merge_hris_client 2.0.3 → 2.0.5
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/BankInfo.md +1 -1
- data/docs/BankInfoApi.md +7 -3
- data/docs/Benefit.md +1 -1
- data/docs/BenefitsApi.md +2 -2
- data/docs/CompaniesApi.md +2 -2
- data/docs/Company.md +1 -1
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/Deduction.md +1 -1
- data/docs/DeductionsApi.md +2 -2
- data/docs/Earning.md +1 -3
- data/docs/Employee.md +4 -0
- data/docs/EmployeePayrollRun.md +1 -1
- data/docs/EmployeePayrollRunsApi.md +2 -2
- data/docs/EmployeeRequest.md +4 -0
- data/docs/EmployeesApi.md +7 -3
- data/docs/Employment.md +1 -1
- data/docs/EmploymentsApi.md +7 -3
- data/docs/EndUserDetailsRequest.md +9 -7
- data/docs/Group.md +1 -1
- data/docs/GroupsApi.md +7 -3
- data/docs/LinkToken.md +3 -1
- data/docs/LinkedAccountsApi.md +2 -0
- data/docs/Location.md +1 -1
- data/docs/LocationsApi.md +7 -3
- data/docs/PayGroup.md +1 -1
- data/docs/PayGroupsApi.md +2 -2
- data/docs/PayrollRun.md +1 -1
- data/docs/PayrollRunsApi.md +7 -3
- data/docs/RemoteResponse.md +5 -1
- data/docs/ResponseTypeEnum.md +15 -0
- data/docs/SyncStatus.md +2 -2
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +1 -3
- data/docs/Team.md +1 -1
- data/docs/TeamsApi.md +2 -2
- data/docs/TimeOffApi.md +7 -3
- data/docs/TimeOffBalance.md +1 -1
- data/docs/TimeOffBalancesApi.md +7 -3
- data/lib/merge_hris_client/api/bank_info_api.rb +16 -2
- data/lib/merge_hris_client/api/benefits_api.rb +2 -2
- data/lib/merge_hris_client/api/companies_api.rb +2 -2
- data/lib/merge_hris_client/api/deductions_api.rb +2 -2
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +2 -2
- data/lib/merge_hris_client/api/employees_api.rb +16 -2
- data/lib/merge_hris_client/api/employments_api.rb +16 -2
- data/lib/merge_hris_client/api/groups_api.rb +16 -2
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -0
- data/lib/merge_hris_client/api/locations_api.rb +16 -2
- data/lib/merge_hris_client/api/pay_groups_api.rb +2 -2
- data/lib/merge_hris_client/api/payroll_runs_api.rb +16 -2
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/api/teams_api.rb +2 -2
- data/lib/merge_hris_client/api/time_off_api.rb +16 -2
- data/lib/merge_hris_client/api/time_off_balances_api.rb +16 -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/bank_info.rb +1 -1
- data/lib/merge_hris_client/models/benefit.rb +1 -1
- 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/company.rb +1 -1
- data/lib/merge_hris_client/models/country_enum.rb +17 -7
- data/lib/merge_hris_client/models/data_passthrough_request.rb +15 -6
- data/lib/merge_hris_client/models/deduction.rb +1 -1
- data/lib/merge_hris_client/models/earning.rb +2 -14
- 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_payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/employee_request.rb +24 -2
- data/lib/merge_hris_client/models/employment.rb +1 -1
- 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 +18 -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.rb +1 -1
- 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.rb +1 -1
- 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_group.rb +1 -1
- data/lib/merge_hris_client/models/pay_period_enum.rb +17 -7
- data/lib/merge_hris_client/models/payroll_run.rb +1 -1
- 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 +23 -9
- 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 +2 -14
- data/lib/merge_hris_client/models/team.rb +1 -1
- data/lib/merge_hris_client/models/time_off_balance.rb +1 -1
- 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/bank_info_api_spec.rb +3 -1
- data/spec/api/benefits_api_spec.rb +1 -1
- data/spec/api/companies_api_spec.rb +1 -1
- data/spec/api/deductions_api_spec.rb +1 -1
- data/spec/api/employee_payroll_runs_api_spec.rb +1 -1
- data/spec/api/employees_api_spec.rb +3 -1
- data/spec/api/employments_api_spec.rb +3 -1
- data/spec/api/groups_api_spec.rb +3 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -0
- data/spec/api/locations_api_spec.rb +3 -1
- data/spec/api/pay_groups_api_spec.rb +1 -1
- data/spec/api/payroll_runs_api_spec.rb +3 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/teams_api_spec.rb +1 -1
- data/spec/api/time_off_api_spec.rb +3 -1
- data/spec/api/time_off_balances_api_spec.rb +3 -1
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/earning_spec.rb +0 -6
- data/spec/models/employee_request_spec.rb +12 -0
- data/spec/models/employee_spec.rb +12 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/link_token_spec.rb +6 -0
- data/spec/models/remote_response_spec.rb +12 -0
- data/spec/models/response_type_enum_spec.rb +28 -0
- data/spec/models/tax_spec.rb +0 -6
- metadata +105 -101
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 82324aa8f5efff6a755415c1e5b117f6601166e920d49c1e37524db2390ec4fc
|
4
|
+
data.tar.gz: 071a0878163cb1a8c37209f2080bd56ef9d6d46c5d4b2feffefdfe2921f26236
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0f3e17935882ddc8988025fc91cc47bb5ffbf88c65a08be9320ddba23b9d90e059ceb32bd3164399bd560e458efa11c87b44de0951dd49a4ca4eb6fe3ebc4e5c
|
7
|
+
data.tar.gz: cf57451bf7c730780954cc0527f70aceb186f15903614c227f9bdc20b6e83f9fca29a5caa8a3c15fd886685785956dc00db331a8047ba67f4cda56053f263e3a
|
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.5
|
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.5.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.5.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.5'
|
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/BankInfo.md
CHANGED
@@ -13,7 +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
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
17
17
|
|
18
18
|
## Example
|
19
19
|
|
data/docs/BankInfoApi.md
CHANGED
@@ -39,12 +39,13 @@ opts = {
|
|
39
39
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
40
40
|
employee_id: 'employee_id_example', # String | If provided, will only return bank accounts for this employee.
|
41
41
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
42
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
42
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
43
43
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
44
44
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
45
45
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
46
46
|
order_by: '-remote_created_at', # String | Overrides the default ordering for this endpoint.
|
47
47
|
page_size: 56, # Integer | Number of results to return per page.
|
48
|
+
remote_fields: 'account_type', # String | Which fields should be returned in non-normalized form.
|
48
49
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
49
50
|
}
|
50
51
|
|
@@ -87,12 +88,13 @@ end
|
|
87
88
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
88
89
|
| **employee_id** | **String** | If provided, will only return bank accounts for this employee. | [optional] |
|
89
90
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
90
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
91
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
91
92
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
92
93
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
93
94
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
94
95
|
| **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
|
95
96
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
97
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
96
98
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
97
99
|
|
98
100
|
### Return type
|
@@ -135,7 +137,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
135
137
|
id = TODO # String |
|
136
138
|
opts = {
|
137
139
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
138
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
140
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
141
|
+
remote_fields: 'account_type' # String | Which fields should be returned in non-normalized form.
|
139
142
|
}
|
140
143
|
|
141
144
|
begin
|
@@ -173,6 +176,7 @@ end
|
|
173
176
|
| **id** | [**String**](.md) | | |
|
174
177
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
175
178
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
179
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
176
180
|
|
177
181
|
### Return type
|
178
182
|
|
data/docs/Benefit.md
CHANGED
@@ -12,7 +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
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
16
|
|
17
17
|
## Example
|
18
18
|
|
data/docs/BenefitsApi.md
CHANGED
@@ -37,7 +37,7 @@ opts = {
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
|
39
39
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
40
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
43
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -82,7 +82,7 @@ end
|
|
82
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
83
|
| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
|
84
84
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
85
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
85
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
86
86
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
87
87
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
88
88
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/CompaniesApi.md
CHANGED
@@ -35,7 +35,7 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -78,7 +78,7 @@ end
|
|
78
78
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
79
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
81
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
82
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
83
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
84
84
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/Company.md
CHANGED
@@ -10,7 +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
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|
@@ -11,6 +11,7 @@
|
|
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
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
|
+
| **normalize_response** | **Boolean** | | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = MergeHRISClient::DataPassthroughRequest.new(
|
|
24
25
|
data: {"company": "Lime", "model": "Gen 2.5"},
|
25
26
|
multipart_form_data: null,
|
26
27
|
headers: {"EXTRA-HEADER":"value"},
|
27
|
-
request_format: JSON
|
28
|
+
request_format: JSON,
|
29
|
+
normalize_response: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/Deduction.md
CHANGED
@@ -10,7 +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
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|
data/docs/DeductionsApi.md
CHANGED
@@ -36,7 +36,7 @@ opts = {
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
employee_payroll_run_id: 'employee_payroll_run_id_example', # String | If provided, will only return deductions for this employee payroll run.
|
39
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -80,7 +80,7 @@ end
|
|
80
80
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
82
|
| **employee_payroll_run_id** | **String** | If provided, will only return deductions for this employee payroll run. | [optional] |
|
83
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
83
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
84
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
85
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
86
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/Earning.md
CHANGED
@@ -8,8 +8,7 @@
|
|
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
|
-
| **
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
|
11
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
13
12
|
|
14
13
|
## Example
|
15
14
|
|
@@ -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/EmployeePayrollRun.md
CHANGED
@@ -17,7 +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
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
@@ -39,7 +39,7 @@ opts = {
|
|
39
39
|
ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs ended after this datetime.
|
40
40
|
ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employee payroll runs ended before this datetime.
|
41
41
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
42
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
42
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
43
43
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
44
44
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
45
45
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -89,7 +89,7 @@ end
|
|
89
89
|
| **ended_after** | **Time** | If provided, will only return employee payroll runs ended after this datetime. | [optional] |
|
90
90
|
| **ended_before** | **Time** | If provided, will only return employee payroll runs ended before this datetime. | [optional] |
|
91
91
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
92
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
92
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
93
93
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
94
94
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
95
95
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
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,
|
data/docs/EmployeesApi.md
CHANGED
@@ -197,7 +197,7 @@ opts = {
|
|
197
197
|
employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status.
|
198
198
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
199
199
|
first_name: 'first_name_example', # String | If provided, will only return employees with this first name.
|
200
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
200
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
201
201
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
202
202
|
include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
203
203
|
last_name: 'last_name_example', # String | If provided, will only return employees with this last name.
|
@@ -207,6 +207,7 @@ opts = {
|
|
207
207
|
page_size: 56, # Integer | Number of results to return per page.
|
208
208
|
pay_group_id: 'pay_group_id_example', # String | If provided, will only return employees for this pay group
|
209
209
|
personal_email: TODO, # String | If provided, will only return Employees with this personal email
|
210
|
+
remote_fields: 'employment_status', # String | Which fields should be returned in non-normalized form.
|
210
211
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
211
212
|
team_id: 'team_id_example', # String | If provided, will only return employees for this team.
|
212
213
|
work_email: TODO, # String | If provided, will only return Employees with this work email
|
@@ -253,7 +254,7 @@ end
|
|
253
254
|
| **employment_status** | **String** | If provided, will only return employees with this employment status. | [optional] |
|
254
255
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
255
256
|
| **first_name** | **String** | If provided, will only return employees with this first name. | [optional] |
|
256
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
257
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
257
258
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
258
259
|
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
259
260
|
| **last_name** | **String** | If provided, will only return employees with this last name. | [optional] |
|
@@ -263,6 +264,7 @@ end
|
|
263
264
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
264
265
|
| **pay_group_id** | **String** | If provided, will only return employees for this pay group | [optional] |
|
265
266
|
| **personal_email** | [**String**](.md) | If provided, will only return Employees with this personal email | [optional] |
|
267
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
266
268
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
267
269
|
| **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
|
268
270
|
| **work_email** | [**String**](.md) | If provided, will only return Employees with this work email | [optional] |
|
@@ -380,7 +382,8 @@ id = TODO # String |
|
|
380
382
|
opts = {
|
381
383
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
382
384
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
383
|
-
include_sensitive_fields: true # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
385
|
+
include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
386
|
+
remote_fields: 'employment_status' # String | Which fields should be returned in non-normalized form.
|
384
387
|
}
|
385
388
|
|
386
389
|
begin
|
@@ -419,6 +422,7 @@ end
|
|
419
422
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
420
423
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
421
424
|
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
425
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
422
426
|
|
423
427
|
### Return type
|
424
428
|
|
data/docs/Employment.md
CHANGED
@@ -17,7 +17,7 @@
|
|
17
17
|
| **effective_date** | **Time** | The position's effective date. | [optional] |
|
18
18
|
| **employment_type** | [**EmploymentTypeEnum**](EmploymentTypeEnum.md) | The position's type of employment. | [optional] |
|
19
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
20
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
data/docs/EmploymentsApi.md
CHANGED
@@ -37,12 +37,13 @@ opts = {
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
employee_id: 'employee_id_example', # String | If provided, will only return employments for this employee.
|
39
39
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
40
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
40
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
42
42
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
43
43
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
44
44
|
order_by: '-effective_date', # String | Overrides the default ordering for this endpoint.
|
45
45
|
page_size: 56, # Integer | Number of results to return per page.
|
46
|
+
remote_fields: 'employment_type', # String | Which fields should be returned in non-normalized form.
|
46
47
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
47
48
|
}
|
48
49
|
|
@@ -83,12 +84,13 @@ end
|
|
83
84
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
84
85
|
| **employee_id** | **String** | If provided, will only return employments for this employee. | [optional] |
|
85
86
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
86
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
87
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
87
88
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
88
89
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
89
90
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
90
91
|
| **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
|
91
92
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
93
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
92
94
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
93
95
|
|
94
96
|
### Return type
|
@@ -131,7 +133,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
131
133
|
id = TODO # String |
|
132
134
|
opts = {
|
133
135
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
134
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
136
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
137
|
+
remote_fields: 'employment_type' # String | Which fields should be returned in non-normalized form.
|
135
138
|
}
|
136
139
|
|
137
140
|
begin
|
@@ -169,6 +172,7 @@ end
|
|
169
172
|
| **id** | [**String**](.md) | | |
|
170
173
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
171
174
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
175
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
172
176
|
|
173
177
|
### Return type
|
174
178
|
|
@@ -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/Group.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **name** | **String** | The group name. | [optional] |
|
11
11
|
| **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The group type | [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
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|
data/docs/GroupsApi.md
CHANGED
@@ -35,11 +35,12 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
42
42
|
page_size: 56, # Integer | Number of results to return per page.
|
43
|
+
remote_fields: 'type', # String | Which fields should be returned in non-normalized form.
|
43
44
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
45
|
}
|
45
46
|
|
@@ -78,11 +79,12 @@ end
|
|
78
79
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
80
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
82
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
83
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
84
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
84
85
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
85
86
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
87
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
86
88
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
87
89
|
|
88
90
|
### Return type
|
@@ -124,7 +126,8 @@ api_instance = MergeHRISClient::GroupsApi.new
|
|
124
126
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
125
127
|
id = TODO # String |
|
126
128
|
opts = {
|
127
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
129
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
130
|
+
remote_fields: 'type' # String | Which fields should be returned in non-normalized form.
|
128
131
|
}
|
129
132
|
|
130
133
|
begin
|
@@ -161,6 +164,7 @@ end
|
|
161
164
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
165
|
| **id** | [**String**](.md) | | |
|
163
166
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
164
168
|
|
165
169
|
### Return type
|
166
170
|
|
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] |
|