merge_hris_client 2.0.4 → 3.2.2

data/docs/AuditTrailApi.md

@@ -0,0 +1,91 @@
+# MergeHRISClient::AuditTrailApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**audit_trail_list**](AuditTrailApi.md#audit_trail_list) | **GET** /audit-trail |  |
+
+
+## audit_trail_list
+
+> <PaginatedAuditLogEventList> audit_trail_list(opts)
+
+
+
+Gets a list of audit trail events.
+
+### 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::AuditTrailApi.new
+opts = {
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  end_date: 'end_date_example', # String | If included, will only include audit trail events that occurred before this time
+  event_type: 'event_type_example', # String | If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
+  page_size: 56, # Integer | Number of results to return per page.
+  start_date: 'start_date_example', # String | If included, will only include audit trail events that occurred after this time
+  user_email: 'user_email_example' # String | If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+}
+
+begin
+  
+  result = api_instance.audit_trail_list(opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AuditTrailApi->audit_trail_list: #{e}"
+end
+```
+
+#### Using the audit_trail_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedAuditLogEventList>, Integer, Hash)> audit_trail_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.audit_trail_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedAuditLogEventList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AuditTrailApi->audit_trail_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **end_date** | **String** | If included, will only include audit trail events that occurred before this time | [optional] |
+| **event_type** | **String** | If included, will only include events with the given event type. Possible values include: &#x60;CREATED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;DELETED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;CREATED_TEST_API_KEY&#x60;, &#x60;DELETED_TEST_API_KEY&#x60;, &#x60;REGENERATED_PRODUCTION_API_KEY&#x60;, &#x60;INVITED_USER&#x60;, &#x60;TWO_FACTOR_AUTH_ENABLED&#x60;, &#x60;TWO_FACTOR_AUTH_DISABLED&#x60;, &#x60;DELETED_LINKED_ACCOUNT&#x60;, &#x60;CREATED_DESTINATION&#x60;, &#x60;DELETED_DESTINATION&#x60;, &#x60;CHANGED_DESTINATION&#x60;, &#x60;CHANGED_SCOPES&#x60;, &#x60;CHANGED_PERSONAL_INFORMATION&#x60;, &#x60;CHANGED_ORGANIZATION_SETTINGS&#x60;, &#x60;ENABLED_INTEGRATION&#x60;, &#x60;DISABLED_INTEGRATION&#x60;, &#x60;ENABLED_CATEGORY&#x60;, &#x60;DISABLED_CATEGORY&#x60;, &#x60;CHANGED_PASSWORD&#x60;, &#x60;RESET_PASSWORD&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;CREATED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CREATED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;CHANGED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CHANGED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;DELETED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;DELETED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;FORCED_LINKED_ACCOUNT_RESYNC&#x60;, &#x60;MUTED_ISSUE&#x60;, &#x60;GENERATED_MAGIC_LINK&#x60;, &#x60;ENABLED_MERGE_WEBHOOK&#x60;, &#x60;DISABLED_MERGE_WEBHOOK&#x60;, &#x60;MERGE_WEBHOOK_TARGET_CHANGED&#x60;, &#x60;END_USER_CREDENTIALS_ACCESSED&#x60; | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **start_date** | **String** | If included, will only include audit trail events that occurred after this time | [optional] |
+| **user_email** | **String** | If provided, this will return events associated with the specified user email. Please note that the email address reflects the user&#39;s email at the time of the event, and may not be their current email. | [optional] |
+
+### Return type
+
+[**PaginatedAuditLogEventList**](PaginatedAuditLogEventList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BankInfo.md

@@ -6,14 +6,17 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **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** | **String** | The employee with this bank account. | [optional] |
 | **account_number** | **String** | The account number. | [optional] |
 | **routing_number** | **String** | The routing number. | [optional] |
 | **bank_name** | **String** | The bank name. | [optional] |
-| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type | [optional] |
+| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type  * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING | [optional] |
 | **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [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
 
@@ -23,14 +26,17 @@ require 'merge_hris_client'
 instance = MergeHRISClient::BankInfo.new(
   id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
   remote_id: 123234,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee: a3617eb4-dfe3-426f-921e-a65fc1661e10,
   account_number: 439291590,
   routing_number: 089690059,
   bank_name: Chase,
   account_type: CHECKING,
   remote_created_at: 2021-12-06T10:11:26Z,
-  remote_data: [{"path":"/bank-info","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":"/bank-info","data":["Varies by platform"]}]
 )
 ```
 

data/docs/BankInfoApi.md

@@ -32,7 +32,7 @@ end
 api_instance = MergeHRISClient::BankInfoApi.new
 x_account_token = 'x_account_token_example' # String | Token identifying the end user.
 opts = {
-  account_type: 'CHECKING', # String | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+  account_type: 'CHECKING', # String | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')  * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
   bank_name: 'bank_name_example', # String | If provided, will only return BankInfo's with this bank name.
   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.
@@ -41,12 +41,13 @@ opts = {
   expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
   include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
   include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
-  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
-  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
-  order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint.
+  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.
+  order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
   page_size: 56, # Integer | Number of results to return per page.
-  remote_fields: 'account_type', # String | Which fields should be returned in non-normalized form.
-  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+  remote_fields: 'account_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: 'account_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
@@ -81,7 +82,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **x_account_token** | **String** | Token identifying the end user. |  |
-| **account_type** | **String** | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') | [optional] |
+| **account_type** | **String** | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')  * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING | [optional] |
 | **bank_name** | **String** | If provided, will only return BankInfo's with this bank name. | [optional] |
 | **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] |
@@ -90,12 +91,13 @@ end
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
 | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
-| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
-| **order_by** | **String** | Overrides the default ordering for this endpoint. | [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] |
+| **order_by** | **String** | Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. | [optional] |
 | **page_size** | **Integer** | Number of results to return per page. | [optional] |
-| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
 | **remote_id** | **String** | The API provider's ID for the given object. | [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
 
@@ -138,7 +140,8 @@ id = TODO # String |
 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: 'account_type' # String | Which fields should be returned in non-normalized form.
+  remote_fields: 'account_type', # String | Deprecated. Use show_enum_origins.
+  show_enum_origins: 'account_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 +179,8 @@ end
 | **id** | [**String**](.md) |  |  |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
 | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
-| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
+| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
+| **show_enum_origins** | **String** | 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/Benefit.md

@@ -6,13 +6,19 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **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** | **String** | The employee on the plan. | [optional] |
 | **provider_name** | **String** | The name of the benefit provider. | [optional] |
 | **benefit_plan_type** | **String** | The type of benefit plan | [optional] |
 | **employee_contribution** | **Float** | The employee's contribution. | [optional] |
 | **company_contribution** | **Float** | The company's contribution. | [optional] |
+| **start_date** | **Time** | The day and time the benefit started. | [optional] |
+| **end_date** | **Time** | The day and time the benefit ended. | [optional] |
+| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
+| **employer_benefit** | **String** | The employer benefit plan the employee is enrolled in. | [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][readonly] |
 
 ## Example
 
@@ -22,13 +28,19 @@ require 'merge_hris_client'
 instance = MergeHRISClient::Benefit.new(
   id: 3fe5ae7a-f1ba-4529-b7af-84e86dc6d232,
   remote_id: 19202938,
+  created_at: 2021-09-15T00:00Z,
+  modified_at: 2021-10-16T00:00Z,
   employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
   provider_name: Blue Shield of California,
-  benefit_plan_type: MEDICAL,
+  benefit_plan_type: null,
   employee_contribution: 23.65,
   company_contribution: 150.0,
-  remote_data: [{"path":"/benefits","data":["Varies by platform"]}],
-  remote_was_deleted: null
+  start_date: null,
+  end_date: null,
+  remote_was_deleted: null,
+  employer_benefit: null,
+  field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
+  remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
 )
 ```
 

data/docs/BenefitPlanTypeEnum.md

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

data/docs/BenefitsApi.md

@@ -35,12 +35,12 @@ opts = {
   created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
   cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
-  employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
+  employee_id: 'employee_id_example', # String | If provided, will return the benefits associated with the employee.
   expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
   include_deleted_data: true, # Boolean | Whether to include data that was 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,12 +80,12 @@ end
 | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
 | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
 | **cursor** | **String** | The pagination cursor value. | [optional] |
-| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
+| **employee_id** | **String** | If provided, will return the benefits associated with the employee. | [optional] |
 | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
 | **include_deleted_data** | **Boolean** | Whether to include data that was 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/CommonModelScopeAPI.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::CommonModelScopeAPI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_models** | [**Array<IndividualCommonModelScopeDeserializer>**](IndividualCommonModelScopeDeserializer.md) | The common models you want to update the scopes for |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopeAPI.new(
+  common_models: [{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled_fields":["avatar","created_at","custom_fields","date_of_birth","first_name","gender","remote_created_at","remote_data"],"disabled_fields":["company","employments","groups","home_location","manager","work_location"]}}]
+)
+```
+

data/docs/CommonModelScopeData.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::CommonModelScopeData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_models** | [**Array<CommonModelScopesDisabledModels>**](CommonModelScopesDisabledModels.md) |  |  |
+| **linked_account_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopeData.new(
+  common_models: null,
+  linked_account_id: null
+)
+```
+

data/docs/CommonModelScopes.md

@@ -0,0 +1,20 @@
+# MergeHRISClient::CommonModelScopes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_level_scopes** | [**CommonModelScopeData**](CommonModelScopeData.md) |  | [optional] |
+| **scope_overrides** | [**Array<CommonModelScopeData>**](CommonModelScopeData.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::CommonModelScopes.new(
+  organization_level_scopes: null,
+  scope_overrides: [{"linked_account_id":"c640b80b-fac9-409f-aa19-1f9221aec445","common_models":[{"model_name":"Employee","model_id":"hris.Employee","enabled_actions":["READ","WRITE"],"is_disabled":false,"disabled_fields":["employment"]},{"model_name":"Employment","model_id":"hris.Employment","enabled_actions":[],"is_disabled":true,"disabled_fields":[]}]}]
+)
+```
+

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
+)
+```
+