merge_hris_client 3.1.0 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -13
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/BankInfo.md +2 -2
- data/docs/BankInfoApi.md +2 -2
- data/docs/Benefit.md +9 -3
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/Company.md +2 -2
- data/docs/Deduction.md +2 -2
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/Dependent.md +50 -0
- data/docs/DependentsApi.md +181 -0
- data/docs/Earning.md +2 -2
- data/docs/Employee.md +2 -2
- data/docs/EmployeePayrollRun.md +2 -2
- data/docs/EmployerBenefit.md +36 -0
- data/docs/EmployerBenefitsApi.md +177 -0
- data/docs/Employment.md +2 -2
- data/docs/EmploymentsApi.md +2 -2
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/Group.md +2 -2
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +3 -3
- data/docs/PaginatedDependentList.md +22 -0
- data/docs/PaginatedEmployerBenefitList.md +22 -0
- data/docs/PayGroup.md +2 -2
- data/docs/PayrollRun.md +2 -2
- data/docs/RelationshipEnum.md +15 -0
- data/docs/RemoteData.md +1 -1
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +2 -2
- data/docs/Team.md +2 -2
- data/docs/TimeOff.md +2 -2
- data/docs/TimeOffBalance.md +2 -2
- data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +2 -2
- data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
- data/lib/merge_hris_client/api/dependents_api.rb +188 -0
- data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
- data/lib/merge_hris_client/api/employments_api.rb +2 -2
- data/lib/merge_hris_client/api/linked_accounts_api.rb +2 -2
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_hris_client/models/bank_info.rb +10 -10
- data/lib/merge_hris_client/models/benefit.rb +42 -9
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
- data/lib/merge_hris_client/models/company.rb +10 -10
- data/lib/merge_hris_client/models/deduction.rb +10 -10
- data/lib/merge_hris_client/models/dependent.rb +470 -0
- data/lib/merge_hris_client/models/earning.rb +10 -10
- data/lib/merge_hris_client/models/employee.rb +10 -10
- data/lib/merge_hris_client/models/employee_payroll_run.rb +10 -10
- data/lib/merge_hris_client/models/employer_benefit.rb +363 -0
- data/lib/merge_hris_client/models/employment.rb +10 -10
- data/lib/merge_hris_client/models/end_user_details_request.rb +1 -1
- data/lib/merge_hris_client/models/group.rb +10 -10
- data/lib/merge_hris_client/models/location.rb +10 -10
- data/lib/merge_hris_client/models/paginated_dependent_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employer_benefit_list.rb +240 -0
- data/lib/merge_hris_client/models/pay_group.rb +10 -10
- data/lib/merge_hris_client/models/payroll_run.rb +10 -10
- data/lib/merge_hris_client/models/relationship_enum.rb +46 -0
- data/lib/merge_hris_client/models/remote_data.rb +3 -4
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
- data/lib/merge_hris_client/models/tax.rb +10 -10
- data/lib/merge_hris_client/models/team.rb +10 -10
- data/lib/merge_hris_client/models/time_off.rb +10 -10
- data/lib/merge_hris_client/models/time_off_balance.rb +10 -10
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +16 -2
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/bank_info_api_spec.rb +1 -1
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/api/dependents_api_spec.rb +70 -0
- data/spec/api/employer_benefits_api_spec.rb +68 -0
- data/spec/api/employments_api_spec.rb +1 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/bank_info_spec.rb +2 -2
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +19 -1
- data/spec/models/company_spec.rb +2 -2
- data/spec/models/deduction_spec.rb +2 -2
- data/spec/models/dependent_spec.rb +130 -0
- data/spec/models/earning_spec.rb +2 -2
- data/spec/models/employee_payroll_run_spec.rb +2 -2
- data/spec/models/employee_spec.rb +2 -2
- data/spec/models/employer_benefit_spec.rb +88 -0
- data/spec/models/employment_spec.rb +2 -2
- data/spec/models/group_spec.rb +2 -2
- data/spec/models/location_spec.rb +2 -2
- data/spec/models/paginated_dependent_list_spec.rb +46 -0
- data/spec/models/paginated_employer_benefit_list_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +2 -2
- data/spec/models/payroll_run_spec.rb +2 -2
- data/spec/models/relationship_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +2 -2
- data/spec/models/team_spec.rb +2 -2
- data/spec/models/time_off_balance_spec.rb +2 -2
- data/spec/models/time_off_spec.rb +2 -2
- metadata +161 -121
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a1011546771f2ba0f9fd3969a27e79ef97b05261719d4f70cc8db1848c710be7
|
4
|
+
data.tar.gz: 8d113662ec14505e8ed217c3768a34ef31911834c64ffbc0644e80ed3722fab8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9b7cc1d9f97f378c967d0e4d7ce15e3aabec5053d6c62f324c5b7f3390656650a99731bcc21c72633e4e8ee91ae44be5713a6e1d6da39cdfb444c09cd6300569
|
7
|
+
data.tar.gz: bf05cbfacc050b247d031d8ebaf6edae4b9dc1f3ad41a20c1db28600e5c4fe75f11bdc8cae3ee68ef53c731cf57adf753a144c07b80ae0a4967b36bd53c23891
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple HR Information Syst
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 3.1
|
10
|
+
- Package version: 3.2.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_hris_client-3.1.
|
27
|
+
gem install ./merge_hris_client-3.2.1.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_hris_client-3.1.
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-3.2.1.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_hris_client', '~> 3.1
|
36
|
+
gem 'merge_hris_client', '~> 3.2.1'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -85,16 +85,18 @@ Class | Method | HTTP request | Description
|
|
85
85
|
------------ | ------------- | ------------- | -------------
|
86
86
|
*MergeHRISClient::AccountDetailsApi* | [**account_details_retrieve**](docs/AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details |
|
87
87
|
*MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
|
88
|
+
*MergeHRISClient::AsyncPassthroughApi* | [**async_passthrough_create**](docs/AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough |
|
89
|
+
*MergeHRISClient::AsyncPassthroughApi* | [**async_passthrough_retrieve**](docs/AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} |
|
88
90
|
*MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
|
89
91
|
*MergeHRISClient::BankInfoApi* | [**bank_info_list**](docs/BankInfoApi.md#bank_info_list) | **GET** /bank-info |
|
90
92
|
*MergeHRISClient::BankInfoApi* | [**bank_info_retrieve**](docs/BankInfoApi.md#bank_info_retrieve) | **GET** /bank-info/{id} |
|
91
93
|
*MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits |
|
92
94
|
*MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |
|
93
|
-
*MergeHRISClient::CommonModelScopesApi* | [**common_model_scopes_create**](docs/CommonModelScopesApi.md#common_model_scopes_create) | **POST** /common-model-scopes |
|
94
|
-
*MergeHRISClient::CommonModelScopesApi* | [**common_model_scopes_retrieve**](docs/CommonModelScopesApi.md#common_model_scopes_retrieve) | **GET** /common-model-scopes |
|
95
95
|
*MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies |
|
96
96
|
*MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} |
|
97
|
-
*MergeHRISClient::DeleteAccountApi* | [**
|
97
|
+
*MergeHRISClient::DeleteAccountApi* | [**delete_account_delete**](docs/DeleteAccountApi.md#delete_account_delete) | **POST** /delete-account |
|
98
|
+
*MergeHRISClient::DependentsApi* | [**dependents_list**](docs/DependentsApi.md#dependents_list) | **GET** /dependents |
|
99
|
+
*MergeHRISClient::DependentsApi* | [**dependents_retrieve**](docs/DependentsApi.md#dependents_retrieve) | **GET** /dependents/{id} |
|
98
100
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
|
99
101
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
|
100
102
|
*MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees |
|
@@ -102,6 +104,8 @@ Class | Method | HTTP request | Description
|
|
102
104
|
*MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees |
|
103
105
|
*MergeHRISClient::EmployeesApi* | [**employees_meta_post_retrieve**](docs/EmployeesApi.md#employees_meta_post_retrieve) | **GET** /employees/meta/post |
|
104
106
|
*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
|
107
|
+
*MergeHRISClient::EmployerBenefitsApi* | [**employer_benefits_list**](docs/EmployerBenefitsApi.md#employer_benefits_list) | **GET** /employer-benefits |
|
108
|
+
*MergeHRISClient::EmployerBenefitsApi* | [**employer_benefits_retrieve**](docs/EmployerBenefitsApi.md#employer_benefits_retrieve) | **GET** /employer-benefits/{id} |
|
105
109
|
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
106
110
|
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
107
111
|
*MergeHRISClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
|
@@ -145,18 +149,14 @@ Class | Method | HTTP request | Description
|
|
145
149
|
- [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
|
146
150
|
- [MergeHRISClient::AccountToken](docs/AccountToken.md)
|
147
151
|
- [MergeHRISClient::AccountTypeEnum](docs/AccountTypeEnum.md)
|
152
|
+
- [MergeHRISClient::AsyncPassthroughReciept](docs/AsyncPassthroughReciept.md)
|
148
153
|
- [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
|
149
154
|
- [MergeHRISClient::BankInfo](docs/BankInfo.md)
|
150
155
|
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
156
|
+
- [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
|
151
157
|
- [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
|
152
158
|
- [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
|
153
|
-
- [MergeHRISClient::CommonModelScopeData](docs/CommonModelScopeData.md)
|
154
|
-
- [MergeHRISClient::CommonModelScopes](docs/CommonModelScopes.md)
|
155
159
|
- [MergeHRISClient::CommonModelScopesBodyRequest](docs/CommonModelScopesBodyRequest.md)
|
156
|
-
- [MergeHRISClient::CommonModelScopesDisabledModels](docs/CommonModelScopesDisabledModels.md)
|
157
|
-
- [MergeHRISClient::CommonModelScopesDisabledModelsEnabledActionsEnum](docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md)
|
158
|
-
- [MergeHRISClient::CommonModelScopesPostInnerDeserializerRequest](docs/CommonModelScopesPostInnerDeserializerRequest.md)
|
159
|
-
- [MergeHRISClient::CommonModelScopesUpdateSerializer](docs/CommonModelScopesUpdateSerializer.md)
|
160
160
|
- [MergeHRISClient::Company](docs/Company.md)
|
161
161
|
- [MergeHRISClient::ConditionSchema](docs/ConditionSchema.md)
|
162
162
|
- [MergeHRISClient::ConditionTypeEnum](docs/ConditionTypeEnum.md)
|
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
|
|
165
165
|
- [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
|
166
166
|
- [MergeHRISClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
|
167
167
|
- [MergeHRISClient::Deduction](docs/Deduction.md)
|
168
|
+
- [MergeHRISClient::Dependent](docs/Dependent.md)
|
168
169
|
- [MergeHRISClient::Earning](docs/Earning.md)
|
169
170
|
- [MergeHRISClient::EarningTypeEnum](docs/EarningTypeEnum.md)
|
170
171
|
- [MergeHRISClient::Employee](docs/Employee.md)
|
@@ -172,6 +173,7 @@ Class | Method | HTTP request | Description
|
|
172
173
|
- [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
|
173
174
|
- [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
|
174
175
|
- [MergeHRISClient::EmployeeResponse](docs/EmployeeResponse.md)
|
176
|
+
- [MergeHRISClient::EmployerBenefit](docs/EmployerBenefit.md)
|
175
177
|
- [MergeHRISClient::Employment](docs/Employment.md)
|
176
178
|
- [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
|
177
179
|
- [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
|
@@ -208,8 +210,10 @@ Class | Method | HTTP request | Description
|
|
208
210
|
- [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
|
209
211
|
- [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
|
210
212
|
- [MergeHRISClient::PaginatedConditionSchemaList](docs/PaginatedConditionSchemaList.md)
|
213
|
+
- [MergeHRISClient::PaginatedDependentList](docs/PaginatedDependentList.md)
|
211
214
|
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
212
215
|
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
216
|
+
- [MergeHRISClient::PaginatedEmployerBenefitList](docs/PaginatedEmployerBenefitList.md)
|
213
217
|
- [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
|
214
218
|
- [MergeHRISClient::PaginatedGroupList](docs/PaginatedGroupList.md)
|
215
219
|
- [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
|
@@ -227,6 +231,7 @@ Class | Method | HTTP request | Description
|
|
227
231
|
- [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
|
228
232
|
- [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
|
229
233
|
- [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
|
234
|
+
- [MergeHRISClient::RelationshipEnum](docs/RelationshipEnum.md)
|
230
235
|
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
231
236
|
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
232
237
|
- [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
@@ -0,0 +1,155 @@
|
|
1
|
+
# MergeHRISClient::AsyncPassthroughApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**async_passthrough_create**](AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough | |
|
8
|
+
| [**async_passthrough_retrieve**](AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## async_passthrough_create
|
12
|
+
|
13
|
+
> <AsyncPassthroughReciept> async_passthrough_create(x_account_token, data_passthrough_request)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Asynchronously pull data from an endpoint not currently supported by Merge.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_hris_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeHRISClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeHRISClient::AsyncPassthroughApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
data_passthrough_request = MergeHRISClient::DataPassthroughRequest.new({method: MergeHRISClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest |
|
35
|
+
|
36
|
+
begin
|
37
|
+
|
38
|
+
result = api_instance.async_passthrough_create(x_account_token, data_passthrough_request)
|
39
|
+
p result
|
40
|
+
rescue MergeHRISClient::ApiError => e
|
41
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_create: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the async_passthrough_create_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<AsyncPassthroughReciept>, Integer, Hash)> async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
|
54
|
+
data, status_code, headers = api_instance.async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <AsyncPassthroughReciept>
|
58
|
+
rescue MergeHRISClient::ApiError => e
|
59
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_create_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
68
|
+
| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) | | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**AsyncPassthroughReciept**](AsyncPassthroughReciept.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[tokenAuth](../README.md#tokenAuth)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## async_passthrough_retrieve
|
85
|
+
|
86
|
+
> <RemoteResponse> async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
Retrieves data from earlier async-passthrough POST request
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'merge_hris_client'
|
97
|
+
# setup authorization
|
98
|
+
MergeHRISClient.configure do |config|
|
99
|
+
# Configure API key authorization: tokenAuth
|
100
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
102
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = MergeHRISClient::AsyncPassthroughApi.new
|
106
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
107
|
+
async_passthrough_receipt_id = TODO # String |
|
108
|
+
|
109
|
+
begin
|
110
|
+
|
111
|
+
result = api_instance.async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
|
112
|
+
p result
|
113
|
+
rescue MergeHRISClient::ApiError => e
|
114
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve: #{e}"
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
#### Using the async_passthrough_retrieve_with_http_info variant
|
119
|
+
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
121
|
+
|
122
|
+
> <Array(<RemoteResponse>, Integer, Hash)> async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
begin
|
126
|
+
|
127
|
+
data, status_code, headers = api_instance.async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
|
128
|
+
p status_code # => 2xx
|
129
|
+
p headers # => { ... }
|
130
|
+
p data # => <RemoteResponse>
|
131
|
+
rescue MergeHRISClient::ApiError => e
|
132
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve_with_http_info: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
| Name | Type | Description | Notes |
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
140
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
141
|
+
| **async_passthrough_receipt_id** | [**String**](.md) | | |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**RemoteResponse**](RemoteResponse.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
[tokenAuth](../README.md#tokenAuth)
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeHRISClient::AsyncPassthroughReciept
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **async_passthrough_receipt_id** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_hris_client'
|
13
|
+
|
14
|
+
instance = MergeHRISClient::AsyncPassthroughReciept.new(
|
15
|
+
async_passthrough_receipt_id: fd29020f-2695-445e-922e-dcd5e81903fd
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/BankInfo.md
CHANGED
@@ -13,8 +13,8 @@
|
|
13
13
|
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING | [optional] |
|
14
14
|
| **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [optional] |
|
15
15
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
16
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
17
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
18
18
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
19
|
|
20
20
|
## Example
|
@@ -32,8 +32,8 @@ instance = MergeHRISClient::BankInfo.new(
|
|
32
32
|
account_type: CHECKING,
|
33
33
|
remote_created_at: 2021-12-06T10:11:26Z,
|
34
34
|
remote_was_deleted: null,
|
35
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
36
35
|
modified_at: 2021-10-16T00:00Z,
|
36
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
37
37
|
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}]
|
38
38
|
)
|
39
39
|
```
|
data/docs/BankInfoApi.md
CHANGED
@@ -43,7 +43,7 @@ opts = {
|
|
43
43
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
44
44
|
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.
|
45
45
|
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.
|
46
|
-
order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint.
|
46
|
+
order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
|
47
47
|
page_size: 56, # Integer | Number of results to return per page.
|
48
48
|
remote_fields: 'account_type', # String | Deprecated. Use show_enum_origins.
|
49
49
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
@@ -93,7 +93,7 @@ end
|
|
93
93
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
94
94
|
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
95
95
|
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
96
|
-
| **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
|
96
|
+
| **order_by** | **String** | Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. | [optional] |
|
97
97
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
98
98
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
99
99
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
data/docs/Benefit.md
CHANGED
@@ -11,9 +11,12 @@
|
|
11
11
|
| **benefit_plan_type** | **String** | The type of benefit plan | [optional] |
|
12
12
|
| **employee_contribution** | **Float** | The employee's contribution. | [optional] |
|
13
13
|
| **company_contribution** | **Float** | The company's contribution. | [optional] |
|
14
|
+
| **start_date** | **Time** | The day and time the benefit started. | [optional] |
|
15
|
+
| **end_date** | **Time** | The day and time the benefit ended. | [optional] |
|
14
16
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
15
|
-
| **
|
17
|
+
| **employer_benefit** | **String** | The employer benefit plan the employee is enrolled in. | [optional] |
|
16
18
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
19
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
17
20
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
18
21
|
|
19
22
|
## Example
|
@@ -26,12 +29,15 @@ instance = MergeHRISClient::Benefit.new(
|
|
26
29
|
remote_id: 19202938,
|
27
30
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
28
31
|
provider_name: Blue Shield of California,
|
29
|
-
benefit_plan_type:
|
32
|
+
benefit_plan_type: null,
|
30
33
|
employee_contribution: 23.65,
|
31
34
|
company_contribution: 150.0,
|
35
|
+
start_date: null,
|
36
|
+
end_date: null,
|
32
37
|
remote_was_deleted: null,
|
33
|
-
|
38
|
+
employer_benefit: null,
|
34
39
|
modified_at: 2021-10-16T00:00Z,
|
40
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
35
41
|
remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
|
36
42
|
)
|
37
43
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::BenefitPlanTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_hris_client'
|
12
|
+
|
13
|
+
instance = MergeHRISClient::BenefitPlanTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/Company.md
CHANGED
@@ -10,8 +10,8 @@
|
|
10
10
|
| **display_name** | **String** | The company's display name. | [optional] |
|
11
11
|
| **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
|
12
12
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
13
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
16
|
|
17
17
|
## Example
|
@@ -26,8 +26,8 @@ instance = MergeHRISClient::Company.new(
|
|
26
26
|
display_name: Waystar Royco,
|
27
27
|
eins: ["12-3456789","12-3451111","11-0011000"],
|
28
28
|
remote_was_deleted: null,
|
29
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
30
29
|
modified_at: 2021-10-16T00:00Z,
|
30
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
31
31
|
remote_data: [{"path":"/companies","data":["Varies by platform"]}]
|
32
32
|
)
|
33
33
|
```
|
data/docs/Deduction.md
CHANGED
@@ -11,8 +11,8 @@
|
|
11
11
|
| **employee_deduction** | **Float** | The amount of money that is withheld from an employee's gross pay by the employee. | [optional] |
|
12
12
|
| **company_deduction** | **Float** | The amount of money that is withheld on behalf of an employee by the company. | [optional] |
|
13
13
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
14
|
-
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
14
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
15
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
16
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
17
17
|
|
18
18
|
## Example
|
@@ -28,8 +28,8 @@ instance = MergeHRISClient::Deduction.new(
|
|
28
28
|
employee_deduction: 34.54,
|
29
29
|
company_deduction: 78.78,
|
30
30
|
remote_was_deleted: null,
|
31
|
-
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
32
31
|
modified_at: 2021-10-16T00:00Z,
|
32
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
33
33
|
remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}]
|
34
34
|
)
|
35
35
|
```
|
data/docs/DeleteAccountApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**delete_account_delete**](DeleteAccountApi.md#delete_account_delete) | **POST** /delete-account | |
|
8
8
|
|
9
9
|
|
10
|
-
##
|
10
|
+
## delete_account_delete
|
11
11
|
|
12
|
-
>
|
12
|
+
> delete_account_delete(x_account_token)
|
13
13
|
|
14
14
|
|
15
15
|
|
@@ -33,27 +33,27 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
33
33
|
|
34
34
|
begin
|
35
35
|
|
36
|
-
api_instance.
|
36
|
+
api_instance.delete_account_delete(x_account_token)
|
37
37
|
rescue MergeHRISClient::ApiError => e
|
38
|
-
puts "Error when calling DeleteAccountApi->
|
38
|
+
puts "Error when calling DeleteAccountApi->delete_account_delete: #{e}"
|
39
39
|
end
|
40
40
|
```
|
41
41
|
|
42
|
-
#### Using the
|
42
|
+
#### Using the delete_account_delete_with_http_info variant
|
43
43
|
|
44
44
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
45
45
|
|
46
|
-
> <Array(nil, Integer, Hash)>
|
46
|
+
> <Array(nil, Integer, Hash)> delete_account_delete_with_http_info(x_account_token)
|
47
47
|
|
48
48
|
```ruby
|
49
49
|
begin
|
50
50
|
|
51
|
-
data, status_code, headers = api_instance.
|
51
|
+
data, status_code, headers = api_instance.delete_account_delete_with_http_info(x_account_token)
|
52
52
|
p status_code # => 2xx
|
53
53
|
p headers # => { ... }
|
54
54
|
p data # => nil
|
55
55
|
rescue MergeHRISClient::ApiError => e
|
56
|
-
puts "Error when calling DeleteAccountApi->
|
56
|
+
puts "Error when calling DeleteAccountApi->delete_account_delete_with_http_info: #{e}"
|
57
57
|
end
|
58
58
|
```
|
59
59
|
|
data/docs/Dependent.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# MergeHRISClient::Dependent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
+
| **first_name** | **String** | The dependents's first name. | [optional] |
|
10
|
+
| **middle_name** | **String** | The dependents's middle name. | [optional] |
|
11
|
+
| **last_name** | **String** | The dependents's last name. | [optional] |
|
12
|
+
| **relationship** | [**RelationshipEnum**](RelationshipEnum.md) | The dependent's relationship to the employee. * `CHILD` - CHILD * `SPOUSE` - SPOUSE * `DOMESTIC_PARTNER` - DOMESTIC_PARTNER | [optional] |
|
13
|
+
| **employee** | **String** | The employee this person is a dependent of. | [optional] |
|
14
|
+
| **date_of_birth** | **Time** | The dependent's date of birth. | [optional] |
|
15
|
+
| **gender** | [**GenderEnum**](GenderEnum.md) | The dependent's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE | [optional] |
|
16
|
+
| **phone_number** | **String** | The dependent's phone number. | [optional] |
|
17
|
+
| **home_location** | **String** | The dependents's home address. | [optional] |
|
18
|
+
| **is_student** | **Boolean** | Whether or not the dependent is a student | [optional] |
|
19
|
+
| **ssn** | **String** | The dependents's social security number. | [optional] |
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
22
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
23
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'merge_hris_client'
|
29
|
+
|
30
|
+
instance = MergeHRISClient::Dependent.new(
|
31
|
+
id: null,
|
32
|
+
remote_id: 19202940,
|
33
|
+
first_name: Greg,
|
34
|
+
middle_name: A,
|
35
|
+
last_name: Hirsch,
|
36
|
+
relationship: CHILD,
|
37
|
+
employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
38
|
+
date_of_birth: 1990-11-10T00:00Z,
|
39
|
+
gender: MALE,
|
40
|
+
phone_number: +1234567890,
|
41
|
+
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
42
|
+
is_student: null,
|
43
|
+
ssn: 1234567890,
|
44
|
+
remote_was_deleted: null,
|
45
|
+
modified_at: 2021-10-16T00:00Z,
|
46
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
47
|
+
remote_data: [{"path":"/dependent","data":["Varies by platform"]}]
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|