merge_hris_client 3.0.0 → 3.2.1

data/docs/DependentsApi.md

@@ -0,0 +1,181 @@
+# MergeHRISClient::DependentsApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**dependents_list**](DependentsApi.md#dependents_list) | **GET** /dependents |  |
+| [**dependents_retrieve**](DependentsApi.md#dependents_retrieve) | **GET** /dependents/{id} |  |
+
+
+## dependents_list
+
+> <PaginatedDependentList> dependents_list(x_account_token, opts)
+
+
+
+Returns a list of `Dependent` objects.
+
+### 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::DependentsApi.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.
+  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
+  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 sensitive fields (such as social security numbers) in the response.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
+  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.dependents_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DependentsApi->dependents_list: #{e}"
+end
+```
+
+#### Using the dependents_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedDependentList>, Integer, Hash)> dependents_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.dependents_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedDependentList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DependentsApi->dependents_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] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [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 sensitive fields (such as social security numbers) in the response. | [optional] |
+| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
+| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [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
+
+[**PaginatedDependentList**](PaginatedDependentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## dependents_retrieve
+
+> <Dependent> dependents_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Dependent` 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['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::DependentsApi.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.
+  include_sensitive_fields: true # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
+}
+
+begin
+  
+  result = api_instance.dependents_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DependentsApi->dependents_retrieve: #{e}"
+end
+```
+
+#### Using the dependents_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Dependent>, Integer, Hash)> dependents_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.dependents_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Dependent>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling DependentsApi->dependents_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] |
+| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
+
+### Return type
+
+[**Dependent**](Dependent.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Earning.md

@@ -5,10 +5,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
 | **employee_payroll_run** | **String** |  | [optional] |
 | **amount** | **Float** | The amount earned. | [optional] |
-| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
+| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning.  * `SALARY` - SALARY * `REIMBURSEMENT` - REIMBURSEMENT * `OVERTIME` - OVERTIME * `BONUS` - BONUS | [optional] |
 | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
+| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
+| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
 
@@ -17,10 +21,14 @@ require 'merge_hris_client'
 
 instance = MergeHRISClient::Earning.new(
   id: babbced6-3a81-4775-8da2-490dc6385259,
+  remote_id: 52802,
   employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
   amount: 1002.34,
   type: SALARY,
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  modified_at: 2021-10-16T00:00Z,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: null
 )
 ```
 

data/docs/Employee.md

@@ -6,8 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers. | [optional] |
-| **company** | **String** |  | [optional] |
+| **employee_number** | **String** | The employee's number that appears in the third-party integration's UI. | [optional] |
+| **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. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
@@ -17,25 +17,27 @@
 | **personal_email** | **String** | The employee's personal email. | [optional] |
 | **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
 | **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
-| **home_location** | **String** |  | [optional] |
-| **work_location** | **String** |  | [optional] |
-| **manager** | **String** |  | [optional] |
-| **team** | **String** |  | [optional] |
-| **pay_group** | **String** |  | [optional] |
+| **home_location** | **String** | The employee's home address. | [optional] |
+| **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] |
+| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender.  * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
+| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity.  * `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
+| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's filing status as related to marital status.  * `SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD | [optional] |
 | **date_of_birth** | **Time** | The employee's date of birth. | [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] |
+| **start_date** | **Time** | The date that the employee started working. If an employee was rehired, the most recent start date will be returned. | [optional] |
 | **remote_created_at** | **Time** | When the third party's employee was created. | [optional] |
-| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
+| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee.  * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE | [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] |
 | **remote_was_deleted** | **Boolean** |  | [optional][readonly] |
+| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
+| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
 
@@ -72,9 +74,11 @@ instance = MergeHRISClient::Employee.new(
   employment_status: INACTIVE,
   termination_date: 2021-10-12T00:00Z,
   avatar: http://alturl.com/h2h8m,
-  remote_data: [{"path":"/people","data":["Varies by platform"]}],
   custom_fields: null,
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  modified_at: 2021-10-16T00:00Z,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/people","data":["Varies by platform"]}]
 )
 ```
 

data/docs/EmployeePayrollRun.md

@@ -6,18 +6,20 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **String** |  | [optional] |
-| **payroll_run** | **String** |  | [optional] |
-| **gross_pay** | **Float** | The gross pay from the run. | [optional] |
-| **net_pay** | **Float** | The net pay from the run. | [optional] |
+| **employee** | **String** | The employee whose payroll is being run. | [optional] |
+| **payroll_run** | **String** | The payroll being run. | [optional] |
+| **gross_pay** | **Float** | The total earnings throughout a given period for an employee before any deductions are made. | [optional] |
+| **net_pay** | **Float** | The take-home pay throughout a given period for an employee after deductions are made. | [optional] |
 | **start_date** | **Time** | The day and time the payroll run started. | [optional] |
 | **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
 | **check_date** | **Time** | The day and time the payroll run was checked. | [optional] |
 | **earnings** | [**Array<Earning>**](Earning.md) |  | [optional][readonly] |
 | **deductions** | [**Array<Deduction>**](Deduction.md) |  | [optional][readonly] |
 | **taxes** | [**Array<Tax>**](Tax.md) |  | [optional][readonly] |
-| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
+| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
+| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
 
@@ -37,8 +39,10 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
   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"}],
-  remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  modified_at: 2021-10-16T00:00Z,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}]
 )
 ```
 

data/docs/EmployeePayrollRunsApi.md

@@ -41,8 +41,8 @@ opts = {
   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 marked as deleted by third party webhooks.
   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.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
   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.
@@ -91,8 +91,8 @@ end
 | **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 marked as deleted by third party webhooks. | [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] |
+| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
+| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [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] |

data/docs/EmployeeRequest.md

@@ -4,9 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers. | [optional] |
-| **company** | **String** |  | [optional] |
+| **employee_number** | **String** | The employee's number that appears in the third-party integration's UI. | [optional] |
+| **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. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
@@ -16,23 +15,23 @@
 | **personal_email** | **String** | The employee's personal email. | [optional] |
 | **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
 | **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
-| **home_location** | **String** |  | [optional] |
-| **work_location** | **String** |  | [optional] |
-| **manager** | **String** |  | [optional] |
-| **team** | **String** |  | [optional] |
-| **pay_group** | **String** |  | [optional] |
+| **home_location** | **String** | The employee's home address. | [optional] |
+| **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] |
+| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender.  * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
+| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity.  * `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
+| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's filing status as related to marital status.  * `SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD | [optional] |
 | **date_of_birth** | **Time** | The employee's date of birth. | [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] |
-| **remote_created_at** | **Time** | When the third party's employee was created. | [optional] |
-| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
+| **start_date** | **Time** | The date that the employee started working. If an employee was rehired, the most recent start date will be returned. | [optional] |
+| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee.  * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE | [optional] |
 | **termination_date** | **Time** | The employee's termination date. | [optional] |
 | **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
-| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
+| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
 
 ## Example
 
@@ -40,7 +39,6 @@
 require 'merge_hris_client'
 
 instance = MergeHRISClient::EmployeeRequest.new(
-  remote_id: 19202938,
   employee_number: 2,
   company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
   first_name: Greg,
@@ -64,11 +62,11 @@ instance = MergeHRISClient::EmployeeRequest.new(
   date_of_birth: 1990-11-10T00:00Z,
   hire_date: 2020-10-10T00:00Z,
   start_date: 2020-10-11T00:00Z,
-  remote_created_at: 2020-10-11T00:00Z,
   employment_status: INACTIVE,
   termination_date: 2021-10-12T00:00Z,
   avatar: http://alturl.com/h2h8m,
-  custom_fields: null
+  integration_params: {"unique_integration_field":"unique_integration_field_value"},
+  linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
 )
 ```
 

data/docs/EmployeesApi.md

@@ -92,7 +92,7 @@ end
 
 ## employees_ignore_create
 
-> <IgnoreCommonModel> employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
+> employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
 
 
 
@@ -118,8 +118,7 @@ ignore_common_model_request = MergeHRISClient::IgnoreCommonModelRequest.new({rea
 
 begin
   
-  result = api_instance.employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
-  p result
+  api_instance.employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
 rescue MergeHRISClient::ApiError => e
   puts "Error when calling EmployeesApi->employees_ignore_create: #{e}"
 end
@@ -127,9 +126,9 @@ end
 
 #### Using the employees_ignore_create_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<IgnoreCommonModel>, Integer, Hash)> employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
+> <Array(nil, Integer, Hash)> employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
 
 ```ruby
 begin
@@ -137,7 +136,7 @@ begin
   data, status_code, headers = api_instance.employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <IgnoreCommonModel>
+  p data # => nil
 rescue MergeHRISClient::ApiError => e
   puts "Error when calling EmployeesApi->employees_ignore_create_with_http_info: #{e}"
 end
@@ -153,7 +152,7 @@ end
 
 ### Return type
 
-[**IgnoreCommonModel**](IgnoreCommonModel.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -162,7 +161,7 @@ end
 ### HTTP request headers
 
 - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
+- **Accept**: Not defined
 
 
 ## employees_list
@@ -194,22 +193,28 @@ 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.
   display_full_name: 'display_full_name_example', # String | If provided, will only return employees with this display name.
-  employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status.
+  employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status.  * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
   expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
   first_name: 'first_name_example', # String | If provided, will only return employees with this first name.
+  groups: 'groups_example', # String | If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
   include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
   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 sensitive fields (such as social security numbers) in the response.
   last_name: 'last_name_example', # String | If provided, will only return employees with this last name.
   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.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
   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_fields: 'employment_status', # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'employment_status', # String | Deprecated. Use show_enum_origins.
   remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
+  show_enum_origins: 'employment_status', # String | Which fields should be returned in non-normalized form.
+  started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that started after this datetime.
+  started_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that started before this datetime.
   team_id: 'team_id_example', # String | If provided, will only return employees for this team.
+  terminated_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that were terminated after this datetime.
+  terminated_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that were terminated before this datetime.
   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.
 }
@@ -251,22 +256,28 @@ end
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
 | **display_full_name** | **String** | If provided, will only return employees with this display name. | [optional] |
-| **employment_status** | **String** | If provided, will only return employees with this employment status. | [optional] |
+| **employment_status** | **String** | If provided, will only return employees with this employment status.  * &#x60;ACTIVE&#x60; - ACTIVE * &#x60;PENDING&#x60; - PENDING * &#x60;INACTIVE&#x60; - INACTIVE | [optional] |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
 | **first_name** | **String** | If provided, will only return employees with this first name. | [optional] |
+| **groups** | **String** | If provided, will only return employees matching the group ids; multiple groups can be separated by commas. | [optional] |
 | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [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 sensitive fields (such as social security numbers) in the response. | [optional] |
 | **last_name** | **String** | If provided, will only return employees with this last name. | [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] |
+| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
+| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [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_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
 | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **started_after** | **Time** | If provided, will only return employees that started after this datetime. | [optional] |
+| **started_before** | **Time** | If provided, will only return employees that started before this datetime. | [optional] |
 | **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
+| **terminated_after** | **Time** | If provided, will only return employees that were terminated after this datetime. | [optional] |
+| **terminated_before** | **Time** | If provided, will only return employees that were terminated before this datetime. | [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] |
 
@@ -383,7 +394,8 @@ 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 sensitive fields (such as social security numbers) in the response.
-  remote_fields: 'employment_status' # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'employment_status', # String | Deprecated. Use show_enum_origins.
+  show_enum_origins: 'employment_status' # String | Which fields should be returned in non-normalized form.
 }
 
 begin
@@ -422,7 +434,8 @@ end
 | **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 sensitive fields (such as social security numbers) in the response. | [optional] |
-| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
+| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
 
 ### Return type
 

data/docs/EmployerBenefit.md

@@ -0,0 +1,36 @@
+# MergeHRISClient::EmployerBenefit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **benefit_plan_type** | [**BenefitPlanTypeEnum**](BenefitPlanTypeEnum.md) | The type of benefit plan.  * `MEDICAL` - MEDICAL * `HEALTH_SAVINGS` - HEALTH_SAVINGS * `INSURANCE` - INSURANCE * `RETIREMENT` - RETIREMENT * `OTHER` - OTHER | [optional] |
+| **name** | **String** | The employer benefit's name - typically the carrier or network name. | [optional] |
+| **description** | **String** | The employer benefit's description. | [optional] |
+| **deduction_code** | **String** | The employer benefit's deduction code. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
+| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
+| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **remote_data** | **Array<Hash<String, AnyType>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::EmployerBenefit.new(
+  id: null,
+  remote_id: 19202939,
+  benefit_plan_type: MEDICAL,
+  name: Kaiser Permanente Medical Plan,
+  description: HDHP Silver Plan,
+  deduction_code: COL,
+  remote_was_deleted: null,
+  modified_at: 2021-10-16T00:00Z,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: null
+)
+```
+