merge_hris_client 3.0.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c9d5def0568843138c03dfa40dd5655225af75383733fcaa2c8b0176d7ab3f7
-  data.tar.gz: f5c7735da13e84b728d7a00ef3dee15a28bcc73f1f5422c2f78c0209096dd635
+  metadata.gz: a1011546771f2ba0f9fd3969a27e79ef97b05261719d4f70cc8db1848c710be7
+  data.tar.gz: 8d113662ec14505e8ed217c3768a34ef31911834c64ffbc0644e80ed3722fab8
 SHA512:
-  metadata.gz: 9b0bfd9e0793473b53f1c23475b03a73bd23be5afa38432f029fbc8f05a05770e55805c52fac385c46e03501f37a70171022dd993b5065687976865853894ed5
-  data.tar.gz: 9e8d7e0de37fed201ff377b7d5b7bd4604873bf22a11b27b3702898fc13abd9afd358ee94f949c63876c1f71acf4583f5355d2cd07de9e1bac3a9f2917d748f1
+  metadata.gz: 9b7cc1d9f97f378c967d0e4d7ce15e3aabec5053d6c62f324c5b7f3390656650a99731bcc21c72633e4e8ee91ae44be5713a6e1d6da39cdfb444c09cd6300569
+  data.tar.gz: bf05cbfacc050b247d031d8ebaf6edae4b9dc1f3ad41a20c1db28600e5c4fe75f11bdc8cae3ee68ef53c731cf57adf753a144c07b80ae0a4967b36bd53c23891

data/README.md

@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple HR Information Syst
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 3.0.0
+- Package version: 3.2.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
 
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./merge_hris_client-3.0.0.gem
+gem install ./merge_hris_client-3.2.1.gem
 ```
 
-(for development, run `gem install --dev ./merge_hris_client-3.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./merge_hris_client-3.2.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'merge_hris_client', '~> 3.0.0'
+    gem 'merge_hris_client', '~> 3.2.1'
 
 ### Install from Git
 
@@ -85,6 +85,8 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *MergeHRISClient::AccountDetailsApi* | [**account_details_retrieve**](docs/AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details | 
 *MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} | 
+*MergeHRISClient::AsyncPassthroughApi* | [**async_passthrough_create**](docs/AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough | 
+*MergeHRISClient::AsyncPassthroughApi* | [**async_passthrough_retrieve**](docs/AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} | 
 *MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions | 
 *MergeHRISClient::BankInfoApi* | [**bank_info_list**](docs/BankInfoApi.md#bank_info_list) | **GET** /bank-info | 
 *MergeHRISClient::BankInfoApi* | [**bank_info_retrieve**](docs/BankInfoApi.md#bank_info_retrieve) | **GET** /bank-info/{id} | 
@@ -92,9 +94,9 @@ Class | Method | HTTP request | Description
 *MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} | 
 *MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies | 
 *MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} | 
-*MergeHRISClient::DeductionsApi* | [**deductions_list**](docs/DeductionsApi.md#deductions_list) | **GET** /deductions | 
-*MergeHRISClient::DeductionsApi* | [**deductions_retrieve**](docs/DeductionsApi.md#deductions_retrieve) | **GET** /deductions/{id} | 
-*MergeHRISClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account | 
+*MergeHRISClient::DeleteAccountApi* | [**delete_account_delete**](docs/DeleteAccountApi.md#delete_account_delete) | **POST** /delete-account | 
+*MergeHRISClient::DependentsApi* | [**dependents_list**](docs/DependentsApi.md#dependents_list) | **GET** /dependents | 
+*MergeHRISClient::DependentsApi* | [**dependents_retrieve**](docs/DependentsApi.md#dependents_retrieve) | **GET** /dependents/{id} | 
 *MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs | 
 *MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} | 
 *MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees | 
@@ -102,6 +104,8 @@ Class | Method | HTTP request | Description
 *MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees | 
 *MergeHRISClient::EmployeesApi* | [**employees_meta_post_retrieve**](docs/EmployeesApi.md#employees_meta_post_retrieve) | **GET** /employees/meta/post | 
 *MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | 
+*MergeHRISClient::EmployerBenefitsApi* | [**employer_benefits_list**](docs/EmployerBenefitsApi.md#employer_benefits_list) | **GET** /employer-benefits | 
+*MergeHRISClient::EmployerBenefitsApi* | [**employer_benefits_retrieve**](docs/EmployerBenefitsApi.md#employer_benefits_retrieve) | **GET** /employer-benefits/{id} | 
 *MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments | 
 *MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} | 
 *MergeHRISClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync | 
@@ -120,6 +124,9 @@ Class | Method | HTTP request | Description
 *MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs | 
 *MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} | 
 *MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key | 
+*MergeHRISClient::SelectiveSyncApi* | [**selective_sync_configurations_list**](docs/SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations | 
+*MergeHRISClient::SelectiveSyncApi* | [**selective_sync_configurations_update**](docs/SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations | 
+*MergeHRISClient::SelectiveSyncApi* | [**selective_sync_meta_list**](docs/SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta | 
 *MergeHRISClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status | 
 *MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams | 
 *MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} | 
@@ -142,17 +149,23 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
  - [MergeHRISClient::AccountToken](docs/AccountToken.md)
  - [MergeHRISClient::AccountTypeEnum](docs/AccountTypeEnum.md)
+ - [MergeHRISClient::AsyncPassthroughReciept](docs/AsyncPassthroughReciept.md)
  - [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
  - [MergeHRISClient::BankInfo](docs/BankInfo.md)
  - [MergeHRISClient::Benefit](docs/Benefit.md)
+ - [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
  - [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
  - [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
+ - [MergeHRISClient::CommonModelScopesBodyRequest](docs/CommonModelScopesBodyRequest.md)
  - [MergeHRISClient::Company](docs/Company.md)
+ - [MergeHRISClient::ConditionSchema](docs/ConditionSchema.md)
+ - [MergeHRISClient::ConditionTypeEnum](docs/ConditionTypeEnum.md)
  - [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
  - [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
  - [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
  - [MergeHRISClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
  - [MergeHRISClient::Deduction](docs/Deduction.md)
+ - [MergeHRISClient::Dependent](docs/Dependent.md)
  - [MergeHRISClient::Earning](docs/Earning.md)
  - [MergeHRISClient::EarningTypeEnum](docs/EarningTypeEnum.md)
  - [MergeHRISClient::Employee](docs/Employee.md)
@@ -160,9 +173,11 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
  - [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
  - [MergeHRISClient::EmployeeResponse](docs/EmployeeResponse.md)
+ - [MergeHRISClient::EmployerBenefit](docs/EmployerBenefit.md)
  - [MergeHRISClient::Employment](docs/Employment.md)
  - [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
  - [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
+ - [MergeHRISClient::EnabledActionsEnum](docs/EnabledActionsEnum.md)
  - [MergeHRISClient::EncodingEnum](docs/EncodingEnum.md)
  - [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
  - [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
@@ -172,11 +187,15 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
  - [MergeHRISClient::Group](docs/Group.md)
  - [MergeHRISClient::GroupTypeEnum](docs/GroupTypeEnum.md)
- - [MergeHRISClient::IgnoreCommonModel](docs/IgnoreCommonModel.md)
  - [MergeHRISClient::IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
  - [MergeHRISClient::Issue](docs/Issue.md)
  - [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
  - [MergeHRISClient::LinkToken](docs/LinkToken.md)
+ - [MergeHRISClient::LinkedAccountCondition](docs/LinkedAccountCondition.md)
+ - [MergeHRISClient::LinkedAccountConditionRequest](docs/LinkedAccountConditionRequest.md)
+ - [MergeHRISClient::LinkedAccountSelectiveSyncConfiguration](docs/LinkedAccountSelectiveSyncConfiguration.md)
+ - [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest](docs/LinkedAccountSelectiveSyncConfigurationListRequest.md)
+ - [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest](docs/LinkedAccountSelectiveSyncConfigurationRequest.md)
  - [MergeHRISClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
  - [MergeHRISClient::Location](docs/Location.md)
  - [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
@@ -185,13 +204,16 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
  - [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
  - [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
+ - [MergeHRISClient::OperatorSchema](docs/OperatorSchema.md)
  - [MergeHRISClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
  - [MergeHRISClient::PaginatedBankInfoList](docs/PaginatedBankInfoList.md)
  - [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
  - [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
- - [MergeHRISClient::PaginatedDeductionList](docs/PaginatedDeductionList.md)
+ - [MergeHRISClient::PaginatedConditionSchemaList](docs/PaginatedConditionSchemaList.md)
+ - [MergeHRISClient::PaginatedDependentList](docs/PaginatedDependentList.md)
  - [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
  - [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
+ - [MergeHRISClient::PaginatedEmployerBenefitList](docs/PaginatedEmployerBenefitList.md)
  - [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
  - [MergeHRISClient::PaginatedGroupList](docs/PaginatedGroupList.md)
  - [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
@@ -209,6 +231,7 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
  - [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
  - [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
+ - [MergeHRISClient::RelationshipEnum](docs/RelationshipEnum.md)
  - [MergeHRISClient::RemoteData](docs/RemoteData.md)
  - [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
  - [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
@@ -218,6 +241,7 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::ResponseTypeEnum](docs/ResponseTypeEnum.md)
  - [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
  - [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
+ - [MergeHRISClient::SelectiveSyncConfigurationsUsageEnum](docs/SelectiveSyncConfigurationsUsageEnum.md)
  - [MergeHRISClient::SyncStatus](docs/SyncStatus.md)
  - [MergeHRISClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
  - [MergeHRISClient::Tax](docs/Tax.md)

data/docs/AccountIntegration.md

@@ -5,11 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Company name. |  |
-| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated.<br/><br>Example: For [ats, hris], enter <i>ats,hris</i> | [optional] |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris]. | [optional] |
 | **image** | **String** | Company logo in rectangular shape. <b>Upload an image with a clear background.</b> | [optional] |
 | **square_image** | **String** | Company logo in square shape. <b>Upload an image with a white background.</b> | [optional] |
 | **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b> | [optional] |
 | **slug** | **String** |  | [optional][readonly] |
+| **is_in_beta** | **Boolean** | If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag. | [optional] |
+| **api_endpoints_to_documentation_urls** | [**Hash<String, AnyType>**](AnyType.md) | Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []} | [optional] |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = MergeHRISClient::AccountIntegration.new(
   image: null,
   square_image: null,
   color: null,
-  slug: null
+  slug: null,
+  is_in_beta: null,
+  api_endpoints_to_documentation_urls: null
 )
 ```
 

data/docs/AsyncPassthroughApi.md

@@ -0,0 +1,155 @@
+# MergeHRISClient::AsyncPassthroughApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**async_passthrough_create**](AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough |  |
+| [**async_passthrough_retrieve**](AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} |  |
+
+
+## async_passthrough_create
+
+> <AsyncPassthroughReciept> async_passthrough_create(x_account_token, data_passthrough_request)
+
+
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+### 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::AsyncPassthroughApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+data_passthrough_request = MergeHRISClient::DataPassthroughRequest.new({method: MergeHRISClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest | 
+
+begin
+  
+  result = api_instance.async_passthrough_create(x_account_token, data_passthrough_request)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AsyncPassthroughApi->async_passthrough_create: #{e}"
+end
+```
+
+#### Using the async_passthrough_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncPassthroughReciept>, Integer, Hash)> async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncPassthroughReciept>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AsyncPassthroughApi->async_passthrough_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) |  |  |
+
+### Return type
+
+[**AsyncPassthroughReciept**](AsyncPassthroughReciept.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## async_passthrough_retrieve
+
+> <RemoteResponse> async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
+
+
+
+Retrieves data from earlier async-passthrough POST request
+
+### 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::AsyncPassthroughApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+async_passthrough_receipt_id = TODO # String | 
+
+begin
+  
+  result = api_instance.async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve: #{e}"
+end
+```
+
+#### Using the async_passthrough_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteResponse>, Integer, Hash)> async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteResponse>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **async_passthrough_receipt_id** | [**String**](.md) |  |  |
+
+### Return type
+
+[**RemoteResponse**](RemoteResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AsyncPassthroughReciept.md

@@ -0,0 +1,18 @@
+# MergeHRISClient::AsyncPassthroughReciept
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **async_passthrough_receipt_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AsyncPassthroughReciept.new(
+  async_passthrough_receipt_id: fd29020f-2695-445e-922e-dcd5e81903fd
+)
+```
+

data/docs/BankInfo.md

@@ -6,14 +6,16 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **String** |  | [optional] |
+| **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_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
 
@@ -29,8 +31,10 @@ instance = MergeHRISClient::BankInfo.new(
   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,
+  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":"/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 | Which fields should be returned in non-normalized form.
 }
 
 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** | Which fields should be returned in non-normalized form. | [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 | Which fields should be returned in non-normalized form.
 }
 
 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** | Which fields should be returned in non-normalized form. | [optional] |
 
 ### Return type
 

data/docs/Benefit.md

@@ -6,13 +6,18 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional][readonly] |
 | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
-| **employee** | **String** |  | [optional] |
+| **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] |
-| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **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 by third party webhooks. | [optional][readonly] |
+| **employer_benefit** | **String** | The employer benefit plan the employee is enrolled in. | [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
 
@@ -24,11 +29,16 @@ instance = MergeHRISClient::Benefit.new(
   remote_id: 19202938,
   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,
+  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":"/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/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":[]}]}]
+)
+```
+