merge_hris_client 2.0.0 → 2.0.3
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 +14 -5
- data/docs/AccountDetails.md +5 -1
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/AccountDetailsApi.md +8 -5
- data/docs/BankInfo.md +3 -1
- data/docs/Benefit.md +3 -1
- data/docs/Company.md +5 -3
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Deduction.md +3 -1
- data/docs/Earning.md +4 -2
- data/docs/Employee.md +11 -9
- data/docs/EmployeePayrollRun.md +3 -1
- data/docs/EmployeeRequest.md +8 -8
- data/docs/EmployeesApi.md +86 -4
- data/docs/Employment.md +8 -4
- data/docs/EndUserDetailsRequest.md +3 -3
- data/docs/ForceResyncApi.md +4 -4
- data/docs/Group.md +3 -1
- data/docs/IssuesApi.md +8 -0
- data/docs/LinkTokenApi.md +1 -1
- data/docs/LinkedAccountStatus.md +20 -0
- data/docs/LinkedAccountsApi.md +14 -14
- data/docs/Location.md +5 -3
- data/docs/MetaResponse.md +24 -0
- data/docs/PayGroup.md +3 -1
- data/docs/PayrollRun.md +3 -1
- data/docs/Tax.md +4 -2
- data/docs/Team.md +3 -1
- data/docs/TimeOff.md +5 -3
- data/docs/TimeOffApi.md +72 -0
- data/docs/TimeOffBalance.md +4 -2
- data/docs/TimeOffRequest.md +2 -2
- 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 +0 -1
- data/lib/merge_hris_client/api/employees_api.rb +88 -3
- data/lib/merge_hris_client/api/employments_api.rb +2 -2
- data/lib/merge_hris_client/api/force_resync_api.rb +3 -3
- data/lib/merge_hris_client/api/issues_api.rb +12 -0
- data/lib/merge_hris_client/api/linked_accounts_api.rb +15 -15
- data/lib/merge_hris_client/api/time_off_api.rb +62 -0
- data/lib/merge_hris_client/api/webhook_receivers_api.rb +154 -0
- data/lib/merge_hris_client/models/account_details.rb +22 -4
- data/lib/merge_hris_client/models/account_details_and_actions.rb +15 -1
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/bank_info.rb +15 -5
- data/lib/merge_hris_client/models/benefit.rb +15 -5
- data/lib/merge_hris_client/models/categories_enum.rb +2 -1
- data/lib/merge_hris_client/models/category_enum.rb +2 -1
- data/lib/merge_hris_client/models/company.rb +16 -6
- data/lib/merge_hris_client/models/country_enum.rb +0 -1
- data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_hris_client/models/deduction.rb +15 -5
- data/lib/merge_hris_client/models/earning.rb +18 -5
- data/lib/merge_hris_client/models/earning_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/employee.rb +15 -6
- data/lib/merge_hris_client/models/employee_payroll_run.rb +15 -5
- data/lib/merge_hris_client/models/employee_request.rb +1 -1
- data/lib/merge_hris_client/models/employment.rb +26 -6
- data/lib/merge_hris_client/models/employment_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/employment_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/encoding_enum.rb +0 -1
- data/lib/merge_hris_client/models/end_user_details_request.rb +34 -0
- data/lib/merge_hris_client/models/ethnicity_enum.rb +0 -1
- data/lib/merge_hris_client/models/flsa_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/gender_enum.rb +0 -1
- data/lib/merge_hris_client/models/group.rb +16 -6
- data/lib/merge_hris_client/models/group_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/issue_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/{data_passthrough.rb → linked_account_status.rb} +24 -49
- data/lib/merge_hris_client/models/location.rb +16 -6
- data/lib/merge_hris_client/models/location_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/marital_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/meta_response.rb +262 -0
- data/lib/merge_hris_client/models/method_enum.rb +0 -1
- data/lib/merge_hris_client/models/pay_currency_enum.rb +0 -1
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +0 -1
- data/lib/merge_hris_client/models/pay_group.rb +15 -5
- data/lib/merge_hris_client/models/pay_period_enum.rb +0 -1
- data/lib/merge_hris_client/models/payroll_run.rb +16 -6
- data/lib/merge_hris_client/models/policy_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/reason_enum.rb +0 -1
- data/lib/merge_hris_client/models/request_format_enum.rb +0 -1
- data/lib/merge_hris_client/models/request_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/run_state_enum.rb +0 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/tax.rb +18 -5
- data/lib/merge_hris_client/models/team.rb +15 -5
- data/lib/merge_hris_client/models/time_off.rb +14 -5
- data/lib/merge_hris_client/models/time_off_balance.rb +16 -6
- data/lib/merge_hris_client/models/time_off_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/units_enum.rb +0 -1
- data/lib/merge_hris_client/models/{remote_key_for_regeneration.rb → webhook_receiver.rb} +38 -16
- data/lib/merge_hris_client/models/{end_user_details.rb → webhook_receiver_request.rb} +60 -69
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +5 -0
- data/spec/api/account_details_api_spec.rb +1 -0
- data/spec/api/employees_api_spec.rb +16 -0
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/issues_api_spec.rb +4 -0
- data/spec/api/linked_accounts_api_spec.rb +7 -7
- data/spec/api/time_off_api_spec.rb +11 -0
- data/spec/api/webhook_receivers_api_spec.rb +58 -0
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/bank_info_spec.rb +6 -0
- data/spec/models/benefit_spec.rb +6 -0
- data/spec/models/company_spec.rb +6 -0
- data/spec/models/deduction_spec.rb +6 -0
- data/spec/models/earning_spec.rb +6 -0
- data/spec/models/employee_payroll_run_spec.rb +6 -0
- data/spec/models/employee_spec.rb +6 -0
- data/spec/models/employment_spec.rb +12 -0
- data/spec/models/group_spec.rb +6 -0
- data/spec/models/linked_account_status_spec.rb +40 -0
- data/spec/models/location_spec.rb +6 -0
- data/spec/models/meta_response_spec.rb +52 -0
- data/spec/models/pay_group_spec.rb +6 -0
- data/spec/models/payroll_run_spec.rb +6 -0
- data/spec/models/tax_spec.rb +6 -0
- data/spec/models/team_spec.rb +6 -0
- data/spec/models/time_off_balance_spec.rb +6 -0
- data/spec/models/time_off_spec.rb +6 -0
- data/spec/models/webhook_receiver_request_spec.rb +46 -0
- data/spec/models/webhook_receiver_spec.rb +46 -0
- metadata +118 -112
- data/docs/BenefitPlanTypeEnum.md +0 -15
- data/docs/TypeEnum.md +0 -15
- data/lib/merge_hris_client/api/time_off_balance_api.rb +0 -196
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +0 -56
- data/lib/merge_hris_client/models/state_enum.rb +0 -93
- data/lib/merge_hris_client/models/type_enum.rb +0 -38
- data/spec/models/benefit_plan_type_enum_spec.rb +0 -28
- data/spec/models/type_enum_spec.rb +0 -28
- 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: c73e43de1aa010c37a121b4edad287773e0ffdb7b1de22ba15749a75b9836f0c
|
|
4
|
+
data.tar.gz: d324ddf4785b69c6dc3ac3ceeb36411334b7adc35f3aa6aa34f5d078a58572c2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4f538c0f8271d2698b7f4229313267fbd0d5b19801040b07958c28e8c6631aee77be89f43f6130c1d233b5b206f7ab238bb4850fa8829dea88f663225299a158
|
|
7
|
+
data.tar.gz: bccabbf556031e866b1e83eae70d5011d1ad0eb5b1e621b59b30ccef1e7ebcebce5f6622bed1a41ce5a5fcb8ee38caad52a64483ff63a4551e15cd1b6e83d102
|
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: 2.0.
|
|
10
|
+
- Package version: 2.0.3
|
|
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-2.0.
|
|
27
|
+
gem install ./merge_hris_client-2.0.3.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./merge_hris_client-2.0.
|
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-2.0.3.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', '~> 2.0.
|
|
36
|
+
gem 'merge_hris_client', '~> 2.0.3'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -66,9 +66,10 @@ MergeHRISClient.configure do |config|
|
|
|
66
66
|
end
|
|
67
67
|
|
|
68
68
|
api_instance = MergeHRISClient::AccountDetailsApi.new
|
|
69
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
69
70
|
|
|
70
71
|
begin
|
|
71
|
-
result = api_instance.account_details_retrieve
|
|
72
|
+
result = api_instance.account_details_retrieve(x_account_token)
|
|
72
73
|
p result
|
|
73
74
|
rescue MergeHRISClient::ApiError => e
|
|
74
75
|
puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
|
|
@@ -99,6 +100,7 @@ Class | Method | HTTP request | Description
|
|
|
99
100
|
*MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees |
|
|
100
101
|
*MergeHRISClient::EmployeesApi* | [**employees_ignore_create**](docs/EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} |
|
|
101
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 |
|
|
102
104
|
*MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
|
|
103
105
|
*MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
|
|
104
106
|
*MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
|
|
@@ -123,9 +125,12 @@ Class | Method | HTTP request | Description
|
|
|
123
125
|
*MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
|
|
124
126
|
*MergeHRISClient::TimeOffApi* | [**time_off_create**](docs/TimeOffApi.md#time_off_create) | **POST** /time-off |
|
|
125
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 |
|
|
126
129
|
*MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |
|
|
127
130
|
*MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_list**](docs/TimeOffBalancesApi.md#time_off_balances_list) | **GET** /time-off-balances |
|
|
128
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 |
|
|
129
134
|
|
|
130
135
|
|
|
131
136
|
## Documentation for Models
|
|
@@ -172,9 +177,11 @@ Class | Method | HTTP request | Description
|
|
|
172
177
|
- [MergeHRISClient::Issue](docs/Issue.md)
|
|
173
178
|
- [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
|
174
179
|
- [MergeHRISClient::LinkToken](docs/LinkToken.md)
|
|
180
|
+
- [MergeHRISClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
|
|
175
181
|
- [MergeHRISClient::Location](docs/Location.md)
|
|
176
182
|
- [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
|
|
177
183
|
- [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
|
|
184
|
+
- [MergeHRISClient::MetaResponse](docs/MetaResponse.md)
|
|
178
185
|
- [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
|
|
179
186
|
- [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
|
|
180
187
|
- [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
|
|
@@ -224,6 +231,8 @@ Class | Method | HTTP request | Description
|
|
|
224
231
|
- [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
|
|
225
232
|
- [MergeHRISClient::ValidationProblemSource](docs/ValidationProblemSource.md)
|
|
226
233
|
- [MergeHRISClient::WarningValidationProblem](docs/WarningValidationProblem.md)
|
|
234
|
+
- [MergeHRISClient::WebhookReceiver](docs/WebhookReceiver.md)
|
|
235
|
+
- [MergeHRISClient::WebhookReceiverRequest](docs/WebhookReceiverRequest.md)
|
|
227
236
|
|
|
228
237
|
|
|
229
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
|
|
|
@@ -20,11 +22,13 @@ require 'merge_hris_client'
|
|
|
20
22
|
instance = MergeHRISClient::AccountDetails.new(
|
|
21
23
|
id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd,
|
|
22
24
|
integration: BambooHR,
|
|
25
|
+
integration_slug: bamboohr,
|
|
23
26
|
category: hris,
|
|
24
27
|
end_user_origin_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
|
25
28
|
end_user_organization_name: Waystar Royco,
|
|
26
29
|
end_user_email_address: kendall.roy@waystar-royco.com,
|
|
27
|
-
status: COMPLETE
|
|
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
|
|
|
@@ -29,10 +29,11 @@ MergeHRISClient.configure do |config|
|
|
|
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/BankInfo.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type | [optional] |
|
|
14
14
|
| **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [optional] |
|
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,7 +29,8 @@ instance = MergeHRISClient::BankInfo.new(
|
|
|
28
29
|
bank_name: Chase,
|
|
29
30
|
account_type: CHECKING,
|
|
30
31
|
remote_created_at: 2021-12-06T10:11:26Z,
|
|
31
|
-
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}]
|
|
32
|
+
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}],
|
|
33
|
+
remote_was_deleted: null
|
|
32
34
|
)
|
|
33
35
|
```
|
|
34
36
|
|
data/docs/Benefit.md
CHANGED
|
@@ -12,6 +12,7 @@
|
|
|
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] |
|
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,7 +27,8 @@ instance = MergeHRISClient::Benefit.new(
|
|
|
26
27
|
benefit_plan_type: MEDICAL,
|
|
27
28
|
employee_contribution: 23.65,
|
|
28
29
|
company_contribution: 150.0,
|
|
29
|
-
remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
|
|
30
|
+
remote_data: [{"path":"/benefits","data":["Varies by platform"]}],
|
|
31
|
+
remote_was_deleted: null
|
|
30
32
|
)
|
|
31
33
|
```
|
|
32
34
|
|
data/docs/Company.md
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| **display_name** | **String** | The company's display name. | [optional] |
|
|
11
11
|
| **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
|
|
12
12
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -19,10 +20,11 @@ require 'merge_hris_client'
|
|
|
19
20
|
instance = MergeHRISClient::Company.new(
|
|
20
21
|
id: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
|
21
22
|
remote_id: 19202938,
|
|
22
|
-
legal_name:
|
|
23
|
-
display_name:
|
|
23
|
+
legal_name: Waystar Royco, Inc.,
|
|
24
|
+
display_name: Waystar Royco,
|
|
24
25
|
eins: ["12-3456789","12-3451111","11-0011000"],
|
|
25
|
-
remote_data: [{"path":"/companies","data":["Varies by platform"]}]
|
|
26
|
+
remote_data: [{"path":"/companies","data":["Varies by platform"]}],
|
|
27
|
+
remote_was_deleted: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
|
@@ -9,7 +9,7 @@
|
|
|
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) |
|
|
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] |
|
|
13
13
|
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
data/docs/Deduction.md
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
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
12
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,7 +23,8 @@ instance = MergeHRISClient::Deduction.new(
|
|
|
22
23
|
name: Social Security,
|
|
23
24
|
employee_deduction: 34.54,
|
|
24
25
|
company_deduction: 78.78,
|
|
25
|
-
remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}]
|
|
26
|
+
remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}],
|
|
27
|
+
remote_was_deleted: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/Earning.md
CHANGED
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
| **employee_payroll_run** | **String** | | [optional] |
|
|
9
9
|
| **amount** | **Float** | The amount earned. | [optional] |
|
|
10
10
|
| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
|
|
11
|
-
| **remote_data** | **String
|
|
11
|
+
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,7 +21,8 @@ instance = MergeHRISClient::Earning.new(
|
|
|
20
21
|
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
|
21
22
|
amount: 1002.34,
|
|
22
23
|
type: SALARY,
|
|
23
|
-
remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}]
|
|
24
|
+
remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}],
|
|
25
|
+
remote_was_deleted: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
26
28
|
|
data/docs/Employee.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_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
|
+
| **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. This value can also change in many API providers. | [optional] |
|
|
10
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] |
|
|
@@ -33,6 +33,7 @@
|
|
|
33
33
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
|
34
34
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
35
35
|
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
|
36
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
|
36
37
|
|
|
37
38
|
## Example
|
|
38
39
|
|
|
@@ -44,12 +45,12 @@ instance = MergeHRISClient::Employee.new(
|
|
|
44
45
|
remote_id: 19202938,
|
|
45
46
|
employee_number: 2,
|
|
46
47
|
company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
|
47
|
-
first_name:
|
|
48
|
-
last_name:
|
|
49
|
-
display_full_name:
|
|
48
|
+
first_name: Greg,
|
|
49
|
+
last_name: Hirsch,
|
|
50
|
+
display_full_name: Cousin Greg Hirsch,
|
|
50
51
|
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
|
51
|
-
work_email:
|
|
52
|
-
personal_email:
|
|
52
|
+
work_email: greg@merge.dev,
|
|
53
|
+
personal_email: greg@gmail.com,
|
|
53
54
|
mobile_phone_number: +1234567890,
|
|
54
55
|
employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
|
55
56
|
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
@@ -58,8 +59,8 @@ instance = MergeHRISClient::Employee.new(
|
|
|
58
59
|
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
|
59
60
|
pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
|
|
60
61
|
ssn: 1234567890,
|
|
61
|
-
gender:
|
|
62
|
-
ethnicity:
|
|
62
|
+
gender: MALE,
|
|
63
|
+
ethnicity: WHITE,
|
|
63
64
|
marital_status: SINGLE,
|
|
64
65
|
date_of_birth: 1990-11-10T00:00Z,
|
|
65
66
|
hire_date: 2020-10-10T00:00Z,
|
|
@@ -68,7 +69,8 @@ instance = MergeHRISClient::Employee.new(
|
|
|
68
69
|
termination_date: 2021-10-12T00:00Z,
|
|
69
70
|
avatar: http://alturl.com/h2h8m,
|
|
70
71
|
remote_data: [{"path":"/people","data":["Varies by platform"]}],
|
|
71
|
-
custom_fields: null
|
|
72
|
+
custom_fields: null,
|
|
73
|
+
remote_was_deleted: null
|
|
72
74
|
)
|
|
73
75
|
```
|
|
74
76
|
|
data/docs/EmployeePayrollRun.md
CHANGED
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
| **deductions** | [**Array<Deduction>**](Deduction.md) | | [optional][readonly] |
|
|
18
18
|
| **taxes** | [**Array<Tax>**](Tax.md) | | [optional][readonly] |
|
|
19
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -36,7 +37,8 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
|
|
|
36
37
|
earnings: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":1002.34,"type":"SALARY"},{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":8342.34,"type":"OVERTIME"}],
|
|
37
38
|
deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
|
|
38
39
|
taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],
|
|
39
|
-
remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}]
|
|
40
|
+
remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}],
|
|
41
|
+
remote_was_deleted: null
|
|
40
42
|
)
|
|
41
43
|
```
|
|
42
44
|
|
data/docs/EmployeeRequest.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
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] |
|
|
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. This value can also change in many API providers. | [optional] |
|
|
9
9
|
| **company** | **String** | | [optional] |
|
|
10
10
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
|
11
11
|
| **last_name** | **String** | The employee's last name. | [optional] |
|
|
@@ -41,12 +41,12 @@ instance = MergeHRISClient::EmployeeRequest.new(
|
|
|
41
41
|
remote_id: 19202938,
|
|
42
42
|
employee_number: 2,
|
|
43
43
|
company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
|
44
|
-
first_name:
|
|
45
|
-
last_name:
|
|
46
|
-
display_full_name:
|
|
44
|
+
first_name: Greg,
|
|
45
|
+
last_name: Hirsch,
|
|
46
|
+
display_full_name: Cousin Greg Hirsch,
|
|
47
47
|
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
|
48
|
-
work_email:
|
|
49
|
-
personal_email:
|
|
48
|
+
work_email: greg@merge.dev,
|
|
49
|
+
personal_email: greg@gmail.com,
|
|
50
50
|
mobile_phone_number: +1234567890,
|
|
51
51
|
employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
|
52
52
|
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
@@ -55,8 +55,8 @@ instance = MergeHRISClient::EmployeeRequest.new(
|
|
|
55
55
|
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
|
56
56
|
pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
|
|
57
57
|
ssn: 1234567890,
|
|
58
|
-
gender:
|
|
59
|
-
ethnicity:
|
|
58
|
+
gender: MALE,
|
|
59
|
+
ethnicity: WHITE,
|
|
60
60
|
marital_status: SINGLE,
|
|
61
61
|
date_of_birth: 1990-11-10T00:00Z,
|
|
62
62
|
hire_date: 2020-10-10T00:00Z,
|
data/docs/EmployeesApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
|
7
7
|
| [**employees_create**](EmployeesApi.md#employees_create) | **POST** /employees | |
|
|
8
8
|
| [**employees_ignore_create**](EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} | |
|
|
9
9
|
| [**employees_list**](EmployeesApi.md#employees_list) | **GET** /employees | |
|
|
10
|
+
| [**employees_meta_post_retrieve**](EmployeesApi.md#employees_meta_post_retrieve) | **GET** /employees/meta/post | |
|
|
10
11
|
| [**employees_retrieve**](EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} | |
|
|
11
12
|
|
|
12
13
|
|
|
@@ -91,7 +92,7 @@ end
|
|
|
91
92
|
|
|
92
93
|
## employees_ignore_create
|
|
93
94
|
|
|
94
|
-
> <IgnoreCommonModel> employees_ignore_create(model_id, ignore_common_model_request)
|
|
95
|
+
> <IgnoreCommonModel> employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
|
|
95
96
|
|
|
96
97
|
|
|
97
98
|
|
|
@@ -111,12 +112,13 @@ MergeHRISClient.configure do |config|
|
|
|
111
112
|
end
|
|
112
113
|
|
|
113
114
|
api_instance = MergeHRISClient::EmployeesApi.new
|
|
115
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
114
116
|
model_id = TODO # String |
|
|
115
117
|
ignore_common_model_request = MergeHRISClient::IgnoreCommonModelRequest.new({reason: MergeHRISClient::ReasonEnum::GENERAL_CUSTOMER_REQUEST}) # IgnoreCommonModelRequest |
|
|
116
118
|
|
|
117
119
|
begin
|
|
118
120
|
|
|
119
|
-
result = api_instance.employees_ignore_create(model_id, ignore_common_model_request)
|
|
121
|
+
result = api_instance.employees_ignore_create(x_account_token, model_id, ignore_common_model_request)
|
|
120
122
|
p result
|
|
121
123
|
rescue MergeHRISClient::ApiError => e
|
|
122
124
|
puts "Error when calling EmployeesApi->employees_ignore_create: #{e}"
|
|
@@ -127,12 +129,12 @@ end
|
|
|
127
129
|
|
|
128
130
|
This returns an Array which contains the response data, status code and headers.
|
|
129
131
|
|
|
130
|
-
> <Array(<IgnoreCommonModel>, Integer, Hash)> employees_ignore_create_with_http_info(model_id, ignore_common_model_request)
|
|
132
|
+
> <Array(<IgnoreCommonModel>, Integer, Hash)> employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
|
|
131
133
|
|
|
132
134
|
```ruby
|
|
133
135
|
begin
|
|
134
136
|
|
|
135
|
-
data, status_code, headers = api_instance.employees_ignore_create_with_http_info(model_id, ignore_common_model_request)
|
|
137
|
+
data, status_code, headers = api_instance.employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request)
|
|
136
138
|
p status_code # => 2xx
|
|
137
139
|
p headers # => { ... }
|
|
138
140
|
p data # => <IgnoreCommonModel>
|
|
@@ -145,6 +147,7 @@ end
|
|
|
145
147
|
|
|
146
148
|
| Name | Type | Description | Notes |
|
|
147
149
|
| ---- | ---- | ----------- | ----- |
|
|
150
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
148
151
|
| **model_id** | [**String**](.md) | | |
|
|
149
152
|
| **ignore_common_model_request** | [**IgnoreCommonModelRequest**](IgnoreCommonModelRequest.md) | | |
|
|
150
153
|
|
|
@@ -190,10 +193,14 @@ opts = {
|
|
|
190
193
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
|
191
194
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
192
195
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
196
|
+
display_full_name: 'display_full_name_example', # String | If provided, will only return employees with this display name.
|
|
197
|
+
employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status.
|
|
193
198
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
199
|
+
first_name: 'first_name_example', # String | If provided, will only return employees with this first name.
|
|
194
200
|
include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
|
|
195
201
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
196
202
|
include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
|
203
|
+
last_name: 'last_name_example', # String | If provided, will only return employees with this last name.
|
|
197
204
|
manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
|
|
198
205
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
|
199
206
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
|
@@ -242,10 +249,14 @@ end
|
|
|
242
249
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
|
243
250
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
244
251
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
252
|
+
| **display_full_name** | **String** | If provided, will only return employees with this display name. | [optional] |
|
|
253
|
+
| **employment_status** | **String** | If provided, will only return employees with this employment status. | [optional] |
|
|
245
254
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
255
|
+
| **first_name** | **String** | If provided, will only return employees with this first name. | [optional] |
|
|
246
256
|
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
|
|
247
257
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
248
258
|
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
|
259
|
+
| **last_name** | **String** | If provided, will only return employees with this last name. | [optional] |
|
|
249
260
|
| **manager_id** | **String** | If provided, will only return employees for this manager. | [optional] |
|
|
250
261
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
|
251
262
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
|
@@ -271,6 +282,77 @@ end
|
|
|
271
282
|
- **Accept**: application/json
|
|
272
283
|
|
|
273
284
|
|
|
285
|
+
## employees_meta_post_retrieve
|
|
286
|
+
|
|
287
|
+
> <MetaResponse> employees_meta_post_retrieve(x_account_token)
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
Returns metadata for `Employee` POSTs.
|
|
292
|
+
|
|
293
|
+
### Examples
|
|
294
|
+
|
|
295
|
+
```ruby
|
|
296
|
+
require 'time'
|
|
297
|
+
require 'merge_hris_client'
|
|
298
|
+
# setup authorization
|
|
299
|
+
MergeHRISClient.configure do |config|
|
|
300
|
+
# Configure API key authorization: tokenAuth
|
|
301
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
302
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
303
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
api_instance = MergeHRISClient::EmployeesApi.new
|
|
307
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
308
|
+
|
|
309
|
+
begin
|
|
310
|
+
|
|
311
|
+
result = api_instance.employees_meta_post_retrieve(x_account_token)
|
|
312
|
+
p result
|
|
313
|
+
rescue MergeHRISClient::ApiError => e
|
|
314
|
+
puts "Error when calling EmployeesApi->employees_meta_post_retrieve: #{e}"
|
|
315
|
+
end
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
#### Using the employees_meta_post_retrieve_with_http_info variant
|
|
319
|
+
|
|
320
|
+
This returns an Array which contains the response data, status code and headers.
|
|
321
|
+
|
|
322
|
+
> <Array(<MetaResponse>, Integer, Hash)> employees_meta_post_retrieve_with_http_info(x_account_token)
|
|
323
|
+
|
|
324
|
+
```ruby
|
|
325
|
+
begin
|
|
326
|
+
|
|
327
|
+
data, status_code, headers = api_instance.employees_meta_post_retrieve_with_http_info(x_account_token)
|
|
328
|
+
p status_code # => 2xx
|
|
329
|
+
p headers # => { ... }
|
|
330
|
+
p data # => <MetaResponse>
|
|
331
|
+
rescue MergeHRISClient::ApiError => e
|
|
332
|
+
puts "Error when calling EmployeesApi->employees_meta_post_retrieve_with_http_info: #{e}"
|
|
333
|
+
end
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Parameters
|
|
337
|
+
|
|
338
|
+
| Name | Type | Description | Notes |
|
|
339
|
+
| ---- | ---- | ----------- | ----- |
|
|
340
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
341
|
+
|
|
342
|
+
### Return type
|
|
343
|
+
|
|
344
|
+
[**MetaResponse**](MetaResponse.md)
|
|
345
|
+
|
|
346
|
+
### Authorization
|
|
347
|
+
|
|
348
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
349
|
+
|
|
350
|
+
### HTTP request headers
|
|
351
|
+
|
|
352
|
+
- **Content-Type**: Not defined
|
|
353
|
+
- **Accept**: application/json
|
|
354
|
+
|
|
355
|
+
|
|
274
356
|
## employees_retrieve
|
|
275
357
|
|
|
276
358
|
> <Employee> employees_retrieve(x_account_token, id, opts)
|
data/docs/Employment.md
CHANGED
|
@@ -12,10 +12,12 @@
|
|
|
12
12
|
| **pay_period** | [**PayPeriodEnum**](PayPeriodEnum.md) | The time period this pay rate encompasses. | [optional] |
|
|
13
13
|
| **pay_frequency** | [**PayFrequencyEnum**](PayFrequencyEnum.md) | The position's pay frequency. | [optional] |
|
|
14
14
|
| **pay_currency** | [**PayCurrencyEnum**](PayCurrencyEnum.md) | The position's currency code. | [optional] |
|
|
15
|
+
| **pay_group** | **String** | | [optional] |
|
|
15
16
|
| **flsa_status** | [**FlsaStatusEnum**](FlsaStatusEnum.md) | The position's FLSA status. | [optional] |
|
|
16
17
|
| **effective_date** | **Time** | The position's effective date. | [optional] |
|
|
17
18
|
| **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position's type of employment. | [optional] |
|
|
18
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -26,15 +28,17 @@ instance = MergeHRISClient::Employment.new(
|
|
|
26
28
|
id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
|
|
27
29
|
remote_id: 19202938,
|
|
28
30
|
employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
|
29
|
-
job_title:
|
|
30
|
-
pay_rate:
|
|
31
|
+
job_title: Executive Assistant to Tom Wambsgans,
|
|
32
|
+
pay_rate: 50000.00,
|
|
31
33
|
pay_period: YEAR,
|
|
32
34
|
pay_frequency: BIWEEKLY,
|
|
33
35
|
pay_currency: USD,
|
|
36
|
+
pay_group: d4e4837f-9900-484c-ac40-528365bb08ef,
|
|
34
37
|
flsa_status: EXEMPT,
|
|
35
|
-
effective_date:
|
|
38
|
+
effective_date: 2023-10-06T18:42:34Z,
|
|
36
39
|
employment_type: FULL TIME,
|
|
37
|
-
remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
|
|
40
|
+
remote_data: [{"path":"/jobs","data":["Varies by platform"]}],
|
|
41
|
+
remote_was_deleted: null
|
|
38
42
|
)
|
|
39
43
|
```
|
|
40
44
|
|
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
| **end_user_email_address** | **String** | | |
|
|
8
8
|
| **end_user_organization_name** | **String** | | |
|
|
9
9
|
| **end_user_origin_id** | **String** | | |
|
|
10
|
-
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | |
|
|
11
|
-
| **integration** | **String** |
|
|
12
|
-
| **link_expiry_mins** | **Integer** |
|
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | | |
|
|
11
|
+
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata | [optional] |
|
|
12
|
+
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|