Skip to content

Commit

Permalink
Automated update by SDK Generator (#148)
Browse files Browse the repository at this point in the history
  • Loading branch information
elsmr authored Jul 27, 2023
1 parent b399229 commit b4756e5
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 261 deletions.
56 changes: 9 additions & 47 deletions src/gen/docs/models/Compensation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,62 +5,24 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
`id` | **string** | A unique identifier for an object. | [optional]
`job_id` | **string** | The ID of the job to which the compensation belongs. | [optional]
`rate` | **number** | The amount paid per payment unit. | [optional]
`payment_unit` | [**PaymentUnit**](PaymentUnit.md) | | [optional]
`currency` | [**Currency**](Currency.md) | | [optional]
`flsa_status` | **string** | The FLSA status for this compensation. | [optional]
`effective_date` | **string** | The date on which a change to an employee\'s compensation takes effect. | [optional]
`payment_frequency` | **string** | Frequency of employee compensation. | [optional]
`employee_id` | **string** | A unique identifier for an object. |
`net_pay` | **number** | The employee\'s net pay. Only available when payroll has been processed | [optional]
`gross_pay` | **number** | The employee\'s gross pay. Only available when payroll has been processed | [optional]
`taxes` | [**Array<Tax>**](Tax.md) | An array of employer and employee taxes for the pay period. | [optional]
`deductions` | [**Array<Deduction>**](Deduction.md) | An array of employee deductions for the pay period. | [optional]
`benefits` | [**Array<Benefit>**](Benefit.md) | An array of employee benefits for the pay period. | [optional]





<a name="CompensationFlsaStatus"></a>
## Enum: Compensation.flsa_status


* `exempt` (value: `'exempt'`)

* `salaried_nonexempt` (value: `'salaried-nonexempt'`)

* `nonexempt` (value: `'nonexempt'`)

* `owner` (value: `'owner'`)

* `other` (value: `'other'`)




<a name="CompensationPaymentFrequency"></a>
## Enum: Compensation.payment_frequency


* `weekly` (value: `'weekly'`)

* `biweekly` (value: `'biweekly'`)

* `monthly` (value: `'monthly'`)

* `pro_rata` (value: `'pro-rata'`)

* `other` (value: `'other'`)




## Referenced Types:



* [`PaymentUnit`](PaymentUnit.md)
* [`Currency`](Currency.md)



* [`Tax`](Tax.md)
* [`Deduction`](Deduction.md)
* [`Benefit`](Benefit.md)

---

Expand Down
54 changes: 0 additions & 54 deletions src/gen/docs/models/EmployeeBankAccounts.md

This file was deleted.

122 changes: 110 additions & 12 deletions src/gen/docs/models/Job.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,133 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
`id` | **string** | A unique identifier for an object. | [optional]
`employee_id` | **string** | A unique identifier for an object. | [optional]
`slug` | **string** | | [optional]
`title` | **string** | The job title of the person. | [optional]
`role` | **string** | The position and responsibilities of the person within the organization. | [optional]
`start_date` | **Date** | The date on which the employee starts working in their current job role. | [optional]
`end_date` | **Date** | The date on which the employee leaves or is expected to leave their current job role. | [optional]
`compensation_rate` | **number** | The rate of pay for the employee in their current job role. | [optional]
`currency` | [**Currency**](Currency.md) | | [optional]
`payment_unit` | [**PaymentUnit**](PaymentUnit.md) | | [optional]
`hired_at` | **Date** | The date on which the employee was hired by the organization | [optional]
`is_primary` | **boolean** | Indicates whether this the employee\'s primary job. | [optional]
`location` | [**Address**](Address.md) | | [optional]
`sequence` | **number** | Sequence in relation to other jobs. | [optional]
`visibility` | **string** | The visibility of the job | [optional]
`status` | [**JobStatus**](JobStatus.md) | | [optional]
`code` | **string** | The code of the job. | [optional]
`language` | **string** | language code according to ISO 639-1. For the United States - EN | [optional]
`employment_terms` | **string** | | [optional]
`experience` | **string** | Level of experience required for the job role. | [optional]
`location` | **string** | Specifies the location for the job posting. | [optional]
`remote` | **boolean** | Specifies whether the posting is for a remote job. | [optional]
`requisition_id` | **string** | A job\'s Requisition ID (Req ID) allows your organization to identify and track a job based on alphanumeric naming conventions unique to your company\'s internal processes. | [optional]
`department` | [**Department**](Department.md) | | [optional]
`branch` | [**Branch**](Branch.md) | | [optional]
`recruiters` | **Array&lt;string&gt;** | The recruiter is generally someone who is tasked to help the hiring manager find and screen qualified applicant | [optional]
`hiring_managers` | **Array&lt;string&gt;** | | [optional]
`followers` | **Array&lt;string&gt;** | | [optional]
`description` | **string** | A description of the object. | [optional]
`description_html` | **string** | The job description in HTML format | [optional]
`blocks` | **Array&lt;object&gt;** | | [optional]
`closing` | **string** | | [optional]
`closing_html` | **string** | The closing section of the job description in HTML format | [optional]
`closing_date` | **Date** | | [optional]
`salary` | [**JobSalary**](JobSalary.md) | | [optional]
`url` | **string** | URL of the job description | [optional]
`job_portal_url` | **string** | URL of the job portal | [optional]
`record_url` | **string** | | [optional]
`links` | [**Array&lt;JobLinks&gt;**](JobLinks.md) | | [optional]
`confidential` | **boolean** | | [optional]
`available_to_employees` | **boolean** | Specifies whether an employee of the organization can apply for the job. | [optional]
`tags` | [**Tags**](Tags.md) | | [optional]
`addresses` | [**Array&lt;Address&gt;**](Address.md) | | [optional]
`custom_fields` | [**Array&lt;CustomField&gt;**](CustomField.md) | | [optional]
`deleted` | **boolean** | | [optional]
`owner_id` | **string** | | [optional]
`published_at` | **Date** | | [optional]
`updated_by` | **string** | The user who last updated the object. | [optional]
`created_by` | **string** | The user who created the object. | [optional]
`updated_at` | **Date** | The date and time when the object was last updated. | [optional]
`created_at` | **Date** | The date and time when the object was created. | [optional]





<a name="JobVisibility"></a>
## Enum: Job.visibility


* `draft` (value: `'draft'`)

* `public` (value: `'public'`)

* `internal` (value: `'internal'`)




<a name="JobEmploymentTerms"></a>
## Enum: Job.employment_terms


* `full_time` (value: `'full-time'`)

* `part_time` (value: `'part-time'`)

* `internship` (value: `'internship'`)

* `contractor` (value: `'contractor'`)

* `employee` (value: `'employee'`)

* `freelance` (value: `'freelance'`)

* `temp` (value: `'temp'`)

* `seasonal` (value: `'seasonal'`)

* `volunteer` (value: `'volunteer'`)

* `other` (value: `'other'`)




## Referenced Types:





* [`JobStatus`](JobStatus.md)



* [`Currency`](Currency.md)
* [`PaymentUnit`](PaymentUnit.md)




* [`Department`](Department.md)
* [`Branch`](Branch.md)









* [`JobSalary`](JobSalary.md)



* [`JobLinks`](JobLinks.md)


* [`Tags`](Tags.md)
* [`Address`](Address.md)
* [`CustomField`](CustomField.md)








---

Expand Down
Loading

0 comments on commit b4756e5

Please sign in to comment.