merge_hris_client 3.0.0 → 3.2.1

data/docs/CommonModelScopesApi.md

@@ -0,0 +1,157 @@
+# MergeHRISClient::CommonModelScopesApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**common_model_scopes_create**](CommonModelScopesApi.md#common_model_scopes_create) | **POST** /common-model-scopes |  |
+| [**common_model_scopes_retrieve**](CommonModelScopesApi.md#common_model_scopes_retrieve) | **GET** /common-model-scopes |  |
+
+
+## common_model_scopes_create
+
+> <CommonModelScopes> common_model_scopes_create(common_model_scopes_update_serializer, opts)
+
+
+
+Update the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
+
+### 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::CommonModelScopesApi.new
+common_model_scopes_update_serializer = MergeHRISClient::CommonModelScopesUpdateSerializer.new({common_models: [MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest.new({model_id: 'hris.Employee', enabled_actions: [MergeHRISClient::EnabledActionsEnum::READ], disabled_fields: ['disabled_fields_example']})]}) # CommonModelScopesUpdateSerializer | 
+opts = {
+  linked_account_id: 'linked_account_id_example' # String | ID of specific linked account to fetch
+}
+
+begin
+  
+  result = api_instance.common_model_scopes_create(common_model_scopes_update_serializer, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CommonModelScopesApi->common_model_scopes_create: #{e}"
+end
+```
+
+#### Using the common_model_scopes_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CommonModelScopes>, Integer, Hash)> common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.common_model_scopes_create_with_http_info(common_model_scopes_update_serializer, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CommonModelScopes>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CommonModelScopesApi->common_model_scopes_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_model_scopes_update_serializer** | [**CommonModelScopesUpdateSerializer**](CommonModelScopesUpdateSerializer.md) |  |  |
+| **linked_account_id** | **String** | ID of specific linked account to fetch | [optional] |
+
+### Return type
+
+[**CommonModelScopes**](CommonModelScopes.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## common_model_scopes_retrieve
+
+> <CommonModelScopes> common_model_scopes_retrieve(opts)
+
+
+
+Fetch the configuration of what data is saved by Merge when syncing. Common model scopes are set as a default across all linked accounts, but can be updated to have greater granularity per account.
+
+### 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::CommonModelScopesApi.new
+opts = {
+  linked_account_id: 'linked_account_id_example' # String | ID of specific linked account to fetch
+}
+
+begin
+  
+  result = api_instance.common_model_scopes_retrieve(opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CommonModelScopesApi->common_model_scopes_retrieve: #{e}"
+end
+```
+
+#### Using the common_model_scopes_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CommonModelScopes>, Integer, Hash)> common_model_scopes_retrieve_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.common_model_scopes_retrieve_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CommonModelScopes>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling CommonModelScopesApi->common_model_scopes_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **linked_account_id** | **String** | ID of specific linked account to fetch | [optional] |
+
+### Return type
+
+[**CommonModelScopes**](CommonModelScopes.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CommonModelScopesBodyRequest.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::CommonModelScopesBodyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_id** | **String** |  |  |
+| **enabled_actions** | [**Array<EnabledActionsEnum>**](EnabledActionsEnum.md) |  |  |
+| **disabled_fields** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopesBodyRequest.new(
+  model_id: hris.Employee,
+  enabled_actions: ["READ","WRITE"],
+  disabled_fields: ["first_name"]
+)
+```
+

data/docs/CommonModelScopesDisabledModels.md

@@ -0,0 +1,26 @@
+# MergeHRISClient::CommonModelScopesDisabledModels
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **model_id** | **String** |  |  |
+| **enabled_actions** | [**Array<CommonModelScopesDisabledModelsEnabledActionsEnum>**](CommonModelScopesDisabledModelsEnabledActionsEnum.md) |  |  |
+| **is_disabled** | **Boolean** |  |  |
+| **disabled_fields** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopesDisabledModels.new(
+  model_name: null,
+  model_id: null,
+  enabled_actions: null,
+  is_disabled: null,
+  disabled_fields: null
+)
+```
+

data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md

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

data/docs/CommonModelScopesPostInnerDeserializerRequest.md

@@ -0,0 +1,22 @@
+# MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_id** | **String** |  |  |
+| **enabled_actions** | [**Array<EnabledActionsEnum>**](EnabledActionsEnum.md) |  |  |
+| **disabled_fields** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest.new(
+  model_id: hris.Employee,
+  enabled_actions: ["READ","WRITE"],
+  disabled_fields: null
+)
+```
+

data/docs/CommonModelScopesUpdateSerializer.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::CommonModelScopesUpdateSerializer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_models** | [**Array<CommonModelScopesPostInnerDeserializerRequest>**](CommonModelScopesPostInnerDeserializerRequest.md) | The common model scopes to update. |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopesUpdateSerializer.new(
+  common_models: null
+)
+```
+

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

@@ -9,8 +9,10 @@
 | **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_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
 
@@ -23,8 +25,10 @@ instance = MergeHRISClient::Company.new(
   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,
+  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":"/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/DataPassthroughRequest.md

@@ -11,7 +11,7 @@
 | **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
 

data/docs/Deduction.md

@@ -5,12 +5,15 @@
 | 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] |
 | **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] |
-| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **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_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
 
 ## Example
 
@@ -19,12 +22,15 @@ require 'merge_hris_client'
 
 instance = MergeHRISClient::Deduction.new(
   id: 5fd439fc-1b64-4755-b275-64918936c365,
+  remote_id: 93478612,
   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,
+  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/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,50 @@
+# MergeHRISClient::Dependent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **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 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
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::Dependent.new(
+  id: null,
+  remote_id: 19202940,
+  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,
+  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"]}]
+)
+```
+