merge_hris_client 2.0.4 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/Earning.md +0 -2
- data/docs/Employee.md +4 -0
- data/docs/EmployeeRequest.md +4 -0
- data/docs/EndUserDetailsRequest.md +9 -7
- data/docs/LinkToken.md +3 -1
- data/docs/LinkedAccountsApi.md +2 -0
- data/docs/RemoteResponse.md +3 -1
- data/docs/ResponseTypeEnum.md +15 -0
- data/docs/SyncStatus.md +2 -2
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +0 -2
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/models/account_details.rb +15 -4
- data/lib/merge_hris_client/models/account_details_and_actions.rb +12 -1
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/account_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/categories_enum.rb +17 -7
- data/lib/merge_hris_client/models/category_enum.rb +17 -7
- data/lib/merge_hris_client/models/country_enum.rb +17 -7
- data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -1
- data/lib/merge_hris_client/models/earning.rb +1 -13
- data/lib/merge_hris_client/models/earning_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/employee.rb +24 -2
- data/lib/merge_hris_client/models/employee_request.rb +24 -2
- data/lib/merge_hris_client/models/employment_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/employment_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/encoding_enum.rb +17 -7
- data/lib/merge_hris_client/models/end_user_details_request.rb +28 -11
- data/lib/merge_hris_client/models/ethnicity_enum.rb +17 -7
- data/lib/merge_hris_client/models/flsa_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/gender_enum.rb +17 -7
- data/lib/merge_hris_client/models/group_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/issue.rb +1 -1
- data/lib/merge_hris_client/models/issue_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/link_token.rb +13 -4
- data/lib/merge_hris_client/models/location_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/marital_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/meta_response.rb +1 -1
- data/lib/merge_hris_client/models/method_enum.rb +17 -7
- data/lib/merge_hris_client/models/pay_currency_enum.rb +17 -7
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +17 -7
- data/lib/merge_hris_client/models/pay_period_enum.rb +17 -7
- data/lib/merge_hris_client/models/policy_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/reason_enum.rb +17 -7
- data/lib/merge_hris_client/models/remote_response.rb +14 -11
- data/lib/merge_hris_client/models/request_format_enum.rb +17 -7
- data/lib/merge_hris_client/models/request_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/response_type_enum.rb +45 -0
- data/lib/merge_hris_client/models/run_state_enum.rb +17 -7
- data/lib/merge_hris_client/models/run_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/sync_status.rb +0 -10
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +18 -7
- data/lib/merge_hris_client/models/tax.rb +1 -13
- data/lib/merge_hris_client/models/time_off_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/units_enum.rb +17 -7
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +1 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +6 -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/employee_payroll_run_spec.rb +6 -0
- data/spec/models/employee_request_spec.rb +12 -0
- data/spec/models/employee_spec.rb +18 -0
- data/spec/models/employment_spec.rb +6 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/group_spec.rb +6 -0
- data/spec/models/link_token_spec.rb +6 -0
- data/spec/models/location_spec.rb +6 -0
- data/spec/models/pay_group_spec.rb +6 -0
- data/spec/models/payroll_run_spec.rb +6 -0
- data/spec/models/remote_response_spec.rb +6 -0
- data/spec/models/response_type_enum_spec.rb +28 -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
- metadata +106 -102
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8c9d5def0568843138c03dfa40dd5655225af75383733fcaa2c8b0176d7ab3f7
|
4
|
+
data.tar.gz: f5c7735da13e84b728d7a00ef3dee15a28bcc73f1f5422c2f78c0209096dd635
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9b0bfd9e0793473b53f1c23475b03a73bd23be5afa38432f029fbc8f05a05770e55805c52fac385c46e03501f37a70171022dd993b5065687976865853894ed5
|
7
|
+
data.tar.gz: 9e8d7e0de37fed201ff377b7d5b7bd4604873bf22a11b27b3702898fc13abd9afd358ee94f949c63876c1f71acf4583f5355d2cd07de9e1bac3a9f2917d748f1
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple HR Information Syst
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version:
|
10
|
+
- Package version: 3.0.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_hris_client-
|
27
|
+
gem install ./merge_hris_client-3.0.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_hris_client-
|
30
|
+
(for development, run `gem install --dev ./merge_hris_client-3.0.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_hris_client', '~>
|
36
|
+
gem 'merge_hris_client', '~> 3.0.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -210,12 +210,12 @@ Class | Method | HTTP request | Description
|
|
210
210
|
- [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
|
211
211
|
- [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
|
212
212
|
- [MergeHRISClient::RemoteData](docs/RemoteData.md)
|
213
|
-
- [MergeHRISClient::RemoteDataRequest](docs/RemoteDataRequest.md)
|
214
213
|
- [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
|
215
214
|
- [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
216
215
|
- [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
|
217
216
|
- [MergeHRISClient::RequestFormatEnum](docs/RequestFormatEnum.md)
|
218
217
|
- [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
|
218
|
+
- [MergeHRISClient::ResponseTypeEnum](docs/ResponseTypeEnum.md)
|
219
219
|
- [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
|
220
220
|
- [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
|
221
221
|
- [MergeHRISClient::SyncStatus](docs/SyncStatus.md)
|
data/docs/AccountDetails.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
| **end_user_email_address** | **String** | | [optional][readonly] |
|
14
14
|
| **status** | **String** | | [optional][readonly] |
|
15
15
|
| **webhook_listener_url** | **String** | | [optional][readonly] |
|
16
|
+
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,8 @@ instance = MergeHRISClient::AccountDetails.new(
|
|
28
29
|
end_user_organization_name: Waystar Royco,
|
29
30
|
end_user_email_address: kendall.roy@waystar-royco.com,
|
30
31
|
status: COMPLETE,
|
31
|
-
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4
|
32
|
+
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
33
|
+
is_duplicate: true
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| **end_user_organization_name** | **String** | | |
|
13
13
|
| **end_user_email_address** | **String** | | |
|
14
14
|
| **webhook_listener_url** | **String** | | |
|
15
|
+
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional] |
|
15
16
|
| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) | | [optional] |
|
16
17
|
|
17
18
|
## Example
|
@@ -28,6 +29,7 @@ instance = MergeHRISClient::AccountDetailsAndActions.new(
|
|
28
29
|
end_user_organization_name: Foo Bar, LLC,
|
29
30
|
end_user_email_address: hradmin@foobar.dev,
|
30
31
|
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
32
|
+
is_duplicate: true,
|
31
33
|
integration: null
|
32
34
|
)
|
33
35
|
```
|
data/docs/Earning.md
CHANGED
@@ -8,7 +8,6 @@
|
|
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** | **Array<Hash<String, AnyType>>** | | [optional] |
|
12
11
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
13
12
|
|
14
13
|
## Example
|
@@ -21,7 +20,6 @@ instance = MergeHRISClient::Earning.new(
|
|
21
20
|
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
22
21
|
amount: 1002.34,
|
23
22
|
type: SALARY,
|
24
|
-
remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}],
|
25
23
|
remote_was_deleted: null
|
26
24
|
)
|
27
25
|
```
|
data/docs/Employee.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
12
12
|
| **last_name** | **String** | The employee's last name. | [optional] |
|
13
13
|
| **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
|
14
|
+
| **username** | **String** | The employee's username that appears in the remote UI. | [optional] |
|
14
15
|
| **groups** | **Array<String>** | | [optional] |
|
15
16
|
| **work_email** | **String** | The employee's work email. | [optional] |
|
16
17
|
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
@@ -28,6 +29,7 @@
|
|
28
29
|
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
29
30
|
| **hire_date** | **Time** | The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. | [optional] |
|
30
31
|
| **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
|
32
|
+
| **remote_created_at** | **Time** | When the third party's employee was created. | [optional] |
|
31
33
|
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
32
34
|
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
33
35
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
@@ -48,6 +50,7 @@ instance = MergeHRISClient::Employee.new(
|
|
48
50
|
first_name: Greg,
|
49
51
|
last_name: Hirsch,
|
50
52
|
display_full_name: Cousin Greg Hirsch,
|
53
|
+
username: cousingreg,
|
51
54
|
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
52
55
|
work_email: greg@merge.dev,
|
53
56
|
personal_email: greg@gmail.com,
|
@@ -65,6 +68,7 @@ instance = MergeHRISClient::Employee.new(
|
|
65
68
|
date_of_birth: 1990-11-10T00:00Z,
|
66
69
|
hire_date: 2020-10-10T00:00Z,
|
67
70
|
start_date: 2020-10-11T00:00Z,
|
71
|
+
remote_created_at: 2020-10-11T00:00Z,
|
68
72
|
employment_status: INACTIVE,
|
69
73
|
termination_date: 2021-10-12T00:00Z,
|
70
74
|
avatar: http://alturl.com/h2h8m,
|
data/docs/EmployeeRequest.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **first_name** | **String** | The employee's first name. | [optional] |
|
11
11
|
| **last_name** | **String** | The employee's last name. | [optional] |
|
12
12
|
| **display_full_name** | **String** | The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. | [optional] |
|
13
|
+
| **username** | **String** | The employee's username that appears in the remote UI. | [optional] |
|
13
14
|
| **groups** | **Array<String>** | | [optional] |
|
14
15
|
| **work_email** | **String** | The employee's work email. | [optional] |
|
15
16
|
| **personal_email** | **String** | The employee's personal email. | [optional] |
|
@@ -27,6 +28,7 @@
|
|
27
28
|
| **date_of_birth** | **Time** | The employee's date of birth. | [optional] |
|
28
29
|
| **hire_date** | **Time** | The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. | [optional] |
|
29
30
|
| **start_date** | **Time** | The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date. | [optional] |
|
31
|
+
| **remote_created_at** | **Time** | When the third party's employee was created. | [optional] |
|
30
32
|
| **employment_status** | [**EmploymentStatusEnum**](EmploymentStatusEnum.md) | The employment status of the employee. | [optional] |
|
31
33
|
| **termination_date** | **Time** | The employee's termination date. | [optional] |
|
32
34
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
@@ -44,6 +46,7 @@ instance = MergeHRISClient::EmployeeRequest.new(
|
|
44
46
|
first_name: Greg,
|
45
47
|
last_name: Hirsch,
|
46
48
|
display_full_name: Cousin Greg Hirsch,
|
49
|
+
username: cousingreg,
|
47
50
|
groups: ["21a54124-397f-494d-985e-3c5b330b8a68"],
|
48
51
|
work_email: greg@merge.dev,
|
49
52
|
personal_email: greg@gmail.com,
|
@@ -61,6 +64,7 @@ instance = MergeHRISClient::EmployeeRequest.new(
|
|
61
64
|
date_of_birth: 1990-11-10T00:00Z,
|
62
65
|
hire_date: 2020-10-10T00:00Z,
|
63
66
|
start_date: 2020-10-11T00:00Z,
|
67
|
+
remote_created_at: 2020-10-11T00:00Z,
|
64
68
|
employment_status: INACTIVE,
|
65
69
|
termination_date: 2021-10-12T00:00Z,
|
66
70
|
avatar: http://alturl.com/h2h8m,
|
@@ -4,12 +4,13 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **end_user_email_address** | **String** |
|
8
|
-
| **end_user_organization_name** | **String** |
|
9
|
-
| **end_user_origin_id** | **String** |
|
10
|
-
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |
|
11
|
-
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token
|
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] |
|
7
|
+
| **end_user_email_address** | **String** | Your end user's email address. | |
|
8
|
+
| **end_user_organization_name** | **String** | Your end user's organization. | |
|
9
|
+
| **end_user_origin_id** | **String** | Unique ID for your end user. | |
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
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 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
|
13
|
+
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/. | [optional][default to false] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeHRISClient::EndUserDetailsRequest.new(
|
|
22
23
|
end_user_origin_id: null,
|
23
24
|
categories: null,
|
24
25
|
integration: null,
|
25
|
-
link_expiry_mins: null
|
26
|
+
link_expiry_mins: null,
|
27
|
+
should_create_magic_link_url: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
data/docs/LinkToken.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **link_token** | **String** | | |
|
8
8
|
| **integration_name** | **String** | | |
|
9
|
+
| **magic_link_url** | **String** | | [optional] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'merge_hris_client'
|
|
14
15
|
|
15
16
|
instance = MergeHRISClient::LinkToken.new(
|
16
17
|
link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
|
17
|
-
integration_name: Lever
|
18
|
+
integration_name: Lever,
|
19
|
+
magic_link_url: https://link.merge.dev/asdfjkl12345jsndfgi2i83n
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
data/docs/LinkedAccountsApi.md
CHANGED
@@ -38,6 +38,7 @@ opts = {
|
|
38
38
|
end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
|
39
39
|
id: TODO, # String |
|
40
40
|
ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
|
41
|
+
include_duplicates: true, # Boolean | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
|
41
42
|
integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
|
42
43
|
is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
|
43
44
|
page_size: 56, # Integer | Number of results to return per page.
|
@@ -83,6 +84,7 @@ end
|
|
83
84
|
| **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
|
84
85
|
| **id** | [**String**](.md) | | [optional] |
|
85
86
|
| **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
|
87
|
+
| **include_duplicates** | **Boolean** | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. | [optional] |
|
86
88
|
| **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
|
87
89
|
| **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
|
88
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
data/docs/RemoteResponse.md
CHANGED
@@ -7,8 +7,9 @@
|
|
7
7
|
| **method** | **String** | | |
|
8
8
|
| **path** | **String** | | |
|
9
9
|
| **status** | **Integer** | | |
|
10
|
-
| **response** | [**
|
10
|
+
| **response** | [**AnyType**](.md) | | |
|
11
11
|
| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
12
|
+
| **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
|
12
13
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = MergeHRISClient::RemoteResponse.new(
|
|
22
23
|
status: 200,
|
23
24
|
response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
24
25
|
response_headers: {"X-Page-Token":"value"},
|
26
|
+
response_type: JSON,
|
25
27
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
26
28
|
)
|
27
29
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeHRISClient::ResponseTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_hris_client'
|
12
|
+
|
13
|
+
instance = MergeHRISClient::ResponseTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/SyncStatus.md
CHANGED
@@ -6,8 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **model_name** | **String** | | |
|
8
8
|
| **model_id** | **String** | | |
|
9
|
-
| **last_sync_start** | **Time** | |
|
10
|
-
| **next_sync_start** | **Time** | |
|
9
|
+
| **last_sync_start** | **Time** | | [optional] |
|
10
|
+
| **next_sync_start** | **Time** | | [optional] |
|
11
11
|
| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
|
12
12
|
| **is_initial_sync** | **Boolean** | | |
|
13
13
|
|
data/docs/SyncStatusApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/Tax.md
CHANGED
@@ -9,7 +9,6 @@
|
|
9
9
|
| **name** | **String** | The tax's name. | [optional] |
|
10
10
|
| **amount** | **Float** | The tax amount. | [optional] |
|
11
11
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
12
|
-
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
13
12
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
14
13
|
|
15
14
|
## Example
|
@@ -23,7 +22,6 @@ instance = MergeHRISClient::Tax.new(
|
|
23
22
|
name: California State Income Tax,
|
24
23
|
amount: 100.25,
|
25
24
|
employer_tax: false,
|
26
|
-
remote_data: [{"path":"/tax","data":["Varies by platform"]}],
|
27
25
|
remote_was_deleted: null
|
28
26
|
)
|
29
27
|
```
|
@@ -29,6 +29,7 @@ module MergeHRISClient
|
|
29
29
|
# @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
|
30
30
|
# @option opts [String] :id
|
31
31
|
# @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
|
32
|
+
# @option opts [Boolean] :include_duplicates If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
|
32
33
|
# @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
|
33
34
|
# @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
|
34
35
|
# @option opts [Integer] :page_size Number of results to return per page.
|
@@ -49,6 +50,7 @@ module MergeHRISClient
|
|
49
50
|
# @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
|
50
51
|
# @option opts [String] :id
|
51
52
|
# @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
|
53
|
+
# @option opts [Boolean] :include_duplicates If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
|
52
54
|
# @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
|
53
55
|
# @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
|
54
56
|
# @option opts [Integer] :page_size Number of results to return per page.
|
@@ -75,6 +77,7 @@ module MergeHRISClient
|
|
75
77
|
query_params[:'end_user_origin_ids'] = opts[:'end_user_origin_ids'] if !opts[:'end_user_origin_ids'].nil?
|
76
78
|
query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
|
77
79
|
query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
|
80
|
+
query_params[:'include_duplicates'] = opts[:'include_duplicates'] if !opts[:'include_duplicates'].nil?
|
78
81
|
query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
|
79
82
|
query_params[:'is_test_account'] = opts[:'is_test_account'] if !opts[:'is_test_account'].nil?
|
80
83
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
@@ -19,7 +19,7 @@ module MergeHRISClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
22
|
+
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
23
23
|
# @param x_account_token [String] Token identifying the end user.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @option opts [String] :cursor The pagination cursor value.
|
@@ -30,7 +30,7 @@ module MergeHRISClient
|
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
33
|
+
# Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
34
34
|
# @param x_account_token [String] Token identifying the end user.
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @option opts [String] :cursor The pagination cursor value.
|
@@ -33,6 +33,9 @@ module MergeHRISClient
|
|
33
33
|
|
34
34
|
attr_accessor :webhook_listener_url
|
35
35
|
|
36
|
+
# Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets.
|
37
|
+
attr_accessor :is_duplicate
|
38
|
+
|
36
39
|
# Attribute mapping from ruby-style variable name to JSON key.
|
37
40
|
def self.attribute_map
|
38
41
|
{
|
@@ -44,7 +47,8 @@ module MergeHRISClient
|
|
44
47
|
:'end_user_organization_name' => :'end_user_organization_name',
|
45
48
|
:'end_user_email_address' => :'end_user_email_address',
|
46
49
|
:'status' => :'status',
|
47
|
-
:'webhook_listener_url' => :'webhook_listener_url'
|
50
|
+
:'webhook_listener_url' => :'webhook_listener_url',
|
51
|
+
:'is_duplicate' => :'is_duplicate'
|
48
52
|
}
|
49
53
|
end
|
50
54
|
|
@@ -64,7 +68,8 @@ module MergeHRISClient
|
|
64
68
|
:'end_user_organization_name' => :'String',
|
65
69
|
:'end_user_email_address' => :'String',
|
66
70
|
:'status' => :'String',
|
67
|
-
:'webhook_listener_url' => :'String'
|
71
|
+
:'webhook_listener_url' => :'String',
|
72
|
+
:'is_duplicate' => :'Boolean'
|
68
73
|
}
|
69
74
|
end
|
70
75
|
|
@@ -72,6 +77,7 @@ module MergeHRISClient
|
|
72
77
|
def self.openapi_nullable
|
73
78
|
Set.new([
|
74
79
|
:'category',
|
80
|
+
:'is_duplicate'
|
75
81
|
])
|
76
82
|
end
|
77
83
|
|
@@ -125,6 +131,10 @@ module MergeHRISClient
|
|
125
131
|
if attributes.key?(:'webhook_listener_url')
|
126
132
|
self.webhook_listener_url = attributes[:'webhook_listener_url']
|
127
133
|
end
|
134
|
+
|
135
|
+
if attributes.key?(:'is_duplicate')
|
136
|
+
self.is_duplicate = attributes[:'is_duplicate']
|
137
|
+
end
|
128
138
|
end
|
129
139
|
|
130
140
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -153,7 +163,8 @@ module MergeHRISClient
|
|
153
163
|
end_user_organization_name == o.end_user_organization_name &&
|
154
164
|
end_user_email_address == o.end_user_email_address &&
|
155
165
|
status == o.status &&
|
156
|
-
webhook_listener_url == o.webhook_listener_url
|
166
|
+
webhook_listener_url == o.webhook_listener_url &&
|
167
|
+
is_duplicate == o.is_duplicate
|
157
168
|
end
|
158
169
|
|
159
170
|
# @see the `==` method
|
@@ -165,7 +176,7 @@ module MergeHRISClient
|
|
165
176
|
# Calculates hash code according to all attributes.
|
166
177
|
# @return [Integer] Hash code
|
167
178
|
def hash
|
168
|
-
[id, integration, integration_slug, category, end_user_origin_id, end_user_organization_name, end_user_email_address, status, webhook_listener_url].hash
|
179
|
+
[id, integration, integration_slug, category, end_user_origin_id, end_user_organization_name, end_user_email_address, status, webhook_listener_url, is_duplicate].hash
|
169
180
|
end
|
170
181
|
|
171
182
|
# Builds the object from hash
|
@@ -32,6 +32,9 @@ module MergeHRISClient
|
|
32
32
|
|
33
33
|
attr_accessor :webhook_listener_url
|
34
34
|
|
35
|
+
# Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets.
|
36
|
+
attr_accessor :is_duplicate
|
37
|
+
|
35
38
|
attr_accessor :integration
|
36
39
|
|
37
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -45,6 +48,7 @@ module MergeHRISClient
|
|
45
48
|
:'end_user_organization_name' => :'end_user_organization_name',
|
46
49
|
:'end_user_email_address' => :'end_user_email_address',
|
47
50
|
:'webhook_listener_url' => :'webhook_listener_url',
|
51
|
+
:'is_duplicate' => :'is_duplicate',
|
48
52
|
:'integration' => :'integration'
|
49
53
|
}
|
50
54
|
end
|
@@ -65,6 +69,7 @@ module MergeHRISClient
|
|
65
69
|
:'end_user_organization_name' => :'String',
|
66
70
|
:'end_user_email_address' => :'String',
|
67
71
|
:'webhook_listener_url' => :'String',
|
72
|
+
:'is_duplicate' => :'Boolean',
|
68
73
|
:'integration' => :'AccountDetailsAndActionsIntegration'
|
69
74
|
}
|
70
75
|
end
|
@@ -72,6 +77,7 @@ module MergeHRISClient
|
|
72
77
|
# List of attributes with nullable: true
|
73
78
|
def self.openapi_nullable
|
74
79
|
Set.new([
|
80
|
+
:'is_duplicate',
|
75
81
|
])
|
76
82
|
end
|
77
83
|
|
@@ -122,6 +128,10 @@ module MergeHRISClient
|
|
122
128
|
self.webhook_listener_url = attributes[:'webhook_listener_url']
|
123
129
|
end
|
124
130
|
|
131
|
+
if attributes.key?(:'is_duplicate')
|
132
|
+
self.is_duplicate = attributes[:'is_duplicate']
|
133
|
+
end
|
134
|
+
|
125
135
|
if attributes.key?(:'integration')
|
126
136
|
self.integration = attributes[:'integration']
|
127
137
|
end
|
@@ -178,6 +188,7 @@ module MergeHRISClient
|
|
178
188
|
end_user_organization_name == o.end_user_organization_name &&
|
179
189
|
end_user_email_address == o.end_user_email_address &&
|
180
190
|
webhook_listener_url == o.webhook_listener_url &&
|
191
|
+
is_duplicate == o.is_duplicate &&
|
181
192
|
integration == o.integration
|
182
193
|
end
|
183
194
|
|
@@ -190,7 +201,7 @@ module MergeHRISClient
|
|
190
201
|
# Calculates hash code according to all attributes.
|
191
202
|
# @return [Integer] Hash code
|
192
203
|
def hash
|
193
|
-
[id, category, status, status_detail, end_user_origin_id, end_user_organization_name, end_user_email_address, webhook_listener_url, integration].hash
|
204
|
+
[id, category, status, status_detail, end_user_origin_id, end_user_organization_name, end_user_email_address, webhook_listener_url, is_duplicate, integration].hash
|
194
205
|
end
|
195
206
|
|
196
207
|
# Builds the object from hash
|
@@ -19,18 +19,28 @@ module MergeHRISClient
|
|
19
19
|
INCOMPLETE = "INCOMPLETE".freeze
|
20
20
|
RELINK_NEEDED = "RELINK_NEEDED".freeze
|
21
21
|
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
new.build_from_hash(value)
|
27
|
-
end
|
22
|
+
MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
|
23
|
+
|
24
|
+
attr_accessor :value
|
25
|
+
attr_accessor :raw_value
|
28
26
|
|
29
27
|
# Builds the enum from string
|
30
28
|
# @param [String] The enum value in the form of the string
|
31
29
|
# @return [String] The enum value
|
32
30
|
def build_from_hash(value)
|
33
|
-
value
|
31
|
+
@raw_value = value
|
32
|
+
if ["COMPLETE", "INCOMPLETE", "RELINK_NEEDED", ].include? value
|
33
|
+
@value = value
|
34
|
+
else
|
35
|
+
@value = MERGE_NONSTANDARD_VALUE
|
36
|
+
end
|
37
|
+
|
38
|
+
self
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.build_from_hash(value)
|
42
|
+
AccountDetailsAndActionsStatusEnum.new.build_from_hash(value)
|
34
43
|
end
|
35
44
|
end
|
45
|
+
|
36
46
|
end
|
@@ -18,18 +18,28 @@ module MergeHRISClient
|
|
18
18
|
SAVINGS = "SAVINGS".freeze
|
19
19
|
CHECKING = "CHECKING".freeze
|
20
20
|
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
new.build_from_hash(value)
|
26
|
-
end
|
21
|
+
MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
|
22
|
+
|
23
|
+
attr_accessor :value
|
24
|
+
attr_accessor :raw_value
|
27
25
|
|
28
26
|
# Builds the enum from string
|
29
27
|
# @param [String] The enum value in the form of the string
|
30
28
|
# @return [String] The enum value
|
31
29
|
def build_from_hash(value)
|
32
|
-
value
|
30
|
+
@raw_value = value
|
31
|
+
if ["SAVINGS", "CHECKING", ].include? value
|
32
|
+
@value = value
|
33
|
+
else
|
34
|
+
@value = MERGE_NONSTANDARD_VALUE
|
35
|
+
end
|
36
|
+
|
37
|
+
self
|
38
|
+
end
|
39
|
+
|
40
|
+
def self.build_from_hash(value)
|
41
|
+
AccountTypeEnum.new.build_from_hash(value)
|
33
42
|
end
|
34
43
|
end
|
44
|
+
|
35
45
|
end
|
@@ -21,18 +21,28 @@ module MergeHRISClient
|
|
21
21
|
TICKETING = "ticketing".freeze
|
22
22
|
CRM = "crm".freeze
|
23
23
|
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
new.build_from_hash(value)
|
29
|
-
end
|
24
|
+
MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
|
25
|
+
|
26
|
+
attr_accessor :value
|
27
|
+
attr_accessor :raw_value
|
30
28
|
|
31
29
|
# Builds the enum from string
|
32
30
|
# @param [String] The enum value in the form of the string
|
33
31
|
# @return [String] The enum value
|
34
32
|
def build_from_hash(value)
|
35
|
-
value
|
33
|
+
@raw_value = value
|
34
|
+
if ["hris", "ats", "accounting", "ticketing", "crm", ].include? value
|
35
|
+
@value = value
|
36
|
+
else
|
37
|
+
@value = MERGE_NONSTANDARD_VALUE
|
38
|
+
end
|
39
|
+
|
40
|
+
self
|
41
|
+
end
|
42
|
+
|
43
|
+
def self.build_from_hash(value)
|
44
|
+
CategoriesEnum.new.build_from_hash(value)
|
36
45
|
end
|
37
46
|
end
|
47
|
+
|
38
48
|
end
|
@@ -21,18 +21,28 @@ module MergeHRISClient
|
|
21
21
|
TICKETING = "ticketing".freeze
|
22
22
|
CRM = "crm".freeze
|
23
23
|
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
new.build_from_hash(value)
|
29
|
-
end
|
24
|
+
MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
|
25
|
+
|
26
|
+
attr_accessor :value
|
27
|
+
attr_accessor :raw_value
|
30
28
|
|
31
29
|
# Builds the enum from string
|
32
30
|
# @param [String] The enum value in the form of the string
|
33
31
|
# @return [String] The enum value
|
34
32
|
def build_from_hash(value)
|
35
|
-
value
|
33
|
+
@raw_value = value
|
34
|
+
if ["hris", "ats", "accounting", "ticketing", "crm", ].include? value
|
35
|
+
@value = value
|
36
|
+
else
|
37
|
+
@value = MERGE_NONSTANDARD_VALUE
|
38
|
+
end
|
39
|
+
|
40
|
+
self
|
41
|
+
end
|
42
|
+
|
43
|
+
def self.build_from_hash(value)
|
44
|
+
CategoryEnum.new.build_from_hash(value)
|
36
45
|
end
|
37
46
|
end
|
47
|
+
|
38
48
|
end
|