merge_hris_client 3.2.1 → 3.2.2

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,9 +5,9 @@
 | 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] |
@@ -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

@@ -6,13 +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] |
 | **employee_payroll_run** | **String** |  | [optional] |
 | **name** | **String** | The deduction's name. | [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 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_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
@@ -23,12 +24,13 @@ 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_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":"/payroll-deduction","data":["Varies by platform"]}]
 )

data/docs/Dependent.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
@@ -17,9 +19,8 @@
 | **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 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_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
@@ -30,6 +31,8 @@ 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,
@@ -42,7 +45,6 @@ instance = MergeHRISClient::Dependent.new(
   is_student: null,
   ssn: 1234567890,
   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":"/dependent","data":["Varies by platform"]}]
 )

data/docs/Earning.md

@@ -6,12 +6,13 @@
 | ---- | ---- | ----------- | ----- |
 | **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.  * `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_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
@@ -22,11 +23,12 @@ 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_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,10 +6,13 @@
 | ---- | ---- | ----------- | ----- |
 | **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_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] |
@@ -35,8 +38,7 @@
 | **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] |
 | **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] |
+| **field_mappings** | **Object** |  | [optional][readonly] |
 | **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
@@ -47,10 +49,13 @@ 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"],
@@ -76,7 +81,6 @@ instance = MergeHRISClient::Employee.new(
   avatar: http://alturl.com/h2h8m,
   custom_fields: 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,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **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** | **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] |
@@ -16,9 +18,8 @@
 | **earnings** | [**Array<Earning>**](Earning.md) |  | [optional][readonly] |
 | **deductions** | [**Array<Deduction>**](Deduction.md) |  | [optional][readonly] |
 | **taxes** | [**Array<Tax>**](Tax.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_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
@@ -29,6 +30,8 @@ require 'merge_hris_client'
 instance = MergeHRISClient::EmployeePayrollRun.new(
   id: fb8c55b6-1cb8-4b4c-9fb6-17924231619d,
   remote_id: 19202938,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
   payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
   gross_pay: 1342.67,
@@ -40,7 +43,6 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
   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_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/EmployeeRequest.md

@@ -8,6 +8,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] |
+| **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] |
@@ -43,6 +44,7 @@ instance = MergeHRISClient::EmployeeRequest.new(
   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"],

data/docs/EmployeesApi.md

@@ -194,12 +194,15 @@ opts = {
   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.  * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
+  employment_type: 'employment_type_example', # String | If provided, will only return employees that have an employment of the specified employment_type.
   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.
+  home_location_id: 'home_location_id_example', # String | If provided, will only return employees for this home location.
   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.
+  job_title: 'job_title_example', # String | If provided, will only return employees that have an employment of the specified job_title.
   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, only objects synced by Merge after this date time will be returned.
@@ -209,7 +212,7 @@ opts = {
   personal_email: TODO, # String | If provided, will only return Employees with this personal email
   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.
+  show_enum_origins: 'employment_status', # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
   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.
@@ -257,12 +260,15 @@ end
 | **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.  * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE | [optional] |
+| **employment_type** | **String** | If provided, will only return employees that have an employment of the specified employment_type. | [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] |
+| **home_location_id** | **String** | If provided, will only return employees for this home location. | [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] |
+| **job_title** | **String** | If provided, will only return employees that have an employment of the specified job_title. | [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, only objects synced by Merge after this date time will be returned. | [optional] |
@@ -272,7 +278,7 @@ end
 | **personal_email** | [**String**](.md) | If provided, will only return Employees with this personal email | [optional] |
 | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [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] |
@@ -395,7 +401,7 @@ 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.
   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.
+  show_enum_origins: 'employment_status' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 }
 
 begin
@@ -435,7 +441,7 @@ end
 | **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** | Deprecated. Use show_enum_origins. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
 
 ### Return type
 

data/docs/EmployerBenefit.md

@@ -6,13 +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] |
 | **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_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<Hash<String, AnyType>>** |  | [optional] |
 
 ## Example
@@ -23,12 +24,13 @@ require 'merge_hris_client'
 instance = MergeHRISClient::EmployerBenefit.new(
   id: null,
   remote_id: 19202939,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   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
 )

data/docs/Employment.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **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** | **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] |
@@ -16,9 +18,8 @@
 | **flsa_status** | [**FlsaStatusEnum**](FlsaStatusEnum.md) | The position's FLSA status.  * `EXEMPT` - EXEMPT * `SALARIED_NONEXEMPT` - SALARIED_NONEXEMPT * `NONEXEMPT` - NONEXEMPT * `OWNER` - OWNER | [optional] |
 | **effective_date** | **Time** | The position's effective date. | [optional] |
 | **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position's type of employment.  * `FULL_TIME` - FULL_TIME * `PART_TIME` - PART_TIME * `INTERN` - INTERN * `CONTRACTOR` - CONTRACTOR * `FREELANCE` - FREELANCE | [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_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
@@ -29,6 +30,8 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Employment.new(
   id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
   remote_id: 19202938,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
   job_title: Executive Assistant to Tom Wambsgans,
   pay_rate: 50000.00,
@@ -40,7 +43,6 @@ instance = MergeHRISClient::Employment.new(
   effective_date: 2023-10-06T18:42:34Z,
   employment_type: FULL TIME,
   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":"/jobs","data":["Varies by platform"]}]
 )

data/docs/EmploymentsApi.md

@@ -45,7 +45,7 @@ opts = {
   page_size: 56, # Integer | Number of results to return per page.
   remote_fields: 'employment_type', # 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_type' # String | Which fields should be returned in non-normalized form.
+  show_enum_origins: 'employment_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 }
 
 begin
@@ -93,7 +93,7 @@ end
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
 | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
 
 ### Return type
 
@@ -137,7 +137,7 @@ opts = {
   expand: 'employee', # 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.
   remote_fields: 'employment_type', # String | Deprecated. Use show_enum_origins.
-  show_enum_origins: 'employment_type' # String | Which fields should be returned in non-normalized form.
+  show_enum_origins: 'employment_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 }
 
 begin
@@ -176,7 +176,7 @@ 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] |
 | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
-| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **show_enum_origins** | **String** | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
 
 ### Return type
 

data/docs/EndUserDetailsRequest.md

@@ -8,10 +8,13 @@
 | **end_user_organization_name** | **String** | Your end user's organization. |  |
 | **end_user_origin_id** | **String** | This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. |  |
 | **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. |  |
-| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
+| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. | [optional] |
 | **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
 | **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. | [optional][default to false] |
 | **common_models** | [**Array<CommonModelScopesBodyRequest>**](CommonModelScopesBodyRequest.md) | An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. | [optional] |
+| **category_common_model_scopes** | **Hash<String, Array<IndividualCommonModelScopeDeserializerRequest>>** | When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. | [optional] |
+| **language** | **String** | The language code for the language to localize Merge Link to. | [optional] |
+| **integration_specific_config** | [**Hash<String, AnyType>**](AnyType.md) | A JSON object containing integration-specific configuration options. | [optional] |
 
 ## Example
 
@@ -19,14 +22,17 @@
 require 'merge_hris_client'
 
 instance = MergeHRISClient::EndUserDetailsRequest.new(
-  end_user_email_address: null,
-  end_user_organization_name: null,
-  end_user_origin_id: null,
-  categories: null,
-  integration: null,
+  end_user_email_address: example@gmail.com,
+  end_user_organization_name: Test Organization,
+  end_user_origin_id: 12345,
+  categories: ["hris","ats"],
+  integration: bamboohr,
   link_expiry_mins: null,
   should_create_magic_link_url: null,
-  common_models: null
+  common_models: null,
+  category_common_model_scopes: {"hris":[{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}},"field_permissions":{"enabled":["first_name","last_name","personal_email"],"disabled":["preferred_name"]}},{"model_name":"Employment","model_permissions":{"READ":{"is_enabled":false},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled":["effective_date"]}}],"ats":[{"model_name":"Job","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}},"field_permissions":{"enabled":["name"],"disabled":["description"]}},{"model_name":"Department","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":true}}}]},
+  language: null,
+  integration_specific_config: {"rippling":{"oauth_code":"3h1jj8ssdf31dfji3o1jjdfjasd"}}
 )
 ```
 

data/docs/EventTypeEnum.md

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

data/docs/ExternalTargetFieldAPI.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::ExternalTargetFieldAPI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional][readonly] |
+| **description** | **String** |  | [optional][readonly] |
+| **is_mapped** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ExternalTargetFieldAPI.new(
+  name: example_target_field_name,
+  description: this is a example description of a target field,
+  is_mapped: true
+)
+```
+

data/docs/ExternalTargetFieldAPIResponse.md

@@ -0,0 +1,48 @@
+# MergeHRISClient::ExternalTargetFieldAPIResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **benefit** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employer_benefit** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **company** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employee_payroll_run** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employee** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **employment** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **location** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **payroll_run** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **team** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **time_off** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **time_off_balance** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **bank_info** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **pay_group** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **group** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **dependent** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+| **timesheet_entry** | [**Array<ExternalTargetFieldAPI>**](ExternalTargetFieldAPI.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::ExternalTargetFieldAPIResponse.new(
+  benefit: null,
+  employer_benefit: null,
+  company: null,
+  employee_payroll_run: null,
+  employee: null,
+  employment: null,
+  location: null,
+  payroll_run: null,
+  team: null,
+  time_off: null,
+  time_off_balance: null,
+  bank_info: null,
+  pay_group: null,
+  group: null,
+  dependent: null,
+  timesheet_entry: null
+)
+```
+