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
@@ -0,0 +1,103 @@
1
+ # MergeHRISClient::LinkedAccountsApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**linked_accounts_list**](LinkedAccountsApi.md#linked_accounts_list) | **GET** /linked-accounts | |
8
+
9
+
10
+ ## linked_accounts_list
11
+
12
+ > <PaginatedAccountDetailsAndActionsList> linked_accounts_list(opts)
13
+
14
+
15
+
16
+ List linked accounts for your organization.
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::LinkedAccountsApi.new
32
+ opts = {
33
+ category: 'accounting', # String |
34
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
35
+ end_user_email_address: 'end_user_email_address_example', # String |
36
+ end_user_organization_name: 'end_user_organization_name_example', # String |
37
+ end_user_origin_id: 'end_user_origin_id_example', # String |
38
+ end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once
39
+ id: TODO, # String |
40
+ ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once
41
+ integration_name: 'integration_name_example', # String |
42
+ is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts
43
+ page_size: 56, # Integer | Number of results to return per page.
44
+ status: 'status_example' # String | Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
45
+ }
46
+
47
+ begin
48
+
49
+ result = api_instance.linked_accounts_list(opts)
50
+ p result
51
+ rescue MergeHRISClient::ApiError => e
52
+ puts "Error when calling LinkedAccountsApi->linked_accounts_list: #{e}"
53
+ end
54
+ ```
55
+
56
+ #### Using the linked_accounts_list_with_http_info variant
57
+
58
+ This returns an Array which contains the response data, status code and headers.
59
+
60
+ > <Array(<PaginatedAccountDetailsAndActionsList>, Integer, Hash)> linked_accounts_list_with_http_info(opts)
61
+
62
+ ```ruby
63
+ begin
64
+
65
+ data, status_code, headers = api_instance.linked_accounts_list_with_http_info(opts)
66
+ p status_code # => 2xx
67
+ p headers # => { ... }
68
+ p data # => <PaginatedAccountDetailsAndActionsList>
69
+ rescue MergeHRISClient::ApiError => e
70
+ puts "Error when calling LinkedAccountsApi->linked_accounts_list_with_http_info: #{e}"
71
+ end
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ | Name | Type | Description | Notes |
77
+ | ---- | ---- | ----------- | ----- |
78
+ | **category** | **String** | | [optional] |
79
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
80
+ | **end_user_email_address** | **String** | | [optional] |
81
+ | **end_user_organization_name** | **String** | | [optional] |
82
+ | **end_user_origin_id** | **String** | | [optional] |
83
+ | **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once | [optional] |
84
+ | **id** | [**String**](.md) | | [optional] |
85
+ | **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once | [optional] |
86
+ | **integration_name** | **String** | | [optional] |
87
+ | **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts | [optional] |
88
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
89
+ | **status** | **String** | Filter by status. Options: &#x60;COMPLETE&#x60;, &#x60;INCOMPLETE&#x60;, &#x60;RELINK_NEEDED&#x60; | [optional] |
90
+
91
+ ### Return type
92
+
93
+ [**PaginatedAccountDetailsAndActionsList**](PaginatedAccountDetailsAndActionsList.md)
94
+
95
+ ### Authorization
96
+
97
+ [tokenAuth](../README.md#tokenAuth)
98
+
99
+ ### HTTP request headers
100
+
101
+ - **Content-Type**: Not defined
102
+ - **Accept**: application/json
103
+
data/docs/Location.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **name** | **String** | The location&#39;s name. | [optional] |
9
10
  | **phone_number** | **String** | The location&#39;s phone number. | [optional] |
10
11
  | **street_1** | **String** | Line 1 of the location&#39;s street address. | [optional] |
11
12
  | **street_2** | **String** | Line 2 of the location&#39;s street address. | [optional] |
@@ -13,6 +14,7 @@
13
14
  | **state** | **String** | The location&#39;s state. Represents a region if outside of the US. | [optional] |
14
15
  | **zip_code** | **String** | The location&#39;s zip code. | [optional] |
15
16
  | **country** | [**CountryEnum**](CountryEnum.md) | The location&#39;s country. | [optional] |
17
+ | **location_type** | [**LocationTypeEnum**](LocationTypeEnum.md) | The location&#39;s type. Can be either WORK or HOME | [optional] |
16
18
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
17
19
 
18
20
  ## Example
@@ -23,6 +25,7 @@ require 'merge_hris_client'
23
25
  instance = MergeHRISClient::Location.new(
24
26
  id: null,
25
27
  remote_id: 93018402,
28
+ name: NYC Office,
26
29
  phone_number: +1111111111,
27
30
  street_1: 2920 Broadway,
28
31
  street_2: 2nd Floor,
@@ -30,6 +33,7 @@ instance = MergeHRISClient::Location.new(
30
33
  state: NY,
31
34
  zip_code: 10027,
32
35
  country: USA,
36
+ location_type: WORK,
33
37
  remote_data: [{&quot;path&quot;:&quot;/locations&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
34
38
  )
35
39
  ```
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::LocationTypeEnum
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::LocationTypeEnum.new()
14
+ ```
15
+
data/docs/LocationsApi.md CHANGED
@@ -24,9 +24,9 @@ require 'merge_hris_client'
24
24
  # setup authorization
25
25
  MergeHRISClient.configure do |config|
26
26
  # Configure API key authorization: tokenAuth
27
- config.api_key['Authorization'] = 'YOUR API KEY'
27
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
28
28
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
- # config.api_key_prefix['Authorization'] = 'Bearer'
29
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
30
  end
31
31
 
32
32
  api_instance = MergeHRISClient::LocationsApi.new
@@ -35,6 +35,7 @@ opts = {
35
35
  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
36
36
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
37
37
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
38
39
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
39
40
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
40
41
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
@@ -77,6 +78,7 @@ end
77
78
  | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
78
79
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
79
80
  | **cursor** | **String** | The pagination cursor value. | [optional] |
81
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
80
82
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
81
83
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
82
84
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
@@ -113,9 +115,9 @@ require 'merge_hris_client'
113
115
  # setup authorization
114
116
  MergeHRISClient.configure do |config|
115
117
  # Configure API key authorization: tokenAuth
116
- config.api_key['Authorization'] = 'YOUR API KEY'
118
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
117
119
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
118
- # config.api_key_prefix['Authorization'] = 'Bearer'
120
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
119
121
  end
120
122
 
121
123
  api_instance = MergeHRISClient::LocationsApi.new
@@ -0,0 +1,26 @@
1
+ # MergeHRISClient::MultipartFormFieldRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the form field | |
8
+ | **data** | **String** | The data for the form field. | |
9
+ | **encoding** | [**EncodingEnum**](EncodingEnum.md) | The encoding of the value of &#x60;data&#x60;. Defaults to &#x60;RAW&#x60; if not defined. | [optional] |
10
+ | **file_name** | **String** | The file name of the form field, if the field is for a file. | [optional] |
11
+ | **content_type** | **String** | The MIME type of the file, if the field is for a file. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'merge_hris_client'
17
+
18
+ instance = MergeHRISClient::MultipartFormFieldRequest.new(
19
+ name: resume,
20
+ data: SW50ZWdyYXRlIGZhc3QKSW50ZWdyYXRlIG9uY2U&#x3D;,
21
+ encoding: BASE64,
22
+ file_name: resume.pdf,
23
+ content_type: application/pdf
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedAccountDetailsAndActionsList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;AccountDetailsAndActions&gt;**](AccountDetailsAndActions.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedAccountDetailsAndActionsList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedBankInfoList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;BankInfo&gt;**](BankInfo.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedBankInfoList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedDeductionList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Deduction&gt;**](Deduction.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedDeductionList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedGroupList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;Group&gt;**](Group.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedGroupList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -14,8 +14,8 @@
14
14
  require 'merge_hris_client'
15
15
 
16
16
  instance = MergeHRISClient::PaginatedIssueList.new(
17
- _next: null,
18
- previous: null,
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
19
  results: null
20
20
  )
21
21
  ```
@@ -0,0 +1,22 @@
1
+ # MergeHRISClient::PaginatedPayGroupList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_next** | **String** | | [optional] |
8
+ | **previous** | **String** | | [optional] |
9
+ | **results** | [**Array&lt;PayGroup&gt;**](PayGroup.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'merge_hris_client'
15
+
16
+ instance = MergeHRISClient::PaginatedPayGroupList.new(
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -14,8 +14,8 @@
14
14
  require 'merge_hris_client'
15
15
 
16
16
  instance = MergeHRISClient::PaginatedSyncStatusList.new(
17
- _next: null,
18
- previous: null,
17
+ _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
18
+ previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
19
19
  results: null
20
20
  )
21
21
  ```
@@ -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::PassthroughApi.new
data/docs/PayGroup.md ADDED
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::PayGroup
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
+ | **pay_group_name** | **String** | The pay group name. | [optional] |
10
+ | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::PayGroup.new(
18
+ id: fd1e0fb5-8f92-4ec9-9f32-179cf732867d,
19
+ remote_id: 800293,
20
+ pay_group_name: contractor,
21
+ remote_data: [{&quot;path&quot;:&quot;/pay-group&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
22
+ )
23
+ ```
24
+
@@ -0,0 +1,177 @@
1
+ # MergeHRISClient::PayGroupsApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**pay_groups_list**](PayGroupsApi.md#pay_groups_list) | **GET** /pay-groups | |
8
+ | [**pay_groups_retrieve**](PayGroupsApi.md#pay_groups_retrieve) | **GET** /pay-groups/{id} | |
9
+
10
+
11
+ ## pay_groups_list
12
+
13
+ > <PaginatedPayGroupList> pay_groups_list(x_account_token, opts)
14
+
15
+
16
+
17
+ Returns a list of `PayGroup` objects.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'merge_hris_client'
24
+ # setup authorization
25
+ MergeHRISClient.configure do |config|
26
+ # Configure API key authorization: tokenAuth
27
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
+ end
31
+
32
+ api_instance = MergeHRISClient::PayGroupsApi.new
33
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
34
+ opts = {
35
+ created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
36
+ created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
37
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
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.
42
+ page_size: 56, # Integer | Number of results to return per page.
43
+ remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
44
+ }
45
+
46
+ begin
47
+
48
+ result = api_instance.pay_groups_list(x_account_token, opts)
49
+ p result
50
+ rescue MergeHRISClient::ApiError => e
51
+ puts "Error when calling PayGroupsApi->pay_groups_list: #{e}"
52
+ end
53
+ ```
54
+
55
+ #### Using the pay_groups_list_with_http_info variant
56
+
57
+ This returns an Array which contains the response data, status code and headers.
58
+
59
+ > <Array(<PaginatedPayGroupList>, Integer, Hash)> pay_groups_list_with_http_info(x_account_token, opts)
60
+
61
+ ```ruby
62
+ begin
63
+
64
+ data, status_code, headers = api_instance.pay_groups_list_with_http_info(x_account_token, opts)
65
+ p status_code # => 2xx
66
+ p headers # => { ... }
67
+ p data # => <PaginatedPayGroupList>
68
+ rescue MergeHRISClient::ApiError => e
69
+ puts "Error when calling PayGroupsApi->pay_groups_list_with_http_info: #{e}"
70
+ end
71
+ ```
72
+
73
+ ### Parameters
74
+
75
+ | Name | Type | Description | Notes |
76
+ | ---- | ---- | ----------- | ----- |
77
+ | **x_account_token** | **String** | Token identifying the end user. | |
78
+ | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
79
+ | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
80
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
81
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
82
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
83
+ | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
84
+ | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
85
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
86
+ | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
87
+
88
+ ### Return type
89
+
90
+ [**PaginatedPayGroupList**](PaginatedPayGroupList.md)
91
+
92
+ ### Authorization
93
+
94
+ [tokenAuth](../README.md#tokenAuth)
95
+
96
+ ### HTTP request headers
97
+
98
+ - **Content-Type**: Not defined
99
+ - **Accept**: application/json
100
+
101
+
102
+ ## pay_groups_retrieve
103
+
104
+ > <PayGroup> pay_groups_retrieve(x_account_token, id, opts)
105
+
106
+
107
+
108
+ Returns a `PayGroup` object with the given `id`.
109
+
110
+ ### Examples
111
+
112
+ ```ruby
113
+ require 'time'
114
+ require 'merge_hris_client'
115
+ # setup authorization
116
+ MergeHRISClient.configure do |config|
117
+ # Configure API key authorization: tokenAuth
118
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
121
+ end
122
+
123
+ api_instance = MergeHRISClient::PayGroupsApi.new
124
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
125
+ id = TODO # String |
126
+ opts = {
127
+ include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
128
+ }
129
+
130
+ begin
131
+
132
+ result = api_instance.pay_groups_retrieve(x_account_token, id, opts)
133
+ p result
134
+ rescue MergeHRISClient::ApiError => e
135
+ puts "Error when calling PayGroupsApi->pay_groups_retrieve: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the pay_groups_retrieve_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(<PayGroup>, Integer, Hash)> pay_groups_retrieve_with_http_info(x_account_token, id, opts)
144
+
145
+ ```ruby
146
+ begin
147
+
148
+ data, status_code, headers = api_instance.pay_groups_retrieve_with_http_info(x_account_token, id, opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => <PayGroup>
152
+ rescue MergeHRISClient::ApiError => e
153
+ puts "Error when calling PayGroupsApi->pay_groups_retrieve_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **x_account_token** | **String** | Token identifying the end user. | |
162
+ | **id** | [**String**](.md) | | |
163
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
164
+
165
+ ### Return type
166
+
167
+ [**PayGroup**](PayGroup.md)
168
+
169
+ ### Authorization
170
+
171
+ [tokenAuth](../README.md#tokenAuth)
172
+
173
+ ### HTTP request headers
174
+
175
+ - **Content-Type**: Not defined
176
+ - **Accept**: application/json
177
+
data/docs/PayrollRun.md CHANGED
@@ -23,9 +23,9 @@ instance = MergeHRISClient::PayrollRun.new(
23
23
  remote_id: 19202938,
24
24
  run_state: PAID,
25
25
  run_type: REGULAR,
26
- start_date: null,
27
- end_date: null,
28
- check_date: null,
26
+ start_date: 2020-11-08T00:00Z,
27
+ end_date: 2020-11-15T00:00Z,
28
+ check_date: 2020-11-15T00:00Z,
29
29
  remote_data: [{&quot;path&quot;:&quot;/payroll&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
30
30
  )
31
31
  ```
@@ -24,9 +24,9 @@ require 'merge_hris_client'
24
24
  # setup authorization
25
25
  MergeHRISClient.configure do |config|
26
26
  # Configure API key authorization: tokenAuth
27
- config.api_key['Authorization'] = 'YOUR API KEY'
27
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
28
28
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
- # config.api_key_prefix['Authorization'] = 'Bearer'
29
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
30
30
  end
31
31
 
32
32
  api_instance = MergeHRISClient::PayrollRunsApi.new
@@ -35,11 +35,17 @@ opts = {
35
35
  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
36
36
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
37
37
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
38
+ ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs ended after this datetime.
39
+ ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs ended before this datetime.
40
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
38
41
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
39
42
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
40
43
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
41
44
  page_size: 56, # Integer | Number of results to return per page.
42
- remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
45
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
46
+ run_type: 'CORRECTION', # String | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
47
+ started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return payroll runs started after this datetime.
48
+ started_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return payroll runs started before this datetime.
43
49
  }
44
50
 
45
51
  begin
@@ -77,11 +83,17 @@ end
77
83
  | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
78
84
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
79
85
  | **cursor** | **String** | The pagination cursor value. | [optional] |
86
+ | **ended_after** | **Time** | If provided, will only return payroll runs ended after this datetime. | [optional] |
87
+ | **ended_before** | **Time** | If provided, will only return payroll runs ended before this datetime. | [optional] |
88
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
80
89
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
81
90
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
82
91
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
83
92
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
84
93
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
94
+ | **run_type** | **String** | If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;) | [optional] |
95
+ | **started_after** | **Time** | If provided, will only return payroll runs started after this datetime. | [optional] |
96
+ | **started_before** | **Time** | If provided, will only return payroll runs started before this datetime. | [optional] |
85
97
 
86
98
  ### Return type
87
99
 
@@ -113,9 +125,9 @@ require 'merge_hris_client'
113
125
  # setup authorization
114
126
  MergeHRISClient.configure do |config|
115
127
  # Configure API key authorization: tokenAuth
116
- config.api_key['Authorization'] = 'YOUR API KEY'
128
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
117
129
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
118
- # config.api_key_prefix['Authorization'] = 'Bearer'
130
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
119
131
  end
120
132
 
121
133
  api_instance = MergeHRISClient::PayrollRunsApi.new
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::PolicyTypeEnum
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::PolicyTypeEnum.new()
14
+ ```
15
+