merge_hris_client 2.0.4 → 3.2.2

data/docs/CompaniesApi.md

@@ -37,8 +37,8 @@ opts = {
   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.
-  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.
   remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
 }
@@ -80,8 +80,8 @@ end
 | **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] |
-| **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] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
 

data/docs/Company.md

@@ -6,11 +6,14 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
 | **legal_name** | **String** | The company's legal name. | [optional] |
 | **display_name** | **String** | The company's display name. | [optional] |
 | **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **field_mappings** | **Object** |  | [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] |
 
 ## Example
 
@@ -20,11 +23,14 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Company.new(
   id: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
   remote_id: 19202938,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   legal_name: Waystar Royco, Inc.,
   display_name: Waystar Royco,
   eins: ["12-3456789","12-3451111","11-0011000"],
-  remote_data: [{"path":"/companies","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/companies","data":["Varies by platform"]}]
 )
 ```
 

data/docs/ConditionSchema.md

@@ -0,0 +1,30 @@
+# MergeHRISClient::ConditionSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the condition schema. This ID is used when updating selective syncs for a linked account. |  |
+| **common_model** | **String** | The common model for which a condition schema is defined. | [optional][readonly] |
+| **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". |  |
+| **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". |  |
+| **is_unique** | **Boolean** | Whether this condition can only be applied once. If false, the condition can be AND'd together multiple times. | [optional] |
+| **condition_type** | [**ConditionTypeEnum**](ConditionTypeEnum.md) | The type of value(s) that can be set for this condition.  * `BOOLEAN` - BOOLEAN * `DATE` - DATE * `DATE_TIME` - DATE_TIME * `INTEGER` - INTEGER * `FLOAT` - FLOAT * `STRING` - STRING * `LIST_OF_STRINGS` - LIST_OF_STRINGS |  |
+| **operators** | [**Array<OperatorSchema>**](OperatorSchema.md) | The schemas for the operators that can be used on a condition. |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ConditionSchema.new(
+  id: null,
+  common_model: null,
+  native_name: null,
+  field_name: null,
+  is_unique: null,
+  condition_type: null,
+  operators: null
+)
+```
+

data/docs/ConditionTypeEnum.md

@@ -0,0 +1,15 @@
+# MergeHRISClient::ConditionTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ConditionTypeEnum.new()
+```
+

data/docs/CreateFieldMappingRequest.md

@@ -0,0 +1,28 @@
+# MergeHRISClient::CreateFieldMappingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target_field_name** | **String** | The name of the target field you want this remote field to map to. |  |
+| **target_field_description** | **String** | The description of the target field you want this remote field to map to. |  |
+| **remote_field_traversal_path** | [**Array<AnyType>**](AnyType.md) | The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. |  |
+| **remote_method** | **String** | The method of the remote endpoint where the remote field is coming from. |  |
+| **remote_url_path** | **String** | The path of the remote endpoint where the remote field is coming from. |  |
+| **common_model_name** | **String** | The name of the Common Model that the remote field corresponds to in a given category. |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CreateFieldMappingRequest.new(
+  target_field_name: example_target_field_name,
+  target_field_description: this is a example description of the target field,
+  remote_field_traversal_path: ["example_remote_field"],
+  remote_method: GET,
+  remote_url_path: /example-url-path,
+  common_model_name: ExampleCommonModel
+)
+```
+

data/docs/DataPassthroughRequest.md

@@ -5,13 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **method** | [**MethodEnum**](MethodEnum.md) |  |  |
-| **path** | **String** |  |  |
-| **base_url_override** | **String** |  | [optional] |
-| **data** | **String** |  | [optional] |
+| **path** | **String** | The path of the request in the third party's platform. |  |
+| **base_url_override** | **String** | An optional override of the third party's base url for the request. | [optional] |
+| **data** | **String** | The data with the request. You must include a `request_format` parameter matching the data's format | [optional] |
 | **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
 | **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
 | **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) |  | [optional] |
-| **normalize_response** | **Boolean** |  | [optional] |
+| **normalize_response** | **Boolean** | Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`. | [optional] |
 
 ## Example
 
@@ -21,7 +21,7 @@ require 'merge_hris_client'
 instance = MergeHRISClient::DataPassthroughRequest.new(
   method: POST,
   path: /scooters,
-  base_url_override: null,
+  base_url_override: https://api.example.com,
   data: {"company": "Lime", "model": "Gen 2.5"},
   multipart_form_data: null,
   headers: {"EXTRA-HEADER":"value"},

data/docs/DebugModelLogSummary.md

@@ -14,7 +14,7 @@
 require 'merge_hris_client'
 
 instance = MergeHRISClient::DebugModelLogSummary.new(
-  url: https://harvest.greenhouse.io/v1/candidates/,
+  url: www.exampleintegration.com/api/v1/exampleapi,
   method: POST,
   status_code: 200
 )

data/docs/Deduction.md

@@ -5,12 +5,16 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
 | **employee_payroll_run** | **String** |  | [optional] |
 | **name** | **String** | The deduction's name. | [optional] |
-| **employee_deduction** | **Float** | The amount the employee is deducting. | [optional] |
-| **company_deduction** | **Float** | The amount the company is deducting. | [optional] |
+| **employee_deduction** | **Float** | The amount of money that is withheld from an employee's gross pay by the employee. | [optional] |
+| **company_deduction** | **Float** | The amount of money that is withheld on behalf of an employee by the company. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional] |
+| **field_mappings** | **Object** |  | [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] |
 
 ## Example
 
@@ -19,12 +23,16 @@ require 'merge_hris_client'
 
 instance = MergeHRISClient::Deduction.new(
   id: 5fd439fc-1b64-4755-b275-64918936c365,
+  remote_id: 93478612,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
   name: Social Security,
   employee_deduction: 34.54,
   company_deduction: 78.78,
-  remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}]
 )
 ```
 

data/docs/DeleteAccountApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**delete_account_create**](DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |  |
+| [**delete_account_delete**](DeleteAccountApi.md#delete_account_delete) | **POST** /delete-account |  |
 
 
-## delete_account_create
+## delete_account_delete
 
-> delete_account_create(x_account_token)
+> delete_account_delete(x_account_token)
 
 
 
@@ -33,27 +33,27 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
 
 begin
   
-  api_instance.delete_account_create(x_account_token)
+  api_instance.delete_account_delete(x_account_token)
 rescue MergeHRISClient::ApiError => e
-  puts "Error when calling DeleteAccountApi->delete_account_create: #{e}"
+  puts "Error when calling DeleteAccountApi->delete_account_delete: #{e}"
 end
 ```
 
-#### Using the delete_account_create_with_http_info variant
+#### Using the delete_account_delete_with_http_info variant
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> delete_account_create_with_http_info(x_account_token)
+> <Array(nil, Integer, Hash)> delete_account_delete_with_http_info(x_account_token)
 
 ```ruby
 begin
   
-  data, status_code, headers = api_instance.delete_account_create_with_http_info(x_account_token)
+  data, status_code, headers = api_instance.delete_account_delete_with_http_info(x_account_token)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
 rescue MergeHRISClient::ApiError => e
-  puts "Error when calling DeleteAccountApi->delete_account_create_with_http_info: #{e}"
+  puts "Error when calling DeleteAccountApi->delete_account_delete_with_http_info: #{e}"
 end
 ```
 

data/docs/Dependent.md

@@ -0,0 +1,52 @@
+# MergeHRISClient::Dependent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
+| **first_name** | **String** | The dependents's first name. | [optional] |
+| **middle_name** | **String** | The dependents's middle name. | [optional] |
+| **last_name** | **String** | The dependents's last name. | [optional] |
+| **relationship** | [**RelationshipEnum**](RelationshipEnum.md) | The dependent's relationship to the employee.  * `CHILD` - CHILD * `SPOUSE` - SPOUSE * `DOMESTIC_PARTNER` - DOMESTIC_PARTNER | [optional] |
+| **employee** | **String** | The employee this person is a dependent of. | [optional] |
+| **date_of_birth** | **Time** | The dependent's date of birth. | [optional] |
+| **gender** | [**GenderEnum**](GenderEnum.md) | The dependent's gender.  * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
+| **phone_number** | **String** | The dependent's phone number. | [optional] |
+| **home_location** | **String** | The dependents's home address. | [optional] |
+| **is_student** | **Boolean** | Whether or not the dependent is a student | [optional] |
+| **ssn** | **String** | The dependents's social security number. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Dependent.new(
+  id: null,
+  remote_id: 19202940,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
+  first_name: Greg,
+  middle_name: A,
+  last_name: Hirsch,
+  relationship: CHILD,
+  employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  date_of_birth: 1990-11-10T00:00Z,
+  gender: MALE,
+  phone_number: +1234567890,
+  home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
+  is_student: null,
+  ssn: 1234567890,
+  remote_was_deleted: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/dependent","data":["Varies by platform"]}]
+)
+```
+

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,11 +5,15 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
 | **employee_payroll_run** | **String** |  | [optional] |
 | **amount** | **Float** | The amount earned. | [optional] |
-| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
-| **remote_data** | **Array<Hash<String, AnyType>>** |  | [optional] |
-| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [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 in the third party platform. | [optional] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
 
@@ -18,11 +22,15 @@ require 'merge_hris_client'
 
 instance = MergeHRISClient::Earning.new(
   id: babbced6-3a81-4775-8da2-490dc6385259,
+  remote_id: 52802,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
   amount: 1002.34,
   type: SALARY,
-  remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  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,34 +6,40 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
+| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
+| **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] |
+| **preferred_name** | **String** | The employee's preferred first 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] |
+| **username** | **String** | The employee's username that appears in the remote UI. | [optional] |
 | **groups** | **Array<String>** |  | [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] |
 | **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] |
-| **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] |
+| **remote_created_at** | **Time** | When the third party's employee was created. | [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] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
 
@@ -43,11 +49,15 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Employee.new(
   id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
   remote_id: 19202938,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee_number: 2,
   company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
   first_name: Greg,
   last_name: Hirsch,
+  preferred_name: Greg the egg,
   display_full_name: Cousin Greg Hirsch,
+  username: cousingreg,
   groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
   work_email: greg@merge.dev,
   personal_email: greg@gmail.com,
@@ -65,12 +75,14 @@ instance = MergeHRISClient::Employee.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,
-  remote_data: [{"path":"/people","data":["Varies by platform"]}],
   custom_fields: null,
-  remote_was_deleted: null
+  remote_was_deleted: null,
+  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"]}]
 )
 ```