merge_hris_client 2.0.3 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AccountDetails.md +3 -1
  4. data/docs/AccountDetailsAndActions.md +2 -0
  5. data/docs/BankInfo.md +1 -1
  6. data/docs/BankInfoApi.md +7 -3
  7. data/docs/Benefit.md +1 -1
  8. data/docs/BenefitsApi.md +2 -2
  9. data/docs/CompaniesApi.md +2 -2
  10. data/docs/Company.md +1 -1
  11. data/docs/DataPassthroughRequest.md +3 -1
  12. data/docs/Deduction.md +1 -1
  13. data/docs/DeductionsApi.md +2 -2
  14. data/docs/Earning.md +1 -3
  15. data/docs/Employee.md +4 -0
  16. data/docs/EmployeePayrollRun.md +1 -1
  17. data/docs/EmployeePayrollRunsApi.md +2 -2
  18. data/docs/EmployeeRequest.md +4 -0
  19. data/docs/EmployeesApi.md +7 -3
  20. data/docs/Employment.md +1 -1
  21. data/docs/EmploymentsApi.md +7 -3
  22. data/docs/EndUserDetailsRequest.md +9 -7
  23. data/docs/Group.md +1 -1
  24. data/docs/GroupsApi.md +7 -3
  25. data/docs/LinkToken.md +3 -1
  26. data/docs/LinkedAccountsApi.md +2 -0
  27. data/docs/Location.md +1 -1
  28. data/docs/LocationsApi.md +7 -3
  29. data/docs/PayGroup.md +1 -1
  30. data/docs/PayGroupsApi.md +2 -2
  31. data/docs/PayrollRun.md +1 -1
  32. data/docs/PayrollRunsApi.md +7 -3
  33. data/docs/RemoteResponse.md +5 -1
  34. data/docs/ResponseTypeEnum.md +15 -0
  35. data/docs/SyncStatus.md +2 -2
  36. data/docs/SyncStatusApi.md +1 -1
  37. data/docs/Tax.md +1 -3
  38. data/docs/Team.md +1 -1
  39. data/docs/TeamsApi.md +2 -2
  40. data/docs/TimeOffApi.md +7 -3
  41. data/docs/TimeOffBalance.md +1 -1
  42. data/docs/TimeOffBalancesApi.md +7 -3
  43. data/lib/merge_hris_client/api/bank_info_api.rb +16 -2
  44. data/lib/merge_hris_client/api/benefits_api.rb +2 -2
  45. data/lib/merge_hris_client/api/companies_api.rb +2 -2
  46. data/lib/merge_hris_client/api/deductions_api.rb +2 -2
  47. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +2 -2
  48. data/lib/merge_hris_client/api/employees_api.rb +16 -2
  49. data/lib/merge_hris_client/api/employments_api.rb +16 -2
  50. data/lib/merge_hris_client/api/groups_api.rb +16 -2
  51. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -0
  52. data/lib/merge_hris_client/api/locations_api.rb +16 -2
  53. data/lib/merge_hris_client/api/pay_groups_api.rb +2 -2
  54. data/lib/merge_hris_client/api/payroll_runs_api.rb +16 -2
  55. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  56. data/lib/merge_hris_client/api/teams_api.rb +2 -2
  57. data/lib/merge_hris_client/api/time_off_api.rb +16 -2
  58. data/lib/merge_hris_client/api/time_off_balances_api.rb +16 -2
  59. data/lib/merge_hris_client/models/account_details.rb +15 -4
  60. data/lib/merge_hris_client/models/account_details_and_actions.rb +12 -1
  61. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +17 -7
  62. data/lib/merge_hris_client/models/account_type_enum.rb +17 -7
  63. data/lib/merge_hris_client/models/bank_info.rb +1 -1
  64. data/lib/merge_hris_client/models/benefit.rb +1 -1
  65. data/lib/merge_hris_client/models/categories_enum.rb +17 -7
  66. data/lib/merge_hris_client/models/category_enum.rb +17 -7
  67. data/lib/merge_hris_client/models/company.rb +1 -1
  68. data/lib/merge_hris_client/models/country_enum.rb +17 -7
  69. data/lib/merge_hris_client/models/data_passthrough_request.rb +15 -6
  70. data/lib/merge_hris_client/models/deduction.rb +1 -1
  71. data/lib/merge_hris_client/models/earning.rb +2 -14
  72. data/lib/merge_hris_client/models/earning_type_enum.rb +17 -7
  73. data/lib/merge_hris_client/models/employee.rb +24 -2
  74. data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -1
  75. data/lib/merge_hris_client/models/employee_request.rb +24 -2
  76. data/lib/merge_hris_client/models/employment.rb +1 -1
  77. data/lib/merge_hris_client/models/employment_status_enum.rb +17 -7
  78. data/lib/merge_hris_client/models/employment_type_enum.rb +17 -7
  79. data/lib/merge_hris_client/models/encoding_enum.rb +18 -7
  80. data/lib/merge_hris_client/models/end_user_details_request.rb +28 -11
  81. data/lib/merge_hris_client/models/ethnicity_enum.rb +17 -7
  82. data/lib/merge_hris_client/models/flsa_status_enum.rb +17 -7
  83. data/lib/merge_hris_client/models/gender_enum.rb +17 -7
  84. data/lib/merge_hris_client/models/group.rb +1 -1
  85. data/lib/merge_hris_client/models/group_type_enum.rb +17 -7
  86. data/lib/merge_hris_client/models/issue.rb +1 -1
  87. data/lib/merge_hris_client/models/issue_status_enum.rb +17 -7
  88. data/lib/merge_hris_client/models/link_token.rb +13 -4
  89. data/lib/merge_hris_client/models/location.rb +1 -1
  90. data/lib/merge_hris_client/models/location_type_enum.rb +17 -7
  91. data/lib/merge_hris_client/models/marital_status_enum.rb +17 -7
  92. data/lib/merge_hris_client/models/meta_response.rb +1 -1
  93. data/lib/merge_hris_client/models/method_enum.rb +17 -7
  94. data/lib/merge_hris_client/models/pay_currency_enum.rb +17 -7
  95. data/lib/merge_hris_client/models/pay_frequency_enum.rb +17 -7
  96. data/lib/merge_hris_client/models/pay_group.rb +1 -1
  97. data/lib/merge_hris_client/models/pay_period_enum.rb +17 -7
  98. data/lib/merge_hris_client/models/payroll_run.rb +1 -1
  99. data/lib/merge_hris_client/models/policy_type_enum.rb +17 -7
  100. data/lib/merge_hris_client/models/reason_enum.rb +17 -7
  101. data/lib/merge_hris_client/models/remote_response.rb +23 -9
  102. data/lib/merge_hris_client/models/request_format_enum.rb +17 -7
  103. data/lib/merge_hris_client/models/request_type_enum.rb +17 -7
  104. data/lib/merge_hris_client/models/response_type_enum.rb +45 -0
  105. data/lib/merge_hris_client/models/run_state_enum.rb +17 -7
  106. data/lib/merge_hris_client/models/run_type_enum.rb +17 -7
  107. data/lib/merge_hris_client/models/sync_status.rb +0 -10
  108. data/lib/merge_hris_client/models/sync_status_status_enum.rb +18 -7
  109. data/lib/merge_hris_client/models/tax.rb +2 -14
  110. data/lib/merge_hris_client/models/team.rb +1 -1
  111. data/lib/merge_hris_client/models/time_off_balance.rb +1 -1
  112. data/lib/merge_hris_client/models/time_off_status_enum.rb +17 -7
  113. data/lib/merge_hris_client/models/units_enum.rb +17 -7
  114. data/lib/merge_hris_client/version.rb +1 -1
  115. data/lib/merge_hris_client.rb +1 -1
  116. data/spec/api/bank_info_api_spec.rb +3 -1
  117. data/spec/api/benefits_api_spec.rb +1 -1
  118. data/spec/api/companies_api_spec.rb +1 -1
  119. data/spec/api/deductions_api_spec.rb +1 -1
  120. data/spec/api/employee_payroll_runs_api_spec.rb +1 -1
  121. data/spec/api/employees_api_spec.rb +3 -1
  122. data/spec/api/employments_api_spec.rb +3 -1
  123. data/spec/api/groups_api_spec.rb +3 -1
  124. data/spec/api/linked_accounts_api_spec.rb +1 -0
  125. data/spec/api/locations_api_spec.rb +3 -1
  126. data/spec/api/pay_groups_api_spec.rb +1 -1
  127. data/spec/api/payroll_runs_api_spec.rb +3 -1
  128. data/spec/api/sync_status_api_spec.rb +1 -1
  129. data/spec/api/teams_api_spec.rb +1 -1
  130. data/spec/api/time_off_api_spec.rb +3 -1
  131. data/spec/api/time_off_balances_api_spec.rb +3 -1
  132. data/spec/models/account_details_and_actions_spec.rb +6 -0
  133. data/spec/models/account_details_spec.rb +6 -0
  134. data/spec/models/data_passthrough_request_spec.rb +6 -0
  135. data/spec/models/earning_spec.rb +0 -6
  136. data/spec/models/employee_request_spec.rb +12 -0
  137. data/spec/models/employee_spec.rb +12 -0
  138. data/spec/models/end_user_details_request_spec.rb +6 -0
  139. data/spec/models/link_token_spec.rb +6 -0
  140. data/spec/models/remote_response_spec.rb +12 -0
  141. data/spec/models/response_type_enum_spec.rb +28 -0
  142. data/spec/models/tax_spec.rb +0 -6
  143. metadata +105 -101
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 on the third-party. | [optional][readonly] |
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 in the third-party service.
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 in the third-party service. | [optional] |
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 on the third-party. | [optional][readonly] |
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 in the third-party service.
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 in the third-party service. | [optional] |
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 on the third-party. | [optional][readonly] |
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
 
@@ -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 in the third-party service.
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 in the third-party service. | [optional] |
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
 
@@ -7,7 +7,9 @@
7
7
  | **method** | **String** | | |
8
8
  | **path** | **String** | | |
9
9
  | **status** | **Integer** | | |
10
- | **response** | [**Hash<String, AnyType>**](AnyType.md) | | |
10
+ | **response** | [**AnyType**](.md) | | |
11
+ | **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
12
+ | **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
11
13
  | **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
12
14
 
13
15
  ## Example
@@ -20,6 +22,8 @@ instance = MergeHRISClient::RemoteResponse.new(
20
22
  path: /scooters,
21
23
  status: 200,
22
24
  response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
25
+ response_headers: {"X-Page-Token":"value"},
26
+ response_type: JSON,
23
27
  headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
24
28
  )
25
29
  ```
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::ResponseTypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_hris_client'
12
+
13
+ instance = MergeHRISClient::ResponseTypeEnum.new()
14
+ ```
15
+
data/docs/SyncStatus.md CHANGED
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **model_name** | **String** | | |
8
8
  | **model_id** | **String** | | |
9
- | **last_sync_start** | **Time** | | |
10
- | **next_sync_start** | **Time** | | |
9
+ | **last_sync_start** | **Time** | | [optional] |
10
+ | **next_sync_start** | **Time** | | [optional] |
11
11
  | **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
12
12
  | **is_initial_sync** | **Boolean** | | |
13
13
 
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
13
13
 
14
14
 
15
15
 
16
- Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
16
+ Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
17
17
 
18
18
  ### Examples
19
19
 
data/docs/Tax.md CHANGED
@@ -9,8 +9,7 @@
9
9
  | **name** | **String** | The tax's name. | [optional] |
10
10
  | **amount** | **Float** | The tax amount. | [optional] |
11
11
  | **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
12
- | **remote_data** | **Array<Hash<String, AnyType>>** | | [optional] |
13
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional] |
12
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
14
13
 
15
14
  ## Example
16
15
 
@@ -23,7 +22,6 @@ instance = MergeHRISClient::Tax.new(
23
22
  name: California State Income Tax,
24
23
  amount: 100.25,
25
24
  employer_tax: false,
26
- remote_data: [{"path":"/tax","data":["Varies by platform"]}],
27
25
  remote_was_deleted: null
28
26
  )
29
27
  ```
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 on the third-party. | [optional][readonly] |
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
 
data/docs/TeamsApi.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
  expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
39
- include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
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.
@@ -81,7 +81,7 @@ end
81
81
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
82
82
  | **cursor** | **String** | The pagination cursor value. | [optional] |
83
83
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
84
- | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
84
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
85
85
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
86
86
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
87
87
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
data/docs/TimeOffApi.md CHANGED
@@ -119,11 +119,12 @@ opts = {
119
119
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
120
120
  employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
121
121
  expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
122
- include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
122
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
123
123
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
124
124
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
125
125
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
126
126
  page_size: 56, # Integer | Number of results to return per page.
127
+ remote_fields: 'request_type', # String | Which fields should be returned in non-normalized form.
127
128
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
128
129
  request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
129
130
  status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
@@ -167,11 +168,12 @@ end
167
168
  | **cursor** | **String** | The pagination cursor value. | [optional] |
168
169
  | **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
169
170
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
170
- | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
171
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
171
172
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
172
173
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
173
174
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
174
175
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
176
+ | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
175
177
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
176
178
  | **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
177
179
  | **status** | **String** | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') | [optional] |
@@ -287,7 +289,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
287
289
  id = TODO # String |
288
290
  opts = {
289
291
  expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
290
- include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
292
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
293
+ remote_fields: 'request_type' # String | Which fields should be returned in non-normalized form.
291
294
  }
292
295
 
293
296
  begin
@@ -325,6 +328,7 @@ end
325
328
  | **id** | [**String**](.md) | | |
326
329
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
327
330
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
331
+ | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
328
332
 
329
333
  ### Return type
330
334
 
@@ -11,7 +11,7 @@
11
11
  | **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
12
12
  | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
13
13
  | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
14
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted on the third-party. | [optional][readonly] |
14
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
15
15
 
16
16
  ## Example
17
17
 
@@ -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 time off balances 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 in the third-party service.
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
45
  policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
46
+ remote_fields: 'policy_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 time off balances 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 in the third-party service. | [optional] |
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
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
91
92
  | **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [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: 'policy_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
 
@@ -29,12 +29,13 @@ module MergeHRISClient
29
29
  # @option opts [String] :cursor The pagination cursor value.
30
30
  # @option opts [String] :employee_id If provided, will only return bank accounts for this employee.
31
31
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
32
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
32
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
33
33
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
34
34
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
35
35
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
36
36
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
37
37
  # @option opts [Integer] :page_size Number of results to return per page.
38
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
38
39
  # @option opts [String] :remote_id The API provider's ID for the given object.
39
40
  # @return [PaginatedBankInfoList]
40
41
  def bank_info_list(x_account_token, opts = {})
@@ -52,12 +53,13 @@ module MergeHRISClient
52
53
  # @option opts [String] :cursor The pagination cursor value.
53
54
  # @option opts [String] :employee_id If provided, will only return bank accounts for this employee.
54
55
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
55
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
56
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
56
57
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
57
58
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
58
59
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
59
60
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
60
61
  # @option opts [Integer] :page_size Number of results to return per page.
62
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
61
63
  # @option opts [String] :remote_id The API provider's ID for the given object.
62
64
  # @return [Array<(PaginatedBankInfoList, Integer, Hash)>] PaginatedBankInfoList data, response status code and response headers
63
65
  def bank_info_list_with_http_info(x_account_token, opts = {})
@@ -80,6 +82,10 @@ module MergeHRISClient
80
82
  if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
81
83
  fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
82
84
  end
85
+ allowable_values = ["account_type"]
86
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
87
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
88
+ end
83
89
  # resource path
84
90
  local_var_path = '/bank-info'
85
91
 
@@ -98,6 +104,7 @@ module MergeHRISClient
98
104
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
99
105
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
100
106
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
107
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
101
108
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
102
109
 
103
110
  # header parameters
@@ -141,6 +148,7 @@ module MergeHRISClient
141
148
  # @param [Hash] opts the optional parameters
142
149
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
143
150
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
151
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
144
152
  # @return [BankInfo]
145
153
  def bank_info_retrieve(x_account_token, id, opts = {})
146
154
  data, _status_code, _headers = bank_info_retrieve_with_http_info(x_account_token, id, opts)
@@ -153,6 +161,7 @@ module MergeHRISClient
153
161
  # @param [Hash] opts the optional parameters
154
162
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
155
163
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
164
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
156
165
  # @return [Array<(BankInfo, Integer, Hash)>] BankInfo data, response status code and response headers
157
166
  def bank_info_retrieve_with_http_info(x_account_token, id, opts = {})
158
167
  if @api_client.config.debugging
@@ -170,6 +179,10 @@ module MergeHRISClient
170
179
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
171
180
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
172
181
  end
182
+ allowable_values = ["account_type"]
183
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
184
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
185
+ end
173
186
  # resource path
174
187
  local_var_path = '/bank-info/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
175
188
 
@@ -177,6 +190,7 @@ module MergeHRISClient
177
190
  query_params = opts[:query_params] || {}
178
191
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
179
192
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
193
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
180
194
 
181
195
  # header parameters
182
196
  header_params = opts[:header_params] || {}
@@ -27,7 +27,7 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [String] :employee_id If provided, will only return time off for this employee.
29
29
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
30
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
30
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
31
31
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
32
32
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
33
33
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -47,7 +47,7 @@ module MergeHRISClient
47
47
  # @option opts [String] :cursor The pagination cursor value.
48
48
  # @option opts [String] :employee_id If provided, will only return time off for this employee.
49
49
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
50
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
50
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
51
51
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
52
52
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
53
53
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -25,7 +25,7 @@ module MergeHRISClient
25
25
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
28
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
30
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
31
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -43,7 +43,7 @@ module MergeHRISClient
43
43
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
44
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
45
  # @option opts [String] :cursor The pagination cursor value.
46
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
46
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
47
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
48
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
49
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -26,7 +26,7 @@ module MergeHRISClient
26
26
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [String] :employee_payroll_run_id If provided, will only return deductions for this employee payroll run.
29
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
29
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
30
30
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
31
31
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
32
32
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -45,7 +45,7 @@ module MergeHRISClient
45
45
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
46
46
  # @option opts [String] :cursor The pagination cursor value.
47
47
  # @option opts [String] :employee_payroll_run_id If provided, will only return deductions for this employee payroll run.
48
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
48
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
49
49
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
50
50
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
51
51
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -29,7 +29,7 @@ module MergeHRISClient
29
29
  # @option opts [Time] :ended_after If provided, will only return employee payroll runs ended after this datetime.
30
30
  # @option opts [Time] :ended_before If provided, will only return employee payroll runs ended before this datetime.
31
31
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
32
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
32
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
33
33
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
34
34
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
35
35
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -54,7 +54,7 @@ module MergeHRISClient
54
54
  # @option opts [Time] :ended_after If provided, will only return employee payroll runs ended after this datetime.
55
55
  # @option opts [Time] :ended_before If provided, will only return employee payroll runs ended before this datetime.
56
56
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
57
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
57
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
58
58
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
59
59
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
60
60
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.