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,24 @@
1
+ # MergeHRISClient::FieldMappingApiInstance
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **is_integration_wide** | **Boolean** | | [optional][readonly] |
9
+ | **target_field** | [**FieldMappingApiInstanceTargetField**](FieldMappingApiInstanceTargetField.md) | | [optional] |
10
+ | **remote_field** | [**FieldMappingApiInstanceRemoteField**](FieldMappingApiInstanceRemoteField.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::FieldMappingApiInstance.new(
18
+ id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
19
+ is_integration_wide: null,
20
+ target_field: null,
21
+ remote_field: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::FieldMappingApiInstanceRemoteField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **remote_key_name** | **String** | | |
8
+ | **schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
9
+ | **remote_endpoint_info** | [**FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo**](FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::FieldMappingApiInstanceRemoteField.new(
17
+ remote_key_name: null,
18
+ schema: null,
19
+ remote_endpoint_info: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **method** | **String** | | |
8
+ | **url_path** | **String** | | |
9
+ | **field_traversal_path** | **Array<String>** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.new(
17
+ method: null,
18
+ url_path: null,
19
+ field_traversal_path: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,48 @@
1
+ # MergeHRISClient::FieldMappingApiInstanceResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **benefit** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
8
+ | **employer_benefit** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
9
+ | **company** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
10
+ | **employee_payroll_run** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
11
+ | **employee** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
12
+ | **employment** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
13
+ | **location** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
14
+ | **payroll_run** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
15
+ | **team** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
16
+ | **time_off** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
17
+ | **time_off_balance** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
18
+ | **bank_info** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
19
+ | **pay_group** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
20
+ | **group** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
21
+ | **dependent** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
22
+ | **timesheet_entry** | [**Array<FieldMappingApiInstance>**](FieldMappingApiInstance.md) | | [optional] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'merge_hris_client'
28
+
29
+ instance = MergeHRISClient::FieldMappingApiInstanceResponse.new(
30
+ benefit: null,
31
+ employer_benefit: null,
32
+ company: null,
33
+ employee_payroll_run: null,
34
+ employee: null,
35
+ employment: null,
36
+ location: null,
37
+ payroll_run: null,
38
+ team: null,
39
+ time_off: null,
40
+ time_off_balance: null,
41
+ bank_info: null,
42
+ pay_group: null,
43
+ group: null,
44
+ dependent: null,
45
+ timesheet_entry: null
46
+ )
47
+ ```
48
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::FieldMappingApiInstanceTargetField
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **description** | **String** | | |
9
+ | **is_organization_wide** | **Boolean** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::FieldMappingApiInstanceTargetField.new(
17
+ name: null,
18
+ description: null,
19
+ is_organization_wide: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::FieldMappingInstanceResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**FieldMappingApiInstance**](FieldMappingApiInstance.md) | | |
8
+ | **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
9
+ | **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
10
+ | **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::FieldMappingInstanceResponse.new(
18
+ model: null,
19
+ warnings: null,
20
+ errors: null,
21
+ logs: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::FieldPermissionDeserializer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
8
+ | **disabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::FieldPermissionDeserializer.new(
16
+ enabled: null,
17
+ disabled: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::FieldPermissionDeserializerRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
8
+ | **disabled** | [**Array<AnyType>**](AnyType.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::FieldPermissionDeserializerRequest.new(
16
+ enabled: null,
17
+ disabled: null
18
+ )
19
+ ```
20
+
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
13
13
 
14
14
 
15
15
 
16
- Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
16
+ 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.
17
17
 
18
18
  ### Examples
19
19
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | |
7
+ | **name** | **String** | The name of the remote key | |
8
8
 
9
9
  ## Example
10
10
 
data/docs/Group.md CHANGED
@@ -6,11 +6,15 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
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] |
9
11
  | **parent_group** | **String** | The parent group for this group. | [optional] |
10
12
  | **name** | **String** | The group name. | [optional] |
11
- | **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The group type | [optional] |
13
+ | **type** | [**GroupTypeEnum**](GroupTypeEnum.md) | The Group type returned directly from the third-party. * `TEAM` - TEAM * `DEPARTMENT` - DEPARTMENT * `COST_CENTER` - COST_CENTER * `BUSINESS_UNIT` - BUSINESS_UNIT * `GROUP` - GROUP | [optional] |
14
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
15
+ | **is_commonly_used_as_team** | **Boolean** | Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct. | [optional] |
16
+ | **field_mappings** | **Object** | | [optional][readonly] |
12
17
  | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
13
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
14
18
 
15
19
  ## Example
16
20
 
@@ -20,11 +24,15 @@ require 'merge_hris_client'
20
24
  instance = MergeHRISClient::Group.new(
21
25
  id: 134e0111-0f67-44f6-98f0-597000290bb3,
22
26
  remote_id: 800293,
27
+ created_at: 2021-09-15T00:00Z,
28
+ modified_at: 2021-10-16T00:00Z,
23
29
  parent_group: 2ef51b11-2c4e-4b02-8d1d-50592d9e96ef,
24
30
  name: COST_CENTER_US,
25
31
  type: COST_CENTER,
26
- remote_data: [{"path":"/group","data":["Varies by platform"]}],
27
- remote_was_deleted: null
32
+ remote_was_deleted: null,
33
+ is_commonly_used_as_team: true,
34
+ field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
35
+ remote_data: [{"path":"/group","data":["Varies by platform"]}]
28
36
  )
29
37
  ```
30
38
 
data/docs/GroupsApi.md CHANGED
@@ -37,11 +37,15 @@ opts = {
37
37
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
38
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
39
39
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
40
- modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
41
- modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
40
+ is_commonly_used_as_team: 'is_commonly_used_as_team_example', # String | 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.
41
+ 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.
42
+ 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.
43
+ names: 'names_example', # String | If provided, will only return groups with these names. Multiple values can be separated by commas.
42
44
  page_size: 56, # Integer | Number of results to return per page.
43
- remote_fields: 'type', # String | Which fields should be returned in non-normalized form.
44
- remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
45
+ remote_fields: 'type', # String | Deprecated. Use show_enum_origins.
46
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
47
+ show_enum_origins: 'type', # String | 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)
48
+ types: 'types_example' # String | If provided, will only return groups of these types. Multiple values can be separated by commas.
45
49
  }
46
50
 
47
51
  begin
@@ -81,11 +85,15 @@ end
81
85
  | **cursor** | **String** | The pagination cursor value. | [optional] |
82
86
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
83
87
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
84
- | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
85
- | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
88
+ | **is_commonly_used_as_team** | **String** | 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. | [optional] |
89
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
90
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
91
+ | **names** | **String** | If provided, will only return groups with these names. Multiple values can be separated by commas. | [optional] |
86
92
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
87
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
93
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
88
94
  | **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
95
+ | **show_enum_origins** | **String** | 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) | [optional] |
96
+ | **types** | **String** | If provided, will only return groups of these types. Multiple values can be separated by commas. | [optional] |
89
97
 
90
98
  ### Return type
91
99
 
@@ -127,7 +135,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
127
135
  id = TODO # String |
128
136
  opts = {
129
137
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
130
- remote_fields: 'type' # String | Which fields should be returned in non-normalized form.
138
+ remote_fields: 'type', # String | Deprecated. Use show_enum_origins.
139
+ show_enum_origins: 'type' # String | 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)
131
140
  }
132
141
 
133
142
  begin
@@ -164,7 +173,8 @@ end
164
173
  | **x_account_token** | **String** | Token identifying the end user. | |
165
174
  | **id** | [**String**](.md) | | |
166
175
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
167
- | **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
176
+ | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
177
+ | **show_enum_origins** | **String** | 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) | [optional] |
168
178
 
169
179
  ### Return type
170
180
 
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::IndividualCommonModelScopeDeserializer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model_name** | **String** | | |
8
+ | **model_permissions** | [**Hash<String, ModelPermissionDeserializer>**](ModelPermissionDeserializer.md) | | [optional] |
9
+ | **field_permissions** | [**FieldPermissionDeserializer**](FieldPermissionDeserializer.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::IndividualCommonModelScopeDeserializer.new(
17
+ model_name: null,
18
+ model_permissions: null,
19
+ field_permissions: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::IndividualCommonModelScopeDeserializerRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model_name** | **String** | | |
8
+ | **model_permissions** | [**Hash<String, ModelPermissionDeserializerRequest>**](ModelPermissionDeserializerRequest.md) | | [optional] |
9
+ | **field_permissions** | [**FieldPermissionDeserializerRequest**](FieldPermissionDeserializerRequest.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::IndividualCommonModelScopeDeserializerRequest.new(
17
+ model_name: null,
18
+ model_permissions: null,
19
+ field_permissions: null
20
+ )
21
+ ```
22
+
data/docs/Issue.md CHANGED
@@ -5,12 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
- | **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | | [optional] |
8
+ | **status** | [**IssueStatusEnum**](IssueStatusEnum.md) | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
9
9
  | **error_description** | **String** | | |
10
10
  | **end_user** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
11
11
  | **first_incident_time** | **Time** | | [optional] |
12
12
  | **last_incident_time** | **Time** | | [optional] |
13
13
  | **is_muted** | **Boolean** | | [optional][readonly] |
14
+ | **error_details** | **Array<String>** | | [optional][readonly] |
14
15
 
15
16
  ## Example
16
17
 
@@ -18,13 +19,14 @@
18
19
  require 'merge_hris_client'
19
20
 
20
21
  instance = MergeHRISClient::Issue.new(
21
- id: null,
22
- status: null,
23
- error_description: null,
24
- end_user: null,
25
- first_incident_time: null,
26
- last_incident_time: null,
27
- is_muted: null
22
+ id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
23
+ status: ONGOING,
24
+ error_description: Missing Permissions,
25
+ end_user: b82302de-852e-4e60-b050-edf9da3b7c02,
26
+ first_incident_time: 2022-12-05T16:19:15.161Z,
27
+ last_incident_time: 2022-12-05T16:19:15.161Z,
28
+ is_muted: true,
29
+ error_details: ["Missing employee permissions.","Missing time off permissions."]
28
30
  )
29
31
  ```
30
32
 
data/docs/IssuesApi.md CHANGED
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
14
14
 
15
15
 
16
16
 
17
- Gets issues.
17
+ Gets all issues for Organization.
18
18
 
19
19
  ### Examples
20
20
 
@@ -37,13 +37,14 @@ opts = {
37
37
  end_user_organization_name: 'end_user_organization_name_example', # String |
38
38
  first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
39
39
  first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
40
- include_muted: 'include_muted_example', # String | If True, will include muted issues
40
+ include_muted: 'include_muted_example', # String | If true, will include muted issues
41
41
  integration_name: 'integration_name_example', # String |
42
- last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
43
- last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
42
+ last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was after this datetime.
43
+ last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose last incident time was before this datetime.
44
+ linked_account_id: 'linked_account_id_example', # String | If provided, will only include issues pertaining to the linked account passed in.
44
45
  page_size: 56, # Integer | Number of results to return per page.
45
46
  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
46
- status: 'ONGOING' # String |
47
+ status: 'ONGOING' # String | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
47
48
  }
48
49
 
49
50
  begin
@@ -83,13 +84,14 @@ end
83
84
  | **end_user_organization_name** | **String** | | [optional] |
84
85
  | **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
85
86
  | **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
86
- | **include_muted** | **String** | If True, will include muted issues | [optional] |
87
+ | **include_muted** | **String** | If true, will include muted issues | [optional] |
87
88
  | **integration_name** | **String** | | [optional] |
88
- | **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
89
- | **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
89
+ | **last_incident_time_after** | **Time** | If provided, will only return issues whose last incident time was after this datetime. | [optional] |
90
+ | **last_incident_time_before** | **Time** | If provided, will only return issues whose last incident time was before this datetime. | [optional] |
91
+ | **linked_account_id** | **String** | If provided, will only include issues pertaining to the linked account passed in. | [optional] |
90
92
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
91
93
  | **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
92
- | **status** | **String** | | [optional] |
94
+ | **status** | **String** | Status of the issue. Options: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
93
95
 
94
96
  ### Return type
95
97
 
data/docs/LinkToken.md CHANGED
@@ -5,7 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **link_token** | **String** | | |
8
- | **integration_name** | **String** | | |
8
+ | **integration_name** | **String** | | [optional] |
9
+ | **magic_link_url** | **String** | | [optional] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'merge_hris_client'
14
15
 
15
16
  instance = MergeHRISClient::LinkToken.new(
16
17
  link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
17
- integration_name: Lever
18
+ integration_name: Lever,
19
+ magic_link_url: https://link.merge.dev/asdfjkl12345jsndfgi2i83n
18
20
  )
19
21
  ```
20
22
 
data/docs/LinkTokenApi.md CHANGED
@@ -29,7 +29,7 @@ MergeHRISClient.configure do |config|
29
29
  end
30
30
 
31
31
  api_instance = MergeHRISClient::LinkTokenApi.new
32
- end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest |
32
+ end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'example@gmail.com', end_user_organization_name: 'Test Organization', end_user_origin_id: '12345', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest |
33
33
 
34
34
  begin
35
35
 
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **common_models** | [**Array<IndividualCommonModelScopeDeserializerRequest>**](IndividualCommonModelScopeDeserializerRequest.md) | The common models you want to update the scopes for | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest.new(
15
+ common_models: [{"model_name":"Employee","model_permissions":{"READ":{"is_enabled":true},"WRITE":{"is_enabled":false}},"field_permissions":{"enabled_fields":["avatar","home_location"],"disabled_fields":["work_location"]}},{"model_name":"Benefit","model_permissions":{"WRITE":{"is_enabled":false}}}]
16
+ )
17
+ ```
18
+
@@ -0,0 +1,28 @@
1
+ # MergeHRISClient::LinkedAccountCondition
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
8
+ | **common_model** | **String** | The common model for a specific condition. | [optional][readonly] |
9
+ | **native_name** | **String** | User-facing *native condition* name. e.g. \"Skip Manager\". | |
10
+ | **operator** | **String** | The operator for a specific condition. | |
11
+ | **value** | [**AnyType**](.md) | The value for a condition. | [optional][readonly] |
12
+ | **field_name** | **String** | The name of the field on the common model that this condition corresponds to, if they conceptually match. e.g. \"location_type\". | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'merge_hris_client'
18
+
19
+ instance = MergeHRISClient::LinkedAccountCondition.new(
20
+ condition_schema_id: null,
21
+ common_model: null,
22
+ native_name: null,
23
+ operator: null,
24
+ value: null,
25
+ field_name: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::LinkedAccountConditionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **condition_schema_id** | **String** | The ID indicating which condition schema to use for a specific condition. | |
8
+ | **operator** | **String** | The operator for a specific condition. | |
9
+ | **value** | [**AnyType**](.md) | The value for a specific condition. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::LinkedAccountConditionRequest.new(
17
+ condition_schema_id: null,
18
+ operator: null,
19
+ value: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::LinkedAccountSelectiveSyncConfiguration
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **linked_account_conditions** | [**Array<LinkedAccountCondition>**](LinkedAccountCondition.md) | The conditions belonging to a selective sync. | [optional][readonly] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::LinkedAccountSelectiveSyncConfiguration.new(
15
+ linked_account_conditions: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sync_configurations** | [**Array<LinkedAccountSelectiveSyncConfigurationRequest>**](LinkedAccountSelectiveSyncConfigurationRequest.md) | The selective syncs associated with a linked account. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest.new(
15
+ sync_configurations: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **linked_account_conditions** | [**Array<LinkedAccountConditionRequest>**](LinkedAccountConditionRequest.md) | The conditions belonging to a selective sync. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest.new(
15
+ linked_account_conditions: null
16
+ )
17
+ ```
18
+