merge_hris_client 1.0.4 → 2.0.0
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 +28 -12
- data/docs/AccountDetails.md +7 -7
- data/docs/AccountDetailsApi.md +2 -2
- 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/DataPassthroughRequest.md +2 -0
- 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 +9 -7
- 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 +158 -4
- data/docs/Employment.md +1 -1
- data/docs/EmploymentsApi.md +5 -4
- data/docs/EncodingEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +3 -1
- 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 +5 -4
- data/docs/LinkTokenApi.md +3 -3
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +2 -0
- data/docs/LocationsApi.md +4 -4
- 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 +2 -2
- data/docs/TimeOffApi.md +8 -6
- data/docs/TimeOffBalance.md +1 -1
- data/docs/TimeOffRequest.md +2 -2
- data/docs/TimeOffResponse.md +3 -1
- data/lib/merge_hris_client/api/bank_info_api.rb +4 -9
- data/lib/merge_hris_client/api/employees_api.rb +147 -2
- data/lib/merge_hris_client/api/groups_api.rb +182 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +0 -62
- data/lib/merge_hris_client/api/time_off_api.rb +3 -0
- data/lib/merge_hris_client/configuration.rb +6 -4
- data/lib/merge_hris_client/models/account_details.rb +1 -1
- data/lib/merge_hris_client/models/account_details_and_actions.rb +1 -1
- 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/country_enum.rb +1 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +16 -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 -8
- data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
- data/lib/merge_hris_client/models/employee.rb +13 -8
- 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 +0 -1
- 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 +40 -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/location.rb +12 -1
- 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/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/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 -7
- 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 +0 -1
- 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/version.rb +1 -1
- data/lib/merge_hris_client.rb +16 -2
- data/pull_request_template.md +3 -1
- data/spec/api/bank_info_api_spec.rb +2 -4
- data/spec/api/employees_api_spec.rb +26 -0
- data/spec/api/groups_api_spec.rb +68 -0
- data/spec/api/time_off_api_spec.rb +1 -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/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 +57 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 229fd1e1c6db27d31c178f60da34b4a7e031966dbcee75c99a3c784eaabf281a
|
|
4
|
+
data.tar.gz: 8583b946ac2eaa2291389831965cf5dbcb2a1b0514e7cc9639c489540593ffb8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6c4bc2a2453a27df2d38768d4daa809dd189d1b472cecfe66ad8db395e06a2ae0c297d9b1ce8ffd9416d617929d9d4c40f8f9ad4dea7f5fdd9a4c837f1b7d278
|
|
7
|
+
data.tar.gz: ab99ee10f58cd7cbd210b67bca51611e09da89926e9327432dda58d3b2129a5c0d74e2d084853ba90519721f0d8618b0e41e257e2e6f3b491dd579bdac17c265
|
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.0
|
|
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.0.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.0.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.0'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -60,19 +60,18 @@ 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
|
-
public_token = 'public_token_example' # String |
|
|
68
|
+
api_instance = MergeHRISClient::AccountDetailsApi.new
|
|
70
69
|
|
|
71
70
|
begin
|
|
72
|
-
result = api_instance.
|
|
71
|
+
result = api_instance.account_details_retrieve
|
|
73
72
|
p result
|
|
74
73
|
rescue MergeHRISClient::ApiError => e
|
|
75
|
-
puts "Exception when calling
|
|
74
|
+
puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
|
|
76
75
|
end
|
|
77
76
|
|
|
78
77
|
```
|
|
@@ -97,12 +96,16 @@ Class | Method | HTTP request | Description
|
|
|
97
96
|
*MergeHRISClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |
|
|
98
97
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
|
|
99
98
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
|
|
99
|
+
*MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees |
|
|
100
|
+
*MergeHRISClient::EmployeesApi* | [**employees_ignore_create**](docs/EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} |
|
|
100
101
|
*MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees |
|
|
101
102
|
*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
|
|
102
103
|
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
|
103
104
|
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
|
104
105
|
*MergeHRISClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
|
|
105
106
|
*MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
|
|
107
|
+
*MergeHRISClient::GroupsApi* | [**groups_list**](docs/GroupsApi.md#groups_list) | **GET** /groups |
|
|
108
|
+
*MergeHRISClient::GroupsApi* | [**groups_retrieve**](docs/GroupsApi.md#groups_retrieve) | **GET** /groups/{id} |
|
|
106
109
|
*MergeHRISClient::IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues |
|
|
107
110
|
*MergeHRISClient::IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |
|
|
108
111
|
*MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token |
|
|
@@ -137,32 +140,44 @@ Class | Method | HTTP request | Description
|
|
|
137
140
|
- [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
|
|
138
141
|
- [MergeHRISClient::BankInfo](docs/BankInfo.md)
|
|
139
142
|
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
|
140
|
-
- [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
|
|
141
143
|
- [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
|
|
142
144
|
- [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
|
|
143
145
|
- [MergeHRISClient::Company](docs/Company.md)
|
|
144
146
|
- [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
|
|
145
147
|
- [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
|
148
|
+
- [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
|
|
149
|
+
- [MergeHRISClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
|
|
146
150
|
- [MergeHRISClient::Deduction](docs/Deduction.md)
|
|
147
151
|
- [MergeHRISClient::Earning](docs/Earning.md)
|
|
152
|
+
- [MergeHRISClient::EarningTypeEnum](docs/EarningTypeEnum.md)
|
|
148
153
|
- [MergeHRISClient::Employee](docs/Employee.md)
|
|
154
|
+
- [MergeHRISClient::EmployeeEndpointRequest](docs/EmployeeEndpointRequest.md)
|
|
149
155
|
- [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
|
|
156
|
+
- [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
|
|
157
|
+
- [MergeHRISClient::EmployeeResponse](docs/EmployeeResponse.md)
|
|
150
158
|
- [MergeHRISClient::Employment](docs/Employment.md)
|
|
151
159
|
- [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
|
|
152
160
|
- [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
|
|
161
|
+
- [MergeHRISClient::EncodingEnum](docs/EncodingEnum.md)
|
|
153
162
|
- [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
|
154
163
|
- [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
|
|
155
164
|
- [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
|
|
156
165
|
- [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
|
|
157
166
|
- [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
|
|
158
167
|
- [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
|
|
168
|
+
- [MergeHRISClient::Group](docs/Group.md)
|
|
169
|
+
- [MergeHRISClient::GroupTypeEnum](docs/GroupTypeEnum.md)
|
|
170
|
+
- [MergeHRISClient::IgnoreCommonModel](docs/IgnoreCommonModel.md)
|
|
171
|
+
- [MergeHRISClient::IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
|
|
159
172
|
- [MergeHRISClient::Issue](docs/Issue.md)
|
|
160
173
|
- [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
|
161
174
|
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
|
162
175
|
- [MergeHRISClient::Location](docs/Location.md)
|
|
176
|
+
- [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
|
|
163
177
|
- [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
|
|
164
178
|
- [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
|
|
165
179
|
- [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
|
|
180
|
+
- [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
|
|
166
181
|
- [MergeHRISClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
|
|
167
182
|
- [MergeHRISClient::PaginatedBankInfoList](docs/PaginatedBankInfoList.md)
|
|
168
183
|
- [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
|
|
@@ -171,6 +186,7 @@ Class | Method | HTTP request | Description
|
|
|
171
186
|
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
|
172
187
|
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
|
173
188
|
- [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
|
|
189
|
+
- [MergeHRISClient::PaginatedGroupList](docs/PaginatedGroupList.md)
|
|
174
190
|
- [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
|
|
175
191
|
- [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
|
|
176
192
|
- [MergeHRISClient::PaginatedPayGroupList](docs/PaginatedPayGroupList.md)
|
|
@@ -185,6 +201,7 @@ Class | Method | HTTP request | Description
|
|
|
185
201
|
- [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
|
|
186
202
|
- [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
|
|
187
203
|
- [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
|
|
204
|
+
- [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
|
|
188
205
|
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
|
189
206
|
- [MergeHRISClient::RemoteDataRequest](docs/RemoteDataRequest.md)
|
|
190
207
|
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
|
@@ -204,7 +221,6 @@ Class | Method | HTTP request | Description
|
|
|
204
221
|
- [MergeHRISClient::TimeOffRequest](docs/TimeOffRequest.md)
|
|
205
222
|
- [MergeHRISClient::TimeOffResponse](docs/TimeOffResponse.md)
|
|
206
223
|
- [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
|
|
207
|
-
- [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
|
|
208
224
|
- [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
|
|
209
225
|
- [MergeHRISClient::ValidationProblemSource](docs/ValidationProblemSource.md)
|
|
210
226
|
- [MergeHRISClient::WarningValidationProblem](docs/WarningValidationProblem.md)
|
data/docs/AccountDetails.md
CHANGED
|
@@ -18,13 +18,13 @@
|
|
|
18
18
|
require 'merge_hris_client'
|
|
19
19
|
|
|
20
20
|
instance = MergeHRISClient::AccountDetails.new(
|
|
21
|
-
id:
|
|
22
|
-
integration:
|
|
23
|
-
category:
|
|
24
|
-
end_user_origin_id:
|
|
25
|
-
end_user_organization_name:
|
|
26
|
-
end_user_email_address:
|
|
27
|
-
status:
|
|
21
|
+
id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd,
|
|
22
|
+
integration: BambooHR,
|
|
23
|
+
category: hris,
|
|
24
|
+
end_user_origin_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
|
25
|
+
end_user_organization_name: Waystar Royco,
|
|
26
|
+
end_user_email_address: kendall.roy@waystar-royco.com,
|
|
27
|
+
status: COMPLETE
|
|
28
28
|
)
|
|
29
29
|
```
|
|
30
30
|
|
data/docs/AccountDetailsApi.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::AccountDetailsApi.new
|
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
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **path** | **String** | | |
|
|
9
9
|
| **base_url_override** | **String** | | [optional] |
|
|
10
10
|
| **data** | **String** | | [optional] |
|
|
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] |
|
|
11
12
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
12
13
|
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
|
13
14
|
|
|
@@ -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
|
+
|
data/docs/Employee.md
CHANGED
|
@@ -7,19 +7,20 @@
|
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
9
|
| **employee_number** | **String** | The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. | [optional] |
|
|
10
|
-
| **company** | **String** |
|
|
10
|
+
| **company** | **String** | | [optional] |
|
|
11
11
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
|
12
12
|
| **last_name** | **String** | The employee's last name. | [optional] |
|
|
13
13
|
| **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
|
|
14
|
+
| **groups** | **Array<String>** | | [optional] |
|
|
14
15
|
| **work_email** | **String** | The employee's work email. | [optional] |
|
|
15
16
|
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
|
16
17
|
| **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
|
|
17
|
-
| **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional]
|
|
18
|
-
| **home_location** | **String** |
|
|
19
|
-
| **work_location** | **String** |
|
|
20
|
-
| **manager** | **String** |
|
|
21
|
-
| **team** | **String** |
|
|
22
|
-
| **pay_group** | **String** |
|
|
18
|
+
| **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional] |
|
|
19
|
+
| **home_location** | **String** | | [optional] |
|
|
20
|
+
| **work_location** | **String** | | [optional] |
|
|
21
|
+
| **manager** | **String** | | [optional] |
|
|
22
|
+
| **team** | **String** | | [optional] |
|
|
23
|
+
| **pay_group** | **String** | | [optional] |
|
|
23
24
|
| **ssn** | **String** | The employee's social security number. | [optional] |
|
|
24
25
|
| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
|
|
25
26
|
| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
|
|
@@ -46,6 +47,7 @@ instance = MergeHRISClient::Employee.new(
|
|
|
46
47
|
first_name: Jane,
|
|
47
48
|
last_name: Doe,
|
|
48
49
|
display_full_name: Jane Doe,
|
|
50
|
+
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
|
49
51
|
work_email: jane@merge.dev,
|
|
50
52
|
personal_email: jane@gmail.com,
|
|
51
53
|
mobile_phone_number: +1234567890,
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MergeHRISClient::EmployeeEndpointRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **model** | [**EmployeeRequest**](EmployeeRequest.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'merge_hris_client'
|
|
13
|
+
|
|
14
|
+
instance = MergeHRISClient::EmployeeEndpointRequest.new(
|
|
15
|
+
model: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/EmployeePayrollRun.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
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** |
|
|
10
|
-
| **payroll_run** | **String** |
|
|
9
|
+
| **employee** | **String** | | [optional] |
|
|
10
|
+
| **payroll_run** | **String** | | [optional] |
|
|
11
11
|
| **gross_pay** | **Float** | The gross pay from the run. | [optional] |
|
|
12
12
|
| **net_pay** | **Float** | The net pay from the run. | [optional] |
|
|
13
13
|
| **start_date** | **Time** | The day and time the payroll run started. | [optional] |
|
|
@@ -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::EmployeePayrollRunsApi.new
|
|
@@ -129,9 +129,9 @@ require 'merge_hris_client'
|
|
|
129
129
|
# setup authorization
|
|
130
130
|
MergeHRISClient.configure do |config|
|
|
131
131
|
# Configure API key authorization: tokenAuth
|
|
132
|
-
config.api_key['
|
|
132
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
133
133
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
134
|
-
# config.api_key_prefix['
|
|
134
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
135
135
|
end
|
|
136
136
|
|
|
137
137
|
api_instance = MergeHRISClient::EmployeePayrollRunsApi.new
|