merge_hris_client 1.0.4 → 2.0.2
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 +37 -12
- data/docs/AccountDetails.md +11 -7
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/AccountDetailsApi.md +10 -7
- data/docs/AccountIntegration.md +4 -4
- data/docs/AccountTokenApi.md +2 -2
- data/docs/AvailableActionsApi.md +2 -2
- data/docs/BankInfo.md +1 -1
- data/docs/BankInfoApi.md +8 -12
- data/docs/Benefit.md +2 -2
- data/docs/BenefitsApi.md +4 -4
- data/docs/CompaniesApi.md +4 -4
- data/docs/Company.md +2 -2
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/DebugModeLog.md +22 -0
- data/docs/DebugModelLogSummary.md +22 -0
- data/docs/Deduction.md +2 -2
- data/docs/DeductionsApi.md +4 -4
- data/docs/DeleteAccountApi.md +3 -2
- data/docs/Earning.md +3 -3
- data/docs/EarningTypeEnum.md +15 -0
- data/docs/Employee.md +17 -15
- data/docs/EmployeeEndpointRequest.md +18 -0
- data/docs/EmployeePayrollRun.md +2 -2
- data/docs/EmployeePayrollRunsApi.md +4 -4
- data/docs/EmployeeRequest.md +70 -0
- data/docs/EmployeeResponse.md +24 -0
- data/docs/EmployeesApi.md +232 -4
- data/docs/Employment.md +6 -4
- data/docs/EmploymentsApi.md +5 -4
- data/docs/EncodingEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +5 -3
- data/docs/ForceResyncApi.md +2 -2
- data/docs/GenerateKeyApi.md +2 -2
- data/docs/Group.md +28 -0
- data/docs/GroupTypeEnum.md +15 -0
- data/docs/GroupsApi.md +177 -0
- data/docs/IgnoreCommonModel.md +20 -0
- data/docs/IssuesApi.md +13 -4
- data/docs/LinkTokenApi.md +3 -3
- data/docs/LinkedAccountStatus.md +20 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +3 -1
- data/docs/LocationsApi.md +4 -4
- data/docs/MetaResponse.md +24 -0
- data/docs/MultipartFormFieldRequest.md +26 -0
- data/docs/PaginatedGroupList.md +22 -0
- data/docs/PassthroughApi.md +2 -2
- data/docs/PayGroupsApi.md +4 -4
- data/docs/PayrollRunsApi.md +4 -4
- data/docs/RegenerateKeyApi.md +2 -2
- data/docs/SyncStatusApi.md +0 -1
- data/docs/Tax.md +2 -2
- data/docs/Team.md +1 -1
- data/docs/TeamsApi.md +5 -4
- data/docs/TimeOff.md +4 -4
- data/docs/TimeOffApi.md +80 -6
- data/docs/TimeOffBalance.md +2 -2
- data/docs/TimeOffRequest.md +4 -4
- data/docs/TimeOffResponse.md +3 -1
- data/docs/WebhookReceiver.md +22 -0
- data/docs/WebhookReceiverRequest.md +22 -0
- data/docs/WebhookReceiversApi.md +153 -0
- data/lib/merge_hris_client/api/account_details_api.rb +10 -3
- data/lib/merge_hris_client/api/bank_info_api.rb +4 -9
- data/lib/merge_hris_client/api/employees_api.rb +216 -2
- data/lib/merge_hris_client/api/employments_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +182 -0
- data/lib/merge_hris_client/api/issues_api.rb +12 -0
- data/lib/merge_hris_client/api/linked_accounts_api.rb +1 -1
- data/lib/merge_hris_client/api/sync_status_api.rb +0 -62
- data/lib/merge_hris_client/api/time_off_api.rb +65 -0
- data/lib/merge_hris_client/api/webhook_receivers_api.rb +154 -0
- data/lib/merge_hris_client/configuration.rb +6 -4
- data/lib/merge_hris_client/models/account_details.rb +23 -5
- data/lib/merge_hris_client/models/account_details_and_actions.rb +16 -2
- data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +1 -1
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +1 -0
- data/lib/merge_hris_client/models/account_integration.rb +5 -27
- data/lib/merge_hris_client/models/account_token.rb +1 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +1 -0
- data/lib/merge_hris_client/models/available_actions.rb +1 -1
- data/lib/merge_hris_client/models/bank_info.rb +0 -1
- data/lib/merge_hris_client/models/benefit.rb +1 -2
- data/lib/merge_hris_client/models/categories_enum.rb +1 -0
- data/lib/merge_hris_client/models/category_enum.rb +1 -0
- data/lib/merge_hris_client/models/company.rb +1 -1
- data/lib/merge_hris_client/models/country_enum.rb +1 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +17 -3
- data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
- data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
- data/lib/merge_hris_client/models/deduction.rb +0 -1
- data/lib/merge_hris_client/models/earning.rb +4 -7
- data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/employee.rb +14 -9
- data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
- data/lib/merge_hris_client/models/employee_request.rb +564 -0
- data/lib/merge_hris_client/models/employee_response.rb +266 -0
- data/lib/merge_hris_client/models/employment.rb +12 -3
- data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/encoding_enum.rb +36 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +74 -27
- data/lib/merge_hris_client/models/error_validation_problem.rb +1 -1
- data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
- data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/gender_enum.rb +1 -1
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -1
- data/lib/merge_hris_client/models/group.rb +275 -0
- data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
- data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
- data/lib/merge_hris_client/models/issue.rb +1 -1
- data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/link_token.rb +1 -1
- data/lib/merge_hris_client/models/linked_account_status.rb +237 -0
- data/lib/merge_hris_client/models/location.rb +13 -2
- data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
- data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/meta_response.rb +262 -0
- data/lib/merge_hris_client/models/method_enum.rb +1 -1
- data/lib/merge_hris_client/models/model_operation.rb +1 -1
- data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
- data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_bank_info_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_deduction_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_pay_group_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
- data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
- data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
- data/lib/merge_hris_client/models/payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/policy_type_enum.rb +1 -0
- data/lib/merge_hris_client/models/reason_enum.rb +37 -0
- data/lib/merge_hris_client/models/remote_data.rb +1 -1
- data/lib/merge_hris_client/models/remote_data_request.rb +1 -1
- data/lib/merge_hris_client/models/remote_key.rb +1 -1
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -1
- data/lib/merge_hris_client/models/remote_response.rb +1 -1
- data/lib/merge_hris_client/models/request_format_enum.rb +2 -0
- data/lib/merge_hris_client/models/request_type_enum.rb +1 -0
- data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
- data/lib/merge_hris_client/models/sync_status.rb +1 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +1 -2
- data/lib/merge_hris_client/models/tax.rb +3 -6
- data/lib/merge_hris_client/models/team.rb +0 -1
- data/lib/merge_hris_client/models/time_off.rb +0 -2
- data/lib/merge_hris_client/models/time_off_balance.rb +1 -2
- data/lib/merge_hris_client/models/time_off_endpoint_request.rb +1 -1
- data/lib/merge_hris_client/models/time_off_request.rb +1 -3
- data/lib/merge_hris_client/models/time_off_response.rb +16 -5
- data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/units_enum.rb +1 -1
- data/lib/merge_hris_client/models/validation_problem_source.rb +1 -1
- data/lib/merge_hris_client/models/warning_validation_problem.rb +1 -1
- data/lib/merge_hris_client/models/webhook_receiver.rb +246 -0
- data/lib/merge_hris_client/models/webhook_receiver_request.rb +280 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +21 -2
- data/pull_request_template.md +3 -1
- data/spec/api/account_details_api_spec.rb +1 -0
- data/spec/api/bank_info_api_spec.rb +2 -4
- data/spec/api/employees_api_spec.rb +38 -0
- data/spec/api/groups_api_spec.rb +68 -0
- data/spec/api/issues_api_spec.rb +4 -0
- data/spec/api/time_off_api_spec.rb +12 -0
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/debug_mode_log_spec.rb +46 -0
- data/spec/models/debug_model_log_summary_spec.rb +46 -0
- data/spec/models/earning_type_enum_spec.rb +28 -0
- data/spec/models/employee_endpoint_request_spec.rb +34 -0
- data/spec/models/employee_request_spec.rb +190 -0
- data/spec/models/employee_response_spec.rb +52 -0
- data/spec/models/employee_spec.rb +6 -0
- data/spec/models/employment_spec.rb +6 -0
- data/spec/models/encoding_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/group_spec.rb +64 -0
- data/spec/models/group_type_enum_spec.rb +28 -0
- data/spec/models/ignore_common_model_spec.rb +40 -0
- data/spec/models/location_spec.rb +6 -0
- data/spec/models/multipart_form_field_request_spec.rb +58 -0
- data/spec/models/paginated_group_list_spec.rb +46 -0
- data/spec/models/time_off_response_spec.rb +6 -0
- metadata +153 -89
- data/test_ruby.rb +0 -30
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 934d37bd63a49bd224602a6a273f4ba7b5812fb465ab9bdf5286e4876445469f
|
|
4
|
+
data.tar.gz: 730ed22b9de01ba6520be7f3eb1c326d6c461ff58419744d5e107d6f9eb33104
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 15841f25f3c023c67577190622ffff5f58b99abacbdcaf982faa706feb5fef9d9b46745abae77982abfb8777a5096eeb2aaa7875e13d8d7208884c50a738c4d4
|
|
7
|
+
data.tar.gz: 2472db4273f90ac24d4bee2eda0e55f91c7a2d8d08136bf7302e4119eac799f675b3efc6cb546ffb493b511aaf90855de8b3619c8812edabb79eed85472e0c99
|
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:
|
|
10
|
+
- Package version: 2.0.2
|
|
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-
|
|
27
|
+
gem install ./merge_hris_client-2.0.2.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./merge_hris_client-
|
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-2.0.2.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', '~>
|
|
36
|
+
gem 'merge_hris_client', '~> 2.0.2'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -60,19 +60,19 @@ require 'merge_hris_client'
|
|
|
60
60
|
# Setup authorization
|
|
61
61
|
MergeHRISClient.configure do |config|
|
|
62
62
|
# Configure API key authorization: tokenAuth
|
|
63
|
-
config.api_key['
|
|
63
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
64
64
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
65
|
-
#config.api_key_prefix['
|
|
65
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
66
66
|
end
|
|
67
67
|
|
|
68
|
-
api_instance = MergeHRISClient::
|
|
69
|
-
|
|
68
|
+
api_instance = MergeHRISClient::AccountDetailsApi.new
|
|
69
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
70
70
|
|
|
71
71
|
begin
|
|
72
|
-
result = api_instance.
|
|
72
|
+
result = api_instance.account_details_retrieve(x_account_token)
|
|
73
73
|
p result
|
|
74
74
|
rescue MergeHRISClient::ApiError => e
|
|
75
|
-
puts "Exception when calling
|
|
75
|
+
puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
|
|
76
76
|
end
|
|
77
77
|
|
|
78
78
|
```
|
|
@@ -97,12 +97,17 @@ Class | Method | HTTP request | Description
|
|
|
97
97
|
*MergeHRISClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |
|
|
98
98
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
|
|
99
99
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
|
|
100
|
+
*MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees |
|
|
101
|
+
*MergeHRISClient::EmployeesApi* | [**employees_ignore_create**](docs/EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} |
|
|
100
102
|
*MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees |
|
|
103
|
+
*MergeHRISClient::EmployeesApi* | [**employees_meta_post_retrieve**](docs/EmployeesApi.md#employees_meta_post_retrieve) | **GET** /employees/meta/post |
|
|
101
104
|
*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
|
|
102
105
|
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
|
103
106
|
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
|
104
107
|
*MergeHRISClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
|
|
105
108
|
*MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
|
|
109
|
+
*MergeHRISClient::GroupsApi* | [**groups_list**](docs/GroupsApi.md#groups_list) | **GET** /groups |
|
|
110
|
+
*MergeHRISClient::GroupsApi* | [**groups_retrieve**](docs/GroupsApi.md#groups_retrieve) | **GET** /groups/{id} |
|
|
106
111
|
*MergeHRISClient::IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues |
|
|
107
112
|
*MergeHRISClient::IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |
|
|
108
113
|
*MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token |
|
|
@@ -120,9 +125,12 @@ Class | Method | HTTP request | Description
|
|
|
120
125
|
*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
|
|
121
126
|
*MergeHRISClient::TimeOffApi* | [**time_off_create**](docs/TimeOffApi.md#time_off_create) | **POST** /time-off |
|
|
122
127
|
*MergeHRISClient::TimeOffApi* | [**time_off_list**](docs/TimeOffApi.md#time_off_list) | **GET** /time-off |
|
|
128
|
+
*MergeHRISClient::TimeOffApi* | [**time_off_meta_post_retrieve**](docs/TimeOffApi.md#time_off_meta_post_retrieve) | **GET** /time-off/meta/post |
|
|
123
129
|
*MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |
|
|
124
130
|
*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_list**](docs/TimeOffBalancesApi.md#time_off_balances_list) | **GET** /time-off-balances |
|
|
125
131
|
*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_retrieve**](docs/TimeOffBalancesApi.md#time_off_balances_retrieve) | **GET** /time-off-balances/{id} |
|
|
132
|
+
*MergeHRISClient::WebhookReceiversApi* | [**webhook_receivers_create**](docs/WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers |
|
|
133
|
+
*MergeHRISClient::WebhookReceiversApi* | [**webhook_receivers_list**](docs/WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers |
|
|
126
134
|
|
|
127
135
|
|
|
128
136
|
## Documentation for Models
|
|
@@ -137,32 +145,46 @@ Class | Method | HTTP request | Description
|
|
|
137
145
|
- [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
|
|
138
146
|
- [MergeHRISClient::BankInfo](docs/BankInfo.md)
|
|
139
147
|
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
|
140
|
-
- [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
|
|
141
148
|
- [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
|
|
142
149
|
- [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
|
|
143
150
|
- [MergeHRISClient::Company](docs/Company.md)
|
|
144
151
|
- [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
|
|
145
152
|
- [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
|
153
|
+
- [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
|
|
154
|
+
- [MergeHRISClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
|
|
146
155
|
- [MergeHRISClient::Deduction](docs/Deduction.md)
|
|
147
156
|
- [MergeHRISClient::Earning](docs/Earning.md)
|
|
157
|
+
- [MergeHRISClient::EarningTypeEnum](docs/EarningTypeEnum.md)
|
|
148
158
|
- [MergeHRISClient::Employee](docs/Employee.md)
|
|
159
|
+
- [MergeHRISClient::EmployeeEndpointRequest](docs/EmployeeEndpointRequest.md)
|
|
149
160
|
- [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
|
|
161
|
+
- [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
|
|
162
|
+
- [MergeHRISClient::EmployeeResponse](docs/EmployeeResponse.md)
|
|
150
163
|
- [MergeHRISClient::Employment](docs/Employment.md)
|
|
151
164
|
- [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
|
|
152
165
|
- [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
|
|
166
|
+
- [MergeHRISClient::EncodingEnum](docs/EncodingEnum.md)
|
|
153
167
|
- [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
|
154
168
|
- [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
|
|
155
169
|
- [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
|
|
156
170
|
- [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
|
|
157
171
|
- [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
|
|
158
172
|
- [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
|
|
173
|
+
- [MergeHRISClient::Group](docs/Group.md)
|
|
174
|
+
- [MergeHRISClient::GroupTypeEnum](docs/GroupTypeEnum.md)
|
|
175
|
+
- [MergeHRISClient::IgnoreCommonModel](docs/IgnoreCommonModel.md)
|
|
176
|
+
- [MergeHRISClient::IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
|
|
159
177
|
- [MergeHRISClient::Issue](docs/Issue.md)
|
|
160
178
|
- [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
|
161
179
|
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
|
180
|
+
- [MergeHRISClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
|
|
162
181
|
- [MergeHRISClient::Location](docs/Location.md)
|
|
182
|
+
- [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
|
|
163
183
|
- [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
|
|
184
|
+
- [MergeHRISClient::MetaResponse](docs/MetaResponse.md)
|
|
164
185
|
- [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
|
|
165
186
|
- [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
|
|
187
|
+
- [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
|
|
166
188
|
- [MergeHRISClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
|
|
167
189
|
- [MergeHRISClient::PaginatedBankInfoList](docs/PaginatedBankInfoList.md)
|
|
168
190
|
- [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
|
|
@@ -171,6 +193,7 @@ Class | Method | HTTP request | Description
|
|
|
171
193
|
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
|
172
194
|
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
|
173
195
|
- [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
|
|
196
|
+
- [MergeHRISClient::PaginatedGroupList](docs/PaginatedGroupList.md)
|
|
174
197
|
- [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
|
|
175
198
|
- [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
|
|
176
199
|
- [MergeHRISClient::PaginatedPayGroupList](docs/PaginatedPayGroupList.md)
|
|
@@ -185,6 +208,7 @@ Class | Method | HTTP request | Description
|
|
|
185
208
|
- [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
|
|
186
209
|
- [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
|
|
187
210
|
- [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
|
|
211
|
+
- [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
|
|
188
212
|
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
|
189
213
|
- [MergeHRISClient::RemoteDataRequest](docs/RemoteDataRequest.md)
|
|
190
214
|
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
|
@@ -204,10 +228,11 @@ Class | Method | HTTP request | Description
|
|
|
204
228
|
- [MergeHRISClient::TimeOffRequest](docs/TimeOffRequest.md)
|
|
205
229
|
- [MergeHRISClient::TimeOffResponse](docs/TimeOffResponse.md)
|
|
206
230
|
- [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
|
|
207
|
-
- [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
|
|
208
231
|
- [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
|
|
209
232
|
- [MergeHRISClient::ValidationProblemSource](docs/ValidationProblemSource.md)
|
|
210
233
|
- [MergeHRISClient::WarningValidationProblem](docs/WarningValidationProblem.md)
|
|
234
|
+
- [MergeHRISClient::WebhookReceiver](docs/WebhookReceiver.md)
|
|
235
|
+
- [MergeHRISClient::WebhookReceiverRequest](docs/WebhookReceiverRequest.md)
|
|
211
236
|
|
|
212
237
|
|
|
213
238
|
## Documentation for Authorization
|
data/docs/AccountDetails.md
CHANGED
|
@@ -6,11 +6,13 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **integration** | **String** | | [optional][readonly] |
|
|
9
|
+
| **integration_slug** | **String** | | [optional][readonly] |
|
|
9
10
|
| **category** | [**CategoryEnum**](CategoryEnum.md) | | [optional] |
|
|
10
11
|
| **end_user_origin_id** | **String** | | [optional][readonly] |
|
|
11
12
|
| **end_user_organization_name** | **String** | | [optional][readonly] |
|
|
12
13
|
| **end_user_email_address** | **String** | | [optional][readonly] |
|
|
13
14
|
| **status** | **String** | | [optional][readonly] |
|
|
15
|
+
| **webhook_listener_url** | **String** | | [optional][readonly] |
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -18,13 +20,15 @@
|
|
|
18
20
|
require 'merge_hris_client'
|
|
19
21
|
|
|
20
22
|
instance = MergeHRISClient::AccountDetails.new(
|
|
21
|
-
id:
|
|
22
|
-
integration:
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
23
|
+
id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd,
|
|
24
|
+
integration: BambooHR,
|
|
25
|
+
integration_slug: bamboohr,
|
|
26
|
+
category: hris,
|
|
27
|
+
end_user_origin_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
|
28
|
+
end_user_organization_name: Waystar Royco,
|
|
29
|
+
end_user_email_address: kendall.roy@waystar-royco.com,
|
|
30
|
+
status: COMPLETE,
|
|
31
|
+
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4
|
|
28
32
|
)
|
|
29
33
|
```
|
|
30
34
|
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **end_user_origin_id** | **String** | | [optional] |
|
|
12
12
|
| **end_user_organization_name** | **String** | | |
|
|
13
13
|
| **end_user_email_address** | **String** | | |
|
|
14
|
+
| **webhook_listener_url** | **String** | | |
|
|
14
15
|
| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) | | [optional] |
|
|
15
16
|
|
|
16
17
|
## Example
|
|
@@ -26,6 +27,7 @@ instance = MergeHRISClient::AccountDetailsAndActions.new(
|
|
|
26
27
|
end_user_origin_id: 3ac95cde-6c7f-4eef-afec-be710b42308d,
|
|
27
28
|
end_user_organization_name: Foo Bar, LLC,
|
|
28
29
|
end_user_email_address: hradmin@foobar.dev,
|
|
30
|
+
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
|
29
31
|
integration: null
|
|
30
32
|
)
|
|
31
33
|
```
|
data/docs/AccountDetailsApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
|
9
9
|
|
|
10
10
|
## account_details_retrieve
|
|
11
11
|
|
|
12
|
-
> <AccountDetails> account_details_retrieve
|
|
12
|
+
> <AccountDetails> account_details_retrieve(x_account_token)
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
|
|
@@ -23,16 +23,17 @@ require 'merge_hris_client'
|
|
|
23
23
|
# setup authorization
|
|
24
24
|
MergeHRISClient.configure do |config|
|
|
25
25
|
# Configure API key authorization: tokenAuth
|
|
26
|
-
config.api_key['
|
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
27
27
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
28
|
-
config.api_key_prefix['
|
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
api_instance = MergeHRISClient::AccountDetailsApi.new
|
|
32
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
32
33
|
|
|
33
34
|
begin
|
|
34
35
|
|
|
35
|
-
result = api_instance.account_details_retrieve
|
|
36
|
+
result = api_instance.account_details_retrieve(x_account_token)
|
|
36
37
|
p result
|
|
37
38
|
rescue MergeHRISClient::ApiError => e
|
|
38
39
|
puts "Error when calling AccountDetailsApi->account_details_retrieve: #{e}"
|
|
@@ -43,12 +44,12 @@ end
|
|
|
43
44
|
|
|
44
45
|
This returns an Array which contains the response data, status code and headers.
|
|
45
46
|
|
|
46
|
-
> <Array(<AccountDetails>, Integer, Hash)> account_details_retrieve_with_http_info
|
|
47
|
+
> <Array(<AccountDetails>, Integer, Hash)> account_details_retrieve_with_http_info(x_account_token)
|
|
47
48
|
|
|
48
49
|
```ruby
|
|
49
50
|
begin
|
|
50
51
|
|
|
51
|
-
data, status_code, headers = api_instance.account_details_retrieve_with_http_info
|
|
52
|
+
data, status_code, headers = api_instance.account_details_retrieve_with_http_info(x_account_token)
|
|
52
53
|
p status_code # => 2xx
|
|
53
54
|
p headers # => { ... }
|
|
54
55
|
p data # => <AccountDetails>
|
|
@@ -59,7 +60,9 @@ end
|
|
|
59
60
|
|
|
60
61
|
### Parameters
|
|
61
62
|
|
|
62
|
-
|
|
63
|
+
| Name | Type | Description | Notes |
|
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
|
65
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
63
66
|
|
|
64
67
|
### Return type
|
|
65
68
|
|
data/docs/AccountIntegration.md
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Company name. | |
|
|
8
|
-
| **categories** | **Array<
|
|
9
|
-
| **image** | **String** | Company logo in rectangular shape. | [optional] |
|
|
10
|
-
| **square_image** | **String** | Company logo in square shape. | [optional] |
|
|
11
|
-
| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. | [optional] |
|
|
8
|
+
| **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] |
|
|
9
|
+
| **image** | **String** | Company logo in rectangular shape. <b>Upload an image with a clear background.</b> | [optional] |
|
|
10
|
+
| **square_image** | **String** | Company logo in square shape. <b>Upload an image with a white background.</b> | [optional] |
|
|
11
|
+
| **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] |
|
|
12
12
|
| **slug** | **String** | | [optional][readonly] |
|
|
13
13
|
|
|
14
14
|
## Example
|
data/docs/AccountTokenApi.md
CHANGED
|
@@ -23,9 +23,9 @@ require 'merge_hris_client'
|
|
|
23
23
|
# setup authorization
|
|
24
24
|
MergeHRISClient.configure do |config|
|
|
25
25
|
# Configure API key authorization: tokenAuth
|
|
26
|
-
config.api_key['
|
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
27
27
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
28
|
-
# config.api_key_prefix['
|
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
api_instance = MergeHRISClient::AccountTokenApi.new
|
data/docs/AvailableActionsApi.md
CHANGED
|
@@ -23,9 +23,9 @@ require 'merge_hris_client'
|
|
|
23
23
|
# setup authorization
|
|
24
24
|
MergeHRISClient.configure do |config|
|
|
25
25
|
# Configure API key authorization: tokenAuth
|
|
26
|
-
config.api_key['
|
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
27
27
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
28
|
-
# config.api_key_prefix['
|
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
api_instance = MergeHRISClient::AvailableActionsApi.new
|
data/docs/BankInfo.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
-
| **employee** | **String** |
|
|
9
|
+
| **employee** | **String** | | [optional] |
|
|
10
10
|
| **account_number** | **String** | The account number. | [optional] |
|
|
11
11
|
| **routing_number** | **String** | The routing number. | [optional] |
|
|
12
12
|
| **bank_name** | **String** | The bank name. | [optional] |
|
data/docs/BankInfoApi.md
CHANGED
|
@@ -24,20 +24,19 @@ require 'merge_hris_client'
|
|
|
24
24
|
# setup authorization
|
|
25
25
|
MergeHRISClient.configure do |config|
|
|
26
26
|
# Configure API key authorization: tokenAuth
|
|
27
|
-
config.api_key['
|
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
-
config.api_key_prefix['
|
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
api_instance = MergeHRISClient::BankInfoApi.new
|
|
33
33
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
34
34
|
opts = {
|
|
35
|
-
account_type: 'CHECKING', # String |
|
|
36
|
-
bank_name: 'bank_name_example', # String |
|
|
35
|
+
account_type: 'CHECKING', # String | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
|
|
36
|
+
bank_name: 'bank_name_example', # String | If provided, will only return BankInfo's with this bank name.
|
|
37
37
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
|
38
38
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
39
39
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
40
|
-
employee: TODO, # String | If provided, will only return bank accounts for this employee.
|
|
41
40
|
employee_id: 'employee_id_example', # String | If provided, will only return bank accounts for this employee.
|
|
42
41
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
43
42
|
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
|
@@ -46,7 +45,6 @@ opts = {
|
|
|
46
45
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
47
46
|
order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint.
|
|
48
47
|
page_size: 56, # Integer | Number of results to return per page.
|
|
49
|
-
remote_created_at: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
50
48
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
51
49
|
}
|
|
52
50
|
|
|
@@ -82,12 +80,11 @@ end
|
|
|
82
80
|
| Name | Type | Description | Notes |
|
|
83
81
|
| ---- | ---- | ----------- | ----- |
|
|
84
82
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
85
|
-
| **account_type** | **String** |
|
|
86
|
-
| **bank_name** | **String** |
|
|
83
|
+
| **account_type** | **String** | If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') | [optional] |
|
|
84
|
+
| **bank_name** | **String** | If provided, will only return BankInfo's with this bank name. | [optional] |
|
|
87
85
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
|
88
86
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
89
87
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
90
|
-
| **employee** | [**String**](.md) | If provided, will only return bank accounts for this employee. | [optional] |
|
|
91
88
|
| **employee_id** | **String** | If provided, will only return bank accounts for this employee. | [optional] |
|
|
92
89
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
93
90
|
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
|
@@ -96,7 +93,6 @@ end
|
|
|
96
93
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
97
94
|
| **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
|
|
98
95
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
99
|
-
| **remote_created_at** | **Time** | | [optional] |
|
|
100
96
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
101
97
|
|
|
102
98
|
### Return type
|
|
@@ -129,9 +125,9 @@ require 'merge_hris_client'
|
|
|
129
125
|
# setup authorization
|
|
130
126
|
MergeHRISClient.configure do |config|
|
|
131
127
|
# Configure API key authorization: tokenAuth
|
|
132
|
-
config.api_key['
|
|
128
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
133
129
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
134
|
-
config.api_key_prefix['
|
|
130
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
135
131
|
end
|
|
136
132
|
|
|
137
133
|
api_instance = MergeHRISClient::BankInfoApi.new
|
data/docs/Benefit.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
-
| **employee** | **String** |
|
|
9
|
+
| **employee** | **String** | | [optional] |
|
|
10
10
|
| **provider_name** | **String** | The name of the benefit provider. | [optional] |
|
|
11
|
-
| **benefit_plan_type** |
|
|
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
14
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
data/docs/BenefitsApi.md
CHANGED
|
@@ -24,9 +24,9 @@ require 'merge_hris_client'
|
|
|
24
24
|
# setup authorization
|
|
25
25
|
MergeHRISClient.configure do |config|
|
|
26
26
|
# Configure API key authorization: tokenAuth
|
|
27
|
-
config.api_key['
|
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
-
# config.api_key_prefix['
|
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
api_instance = MergeHRISClient::BenefitsApi.new
|
|
@@ -119,9 +119,9 @@ require 'merge_hris_client'
|
|
|
119
119
|
# setup authorization
|
|
120
120
|
MergeHRISClient.configure do |config|
|
|
121
121
|
# Configure API key authorization: tokenAuth
|
|
122
|
-
config.api_key['
|
|
122
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
123
123
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
124
|
-
# config.api_key_prefix['
|
|
124
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
125
125
|
end
|
|
126
126
|
|
|
127
127
|
api_instance = MergeHRISClient::BenefitsApi.new
|
data/docs/CompaniesApi.md
CHANGED
|
@@ -24,9 +24,9 @@ require 'merge_hris_client'
|
|
|
24
24
|
# setup authorization
|
|
25
25
|
MergeHRISClient.configure do |config|
|
|
26
26
|
# Configure API key authorization: tokenAuth
|
|
27
|
-
config.api_key['
|
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
-
config.api_key_prefix['
|
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
api_instance = MergeHRISClient::CompaniesApi.new
|
|
@@ -115,9 +115,9 @@ require 'merge_hris_client'
|
|
|
115
115
|
# setup authorization
|
|
116
116
|
MergeHRISClient.configure do |config|
|
|
117
117
|
# Configure API key authorization: tokenAuth
|
|
118
|
-
config.api_key['
|
|
118
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
119
119
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
120
|
-
# config.api_key_prefix['
|
|
120
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
121
121
|
end
|
|
122
122
|
|
|
123
123
|
api_instance = MergeHRISClient::CompaniesApi.new
|
data/docs/Company.md
CHANGED
|
@@ -19,8 +19,8 @@ require 'merge_hris_client'
|
|
|
19
19
|
instance = MergeHRISClient::Company.new(
|
|
20
20
|
id: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
|
21
21
|
remote_id: 19202938,
|
|
22
|
-
legal_name:
|
|
23
|
-
display_name:
|
|
22
|
+
legal_name: Waystar Royco, Inc.,
|
|
23
|
+
display_name: Waystar Royco,
|
|
24
24
|
eins: ["12-3456789","12-3451111","11-0011000"],
|
|
25
25
|
remote_data: [{"path":"/companies","data":["Varies by platform"]}]
|
|
26
26
|
)
|
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
| **path** | **String** | | |
|
|
9
9
|
| **base_url_override** | **String** | | [optional] |
|
|
10
10
|
| **data** | **String** | | [optional] |
|
|
11
|
-
| **
|
|
11
|
+
| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
|
|
12
|
+
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
|
|
12
13
|
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -21,6 +22,7 @@ instance = MergeHRISClient::DataPassthroughRequest.new(
|
|
|
21
22
|
path: /scooters,
|
|
22
23
|
base_url_override: null,
|
|
23
24
|
data: {"company": "Lime", "model": "Gen 2.5"},
|
|
25
|
+
multipart_form_data: null,
|
|
24
26
|
headers: {"EXTRA-HEADER":"value"},
|
|
25
27
|
request_format: JSON
|
|
26
28
|
)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MergeHRISClient::DebugModeLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **log_id** | **String** | | |
|
|
8
|
+
| **dashboard_view** | **String** | | |
|
|
9
|
+
| **log_summary** | [**DebugModelLogSummary**](DebugModelLogSummary.md) | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'merge_hris_client'
|
|
15
|
+
|
|
16
|
+
instance = MergeHRISClient::DebugModeLog.new(
|
|
17
|
+
log_id: 99433219-8017-4acd-bb3c-ceb23d663832,
|
|
18
|
+
dashboard_view: https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832,
|
|
19
|
+
log_summary: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MergeHRISClient::DebugModelLogSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | | |
|
|
8
|
+
| **method** | **String** | | |
|
|
9
|
+
| **status_code** | **Integer** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'merge_hris_client'
|
|
15
|
+
|
|
16
|
+
instance = MergeHRISClient::DebugModelLogSummary.new(
|
|
17
|
+
url: https://harvest.greenhouse.io/v1/candidates/,
|
|
18
|
+
method: POST,
|
|
19
|
+
status_code: 200
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/Deduction.md
CHANGED
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
|
-
| **employee_payroll_run** | **String** |
|
|
8
|
+
| **employee_payroll_run** | **String** | | [optional] |
|
|
9
9
|
| **name** | **String** | The deduction's name. | [optional] |
|
|
10
10
|
| **employee_deduction** | **Float** | The amount the employee is deducting. | [optional] |
|
|
11
11
|
| **company_deduction** | **Float** | The amount the company is deducting. | [optional] |
|
|
12
|
-
| **remote_data** | **Array<
|
|
12
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
data/docs/DeductionsApi.md
CHANGED
|
@@ -24,9 +24,9 @@ require 'merge_hris_client'
|
|
|
24
24
|
# setup authorization
|
|
25
25
|
MergeHRISClient.configure do |config|
|
|
26
26
|
# Configure API key authorization: tokenAuth
|
|
27
|
-
config.api_key['
|
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
28
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
-
config.api_key_prefix['
|
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
api_instance = MergeHRISClient::DeductionsApi.new
|
|
@@ -117,9 +117,9 @@ require 'merge_hris_client'
|
|
|
117
117
|
# setup authorization
|
|
118
118
|
MergeHRISClient.configure do |config|
|
|
119
119
|
# Configure API key authorization: tokenAuth
|
|
120
|
-
config.api_key['
|
|
120
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
121
121
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
122
|
-
config.api_key_prefix['
|
|
122
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
123
123
|
end
|
|
124
124
|
|
|
125
125
|
api_instance = MergeHRISClient::DeductionsApi.new
|
data/docs/DeleteAccountApi.md
CHANGED
|
@@ -23,8 +23,9 @@ require 'merge_hris_client'
|
|
|
23
23
|
# setup authorization
|
|
24
24
|
MergeHRISClient.configure do |config|
|
|
25
25
|
# Configure API key authorization: tokenAuth
|
|
26
|
-
config.api_key['
|
|
27
|
-
|
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
28
29
|
end
|
|
29
30
|
|
|
30
31
|
api_instance = MergeHRISClient::DeleteAccountApi.new
|
data/docs/Earning.md
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
|
-
| **employee_payroll_run** | **String** |
|
|
8
|
+
| **employee_payroll_run** | **String** | | [optional] |
|
|
9
9
|
| **amount** | **Float** | The amount earned. | [optional] |
|
|
10
|
-
| **type** | [**
|
|
11
|
-
| **remote_data** | **
|
|
10
|
+
| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
|
|
11
|
+
| **remote_data** | **String** | | [optional][readonly] |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MergeHRISClient::EarningTypeEnum
|
|
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::EarningTypeEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|