merge_hris_client 2.0.3 → 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 +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 -1
- data/docs/EmployeePayrollRun.md +1 -1
- data/docs/EmployeePayrollRunsApi.md +2 -2
- data/docs/EmployeesApi.md +7 -3
- data/docs/Employment.md +1 -1
- data/docs/EmploymentsApi.md +7 -3
- data/docs/Group.md +1 -1
- data/docs/GroupsApi.md +7 -3
- 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 +2 -0
- data/docs/Tax.md +1 -1
- 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/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/models/bank_info.rb +1 -1
- data/lib/merge_hris_client/models/benefit.rb +1 -1
- data/lib/merge_hris_client/models/company.rb +1 -1
- data/lib/merge_hris_client/models/data_passthrough_request.rb +14 -5
- data/lib/merge_hris_client/models/deduction.rb +1 -1
- data/lib/merge_hris_client/models/earning.rb +1 -1
- data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/employment.rb +1 -1
- data/lib/merge_hris_client/models/encoding_enum.rb +1 -0
- data/lib/merge_hris_client/models/group.rb +1 -1
- data/lib/merge_hris_client/models/location.rb +1 -1
- data/lib/merge_hris_client/models/pay_group.rb +1 -1
- data/lib/merge_hris_client/models/payroll_run.rb +1 -1
- data/lib/merge_hris_client/models/remote_response.rb +13 -2
- data/lib/merge_hris_client/models/tax.rb +1 -1
- 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/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 +3 -1
- data/spec/api/employments_api_spec.rb +3 -1
- data/spec/api/groups_api_spec.rb +3 -1
- 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/models/bank_info_spec.rb +0 -6
- data/spec/models/benefit_spec.rb +0 -6
- data/spec/models/company_spec.rb +0 -6
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/deduction_spec.rb +0 -6
- data/spec/models/earning_spec.rb +0 -6
- data/spec/models/employee_payroll_run_spec.rb +0 -6
- data/spec/models/employee_spec.rb +0 -6
- data/spec/models/employment_spec.rb +0 -6
- data/spec/models/group_spec.rb +0 -6
- data/spec/models/location_spec.rb +0 -6
- data/spec/models/pay_group_spec.rb +0 -6
- data/spec/models/payroll_run_spec.rb +0 -6
- data/spec/models/remote_response_spec.rb +6 -0
- data/spec/models/tax_spec.rb +0 -6
- data/spec/models/team_spec.rb +0 -6
- data/spec/models/time_off_balance_spec.rb +0 -6
- data/spec/models/time_off_spec.rb +0 -6
- metadata +102 -102
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,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
@@ -9,7 +9,7 @@
|
|
9
9
|
| **amount** | **Float** | The amount earned. | [optional] |
|
10
10
|
| **type** | [**EarningTypeEnum**](EarningTypeEnum.md) | The type of earning. | [optional] |
|
11
11
|
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
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/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
|
|
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/Location.md
CHANGED
@@ -16,7 +16,7 @@
|
|
16
16
|
| **country** | [**CountryEnum**](CountryEnum.md) | The location's country. | [optional] |
|
17
17
|
| **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location's type. Can be either WORK or HOME | [optional] |
|
18
18
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
19
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
20
|
|
21
21
|
## Example
|
22
22
|
|
data/docs/LocationsApi.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: 'location_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::LocationsApi.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: 'location_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/PayGroup.md
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **pay_group_name** | **String** | The pay group name. | [optional] |
|
10
10
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
11
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
11
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
data/docs/PayGroupsApi.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/PayrollRun.md
CHANGED
@@ -12,7 +12,7 @@
|
|
12
12
|
| **end_date** | **Time** | The day and time the payroll run ended. | [optional] |
|
13
13
|
| **check_date** | **Time** | The day and time the payroll run was checked. | [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/PayrollRunsApi.md
CHANGED
@@ -37,11 +37,12 @@ opts = {
|
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs ended after this datetime.
|
39
39
|
ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs ended before this datetime.
|
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
|
page_size: 56, # Integer | Number of results to return per page.
|
45
|
+
remote_fields: 'run_state', # String | Which fields should be returned in non-normalized form.
|
45
46
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
46
47
|
run_type: 'CORRECTION', # String | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
|
47
48
|
started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs started after this datetime.
|
@@ -85,11 +86,12 @@ end
|
|
85
86
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
86
87
|
| **ended_after** | **Time** | If provided, will only return payroll runs ended after this datetime. | [optional] |
|
87
88
|
| **ended_before** | **Time** | If provided, will only return payroll runs ended before this datetime. | [optional] |
|
88
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
89
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
89
90
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
90
91
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
91
92
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
92
93
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
94
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
93
95
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
94
96
|
| **run_type** | **String** | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') | [optional] |
|
95
97
|
| **started_after** | **Time** | If provided, will only return payroll runs started after this datetime. | [optional] |
|
@@ -134,7 +136,8 @@ api_instance = MergeHRISClient::PayrollRunsApi.new
|
|
134
136
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
135
137
|
id = TODO # String |
|
136
138
|
opts = {
|
137
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
139
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
140
|
+
remote_fields: 'run_state' # String | Which fields should be returned in non-normalized form.
|
138
141
|
}
|
139
142
|
|
140
143
|
begin
|
@@ -171,6 +174,7 @@ end
|
|
171
174
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
172
175
|
| **id** | [**String**](.md) | | |
|
173
176
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
177
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
174
178
|
|
175
179
|
### Return type
|
176
180
|
|
data/docs/RemoteResponse.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **path** | **String** | | |
|
9
9
|
| **status** | **Integer** | | |
|
10
10
|
| **response** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
11
|
+
| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
11
12
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
12
13
|
|
13
14
|
## Example
|
@@ -20,6 +21,7 @@ instance = MergeHRISClient::RemoteResponse.new(
|
|
20
21
|
path: /scooters,
|
21
22
|
status: 200,
|
22
23
|
response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
24
|
+
response_headers: {"X-Page-Token":"value"},
|
23
25
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
24
26
|
)
|
25
27
|
```
|
data/docs/Tax.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **amount** | **Float** | The tax amount. | [optional] |
|
11
11
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
12
12
|
| **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
|
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/Team.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **name** | **String** | The team's name. | [optional] |
|
10
10
|
| **parent_team** | **String** | | [optional] |
|
11
11
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|