merge_hris_client 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +14 -5
- data/docs/AccountDetails.md +5 -1
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/AccountDetailsApi.md +8 -5
- data/docs/Company.md +2 -2
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Employee.md +8 -8
- data/docs/EmployeeRequest.md +8 -8
- data/docs/EmployeesApi.md +78 -4
- data/docs/Employment.md +5 -3
- data/docs/EndUserDetailsRequest.md +3 -3
- data/docs/IssuesApi.md +8 -0
- data/docs/LinkTokenApi.md +1 -1
- data/docs/LinkedAccountStatus.md +20 -0
- data/docs/Location.md +1 -1
- data/docs/MetaResponse.md +24 -0
- data/docs/TimeOff.md +2 -2
- data/docs/TimeOffApi.md +72 -0
- data/docs/TimeOffBalance.md +1 -1
- 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/employees_api.rb +72 -3
- data/lib/merge_hris_client/api/employments_api.rb +2 -2
- data/lib/merge_hris_client/api/issues_api.rb +12 -0
- data/lib/merge_hris_client/api/linked_accounts_api.rb +1 -1
- data/lib/merge_hris_client/api/time_off_api.rb +62 -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/company.rb +1 -1
- data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_hris_client/models/earning.rb +1 -0
- data/lib/merge_hris_client/models/employee.rb +1 -1
- data/lib/merge_hris_client/models/employee_request.rb +1 -1
- data/lib/merge_hris_client/models/employment.rb +12 -2
- data/lib/merge_hris_client/models/end_user_details_request.rb +34 -0
- data/lib/merge_hris_client/models/group.rb +1 -1
- data/lib/merge_hris_client/models/linked_account_status.rb +237 -0
- data/lib/merge_hris_client/models/location.rb +1 -1
- data/lib/merge_hris_client/models/meta_response.rb +262 -0
- data/lib/merge_hris_client/models/payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/tax.rb +1 -0
- data/lib/merge_hris_client/models/time_off_balance.rb +1 -1
- data/lib/merge_hris_client/models/webhook_receiver.rb +246 -0
- data/lib/merge_hris_client/models/webhook_receiver_request.rb +280 -0
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +5 -0
- data/spec/api/account_details_api_spec.rb +1 -0
- data/spec/api/employees_api_spec.rb +12 -0
- data/spec/api/issues_api_spec.rb +4 -0
- data/spec/api/time_off_api_spec.rb +11 -0
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/employment_spec.rb +6 -0
- metadata +108 -100
- 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: 50d8774f2f315c4183225ba7818a198455db0cdca22a2ae9df2274f3294bbb6d
|
4
|
+
data.tar.gz: e22ba5fb73c5ec1a4b7604f337889e734b524e7b96f22c326119178d955628e7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 70ae18aa5637754e0645ab3ccadd690cacd745623d4f98046425a78ab9c61edb90e9f7dddaffcef0cfc6523256215f8119ab08c7a1fdf2894c53c60711cedcea
|
7
|
+
data.tar.gz: 4405a404e9e5f85308f2a47c06b079522d73a3e53fa921edecfd5845a48d78dc1b6718d97c83ead686847f6734da928dcc927883fa4611cb2a16e5f5eafe1339
|
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.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_hris_client-2.0.
|
27
|
+
gem install ./merge_hris_client-2.0.1.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.1.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_hris_client', '~> 2.0.
|
36
|
+
gem 'merge_hris_client', '~> 2.0.1'
|
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/Company.md
CHANGED
@@ -19,8 +19,8 @@ require 'merge_hris_client'
|
|
19
19
|
instance = MergeHRISClient::Company.new(
|
20
20
|
id: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
21
21
|
remote_id: 19202938,
|
22
|
-
legal_name:
|
23
|
-
display_name:
|
22
|
+
legal_name: Waystar Royco, Inc.,
|
23
|
+
display_name: Waystar Royco,
|
24
24
|
eins: ["12-3456789","12-3451111","11-0011000"],
|
25
25
|
remote_data: [{"path":"/companies","data":["Varies by platform"]}]
|
26
26
|
)
|
@@ -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/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] |
|
@@ -44,12 +44,12 @@ instance = MergeHRISClient::Employee.new(
|
|
44
44
|
remote_id: 19202938,
|
45
45
|
employee_number: 2,
|
46
46
|
company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
47
|
-
first_name:
|
48
|
-
last_name:
|
49
|
-
display_full_name:
|
47
|
+
first_name: Greg,
|
48
|
+
last_name: Hirsch,
|
49
|
+
display_full_name: Cousin Greg Hirsch,
|
50
50
|
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
51
|
-
work_email:
|
52
|
-
personal_email:
|
51
|
+
work_email: greg@merge.dev,
|
52
|
+
personal_email: greg@gmail.com,
|
53
53
|
mobile_phone_number: +1234567890,
|
54
54
|
employments: ["17a54124-287f-494d-965e-3c5b330c9a68"],
|
55
55
|
home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
@@ -58,8 +58,8 @@ instance = MergeHRISClient::Employee.new(
|
|
58
58
|
team: 249c9faa-3045-4a31-953b-8f22d3613301,
|
59
59
|
pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
|
60
60
|
ssn: 1234567890,
|
61
|
-
gender:
|
62
|
-
ethnicity:
|
61
|
+
gender: MALE,
|
62
|
+
ethnicity: WHITE,
|
63
63
|
marital_status: SINGLE,
|
64
64
|
date_of_birth: 1990-11-10T00:00Z,
|
65
65
|
hire_date: 2020-10-10T00:00Z,
|
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
|
|
@@ -271,6 +274,77 @@ end
|
|
271
274
|
- **Accept**: application/json
|
272
275
|
|
273
276
|
|
277
|
+
## employees_meta_post_retrieve
|
278
|
+
|
279
|
+
> <MetaResponse> employees_meta_post_retrieve(x_account_token)
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
Returns metadata for `Employee` POSTs.
|
284
|
+
|
285
|
+
### Examples
|
286
|
+
|
287
|
+
```ruby
|
288
|
+
require 'time'
|
289
|
+
require 'merge_hris_client'
|
290
|
+
# setup authorization
|
291
|
+
MergeHRISClient.configure do |config|
|
292
|
+
# Configure API key authorization: tokenAuth
|
293
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
294
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
295
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
296
|
+
end
|
297
|
+
|
298
|
+
api_instance = MergeHRISClient::EmployeesApi.new
|
299
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
300
|
+
|
301
|
+
begin
|
302
|
+
|
303
|
+
result = api_instance.employees_meta_post_retrieve(x_account_token)
|
304
|
+
p result
|
305
|
+
rescue MergeHRISClient::ApiError => e
|
306
|
+
puts "Error when calling EmployeesApi->employees_meta_post_retrieve: #{e}"
|
307
|
+
end
|
308
|
+
```
|
309
|
+
|
310
|
+
#### Using the employees_meta_post_retrieve_with_http_info variant
|
311
|
+
|
312
|
+
This returns an Array which contains the response data, status code and headers.
|
313
|
+
|
314
|
+
> <Array(<MetaResponse>, Integer, Hash)> employees_meta_post_retrieve_with_http_info(x_account_token)
|
315
|
+
|
316
|
+
```ruby
|
317
|
+
begin
|
318
|
+
|
319
|
+
data, status_code, headers = api_instance.employees_meta_post_retrieve_with_http_info(x_account_token)
|
320
|
+
p status_code # => 2xx
|
321
|
+
p headers # => { ... }
|
322
|
+
p data # => <MetaResponse>
|
323
|
+
rescue MergeHRISClient::ApiError => e
|
324
|
+
puts "Error when calling EmployeesApi->employees_meta_post_retrieve_with_http_info: #{e}"
|
325
|
+
end
|
326
|
+
```
|
327
|
+
|
328
|
+
### Parameters
|
329
|
+
|
330
|
+
| Name | Type | Description | Notes |
|
331
|
+
| ---- | ---- | ----------- | ----- |
|
332
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
333
|
+
|
334
|
+
### Return type
|
335
|
+
|
336
|
+
[**MetaResponse**](MetaResponse.md)
|
337
|
+
|
338
|
+
### Authorization
|
339
|
+
|
340
|
+
[tokenAuth](../README.md#tokenAuth)
|
341
|
+
|
342
|
+
### HTTP request headers
|
343
|
+
|
344
|
+
- **Content-Type**: Not defined
|
345
|
+
- **Accept**: application/json
|
346
|
+
|
347
|
+
|
274
348
|
## employees_retrieve
|
275
349
|
|
276
350
|
> <Employee> employees_retrieve(x_account_token, id, opts)
|
data/docs/Employment.md
CHANGED
@@ -12,6 +12,7 @@
|
|
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] |
|
@@ -26,13 +27,14 @@ instance = MergeHRISClient::Employment.new(
|
|
26
27
|
id: 65d8ffd0-211b-4ba4-b85a-fbe2ce220982,
|
27
28
|
remote_id: 19202938,
|
28
29
|
employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
29
|
-
job_title:
|
30
|
-
pay_rate:
|
30
|
+
job_title: Executive Assistant to Tom Wambsgans,
|
31
|
+
pay_rate: 500.00,
|
31
32
|
pay_period: YEAR,
|
32
33
|
pay_frequency: BIWEEKLY,
|
33
34
|
pay_currency: USD,
|
35
|
+
pay_group: d4e4837f-9900-484c-ac40-528365bb08ef,
|
34
36
|
flsa_status: EXEMPT,
|
35
|
-
effective_date:
|
37
|
+
effective_date: 2023-10-06T18:42:34Z,
|
36
38
|
employment_type: FULL TIME,
|
37
39
|
remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
|
38
40
|
)
|
@@ -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<
|
11
|
-
| **integration** | **String** |
|
12
|
-
| **link_expiry_mins** | **Integer** |
|
10
|
+
| **categories** | [**Array<Categories143Enum>**](Categories143Enum.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
|
|
data/docs/IssuesApi.md
CHANGED
@@ -35,8 +35,12 @@ opts = {
|
|
35
35
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
36
36
|
end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
|
37
37
|
end_user_organization_name: 'end_user_organization_name_example', # String |
|
38
|
+
first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
|
39
|
+
first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
|
38
40
|
include_muted: 'include_muted_example', # String | If True, will include muted issues
|
39
41
|
integration_name: 'integration_name_example', # String |
|
42
|
+
last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
|
43
|
+
last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
|
40
44
|
page_size: 56, # Integer | Number of results to return per page.
|
41
45
|
start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
|
42
46
|
status: 'ONGOING' # String |
|
@@ -77,8 +81,12 @@ end
|
|
77
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
78
82
|
| **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
|
79
83
|
| **end_user_organization_name** | **String** | | [optional] |
|
84
|
+
| **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
|
85
|
+
| **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
80
86
|
| **include_muted** | **String** | If True, will include muted issues | [optional] |
|
81
87
|
| **integration_name** | **String** | | [optional] |
|
88
|
+
| **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
|
89
|
+
| **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
82
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
83
91
|
| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
|
84
92
|
| **status** | **String** | | [optional] |
|
data/docs/LinkTokenApi.md
CHANGED
@@ -29,7 +29,7 @@ MergeHRISClient.configure do |config|
|
|
29
29
|
end
|
30
30
|
|
31
31
|
api_instance = MergeHRISClient::LinkTokenApi.new
|
32
|
-
end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example'}) # EndUserDetailsRequest |
|
32
|
+
end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest |
|
33
33
|
|
34
34
|
begin
|
35
35
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MergeHRISClient::LinkedAccountStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **linked_account_status** | **String** | | |
|
8
|
+
| **can_make_request** | **Boolean** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'merge_hris_client'
|
14
|
+
|
15
|
+
instance = MergeHRISClient::LinkedAccountStatus.new(
|
16
|
+
linked_account_status: null,
|
17
|
+
can_make_request: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Location.md
CHANGED
@@ -12,7 +12,7 @@
|
|
12
12
|
| **street_2** | **String** | Line 2 of the location's street address. | [optional] |
|
13
13
|
| **city** | **String** | The location's city. | [optional] |
|
14
14
|
| **state** | **String** | The location's state. Represents a region if outside of the US. | [optional] |
|
15
|
-
| **zip_code** | **String** | The location's zip code. | [optional] |
|
15
|
+
| **zip_code** | **String** | The location's zip code or postal code. | [optional] |
|
16
16
|
| **country** | [**CountryEnum**](CountryEnum.md) | The location's country. | [optional] |
|
17
17
|
| **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME | [optional] |
|
18
18
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeHRISClient::MetaResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **request_schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
8
|
+
| **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
|
9
|
+
| **has_conditional_params** | **Boolean** | | |
|
10
|
+
| **has_required_linked_account_params** | **Boolean** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_hris_client'
|
16
|
+
|
17
|
+
instance = MergeHRISClient::MetaResponse.new(
|
18
|
+
request_schema: null,
|
19
|
+
status: null,
|
20
|
+
has_conditional_params: null,
|
21
|
+
has_required_linked_account_params: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/TimeOff.md
CHANGED
@@ -28,9 +28,9 @@ instance = MergeHRISClient::TimeOff.new(
|
|
28
28
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
29
29
|
approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
30
30
|
status: APPROVED,
|
31
|
-
employee_note:
|
31
|
+
employee_note: Moving into the new apartment Kendall Roy gave me!,
|
32
32
|
units: DAYS,
|
33
|
-
amount:
|
33
|
+
amount: 3,
|
34
34
|
request_type: VACATION,
|
35
35
|
start_time: 2020-11-10T00:00Z,
|
36
36
|
end_time: 2020-11-17T00:00Z,
|
data/docs/TimeOffApi.md
CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**time_off_create**](TimeOffApi.md#time_off_create) | **POST** /time-off | |
|
8
8
|
| [**time_off_list**](TimeOffApi.md#time_off_list) | **GET** /time-off | |
|
9
|
+
| [**time_off_meta_post_retrieve**](TimeOffApi.md#time_off_meta_post_retrieve) | **GET** /time-off/meta/post | |
|
9
10
|
| [**time_off_retrieve**](TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} | |
|
10
11
|
|
11
12
|
|
@@ -189,6 +190,77 @@ end
|
|
189
190
|
- **Accept**: application/json
|
190
191
|
|
191
192
|
|
193
|
+
## time_off_meta_post_retrieve
|
194
|
+
|
195
|
+
> <MetaResponse> time_off_meta_post_retrieve(x_account_token)
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
Returns metadata for `TimeOff` POSTs.
|
200
|
+
|
201
|
+
### Examples
|
202
|
+
|
203
|
+
```ruby
|
204
|
+
require 'time'
|
205
|
+
require 'merge_hris_client'
|
206
|
+
# setup authorization
|
207
|
+
MergeHRISClient.configure do |config|
|
208
|
+
# Configure API key authorization: tokenAuth
|
209
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
210
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
211
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
212
|
+
end
|
213
|
+
|
214
|
+
api_instance = MergeHRISClient::TimeOffApi.new
|
215
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
216
|
+
|
217
|
+
begin
|
218
|
+
|
219
|
+
result = api_instance.time_off_meta_post_retrieve(x_account_token)
|
220
|
+
p result
|
221
|
+
rescue MergeHRISClient::ApiError => e
|
222
|
+
puts "Error when calling TimeOffApi->time_off_meta_post_retrieve: #{e}"
|
223
|
+
end
|
224
|
+
```
|
225
|
+
|
226
|
+
#### Using the time_off_meta_post_retrieve_with_http_info variant
|
227
|
+
|
228
|
+
This returns an Array which contains the response data, status code and headers.
|
229
|
+
|
230
|
+
> <Array(<MetaResponse>, Integer, Hash)> time_off_meta_post_retrieve_with_http_info(x_account_token)
|
231
|
+
|
232
|
+
```ruby
|
233
|
+
begin
|
234
|
+
|
235
|
+
data, status_code, headers = api_instance.time_off_meta_post_retrieve_with_http_info(x_account_token)
|
236
|
+
p status_code # => 2xx
|
237
|
+
p headers # => { ... }
|
238
|
+
p data # => <MetaResponse>
|
239
|
+
rescue MergeHRISClient::ApiError => e
|
240
|
+
puts "Error when calling TimeOffApi->time_off_meta_post_retrieve_with_http_info: #{e}"
|
241
|
+
end
|
242
|
+
```
|
243
|
+
|
244
|
+
### Parameters
|
245
|
+
|
246
|
+
| Name | Type | Description | Notes |
|
247
|
+
| ---- | ---- | ----------- | ----- |
|
248
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
249
|
+
|
250
|
+
### Return type
|
251
|
+
|
252
|
+
[**MetaResponse**](MetaResponse.md)
|
253
|
+
|
254
|
+
### Authorization
|
255
|
+
|
256
|
+
[tokenAuth](../README.md#tokenAuth)
|
257
|
+
|
258
|
+
### HTTP request headers
|
259
|
+
|
260
|
+
- **Content-Type**: Not defined
|
261
|
+
- **Accept**: application/json
|
262
|
+
|
263
|
+
|
192
264
|
## time_off_retrieve
|
193
265
|
|
194
266
|
> <TimeOff> time_off_retrieve(x_account_token, id, opts)
|