merge_hris_client 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +21 -2
- data/docs/AccountToken.md +3 -1
- data/docs/AvailableActions.md +1 -1
- data/docs/BenefitRequest.md +28 -0
- data/docs/BenefitsApi.md +78 -0
- data/docs/DeleteAccountApi.md +77 -0
- data/docs/Employee.md +8 -6
- data/docs/EmployeeRequest.md +62 -0
- data/docs/EmployeesApi.md +83 -1
- data/docs/EmploymentRequest.md +34 -0
- data/docs/EmploymentsApi.md +78 -0
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/Issue.md +30 -0
- data/docs/IssueStatusEnum.md +15 -0
- data/docs/IssuesApi.md +167 -0
- data/docs/Location.md +1 -1
- data/docs/ModelOperation.md +3 -1
- data/docs/PaginatedIssueList.md +22 -0
- data/docs/PaginatedSyncStatusList.md +22 -0
- data/docs/PaginatedTimeOffBalanceList.md +22 -0
- data/docs/RemoteDataRequest.md +20 -0
- data/docs/SyncStatus.md +1 -1
- data/docs/SyncStatusApi.md +89 -11
- data/docs/SyncStatusStatusEnum.md +15 -0
- data/docs/Team.md +2 -0
- data/docs/TeamsApi.md +2 -0
- data/docs/TimeOff.md +4 -0
- data/docs/TimeOffBalance.md +28 -0
- data/docs/TimeOffBalanceApi.md +181 -0
- data/lib/merge_hris_client.rb +15 -4
- data/lib/merge_hris_client/api/account_token_api.rb +1 -1
- data/lib/merge_hris_client/api/available_actions_api.rb +1 -1
- data/lib/merge_hris_client/api/benefits_api.rb +70 -1
- data/lib/merge_hris_client/api/companies_api.rb +1 -1
- data/lib/merge_hris_client/api/delete_account_api.rb +82 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +1 -1
- data/lib/merge_hris_client/api/employees_api.rb +76 -1
- data/lib/merge_hris_client/api/employments_api.rb +70 -1
- data/lib/merge_hris_client/api/generate_key_api.rb +1 -1
- data/lib/merge_hris_client/api/issues_api.rb +169 -0
- data/lib/merge_hris_client/api/link_token_api.rb +1 -1
- data/lib/merge_hris_client/api/locations_api.rb +1 -1
- data/lib/merge_hris_client/api/passthrough_api.rb +1 -1
- data/lib/merge_hris_client/api/payroll_runs_api.rb +1 -1
- data/lib/merge_hris_client/api/regenerate_key_api.rb +1 -1
- data/lib/merge_hris_client/api/sync_status_api.rb +79 -11
- data/lib/merge_hris_client/api/teams_api.rb +4 -1
- data/lib/merge_hris_client/api/time_off_api.rb +1 -1
- data/lib/merge_hris_client/api/time_off_balance_api.rb +196 -0
- data/lib/merge_hris_client/api_client.rb +2 -2
- data/lib/merge_hris_client/api_error.rb +1 -1
- data/lib/merge_hris_client/configuration.rb +1 -1
- data/lib/merge_hris_client/models/account_integration.rb +1 -1
- data/lib/merge_hris_client/models/account_token.rb +19 -5
- data/lib/merge_hris_client/models/available_actions.rb +1 -1
- data/lib/merge_hris_client/models/benefit.rb +1 -1
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/benefit_request.rb +276 -0
- data/lib/merge_hris_client/models/company.rb +1 -1
- data/lib/merge_hris_client/models/country_enum.rb +1 -1
- data/lib/merge_hris_client/models/data_passthrough_request.rb +2 -1
- data/lib/merge_hris_client/models/deduction.rb +1 -1
- data/lib/merge_hris_client/models/earning.rb +1 -1
- data/lib/merge_hris_client/models/employee.rb +32 -20
- data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/employee_request.rb +523 -0
- data/lib/merge_hris_client/models/employment.rb +1 -1
- data/lib/merge_hris_client/models/employment_request.rb +309 -0
- 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/end_user_details_request.rb +2 -6
- 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/issue.rb +281 -0
- data/lib/merge_hris_client/models/issue_status_enum.rb +36 -0
- data/lib/merge_hris_client/models/link_token.rb +1 -1
- data/lib/merge_hris_client/models/location.rb +4 -4
- data/lib/merge_hris_client/models/method_enum.rb +1 -1
- data/lib/merge_hris_client/models/model_operation.rb +21 -5
- 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_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_issue_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_location_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 +240 -0
- data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
- data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +240 -0
- 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 -1
- 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/remote_data.rb +1 -1
- data/lib/merge_hris_client/models/remote_data_request.rb +234 -0
- 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_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +1 -1
- data/lib/merge_hris_client/models/sync_status.rb +2 -2
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +37 -0
- data/lib/merge_hris_client/models/tax.rb +1 -1
- data/lib/merge_hris_client/models/team.rb +13 -2
- data/lib/merge_hris_client/models/time_off.rb +24 -2
- data/lib/merge_hris_client/models/time_off_balance.rb +275 -0
- data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
- data/lib/merge_hris_client/models/type_enum.rb +1 -1
- data/lib/merge_hris_client/models/units_enum.rb +1 -1
- data/lib/merge_hris_client/version.rb +2 -2
- data/merge_hris_client-1.0.1.gem +0 -0
- data/merge_hris_client.gemspec +1 -1
- data/spec/api/delete_account_api_spec.rb +46 -0
- data/spec/api/generate_key_api_spec.rb +46 -0
- data/spec/api/issues_api_spec.rb +65 -0
- data/spec/api/sync_status_api_spec.rb +59 -0
- data/spec/api/time_off_balance_api_spec.rb +70 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/benefit_request_spec.rb +64 -0
- data/spec/models/employee_request_spec.rb +160 -0
- data/spec/models/employment_request_spec.rb +82 -0
- data/spec/models/generate_remote_key_request_spec.rb +34 -0
- data/spec/models/issue_spec.rb +70 -0
- data/spec/models/issue_status_enum_spec.rb +28 -0
- data/spec/models/paginated_issue_list_spec.rb +46 -0
- data/spec/models/paginated_sync_status_list_spec.rb +46 -0
- data/spec/models/paginated_time_off_balance_list_spec.rb +46 -0
- data/spec/models/remote_data_request_spec.rb +40 -0
- data/spec/models/sync_status_spec.rb +64 -0
- data/spec/models/sync_status_status_enum_spec.rb +28 -0
- data/spec/models/time_off_balance_spec.rb +64 -0
- data/spec/spec_helper.rb +1 -1
- data/test_ruby.rb +14 -11
- metadata +67 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1019ad62ce1658e194a3bb31737940198de592a478beb103a011ccff8b93257f
|
4
|
+
data.tar.gz: 7f3a57417e8d5a924b61844b03963e1304eab299dbc24facdaee557f6810b5d2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 81a6f2c35383814dc9882b32b327fb01f6a255571d35fe5f3f0969f5cd370be97e4eef9ee42d86e5df72d1658594a3767208d14fd667317ac67dff99a22d9567
|
7
|
+
data.tar.gz: 919a1b4fe3fd8a38c0896589e84c4d1cbfa7097d56d603be3cf4ca27c819ecd7ca9c9bcaab7dff0b939abbf26aca47c5d8dd96e659db57e9e99e8858d9536c87
|
data/README.md
CHANGED
@@ -85,17 +85,23 @@ Class | Method | HTTP request | Description
|
|
85
85
|
------------ | ------------- | ------------- | -------------
|
86
86
|
*MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
|
87
87
|
*MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
|
88
|
+
*MergeHRISClient::BenefitsApi* | [**benefits_create**](docs/BenefitsApi.md#benefits_create) | **POST** /benefits |
|
88
89
|
*MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits |
|
89
90
|
*MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |
|
90
91
|
*MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies |
|
91
92
|
*MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} |
|
93
|
+
*MergeHRISClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |
|
92
94
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
|
93
95
|
*MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
|
96
|
+
*MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees |
|
94
97
|
*MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees |
|
95
98
|
*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
|
99
|
+
*MergeHRISClient::EmploymentsApi* | [**employments_create**](docs/EmploymentsApi.md#employments_create) | **POST** /employments |
|
96
100
|
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
97
101
|
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
98
102
|
*MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
|
103
|
+
*MergeHRISClient::IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues |
|
104
|
+
*MergeHRISClient::IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |
|
99
105
|
*MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token |
|
100
106
|
*MergeHRISClient::LocationsApi* | [**locations_list**](docs/LocationsApi.md#locations_list) | **GET** /locations |
|
101
107
|
*MergeHRISClient::LocationsApi* | [**locations_retrieve**](docs/LocationsApi.md#locations_retrieve) | **GET** /locations/{id} |
|
@@ -103,11 +109,14 @@ Class | Method | HTTP request | Description
|
|
103
109
|
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs |
|
104
110
|
*MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} |
|
105
111
|
*MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |
|
106
|
-
*MergeHRISClient::SyncStatusApi* | [**
|
112
|
+
*MergeHRISClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status |
|
113
|
+
*MergeHRISClient::SyncStatusApi* | [**sync_status_resync_create**](docs/SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
|
107
114
|
*MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams |
|
108
115
|
*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
|
109
116
|
*MergeHRISClient::TimeOffApi* | [**time_off_list**](docs/TimeOffApi.md#time_off_list) | **GET** /time-off |
|
110
117
|
*MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |
|
118
|
+
*MergeHRISClient::TimeOffBalanceApi* | [**time_off_balance_list**](docs/TimeOffBalanceApi.md#time_off_balance_list) | **GET** /time-off-balance |
|
119
|
+
*MergeHRISClient::TimeOffBalanceApi* | [**time_off_balance_retrieve**](docs/TimeOffBalanceApi.md#time_off_balance_retrieve) | **GET** /time-off-balance/{id} |
|
111
120
|
|
112
121
|
|
113
122
|
## Documentation for Models
|
@@ -117,6 +126,7 @@ Class | Method | HTTP request | Description
|
|
117
126
|
- [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
|
118
127
|
- [MergeHRISClient::Benefit](docs/Benefit.md)
|
119
128
|
- [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
|
129
|
+
- [MergeHRISClient::BenefitRequest](docs/BenefitRequest.md)
|
120
130
|
- [MergeHRISClient::Company](docs/Company.md)
|
121
131
|
- [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
|
122
132
|
- [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
@@ -124,7 +134,9 @@ Class | Method | HTTP request | Description
|
|
124
134
|
- [MergeHRISClient::Earning](docs/Earning.md)
|
125
135
|
- [MergeHRISClient::Employee](docs/Employee.md)
|
126
136
|
- [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
|
137
|
+
- [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
|
127
138
|
- [MergeHRISClient::Employment](docs/Employment.md)
|
139
|
+
- [MergeHRISClient::EmploymentRequest](docs/EmploymentRequest.md)
|
128
140
|
- [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
|
129
141
|
- [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
|
130
142
|
- [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
@@ -132,6 +144,8 @@ Class | Method | HTTP request | Description
|
|
132
144
|
- [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
|
133
145
|
- [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
|
134
146
|
- [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
|
147
|
+
- [MergeHRISClient::Issue](docs/Issue.md)
|
148
|
+
- [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
135
149
|
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
136
150
|
- [MergeHRISClient::Location](docs/Location.md)
|
137
151
|
- [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
|
@@ -142,26 +156,31 @@ Class | Method | HTTP request | Description
|
|
142
156
|
- [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
|
143
157
|
- [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
|
144
158
|
- [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
|
159
|
+
- [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
|
145
160
|
- [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
|
146
161
|
- [MergeHRISClient::PaginatedPayrollRunList](docs/PaginatedPayrollRunList.md)
|
162
|
+
- [MergeHRISClient::PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
|
147
163
|
- [MergeHRISClient::PaginatedTeamList](docs/PaginatedTeamList.md)
|
164
|
+
- [MergeHRISClient::PaginatedTimeOffBalanceList](docs/PaginatedTimeOffBalanceList.md)
|
148
165
|
- [MergeHRISClient::PaginatedTimeOffList](docs/PaginatedTimeOffList.md)
|
149
166
|
- [MergeHRISClient::PayCurrencyEnum](docs/PayCurrencyEnum.md)
|
150
167
|
- [MergeHRISClient::PayFrequencyEnum](docs/PayFrequencyEnum.md)
|
151
168
|
- [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
|
152
169
|
- [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
|
153
170
|
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
171
|
+
- [MergeHRISClient::RemoteDataRequest](docs/RemoteDataRequest.md)
|
154
172
|
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
155
173
|
- [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
156
174
|
- [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
|
157
175
|
- [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
|
158
176
|
- [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
|
159
177
|
- [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
|
160
|
-
- [MergeHRISClient::StateEnum](docs/StateEnum.md)
|
161
178
|
- [MergeHRISClient::SyncStatus](docs/SyncStatus.md)
|
179
|
+
- [MergeHRISClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
|
162
180
|
- [MergeHRISClient::Tax](docs/Tax.md)
|
163
181
|
- [MergeHRISClient::Team](docs/Team.md)
|
164
182
|
- [MergeHRISClient::TimeOff](docs/TimeOff.md)
|
183
|
+
- [MergeHRISClient::TimeOffBalance](docs/TimeOffBalance.md)
|
165
184
|
- [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
|
166
185
|
- [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
|
167
186
|
- [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
|
data/docs/AccountToken.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **account_token** | **String** | | |
|
8
|
+
| **integration** | [**AccountIntegration**](AccountIntegration.md) | | |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'merge_hris_client'
|
13
14
|
|
14
15
|
instance = MergeHRISClient::AccountToken.new(
|
15
|
-
account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB
|
16
|
+
account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB,
|
17
|
+
integration: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/AvailableActions.md
CHANGED
@@ -16,7 +16,7 @@ require 'merge_hris_client'
|
|
16
16
|
instance = MergeHRISClient::AvailableActions.new(
|
17
17
|
integration: null,
|
18
18
|
passthrough_available: true,
|
19
|
-
available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"]}]
|
19
|
+
available_model_operations: [{"model_name":"Candidate","available_operations":["FETCH","CREATE"],"required_post_parameters":["remote_user_id"],"supported_fields":["first_name","last_name","company","title"]}]
|
20
20
|
)
|
21
21
|
```
|
22
22
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MergeHRISClient::BenefitRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **employee** | **String** | The employee on the plan. | [optional] |
|
9
|
+
| **provider_name** | **String** | The name of the benefit provider. | [optional] |
|
10
|
+
| **benefit_plan_type** | [**BenefitPlanTypeEnum**](BenefitPlanTypeEnum.md) | The type of benefit plan | [optional] |
|
11
|
+
| **employee_contribution** | **Float** | The employee's contribution. | [optional] |
|
12
|
+
| **company_contribution** | **Float** | The company's contribution. | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'merge_hris_client'
|
18
|
+
|
19
|
+
instance = MergeHRISClient::BenefitRequest.new(
|
20
|
+
remote_id: 19202938,
|
21
|
+
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
22
|
+
provider_name: Blue Shield of California,
|
23
|
+
benefit_plan_type: MEDICAL,
|
24
|
+
employee_contribution: 23.65,
|
25
|
+
company_contribution: 150.0
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/BenefitsApi.md
CHANGED
@@ -4,10 +4,88 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**benefits_create**](BenefitsApi.md#benefits_create) | **POST** /benefits | |
|
7
8
|
| [**benefits_list**](BenefitsApi.md#benefits_list) | **GET** /benefits | |
|
8
9
|
| [**benefits_retrieve**](BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} | |
|
9
10
|
|
10
11
|
|
12
|
+
## benefits_create
|
13
|
+
|
14
|
+
> <Benefit> benefits_create(x_account_token, opts)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
Creates a `Benefit` object with the given values.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'merge_hris_client'
|
25
|
+
# setup authorization
|
26
|
+
MergeHRISClient.configure do |config|
|
27
|
+
# Configure API key authorization: tokenAuth
|
28
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = MergeHRISClient::BenefitsApi.new
|
34
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
35
|
+
opts = {
|
36
|
+
run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
|
37
|
+
benefit_request: MergeHRISClient::BenefitRequest.new # BenefitRequest |
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
|
42
|
+
result = api_instance.benefits_create(x_account_token, opts)
|
43
|
+
p result
|
44
|
+
rescue MergeHRISClient::ApiError => e
|
45
|
+
puts "Error when calling BenefitsApi->benefits_create: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Using the benefits_create_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(<Benefit>, Integer, Hash)> benefits_create_with_http_info(x_account_token, opts)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
|
58
|
+
data, status_code, headers = api_instance.benefits_create_with_http_info(x_account_token, opts)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => <Benefit>
|
62
|
+
rescue MergeHRISClient::ApiError => e
|
63
|
+
puts "Error when calling BenefitsApi->benefits_create_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
### Parameters
|
68
|
+
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
72
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
73
|
+
| **benefit_request** | [**BenefitRequest**](BenefitRequest.md) | | [optional] |
|
74
|
+
|
75
|
+
### Return type
|
76
|
+
|
77
|
+
[**Benefit**](Benefit.md)
|
78
|
+
|
79
|
+
### Authorization
|
80
|
+
|
81
|
+
[tokenAuth](../README.md#tokenAuth)
|
82
|
+
|
83
|
+
### HTTP request headers
|
84
|
+
|
85
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
86
|
+
- **Accept**: application/json
|
87
|
+
|
88
|
+
|
11
89
|
## benefits_list
|
12
90
|
|
13
91
|
> <PaginatedBenefitList> benefits_list(x_account_token, opts)
|
@@ -0,0 +1,77 @@
|
|
1
|
+
# MergeHRISClient::DeleteAccountApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_account_create**](DeleteAccountApi.md#delete_account_create) | **POST** /delete-account | |
|
8
|
+
|
9
|
+
|
10
|
+
## delete_account_create
|
11
|
+
|
12
|
+
> delete_account_create(x_account_token)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Delete a linked account.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_hris_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeHRISClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
26
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
27
|
+
config.api_key_prefix['Authorization'] = 'Bearer'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = MergeHRISClient::DeleteAccountApi.new
|
31
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
32
|
+
|
33
|
+
begin
|
34
|
+
|
35
|
+
api_instance.delete_account_create(x_account_token)
|
36
|
+
rescue MergeHRISClient::ApiError => e
|
37
|
+
puts "Error when calling DeleteAccountApi->delete_account_create: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
#### Using the delete_account_create_with_http_info variant
|
42
|
+
|
43
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
44
|
+
|
45
|
+
> <Array(nil, Integer, Hash)> delete_account_create_with_http_info(x_account_token)
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
begin
|
49
|
+
|
50
|
+
data, status_code, headers = api_instance.delete_account_create_with_http_info(x_account_token)
|
51
|
+
p status_code # => 2xx
|
52
|
+
p headers # => { ... }
|
53
|
+
p data # => nil
|
54
|
+
rescue MergeHRISClient::ApiError => e
|
55
|
+
puts "Error when calling DeleteAccountApi->delete_account_create_with_http_info: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
| Name | Type | Description | Notes |
|
62
|
+
| ---- | ---- | ----------- | ----- |
|
63
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
64
|
+
|
65
|
+
### Return type
|
66
|
+
|
67
|
+
nil (empty response body)
|
68
|
+
|
69
|
+
### Authorization
|
70
|
+
|
71
|
+
[tokenAuth](../README.md#tokenAuth)
|
72
|
+
|
73
|
+
### HTTP request headers
|
74
|
+
|
75
|
+
- **Content-Type**: Not defined
|
76
|
+
- **Accept**: Not defined
|
77
|
+
|
data/docs/Employee.md
CHANGED
@@ -6,14 +6,15 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
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** | The ID of the employee's company. | [optional] |
|
10
11
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
11
12
|
| **last_name** | **String** | The employee's last name. | [optional] |
|
12
13
|
| **display_full_name** | **String** | The employee's full name, to use for display purposes. | [optional] |
|
13
14
|
| **work_email** | **String** | The employee's work email. | [optional] |
|
14
15
|
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
15
16
|
| **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
|
16
|
-
| **employments** | **Array<String>** |
|
17
|
+
| **employments** | **Array<String>** | Array of `Employment` IDs for this Employee. | [optional][readonly] |
|
17
18
|
| **home_location** | **String** | The employee's home address. | [optional] |
|
18
19
|
| **work_location** | **String** | The employee's work address. | [optional] |
|
19
20
|
| **manager** | **String** | The employee ID of the employee's manager. | [optional] |
|
@@ -23,11 +24,11 @@
|
|
23
24
|
| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
|
24
25
|
| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
|
25
26
|
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
26
|
-
| **hire_date** | **Time** | The employee's hire date. | [optional] |
|
27
|
+
| **hire_date** | **Time** | The employee's hire date. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. | [optional] |
|
28
|
+
| **start_date** | **Time** | The employee's start date. | [optional] |
|
27
29
|
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
28
30
|
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
29
31
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
30
|
-
| **employee_number** | **String** | The identification number for the employee. | [optional] |
|
31
32
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
32
33
|
|
33
34
|
## Example
|
@@ -38,6 +39,7 @@ require 'merge_hris_client'
|
|
38
39
|
instance = MergeHRISClient::Employee.new(
|
39
40
|
id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
40
41
|
remote_id: 19202938,
|
42
|
+
employee_number: 2,
|
41
43
|
company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
42
44
|
first_name: Jane,
|
43
45
|
last_name: Doe,
|
@@ -56,10 +58,10 @@ instance = MergeHRISClient::Employee.new(
|
|
56
58
|
marital_status: SINGLE,
|
57
59
|
date_of_birth: null,
|
58
60
|
hire_date: null,
|
59
|
-
|
61
|
+
start_date: null,
|
62
|
+
employment_status: INACTIVE,
|
60
63
|
termination_date: null,
|
61
64
|
avatar: http://alturl.com/h2h8m,
|
62
|
-
employee_number: null,
|
63
65
|
remote_data: [{"path":"/people","data":["Varies by platform"]}]
|
64
66
|
)
|
65
67
|
```
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# MergeHRISClient::EmployeeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
|
+
| **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] |
|
9
|
+
| **company** | **String** | The ID of the employee's company. | [optional] |
|
10
|
+
| **first_name** | **String** | The employee's first name. | [optional] |
|
11
|
+
| **last_name** | **String** | The employee's last name. | [optional] |
|
12
|
+
| **display_full_name** | **String** | The employee's full name, to use for display purposes. | [optional] |
|
13
|
+
| **work_email** | **String** | The employee's work email. | [optional] |
|
14
|
+
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
15
|
+
| **mobile_phone_number** | **String** | The employee's mobile phone number. | [optional] |
|
16
|
+
| **home_location** | **String** | The employee's home address. | [optional] |
|
17
|
+
| **work_location** | **String** | The employee's work address. | [optional] |
|
18
|
+
| **manager** | **String** | The employee ID of the employee's manager. | [optional] |
|
19
|
+
| **team** | **String** | The employee's team. | [optional] |
|
20
|
+
| **ssn** | **String** | The employee's social security number. | [optional] |
|
21
|
+
| **gender** | [**GenderEnum**](GenderEnum.md) | The employee's gender. | [optional] |
|
22
|
+
| **ethnicity** | [**EthnicityEnum**](EthnicityEnum.md) | The employee's ethnicity. | [optional] |
|
23
|
+
| **marital_status** | [**MaritalStatusEnum**](MaritalStatusEnum.md) | The employee's marital status. | [optional] |
|
24
|
+
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
25
|
+
| **hire_date** | **Time** | The employee's hire date. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. | [optional] |
|
26
|
+
| **start_date** | **Time** | The employee's start date. | [optional] |
|
27
|
+
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
28
|
+
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
29
|
+
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
30
|
+
|
31
|
+
## Example
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'merge_hris_client'
|
35
|
+
|
36
|
+
instance = MergeHRISClient::EmployeeRequest.new(
|
37
|
+
remote_id: 19202938,
|
38
|
+
employee_number: 2,
|
39
|
+
company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
40
|
+
first_name: Jane,
|
41
|
+
last_name: Doe,
|
42
|
+
display_full_name: Jane Doe,
|
43
|
+
work_email: jane@merge.dev,
|
44
|
+
personal_email: jane@gmail.com,
|
45
|
+
mobile_phone_number: +1234567890,
|
46
|
+
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
47
|
+
work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
48
|
+
manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
|
49
|
+
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
50
|
+
ssn: 1234567890,
|
51
|
+
gender: FEMALE,
|
52
|
+
ethnicity: AMERICAN_INDIAN_OR_ALASKA_NATIVE,
|
53
|
+
marital_status: SINGLE,
|
54
|
+
date_of_birth: null,
|
55
|
+
hire_date: null,
|
56
|
+
start_date: null,
|
57
|
+
employment_status: INACTIVE,
|
58
|
+
termination_date: null,
|
59
|
+
avatar: http://alturl.com/h2h8m
|
60
|
+
)
|
61
|
+
```
|
62
|
+
|