merge_hris_client 2.0.1 → 2.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/docs/BankInfo.md +3 -1
- data/docs/BankInfoApi.md +7 -3
- data/docs/Benefit.md +3 -1
- data/docs/BenefitsApi.md +2 -2
- data/docs/CompaniesApi.md +2 -2
- data/docs/Company.md +3 -1
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/Deduction.md +3 -1
- data/docs/DeductionsApi.md +2 -2
- data/docs/Earning.md +4 -2
- data/docs/Employee.md +3 -1
- data/docs/EmployeePayrollRun.md +3 -1
- data/docs/EmployeePayrollRunsApi.md +2 -2
- data/docs/EmployeesApi.md +15 -3
- data/docs/Employment.md +4 -2
- data/docs/EmploymentsApi.md +7 -3
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/ForceResyncApi.md +4 -4
- data/docs/Group.md +3 -1
- data/docs/GroupsApi.md +7 -3
- data/docs/LinkedAccountsApi.md +14 -14
- data/docs/Location.md +4 -2
- data/docs/LocationsApi.md +7 -3
- data/docs/PayGroup.md +3 -1
- data/docs/PayGroupsApi.md +2 -2
- data/docs/PayrollRun.md +3 -1
- data/docs/PayrollRunsApi.md +7 -3
- data/docs/RemoteResponse.md +2 -0
- data/docs/Tax.md +4 -2
- data/docs/Team.md +3 -1
- data/docs/TeamsApi.md +2 -2
- data/docs/TimeOff.md +3 -1
- data/docs/TimeOffApi.md +7 -3
- data/docs/TimeOffBalance.md +3 -1
- data/docs/TimeOffBalancesApi.md +7 -3
- data/lib/merge_hris_client/api/bank_info_api.rb +16 -3
- 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 +32 -2
- data/lib/merge_hris_client/api/employments_api.rb +16 -2
- data/lib/merge_hris_client/api/force_resync_api.rb +3 -3
- data/lib/merge_hris_client/api/groups_api.rb +16 -2
- data/lib/merge_hris_client/api/linked_accounts_api.rb +14 -14
- 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/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/api/webhook_receivers_api.rb +154 -0
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/account_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/bank_info.rb +15 -5
- data/lib/merge_hris_client/models/benefit.rb +15 -5
- data/lib/merge_hris_client/models/categories_enum.rb +2 -1
- data/lib/merge_hris_client/models/category_enum.rb +2 -1
- data/lib/merge_hris_client/models/company.rb +15 -5
- data/lib/merge_hris_client/models/country_enum.rb +0 -1
- data/lib/merge_hris_client/models/data_passthrough_request.rb +14 -5
- data/lib/merge_hris_client/models/deduction.rb +15 -5
- data/lib/merge_hris_client/models/earning.rb +18 -6
- data/lib/merge_hris_client/models/earning_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/employee.rb +14 -5
- data/lib/merge_hris_client/models/employee_payroll_run.rb +15 -5
- data/lib/merge_hris_client/models/employment.rb +15 -5
- data/lib/merge_hris_client/models/employment_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/employment_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/encoding_enum.rb +1 -1
- data/lib/merge_hris_client/models/ethnicity_enum.rb +0 -1
- data/lib/merge_hris_client/models/flsa_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/gender_enum.rb +0 -1
- data/lib/merge_hris_client/models/group.rb +15 -5
- data/lib/merge_hris_client/models/group_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/issue_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/location.rb +15 -5
- data/lib/merge_hris_client/models/location_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/marital_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/method_enum.rb +0 -1
- data/lib/merge_hris_client/models/pay_currency_enum.rb +0 -1
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +0 -1
- data/lib/merge_hris_client/models/pay_group.rb +15 -5
- data/lib/merge_hris_client/models/pay_period_enum.rb +0 -1
- data/lib/merge_hris_client/models/payroll_run.rb +15 -5
- data/lib/merge_hris_client/models/policy_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/reason_enum.rb +0 -1
- data/lib/merge_hris_client/models/remote_response.rb +13 -2
- data/lib/merge_hris_client/models/request_format_enum.rb +0 -1
- data/lib/merge_hris_client/models/request_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/run_state_enum.rb +0 -1
- data/lib/merge_hris_client/models/run_type_enum.rb +0 -1
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/tax.rb +18 -6
- data/lib/merge_hris_client/models/team.rb +15 -5
- data/lib/merge_hris_client/models/time_off.rb +14 -5
- data/lib/merge_hris_client/models/time_off_balance.rb +15 -5
- data/lib/merge_hris_client/models/time_off_status_enum.rb +0 -1
- data/lib/merge_hris_client/models/units_enum.rb +0 -1
- data/lib/merge_hris_client/version.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 +7 -1
- data/spec/api/employments_api_spec.rb +3 -1
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +3 -1
- data/spec/api/linked_accounts_api_spec.rb +7 -7
- 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/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/api/webhook_receivers_api_spec.rb +58 -0
- data/spec/models/bank_info_spec.rb +1 -1
- data/spec/models/benefit_spec.rb +1 -1
- data/spec/models/company_spec.rb +1 -1
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/deduction_spec.rb +1 -1
- data/spec/models/earning_spec.rb +1 -1
- data/spec/models/employee_payroll_run_spec.rb +1 -1
- data/spec/models/employee_spec.rb +2 -2
- data/spec/models/employment_spec.rb +1 -1
- data/spec/models/group_spec.rb +1 -1
- data/spec/models/linked_account_status_spec.rb +40 -0
- data/spec/models/location_spec.rb +1 -1
- data/spec/models/meta_response_spec.rb +52 -0
- data/spec/models/pay_group_spec.rb +1 -1
- data/spec/models/payroll_run_spec.rb +1 -1
- data/spec/models/remote_response_spec.rb +6 -0
- data/spec/models/tax_spec.rb +1 -1
- data/spec/models/team_spec.rb +1 -1
- data/spec/models/time_off_balance_spec.rb +1 -1
- data/spec/models/time_off_spec.rb +1 -1
- data/spec/models/webhook_receiver_request_spec.rb +46 -0
- data/spec/models/webhook_receiver_spec.rb +46 -0
- metadata +105 -107
- data/docs/BenefitPlanTypeEnum.md +0 -15
- data/docs/TypeEnum.md +0 -15
- data/lib/merge_hris_client/api/time_off_balance_api.rb +0 -196
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +0 -56
- data/lib/merge_hris_client/models/data_passthrough.rb +0 -262
- data/lib/merge_hris_client/models/end_user_details.rb +0 -289
- data/lib/merge_hris_client/models/remote_key_for_regeneration.rb +0 -224
- data/lib/merge_hris_client/models/state_enum.rb +0 -93
- data/lib/merge_hris_client/models/type_enum.rb +0 -38
- data/spec/models/benefit_plan_type_enum_spec.rb +0 -28
- data/spec/models/type_enum_spec.rb +0 -28
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8dcd3c0cc8d034afc1e0f9df67af02c040ae88f302cedf7e3ccaae7af37f5a83
|
4
|
+
data.tar.gz: a594f7ef5eab71e50f30b50c65571cb3722d06ee8834b371cb69d29623e7f3f0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1a489a006948a1dc664b72cb89c9faf24e212491ae79764c5d8ea80f04e193181326e08c9d62ac0c72e211e7730c2b934de1575225727d0ebb8aa4920438ee7f
|
7
|
+
data.tar.gz: 5c9f230e7d3fc80a82a2fc0f6d04be3c669e974e3ef0dae725cf5dd366b777918798c53edbbf3c9e41bc56961cd140011f6147b5b7da4bb4afc49413bcde04b7
|
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.4
|
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.4.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.4.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.4'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
data/docs/BankInfo.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type | [optional] |
|
14
14
|
| **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [optional] |
|
15
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,8 @@ instance = MergeHRISClient::BankInfo.new(
|
|
28
29
|
bank_name: Chase,
|
29
30
|
account_type: CHECKING,
|
30
31
|
remote_created_at: 2021-12-06T10:11:26Z,
|
31
|
-
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}]
|
32
|
+
remote_data: [{"path":"/bank-info","data":["Varies by platform"]}],
|
33
|
+
remote_was_deleted: null
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
data/docs/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,6 +12,7 @@
|
|
12
12
|
| **employee_contribution** | **Float** | The employee's contribution. | [optional] |
|
13
13
|
| **company_contribution** | **Float** | The company's contribution. | [optional] |
|
14
14
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
15
16
|
|
16
17
|
## Example
|
17
18
|
|
@@ -26,7 +27,8 @@ instance = MergeHRISClient::Benefit.new(
|
|
26
27
|
benefit_plan_type: MEDICAL,
|
27
28
|
employee_contribution: 23.65,
|
28
29
|
company_contribution: 150.0,
|
29
|
-
remote_data: [{"path":"/benefits","data":["Varies by platform"]}]
|
30
|
+
remote_data: [{"path":"/benefits","data":["Varies by platform"]}],
|
31
|
+
remote_was_deleted: null
|
30
32
|
)
|
31
33
|
```
|
32
34
|
|
data/docs/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,6 +10,7 @@
|
|
10
10
|
| **display_name** | **String** | The company's display name. | [optional] |
|
11
11
|
| **eins** | **Array<String>** | The company's Employer Identification Numbers. | [optional] |
|
12
12
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeHRISClient::Company.new(
|
|
22
23
|
legal_name: Waystar Royco, Inc.,
|
23
24
|
display_name: Waystar Royco,
|
24
25
|
eins: ["12-3456789","12-3451111","11-0011000"],
|
25
|
-
remote_data: [{"path":"/companies","data":["Varies by platform"]}]
|
26
|
+
remote_data: [{"path":"/companies","data":["Varies by platform"]}],
|
27
|
+
remote_was_deleted: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
@@ -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,6 +10,7 @@
|
|
10
10
|
| **employee_deduction** | **Float** | The amount the employee is deducting. | [optional] |
|
11
11
|
| **company_deduction** | **Float** | The amount the company is deducting. | [optional] |
|
12
12
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeHRISClient::Deduction.new(
|
|
22
23
|
name: Social Security,
|
23
24
|
employee_deduction: 34.54,
|
24
25
|
company_deduction: 78.78,
|
25
|
-
remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}]
|
26
|
+
remote_data: [{"path":"/payroll-deduction","data":["Varies by platform"]}],
|
27
|
+
remote_was_deleted: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
data/docs/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,7 +8,8 @@
|
|
8
8
|
| **employee_payroll_run** | **String** | | [optional] |
|
9
9
|
| **amount** | **Float** | The amount earned. | [optional] |
|
10
10
|
| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
|
11
|
-
| **remote_data** | **String
|
11
|
+
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = MergeHRISClient::Earning.new(
|
|
20
21
|
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
21
22
|
amount: 1002.34,
|
22
23
|
type: SALARY,
|
23
|
-
remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}]
|
24
|
+
remote_data: [{"path":"/payroll-earnings","data":["Varies by platform"]}],
|
25
|
+
remote_was_deleted: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
data/docs/Employee.md
CHANGED
@@ -33,6 +33,7 @@
|
|
33
33
|
| **avatar** | **String** | The URL of the employee's avatar image. | [optional] |
|
34
34
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
35
35
|
| **custom_fields** | [**Hash<String, AnyType>**](AnyType.md) | Custom fields configured for a given model. | [optional] |
|
36
|
+
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
36
37
|
|
37
38
|
## Example
|
38
39
|
|
@@ -68,7 +69,8 @@ instance = MergeHRISClient::Employee.new(
|
|
68
69
|
termination_date: 2021-10-12T00:00Z,
|
69
70
|
avatar: http://alturl.com/h2h8m,
|
70
71
|
remote_data: [{"path":"/people","data":["Varies by platform"]}],
|
71
|
-
custom_fields: null
|
72
|
+
custom_fields: null,
|
73
|
+
remote_was_deleted: null
|
72
74
|
)
|
73
75
|
```
|
74
76
|
|
data/docs/EmployeePayrollRun.md
CHANGED
@@ -17,6 +17,7 @@
|
|
17
17
|
| **deductions** | [**Array<Deduction>**](Deduction.md) | | [optional][readonly] |
|
18
18
|
| **taxes** | [**Array<Tax>**](Tax.md) | | [optional][readonly] |
|
19
19
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
21
|
|
21
22
|
## Example
|
22
23
|
|
@@ -36,7 +37,8 @@ instance = MergeHRISClient::EmployeePayrollRun.new(
|
|
36
37
|
earnings: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":1002.34,"type":"SALARY"},{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","amount":8342.34,"type":"OVERTIME"}],
|
37
38
|
deductions: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"Social Security","employee_deduction":34.54,"company_deduction":78.78}],
|
38
39
|
taxes: [{"employee_payroll_run":"35347df1-95e7-46e2-93cc-66f1191edca5","name":"California State Income Tax","amount":100.25,"employer_tax":"False"}],
|
39
|
-
remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}]
|
40
|
+
remote_data: [{"path":"/employee-payroll","data":["Varies by platform"]}],
|
41
|
+
remote_was_deleted: null
|
40
42
|
)
|
41
43
|
```
|
42
44
|
|
@@ -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/EmployeesApi.md
CHANGED
@@ -193,16 +193,21 @@ opts = {
|
|
193
193
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
194
194
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
195
195
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
196
|
+
display_full_name: 'display_full_name_example', # String | If provided, will only return employees with this display name.
|
197
|
+
employment_status: 'ACTIVE', # String | If provided, will only return employees with this employment status.
|
196
198
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
197
|
-
|
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 marked as deleted by third party webhooks.
|
198
201
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
199
202
|
include_sensitive_fields: true, # Boolean | Whether to include sensitive fields (such as social security numbers) in the response.
|
203
|
+
last_name: 'last_name_example', # String | If provided, will only return employees with this last name.
|
200
204
|
manager_id: 'manager_id_example', # String | If provided, will only return employees for this manager.
|
201
205
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
202
206
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
203
207
|
page_size: 56, # Integer | Number of results to return per page.
|
204
208
|
pay_group_id: 'pay_group_id_example', # String | If provided, will only return employees for this pay group
|
205
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.
|
206
211
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
207
212
|
team_id: 'team_id_example', # String | If provided, will only return employees for this team.
|
208
213
|
work_email: TODO, # String | If provided, will only return Employees with this work email
|
@@ -245,16 +250,21 @@ end
|
|
245
250
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
246
251
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
247
252
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
253
|
+
| **display_full_name** | **String** | If provided, will only return employees with this display name. | [optional] |
|
254
|
+
| **employment_status** | **String** | If provided, will only return employees with this employment status. | [optional] |
|
248
255
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
249
|
-
| **
|
256
|
+
| **first_name** | **String** | If provided, will only return employees with this first name. | [optional] |
|
257
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
250
258
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
251
259
|
| **include_sensitive_fields** | **Boolean** | Whether to include sensitive fields (such as social security numbers) in the response. | [optional] |
|
260
|
+
| **last_name** | **String** | If provided, will only return employees with this last name. | [optional] |
|
252
261
|
| **manager_id** | **String** | If provided, will only return employees for this manager. | [optional] |
|
253
262
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
254
263
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
255
264
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
256
265
|
| **pay_group_id** | **String** | If provided, will only return employees for this pay group | [optional] |
|
257
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] |
|
258
268
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
259
269
|
| **team_id** | **String** | If provided, will only return employees for this team. | [optional] |
|
260
270
|
| **work_email** | [**String**](.md) | If provided, will only return Employees with this work email | [optional] |
|
@@ -372,7 +382,8 @@ id = TODO # String |
|
|
372
382
|
opts = {
|
373
383
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
374
384
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
375
|
-
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.
|
376
387
|
}
|
377
388
|
|
378
389
|
begin
|
@@ -411,6 +422,7 @@ end
|
|
411
422
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
412
423
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
413
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] |
|
414
426
|
|
415
427
|
### Return type
|
416
428
|
|
data/docs/Employment.md
CHANGED
@@ -17,6 +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 by third party webhooks. | [optional][readonly] |
|
20
21
|
|
21
22
|
## Example
|
22
23
|
|
@@ -28,7 +29,7 @@ instance = MergeHRISClient::Employment.new(
|
|
28
29
|
remote_id: 19202938,
|
29
30
|
employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
30
31
|
job_title: Executive Assistant to Tom Wambsgans,
|
31
|
-
pay_rate:
|
32
|
+
pay_rate: 50000.00,
|
32
33
|
pay_period: YEAR,
|
33
34
|
pay_frequency: BIWEEKLY,
|
34
35
|
pay_currency: USD,
|
@@ -36,7 +37,8 @@ instance = MergeHRISClient::Employment.new(
|
|
36
37
|
flsa_status: EXEMPT,
|
37
38
|
effective_date: 2023-10-06T18:42:34Z,
|
38
39
|
employment_type: FULL TIME,
|
39
|
-
remote_data: [{"path":"/jobs","data":["Varies by platform"]}]
|
40
|
+
remote_data: [{"path":"/jobs","data":["Varies by platform"]}],
|
41
|
+
remote_was_deleted: null
|
40
42
|
)
|
41
43
|
```
|
42
44
|
|
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
|
|
@@ -7,7 +7,7 @@
|
|
7
7
|
| **end_user_email_address** | **String** | | |
|
8
8
|
| **end_user_organization_name** | **String** | | |
|
9
9
|
| **end_user_origin_id** | **String** | | |
|
10
|
-
| **categories** | [**Array<
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | | |
|
11
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
12
|
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
|
13
13
|
|
data/docs/ForceResyncApi.md
CHANGED
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
9
9
|
|
10
10
|
## sync_status_resync_create
|
11
11
|
|
12
|
-
> <SyncStatus
|
12
|
+
> <Array<SyncStatus>> sync_status_resync_create(x_account_token)
|
13
13
|
|
14
14
|
|
15
15
|
|
@@ -44,7 +44,7 @@ end
|
|
44
44
|
|
45
45
|
This returns an Array which contains the response data, status code and headers.
|
46
46
|
|
47
|
-
> <Array(<SyncStatus
|
47
|
+
> <Array(<Array<SyncStatus>>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
|
48
48
|
|
49
49
|
```ruby
|
50
50
|
begin
|
@@ -52,7 +52,7 @@ begin
|
|
52
52
|
data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
|
53
53
|
p status_code # => 2xx
|
54
54
|
p headers # => { ... }
|
55
|
-
p data # => <SyncStatus
|
55
|
+
p data # => <Array<SyncStatus>>
|
56
56
|
rescue MergeHRISClient::ApiError => e
|
57
57
|
puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
|
58
58
|
end
|
@@ -66,7 +66,7 @@ end
|
|
66
66
|
|
67
67
|
### Return type
|
68
68
|
|
69
|
-
[**SyncStatus
|
69
|
+
[**Array<SyncStatus>**](SyncStatus.md)
|
70
70
|
|
71
71
|
### Authorization
|
72
72
|
|
data/docs/Group.md
CHANGED
@@ -10,6 +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 by third party webhooks. | [optional][readonly] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeHRISClient::Group.new(
|
|
22
23
|
parent_group: 2ef51b11-2c4e-4b02-8d1d-50592d9e96ef,
|
23
24
|
name: COST_CENTER_US,
|
24
25
|
type: COST_CENTER,
|
25
|
-
remote_data: [{"path":"/group","data":["Varies by platform"]}]
|
26
|
+
remote_data: [{"path":"/group","data":["Varies by platform"]}],
|
27
|
+
remote_was_deleted: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
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
|
|