merge_hris_client 2.0.1 → 2.0.4

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 (153) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/docs/BankInfo.md +3 -1
  4. data/docs/BankInfoApi.md +7 -3
  5. data/docs/Benefit.md +3 -1
  6. data/docs/BenefitsApi.md +2 -2
  7. data/docs/CompaniesApi.md +2 -2
  8. data/docs/Company.md +3 -1
  9. data/docs/DataPassthroughRequest.md +3 -1
  10. data/docs/Deduction.md +3 -1
  11. data/docs/DeductionsApi.md +2 -2
  12. data/docs/Earning.md +4 -2
  13. data/docs/Employee.md +3 -1
  14. data/docs/EmployeePayrollRun.md +3 -1
  15. data/docs/EmployeePayrollRunsApi.md +2 -2
  16. data/docs/EmployeesApi.md +15 -3
  17. data/docs/Employment.md +4 -2
  18. data/docs/EmploymentsApi.md +7 -3
  19. data/docs/EndUserDetailsRequest.md +1 -1
  20. data/docs/ForceResyncApi.md +4 -4
  21. data/docs/Group.md +3 -1
  22. data/docs/GroupsApi.md +7 -3
  23. data/docs/LinkedAccountsApi.md +14 -14
  24. data/docs/Location.md +4 -2
  25. data/docs/LocationsApi.md +7 -3
  26. data/docs/PayGroup.md +3 -1
  27. data/docs/PayGroupsApi.md +2 -2
  28. data/docs/PayrollRun.md +3 -1
  29. data/docs/PayrollRunsApi.md +7 -3
  30. data/docs/RemoteResponse.md +2 -0
  31. data/docs/Tax.md +4 -2
  32. data/docs/Team.md +3 -1
  33. data/docs/TeamsApi.md +2 -2
  34. data/docs/TimeOff.md +3 -1
  35. data/docs/TimeOffApi.md +7 -3
  36. data/docs/TimeOffBalance.md +3 -1
  37. data/docs/TimeOffBalancesApi.md +7 -3
  38. data/lib/merge_hris_client/api/bank_info_api.rb +16 -3
  39. data/lib/merge_hris_client/api/benefits_api.rb +2 -2
  40. data/lib/merge_hris_client/api/companies_api.rb +2 -2
  41. data/lib/merge_hris_client/api/deductions_api.rb +2 -2
  42. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +2 -2
  43. data/lib/merge_hris_client/api/employees_api.rb +32 -2
  44. data/lib/merge_hris_client/api/employments_api.rb +16 -2
  45. data/lib/merge_hris_client/api/force_resync_api.rb +3 -3
  46. data/lib/merge_hris_client/api/groups_api.rb +16 -2
  47. data/lib/merge_hris_client/api/linked_accounts_api.rb +14 -14
  48. data/lib/merge_hris_client/api/locations_api.rb +16 -2
  49. data/lib/merge_hris_client/api/pay_groups_api.rb +2 -2
  50. data/lib/merge_hris_client/api/payroll_runs_api.rb +16 -2
  51. data/lib/merge_hris_client/api/teams_api.rb +2 -2
  52. data/lib/merge_hris_client/api/time_off_api.rb +16 -2
  53. data/lib/merge_hris_client/api/time_off_balances_api.rb +16 -2
  54. data/lib/merge_hris_client/api/webhook_receivers_api.rb +154 -0
  55. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +0 -1
  56. data/lib/merge_hris_client/models/account_type_enum.rb +0 -1
  57. data/lib/merge_hris_client/models/bank_info.rb +15 -5
  58. data/lib/merge_hris_client/models/benefit.rb +15 -5
  59. data/lib/merge_hris_client/models/categories_enum.rb +2 -1
  60. data/lib/merge_hris_client/models/category_enum.rb +2 -1
  61. data/lib/merge_hris_client/models/company.rb +15 -5
  62. data/lib/merge_hris_client/models/country_enum.rb +0 -1
  63. data/lib/merge_hris_client/models/data_passthrough_request.rb +14 -5
  64. data/lib/merge_hris_client/models/deduction.rb +15 -5
  65. data/lib/merge_hris_client/models/earning.rb +18 -6
  66. data/lib/merge_hris_client/models/earning_type_enum.rb +0 -1
  67. data/lib/merge_hris_client/models/employee.rb +14 -5
  68. data/lib/merge_hris_client/models/employee_payroll_run.rb +15 -5
  69. data/lib/merge_hris_client/models/employment.rb +15 -5
  70. data/lib/merge_hris_client/models/employment_status_enum.rb +0 -1
  71. data/lib/merge_hris_client/models/employment_type_enum.rb +0 -1
  72. data/lib/merge_hris_client/models/encoding_enum.rb +1 -1
  73. data/lib/merge_hris_client/models/ethnicity_enum.rb +0 -1
  74. data/lib/merge_hris_client/models/flsa_status_enum.rb +0 -1
  75. data/lib/merge_hris_client/models/gender_enum.rb +0 -1
  76. data/lib/merge_hris_client/models/group.rb +15 -5
  77. data/lib/merge_hris_client/models/group_type_enum.rb +0 -1
  78. data/lib/merge_hris_client/models/issue_status_enum.rb +0 -1
  79. data/lib/merge_hris_client/models/location.rb +15 -5
  80. data/lib/merge_hris_client/models/location_type_enum.rb +0 -1
  81. data/lib/merge_hris_client/models/marital_status_enum.rb +0 -1
  82. data/lib/merge_hris_client/models/method_enum.rb +0 -1
  83. data/lib/merge_hris_client/models/pay_currency_enum.rb +0 -1
  84. data/lib/merge_hris_client/models/pay_frequency_enum.rb +0 -1
  85. data/lib/merge_hris_client/models/pay_group.rb +15 -5
  86. data/lib/merge_hris_client/models/pay_period_enum.rb +0 -1
  87. data/lib/merge_hris_client/models/payroll_run.rb +15 -5
  88. data/lib/merge_hris_client/models/policy_type_enum.rb +0 -1
  89. data/lib/merge_hris_client/models/reason_enum.rb +0 -1
  90. data/lib/merge_hris_client/models/remote_response.rb +13 -2
  91. data/lib/merge_hris_client/models/request_format_enum.rb +0 -1
  92. data/lib/merge_hris_client/models/request_type_enum.rb +0 -1
  93. data/lib/merge_hris_client/models/run_state_enum.rb +0 -1
  94. data/lib/merge_hris_client/models/run_type_enum.rb +0 -1
  95. data/lib/merge_hris_client/models/sync_status_status_enum.rb +0 -1
  96. data/lib/merge_hris_client/models/tax.rb +18 -6
  97. data/lib/merge_hris_client/models/team.rb +15 -5
  98. data/lib/merge_hris_client/models/time_off.rb +14 -5
  99. data/lib/merge_hris_client/models/time_off_balance.rb +15 -5
  100. data/lib/merge_hris_client/models/time_off_status_enum.rb +0 -1
  101. data/lib/merge_hris_client/models/units_enum.rb +0 -1
  102. data/lib/merge_hris_client/version.rb +1 -1
  103. data/spec/api/bank_info_api_spec.rb +3 -1
  104. data/spec/api/benefits_api_spec.rb +1 -1
  105. data/spec/api/companies_api_spec.rb +1 -1
  106. data/spec/api/deductions_api_spec.rb +1 -1
  107. data/spec/api/employee_payroll_runs_api_spec.rb +1 -1
  108. data/spec/api/employees_api_spec.rb +7 -1
  109. data/spec/api/employments_api_spec.rb +3 -1
  110. data/spec/api/force_resync_api_spec.rb +1 -1
  111. data/spec/api/groups_api_spec.rb +3 -1
  112. data/spec/api/linked_accounts_api_spec.rb +7 -7
  113. data/spec/api/locations_api_spec.rb +3 -1
  114. data/spec/api/pay_groups_api_spec.rb +1 -1
  115. data/spec/api/payroll_runs_api_spec.rb +3 -1
  116. data/spec/api/teams_api_spec.rb +1 -1
  117. data/spec/api/time_off_api_spec.rb +3 -1
  118. data/spec/api/time_off_balances_api_spec.rb +3 -1
  119. data/spec/api/webhook_receivers_api_spec.rb +58 -0
  120. data/spec/models/bank_info_spec.rb +1 -1
  121. data/spec/models/benefit_spec.rb +1 -1
  122. data/spec/models/company_spec.rb +1 -1
  123. data/spec/models/data_passthrough_request_spec.rb +6 -0
  124. data/spec/models/deduction_spec.rb +1 -1
  125. data/spec/models/earning_spec.rb +1 -1
  126. data/spec/models/employee_payroll_run_spec.rb +1 -1
  127. data/spec/models/employee_spec.rb +2 -2
  128. data/spec/models/employment_spec.rb +1 -1
  129. data/spec/models/group_spec.rb +1 -1
  130. data/spec/models/linked_account_status_spec.rb +40 -0
  131. data/spec/models/location_spec.rb +1 -1
  132. data/spec/models/meta_response_spec.rb +52 -0
  133. data/spec/models/pay_group_spec.rb +1 -1
  134. data/spec/models/payroll_run_spec.rb +1 -1
  135. data/spec/models/remote_response_spec.rb +6 -0
  136. data/spec/models/tax_spec.rb +1 -1
  137. data/spec/models/team_spec.rb +1 -1
  138. data/spec/models/time_off_balance_spec.rb +1 -1
  139. data/spec/models/time_off_spec.rb +1 -1
  140. data/spec/models/webhook_receiver_request_spec.rb +46 -0
  141. data/spec/models/webhook_receiver_spec.rb +46 -0
  142. metadata +105 -107
  143. data/docs/BenefitPlanTypeEnum.md +0 -15
  144. data/docs/TypeEnum.md +0 -15
  145. data/lib/merge_hris_client/api/time_off_balance_api.rb +0 -196
  146. data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +0 -56
  147. data/lib/merge_hris_client/models/data_passthrough.rb +0 -262
  148. data/lib/merge_hris_client/models/end_user_details.rb +0 -289
  149. data/lib/merge_hris_client/models/remote_key_for_regeneration.rb +0 -224
  150. data/lib/merge_hris_client/models/state_enum.rb +0 -93
  151. data/lib/merge_hris_client/models/type_enum.rb +0 -38
  152. data/spec/models/benefit_plan_type_enum_spec.rb +0 -28
  153. data/spec/models/type_enum_spec.rb +0 -28
@@ -178,16 +178,21 @@ module MergeHRISClient
178
178
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
179
179
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
180
180
  # @option opts [String] :cursor The pagination cursor value.
181
+ # @option opts [String] :display_full_name If provided, will only return employees with this display name.
182
+ # @option opts [String] :employment_status If provided, will only return employees with this employment status.
181
183
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
182
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
184
+ # @option opts [String] :first_name If provided, will only return employees with this first name.
185
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
183
186
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
184
187
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
188
+ # @option opts [String] :last_name If provided, will only return employees with this last name.
185
189
  # @option opts [String] :manager_id If provided, will only return employees for this manager.
186
190
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
187
191
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
188
192
  # @option opts [Integer] :page_size Number of results to return per page.
189
193
  # @option opts [String] :pay_group_id If provided, will only return employees for this pay group
190
194
  # @option opts [String] :personal_email If provided, will only return Employees with this personal email
195
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
191
196
  # @option opts [String] :remote_id The API provider's ID for the given object.
192
197
  # @option opts [String] :team_id If provided, will only return employees for this team.
193
198
  # @option opts [String] :work_email If provided, will only return Employees with this work email
@@ -205,16 +210,21 @@ module MergeHRISClient
205
210
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
206
211
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
207
212
  # @option opts [String] :cursor The pagination cursor value.
213
+ # @option opts [String] :display_full_name If provided, will only return employees with this display name.
214
+ # @option opts [String] :employment_status If provided, will only return employees with this employment status.
208
215
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
209
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
216
+ # @option opts [String] :first_name If provided, will only return employees with this first name.
217
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
210
218
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
211
219
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
220
+ # @option opts [String] :last_name If provided, will only return employees with this last name.
212
221
  # @option opts [String] :manager_id If provided, will only return employees for this manager.
213
222
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
214
223
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
215
224
  # @option opts [Integer] :page_size Number of results to return per page.
216
225
  # @option opts [String] :pay_group_id If provided, will only return employees for this pay group
217
226
  # @option opts [String] :personal_email If provided, will only return Employees with this personal email
227
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
218
228
  # @option opts [String] :remote_id The API provider's ID for the given object.
219
229
  # @option opts [String] :team_id If provided, will only return employees for this team.
220
230
  # @option opts [String] :work_email If provided, will only return Employees with this work email
@@ -228,10 +238,18 @@ module MergeHRISClient
228
238
  if @api_client.config.client_side_validation && x_account_token.nil?
229
239
  fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployeesApi.employees_list"
230
240
  end
241
+ allowable_values = ["ACTIVE", "INACTIVE", "PENDING"]
242
+ if @api_client.config.client_side_validation && opts[:'employment_status'] && !allowable_values.include?(opts[:'employment_status'])
243
+ fail ArgumentError, "invalid value for \"employment_status\", must be one of #{allowable_values}"
244
+ end
231
245
  allowable_values = ["company", "company,pay_group", "employments", "employments,company", "employments,company,pay_group", "employments,groups", "employments,groups,company", "employments,groups,company,pay_group", "employments,groups,home_location", "employments,groups,home_location,company", "employments,groups,home_location,company,pay_group", "employments,groups,home_location,manager", "employments,groups,home_location,manager,company", "employments,groups,home_location,manager,company,pay_group", "employments,groups,home_location,manager,pay_group", "employments,groups,home_location,manager,team", "employments,groups,home_location,manager,team,company", "employments,groups,home_location,manager,team,company,pay_group", "employments,groups,home_location,manager,team,pay_group", "employments,groups,home_location,pay_group", "employments,groups,home_location,team", "employments,groups,home_location,team,company", "employments,groups,home_location,team,company,pay_group", "employments,groups,home_location,team,pay_group", "employments,groups,home_location,work_location", "employments,groups,home_location,work_location,company", "employments,groups,home_location,work_location,company,pay_group", "employments,groups,home_location,work_location,manager", "employments,groups,home_location,work_location,manager,company", "employments,groups,home_location,work_location,manager,company,pay_group", "employments,groups,home_location,work_location,manager,pay_group", "employments,groups,home_location,work_location,manager,team", "employments,groups,home_location,work_location,manager,team,company", "employments,groups,home_location,work_location,manager,team,company,pay_group", "employments,groups,home_location,work_location,manager,team,pay_group", "employments,groups,home_location,work_location,pay_group", "employments,groups,home_location,work_location,team", "employments,groups,home_location,work_location,team,company", "employments,groups,home_location,work_location,team,company,pay_group", "employments,groups,home_location,work_location,team,pay_group", "employments,groups,manager", "employments,groups,manager,company", "employments,groups,manager,company,pay_group", "employments,groups,manager,pay_group", "employments,groups,manager,team", "employments,groups,manager,team,company", "employments,groups,manager,team,company,pay_group", "employments,groups,manager,team,pay_group", "employments,groups,pay_group", "employments,groups,team", "employments,groups,team,company", "employments,groups,team,company,pay_group", "employments,groups,team,pay_group", "employments,groups,work_location", "employments,groups,work_location,company", "employments,groups,work_location,company,pay_group", "employments,groups,work_location,manager", "employments,groups,work_location,manager,company", "employments,groups,work_location,manager,company,pay_group", "employments,groups,work_location,manager,pay_group", "employments,groups,work_location,manager,team", "employments,groups,work_location,manager,team,company", "employments,groups,work_location,manager,team,company,pay_group", "employments,groups,work_location,manager,team,pay_group", "employments,groups,work_location,pay_group", "employments,groups,work_location,team", "employments,groups,work_location,team,company", "employments,groups,work_location,team,company,pay_group", "employments,groups,work_location,team,pay_group", "employments,home_location", "employments,home_location,company", "employments,home_location,company,pay_group", "employments,home_location,manager", "employments,home_location,manager,company", "employments,home_location,manager,company,pay_group", "employments,home_location,manager,pay_group", "employments,home_location,manager,team", "employments,home_location,manager,team,company", "employments,home_location,manager,team,company,pay_group", "employments,home_location,manager,team,pay_group", "employments,home_location,pay_group", "employments,home_location,team", "employments,home_location,team,company", "employments,home_location,team,company,pay_group", "employments,home_location,team,pay_group", "employments,home_location,work_location", "employments,home_location,work_location,company", "employments,home_location,work_location,company,pay_group", "employments,home_location,work_location,manager", "employments,home_location,work_location,manager,company", "employments,home_location,work_location,manager,company,pay_group", "employments,home_location,work_location,manager,pay_group", "employments,home_location,work_location,manager,team", "employments,home_location,work_location,manager,team,company", "employments,home_location,work_location,manager,team,company,pay_group", "employments,home_location,work_location,manager,team,pay_group", "employments,home_location,work_location,pay_group", "employments,home_location,work_location,team", "employments,home_location,work_location,team,company", "employments,home_location,work_location,team,company,pay_group", "employments,home_location,work_location,team,pay_group", "employments,manager", "employments,manager,company", "employments,manager,company,pay_group", "employments,manager,pay_group", "employments,manager,team", "employments,manager,team,company", "employments,manager,team,company,pay_group", "employments,manager,team,pay_group", "employments,pay_group", "employments,team", "employments,team,company", "employments,team,company,pay_group", "employments,team,pay_group", "employments,work_location", "employments,work_location,company", "employments,work_location,company,pay_group", "employments,work_location,manager", "employments,work_location,manager,company", "employments,work_location,manager,company,pay_group", "employments,work_location,manager,pay_group", "employments,work_location,manager,team", "employments,work_location,manager,team,company", "employments,work_location,manager,team,company,pay_group", "employments,work_location,manager,team,pay_group", "employments,work_location,pay_group", "employments,work_location,team", "employments,work_location,team,company", "employments,work_location,team,company,pay_group", "employments,work_location,team,pay_group", "groups", "groups,company", "groups,company,pay_group", "groups,home_location", "groups,home_location,company", "groups,home_location,company,pay_group", "groups,home_location,manager", "groups,home_location,manager,company", "groups,home_location,manager,company,pay_group", "groups,home_location,manager,pay_group", "groups,home_location,manager,team", "groups,home_location,manager,team,company", "groups,home_location,manager,team,company,pay_group", "groups,home_location,manager,team,pay_group", "groups,home_location,pay_group", "groups,home_location,team", "groups,home_location,team,company", "groups,home_location,team,company,pay_group", "groups,home_location,team,pay_group", "groups,home_location,work_location", "groups,home_location,work_location,company", "groups,home_location,work_location,company,pay_group", "groups,home_location,work_location,manager", "groups,home_location,work_location,manager,company", "groups,home_location,work_location,manager,company,pay_group", "groups,home_location,work_location,manager,pay_group", "groups,home_location,work_location,manager,team", "groups,home_location,work_location,manager,team,company", "groups,home_location,work_location,manager,team,company,pay_group", "groups,home_location,work_location,manager,team,pay_group", "groups,home_location,work_location,pay_group", "groups,home_location,work_location,team", "groups,home_location,work_location,team,company", "groups,home_location,work_location,team,company,pay_group", "groups,home_location,work_location,team,pay_group", "groups,manager", "groups,manager,company", "groups,manager,company,pay_group", "groups,manager,pay_group", "groups,manager,team", "groups,manager,team,company", "groups,manager,team,company,pay_group", "groups,manager,team,pay_group", "groups,pay_group", "groups,team", "groups,team,company", "groups,team,company,pay_group", "groups,team,pay_group", "groups,work_location", "groups,work_location,company", "groups,work_location,company,pay_group", "groups,work_location,manager", "groups,work_location,manager,company", "groups,work_location,manager,company,pay_group", "groups,work_location,manager,pay_group", "groups,work_location,manager,team", "groups,work_location,manager,team,company", "groups,work_location,manager,team,company,pay_group", "groups,work_location,manager,team,pay_group", "groups,work_location,pay_group", "groups,work_location,team", "groups,work_location,team,company", "groups,work_location,team,company,pay_group", "groups,work_location,team,pay_group", "home_location", "home_location,company", "home_location,company,pay_group", "home_location,manager", "home_location,manager,company", "home_location,manager,company,pay_group", "home_location,manager,pay_group", "home_location,manager,team", "home_location,manager,team,company", "home_location,manager,team,company,pay_group", "home_location,manager,team,pay_group", "home_location,pay_group", "home_location,team", "home_location,team,company", "home_location,team,company,pay_group", "home_location,team,pay_group", "home_location,work_location", "home_location,work_location,company", "home_location,work_location,company,pay_group", "home_location,work_location,manager", "home_location,work_location,manager,company", "home_location,work_location,manager,company,pay_group", "home_location,work_location,manager,pay_group", "home_location,work_location,manager,team", "home_location,work_location,manager,team,company", "home_location,work_location,manager,team,company,pay_group", "home_location,work_location,manager,team,pay_group", "home_location,work_location,pay_group", "home_location,work_location,team", "home_location,work_location,team,company", "home_location,work_location,team,company,pay_group", "home_location,work_location,team,pay_group", "manager", "manager,company", "manager,company,pay_group", "manager,pay_group", "manager,team", "manager,team,company", "manager,team,company,pay_group", "manager,team,pay_group", "pay_group", "team", "team,company", "team,company,pay_group", "team,pay_group", "work_location", "work_location,company", "work_location,company,pay_group", "work_location,manager", "work_location,manager,company", "work_location,manager,company,pay_group", "work_location,manager,pay_group", "work_location,manager,team", "work_location,manager,team,company", "work_location,manager,team,company,pay_group", "work_location,manager,team,pay_group", "work_location,pay_group", "work_location,team", "work_location,team,company", "work_location,team,company,pay_group", "work_location,team,pay_group"]
232
246
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
233
247
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
234
248
  end
249
+ allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
250
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
251
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
252
+ end
235
253
  # resource path
236
254
  local_var_path = '/employees'
237
255
 
@@ -241,16 +259,21 @@ module MergeHRISClient
241
259
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
242
260
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
243
261
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
262
+ query_params[:'display_full_name'] = opts[:'display_full_name'] if !opts[:'display_full_name'].nil?
263
+ query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
244
264
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
265
+ query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
245
266
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
246
267
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
247
268
  query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
269
+ query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
248
270
  query_params[:'manager_id'] = opts[:'manager_id'] if !opts[:'manager_id'].nil?
249
271
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
250
272
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
251
273
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
252
274
  query_params[:'pay_group_id'] = opts[:'pay_group_id'] if !opts[:'pay_group_id'].nil?
253
275
  query_params[:'personal_email'] = opts[:'personal_email'] if !opts[:'personal_email'].nil?
276
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
254
277
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
255
278
  query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
256
279
  query_params[:'work_email'] = opts[:'work_email'] if !opts[:'work_email'].nil?
@@ -360,6 +383,7 @@ module MergeHRISClient
360
383
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
361
384
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
362
385
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
386
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
363
387
  # @return [Employee]
364
388
  def employees_retrieve(x_account_token, id, opts = {})
365
389
  data, _status_code, _headers = employees_retrieve_with_http_info(x_account_token, id, opts)
@@ -373,6 +397,7 @@ module MergeHRISClient
373
397
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
374
398
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
375
399
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
400
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
376
401
  # @return [Array<(Employee, Integer, Hash)>] Employee data, response status code and response headers
377
402
  def employees_retrieve_with_http_info(x_account_token, id, opts = {})
378
403
  if @api_client.config.debugging
@@ -390,6 +415,10 @@ module MergeHRISClient
390
415
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
391
416
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
392
417
  end
418
+ allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
419
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
420
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
421
+ end
393
422
  # resource path
394
423
  local_var_path = '/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
395
424
 
@@ -398,6 +427,7 @@ module MergeHRISClient
398
427
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
399
428
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
400
429
  query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
430
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
401
431
 
402
432
  # header parameters
403
433
  header_params = opts[:header_params] || {}
@@ -27,12 +27,13 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [String] :employee_id If provided, will only return employments 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.
34
34
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
35
35
  # @option opts [Integer] :page_size Number of results to return per page.
36
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
36
37
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
37
38
  # @return [PaginatedEmploymentList]
38
39
  def employments_list(x_account_token, opts = {})
@@ -48,12 +49,13 @@ module MergeHRISClient
48
49
  # @option opts [String] :cursor The pagination cursor value.
49
50
  # @option opts [String] :employee_id If provided, will only return employments for this employee.
50
51
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
51
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
52
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
52
53
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
53
54
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
54
55
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
55
56
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
56
57
  # @option opts [Integer] :page_size Number of results to return per page.
58
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
57
59
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
58
60
  # @return [Array<(PaginatedEmploymentList, Integer, Hash)>] PaginatedEmploymentList data, response status code and response headers
59
61
  def employments_list_with_http_info(x_account_token, opts = {})
@@ -72,6 +74,10 @@ module MergeHRISClient
72
74
  if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
73
75
  fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
74
76
  end
77
+ allowable_values = ["employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period"]
78
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
79
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
80
+ end
75
81
  # resource path
76
82
  local_var_path = '/employments'
77
83
 
@@ -88,6 +94,7 @@ module MergeHRISClient
88
94
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
89
95
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
90
96
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
97
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
91
98
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
92
99
 
93
100
  # header parameters
@@ -131,6 +138,7 @@ module MergeHRISClient
131
138
  # @param [Hash] opts the optional parameters
132
139
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
133
140
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
141
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
134
142
  # @return [Employment]
135
143
  def employments_retrieve(x_account_token, id, opts = {})
136
144
  data, _status_code, _headers = employments_retrieve_with_http_info(x_account_token, id, opts)
@@ -143,6 +151,7 @@ module MergeHRISClient
143
151
  # @param [Hash] opts the optional parameters
144
152
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
145
153
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
154
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
146
155
  # @return [Array<(Employment, Integer, Hash)>] Employment data, response status code and response headers
147
156
  def employments_retrieve_with_http_info(x_account_token, id, opts = {})
148
157
  if @api_client.config.debugging
@@ -160,6 +169,10 @@ module MergeHRISClient
160
169
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
161
170
  fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
162
171
  end
172
+ allowable_values = ["employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period"]
173
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
174
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
175
+ end
163
176
  # resource path
164
177
  local_var_path = '/employments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
165
178
 
@@ -167,6 +180,7 @@ module MergeHRISClient
167
180
  query_params = opts[:query_params] || {}
168
181
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
169
182
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
183
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
170
184
 
171
185
  # header parameters
172
186
  header_params = opts[:header_params] || {}
@@ -22,7 +22,7 @@ module MergeHRISClient
22
22
  # Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
23
23
  # @param x_account_token [String] Token identifying the end user.
24
24
  # @param [Hash] opts the optional parameters
25
- # @return [SyncStatus]
25
+ # @return [Array<SyncStatus>]
26
26
  def sync_status_resync_create(x_account_token, opts = {})
27
27
  data, _status_code, _headers = sync_status_resync_create_with_http_info(x_account_token, opts)
28
28
  data
@@ -31,7 +31,7 @@ module MergeHRISClient
31
31
  # Force re-sync of all models. This is only available for organizations on Merge&#39;s Grow and Expand plans.
32
32
  # @param x_account_token [String] Token identifying the end user.
33
33
  # @param [Hash] opts the optional parameters
34
- # @return [Array<(SyncStatus, Integer, Hash)>] SyncStatus data, response status code and response headers
34
+ # @return [Array<(Array<SyncStatus>, Integer, Hash)>] Array<SyncStatus> data, response status code and response headers
35
35
  def sync_status_resync_create_with_http_info(x_account_token, opts = {})
36
36
  if @api_client.config.debugging
37
37
  @api_client.config.logger.debug 'Calling API: ForceResyncApi.sync_status_resync_create ...'
@@ -59,7 +59,7 @@ module MergeHRISClient
59
59
  post_body = opts[:debug_body]
60
60
 
61
61
  # return_type
62
- return_type = opts[:debug_return_type] || 'SyncStatus'
62
+ return_type = opts[:debug_return_type] || 'Array<SyncStatus>'
63
63
 
64
64
  # auth_names
65
65
  auth_names = opts[:debug_auth_names] || ['tokenAuth']
@@ -25,11 +25,12 @@ 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.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
33
34
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
34
35
  # @return [PaginatedGroupList]
35
36
  def groups_list(x_account_token, opts = {})
@@ -43,11 +44,12 @@ module MergeHRISClient
43
44
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
45
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
46
  # @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.
47
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
48
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
49
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
50
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
50
51
  # @option opts [Integer] :page_size Number of results to return per page.
52
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
51
53
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
52
54
  # @return [Array<(PaginatedGroupList, Integer, Hash)>] PaginatedGroupList data, response status code and response headers
53
55
  def groups_list_with_http_info(x_account_token, opts = {})
@@ -58,6 +60,10 @@ module MergeHRISClient
58
60
  if @api_client.config.client_side_validation && x_account_token.nil?
59
61
  fail ArgumentError, "Missing the required parameter 'x_account_token' when calling GroupsApi.groups_list"
60
62
  end
63
+ allowable_values = ["type"]
64
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
65
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
66
+ end
61
67
  # resource path
62
68
  local_var_path = '/groups'
63
69
 
@@ -71,6 +77,7 @@ module MergeHRISClient
71
77
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
72
78
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
73
79
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
80
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
74
81
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
75
82
 
76
83
  # header parameters
@@ -113,6 +120,7 @@ module MergeHRISClient
113
120
  # @param id [String]
114
121
  # @param [Hash] opts the optional parameters
115
122
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
123
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
116
124
  # @return [Group]
117
125
  def groups_retrieve(x_account_token, id, opts = {})
118
126
  data, _status_code, _headers = groups_retrieve_with_http_info(x_account_token, id, opts)
@@ -124,6 +132,7 @@ module MergeHRISClient
124
132
  # @param id [String]
125
133
  # @param [Hash] opts the optional parameters
126
134
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
135
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
127
136
  # @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
128
137
  def groups_retrieve_with_http_info(x_account_token, id, opts = {})
129
138
  if @api_client.config.debugging
@@ -137,12 +146,17 @@ module MergeHRISClient
137
146
  if @api_client.config.client_side_validation && id.nil?
138
147
  fail ArgumentError, "Missing the required parameter 'id' when calling GroupsApi.groups_retrieve"
139
148
  end
149
+ allowable_values = ["type"]
150
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
151
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
152
+ end
140
153
  # resource path
141
154
  local_var_path = '/groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
142
155
 
143
156
  # query parameters
144
157
  query_params = opts[:query_params] || {}
145
158
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
159
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
146
160
 
147
161
  # header parameters
148
162
  header_params = opts[:header_params] || {}
@@ -23,14 +23,14 @@ module MergeHRISClient
23
23
  # @param [Hash] opts the optional parameters
24
24
  # @option opts [String] :category
25
25
  # @option opts [String] :cursor The pagination cursor value.
26
- # @option opts [String] :end_user_email_address
27
- # @option opts [String] :end_user_organization_name
28
- # @option opts [String] :end_user_origin_id
29
- # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once
26
+ # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
27
+ # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
28
+ # @option opts [String] :end_user_origin_id If provided, will only return linked accounts associated with the given origin ID.
29
+ # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
30
30
  # @option opts [String] :id
31
- # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once
32
- # @option opts [String] :integration_name
33
- # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts
31
+ # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
32
+ # @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
33
+ # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
35
  # @option opts [String] :status Filter by status. Options: &#x60;COMPLETE&#x60;, &#x60;INCOMPLETE&#x60;, &#x60;RELINK_NEEDED&#x60;
36
36
  # @return [PaginatedAccountDetailsAndActionsList]
@@ -43,14 +43,14 @@ module MergeHRISClient
43
43
  # @param [Hash] opts the optional parameters
44
44
  # @option opts [String] :category
45
45
  # @option opts [String] :cursor The pagination cursor value.
46
- # @option opts [String] :end_user_email_address
47
- # @option opts [String] :end_user_organization_name
48
- # @option opts [String] :end_user_origin_id
49
- # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once
46
+ # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
47
+ # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
48
+ # @option opts [String] :end_user_origin_id If provided, will only return linked accounts associated with the given origin ID.
49
+ # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
50
50
  # @option opts [String] :id
51
- # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once
52
- # @option opts [String] :integration_name
53
- # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts
51
+ # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
52
+ # @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
53
+ # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
54
54
  # @option opts [Integer] :page_size Number of results to return per page.
55
55
  # @option opts [String] :status Filter by status. Options: &#x60;COMPLETE&#x60;, &#x60;INCOMPLETE&#x60;, &#x60;RELINK_NEEDED&#x60;
56
56
  # @return [Array<(PaginatedAccountDetailsAndActionsList, Integer, Hash)>] PaginatedAccountDetailsAndActionsList data, response status code and response headers
@@ -25,11 +25,12 @@ 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.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
33
34
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
34
35
  # @return [PaginatedLocationList]
35
36
  def locations_list(x_account_token, opts = {})
@@ -43,11 +44,12 @@ module MergeHRISClient
43
44
  # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
44
45
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
45
46
  # @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.
47
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
48
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
49
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
50
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
50
51
  # @option opts [Integer] :page_size Number of results to return per page.
52
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
51
53
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
52
54
  # @return [Array<(PaginatedLocationList, Integer, Hash)>] PaginatedLocationList data, response status code and response headers
53
55
  def locations_list_with_http_info(x_account_token, opts = {})
@@ -58,6 +60,10 @@ module MergeHRISClient
58
60
  if @api_client.config.client_side_validation && x_account_token.nil?
59
61
  fail ArgumentError, "Missing the required parameter 'x_account_token' when calling LocationsApi.locations_list"
60
62
  end
63
+ allowable_values = ["location_type"]
64
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
65
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
66
+ end
61
67
  # resource path
62
68
  local_var_path = '/locations'
63
69
 
@@ -71,6 +77,7 @@ module MergeHRISClient
71
77
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
72
78
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
73
79
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
80
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
74
81
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
75
82
 
76
83
  # header parameters
@@ -113,6 +120,7 @@ module MergeHRISClient
113
120
  # @param id [String]
114
121
  # @param [Hash] opts the optional parameters
115
122
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
123
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
116
124
  # @return [Location]
117
125
  def locations_retrieve(x_account_token, id, opts = {})
118
126
  data, _status_code, _headers = locations_retrieve_with_http_info(x_account_token, id, opts)
@@ -124,6 +132,7 @@ module MergeHRISClient
124
132
  # @param id [String]
125
133
  # @param [Hash] opts the optional parameters
126
134
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
135
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
127
136
  # @return [Array<(Location, Integer, Hash)>] Location data, response status code and response headers
128
137
  def locations_retrieve_with_http_info(x_account_token, id, opts = {})
129
138
  if @api_client.config.debugging
@@ -137,12 +146,17 @@ module MergeHRISClient
137
146
  if @api_client.config.client_side_validation && id.nil?
138
147
  fail ArgumentError, "Missing the required parameter 'id' when calling LocationsApi.locations_retrieve"
139
148
  end
149
+ allowable_values = ["location_type"]
150
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
151
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
152
+ end
140
153
  # resource path
141
154
  local_var_path = '/locations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
142
155
 
143
156
  # query parameters
144
157
  query_params = opts[:query_params] || {}
145
158
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
159
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
146
160
 
147
161
  # header parameters
148
162
  header_params = opts[:header_params] || {}
@@ -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.
@@ -27,11 +27,12 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [Time] :ended_after If provided, will only return payroll runs ended after this datetime.
29
29
  # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
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.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
35
36
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
36
37
  # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;)
37
38
  # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
@@ -50,11 +51,12 @@ module MergeHRISClient
50
51
  # @option opts [String] :cursor The pagination cursor value.
51
52
  # @option opts [Time] :ended_after If provided, will only return payroll runs ended after this datetime.
52
53
  # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
53
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
54
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
54
55
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
55
56
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
56
57
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
57
58
  # @option opts [Integer] :page_size Number of results to return per page.
59
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
58
60
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
59
61
  # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;)
60
62
  # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
@@ -68,6 +70,10 @@ module MergeHRISClient
68
70
  if @api_client.config.client_side_validation && x_account_token.nil?
69
71
  fail ArgumentError, "Missing the required parameter 'x_account_token' when calling PayrollRunsApi.payroll_runs_list"
70
72
  end
73
+ allowable_values = ["run_state", "run_state,run_type", "run_type"]
74
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
75
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
76
+ end
71
77
  allowable_values = ["CORRECTION", "OFF_CYCLE", "REGULAR", "SIGN_ON_BONUS", "TERMINATION"]
72
78
  if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
73
79
  fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
@@ -87,6 +93,7 @@ module MergeHRISClient
87
93
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
88
94
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
89
95
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
96
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
90
97
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
91
98
  query_params[:'run_type'] = opts[:'run_type'] if !opts[:'run_type'].nil?
92
99
  query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
@@ -132,6 +139,7 @@ module MergeHRISClient
132
139
  # @param id [String]
133
140
  # @param [Hash] opts the optional parameters
134
141
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
142
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
135
143
  # @return [PayrollRun]
136
144
  def payroll_runs_retrieve(x_account_token, id, opts = {})
137
145
  data, _status_code, _headers = payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
@@ -143,6 +151,7 @@ module MergeHRISClient
143
151
  # @param id [String]
144
152
  # @param [Hash] opts the optional parameters
145
153
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
154
+ # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
146
155
  # @return [Array<(PayrollRun, Integer, Hash)>] PayrollRun data, response status code and response headers
147
156
  def payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {})
148
157
  if @api_client.config.debugging
@@ -156,12 +165,17 @@ module MergeHRISClient
156
165
  if @api_client.config.client_side_validation && id.nil?
157
166
  fail ArgumentError, "Missing the required parameter 'id' when calling PayrollRunsApi.payroll_runs_retrieve"
158
167
  end
168
+ allowable_values = ["run_state", "run_state,run_type", "run_type"]
169
+ if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
170
+ fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
171
+ end
159
172
  # resource path
160
173
  local_var_path = '/payroll-runs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
161
174
 
162
175
  # query parameters
163
176
  query_params = opts[:query_params] || {}
164
177
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
178
+ query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
165
179
 
166
180
  # header parameters
167
181
  header_params = opts[:header_params] || {}
@@ -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] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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.
@@ -46,7 +46,7 @@ module MergeHRISClient
46
46
  # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
47
47
  # @option opts [String] :cursor The pagination cursor value.
48
48
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
49
- # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
49
+ # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
50
50
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
51
51
  # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
52
52
  # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.