merge_hris_client 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1019ad62ce1658e194a3bb31737940198de592a478beb103a011ccff8b93257f
-  data.tar.gz: 7f3a57417e8d5a924b61844b03963e1304eab299dbc24facdaee557f6810b5d2
+  metadata.gz: 2f2b89346995cd811138daf6df98a0f97045dcf4f03990a6c3306c14da5c9f9d
+  data.tar.gz: 144f81f0ff9b22eb70d9f11b0b3cbbfc71bdd993bc4855dfd6cadfbe476be354
 SHA512:
-  metadata.gz: 81a6f2c35383814dc9882b32b327fb01f6a255571d35fe5f3f0969f5cd370be97e4eef9ee42d86e5df72d1658594a3767208d14fd667317ac67dff99a22d9567
-  data.tar.gz: 919a1b4fe3fd8a38c0896589e84c4d1cbfa7097d56d603be3cf4ca27c819ecd7ca9c9bcaab7dff0b939abbf26aca47c5d8dd96e659db57e9e99e8858d9536c87
+  metadata.gz: 0d204253541b196e1612ac740d988033dd6a33d6ffa0bf7ced9c7fb7723f7aeb447d418d8fb7d0af399ffb995c8f820fa5f4e178fdcf582d31b721a99824035f
+  data.tar.gz: ba61ffd0632483616d42562774095959678a857c2b54657171d9daf5e98571d8b90824331a2cca6cb17130fab75284c55f90822dfdd0161a114a6dd5e1b8f5e7

data/README.md

@@ -83,50 +83,63 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
 
 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::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions | 
-*MergeHRISClient::BenefitsApi* | [**benefits_create**](docs/BenefitsApi.md#benefits_create) | **POST** /benefits | 
+*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} | 
 *MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits | 
 *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::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 | 
 *MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees | 
 *MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | 
-*MergeHRISClient::EmploymentsApi* | [**employments_create**](docs/EmploymentsApi.md#employments_create) | **POST** /employments | 
 *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 | 
 *MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key | 
 *MergeHRISClient::IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues | 
 *MergeHRISClient::IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} | 
 *MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token | 
+*MergeHRISClient::LinkedAccountsApi* | [**linked_accounts_list**](docs/LinkedAccountsApi.md#linked_accounts_list) | **GET** /linked-accounts | 
 *MergeHRISClient::LocationsApi* | [**locations_list**](docs/LocationsApi.md#locations_list) | **GET** /locations | 
 *MergeHRISClient::LocationsApi* | [**locations_retrieve**](docs/LocationsApi.md#locations_retrieve) | **GET** /locations/{id} | 
 *MergeHRISClient::PassthroughApi* | [**passthrough_create**](docs/PassthroughApi.md#passthrough_create) | **POST** /passthrough | 
+*MergeHRISClient::PayGroupsApi* | [**pay_groups_list**](docs/PayGroupsApi.md#pay_groups_list) | **GET** /pay-groups | 
+*MergeHRISClient::PayGroupsApi* | [**pay_groups_retrieve**](docs/PayGroupsApi.md#pay_groups_retrieve) | **GET** /pay-groups/{id} | 
 *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::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status | 
-*MergeHRISClient::SyncStatusApi* | [**sync_status_resync_create**](docs/SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync | 
 *MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams | 
 *MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} | 
+*MergeHRISClient::TimeOffApi* | [**time_off_create**](docs/TimeOffApi.md#time_off_create) | **POST** /time-off | 
 *MergeHRISClient::TimeOffApi* | [**time_off_list**](docs/TimeOffApi.md#time_off_list) | **GET** /time-off | 
 *MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} | 
-*MergeHRISClient::TimeOffBalanceApi* | [**time_off_balance_list**](docs/TimeOffBalanceApi.md#time_off_balance_list) | **GET** /time-off-balance | 
-*MergeHRISClient::TimeOffBalanceApi* | [**time_off_balance_retrieve**](docs/TimeOffBalanceApi.md#time_off_balance_retrieve) | **GET** /time-off-balance/{id} | 
+*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_list**](docs/TimeOffBalancesApi.md#time_off_balances_list) | **GET** /time-off-balances | 
+*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_retrieve**](docs/TimeOffBalancesApi.md#time_off_balances_retrieve) | **GET** /time-off-balances/{id} | 
 
 
 ## Documentation for Models
 
+ - [MergeHRISClient::AccountDetails](docs/AccountDetails.md)
+ - [MergeHRISClient::AccountDetailsAndActions](docs/AccountDetailsAndActions.md)
+ - [MergeHRISClient::AccountDetailsAndActionsIntegration](docs/AccountDetailsAndActionsIntegration.md)
+ - [MergeHRISClient::AccountDetailsAndActionsStatusEnum](docs/AccountDetailsAndActionsStatusEnum.md)
  - [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
  - [MergeHRISClient::AccountToken](docs/AccountToken.md)
+ - [MergeHRISClient::AccountTypeEnum](docs/AccountTypeEnum.md)
  - [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
+ - [MergeHRISClient::BankInfo](docs/BankInfo.md)
  - [MergeHRISClient::Benefit](docs/Benefit.md)
  - [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
- - [MergeHRISClient::BenefitRequest](docs/BenefitRequest.md)
+ - [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
+ - [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
  - [MergeHRISClient::Company](docs/Company.md)
  - [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
  - [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
@@ -134,12 +147,11 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::Earning](docs/Earning.md)
  - [MergeHRISClient::Employee](docs/Employee.md)
  - [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
- - [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
  - [MergeHRISClient::Employment](docs/Employment.md)
- - [MergeHRISClient::EmploymentRequest](docs/EmploymentRequest.md)
  - [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
  - [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
  - [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
+ - [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
  - [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
  - [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
  - [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
@@ -151,13 +163,17 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
  - [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
  - [MergeHRISClient::ModelOperation](docs/ModelOperation.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::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
  - [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
  - [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
  - [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
  - [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
+ - [MergeHRISClient::PaginatedPayGroupList](docs/PaginatedPayGroupList.md)
  - [MergeHRISClient::PaginatedPayrollRunList](docs/PaginatedPayrollRunList.md)
  - [MergeHRISClient::PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
  - [MergeHRISClient::PaginatedTeamList](docs/PaginatedTeamList.md)
@@ -165,13 +181,16 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::PaginatedTimeOffList](docs/PaginatedTimeOffList.md)
  - [MergeHRISClient::PayCurrencyEnum](docs/PayCurrencyEnum.md)
  - [MergeHRISClient::PayFrequencyEnum](docs/PayFrequencyEnum.md)
+ - [MergeHRISClient::PayGroup](docs/PayGroup.md)
  - [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
  - [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
+ - [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
  - [MergeHRISClient::RemoteData](docs/RemoteData.md)
  - [MergeHRISClient::RemoteDataRequest](docs/RemoteDataRequest.md)
  - [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
  - [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
  - [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
+ - [MergeHRISClient::RequestFormatEnum](docs/RequestFormatEnum.md)
  - [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
  - [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
  - [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
@@ -181,9 +200,14 @@ Class | Method | HTTP request | Description
  - [MergeHRISClient::Team](docs/Team.md)
  - [MergeHRISClient::TimeOff](docs/TimeOff.md)
  - [MergeHRISClient::TimeOffBalance](docs/TimeOffBalance.md)
+ - [MergeHRISClient::TimeOffEndpointRequest](docs/TimeOffEndpointRequest.md)
+ - [MergeHRISClient::TimeOffRequest](docs/TimeOffRequest.md)
+ - [MergeHRISClient::TimeOffResponse](docs/TimeOffResponse.md)
  - [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
  - [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
  - [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
+ - [MergeHRISClient::ValidationProblemSource](docs/ValidationProblemSource.md)
+ - [MergeHRISClient::WarningValidationProblem](docs/WarningValidationProblem.md)
 
 
 ## Documentation for Authorization

data/docs/AccountDetails.md

@@ -0,0 +1,30 @@
+# MergeHRISClient::AccountDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **integration** | **String** |  | [optional][readonly] |
+| **category** | [**CategoryEnum**](CategoryEnum.md) |  | [optional] |
+| **end_user_origin_id** | **String** |  | [optional][readonly] |
+| **end_user_organization_name** | **String** |  | [optional][readonly] |
+| **end_user_email_address** | **String** |  | [optional][readonly] |
+| **status** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AccountDetails.new(
+  id: null,
+  integration: null,
+  category: null,
+  end_user_origin_id: null,
+  end_user_organization_name: null,
+  end_user_email_address: null,
+  status: null
+)
+```
+

data/docs/AccountDetailsAndActions.md

@@ -0,0 +1,32 @@
+# MergeHRISClient::AccountDetailsAndActions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **category** | [**CategoryEnum**](CategoryEnum.md) |  | [optional] |
+| **status** | [**AccountDetailsAndActionsStatusEnum**](AccountDetailsAndActionsStatusEnum.md) |  |  |
+| **status_detail** | **String** |  | [optional] |
+| **end_user_origin_id** | **String** |  | [optional] |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_email_address** | **String** |  |  |
+| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AccountDetailsAndActions.new(
+  id: e59b1821-f85c-4e28-a6b3-1804156f3563,
+  category: hris,
+  status: COMPLETE,
+  status_detail: null,
+  end_user_origin_id: 3ac95cde-6c7f-4eef-afec-be710b42308d,
+  end_user_organization_name: Foo Bar, LLC,
+  end_user_email_address: hradmin@foobar.dev,
+  integration: null
+)
+```
+

data/docs/AccountDetailsAndActionsIntegration.md

@@ -0,0 +1,32 @@
+# MergeHRISClient::AccountDetailsAndActionsIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |  |  |
+| **image** | **String** |  | [optional] |
+| **square_image** | **String** |  | [optional] |
+| **color** | **String** |  |  |
+| **slug** | **String** |  |  |
+| **passthrough_available** | **Boolean** |  |  |
+| **available_model_operations** | [**Array<ModelOperation>**](ModelOperation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::AccountDetailsAndActionsIntegration.new(
+  name: null,
+  categories: null,
+  image: null,
+  square_image: null,
+  color: null,
+  slug: null,
+  passthrough_available: null,
+  available_model_operations: null
+)
+```
+

data/docs/AccountDetailsAndActionsStatusEnum.md

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

data/docs/AccountDetailsApi.md

@@ -0,0 +1,76 @@
+# MergeHRISClient::AccountDetailsApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_details_retrieve**](AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details |  |
+
+
+## account_details_retrieve
+
+> <AccountDetails> account_details_retrieve
+
+
+
+Get details for a linked account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::AccountDetailsApi.new
+
+begin
+  
+  result = api_instance.account_details_retrieve
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AccountDetailsApi->account_details_retrieve: #{e}"
+end
+```
+
+#### Using the account_details_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountDetails>, Integer, Hash)> account_details_retrieve_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.account_details_retrieve_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountDetails>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling AccountDetailsApi->account_details_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AccountDetails**](AccountDetails.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountTypeEnum.md

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

data/docs/BankInfo.md

@@ -0,0 +1,34 @@
+# MergeHRISClient::BankInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'merge_hris_client'
+
+instance = MergeHRISClient::BankInfo.new(
+  id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
+  remote_id: 123234,
+  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"]}]
+)
+```
+

data/docs/BankInfoApi.md

@@ -0,0 +1,193 @@
+# MergeHRISClient::BankInfoApi
+
+All URIs are relative to *https://api.merge.dev/api/hris/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bank_info_list**](BankInfoApi.md#bank_info_list) | **GET** /bank-info |  |
+| [**bank_info_retrieve**](BankInfoApi.md#bank_info_retrieve) | **GET** /bank-info/{id} |  |
+
+
+## bank_info_list
+
+> <PaginatedBankInfoList> bank_info_list(x_account_token, opts)
+
+
+
+Returns a list of `BankInfo` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::BankInfoApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  account_type: 'CHECKING', # String | The bank account type
+  bank_name: 'bank_name_example', # String | 
+  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: TODO, # String | If provided, will only return bank accounts for this employee.
+  employee_id: 'employee_id_example', # String | If provided, will only return bank accounts for this 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 deleted in the third-party service.
+  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.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_created_at: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.bank_info_list(x_account_token, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BankInfoApi->bank_info_list: #{e}"
+end
+```
+
+#### Using the bank_info_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedBankInfoList>, Integer, Hash)> bank_info_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.bank_info_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedBankInfoList>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BankInfoApi->bank_info_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **account_type** | **String** | The bank account type | [optional] |
+| **bank_name** | **String** |  | [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] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **employee** | [**String**](.md) | If provided, will only return bank accounts for this employee. | [optional] |
+| **employee_id** | **String** | If provided, will only return bank accounts for this 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 deleted in the third-party service. | [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] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_created_at** | **Time** |  | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedBankInfoList**](PaginatedBankInfoList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bank_info_retrieve
+
+> <BankInfo> bank_info_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `BankInfo` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_hris_client'
+# setup authorization
+MergeHRISClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = MergeHRISClient::BankInfoApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+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.
+}
+
+begin
+  
+  result = api_instance.bank_info_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BankInfoApi->bank_info_retrieve: #{e}"
+end
+```
+
+#### Using the bank_info_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BankInfo>, Integer, Hash)> bank_info_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.bank_info_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BankInfo>
+rescue MergeHRISClient::ApiError => e
+  puts "Error when calling BankInfoApi->bank_info_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **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] |
+
+### Return type
+
+[**BankInfo**](BankInfo.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+