merge_hris_client 1.0.2 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (318) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +59 -19
  3. data/docs/AccountDetails.md +30 -0
  4. data/docs/AccountDetailsAndActions.md +32 -0
  5. data/docs/AccountDetailsAndActionsIntegration.md +32 -0
  6. data/docs/AccountDetailsAndActionsStatusEnum.md +15 -0
  7. data/docs/AccountDetailsApi.md +76 -0
  8. data/docs/AccountIntegration.md +4 -4
  9. data/docs/AccountTokenApi.md +2 -2
  10. data/docs/AccountTypeEnum.md +15 -0
  11. data/docs/AvailableActionsApi.md +2 -2
  12. data/docs/BankInfo.md +34 -0
  13. data/docs/BankInfoApi.md +189 -0
  14. data/docs/Benefit.md +2 -2
  15. data/docs/BenefitsApi.md +6 -82
  16. data/docs/CategoriesEnum.md +15 -0
  17. data/docs/{StateEnum.md → CategoryEnum.md} +2 -2
  18. data/docs/CompaniesApi.md +6 -4
  19. data/docs/DataPassthroughRequest.md +7 -3
  20. data/docs/DebugModeLog.md +22 -0
  21. data/docs/DebugModelLogSummary.md +22 -0
  22. data/docs/Deduction.md +2 -2
  23. data/docs/DeductionsApi.md +179 -0
  24. data/docs/DeleteAccountApi.md +3 -2
  25. data/docs/Earning.md +3 -3
  26. data/docs/EarningTypeEnum.md +15 -0
  27. data/docs/Employee.md +20 -14
  28. data/docs/EmployeeEndpointRequest.md +18 -0
  29. data/docs/EmployeePayrollRun.md +5 -5
  30. data/docs/EmployeePayrollRunsApi.md +17 -7
  31. data/docs/EmployeeRequest.md +21 -13
  32. data/docs/EmployeeResponse.md +24 -0
  33. data/docs/EmployeesApi.md +101 -17
  34. data/docs/Employment.md +3 -1
  35. data/docs/EmploymentsApi.md +12 -82
  36. data/docs/EncodingEnum.md +15 -0
  37. data/docs/EndUserDetailsRequest.md +4 -2
  38. data/docs/ErrorValidationProblem.md +24 -0
  39. data/docs/ForceResyncApi.md +79 -0
  40. data/docs/GenerateKeyApi.md +2 -2
  41. data/docs/Group.md +28 -0
  42. data/docs/GroupTypeEnum.md +15 -0
  43. data/docs/GroupsApi.md +177 -0
  44. data/docs/IgnoreCommonModel.md +20 -0
  45. data/docs/IgnoreCommonModelRequest.md +20 -0
  46. data/docs/IssuesApi.md +16 -14
  47. data/docs/LinkTokenApi.md +3 -3
  48. data/docs/LinkedAccountsApi.md +103 -0
  49. data/docs/Location.md +4 -0
  50. data/docs/LocationTypeEnum.md +15 -0
  51. data/docs/LocationsApi.md +6 -4
  52. data/docs/MultipartFormFieldRequest.md +26 -0
  53. data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
  54. data/docs/PaginatedBankInfoList.md +22 -0
  55. data/docs/PaginatedDeductionList.md +22 -0
  56. data/docs/PaginatedGroupList.md +22 -0
  57. data/docs/PaginatedIssueList.md +2 -2
  58. data/docs/PaginatedPayGroupList.md +22 -0
  59. data/docs/PaginatedSyncStatusList.md +2 -2
  60. data/docs/PassthroughApi.md +2 -2
  61. data/docs/PayGroup.md +24 -0
  62. data/docs/PayGroupsApi.md +177 -0
  63. data/docs/PayrollRun.md +3 -3
  64. data/docs/PayrollRunsApi.md +17 -5
  65. data/docs/PolicyTypeEnum.md +15 -0
  66. data/docs/{NullEnum.md → ReasonEnum.md} +2 -2
  67. data/docs/RegenerateKeyApi.md +2 -2
  68. data/docs/RequestFormatEnum.md +15 -0
  69. data/docs/SyncStatusApi.md +3 -75
  70. data/docs/Tax.md +2 -2
  71. data/docs/Team.md +1 -1
  72. data/docs/TeamsApi.md +12 -6
  73. data/docs/TimeOff.md +5 -5
  74. data/docs/TimeOffApi.md +92 -6
  75. data/docs/TimeOffBalance.md +5 -3
  76. data/docs/{TimeOffBalanceApi.md → TimeOffBalancesApi.md} +26 -22
  77. data/docs/TimeOffEndpointRequest.md +18 -0
  78. data/docs/TimeOffRequest.md +36 -0
  79. data/docs/TimeOffResponse.md +24 -0
  80. data/docs/ValidationProblemSource.md +18 -0
  81. data/docs/WarningValidationProblem.md +24 -0
  82. data/lib/merge_hris_client/api/account_details_api.rb +77 -0
  83. data/lib/merge_hris_client/api/bank_info_api.rb +217 -0
  84. data/lib/merge_hris_client/api/benefits_api.rb +3 -69
  85. data/lib/merge_hris_client/api/companies_api.rb +3 -0
  86. data/lib/merge_hris_client/api/deductions_api.rb +185 -0
  87. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +17 -2
  88. data/lib/merge_hris_client/api/employees_api.rb +103 -15
  89. data/lib/merge_hris_client/api/employments_api.rb +24 -69
  90. data/lib/merge_hris_client/api/force_resync_api.rb +84 -0
  91. data/lib/merge_hris_client/api/groups_api.rb +182 -0
  92. data/lib/merge_hris_client/api/issues_api.rb +10 -10
  93. data/lib/merge_hris_client/api/linked_accounts_api.rb +117 -0
  94. data/lib/merge_hris_client/api/locations_api.rb +3 -0
  95. data/lib/merge_hris_client/api/pay_groups_api.rb +182 -0
  96. data/lib/merge_hris_client/api/payroll_runs_api.rb +22 -0
  97. data/lib/merge_hris_client/api/sync_status_api.rb +4 -66
  98. data/lib/merge_hris_client/api/teams_api.rb +17 -0
  99. data/lib/merge_hris_client/api/time_off_api.rb +95 -2
  100. data/lib/merge_hris_client/api/time_off_balances_api.rb +206 -0
  101. data/lib/merge_hris_client/configuration.rb +6 -4
  102. data/lib/merge_hris_client/models/account_details.rb +273 -0
  103. data/lib/merge_hris_client/models/account_details_and_actions.rb +302 -0
  104. data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +310 -0
  105. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +37 -0
  106. data/lib/merge_hris_client/models/account_integration.rb +6 -28
  107. data/lib/merge_hris_client/models/account_token.rb +1 -1
  108. data/lib/merge_hris_client/models/account_type_enum.rb +36 -0
  109. data/lib/merge_hris_client/models/available_actions.rb +1 -1
  110. data/lib/merge_hris_client/models/bank_info.rb +322 -0
  111. data/lib/merge_hris_client/models/benefit.rb +2 -3
  112. data/lib/merge_hris_client/models/categories_enum.rb +37 -0
  113. data/lib/merge_hris_client/models/category_enum.rb +37 -0
  114. data/lib/merge_hris_client/models/company.rb +1 -1
  115. data/lib/merge_hris_client/models/country_enum.rb +1 -0
  116. data/lib/merge_hris_client/models/data_passthrough_request.rb +79 -9
  117. data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
  118. data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
  119. data/lib/merge_hris_client/models/deduction.rb +1 -2
  120. data/lib/merge_hris_client/models/earning.rb +4 -8
  121. data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
  122. data/lib/merge_hris_client/models/employee.rb +43 -14
  123. data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
  124. data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
  125. data/lib/merge_hris_client/models/employee_request.rb +55 -14
  126. data/lib/merge_hris_client/models/employee_response.rb +266 -0
  127. data/lib/merge_hris_client/models/employment.rb +12 -2
  128. data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
  129. data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
  130. data/lib/merge_hris_client/models/encoding_enum.rb +36 -0
  131. data/lib/merge_hris_client/models/end_user_details_request.rb +113 -28
  132. data/lib/merge_hris_client/models/error_validation_problem.rb +260 -0
  133. data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
  134. data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
  135. data/lib/merge_hris_client/models/gender_enum.rb +1 -1
  136. data/lib/merge_hris_client/models/generate_remote_key_request.rb +20 -1
  137. data/lib/merge_hris_client/models/{benefit_request.rb → group.rb} +48 -49
  138. data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
  139. data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
  140. data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
  141. data/lib/merge_hris_client/models/issue.rb +1 -1
  142. data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
  143. data/lib/merge_hris_client/models/link_token.rb +1 -1
  144. data/lib/merge_hris_client/models/location.rb +24 -2
  145. data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
  146. data/lib/merge_hris_client/models/marital_status_enum.rb +2 -2
  147. data/lib/merge_hris_client/models/method_enum.rb +1 -1
  148. data/lib/merge_hris_client/models/model_operation.rb +1 -1
  149. data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
  150. data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +240 -0
  151. data/lib/merge_hris_client/models/paginated_bank_info_list.rb +240 -0
  152. data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
  153. data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
  154. data/lib/merge_hris_client/models/paginated_deduction_list.rb +240 -0
  155. data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
  156. data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
  157. data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
  158. data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
  159. data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
  160. data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
  161. data/lib/merge_hris_client/models/paginated_pay_group_list.rb +240 -0
  162. data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
  163. data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
  164. data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
  165. data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
  166. data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
  167. data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
  168. data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
  169. data/lib/merge_hris_client/models/pay_group.rb +253 -0
  170. data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
  171. data/lib/merge_hris_client/models/payroll_run.rb +1 -1
  172. data/lib/merge_hris_client/models/policy_type_enum.rb +40 -0
  173. data/lib/merge_hris_client/models/reason_enum.rb +37 -0
  174. data/lib/merge_hris_client/models/remote_data.rb +1 -1
  175. data/lib/merge_hris_client/models/remote_data_request.rb +20 -1
  176. data/lib/merge_hris_client/models/remote_key.rb +1 -1
  177. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +20 -1
  178. data/lib/merge_hris_client/models/remote_response.rb +1 -1
  179. data/lib/merge_hris_client/models/request_format_enum.rb +37 -0
  180. data/lib/merge_hris_client/models/request_type_enum.rb +3 -1
  181. data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
  182. data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
  183. data/lib/merge_hris_client/models/sync_status.rb +1 -1
  184. data/lib/merge_hris_client/models/sync_status_status_enum.rb +3 -2
  185. data/lib/merge_hris_client/models/tax.rb +3 -7
  186. data/lib/merge_hris_client/models/team.rb +1 -2
  187. data/lib/merge_hris_client/models/time_off.rb +1 -3
  188. data/lib/merge_hris_client/models/time_off_balance.rb +15 -5
  189. data/lib/merge_hris_client/models/time_off_endpoint_request.rb +223 -0
  190. data/lib/merge_hris_client/models/{employment_request.rb → time_off_request.rb} +79 -70
  191. data/lib/merge_hris_client/models/time_off_response.rb +266 -0
  192. data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
  193. data/lib/merge_hris_client/models/units_enum.rb +1 -1
  194. data/lib/merge_hris_client/models/validation_problem_source.rb +223 -0
  195. data/lib/merge_hris_client/models/warning_validation_problem.rb +260 -0
  196. data/lib/merge_hris_client/version.rb +1 -1
  197. data/lib/merge_hris_client.rb +43 -5
  198. data/pull_request_template.md +3 -1
  199. data/spec/api/account_details_api_spec.rb +45 -0
  200. data/spec/api/account_token_api_spec.rb +1 -1
  201. data/spec/api/available_actions_api_spec.rb +1 -1
  202. data/spec/api/bank_info_api_spec.rb +74 -0
  203. data/spec/api/benefits_api_spec.rb +4 -1
  204. data/spec/api/companies_api_spec.rb +4 -1
  205. data/spec/api/deductions_api_spec.rb +69 -0
  206. data/spec/api/employee_payroll_runs_api_spec.rb +9 -2
  207. data/spec/api/employees_api_spec.rb +35 -1
  208. data/spec/api/employments_api_spec.rb +7 -1
  209. data/spec/api/force_resync_api_spec.rb +46 -0
  210. data/spec/api/groups_api_spec.rb +68 -0
  211. data/spec/api/issues_api_spec.rb +5 -5
  212. data/spec/api/link_token_api_spec.rb +2 -2
  213. data/spec/api/linked_accounts_api_spec.rb +57 -0
  214. data/spec/api/locations_api_spec.rb +4 -1
  215. data/spec/api/passthrough_api_spec.rb +2 -3
  216. data/spec/api/pay_groups_api_spec.rb +68 -0
  217. data/spec/api/payroll_runs_api_spec.rb +9 -1
  218. data/spec/api/regenerate_key_api_spec.rb +2 -2
  219. data/spec/api/sync_status_api_spec.rb +2 -13
  220. data/spec/api/teams_api_spec.rb +7 -1
  221. data/spec/api/time_off_api_spec.rb +21 -2
  222. data/spec/api/{time_off_balance_api_spec.rb → time_off_balances_api_spec.rb} +13 -11
  223. data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
  224. data/spec/models/account_details_and_actions_spec.rb +76 -0
  225. data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
  226. data/spec/models/account_details_spec.rb +70 -0
  227. data/spec/models/account_integration_spec.rb +7 -1
  228. data/spec/models/account_token_spec.rb +7 -1
  229. data/spec/models/account_type_enum_spec.rb +28 -0
  230. data/spec/models/available_actions_spec.rb +13 -1
  231. data/spec/models/{employment_request_spec.rb → bank_info_spec.rb} +15 -15
  232. data/spec/models/benefit_plan_type_enum_spec.rb +1 -1
  233. data/spec/models/benefit_spec.rb +7 -1
  234. data/spec/models/categories_enum_spec.rb +28 -0
  235. data/spec/models/category_enum_spec.rb +28 -0
  236. data/spec/models/company_spec.rb +7 -1
  237. data/spec/models/country_enum_spec.rb +1 -1
  238. data/spec/models/data_passthrough_request_spec.rb +13 -1
  239. data/spec/models/debug_mode_log_spec.rb +46 -0
  240. data/spec/models/debug_model_log_summary_spec.rb +46 -0
  241. data/spec/models/deduction_spec.rb +7 -1
  242. data/spec/models/earning_spec.rb +7 -1
  243. data/spec/models/earning_type_enum_spec.rb +28 -0
  244. data/spec/models/{remote_key_for_regeneration_spec.rb → employee_endpoint_request_spec.rb} +8 -8
  245. data/spec/models/employee_payroll_run_spec.rb +7 -1
  246. data/spec/models/employee_request_spec.rb +30 -0
  247. data/spec/models/{end_user_details_spec.rb → employee_response_spec.rb} +11 -15
  248. data/spec/models/employee_spec.rb +37 -1
  249. data/spec/models/employment_spec.rb +13 -1
  250. data/spec/models/employment_status_enum_spec.rb +1 -1
  251. data/spec/models/employment_type_enum_spec.rb +1 -1
  252. data/spec/models/encoding_enum_spec.rb +28 -0
  253. data/spec/models/end_user_details_request_spec.rb +13 -5
  254. data/spec/models/error_validation_problem_spec.rb +52 -0
  255. data/spec/models/ethnicity_enum_spec.rb +1 -1
  256. data/spec/models/flsa_status_enum_spec.rb +1 -1
  257. data/spec/models/gender_enum_spec.rb +1 -1
  258. data/spec/models/{benefit_request_spec.rb → group_spec.rb} +12 -12
  259. data/spec/models/group_type_enum_spec.rb +28 -0
  260. data/spec/models/ignore_common_model_request_spec.rb +40 -0
  261. data/spec/models/ignore_common_model_spec.rb +40 -0
  262. data/spec/models/link_token_spec.rb +1 -1
  263. data/spec/models/location_spec.rb +19 -1
  264. data/spec/models/location_type_enum_spec.rb +28 -0
  265. data/spec/models/marital_status_enum_spec.rb +1 -1
  266. data/spec/models/method_enum_spec.rb +1 -1
  267. data/spec/models/model_operation_spec.rb +13 -1
  268. data/spec/models/multipart_form_field_request_spec.rb +58 -0
  269. data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
  270. data/spec/models/paginated_bank_info_list_spec.rb +46 -0
  271. data/spec/models/paginated_benefit_list_spec.rb +1 -1
  272. data/spec/models/paginated_company_list_spec.rb +1 -1
  273. data/spec/models/paginated_deduction_list_spec.rb +46 -0
  274. data/spec/models/paginated_employee_list_spec.rb +1 -1
  275. data/spec/models/paginated_employee_payroll_run_list_spec.rb +1 -1
  276. data/spec/models/paginated_employment_list_spec.rb +1 -1
  277. data/spec/models/paginated_group_list_spec.rb +46 -0
  278. data/spec/models/paginated_location_list_spec.rb +1 -1
  279. data/spec/models/paginated_pay_group_list_spec.rb +46 -0
  280. data/spec/models/paginated_payroll_run_list_spec.rb +1 -1
  281. data/spec/models/paginated_team_list_spec.rb +1 -1
  282. data/spec/models/paginated_time_off_list_spec.rb +1 -1
  283. data/spec/models/pay_currency_enum_spec.rb +1 -1
  284. data/spec/models/pay_frequency_enum_spec.rb +1 -1
  285. data/spec/models/{data_passthrough_spec.rb → pay_group_spec.rb} +11 -11
  286. data/spec/models/pay_period_enum_spec.rb +1 -1
  287. data/spec/models/payroll_run_spec.rb +7 -1
  288. data/spec/models/policy_type_enum_spec.rb +28 -0
  289. data/spec/models/{state_enum_spec.rb → reason_enum_spec.rb} +7 -7
  290. data/spec/models/remote_data_spec.rb +1 -1
  291. data/spec/models/remote_key_for_regeneration_request_spec.rb +1 -1
  292. data/spec/models/remote_key_spec.rb +1 -1
  293. data/spec/models/remote_response_spec.rb +1 -1
  294. data/spec/models/request_format_enum_spec.rb +28 -0
  295. data/spec/models/request_type_enum_spec.rb +1 -1
  296. data/spec/models/run_state_enum_spec.rb +1 -1
  297. data/spec/models/run_type_enum_spec.rb +1 -1
  298. data/spec/models/tax_spec.rb +7 -1
  299. data/spec/models/team_spec.rb +13 -1
  300. data/spec/models/time_off_balance_spec.rb +6 -0
  301. data/spec/models/time_off_endpoint_request_spec.rb +34 -0
  302. data/spec/models/time_off_request_spec.rb +88 -0
  303. data/spec/models/time_off_response_spec.rb +52 -0
  304. data/spec/models/time_off_spec.rb +19 -1
  305. data/spec/models/time_off_status_enum_spec.rb +1 -1
  306. data/spec/models/type_enum_spec.rb +1 -1
  307. data/spec/models/units_enum_spec.rb +1 -1
  308. data/spec/models/validation_problem_source_spec.rb +34 -0
  309. data/spec/models/warning_validation_problem_spec.rb +52 -0
  310. data/test_ruby.rb +11 -14
  311. metadata +175 -29
  312. data/docs/BenefitRequest.md +0 -28
  313. data/docs/DataPassthrough.md +0 -24
  314. data/docs/EmploymentRequest.md +0 -34
  315. data/docs/EndUserDetails.md +0 -24
  316. data/docs/RemoteKeyForRegeneration.md +0 -18
  317. data/merge_hris_client-1.0.0.gem +0 -0
  318. data/merge_hris_client-1.0.1.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1019ad62ce1658e194a3bb31737940198de592a478beb103a011ccff8b93257f
4
- data.tar.gz: 7f3a57417e8d5a924b61844b03963e1304eab299dbc24facdaee557f6810b5d2
3
+ metadata.gz: 229fd1e1c6db27d31c178f60da34b4a7e031966dbcee75c99a3c784eaabf281a
4
+ data.tar.gz: 8583b946ac2eaa2291389831965cf5dbcb2a1b0514e7cc9639c489540593ffb8
5
5
  SHA512:
6
- metadata.gz: 81a6f2c35383814dc9882b32b327fb01f6a255571d35fe5f3f0969f5cd370be97e4eef9ee42d86e5df72d1658594a3767208d14fd667317ac67dff99a22d9567
7
- data.tar.gz: 919a1b4fe3fd8a38c0896589e84c4d1cbfa7097d56d603be3cf4ca27c819ecd7ca9c9bcaab7dff0b939abbf26aca47c5d8dd96e659db57e9e99e8858d9536c87
6
+ metadata.gz: 6c4bc2a2453a27df2d38768d4daa809dd189d1b472cecfe66ad8db395e06a2ae0c297d9b1ce8ffd9416d617929d9d4c40f8f9ad4dea7f5fdd9a4c837f1b7d278
7
+ data.tar.gz: ab99ee10f58cd7cbd210b67bca51611e09da89926e9327432dda58d3b2129a5c0d74e2d084853ba90519721f0d8618b0e41e257e2e6f3b491dd579bdac17c265
data/README.md CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple HR Information Syst
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0
10
- - Package version: 1.0.0
10
+ - Package version: 2.0.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
13
13
 
@@ -24,16 +24,16 @@ gem build merge_hris_client.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./merge_hris_client-1.0.0.gem
27
+ gem install ./merge_hris_client-2.0.0.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./merge_hris_client-1.0.0.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./merge_hris_client-2.0.0.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'merge_hris_client', '~> 1.0.0'
36
+ gem 'merge_hris_client', '~> 2.0.0'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -60,19 +60,18 @@ require 'merge_hris_client'
60
60
  # Setup authorization
61
61
  MergeHRISClient.configure do |config|
62
62
  # Configure API key authorization: tokenAuth
63
- config.api_key['Authorization'] = 'YOUR API KEY'
63
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
64
64
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
65
- #config.api_key_prefix['Authorization'] = 'Bearer'
65
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
66
66
  end
67
67
 
68
- api_instance = MergeHRISClient::AccountTokenApi.new
69
- public_token = 'public_token_example' # String |
68
+ api_instance = MergeHRISClient::AccountDetailsApi.new
70
69
 
71
70
  begin
72
- result = api_instance.account_token_retrieve(public_token)
71
+ result = api_instance.account_details_retrieve
73
72
  p result
74
73
  rescue MergeHRISClient::ApiError => e
75
- puts "Exception when calling AccountTokenApi->account_token_retrieve: #{e}"
74
+ puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
76
75
  end
77
76
 
78
77
  ```
@@ -83,81 +82,114 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
83
82
 
84
83
  Class | Method | HTTP request | Description
85
84
  ------------ | ------------- | ------------- | -------------
85
+ *MergeHRISClient::AccountDetailsApi* | [**account_details_retrieve**](docs/AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details |
86
86
  *MergeHRISClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
87
87
  *MergeHRISClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
88
- *MergeHRISClient::BenefitsApi* | [**benefits_create**](docs/BenefitsApi.md#benefits_create) | **POST** /benefits |
88
+ *MergeHRISClient::BankInfoApi* | [**bank_info_list**](docs/BankInfoApi.md#bank_info_list) | **GET** /bank-info |
89
+ *MergeHRISClient::BankInfoApi* | [**bank_info_retrieve**](docs/BankInfoApi.md#bank_info_retrieve) | **GET** /bank-info/{id} |
89
90
  *MergeHRISClient::BenefitsApi* | [**benefits_list**](docs/BenefitsApi.md#benefits_list) | **GET** /benefits |
90
91
  *MergeHRISClient::BenefitsApi* | [**benefits_retrieve**](docs/BenefitsApi.md#benefits_retrieve) | **GET** /benefits/{id} |
91
92
  *MergeHRISClient::CompaniesApi* | [**companies_list**](docs/CompaniesApi.md#companies_list) | **GET** /companies |
92
93
  *MergeHRISClient::CompaniesApi* | [**companies_retrieve**](docs/CompaniesApi.md#companies_retrieve) | **GET** /companies/{id} |
94
+ *MergeHRISClient::DeductionsApi* | [**deductions_list**](docs/DeductionsApi.md#deductions_list) | **GET** /deductions |
95
+ *MergeHRISClient::DeductionsApi* | [**deductions_retrieve**](docs/DeductionsApi.md#deductions_retrieve) | **GET** /deductions/{id} |
93
96
  *MergeHRISClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account |
94
97
  *MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_list**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_list) | **GET** /employee-payroll-runs |
95
98
  *MergeHRISClient::EmployeePayrollRunsApi* | [**employee_payroll_runs_retrieve**](docs/EmployeePayrollRunsApi.md#employee_payroll_runs_retrieve) | **GET** /employee-payroll-runs/{id} |
96
99
  *MergeHRISClient::EmployeesApi* | [**employees_create**](docs/EmployeesApi.md#employees_create) | **POST** /employees |
100
+ *MergeHRISClient::EmployeesApi* | [**employees_ignore_create**](docs/EmployeesApi.md#employees_ignore_create) | **POST** /employees/ignore/{model_id} |
97
101
  *MergeHRISClient::EmployeesApi* | [**employees_list**](docs/EmployeesApi.md#employees_list) | **GET** /employees |
98
102
  *MergeHRISClient::EmployeesApi* | [**employees_retrieve**](docs/EmployeesApi.md#employees_retrieve) | **GET** /employees/{id} |
99
- *MergeHRISClient::EmploymentsApi* | [**employments_create**](docs/EmploymentsApi.md#employments_create) | **POST** /employments |
100
103
  *MergeHRISClient::EmploymentsApi* | [**employments_list**](docs/EmploymentsApi.md#employments_list) | **GET** /employments |
101
104
  *MergeHRISClient::EmploymentsApi* | [**employments_retrieve**](docs/EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} |
105
+ *MergeHRISClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
102
106
  *MergeHRISClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |
107
+ *MergeHRISClient::GroupsApi* | [**groups_list**](docs/GroupsApi.md#groups_list) | **GET** /groups |
108
+ *MergeHRISClient::GroupsApi* | [**groups_retrieve**](docs/GroupsApi.md#groups_retrieve) | **GET** /groups/{id} |
103
109
  *MergeHRISClient::IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues |
104
110
  *MergeHRISClient::IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |
105
111
  *MergeHRISClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token |
112
+ *MergeHRISClient::LinkedAccountsApi* | [**linked_accounts_list**](docs/LinkedAccountsApi.md#linked_accounts_list) | **GET** /linked-accounts |
106
113
  *MergeHRISClient::LocationsApi* | [**locations_list**](docs/LocationsApi.md#locations_list) | **GET** /locations |
107
114
  *MergeHRISClient::LocationsApi* | [**locations_retrieve**](docs/LocationsApi.md#locations_retrieve) | **GET** /locations/{id} |
108
115
  *MergeHRISClient::PassthroughApi* | [**passthrough_create**](docs/PassthroughApi.md#passthrough_create) | **POST** /passthrough |
116
+ *MergeHRISClient::PayGroupsApi* | [**pay_groups_list**](docs/PayGroupsApi.md#pay_groups_list) | **GET** /pay-groups |
117
+ *MergeHRISClient::PayGroupsApi* | [**pay_groups_retrieve**](docs/PayGroupsApi.md#pay_groups_retrieve) | **GET** /pay-groups/{id} |
109
118
  *MergeHRISClient::PayrollRunsApi* | [**payroll_runs_list**](docs/PayrollRunsApi.md#payroll_runs_list) | **GET** /payroll-runs |
110
119
  *MergeHRISClient::PayrollRunsApi* | [**payroll_runs_retrieve**](docs/PayrollRunsApi.md#payroll_runs_retrieve) | **GET** /payroll-runs/{id} |
111
120
  *MergeHRISClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |
112
121
  *MergeHRISClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status |
113
- *MergeHRISClient::SyncStatusApi* | [**sync_status_resync_create**](docs/SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync |
114
122
  *MergeHRISClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams |
115
123
  *MergeHRISClient::TeamsApi* | [**teams_retrieve**](docs/TeamsApi.md#teams_retrieve) | **GET** /teams/{id} |
124
+ *MergeHRISClient::TimeOffApi* | [**time_off_create**](docs/TimeOffApi.md#time_off_create) | **POST** /time-off |
116
125
  *MergeHRISClient::TimeOffApi* | [**time_off_list**](docs/TimeOffApi.md#time_off_list) | **GET** /time-off |
117
126
  *MergeHRISClient::TimeOffApi* | [**time_off_retrieve**](docs/TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} |
118
- *MergeHRISClient::TimeOffBalanceApi* | [**time_off_balance_list**](docs/TimeOffBalanceApi.md#time_off_balance_list) | **GET** /time-off-balance |
119
- *MergeHRISClient::TimeOffBalanceApi* | [**time_off_balance_retrieve**](docs/TimeOffBalanceApi.md#time_off_balance_retrieve) | **GET** /time-off-balance/{id} |
127
+ *MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_list**](docs/TimeOffBalancesApi.md#time_off_balances_list) | **GET** /time-off-balances |
128
+ *MergeHRISClient::TimeOffBalancesApi* | [**time_off_balances_retrieve**](docs/TimeOffBalancesApi.md#time_off_balances_retrieve) | **GET** /time-off-balances/{id} |
120
129
 
121
130
 
122
131
  ## Documentation for Models
123
132
 
133
+ - [MergeHRISClient::AccountDetails](docs/AccountDetails.md)
134
+ - [MergeHRISClient::AccountDetailsAndActions](docs/AccountDetailsAndActions.md)
135
+ - [MergeHRISClient::AccountDetailsAndActionsIntegration](docs/AccountDetailsAndActionsIntegration.md)
136
+ - [MergeHRISClient::AccountDetailsAndActionsStatusEnum](docs/AccountDetailsAndActionsStatusEnum.md)
124
137
  - [MergeHRISClient::AccountIntegration](docs/AccountIntegration.md)
125
138
  - [MergeHRISClient::AccountToken](docs/AccountToken.md)
139
+ - [MergeHRISClient::AccountTypeEnum](docs/AccountTypeEnum.md)
126
140
  - [MergeHRISClient::AvailableActions](docs/AvailableActions.md)
141
+ - [MergeHRISClient::BankInfo](docs/BankInfo.md)
127
142
  - [MergeHRISClient::Benefit](docs/Benefit.md)
128
- - [MergeHRISClient::BenefitPlanTypeEnum](docs/BenefitPlanTypeEnum.md)
129
- - [MergeHRISClient::BenefitRequest](docs/BenefitRequest.md)
143
+ - [MergeHRISClient::CategoriesEnum](docs/CategoriesEnum.md)
144
+ - [MergeHRISClient::CategoryEnum](docs/CategoryEnum.md)
130
145
  - [MergeHRISClient::Company](docs/Company.md)
131
146
  - [MergeHRISClient::CountryEnum](docs/CountryEnum.md)
132
147
  - [MergeHRISClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
148
+ - [MergeHRISClient::DebugModeLog](docs/DebugModeLog.md)
149
+ - [MergeHRISClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
133
150
  - [MergeHRISClient::Deduction](docs/Deduction.md)
134
151
  - [MergeHRISClient::Earning](docs/Earning.md)
152
+ - [MergeHRISClient::EarningTypeEnum](docs/EarningTypeEnum.md)
135
153
  - [MergeHRISClient::Employee](docs/Employee.md)
154
+ - [MergeHRISClient::EmployeeEndpointRequest](docs/EmployeeEndpointRequest.md)
136
155
  - [MergeHRISClient::EmployeePayrollRun](docs/EmployeePayrollRun.md)
137
156
  - [MergeHRISClient::EmployeeRequest](docs/EmployeeRequest.md)
157
+ - [MergeHRISClient::EmployeeResponse](docs/EmployeeResponse.md)
138
158
  - [MergeHRISClient::Employment](docs/Employment.md)
139
- - [MergeHRISClient::EmploymentRequest](docs/EmploymentRequest.md)
140
159
  - [MergeHRISClient::EmploymentStatusEnum](docs/EmploymentStatusEnum.md)
141
160
  - [MergeHRISClient::EmploymentTypeEnum](docs/EmploymentTypeEnum.md)
161
+ - [MergeHRISClient::EncodingEnum](docs/EncodingEnum.md)
142
162
  - [MergeHRISClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
163
+ - [MergeHRISClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
143
164
  - [MergeHRISClient::EthnicityEnum](docs/EthnicityEnum.md)
144
165
  - [MergeHRISClient::FlsaStatusEnum](docs/FlsaStatusEnum.md)
145
166
  - [MergeHRISClient::GenderEnum](docs/GenderEnum.md)
146
167
  - [MergeHRISClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
168
+ - [MergeHRISClient::Group](docs/Group.md)
169
+ - [MergeHRISClient::GroupTypeEnum](docs/GroupTypeEnum.md)
170
+ - [MergeHRISClient::IgnoreCommonModel](docs/IgnoreCommonModel.md)
171
+ - [MergeHRISClient::IgnoreCommonModelRequest](docs/IgnoreCommonModelRequest.md)
147
172
  - [MergeHRISClient::Issue](docs/Issue.md)
148
173
  - [MergeHRISClient::IssueStatusEnum](docs/IssueStatusEnum.md)
149
174
  - [MergeHRISClient::LinkToken](docs/LinkToken.md)
150
175
  - [MergeHRISClient::Location](docs/Location.md)
176
+ - [MergeHRISClient::LocationTypeEnum](docs/LocationTypeEnum.md)
151
177
  - [MergeHRISClient::MaritalStatusEnum](docs/MaritalStatusEnum.md)
152
178
  - [MergeHRISClient::MethodEnum](docs/MethodEnum.md)
153
179
  - [MergeHRISClient::ModelOperation](docs/ModelOperation.md)
180
+ - [MergeHRISClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
181
+ - [MergeHRISClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
182
+ - [MergeHRISClient::PaginatedBankInfoList](docs/PaginatedBankInfoList.md)
154
183
  - [MergeHRISClient::PaginatedBenefitList](docs/PaginatedBenefitList.md)
155
184
  - [MergeHRISClient::PaginatedCompanyList](docs/PaginatedCompanyList.md)
185
+ - [MergeHRISClient::PaginatedDeductionList](docs/PaginatedDeductionList.md)
156
186
  - [MergeHRISClient::PaginatedEmployeeList](docs/PaginatedEmployeeList.md)
157
187
  - [MergeHRISClient::PaginatedEmployeePayrollRunList](docs/PaginatedEmployeePayrollRunList.md)
158
188
  - [MergeHRISClient::PaginatedEmploymentList](docs/PaginatedEmploymentList.md)
189
+ - [MergeHRISClient::PaginatedGroupList](docs/PaginatedGroupList.md)
159
190
  - [MergeHRISClient::PaginatedIssueList](docs/PaginatedIssueList.md)
160
191
  - [MergeHRISClient::PaginatedLocationList](docs/PaginatedLocationList.md)
192
+ - [MergeHRISClient::PaginatedPayGroupList](docs/PaginatedPayGroupList.md)
161
193
  - [MergeHRISClient::PaginatedPayrollRunList](docs/PaginatedPayrollRunList.md)
162
194
  - [MergeHRISClient::PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
163
195
  - [MergeHRISClient::PaginatedTeamList](docs/PaginatedTeamList.md)
@@ -165,13 +197,17 @@ Class | Method | HTTP request | Description
165
197
  - [MergeHRISClient::PaginatedTimeOffList](docs/PaginatedTimeOffList.md)
166
198
  - [MergeHRISClient::PayCurrencyEnum](docs/PayCurrencyEnum.md)
167
199
  - [MergeHRISClient::PayFrequencyEnum](docs/PayFrequencyEnum.md)
200
+ - [MergeHRISClient::PayGroup](docs/PayGroup.md)
168
201
  - [MergeHRISClient::PayPeriodEnum](docs/PayPeriodEnum.md)
169
202
  - [MergeHRISClient::PayrollRun](docs/PayrollRun.md)
203
+ - [MergeHRISClient::PolicyTypeEnum](docs/PolicyTypeEnum.md)
204
+ - [MergeHRISClient::ReasonEnum](docs/ReasonEnum.md)
170
205
  - [MergeHRISClient::RemoteData](docs/RemoteData.md)
171
206
  - [MergeHRISClient::RemoteDataRequest](docs/RemoteDataRequest.md)
172
207
  - [MergeHRISClient::RemoteKey](docs/RemoteKey.md)
173
208
  - [MergeHRISClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
174
209
  - [MergeHRISClient::RemoteResponse](docs/RemoteResponse.md)
210
+ - [MergeHRISClient::RequestFormatEnum](docs/RequestFormatEnum.md)
175
211
  - [MergeHRISClient::RequestTypeEnum](docs/RequestTypeEnum.md)
176
212
  - [MergeHRISClient::RunStateEnum](docs/RunStateEnum.md)
177
213
  - [MergeHRISClient::RunTypeEnum](docs/RunTypeEnum.md)
@@ -181,9 +217,13 @@ Class | Method | HTTP request | Description
181
217
  - [MergeHRISClient::Team](docs/Team.md)
182
218
  - [MergeHRISClient::TimeOff](docs/TimeOff.md)
183
219
  - [MergeHRISClient::TimeOffBalance](docs/TimeOffBalance.md)
220
+ - [MergeHRISClient::TimeOffEndpointRequest](docs/TimeOffEndpointRequest.md)
221
+ - [MergeHRISClient::TimeOffRequest](docs/TimeOffRequest.md)
222
+ - [MergeHRISClient::TimeOffResponse](docs/TimeOffResponse.md)
184
223
  - [MergeHRISClient::TimeOffStatusEnum](docs/TimeOffStatusEnum.md)
185
- - [MergeHRISClient::TypeEnum](docs/TypeEnum.md)
186
224
  - [MergeHRISClient::UnitsEnum](docs/UnitsEnum.md)
225
+ - [MergeHRISClient::ValidationProblemSource](docs/ValidationProblemSource.md)
226
+ - [MergeHRISClient::WarningValidationProblem](docs/WarningValidationProblem.md)
187
227
 
188
228
 
189
229
  ## Documentation for Authorization
@@ -0,0 +1,30 @@
1
+ # MergeHRISClient::AccountDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **integration** | **String** | | [optional][readonly] |
9
+ | **category** | [**CategoryEnum**](CategoryEnum.md) | | [optional] |
10
+ | **end_user_origin_id** | **String** | | [optional][readonly] |
11
+ | **end_user_organization_name** | **String** | | [optional][readonly] |
12
+ | **end_user_email_address** | **String** | | [optional][readonly] |
13
+ | **status** | **String** | | [optional][readonly] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'merge_hris_client'
19
+
20
+ instance = MergeHRISClient::AccountDetails.new(
21
+ id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd,
22
+ integration: BambooHR,
23
+ category: hris,
24
+ end_user_origin_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
25
+ end_user_organization_name: Waystar Royco,
26
+ end_user_email_address: kendall.roy@waystar-royco.com,
27
+ status: COMPLETE
28
+ )
29
+ ```
30
+
@@ -0,0 +1,32 @@
1
+ # MergeHRISClient::AccountDetailsAndActions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **category** | [**CategoryEnum**](CategoryEnum.md) | | [optional] |
9
+ | **status** | [**AccountDetailsAndActionsStatusEnum**](AccountDetailsAndActionsStatusEnum.md) | | |
10
+ | **status_detail** | **String** | | [optional] |
11
+ | **end_user_origin_id** | **String** | | [optional] |
12
+ | **end_user_organization_name** | **String** | | |
13
+ | **end_user_email_address** | **String** | | |
14
+ | **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'merge_hris_client'
20
+
21
+ instance = MergeHRISClient::AccountDetailsAndActions.new(
22
+ id: e59b1821-f85c-4e28-a6b3-1804156f3563,
23
+ category: hris,
24
+ status: COMPLETE,
25
+ status_detail: null,
26
+ end_user_origin_id: 3ac95cde-6c7f-4eef-afec-be710b42308d,
27
+ end_user_organization_name: Foo Bar, LLC,
28
+ end_user_email_address: hradmin@foobar.dev,
29
+ integration: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,32 @@
1
+ # MergeHRISClient::AccountDetailsAndActionsIntegration
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | | |
9
+ | **image** | **String** | | [optional] |
10
+ | **square_image** | **String** | | [optional] |
11
+ | **color** | **String** | | |
12
+ | **slug** | **String** | | |
13
+ | **passthrough_available** | **Boolean** | | |
14
+ | **available_model_operations** | [**Array<ModelOperation>**](ModelOperation.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'merge_hris_client'
20
+
21
+ instance = MergeHRISClient::AccountDetailsAndActionsIntegration.new(
22
+ name: null,
23
+ categories: null,
24
+ image: null,
25
+ square_image: null,
26
+ color: null,
27
+ slug: null,
28
+ passthrough_available: null,
29
+ available_model_operations: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::AccountDetailsAndActionsStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_hris_client'
12
+
13
+ instance = MergeHRISClient::AccountDetailsAndActionsStatusEnum.new()
14
+ ```
15
+
@@ -0,0 +1,76 @@
1
+ # MergeHRISClient::AccountDetailsApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**account_details_retrieve**](AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details | |
8
+
9
+
10
+ ## account_details_retrieve
11
+
12
+ > <AccountDetails> account_details_retrieve
13
+
14
+
15
+
16
+ Get details for a linked account.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'merge_hris_client'
23
+ # setup authorization
24
+ MergeHRISClient.configure do |config|
25
+ # Configure API key authorization: tokenAuth
26
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
29
+ end
30
+
31
+ api_instance = MergeHRISClient::AccountDetailsApi.new
32
+
33
+ begin
34
+
35
+ result = api_instance.account_details_retrieve
36
+ p result
37
+ rescue MergeHRISClient::ApiError => e
38
+ puts "Error when calling AccountDetailsApi->account_details_retrieve: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the account_details_retrieve_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<AccountDetails>, Integer, Hash)> account_details_retrieve_with_http_info
47
+
48
+ ```ruby
49
+ begin
50
+
51
+ data, status_code, headers = api_instance.account_details_retrieve_with_http_info
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <AccountDetails>
55
+ rescue MergeHRISClient::ApiError => e
56
+ puts "Error when calling AccountDetailsApi->account_details_retrieve_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ This endpoint does not need any parameter.
63
+
64
+ ### Return type
65
+
66
+ [**AccountDetails**](AccountDetails.md)
67
+
68
+ ### Authorization
69
+
70
+ [tokenAuth](../README.md#tokenAuth)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: Not defined
75
+ - **Accept**: application/json
76
+
@@ -5,10 +5,10 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Company name. | |
8
- | **categories** | **Array&lt;String&gt;** | Category or categories this integration belongs to. | [optional] |
9
- | **image** | **String** | Company logo in rectangular shape. | [optional] |
10
- | **square_image** | **String** | Company logo in square shape. | [optional] |
11
- | **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. | [optional] |
8
+ | **categories** | [**Array&lt;CategoriesEnum&gt;**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated.&lt;br/&gt;&lt;br&gt;Example: For [ats, hris], enter &lt;i&gt;ats,hris&lt;/i&gt; | [optional] |
9
+ | **image** | **String** | Company logo in rectangular shape. &lt;b&gt;Upload an image with a clear background.&lt;/b&gt; | [optional] |
10
+ | **square_image** | **String** | Company logo in square shape. &lt;b&gt;Upload an image with a white background.&lt;/b&gt; | [optional] |
11
+ | **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. &lt;b&gt;Choose a darker, saturated color.&lt;/b&gt; | [optional] |
12
12
  | **slug** | **String** | | [optional][readonly] |
13
13
 
14
14
  ## Example
@@ -23,9 +23,9 @@ require 'merge_hris_client'
23
23
  # setup authorization
24
24
  MergeHRISClient.configure do |config|
25
25
  # Configure API key authorization: tokenAuth
26
- config.api_key['Authorization'] = 'YOUR API KEY'
26
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
27
27
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- # config.api_key_prefix['Authorization'] = 'Bearer'
28
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
29
29
  end
30
30
 
31
31
  api_instance = MergeHRISClient::AccountTokenApi.new
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::AccountTypeEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_hris_client'
12
+
13
+ instance = MergeHRISClient::AccountTypeEnum.new()
14
+ ```
15
+
@@ -23,9 +23,9 @@ require 'merge_hris_client'
23
23
  # setup authorization
24
24
  MergeHRISClient.configure do |config|
25
25
  # Configure API key authorization: tokenAuth
26
- config.api_key['Authorization'] = 'YOUR API KEY'
26
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
27
27
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- # config.api_key_prefix['Authorization'] = 'Bearer'
28
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
29
29
  end
30
30
 
31
31
  api_instance = MergeHRISClient::AvailableActionsApi.new
data/docs/BankInfo.md ADDED
@@ -0,0 +1,34 @@
1
+ # MergeHRISClient::BankInfo
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
+ | **employee** | **String** | | [optional] |
10
+ | **account_number** | **String** | The account number. | [optional] |
11
+ | **routing_number** | **String** | The routing number. | [optional] |
12
+ | **bank_name** | **String** | The bank name. | [optional] |
13
+ | **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type | [optional] |
14
+ | **remote_created_at** | **Time** | When the matching bank object was created in the third party system. | [optional] |
15
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'merge_hris_client'
21
+
22
+ instance = MergeHRISClient::BankInfo.new(
23
+ id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
24
+ remote_id: 123234,
25
+ employee: a3617eb4-dfe3-426f-921e-a65fc1661e10,
26
+ account_number: 439291590,
27
+ routing_number: 089690059,
28
+ bank_name: Chase,
29
+ account_type: CHECKING,
30
+ remote_created_at: 2021-12-06T10:11:26Z,
31
+ remote_data: [{&quot;path&quot;:&quot;/bank-info&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
32
+ )
33
+ ```
34
+