merge_hris_client 3.2.1 → 3.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (226) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +49 -16
  3. data/docs/AccountDetails.md +3 -1
  4. data/docs/AccountDetailsAndActions.md +7 -3
  5. data/docs/AccountIntegration.md +8 -4
  6. data/docs/AdvancedMetadata.md +28 -0
  7. data/docs/AuditLogEvent.md +32 -0
  8. data/docs/AuditTrailApi.md +91 -0
  9. data/docs/BankInfo.md +6 -4
  10. data/docs/BankInfoApi.md +4 -4
  11. data/docs/Benefit.md +6 -4
  12. data/docs/CommonModelScopeAPI.md +18 -0
  13. data/docs/Company.md +6 -4
  14. data/docs/CreateFieldMappingRequest.md +28 -0
  15. data/docs/DataPassthroughRequest.md +4 -4
  16. data/docs/DebugModelLogSummary.md +1 -1
  17. data/docs/Deduction.md +6 -4
  18. data/docs/Dependent.md +6 -4
  19. data/docs/Earning.md +6 -4
  20. data/docs/Employee.md +7 -3
  21. data/docs/EmployeePayrollRun.md +6 -4
  22. data/docs/EmployeeRequest.md +2 -0
  23. data/docs/EmployeesApi.md +10 -4
  24. data/docs/EmployerBenefit.md +6 -4
  25. data/docs/Employment.md +6 -4
  26. data/docs/EmploymentsApi.md +4 -4
  27. data/docs/EndUserDetailsRequest.md +13 -7
  28. data/docs/EventTypeEnum.md +15 -0
  29. data/docs/ExternalTargetFieldAPI.md +22 -0
  30. data/docs/ExternalTargetFieldAPIResponse.md +48 -0
  31. data/docs/FieldMappingApi.md +455 -0
  32. data/docs/FieldMappingApiInstance.md +24 -0
  33. data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
  34. data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
  35. data/docs/FieldMappingApiInstanceResponse.md +48 -0
  36. data/docs/FieldMappingApiInstanceTargetField.md +22 -0
  37. data/docs/FieldMappingInstanceResponse.md +24 -0
  38. data/docs/FieldPermissionDeserializer.md +20 -0
  39. data/docs/FieldPermissionDeserializerRequest.md +20 -0
  40. data/docs/ForceResyncApi.md +1 -1
  41. data/docs/GenerateRemoteKeyRequest.md +1 -1
  42. data/docs/Group.md +9 -5
  43. data/docs/GroupsApi.md +8 -4
  44. data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
  45. data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
  46. data/docs/Issue.md +1 -1
  47. data/docs/IssuesApi.md +5 -3
  48. data/docs/LinkTokenApi.md +1 -1
  49. data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
  50. data/docs/LinkedAccountsApi.md +2 -2
  51. data/docs/Location.md +6 -4
  52. data/docs/LocationsApi.md +6 -4
  53. data/docs/MetaResponse.md +1 -1
  54. data/docs/ModelPermissionDeserializer.md +18 -0
  55. data/docs/ModelPermissionDeserializerRequest.md +18 -0
  56. data/docs/PaginatedAuditLogEventList.md +22 -0
  57. data/docs/PaginatedTimesheetEntryList.md +22 -0
  58. data/docs/PatchedEditFieldMappingRequest.md +22 -0
  59. data/docs/PayGroup.md +6 -4
  60. data/docs/PayrollRun.md +6 -4
  61. data/docs/PayrollRunsApi.md +4 -4
  62. data/docs/RemoteEndpointInfo.md +22 -0
  63. data/docs/RemoteFieldAPI.md +28 -0
  64. data/docs/RemoteFieldAPIResponse.md +48 -0
  65. data/docs/RemoteKeyForRegenerationRequest.md +1 -1
  66. data/docs/RoleEnum.md +15 -0
  67. data/docs/ScopesApi.md +222 -0
  68. data/docs/SyncStatusApi.md +1 -1
  69. data/docs/Tax.md +6 -4
  70. data/docs/Team.md +6 -4
  71. data/docs/TimeOff.md +5 -3
  72. data/docs/TimeOffApi.md +12 -4
  73. data/docs/TimeOffBalance.md +6 -4
  74. data/docs/TimeOffBalancesApi.md +4 -4
  75. data/docs/TimesheetEntriesApi.md +341 -0
  76. data/docs/TimesheetEntry.md +38 -0
  77. data/docs/TimesheetEntryEndpointRequest.md +18 -0
  78. data/docs/TimesheetEntryRequest.md +28 -0
  79. data/docs/TimesheetEntryResponse.md +24 -0
  80. data/lib/merge_hris_client/api/audit_trail_api.rb +95 -0
  81. data/lib/merge_hris_client/api/bank_info_api.rb +4 -4
  82. data/lib/merge_hris_client/api/employees_api.rb +13 -4
  83. data/lib/merge_hris_client/api/employments_api.rb +4 -4
  84. data/lib/merge_hris_client/api/field_mapping_api.rb +424 -0
  85. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  86. data/lib/merge_hris_client/api/groups_api.rb +10 -4
  87. data/lib/merge_hris_client/api/issues_api.rb +7 -4
  88. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
  89. data/lib/merge_hris_client/api/locations_api.rb +11 -4
  90. data/lib/merge_hris_client/api/payroll_runs_api.rb +4 -4
  91. data/lib/merge_hris_client/api/scopes_api.rb +209 -0
  92. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  93. data/lib/merge_hris_client/api/time_off_api.rb +16 -4
  94. data/lib/merge_hris_client/api/time_off_balances_api.rb +4 -4
  95. data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
  96. data/lib/merge_hris_client/configuration.rb +4 -0
  97. data/lib/merge_hris_client/models/account_details.rb +14 -5
  98. data/lib/merge_hris_client/models/account_details_and_actions.rb +28 -4
  99. data/lib/merge_hris_client/models/account_integration.rb +36 -14
  100. data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
  101. data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
  102. data/lib/merge_hris_client/models/bank_info.rb +24 -16
  103. data/lib/merge_hris_client/models/benefit.rb +24 -16
  104. data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
  105. data/lib/merge_hris_client/models/company.rb +24 -16
  106. data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
  107. data/lib/merge_hris_client/models/data_passthrough_request.rb +3 -0
  108. data/lib/merge_hris_client/models/deduction.rb +24 -16
  109. data/lib/merge_hris_client/models/dependent.rb +24 -16
  110. data/lib/merge_hris_client/models/earning.rb +24 -16
  111. data/lib/merge_hris_client/models/employee.rb +34 -15
  112. data/lib/merge_hris_client/models/employee_payroll_run.rb +24 -16
  113. data/lib/merge_hris_client/models/employee_request.rb +12 -1
  114. data/lib/merge_hris_client/models/employer_benefit.rb +24 -16
  115. data/lib/merge_hris_client/models/employment.rb +24 -16
  116. data/lib/merge_hris_client/models/end_user_details_request.rb +67 -6
  117. data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
  118. data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
  119. data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
  120. data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
  121. data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
  122. data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
  123. data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
  124. data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
  125. data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
  126. data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
  127. data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
  128. data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
  129. data/lib/merge_hris_client/models/group.rb +34 -15
  130. data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
  131. data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
  132. data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
  133. data/lib/merge_hris_client/models/location.rb +24 -16
  134. data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
  135. data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
  136. data/lib/merge_hris_client/models/paginated_audit_log_event_list.rb +240 -0
  137. data/lib/merge_hris_client/models/paginated_timesheet_entry_list.rb +240 -0
  138. data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
  139. data/lib/merge_hris_client/models/pay_group.rb +24 -16
  140. data/lib/merge_hris_client/models/payroll_run.rb +24 -16
  141. data/lib/merge_hris_client/models/remote_endpoint_info.rb +253 -0
  142. data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
  143. data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
  144. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
  145. data/lib/merge_hris_client/models/role_enum.rb +49 -0
  146. data/lib/merge_hris_client/models/tax.rb +24 -16
  147. data/lib/merge_hris_client/models/team.rb +24 -16
  148. data/lib/merge_hris_client/models/time_off.rb +23 -15
  149. data/lib/merge_hris_client/models/time_off_balance.rb +24 -16
  150. data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
  151. data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
  152. data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
  153. data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
  154. data/lib/merge_hris_client/version.rb +1 -1
  155. data/lib/merge_hris_client.rb +35 -21
  156. data/spec/api/audit_trail_api_spec.rb +51 -0
  157. data/spec/api/bank_info_api_spec.rb +2 -2
  158. data/spec/api/employees_api_spec.rb +5 -2
  159. data/spec/api/employments_api_spec.rb +2 -2
  160. data/spec/api/field_mapping_api_spec.rb +107 -0
  161. data/spec/api/force_resync_api_spec.rb +1 -1
  162. data/spec/api/groups_api_spec.rb +4 -2
  163. data/spec/api/issues_api_spec.rb +3 -2
  164. data/spec/api/linked_accounts_api_spec.rb +1 -1
  165. data/spec/api/locations_api_spec.rb +3 -2
  166. data/spec/api/payroll_runs_api_spec.rb +2 -2
  167. data/spec/api/scopes_api_spec.rb +68 -0
  168. data/spec/api/sync_status_api_spec.rb +1 -1
  169. data/spec/api/time_off_api_spec.rb +6 -2
  170. data/spec/api/time_off_balances_api_spec.rb +2 -2
  171. data/spec/api/timesheet_entries_api_spec.rb +99 -0
  172. data/spec/models/account_details_and_actions_spec.rb +12 -0
  173. data/spec/models/account_details_spec.rb +6 -0
  174. data/spec/models/account_integration_spec.rb +14 -2
  175. data/spec/models/advanced_metadata_spec.rb +64 -0
  176. data/spec/models/audit_log_event_spec.rb +76 -0
  177. data/spec/models/bank_info_spec.rb +12 -6
  178. data/spec/models/benefit_spec.rb +12 -6
  179. data/spec/models/common_model_scope_api_spec.rb +34 -0
  180. data/spec/models/company_spec.rb +11 -5
  181. data/spec/models/create_field_mapping_request_spec.rb +64 -0
  182. data/spec/models/deduction_spec.rb +12 -6
  183. data/spec/models/dependent_spec.rb +12 -6
  184. data/spec/models/earning_spec.rb +11 -5
  185. data/spec/models/employee_payroll_run_spec.rb +12 -6
  186. data/spec/models/employee_request_spec.rb +6 -0
  187. data/spec/models/employee_spec.rb +18 -6
  188. data/spec/models/employer_benefit_spec.rb +12 -6
  189. data/spec/models/employment_spec.rb +12 -6
  190. data/spec/models/end_user_details_request_spec.rb +18 -0
  191. data/spec/models/event_type_enum_spec.rb +28 -0
  192. data/spec/models/external_target_field_api_response_spec.rb +124 -0
  193. data/spec/models/external_target_field_api_spec.rb +46 -0
  194. data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
  195. data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
  196. data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
  197. data/spec/models/field_mapping_api_instance_spec.rb +52 -0
  198. data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
  199. data/spec/models/field_mapping_instance_response_spec.rb +52 -0
  200. data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
  201. data/spec/models/field_permission_deserializer_spec.rb +40 -0
  202. data/spec/models/group_spec.rb +13 -1
  203. data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
  204. data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
  205. data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -0
  206. data/spec/models/location_spec.rb +12 -6
  207. data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
  208. data/spec/models/model_permission_deserializer_spec.rb +34 -0
  209. data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
  210. data/spec/models/paginated_timesheet_entry_list_spec.rb +46 -0
  211. data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
  212. data/spec/models/pay_group_spec.rb +9 -3
  213. data/spec/models/payroll_run_spec.rb +12 -6
  214. data/spec/models/remote_endpoint_info_spec.rb +46 -0
  215. data/spec/models/remote_field_api_response_spec.rb +124 -0
  216. data/spec/models/remote_field_api_spec.rb +64 -0
  217. data/spec/models/role_enum_spec.rb +28 -0
  218. data/spec/models/tax_spec.rb +12 -6
  219. data/spec/models/team_spec.rb +10 -4
  220. data/spec/models/time_off_balance_spec.rb +12 -6
  221. data/spec/models/time_off_spec.rb +12 -6
  222. data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
  223. data/spec/models/timesheet_entry_request_spec.rb +64 -0
  224. data/spec/models/timesheet_entry_response_spec.rb +52 -0
  225. data/spec/models/timesheet_entry_spec.rb +94 -0
  226. metadata +266 -126
@@ -178,12 +178,15 @@ module MergeHRISClient
178
178
  # @option opts [String] :cursor The pagination cursor value.
179
179
  # @option opts [String] :display_full_name If provided, will only return employees with this display name.
180
180
  # @option opts [String] :employment_status If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
181
+ # @option opts [String] :employment_type If provided, will only return employees that have an employment of the specified employment_type.
181
182
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
182
183
  # @option opts [String] :first_name If provided, will only return employees with this first name.
183
184
  # @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
185
+ # @option opts [String] :home_location_id If provided, will only return employees for this home location.
184
186
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
185
187
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
186
188
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
189
+ # @option opts [String] :job_title If provided, will only return employees that have an employment of the specified job_title.
187
190
  # @option opts [String] :last_name If provided, will only return employees with this last name.
188
191
  # @option opts [String] :manager_id If provided, will only return employees for this manager.
189
192
  # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
@@ -193,7 +196,7 @@ module MergeHRISClient
193
196
  # @option opts [String] :personal_email If provided, will only return Employees with this personal email
194
197
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
195
198
  # @option opts [String] :remote_id The API provider's ID for the given object.
196
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
199
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
197
200
  # @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
198
201
  # @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
199
202
  # @option opts [String] :team_id If provided, will only return employees for this team.
@@ -216,12 +219,15 @@ module MergeHRISClient
216
219
  # @option opts [String] :cursor The pagination cursor value.
217
220
  # @option opts [String] :display_full_name If provided, will only return employees with this display name.
218
221
  # @option opts [String] :employment_status If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
222
+ # @option opts [String] :employment_type If provided, will only return employees that have an employment of the specified employment_type.
219
223
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
220
224
  # @option opts [String] :first_name If provided, will only return employees with this first name.
221
225
  # @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
226
+ # @option opts [String] :home_location_id If provided, will only return employees for this home location.
222
227
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
223
228
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
224
229
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
230
+ # @option opts [String] :job_title If provided, will only return employees that have an employment of the specified job_title.
225
231
  # @option opts [String] :last_name If provided, will only return employees with this last name.
226
232
  # @option opts [String] :manager_id If provided, will only return employees for this manager.
227
233
  # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
@@ -231,7 +237,7 @@ module MergeHRISClient
231
237
  # @option opts [String] :personal_email If provided, will only return Employees with this personal email
232
238
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
233
239
  # @option opts [String] :remote_id The API provider's ID for the given object.
234
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
240
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
235
241
  # @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
236
242
  # @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
237
243
  # @option opts [String] :team_id If provided, will only return employees for this team.
@@ -275,12 +281,15 @@ module MergeHRISClient
275
281
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
276
282
  query_params[:'display_full_name'] = opts[:'display_full_name'] if !opts[:'display_full_name'].nil?
277
283
  query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
284
+ query_params[:'employment_type'] = opts[:'employment_type'] if !opts[:'employment_type'].nil?
278
285
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
279
286
  query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
280
287
  query_params[:'groups'] = opts[:'groups'] if !opts[:'groups'].nil?
288
+ query_params[:'home_location_id'] = opts[:'home_location_id'] if !opts[:'home_location_id'].nil?
281
289
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
282
290
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
283
291
  query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
292
+ query_params[:'job_title'] = opts[:'job_title'] if !opts[:'job_title'].nil?
284
293
  query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
285
294
  query_params[:'manager_id'] = opts[:'manager_id'] if !opts[:'manager_id'].nil?
286
295
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
@@ -404,7 +413,7 @@ module MergeHRISClient
404
413
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
405
414
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
406
415
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
407
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
416
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
408
417
  # @return [Employee]
409
418
  def employees_retrieve(x_account_token, id, opts = {})
410
419
  data, _status_code, _headers = employees_retrieve_with_http_info(x_account_token, id, opts)
@@ -419,7 +428,7 @@ module MergeHRISClient
419
428
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
420
429
  # @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
421
430
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
422
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
431
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
423
432
  # @return [Array<(Employee, Integer, Hash)>] Employee data, response status code and response headers
424
433
  def employees_retrieve_with_http_info(x_account_token, id, opts = {})
425
434
  if @api_client.config.debugging
@@ -35,7 +35,7 @@ module MergeHRISClient
35
35
  # @option opts [Integer] :page_size Number of results to return per page.
36
36
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
37
37
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
38
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
38
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
39
39
  # @return [PaginatedEmploymentList]
40
40
  def employments_list(x_account_token, opts = {})
41
41
  data, _status_code, _headers = employments_list_with_http_info(x_account_token, opts)
@@ -58,7 +58,7 @@ module MergeHRISClient
58
58
  # @option opts [Integer] :page_size Number of results to return per page.
59
59
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
60
60
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
61
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
61
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
62
62
  # @return [Array<(PaginatedEmploymentList, Integer, Hash)>] PaginatedEmploymentList data, response status code and response headers
63
63
  def employments_list_with_http_info(x_account_token, opts = {})
64
64
  if @api_client.config.debugging
@@ -146,7 +146,7 @@ module MergeHRISClient
146
146
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
147
147
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
148
148
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
149
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
149
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
150
150
  # @return [Employment]
151
151
  def employments_retrieve(x_account_token, id, opts = {})
152
152
  data, _status_code, _headers = employments_retrieve_with_http_info(x_account_token, id, opts)
@@ -160,7 +160,7 @@ module MergeHRISClient
160
160
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
161
161
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
162
162
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
163
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
163
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
164
164
  # @return [Array<(Employment, Integer, Hash)>] Employment data, response status code and response headers
165
165
  def employments_retrieve_with_http_info(x_account_token, id, opts = {})
166
166
  if @api_client.config.debugging
@@ -0,0 +1,424 @@
1
+ =begin
2
+ #Merge HRIS API
3
+
4
+ #The unified API for building rich integrations with multiple HR Information System platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeHRISClient
16
+ class FieldMappingApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param create_field_mapping_request [CreateFieldMappingRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [FieldMappingInstanceResponse]
27
+ def field_mappings_create(x_account_token, create_field_mapping_request, opts = {})
28
+ data, _status_code, _headers = field_mappings_create_with_http_info(x_account_token, create_field_mapping_request, opts)
29
+ data
30
+ end
31
+
32
+ # Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
33
+ # @param x_account_token [String] Token identifying the end user.
34
+ # @param create_field_mapping_request [CreateFieldMappingRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(FieldMappingInstanceResponse, Integer, Hash)>] FieldMappingInstanceResponse data, response status code and response headers
37
+ def field_mappings_create_with_http_info(x_account_token, create_field_mapping_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_create ...'
40
+ end
41
+ # verify the required parameter 'x_account_token' is set
42
+ if @api_client.config.client_side_validation && x_account_token.nil?
43
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_create"
44
+ end
45
+ # verify the required parameter 'create_field_mapping_request' is set
46
+ if @api_client.config.client_side_validation && create_field_mapping_request.nil?
47
+ fail ArgumentError, "Missing the required parameter 'create_field_mapping_request' when calling FieldMappingApi.field_mappings_create"
48
+ end
49
+ # resource path
50
+ local_var_path = '/field-mappings'
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+
55
+ # header parameters
56
+ header_params = opts[:header_params] || {}
57
+ # HTTP header 'Accept' (if needed)
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
59
+ # HTTP header 'Content-Type'
60
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
61
+ header_params[:'X-Account-Token'] = x_account_token
62
+
63
+ # form parameters
64
+ form_params = opts[:form_params] || {}
65
+
66
+ # http body (model)
67
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_field_mapping_request)
68
+
69
+ # return_type
70
+ return_type = opts[:debug_return_type] || 'FieldMappingInstanceResponse'
71
+
72
+ # auth_names
73
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
74
+
75
+ new_options = opts.merge(
76
+ :operation => :"FieldMappingApi.field_mappings_create",
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => return_type
83
+ )
84
+
85
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
92
+ # Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
93
+ # @param x_account_token [String] Token identifying the end user.
94
+ # @param field_mapping_id [String]
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [FieldMappingInstanceResponse]
97
+ def field_mappings_destroy(x_account_token, field_mapping_id, opts = {})
98
+ data, _status_code, _headers = field_mappings_destroy_with_http_info(x_account_token, field_mapping_id, opts)
99
+ data
100
+ end
101
+
102
+ # Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
103
+ # @param x_account_token [String] Token identifying the end user.
104
+ # @param field_mapping_id [String]
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(FieldMappingInstanceResponse, Integer, Hash)>] FieldMappingInstanceResponse data, response status code and response headers
107
+ def field_mappings_destroy_with_http_info(x_account_token, field_mapping_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_destroy ...'
110
+ end
111
+ # verify the required parameter 'x_account_token' is set
112
+ if @api_client.config.client_side_validation && x_account_token.nil?
113
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_destroy"
114
+ end
115
+ # verify the required parameter 'field_mapping_id' is set
116
+ if @api_client.config.client_side_validation && field_mapping_id.nil?
117
+ fail ArgumentError, "Missing the required parameter 'field_mapping_id' when calling FieldMappingApi.field_mappings_destroy"
118
+ end
119
+ # resource path
120
+ local_var_path = '/field-mappings/{field_mapping_id}'.sub('{' + 'field_mapping_id' + '}', CGI.escape(field_mapping_id.to_s))
121
+
122
+ # query parameters
123
+ query_params = opts[:query_params] || {}
124
+
125
+ # header parameters
126
+ header_params = opts[:header_params] || {}
127
+ # HTTP header 'Accept' (if needed)
128
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
129
+ header_params[:'X-Account-Token'] = x_account_token
130
+
131
+ # form parameters
132
+ form_params = opts[:form_params] || {}
133
+
134
+ # http body (model)
135
+ post_body = opts[:debug_body]
136
+
137
+ # return_type
138
+ return_type = opts[:debug_return_type] || 'FieldMappingInstanceResponse'
139
+
140
+ # auth_names
141
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
142
+
143
+ new_options = opts.merge(
144
+ :operation => :"FieldMappingApi.field_mappings_destroy",
145
+ :header_params => header_params,
146
+ :query_params => query_params,
147
+ :form_params => form_params,
148
+ :body => post_body,
149
+ :auth_names => auth_names,
150
+ :return_type => return_type
151
+ )
152
+
153
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
154
+ if @api_client.config.debugging
155
+ @api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
156
+ end
157
+ return data, status_code, headers
158
+ end
159
+
160
+ # Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
161
+ # @param x_account_token [String] Token identifying the end user.
162
+ # @param field_mapping_id [String]
163
+ # @param [Hash] opts the optional parameters
164
+ # @option opts [PatchedEditFieldMappingRequest] :patched_edit_field_mapping_request
165
+ # @return [FieldMappingInstanceResponse]
166
+ def field_mappings_partial_update(x_account_token, field_mapping_id, opts = {})
167
+ data, _status_code, _headers = field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts)
168
+ data
169
+ end
170
+
171
+ # Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
172
+ # @param x_account_token [String] Token identifying the end user.
173
+ # @param field_mapping_id [String]
174
+ # @param [Hash] opts the optional parameters
175
+ # @option opts [PatchedEditFieldMappingRequest] :patched_edit_field_mapping_request
176
+ # @return [Array<(FieldMappingInstanceResponse, Integer, Hash)>] FieldMappingInstanceResponse data, response status code and response headers
177
+ def field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts = {})
178
+ if @api_client.config.debugging
179
+ @api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_partial_update ...'
180
+ end
181
+ # verify the required parameter 'x_account_token' is set
182
+ if @api_client.config.client_side_validation && x_account_token.nil?
183
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_partial_update"
184
+ end
185
+ # verify the required parameter 'field_mapping_id' is set
186
+ if @api_client.config.client_side_validation && field_mapping_id.nil?
187
+ fail ArgumentError, "Missing the required parameter 'field_mapping_id' when calling FieldMappingApi.field_mappings_partial_update"
188
+ end
189
+ # resource path
190
+ local_var_path = '/field-mappings/{field_mapping_id}'.sub('{' + 'field_mapping_id' + '}', CGI.escape(field_mapping_id.to_s))
191
+
192
+ # query parameters
193
+ query_params = opts[:query_params] || {}
194
+
195
+ # header parameters
196
+ header_params = opts[:header_params] || {}
197
+ # HTTP header 'Accept' (if needed)
198
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
199
+ # HTTP header 'Content-Type'
200
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
201
+ header_params[:'X-Account-Token'] = x_account_token
202
+
203
+ # form parameters
204
+ form_params = opts[:form_params] || {}
205
+
206
+ # http body (model)
207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patched_edit_field_mapping_request'])
208
+
209
+ # return_type
210
+ return_type = opts[:debug_return_type] || 'FieldMappingInstanceResponse'
211
+
212
+ # auth_names
213
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
214
+
215
+ new_options = opts.merge(
216
+ :operation => :"FieldMappingApi.field_mappings_partial_update",
217
+ :header_params => header_params,
218
+ :query_params => query_params,
219
+ :form_params => form_params,
220
+ :body => post_body,
221
+ :auth_names => auth_names,
222
+ :return_type => return_type
223
+ )
224
+
225
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
226
+ if @api_client.config.debugging
227
+ @api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
228
+ end
229
+ return data, status_code, headers
230
+ end
231
+
232
+ # Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
233
+ # @param x_account_token [String] Token identifying the end user.
234
+ # @param [Hash] opts the optional parameters
235
+ # @return [FieldMappingApiInstanceResponse]
236
+ def field_mappings_retrieve(x_account_token, opts = {})
237
+ data, _status_code, _headers = field_mappings_retrieve_with_http_info(x_account_token, opts)
238
+ data
239
+ end
240
+
241
+ # Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
242
+ # @param x_account_token [String] Token identifying the end user.
243
+ # @param [Hash] opts the optional parameters
244
+ # @return [Array<(FieldMappingApiInstanceResponse, Integer, Hash)>] FieldMappingApiInstanceResponse data, response status code and response headers
245
+ def field_mappings_retrieve_with_http_info(x_account_token, opts = {})
246
+ if @api_client.config.debugging
247
+ @api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_retrieve ...'
248
+ end
249
+ # verify the required parameter 'x_account_token' is set
250
+ if @api_client.config.client_side_validation && x_account_token.nil?
251
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_retrieve"
252
+ end
253
+ # resource path
254
+ local_var_path = '/field-mappings'
255
+
256
+ # query parameters
257
+ query_params = opts[:query_params] || {}
258
+
259
+ # header parameters
260
+ header_params = opts[:header_params] || {}
261
+ # HTTP header 'Accept' (if needed)
262
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
263
+ header_params[:'X-Account-Token'] = x_account_token
264
+
265
+ # form parameters
266
+ form_params = opts[:form_params] || {}
267
+
268
+ # http body (model)
269
+ post_body = opts[:debug_body]
270
+
271
+ # return_type
272
+ return_type = opts[:debug_return_type] || 'FieldMappingApiInstanceResponse'
273
+
274
+ # auth_names
275
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
276
+
277
+ new_options = opts.merge(
278
+ :operation => :"FieldMappingApi.field_mappings_retrieve",
279
+ :header_params => header_params,
280
+ :query_params => query_params,
281
+ :form_params => form_params,
282
+ :body => post_body,
283
+ :auth_names => auth_names,
284
+ :return_type => return_type
285
+ )
286
+
287
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
288
+ if @api_client.config.debugging
289
+ @api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
290
+ end
291
+ return data, status_code, headers
292
+ end
293
+
294
+ # Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
295
+ # @param x_account_token [String] Token identifying the end user.
296
+ # @param [Hash] opts the optional parameters
297
+ # @option opts [String] :common_models A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
298
+ # @option opts [String] :include_example_values If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
299
+ # @return [RemoteFieldAPIResponse]
300
+ def remote_fields_retrieve(x_account_token, opts = {})
301
+ data, _status_code, _headers = remote_fields_retrieve_with_http_info(x_account_token, opts)
302
+ data
303
+ end
304
+
305
+ # Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
306
+ # @param x_account_token [String] Token identifying the end user.
307
+ # @param [Hash] opts the optional parameters
308
+ # @option opts [String] :common_models A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
309
+ # @option opts [String] :include_example_values If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
310
+ # @return [Array<(RemoteFieldAPIResponse, Integer, Hash)>] RemoteFieldAPIResponse data, response status code and response headers
311
+ def remote_fields_retrieve_with_http_info(x_account_token, opts = {})
312
+ if @api_client.config.debugging
313
+ @api_client.config.logger.debug 'Calling API: FieldMappingApi.remote_fields_retrieve ...'
314
+ end
315
+ # verify the required parameter 'x_account_token' is set
316
+ if @api_client.config.client_side_validation && x_account_token.nil?
317
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.remote_fields_retrieve"
318
+ end
319
+ # resource path
320
+ local_var_path = '/remote-fields'
321
+
322
+ # query parameters
323
+ query_params = opts[:query_params] || {}
324
+ query_params[:'common_models'] = opts[:'common_models'] if !opts[:'common_models'].nil?
325
+ query_params[:'include_example_values'] = opts[:'include_example_values'] if !opts[:'include_example_values'].nil?
326
+
327
+ # header parameters
328
+ header_params = opts[:header_params] || {}
329
+ # HTTP header 'Accept' (if needed)
330
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
331
+ header_params[:'X-Account-Token'] = x_account_token
332
+
333
+ # form parameters
334
+ form_params = opts[:form_params] || {}
335
+
336
+ # http body (model)
337
+ post_body = opts[:debug_body]
338
+
339
+ # return_type
340
+ return_type = opts[:debug_return_type] || 'RemoteFieldAPIResponse'
341
+
342
+ # auth_names
343
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
344
+
345
+ new_options = opts.merge(
346
+ :operation => :"FieldMappingApi.remote_fields_retrieve",
347
+ :header_params => header_params,
348
+ :query_params => query_params,
349
+ :form_params => form_params,
350
+ :body => post_body,
351
+ :auth_names => auth_names,
352
+ :return_type => return_type
353
+ )
354
+
355
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
356
+ if @api_client.config.debugging
357
+ @api_client.config.logger.debug "API called: FieldMappingApi#remote_fields_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
358
+ end
359
+ return data, status_code, headers
360
+ end
361
+
362
+ # Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
363
+ # @param x_account_token [String] Token identifying the end user.
364
+ # @param [Hash] opts the optional parameters
365
+ # @return [ExternalTargetFieldAPIResponse]
366
+ def target_fields_retrieve(x_account_token, opts = {})
367
+ data, _status_code, _headers = target_fields_retrieve_with_http_info(x_account_token, opts)
368
+ data
369
+ end
370
+
371
+ # Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
372
+ # @param x_account_token [String] Token identifying the end user.
373
+ # @param [Hash] opts the optional parameters
374
+ # @return [Array<(ExternalTargetFieldAPIResponse, Integer, Hash)>] ExternalTargetFieldAPIResponse data, response status code and response headers
375
+ def target_fields_retrieve_with_http_info(x_account_token, opts = {})
376
+ if @api_client.config.debugging
377
+ @api_client.config.logger.debug 'Calling API: FieldMappingApi.target_fields_retrieve ...'
378
+ end
379
+ # verify the required parameter 'x_account_token' is set
380
+ if @api_client.config.client_side_validation && x_account_token.nil?
381
+ fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.target_fields_retrieve"
382
+ end
383
+ # resource path
384
+ local_var_path = '/target-fields'
385
+
386
+ # query parameters
387
+ query_params = opts[:query_params] || {}
388
+
389
+ # header parameters
390
+ header_params = opts[:header_params] || {}
391
+ # HTTP header 'Accept' (if needed)
392
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
393
+ header_params[:'X-Account-Token'] = x_account_token
394
+
395
+ # form parameters
396
+ form_params = opts[:form_params] || {}
397
+
398
+ # http body (model)
399
+ post_body = opts[:debug_body]
400
+
401
+ # return_type
402
+ return_type = opts[:debug_return_type] || 'ExternalTargetFieldAPIResponse'
403
+
404
+ # auth_names
405
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
406
+
407
+ new_options = opts.merge(
408
+ :operation => :"FieldMappingApi.target_fields_retrieve",
409
+ :header_params => header_params,
410
+ :query_params => query_params,
411
+ :form_params => form_params,
412
+ :body => post_body,
413
+ :auth_names => auth_names,
414
+ :return_type => return_type
415
+ )
416
+
417
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
418
+ if @api_client.config.debugging
419
+ @api_client.config.logger.debug "API called: FieldMappingApi#target_fields_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
420
+ end
421
+ return data, status_code, headers
422
+ end
423
+ end
424
+ end
@@ -19,7 +19,7 @@ module MergeHRISClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
22
+ # Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
23
23
  # @param x_account_token [String] Token identifying the end user.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [Array<SyncStatus>]
@@ -28,7 +28,7 @@ module MergeHRISClient
28
28
  data
29
29
  end
30
30
 
31
- # Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
31
+ # Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
32
32
  # @param x_account_token [String] Token identifying the end user.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(Array<SyncStatus>, Integer, Hash)>] Array<SyncStatus> data, response status code and response headers
@@ -27,12 +27,14 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
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
+ # @option opts [String] :is_commonly_used_as_team If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
30
31
  # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
31
32
  # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
33
+ # @option opts [String] :names If provided, will only return groups with these names. Multiple values can be separated by commas.
32
34
  # @option opts [Integer] :page_size Number of results to return per page.
33
35
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
34
36
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
35
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
37
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
36
38
  # @option opts [String] :types If provided, will only return groups of these types. Multiple values can be separated by commas.
37
39
  # @return [PaginatedGroupList]
38
40
  def groups_list(x_account_token, opts = {})
@@ -48,12 +50,14 @@ module MergeHRISClient
48
50
  # @option opts [String] :cursor The pagination cursor value.
49
51
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
50
52
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
53
+ # @option opts [String] :is_commonly_used_as_team If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
51
54
  # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
52
55
  # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
56
+ # @option opts [String] :names If provided, will only return groups with these names. Multiple values can be separated by commas.
53
57
  # @option opts [Integer] :page_size Number of results to return per page.
54
58
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
55
59
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
56
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
60
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
57
61
  # @option opts [String] :types If provided, will only return groups of these types. Multiple values can be separated by commas.
58
62
  # @return [Array<(PaginatedGroupList, Integer, Hash)>] PaginatedGroupList data, response status code and response headers
59
63
  def groups_list_with_http_info(x_account_token, opts = {})
@@ -82,8 +86,10 @@ module MergeHRISClient
82
86
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
83
87
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
84
88
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
89
+ query_params[:'is_commonly_used_as_team'] = opts[:'is_commonly_used_as_team'] if !opts[:'is_commonly_used_as_team'].nil?
85
90
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
86
91
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
92
+ query_params[:'names'] = opts[:'names'] if !opts[:'names'].nil?
87
93
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
88
94
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
89
95
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
@@ -131,7 +137,7 @@ module MergeHRISClient
131
137
  # @param [Hash] opts the optional parameters
132
138
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
133
139
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
134
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
140
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
135
141
  # @return [Group]
136
142
  def groups_retrieve(x_account_token, id, opts = {})
137
143
  data, _status_code, _headers = groups_retrieve_with_http_info(x_account_token, id, opts)
@@ -144,7 +150,7 @@ module MergeHRISClient
144
150
  # @param [Hash] opts the optional parameters
145
151
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
146
152
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
147
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
153
+ # @option opts [String] :show_enum_origins A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
148
154
  # @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
149
155
  def groups_retrieve_with_http_info(x_account_token, id, opts = {})
150
156
  if @api_client.config.debugging