merge_hris_client 1.0.2 → 1.0.3

data/docs/BenefitsApi.md

@@ -4,88 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**benefits_create**](BenefitsApi.md#benefits_create) | **POST** /benefits |  |
 | [**benefits_list**](BenefitsApi.md#benefits_list) | **GET** /benefits |  |
 | [**benefits_retrieve**](BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |  |
 
 
-## benefits_create
-
-> <Benefit> benefits_create(x_account_token, opts)
-
-
-
-Creates a `Benefit` object with the given values.
-
-### Examples
-
-```ruby
-require 'time'
-require 'merge_hris_client'
-# setup authorization
-MergeHRISClient.configure do |config|
-  # Configure API key authorization: tokenAuth
-  config.api_key['tokenAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['tokenAuth'] = 'Bearer'
-end
-
-api_instance = MergeHRISClient::BenefitsApi.new
-x_account_token = 'x_account_token_example' # String | Token identifying the end user.
-opts = {
-  run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
-  benefit_request: MergeHRISClient::BenefitRequest.new # BenefitRequest | 
-}
-
-begin
-  
-  result = api_instance.benefits_create(x_account_token, opts)
-  p result
-rescue MergeHRISClient::ApiError => e
-  puts "Error when calling BenefitsApi->benefits_create: #{e}"
-end
-```
-
-#### Using the benefits_create_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Benefit>, Integer, Hash)> benefits_create_with_http_info(x_account_token, opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.benefits_create_with_http_info(x_account_token, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Benefit>
-rescue MergeHRISClient::ApiError => e
-  puts "Error when calling BenefitsApi->benefits_create_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x_account_token** | **String** | Token identifying the end user. |  |
-| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
-| **benefit_request** | [**BenefitRequest**](BenefitRequest.md) |  | [optional] |
-
-### Return type
-
-[**Benefit**](Benefit.md)
-
-### Authorization
-
-[tokenAuth](../README.md#tokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
 ## benefits_list
 
 > <PaginatedBenefitList> benefits_list(x_account_token, opts)
@@ -115,6 +37,7 @@ opts = {
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
   expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
   modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
   modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
@@ -159,6 +82,7 @@ end
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
 | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
 | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |

data/docs/{StateEnum.md → CategoriesEnum.md}

@@ -1,4 +1,4 @@
-# MergeHRISClient::StateEnum
+# MergeHRISClient::CategoriesEnum
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'merge_hris_client'
 
-instance = MergeHRISClient::StateEnum.new()
+instance = MergeHRISClient::CategoriesEnum.new()
 ```
 

data/docs/{NullEnum.md → CategoryEnum.md}

@@ -1,4 +1,4 @@
-# MergeHRISClient::NullEnum
+# MergeHRISClient::CategoryEnum
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'merge_hris_client'
 
-instance = MergeHRISClient::NullEnum.new()
+instance = MergeHRISClient::CategoryEnum.new()
 ```
 

data/docs/CompaniesApi.md

@@ -26,7 +26,7 @@ MergeHRISClient.configure do |config|
   # Configure API key authorization: tokenAuth
   config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['Authorization'] = 'Bearer'
+  config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = MergeHRISClient::CompaniesApi.new
@@ -35,6 +35,7 @@ opts = {
   created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
   modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
   modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
@@ -77,6 +78,7 @@ end
 | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
 | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
 | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |

data/docs/DataPassthroughRequest.md

@@ -7,8 +7,9 @@
 | **method** | [**MethodEnum**](MethodEnum.md) |  |  |
 | **path** | **String** |  |  |
 | **base_url_override** | **String** |  | [optional] |
-| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **data** | **String** |  | [optional] |
 | **headers** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) |  | [optional] |
 
 ## Example
 
@@ -19,8 +20,9 @@ instance = MergeHRISClient::DataPassthroughRequest.new(
   method: POST,
   path: /scooters,
   base_url_override: null,
-  data: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
-  headers: {"EXTRA-HEADER":"value"}
+  data: {"company": "Lime", "model": "Gen 2.5"},
+  headers: {"EXTRA-HEADER":"value"},
+  request_format: JSON
 )
 ```
 

data/docs/DeductionsApi.md

@@ -0,0 +1,179 @@
+# MergeHRISClient::DeductionsApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**deductions_list**](DeductionsApi.md#deductions_list) | **GET** /deductions |  |
+| [**deductions_retrieve**](DeductionsApi.md#deductions_retrieve) | **GET** /deductions/{id} |  |
+
+
+## deductions_list
+
+> <PaginatedDeductionList> deductions_list(x_account_token, opts)
+
+
+
+Returns a list of `Deduction` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::DeductionsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  employee_payroll_run_id: 'employee_payroll_run_id_example', # String | If provided, will only return deductions for this employee payroll run.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.deductions_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DeductionsApi->deductions_list: #{e}"
+end
+```
+
+#### Using the deductions_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedDeductionList>, Integer, Hash)> deductions_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.deductions_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedDeductionList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DeductionsApi->deductions_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **employee_payroll_run_id** | **String** | If provided, will only return deductions for this employee payroll run. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedDeductionList**](PaginatedDeductionList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## deductions_retrieve
+
+> <Deduction> deductions_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Deduction` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::DeductionsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.deductions_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DeductionsApi->deductions_retrieve: #{e}"
+end
+```
+
+#### Using the deductions_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Deduction>, Integer, Hash)> deductions_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.deductions_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Deduction>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DeductionsApi->deductions_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Deduction**](Deduction.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Employee.md

@@ -10,7 +10,7 @@
 | **company** | **String** | The ID of the employee's company. | [optional] |
 | **first_name** | **String** | The employee's first name. | [optional] |
 | **last_name** | **String** | The employee's last name. | [optional] |
-| **display_full_name** | **String** | The employee's full name, to use for display purposes. | [optional] |
+| **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
 | **work_email** | **String** | The employee's work email. | [optional] |
 | **personal_email** | **String** | The employee's personal email. | [optional] |
 | **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
@@ -19,17 +19,19 @@
 | **work_location** | **String** | The employee's work address. | [optional] |
 | **manager** | **String** | The employee ID of the employee's manager. | [optional] |
 | **team** | **String** | The employee's team. | [optional] |
+| **pay_group** | **String** | The employee's pay group | [optional] |
 | **ssn** | **String** | The employee's social security number. | [optional] |
 | **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
 | **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
 | **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
 | **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
-| **hire_date** | **Time** | The employee's hire date. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. | [optional] |
-| **start_date** | **Time** | The employee's start date. | [optional] |
+| **hire_date** | **Time** | The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. | [optional] |
+| **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
 | **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
 | **termination_date** | **Time** | The employee's termination date. | [optional] |
 | **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
 
 ## Example
 
@@ -52,17 +54,19 @@ instance = MergeHRISClient::Employee.new(
   work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
   manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
   team: 249c9faa-3045-4a31-953b-8f22d3613301,
+  pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
   ssn: 1234567890,
   gender: FEMALE,
   ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
   marital_status: SINGLE,
-  date_of_birth: null,
-  hire_date: null,
-  start_date: null,
+  date_of_birth: 1990-11-10T00:00Z,
+  hire_date: 2020-10-10T00:00Z,
+  start_date: 2020-10-11T00:00Z,
   employment_status: INACTIVE,
-  termination_date: null,
+  termination_date: 2021-10-12T00:00Z,
   avatar: http://alturl.com/h2h8m,
-  remote_data: [{"path":"/people","data":["Varies by platform"]}]
+  remote_data: [{"path":"/people","data":["Varies by platform"]}],
+  custom_fields: null
 )
 ```
 

data/docs/EmployeePayrollRun.md

@@ -30,9 +30,9 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
   payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
   gross_pay: 1342.67,
   net_pay: 865.78,
-  start_date: null,
-  end_date: null,
-  check_date: null,
+  start_date: 2020-11-08T00:00Z,
+  end_date: 2020-11-09T00:00Z,
+  check_date: 2020-11-10T00:00Z,
   earnings: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":1002.34,"type":"SALARY"},{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":8342.34,"type":"OVERTIME"}],
   deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
   taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],

data/docs/EmployeePayrollRunsApi.md

@@ -35,14 +35,19 @@ opts = {
   created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
-  employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
+  employee_id: 'employee_id_example', # String | If provided, will only return employee payroll runs for this employee.
+  ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs ended after this datetime.
+  ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs ended before this datetime.
   expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
   modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
   modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
   page_size: 56, # Integer | Number of results to return per page.
   payroll_run_id: 'payroll_run_id_example', # String | If provided, will only return employee payroll runs for this employee.
-  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
+  started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs started after this datetime.
+  started_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return employee payroll runs started before this datetime.
 }
 
 begin
@@ -80,14 +85,19 @@ end
 | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
-| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
+| **employee_id** | **String** | If provided, will only return employee payroll runs for this employee. | [optional] |
+| **ended_after** | **Time** | If provided, will only return employee payroll runs ended after this datetime. | [optional] |
+| **ended_before** | **Time** | If provided, will only return employee payroll runs ended before this datetime. | [optional] |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
 | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
 | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
 | **payroll_run_id** | **String** | If provided, will only return employee payroll runs for this employee. | [optional] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
+| **started_after** | **Time** | If provided, will only return employee payroll runs started after this datetime. | [optional] |
+| **started_before** | **Time** | If provided, will only return employee payroll runs started before this datetime. | [optional] |
 
 ### Return type
 

data/docs/EmployeesApi.md

@@ -4,88 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**employees_create**](EmployeesApi.md#employees_create) | **POST** /employees |  |
 | [**employees_list**](EmployeesApi.md#employees_list) | **GET** /employees |  |
 | [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |  |
 
 
-## employees_create
-
-> <Employee> employees_create(x_account_token, opts)
-
-
-
-Creates an `Employee` object with the given values.
-
-### Examples
-
-```ruby
-require 'time'
-require 'merge_hris_client'
-# setup authorization
-MergeHRISClient.configure do |config|
-  # Configure API key authorization: tokenAuth
-  config.api_key['tokenAuth'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['tokenAuth'] = 'Bearer'
-end
-
-api_instance = MergeHRISClient::EmployeesApi.new
-x_account_token = 'x_account_token_example' # String | Token identifying the end user.
-opts = {
-  run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
-  employee_request: MergeHRISClient::EmployeeRequest.new # EmployeeRequest | 
-}
-
-begin
-  
-  result = api_instance.employees_create(x_account_token, opts)
-  p result
-rescue MergeHRISClient::ApiError => e
-  puts "Error when calling EmployeesApi->employees_create: #{e}"
-end
-```
-
-#### Using the employees_create_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Employee>, Integer, Hash)> employees_create_with_http_info(x_account_token, opts)
-
-```ruby
-begin
-  
-  data, status_code, headers = api_instance.employees_create_with_http_info(x_account_token, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Employee>
-rescue MergeHRISClient::ApiError => e
-  puts "Error when calling EmployeesApi->employees_create_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **x_account_token** | **String** | Token identifying the end user. |  |
-| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
-| **employee_request** | [**EmployeeRequest**](EmployeeRequest.md) |  | [optional] |
-
-### Return type
-
-[**Employee**](Employee.md)
-
-### Authorization
-
-[tokenAuth](../README.md#tokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
 ## employees_list
 
 > <PaginatedEmployeeList> employees_list(x_account_token, opts)
@@ -115,14 +37,18 @@ opts = {
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
   expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  include_sensitive_fields: true, # Boolean | Whether to include sensetive fields (such as social security numbers) in the response.
+  include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
   manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
   modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
   modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
   page_size: 56, # Integer | Number of results to return per page.
+  pay_group_id: 'pay_group_id_example', # String | If provided, will only return employees for this pay group
+  personal_email: TODO, # String | If provided, will only return Employees with this personal email
   remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
   team_id: 'team_id_example', # String | If provided, will only return employees for this team.
+  work_email: TODO, # String | If provided, will only return Employees with this work email
   work_location_id: 'work_location_id_example' # String | If provided, will only return employees for this location.
 }
 
@@ -163,14 +89,18 @@ end
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **include_sensitive_fields** | **Boolean** | Whether to include sensetive fields (such as social security numbers) in the response. | [optional] |
+| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
 | **manager_id** | **String** | If provided, will only return employees for this manager. | [optional] |
 | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
 | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **pay_group_id** | **String** | If provided, will only return employees for this pay group | [optional] |
+| **personal_email** | [**String**](.md) | If provided, will only return Employees with this personal email | [optional] |
 | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
 | **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
+| **work_email** | [**String**](.md) | If provided, will only return Employees with this work email | [optional] |
 | **work_location_id** | **String** | If provided, will only return employees for this location. | [optional] |
 
 ### Return type
@@ -214,7 +144,7 @@ id = TODO # String |
 opts = {
   expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  include_sensitive_fields: true # Boolean | Whether to include sensetive fields (such as social security numbers) in the response.
+  include_sensitive_fields: true # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
 }
 
 begin
@@ -252,7 +182,7 @@ end
 | **id** | [**String**](.md) |  |  |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **include_sensitive_fields** | **Boolean** | Whether to include sensetive fields (such as social security numbers) in the response. | [optional] |
+| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
 
 ### Return type
 

data/docs/Employment.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **employee** | **String** | The employee holding this position. | [optional] |
 | **job_title** | **String** | The position's title. | [optional] |
 | **pay_rate** | **Float** | The position's pay rate in dollars. | [optional] |
 | **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. | [optional] |
@@ -24,13 +25,14 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Employment.new(
   id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
   remote_id: 19202938,
+  employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
   job_title: Software Engineer,
   pay_rate: 80000.00,
   pay_period: YEAR,
   pay_frequency: BIWEEKLY,
   pay_currency: USD,
   flsa_status: EXEMPT,
-  effective_date: null,
+  effective_date: 2020-10-06T18:42:34Z,
   employment_type: FULL TIME,
   remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
 )