merge_hris_client 2.0.4 → 3.2.2

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 (380) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +67 -10
  3. data/docs/AccountDetails.md +5 -1
  4. data/docs/AccountDetailsAndActions.md +9 -3
  5. data/docs/AccountIntegration.md +10 -2
  6. data/docs/AdvancedMetadata.md +28 -0
  7. data/docs/AsyncPassthroughApi.md +155 -0
  8. data/docs/AsyncPassthroughReciept.md +18 -0
  9. data/docs/AuditLogEvent.md +32 -0
  10. data/docs/AuditTrailApi.md +91 -0
  11. data/docs/BankInfo.md +11 -5
  12. data/docs/BankInfoApi.md +17 -13
  13. data/docs/Benefit.md +17 -5
  14. data/docs/BenefitPlanTypeEnum.md +15 -0
  15. data/docs/BenefitsApi.md +6 -6
  16. data/docs/CommonModelScopeAPI.md +18 -0
  17. data/docs/CommonModelScopeData.md +20 -0
  18. data/docs/CommonModelScopes.md +20 -0
  19. data/docs/CommonModelScopesApi.md +157 -0
  20. data/docs/CommonModelScopesBodyRequest.md +22 -0
  21. data/docs/CommonModelScopesDisabledModels.md +26 -0
  22. data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
  23. data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
  24. data/docs/CommonModelScopesUpdateSerializer.md +18 -0
  25. data/docs/CompaniesApi.md +4 -4
  26. data/docs/Company.md +9 -3
  27. data/docs/ConditionSchema.md +30 -0
  28. data/docs/ConditionTypeEnum.md +15 -0
  29. data/docs/CreateFieldMappingRequest.md +28 -0
  30. data/docs/DataPassthroughRequest.md +5 -5
  31. data/docs/DebugModelLogSummary.md +1 -1
  32. data/docs/Deduction.md +13 -5
  33. data/docs/DeleteAccountApi.md +9 -9
  34. data/docs/Dependent.md +52 -0
  35. data/docs/DependentsApi.md +181 -0
  36. data/docs/Earning.md +13 -5
  37. data/docs/Employee.md +27 -15
  38. data/docs/EmployeePayrollRun.md +13 -7
  39. data/docs/EmployeePayrollRunsApi.md +4 -4
  40. data/docs/EmployeeRequest.md +20 -16
  41. data/docs/EmployeesApi.md +37 -18
  42. data/docs/EmployerBenefit.md +38 -0
  43. data/docs/EmployerBenefitsApi.md +177 -0
  44. data/docs/Employment.md +16 -10
  45. data/docs/EmploymentsApi.md +15 -11
  46. data/docs/EnabledActionsEnum.md +15 -0
  47. data/docs/EndUserDetailsRequest.md +22 -12
  48. data/docs/EventTypeEnum.md +15 -0
  49. data/docs/ExternalTargetFieldAPI.md +22 -0
  50. data/docs/ExternalTargetFieldAPIResponse.md +48 -0
  51. data/docs/FieldMappingApi.md +455 -0
  52. data/docs/FieldMappingApiInstance.md +24 -0
  53. data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
  54. data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
  55. data/docs/FieldMappingApiInstanceResponse.md +48 -0
  56. data/docs/FieldMappingApiInstanceTargetField.md +22 -0
  57. data/docs/FieldMappingInstanceResponse.md +24 -0
  58. data/docs/FieldPermissionDeserializer.md +20 -0
  59. data/docs/FieldPermissionDeserializerRequest.md +20 -0
  60. data/docs/ForceResyncApi.md +1 -1
  61. data/docs/GenerateRemoteKeyRequest.md +1 -1
  62. data/docs/Group.md +12 -4
  63. data/docs/GroupsApi.md +19 -9
  64. data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
  65. data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
  66. data/docs/Issue.md +10 -8
  67. data/docs/IssuesApi.md +11 -9
  68. data/docs/LinkToken.md +4 -2
  69. data/docs/LinkTokenApi.md +1 -1
  70. data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
  71. data/docs/LinkedAccountCondition.md +28 -0
  72. data/docs/LinkedAccountConditionRequest.md +22 -0
  73. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  74. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  75. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  76. data/docs/LinkedAccountsApi.md +4 -2
  77. data/docs/Location.md +12 -6
  78. data/docs/LocationsApi.md +15 -9
  79. data/docs/MetaResponse.md +3 -1
  80. data/docs/ModelPermissionDeserializer.md +18 -0
  81. data/docs/ModelPermissionDeserializerRequest.md +18 -0
  82. data/docs/MultipartFormFieldRequest.md +1 -1
  83. data/docs/OperatorSchema.md +20 -0
  84. data/docs/PaginatedAuditLogEventList.md +22 -0
  85. data/docs/PaginatedConditionSchemaList.md +22 -0
  86. data/docs/PaginatedDependentList.md +22 -0
  87. data/docs/PaginatedEmployerBenefitList.md +22 -0
  88. data/docs/PaginatedTimesheetEntryList.md +22 -0
  89. data/docs/PatchedEditFieldMappingRequest.md +22 -0
  90. data/docs/PayGroup.md +9 -3
  91. data/docs/PayGroupsApi.md +4 -4
  92. data/docs/PayrollRun.md +11 -5
  93. data/docs/PayrollRunsApi.md +14 -10
  94. data/docs/RelationshipEnum.md +15 -0
  95. data/docs/RemoteData.md +1 -1
  96. data/docs/RemoteEndpointInfo.md +22 -0
  97. data/docs/RemoteFieldAPI.md +28 -0
  98. data/docs/RemoteFieldAPIResponse.md +48 -0
  99. data/docs/RemoteKeyForRegenerationRequest.md +1 -1
  100. data/docs/RemoteResponse.md +3 -1
  101. data/docs/ResponseTypeEnum.md +15 -0
  102. data/docs/RoleEnum.md +15 -0
  103. data/docs/ScopesApi.md +222 -0
  104. data/docs/SelectiveSyncApi.md +233 -0
  105. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  106. data/docs/SyncStatus.md +7 -5
  107. data/docs/SyncStatusApi.md +1 -1
  108. data/docs/Tax.md +12 -4
  109. data/docs/Team.md +10 -4
  110. data/docs/TeamsApi.md +4 -4
  111. data/docs/TimeOff.md +15 -9
  112. data/docs/TimeOffApi.md +24 -12
  113. data/docs/TimeOffBalance.md +12 -6
  114. data/docs/TimeOffBalancesApi.md +15 -11
  115. data/docs/TimeOffRequest.md +11 -9
  116. data/docs/TimesheetEntriesApi.md +341 -0
  117. data/docs/TimesheetEntry.md +38 -0
  118. data/docs/TimesheetEntryEndpointRequest.md +18 -0
  119. data/docs/TimesheetEntryRequest.md +28 -0
  120. data/docs/TimesheetEntryResponse.md +24 -0
  121. data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
  122. data/lib/merge_hris_client/api/audit_trail_api.rb +95 -0
  123. data/lib/merge_hris_client/api/bank_info_api.rb +26 -12
  124. data/lib/merge_hris_client/api/benefits_api.rb +6 -6
  125. data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
  126. data/lib/merge_hris_client/api/companies_api.rb +4 -4
  127. data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
  128. data/lib/merge_hris_client/api/dependents_api.rb +188 -0
  129. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
  130. data/lib/merge_hris_client/api/employees_api.rb +53 -17
  131. data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
  132. data/lib/merge_hris_client/api/employments_api.rb +24 -10
  133. data/lib/merge_hris_client/api/field_mapping_api.rb +424 -0
  134. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  135. data/lib/merge_hris_client/api/groups_api.rb +31 -8
  136. data/lib/merge_hris_client/api/issues_api.rb +13 -10
  137. data/lib/merge_hris_client/api/linked_accounts_api.rb +6 -3
  138. data/lib/merge_hris_client/api/locations_api.rb +29 -8
  139. data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
  140. data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
  141. data/lib/merge_hris_client/api/scopes_api.rb +209 -0
  142. data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
  143. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  144. data/lib/merge_hris_client/api/teams_api.rb +4 -4
  145. data/lib/merge_hris_client/api/time_off_api.rb +38 -12
  146. data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
  147. data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
  148. data/lib/merge_hris_client/configuration.rb +4 -0
  149. data/lib/merge_hris_client/models/account_details.rb +24 -4
  150. data/lib/merge_hris_client/models/account_details_and_actions.rb +39 -4
  151. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +17 -7
  152. data/lib/merge_hris_client/models/account_integration.rb +52 -8
  153. data/lib/merge_hris_client/models/account_type_enum.rb +17 -7
  154. data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
  155. data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
  156. data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
  157. data/lib/merge_hris_client/models/bank_info.rb +48 -17
  158. data/lib/merge_hris_client/models/benefit.rb +79 -15
  159. data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
  160. data/lib/merge_hris_client/models/categories_enum.rb +19 -7
  161. data/lib/merge_hris_client/models/category_enum.rb +19 -7
  162. data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
  163. data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
  164. data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
  165. data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
  166. data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
  167. data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
  168. data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
  169. data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
  170. data/lib/merge_hris_client/models/company.rb +46 -16
  171. data/lib/merge_hris_client/models/condition_schema.rb +298 -0
  172. data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
  173. data/lib/merge_hris_client/models/country_enum.rb +17 -7
  174. data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
  175. data/lib/merge_hris_client/models/data_passthrough_request.rb +5 -1
  176. data/lib/merge_hris_client/models/deduction.rb +59 -18
  177. data/lib/merge_hris_client/models/dependent.rb +478 -0
  178. data/lib/merge_hris_client/models/earning.rb +58 -17
  179. data/lib/merge_hris_client/models/earning_type_enum.rb +17 -7
  180. data/lib/merge_hris_client/models/employee.rb +93 -24
  181. data/lib/merge_hris_client/models/employee_payroll_run.rb +50 -18
  182. data/lib/merge_hris_client/models/employee_request.rb +56 -28
  183. data/lib/merge_hris_client/models/employer_benefit.rb +371 -0
  184. data/lib/merge_hris_client/models/employment.rb +53 -21
  185. data/lib/merge_hris_client/models/employment_status_enum.rb +17 -7
  186. data/lib/merge_hris_client/models/employment_type_enum.rb +17 -7
  187. data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
  188. data/lib/merge_hris_client/models/encoding_enum.rb +17 -7
  189. data/lib/merge_hris_client/models/end_user_details_request.rb +102 -11
  190. data/lib/merge_hris_client/models/ethnicity_enum.rb +17 -7
  191. data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
  192. data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
  193. data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
  194. data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
  195. data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
  196. data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
  197. data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
  198. data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
  199. data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
  200. data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
  201. data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
  202. data/lib/merge_hris_client/models/flsa_status_enum.rb +17 -7
  203. data/lib/merge_hris_client/models/gender_enum.rb +17 -7
  204. data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
  205. data/lib/merge_hris_client/models/group.rb +58 -17
  206. data/lib/merge_hris_client/models/group_type_enum.rb +18 -7
  207. data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
  208. data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
  209. data/lib/merge_hris_client/models/issue.rb +17 -5
  210. data/lib/merge_hris_client/models/issue_status_enum.rb +17 -7
  211. data/lib/merge_hris_client/models/link_token.rb +13 -9
  212. data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
  213. data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
  214. data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
  215. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
  216. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  217. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  218. data/lib/merge_hris_client/models/location.rb +48 -18
  219. data/lib/merge_hris_client/models/location_type_enum.rb +17 -7
  220. data/lib/merge_hris_client/models/marital_status_enum.rb +17 -7
  221. data/lib/merge_hris_client/models/meta_response.rb +13 -2
  222. data/lib/merge_hris_client/models/method_enum.rb +17 -7
  223. data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
  224. data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
  225. data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
  226. data/lib/merge_hris_client/models/operator_schema.rb +229 -0
  227. data/lib/merge_hris_client/models/paginated_audit_log_event_list.rb +240 -0
  228. data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
  229. data/lib/merge_hris_client/models/paginated_dependent_list.rb +240 -0
  230. data/lib/merge_hris_client/models/paginated_employer_benefit_list.rb +240 -0
  231. data/lib/merge_hris_client/models/paginated_timesheet_entry_list.rb +240 -0
  232. data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
  233. data/lib/merge_hris_client/models/pay_currency_enum.rb +17 -7
  234. data/lib/merge_hris_client/models/pay_frequency_enum.rb +18 -7
  235. data/lib/merge_hris_client/models/pay_group.rb +46 -16
  236. data/lib/merge_hris_client/models/pay_period_enum.rb +18 -7
  237. data/lib/merge_hris_client/models/payroll_run.rb +48 -18
  238. data/lib/merge_hris_client/models/policy_type_enum.rb +17 -7
  239. data/lib/merge_hris_client/models/reason_enum.rb +17 -7
  240. data/lib/merge_hris_client/models/relationship_enum.rb +46 -0
  241. data/lib/merge_hris_client/models/remote_data.rb +3 -4
  242. data/lib/merge_hris_client/models/remote_endpoint_info.rb +253 -0
  243. data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
  244. data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
  245. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
  246. data/lib/merge_hris_client/models/remote_response.rb +14 -11
  247. data/lib/merge_hris_client/models/request_format_enum.rb +17 -7
  248. data/lib/merge_hris_client/models/request_type_enum.rb +17 -7
  249. data/lib/merge_hris_client/models/response_type_enum.rb +45 -0
  250. data/lib/merge_hris_client/models/role_enum.rb +49 -0
  251. data/lib/merge_hris_client/models/run_state_enum.rb +17 -7
  252. data/lib/merge_hris_client/models/run_type_enum.rb +17 -7
  253. data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  254. data/lib/merge_hris_client/models/sync_status.rb +13 -14
  255. data/lib/merge_hris_client/models/sync_status_status_enum.rb +19 -7
  256. data/lib/merge_hris_client/models/tax.rb +57 -16
  257. data/lib/merge_hris_client/models/team.rb +47 -16
  258. data/lib/merge_hris_client/models/time_off.rb +51 -19
  259. data/lib/merge_hris_client/models/time_off_balance.rb +49 -18
  260. data/lib/merge_hris_client/models/time_off_request.rb +36 -21
  261. data/lib/merge_hris_client/models/time_off_status_enum.rb +17 -7
  262. data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
  263. data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
  264. data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
  265. data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
  266. data/lib/merge_hris_client/models/units_enum.rb +17 -7
  267. data/lib/merge_hris_client/version.rb +1 -1
  268. data/lib/merge_hris_client.rb +49 -4
  269. data/spec/api/async_passthrough_api_spec.rb +59 -0
  270. data/spec/api/audit_trail_api_spec.rb +51 -0
  271. data/spec/api/bank_info_api_spec.rb +8 -6
  272. data/spec/api/benefits_api_spec.rb +3 -3
  273. data/spec/api/common_model_scopes_api_spec.rb +58 -0
  274. data/spec/api/companies_api_spec.rb +2 -2
  275. data/spec/api/delete_account_api_spec.rb +2 -2
  276. data/spec/api/dependents_api_spec.rb +70 -0
  277. data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
  278. data/spec/api/employees_api_spec.rb +16 -6
  279. data/spec/api/employer_benefits_api_spec.rb +68 -0
  280. data/spec/api/employments_api_spec.rb +7 -5
  281. data/spec/api/field_mapping_api_spec.rb +107 -0
  282. data/spec/api/force_resync_api_spec.rb +1 -1
  283. data/spec/api/groups_api_spec.rb +9 -4
  284. data/spec/api/issues_api_spec.rb +6 -5
  285. data/spec/api/linked_accounts_api_spec.rb +2 -1
  286. data/spec/api/locations_api_spec.rb +7 -4
  287. data/spec/api/pay_groups_api_spec.rb +2 -2
  288. data/spec/api/payroll_runs_api_spec.rb +7 -5
  289. data/spec/api/scopes_api_spec.rb +68 -0
  290. data/spec/api/selective_sync_api_spec.rb +72 -0
  291. data/spec/api/sync_status_api_spec.rb +1 -1
  292. data/spec/api/teams_api_spec.rb +2 -2
  293. data/spec/api/time_off_api_spec.rb +12 -6
  294. data/spec/api/time_off_balances_api_spec.rb +7 -5
  295. data/spec/api/timesheet_entries_api_spec.rb +99 -0
  296. data/spec/models/account_details_and_actions_spec.rb +18 -0
  297. data/spec/models/account_details_spec.rb +12 -0
  298. data/spec/models/account_integration_spec.rb +24 -0
  299. data/spec/models/advanced_metadata_spec.rb +64 -0
  300. data/spec/models/async_passthrough_reciept_spec.rb +34 -0
  301. data/spec/models/audit_log_event_spec.rb +76 -0
  302. data/spec/models/bank_info_spec.rb +24 -0
  303. data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
  304. data/spec/models/benefit_spec.rb +42 -0
  305. data/spec/models/common_model_scope_api_spec.rb +34 -0
  306. data/spec/models/common_model_scope_data_spec.rb +40 -0
  307. data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
  308. data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
  309. data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
  310. data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
  311. data/spec/models/common_model_scopes_spec.rb +40 -0
  312. data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
  313. data/spec/models/company_spec.rb +24 -0
  314. data/spec/models/condition_schema_spec.rb +70 -0
  315. data/spec/models/condition_type_enum_spec.rb +28 -0
  316. data/spec/models/create_field_mapping_request_spec.rb +64 -0
  317. data/spec/models/deduction_spec.rb +30 -0
  318. data/spec/models/dependent_spec.rb +136 -0
  319. data/spec/models/earning_spec.rb +30 -0
  320. data/spec/models/employee_payroll_run_spec.rb +24 -0
  321. data/spec/models/employee_request_spec.rb +18 -6
  322. data/spec/models/employee_spec.rb +42 -0
  323. data/spec/models/employer_benefit_spec.rb +94 -0
  324. data/spec/models/employment_spec.rb +24 -0
  325. data/spec/models/enabled_actions_enum_spec.rb +28 -0
  326. data/spec/models/end_user_details_request_spec.rb +30 -0
  327. data/spec/models/event_type_enum_spec.rb +28 -0
  328. data/spec/models/external_target_field_api_response_spec.rb +124 -0
  329. data/spec/models/external_target_field_api_spec.rb +46 -0
  330. data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
  331. data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
  332. data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
  333. data/spec/models/field_mapping_api_instance_spec.rb +52 -0
  334. data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
  335. data/spec/models/field_mapping_instance_response_spec.rb +52 -0
  336. data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
  337. data/spec/models/field_permission_deserializer_spec.rb +40 -0
  338. data/spec/models/group_spec.rb +30 -0
  339. data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
  340. data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
  341. data/spec/models/issue_spec.rb +6 -0
  342. data/spec/models/link_token_spec.rb +6 -0
  343. data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -0
  344. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  345. data/spec/models/linked_account_condition_spec.rb +64 -0
  346. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  347. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  348. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  349. data/spec/models/location_spec.rb +24 -0
  350. data/spec/models/meta_response_spec.rb +6 -0
  351. data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
  352. data/spec/models/model_permission_deserializer_spec.rb +34 -0
  353. data/spec/models/operator_schema_spec.rb +40 -0
  354. data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
  355. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  356. data/spec/models/paginated_dependent_list_spec.rb +46 -0
  357. data/spec/models/paginated_employer_benefit_list_spec.rb +46 -0
  358. data/spec/models/paginated_timesheet_entry_list_spec.rb +46 -0
  359. data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
  360. data/spec/models/pay_group_spec.rb +24 -0
  361. data/spec/models/payroll_run_spec.rb +24 -0
  362. data/spec/models/relationship_enum_spec.rb +28 -0
  363. data/spec/models/remote_endpoint_info_spec.rb +46 -0
  364. data/spec/models/remote_field_api_response_spec.rb +124 -0
  365. data/spec/models/remote_field_api_spec.rb +64 -0
  366. data/spec/models/remote_response_spec.rb +6 -0
  367. data/spec/models/response_type_enum_spec.rb +28 -0
  368. data/spec/models/role_enum_spec.rb +28 -0
  369. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  370. data/spec/models/sync_status_spec.rb +6 -0
  371. data/spec/models/tax_spec.rb +30 -0
  372. data/spec/models/team_spec.rb +24 -0
  373. data/spec/models/time_off_balance_spec.rb +24 -0
  374. data/spec/models/time_off_request_spec.rb +12 -6
  375. data/spec/models/time_off_spec.rb +24 -0
  376. data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
  377. data/spec/models/timesheet_entry_request_spec.rb +64 -0
  378. data/spec/models/timesheet_entry_response_spec.rb +52 -0
  379. data/spec/models/timesheet_entry_spec.rb +94 -0
  380. metadata +368 -104
@@ -0,0 +1,341 @@
1
+ # MergeHRISClient::TimesheetEntriesApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**timesheet_entries_create**](TimesheetEntriesApi.md#timesheet_entries_create) | **POST** /timesheet-entries | |
8
+ | [**timesheet_entries_list**](TimesheetEntriesApi.md#timesheet_entries_list) | **GET** /timesheet-entries | |
9
+ | [**timesheet_entries_meta_post_retrieve**](TimesheetEntriesApi.md#timesheet_entries_meta_post_retrieve) | **GET** /timesheet-entries/meta/post | |
10
+ | [**timesheet_entries_retrieve**](TimesheetEntriesApi.md#timesheet_entries_retrieve) | **GET** /timesheet-entries/{id} | |
11
+
12
+
13
+ ## timesheet_entries_create
14
+
15
+ > <TimesheetEntryResponse> timesheet_entries_create(x_account_token, timesheet_entry_endpoint_request, opts)
16
+
17
+
18
+
19
+ Creates a `TimesheetEntry` object with the given values.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'merge_hris_client'
26
+ # setup authorization
27
+ MergeHRISClient.configure do |config|
28
+ # Configure API key authorization: tokenAuth
29
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
35
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
36
+ timesheet_entry_endpoint_request = MergeHRISClient::TimesheetEntryEndpointRequest.new({model: MergeHRISClient::TimesheetEntryRequest.new}) # TimesheetEntryEndpointRequest |
37
+ opts = {
38
+ is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
39
+ run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
40
+ }
41
+
42
+ begin
43
+
44
+ result = api_instance.timesheet_entries_create(x_account_token, timesheet_entry_endpoint_request, opts)
45
+ p result
46
+ rescue MergeHRISClient::ApiError => e
47
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_create: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the timesheet_entries_create_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<TimesheetEntryResponse>, Integer, Hash)> timesheet_entries_create_with_http_info(x_account_token, timesheet_entry_endpoint_request, opts)
56
+
57
+ ```ruby
58
+ begin
59
+
60
+ data, status_code, headers = api_instance.timesheet_entries_create_with_http_info(x_account_token, timesheet_entry_endpoint_request, opts)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <TimesheetEntryResponse>
64
+ rescue MergeHRISClient::ApiError => e
65
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_create_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **x_account_token** | **String** | Token identifying the end user. | |
74
+ | **timesheet_entry_endpoint_request** | [**TimesheetEntryEndpointRequest**](TimesheetEntryEndpointRequest.md) | | |
75
+ | **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
76
+ | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
77
+
78
+ ### Return type
79
+
80
+ [**TimesheetEntryResponse**](TimesheetEntryResponse.md)
81
+
82
+ ### Authorization
83
+
84
+ [tokenAuth](../README.md#tokenAuth)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
89
+ - **Accept**: application/json
90
+
91
+
92
+ ## timesheet_entries_list
93
+
94
+ > <PaginatedTimesheetEntryList> timesheet_entries_list(x_account_token, opts)
95
+
96
+
97
+
98
+ Returns a list of `TimesheetEntry` objects.
99
+
100
+ ### Examples
101
+
102
+ ```ruby
103
+ require 'time'
104
+ require 'merge_hris_client'
105
+ # setup authorization
106
+ MergeHRISClient.configure do |config|
107
+ # Configure API key authorization: tokenAuth
108
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
109
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
110
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
111
+ end
112
+
113
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
114
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
115
+ opts = {
116
+ created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
117
+ created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
118
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
119
+ employee_id: 'employee_id_example', # String | If provided, will only return timesheet entries for this employee.
120
+ ended_after: 'ended_after_example', # String | If provided, will only return timesheet entries ended after this datetime.
121
+ ended_before: 'ended_before_example', # String | If provided, will only return timesheet entries ended before this datetime.
122
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
123
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
124
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
125
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
126
+ order_by: '-start_time', # String | Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
127
+ page_size: 56, # Integer | Number of results to return per page.
128
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
129
+ started_after: 'started_after_example', # String | If provided, will only return timesheet entries started after this datetime.
130
+ started_before: 'started_before_example' # String | If provided, will only return timesheet entries started before this datetime.
131
+ }
132
+
133
+ begin
134
+
135
+ result = api_instance.timesheet_entries_list(x_account_token, opts)
136
+ p result
137
+ rescue MergeHRISClient::ApiError => e
138
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_list: #{e}"
139
+ end
140
+ ```
141
+
142
+ #### Using the timesheet_entries_list_with_http_info variant
143
+
144
+ This returns an Array which contains the response data, status code and headers.
145
+
146
+ > <Array(<PaginatedTimesheetEntryList>, Integer, Hash)> timesheet_entries_list_with_http_info(x_account_token, opts)
147
+
148
+ ```ruby
149
+ begin
150
+
151
+ data, status_code, headers = api_instance.timesheet_entries_list_with_http_info(x_account_token, opts)
152
+ p status_code # => 2xx
153
+ p headers # => { ... }
154
+ p data # => <PaginatedTimesheetEntryList>
155
+ rescue MergeHRISClient::ApiError => e
156
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_list_with_http_info: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ | Name | Type | Description | Notes |
163
+ | ---- | ---- | ----------- | ----- |
164
+ | **x_account_token** | **String** | Token identifying the end user. | |
165
+ | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
166
+ | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
167
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
168
+ | **employee_id** | **String** | If provided, will only return timesheet entries for this employee. | [optional] |
169
+ | **ended_after** | **String** | If provided, will only return timesheet entries ended after this datetime. | [optional] |
170
+ | **ended_before** | **String** | If provided, will only return timesheet entries ended before this datetime. | [optional] |
171
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
172
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
173
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
174
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
175
+ | **order_by** | **String** | Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. | [optional] |
176
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
177
+ | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
178
+ | **started_after** | **String** | If provided, will only return timesheet entries started after this datetime. | [optional] |
179
+ | **started_before** | **String** | If provided, will only return timesheet entries started before this datetime. | [optional] |
180
+
181
+ ### Return type
182
+
183
+ [**PaginatedTimesheetEntryList**](PaginatedTimesheetEntryList.md)
184
+
185
+ ### Authorization
186
+
187
+ [tokenAuth](../README.md#tokenAuth)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: Not defined
192
+ - **Accept**: application/json
193
+
194
+
195
+ ## timesheet_entries_meta_post_retrieve
196
+
197
+ > <MetaResponse> timesheet_entries_meta_post_retrieve(x_account_token)
198
+
199
+
200
+
201
+ Returns metadata for `TimesheetEntry` POSTs.
202
+
203
+ ### Examples
204
+
205
+ ```ruby
206
+ require 'time'
207
+ require 'merge_hris_client'
208
+ # setup authorization
209
+ MergeHRISClient.configure do |config|
210
+ # Configure API key authorization: tokenAuth
211
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
214
+ end
215
+
216
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
217
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
218
+
219
+ begin
220
+
221
+ result = api_instance.timesheet_entries_meta_post_retrieve(x_account_token)
222
+ p result
223
+ rescue MergeHRISClient::ApiError => e
224
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_meta_post_retrieve: #{e}"
225
+ end
226
+ ```
227
+
228
+ #### Using the timesheet_entries_meta_post_retrieve_with_http_info variant
229
+
230
+ This returns an Array which contains the response data, status code and headers.
231
+
232
+ > <Array(<MetaResponse>, Integer, Hash)> timesheet_entries_meta_post_retrieve_with_http_info(x_account_token)
233
+
234
+ ```ruby
235
+ begin
236
+
237
+ data, status_code, headers = api_instance.timesheet_entries_meta_post_retrieve_with_http_info(x_account_token)
238
+ p status_code # => 2xx
239
+ p headers # => { ... }
240
+ p data # => <MetaResponse>
241
+ rescue MergeHRISClient::ApiError => e
242
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_meta_post_retrieve_with_http_info: #{e}"
243
+ end
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+ | Name | Type | Description | Notes |
249
+ | ---- | ---- | ----------- | ----- |
250
+ | **x_account_token** | **String** | Token identifying the end user. | |
251
+
252
+ ### Return type
253
+
254
+ [**MetaResponse**](MetaResponse.md)
255
+
256
+ ### Authorization
257
+
258
+ [tokenAuth](../README.md#tokenAuth)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: Not defined
263
+ - **Accept**: application/json
264
+
265
+
266
+ ## timesheet_entries_retrieve
267
+
268
+ > <TimesheetEntry> timesheet_entries_retrieve(x_account_token, id, opts)
269
+
270
+
271
+
272
+ Returns a `TimesheetEntry` object with the given `id`.
273
+
274
+ ### Examples
275
+
276
+ ```ruby
277
+ require 'time'
278
+ require 'merge_hris_client'
279
+ # setup authorization
280
+ MergeHRISClient.configure do |config|
281
+ # Configure API key authorization: tokenAuth
282
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
285
+ end
286
+
287
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
288
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
289
+ id = TODO # String |
290
+ opts = {
291
+ include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
292
+ }
293
+
294
+ begin
295
+
296
+ result = api_instance.timesheet_entries_retrieve(x_account_token, id, opts)
297
+ p result
298
+ rescue MergeHRISClient::ApiError => e
299
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_retrieve: #{e}"
300
+ end
301
+ ```
302
+
303
+ #### Using the timesheet_entries_retrieve_with_http_info variant
304
+
305
+ This returns an Array which contains the response data, status code and headers.
306
+
307
+ > <Array(<TimesheetEntry>, Integer, Hash)> timesheet_entries_retrieve_with_http_info(x_account_token, id, opts)
308
+
309
+ ```ruby
310
+ begin
311
+
312
+ data, status_code, headers = api_instance.timesheet_entries_retrieve_with_http_info(x_account_token, id, opts)
313
+ p status_code # => 2xx
314
+ p headers # => { ... }
315
+ p data # => <TimesheetEntry>
316
+ rescue MergeHRISClient::ApiError => e
317
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_retrieve_with_http_info: #{e}"
318
+ end
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ | Name | Type | Description | Notes |
324
+ | ---- | ---- | ----------- | ----- |
325
+ | **x_account_token** | **String** | Token identifying the end user. | |
326
+ | **id** | [**String**](.md) | | |
327
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
328
+
329
+ ### Return type
330
+
331
+ [**TimesheetEntry**](TimesheetEntry.md)
332
+
333
+ ### Authorization
334
+
335
+ [tokenAuth](../README.md#tokenAuth)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: Not defined
340
+ - **Accept**: application/json
341
+
@@ -0,0 +1,38 @@
1
+ # MergeHRISClient::TimesheetEntry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
10
+ | **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
11
+ | **employee** | **String** | The employee the timesheet entry is for. | [optional] |
12
+ | **hours_worked** | **Float** | The number of hours logged by the employee. | [optional] |
13
+ | **start_time** | **Time** | The time at which the employee started work. | [optional] |
14
+ | **end_time** | **Time** | The time at which the employee ended work. | [optional] |
15
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
16
+ | **field_mappings** | **Object** | | [optional][readonly] |
17
+ | **remote_data** | **Array&lt;Hash&lt;String, AnyType&gt;&gt;** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'merge_hris_client'
23
+
24
+ instance = MergeHRISClient::TimesheetEntry.new(
25
+ id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
26
+ remote_id: 19202938,
27
+ created_at: 2021-09-15T00:00Z,
28
+ modified_at: 2021-10-16T00:00Z,
29
+ employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
30
+ hours_worked: 10.0,
31
+ start_time: 2020-11-10T00:00Z,
32
+ end_time: 2020-11-10T00:10Z,
33
+ remote_was_deleted: null,
34
+ field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
35
+ remote_data: [{&quot;path&quot;:&quot;/dependent&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
36
+ )
37
+ ```
38
+
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::TimesheetEntryEndpointRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**TimesheetEntryRequest**](TimesheetEntryRequest.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::TimesheetEntryEndpointRequest.new(
15
+ model: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,28 @@
1
+ # MergeHRISClient::TimesheetEntryRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **employee** | **String** | The employee the timesheet entry is for. | [optional] |
8
+ | **hours_worked** | **Float** | The number of hours logged by the employee. | [optional] |
9
+ | **start_time** | **Time** | The time at which the employee started work. | [optional] |
10
+ | **end_time** | **Time** | The time at which the employee ended work. | [optional] |
11
+ | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
12
+ | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'merge_hris_client'
18
+
19
+ instance = MergeHRISClient::TimesheetEntryRequest.new(
20
+ employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
21
+ hours_worked: 10.0,
22
+ start_time: 2020-11-10T00:00Z,
23
+ end_time: 2020-11-10T00:10Z,
24
+ integration_params: {&quot;unique_integration_field&quot;:&quot;unique_integration_field_value&quot;},
25
+ linked_account_params: {&quot;unique_linked_account_field&quot;:&quot;unique_linked_account_field_value&quot;}
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::TimesheetEntryResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**TimesheetEntry**](TimesheetEntry.md) | | |
8
+ | **warnings** | [**Array&lt;WarningValidationProblem&gt;**](WarningValidationProblem.md) | | |
9
+ | **errors** | [**Array&lt;ErrorValidationProblem&gt;**](ErrorValidationProblem.md) | | |
10
+ | **logs** | [**Array&lt;DebugModeLog&gt;**](DebugModeLog.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::TimesheetEntryResponse.new(
18
+ model: null,
19
+ warnings: null,
20
+ errors: null,
21
+ logs: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,160 @@
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 AsyncPassthroughApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Asynchronously pull data from an endpoint not currently supported by Merge.
23
+ # @param x_account_token [String] Token identifying the end user.
24
+ # @param data_passthrough_request [DataPassthroughRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [AsyncPassthroughReciept]
27
+ def async_passthrough_create(x_account_token, data_passthrough_request, opts = {})
28
+ data, _status_code, _headers = async_passthrough_create_with_http_info(x_account_token, data_passthrough_request, opts)
29
+ data
30
+ end
31
+
32
+ # Asynchronously pull data from an endpoint not currently supported by Merge.
33
+ # @param x_account_token [String] Token identifying the end user.
34
+ # @param data_passthrough_request [DataPassthroughRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(AsyncPassthroughReciept, Integer, Hash)>] AsyncPassthroughReciept data, response status code and response headers
37
+ def async_passthrough_create_with_http_info(x_account_token, data_passthrough_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: AsyncPassthroughApi.async_passthrough_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 AsyncPassthroughApi.async_passthrough_create"
44
+ end
45
+ # verify the required parameter 'data_passthrough_request' is set
46
+ if @api_client.config.client_side_validation && data_passthrough_request.nil?
47
+ fail ArgumentError, "Missing the required parameter 'data_passthrough_request' when calling AsyncPassthroughApi.async_passthrough_create"
48
+ end
49
+ # resource path
50
+ local_var_path = '/async-passthrough'
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(data_passthrough_request)
68
+
69
+ # return_type
70
+ return_type = opts[:debug_return_type] || 'AsyncPassthroughReciept'
71
+
72
+ # auth_names
73
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
74
+
75
+ new_options = opts.merge(
76
+ :operation => :"AsyncPassthroughApi.async_passthrough_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: AsyncPassthroughApi#async_passthrough_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
92
+ # Retrieves data from earlier async-passthrough POST request
93
+ # @param x_account_token [String] Token identifying the end user.
94
+ # @param async_passthrough_receipt_id [String]
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [RemoteResponse]
97
+ def async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id, opts = {})
98
+ data, _status_code, _headers = async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id, opts)
99
+ data
100
+ end
101
+
102
+ # Retrieves data from earlier async-passthrough POST request
103
+ # @param x_account_token [String] Token identifying the end user.
104
+ # @param async_passthrough_receipt_id [String]
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(RemoteResponse, Integer, Hash)>] RemoteResponse data, response status code and response headers
107
+ def async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug 'Calling API: AsyncPassthroughApi.async_passthrough_retrieve ...'
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 AsyncPassthroughApi.async_passthrough_retrieve"
114
+ end
115
+ # verify the required parameter 'async_passthrough_receipt_id' is set
116
+ if @api_client.config.client_side_validation && async_passthrough_receipt_id.nil?
117
+ fail ArgumentError, "Missing the required parameter 'async_passthrough_receipt_id' when calling AsyncPassthroughApi.async_passthrough_retrieve"
118
+ end
119
+ # resource path
120
+ local_var_path = '/async-passthrough/{async_passthrough_receipt_id}'.sub('{' + 'async_passthrough_receipt_id' + '}', CGI.escape(async_passthrough_receipt_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] || 'RemoteResponse'
139
+
140
+ # auth_names
141
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
142
+
143
+ new_options = opts.merge(
144
+ :operation => :"AsyncPassthroughApi.async_passthrough_retrieve",
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(:GET, local_var_path, new_options)
154
+ if @api_client.config.debugging
155
+ @api_client.config.logger.debug "API called: AsyncPassthroughApi#async_passthrough_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
156
+ end
157
+ return data, status_code, headers
158
+ end
159
+ end
160
+ end