merge_hris_client 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (213) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -9
  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/AccountTypeEnum.md +15 -0
  9. data/docs/BankInfo.md +34 -0
  10. data/docs/BankInfoApi.md +193 -0
  11. data/docs/BenefitsApi.md +2 -78
  12. data/docs/{StateEnum.md → CategoriesEnum.md} +2 -2
  13. data/docs/{NullEnum.md → CategoryEnum.md} +2 -2
  14. data/docs/CompaniesApi.md +3 -1
  15. data/docs/DataPassthroughRequest.md +5 -3
  16. data/docs/DeductionsApi.md +179 -0
  17. data/docs/Employee.md +12 -8
  18. data/docs/EmployeePayrollRun.md +3 -3
  19. data/docs/EmployeePayrollRunsApi.md +13 -3
  20. data/docs/EmployeesApi.md +12 -82
  21. data/docs/Employment.md +3 -1
  22. data/docs/EmploymentsApi.md +7 -78
  23. data/docs/EndUserDetailsRequest.md +1 -1
  24. data/docs/ErrorValidationProblem.md +24 -0
  25. data/docs/ForceResyncApi.md +79 -0
  26. data/docs/IssuesApi.md +11 -10
  27. data/docs/LinkedAccountsApi.md +103 -0
  28. data/docs/Location.md +2 -0
  29. data/docs/LocationsApi.md +2 -0
  30. data/docs/PaginatedAccountDetailsAndActionsList.md +22 -0
  31. data/docs/PaginatedBankInfoList.md +22 -0
  32. data/docs/PaginatedDeductionList.md +22 -0
  33. data/docs/PaginatedIssueList.md +2 -2
  34. data/docs/PaginatedPayGroupList.md +22 -0
  35. data/docs/PaginatedSyncStatusList.md +2 -2
  36. data/docs/PayGroup.md +24 -0
  37. data/docs/PayGroupsApi.md +177 -0
  38. data/docs/PayrollRun.md +3 -3
  39. data/docs/PayrollRunsApi.md +13 -1
  40. data/docs/PolicyTypeEnum.md +15 -0
  41. data/docs/RequestFormatEnum.md +15 -0
  42. data/docs/SyncStatusApi.md +3 -74
  43. data/docs/TeamsApi.md +7 -2
  44. data/docs/TimeOff.md +3 -3
  45. data/docs/TimeOffApi.md +88 -4
  46. data/docs/TimeOffBalance.md +4 -2
  47. data/docs/{TimeOffBalanceApi.md → TimeOffBalancesApi.md} +26 -22
  48. data/docs/TimeOffEndpointRequest.md +18 -0
  49. data/docs/TimeOffRequest.md +36 -0
  50. data/docs/TimeOffResponse.md +22 -0
  51. data/docs/ValidationProblemSource.md +18 -0
  52. data/docs/WarningValidationProblem.md +24 -0
  53. data/lib/merge_hris_client/api/account_details_api.rb +77 -0
  54. data/lib/merge_hris_client/api/bank_info_api.rb +222 -0
  55. data/lib/merge_hris_client/api/benefits_api.rb +3 -69
  56. data/lib/merge_hris_client/api/companies_api.rb +3 -0
  57. data/lib/merge_hris_client/api/deductions_api.rb +185 -0
  58. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +17 -2
  59. data/lib/merge_hris_client/api/employees_api.rb +18 -75
  60. data/lib/merge_hris_client/api/employments_api.rb +24 -69
  61. data/lib/merge_hris_client/api/force_resync_api.rb +84 -0
  62. data/lib/merge_hris_client/api/issues_api.rb +10 -10
  63. data/lib/merge_hris_client/api/linked_accounts_api.rb +117 -0
  64. data/lib/merge_hris_client/api/locations_api.rb +3 -0
  65. data/lib/merge_hris_client/api/pay_groups_api.rb +182 -0
  66. data/lib/merge_hris_client/api/payroll_runs_api.rb +22 -0
  67. data/lib/merge_hris_client/api/sync_status_api.rb +4 -4
  68. data/lib/merge_hris_client/api/teams_api.rb +17 -0
  69. data/lib/merge_hris_client/api/time_off_api.rb +92 -2
  70. data/lib/merge_hris_client/api/time_off_balances_api.rb +206 -0
  71. data/lib/merge_hris_client/models/account_details.rb +273 -0
  72. data/lib/merge_hris_client/models/account_details_and_actions.rb +302 -0
  73. data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +310 -0
  74. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +36 -0
  75. data/lib/merge_hris_client/models/account_integration.rb +1 -1
  76. data/lib/merge_hris_client/models/account_type_enum.rb +35 -0
  77. data/lib/merge_hris_client/models/bank_info.rb +323 -0
  78. data/lib/merge_hris_client/models/categories_enum.rb +36 -0
  79. data/lib/merge_hris_client/models/category_enum.rb +36 -0
  80. data/lib/merge_hris_client/models/data_passthrough_request.rb +66 -9
  81. data/lib/merge_hris_client/models/employee.rb +32 -8
  82. data/lib/merge_hris_client/models/employment.rb +12 -1
  83. data/lib/merge_hris_client/models/end_user_details_request.rb +73 -1
  84. data/lib/merge_hris_client/models/error_validation_problem.rb +260 -0
  85. data/lib/merge_hris_client/models/generate_remote_key_request.rb +19 -0
  86. data/lib/merge_hris_client/models/location.rb +12 -1
  87. data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
  88. data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +240 -0
  89. data/lib/merge_hris_client/models/paginated_bank_info_list.rb +240 -0
  90. data/lib/merge_hris_client/models/paginated_deduction_list.rb +240 -0
  91. data/lib/merge_hris_client/models/paginated_pay_group_list.rb +240 -0
  92. data/lib/merge_hris_client/models/{benefit_request.rb → pay_group.rb} +31 -54
  93. data/lib/merge_hris_client/models/policy_type_enum.rb +39 -0
  94. data/lib/merge_hris_client/models/remote_data_request.rb +19 -0
  95. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +19 -0
  96. data/lib/merge_hris_client/models/request_format_enum.rb +35 -0
  97. data/lib/merge_hris_client/models/request_type_enum.rb +2 -1
  98. data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -0
  99. data/lib/merge_hris_client/models/time_off_balance.rb +14 -3
  100. data/lib/merge_hris_client/models/time_off_endpoint_request.rb +223 -0
  101. data/lib/merge_hris_client/models/{employment_request.rb → time_off_request.rb} +80 -69
  102. data/lib/merge_hris_client/models/time_off_response.rb +255 -0
  103. data/lib/merge_hris_client/models/validation_problem_source.rb +223 -0
  104. data/lib/merge_hris_client/models/warning_validation_problem.rb +260 -0
  105. data/lib/merge_hris_client/version.rb +1 -1
  106. data/lib/merge_hris_client.rb +28 -4
  107. data/spec/api/account_details_api_spec.rb +45 -0
  108. data/spec/api/account_token_api_spec.rb +1 -1
  109. data/spec/api/available_actions_api_spec.rb +1 -1
  110. data/spec/api/bank_info_api_spec.rb +76 -0
  111. data/spec/api/benefits_api_spec.rb +4 -1
  112. data/spec/api/companies_api_spec.rb +4 -1
  113. data/spec/api/deductions_api_spec.rb +69 -0
  114. data/spec/api/employee_payroll_runs_api_spec.rb +9 -2
  115. data/spec/api/employees_api_spec.rb +9 -1
  116. data/spec/api/employments_api_spec.rb +7 -1
  117. data/spec/api/force_resync_api_spec.rb +46 -0
  118. data/spec/api/issues_api_spec.rb +5 -5
  119. data/spec/api/link_token_api_spec.rb +2 -2
  120. data/spec/api/linked_accounts_api_spec.rb +57 -0
  121. data/spec/api/locations_api_spec.rb +4 -1
  122. data/spec/api/passthrough_api_spec.rb +2 -3
  123. data/spec/api/pay_groups_api_spec.rb +68 -0
  124. data/spec/api/payroll_runs_api_spec.rb +9 -1
  125. data/spec/api/regenerate_key_api_spec.rb +2 -2
  126. data/spec/api/sync_status_api_spec.rb +2 -13
  127. data/spec/api/teams_api_spec.rb +7 -1
  128. data/spec/api/time_off_api_spec.rb +20 -2
  129. data/spec/api/{time_off_balance_api_spec.rb → time_off_balances_api_spec.rb} +13 -11
  130. data/spec/models/account_details_and_actions_integration_spec.rb +76 -0
  131. data/spec/models/account_details_and_actions_spec.rb +76 -0
  132. data/spec/models/account_details_and_actions_status_enum_spec.rb +28 -0
  133. data/spec/models/{benefit_request_spec.rb → account_details_spec.rb} +18 -12
  134. data/spec/models/account_integration_spec.rb +7 -1
  135. data/spec/models/account_token_spec.rb +7 -1
  136. data/spec/models/account_type_enum_spec.rb +28 -0
  137. data/spec/models/available_actions_spec.rb +13 -1
  138. data/spec/models/{employment_request_spec.rb → bank_info_spec.rb} +15 -15
  139. data/spec/models/benefit_plan_type_enum_spec.rb +1 -1
  140. data/spec/models/benefit_spec.rb +7 -1
  141. data/spec/models/categories_enum_spec.rb +28 -0
  142. data/spec/models/{state_enum_spec.rb → category_enum_spec.rb} +7 -7
  143. data/spec/models/company_spec.rb +7 -1
  144. data/spec/models/country_enum_spec.rb +1 -1
  145. data/spec/models/data_passthrough_request_spec.rb +7 -1
  146. data/spec/models/deduction_spec.rb +7 -1
  147. data/spec/models/earning_spec.rb +7 -1
  148. data/spec/models/employee_payroll_run_spec.rb +7 -1
  149. data/spec/models/employee_spec.rb +31 -1
  150. data/spec/models/employment_spec.rb +13 -1
  151. data/spec/models/employment_status_enum_spec.rb +1 -1
  152. data/spec/models/employment_type_enum_spec.rb +1 -1
  153. data/spec/models/end_user_details_request_spec.rb +7 -5
  154. data/spec/models/{end_user_details_spec.rb → error_validation_problem_spec.rb} +11 -15
  155. data/spec/models/ethnicity_enum_spec.rb +1 -1
  156. data/spec/models/flsa_status_enum_spec.rb +1 -1
  157. data/spec/models/gender_enum_spec.rb +1 -1
  158. data/spec/models/link_token_spec.rb +1 -1
  159. data/spec/models/location_spec.rb +13 -1
  160. data/spec/models/marital_status_enum_spec.rb +1 -1
  161. data/spec/models/method_enum_spec.rb +1 -1
  162. data/spec/models/model_operation_spec.rb +13 -1
  163. data/spec/models/paginated_account_details_and_actions_list_spec.rb +46 -0
  164. data/spec/models/paginated_bank_info_list_spec.rb +46 -0
  165. data/spec/models/paginated_benefit_list_spec.rb +1 -1
  166. data/spec/models/paginated_company_list_spec.rb +1 -1
  167. data/spec/models/paginated_deduction_list_spec.rb +46 -0
  168. data/spec/models/paginated_employee_list_spec.rb +1 -1
  169. data/spec/models/paginated_employee_payroll_run_list_spec.rb +1 -1
  170. data/spec/models/paginated_employment_list_spec.rb +1 -1
  171. data/spec/models/paginated_location_list_spec.rb +1 -1
  172. data/spec/models/paginated_pay_group_list_spec.rb +46 -0
  173. data/spec/models/paginated_payroll_run_list_spec.rb +1 -1
  174. data/spec/models/paginated_team_list_spec.rb +1 -1
  175. data/spec/models/paginated_time_off_list_spec.rb +1 -1
  176. data/spec/models/pay_currency_enum_spec.rb +1 -1
  177. data/spec/models/pay_frequency_enum_spec.rb +1 -1
  178. data/spec/models/{data_passthrough_spec.rb → pay_group_spec.rb} +11 -11
  179. data/spec/models/pay_period_enum_spec.rb +1 -1
  180. data/spec/models/payroll_run_spec.rb +7 -1
  181. data/spec/models/policy_type_enum_spec.rb +28 -0
  182. data/spec/models/remote_data_spec.rb +1 -1
  183. data/spec/models/remote_key_for_regeneration_request_spec.rb +1 -1
  184. data/spec/models/remote_key_spec.rb +1 -1
  185. data/spec/models/remote_response_spec.rb +1 -1
  186. data/spec/models/request_format_enum_spec.rb +28 -0
  187. data/spec/models/request_type_enum_spec.rb +1 -1
  188. data/spec/models/run_state_enum_spec.rb +1 -1
  189. data/spec/models/run_type_enum_spec.rb +1 -1
  190. data/spec/models/tax_spec.rb +7 -1
  191. data/spec/models/team_spec.rb +13 -1
  192. data/spec/models/time_off_balance_spec.rb +6 -0
  193. data/spec/models/{remote_key_for_regeneration_spec.rb → time_off_endpoint_request_spec.rb} +8 -8
  194. data/spec/models/time_off_request_spec.rb +88 -0
  195. data/spec/models/time_off_response_spec.rb +46 -0
  196. data/spec/models/time_off_spec.rb +19 -1
  197. data/spec/models/time_off_status_enum_spec.rb +1 -1
  198. data/spec/models/type_enum_spec.rb +1 -1
  199. data/spec/models/units_enum_spec.rb +1 -1
  200. data/spec/models/validation_problem_source_spec.rb +34 -0
  201. data/spec/models/warning_validation_problem_spec.rb +52 -0
  202. data/test_ruby.rb +11 -14
  203. metadata +115 -33
  204. data/docs/BenefitRequest.md +0 -28
  205. data/docs/DataPassthrough.md +0 -24
  206. data/docs/EmployeeRequest.md +0 -62
  207. data/docs/EmploymentRequest.md +0 -34
  208. data/docs/EndUserDetails.md +0 -24
  209. data/docs/RemoteKeyForRegeneration.md +0 -18
  210. data/lib/merge_hris_client/models/employee_request.rb +0 -523
  211. data/merge_hris_client-1.0.0.gem +0 -0
  212. data/merge_hris_client-1.0.1.gem +0 -0
  213. data/spec/models/employee_request_spec.rb +0 -160
@@ -4,88 +4,10 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**employments_create**](EmploymentsApi.md#employments_create) | **POST** /employments | |
8
7
  | [**employments_list**](EmploymentsApi.md#employments_list) | **GET** /employments | |
9
8
  | [**employments_retrieve**](EmploymentsApi.md#employments_retrieve) | **GET** /employments/{id} | |
10
9
 
11
10
 
12
- ## employments_create
13
-
14
- > <Employment> employments_create(x_account_token, opts)
15
-
16
-
17
-
18
- Creates an `Employment` object with the given values.
19
-
20
- ### Examples
21
-
22
- ```ruby
23
- require 'time'
24
- require 'merge_hris_client'
25
- # setup authorization
26
- MergeHRISClient.configure do |config|
27
- # Configure API key authorization: tokenAuth
28
- config.api_key['tokenAuth'] = 'YOUR API KEY'
29
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
- # config.api_key_prefix['tokenAuth'] = 'Bearer'
31
- end
32
-
33
- api_instance = MergeHRISClient::EmploymentsApi.new
34
- x_account_token = 'x_account_token_example' # String | Token identifying the end user.
35
- opts = {
36
- run_async: true, # Boolean | Whether or not third-party updates should be run asynchronously.
37
- employment_request: MergeHRISClient::EmploymentRequest.new # EmploymentRequest |
38
- }
39
-
40
- begin
41
-
42
- result = api_instance.employments_create(x_account_token, opts)
43
- p result
44
- rescue MergeHRISClient::ApiError => e
45
- puts "Error when calling EmploymentsApi->employments_create: #{e}"
46
- end
47
- ```
48
-
49
- #### Using the employments_create_with_http_info variant
50
-
51
- This returns an Array which contains the response data, status code and headers.
52
-
53
- > <Array(<Employment>, Integer, Hash)> employments_create_with_http_info(x_account_token, opts)
54
-
55
- ```ruby
56
- begin
57
-
58
- data, status_code, headers = api_instance.employments_create_with_http_info(x_account_token, opts)
59
- p status_code # => 2xx
60
- p headers # => { ... }
61
- p data # => <Employment>
62
- rescue MergeHRISClient::ApiError => e
63
- puts "Error when calling EmploymentsApi->employments_create_with_http_info: #{e}"
64
- end
65
- ```
66
-
67
- ### Parameters
68
-
69
- | Name | Type | Description | Notes |
70
- | ---- | ---- | ----------- | ----- |
71
- | **x_account_token** | **String** | Token identifying the end user. | |
72
- | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
73
- | **employment_request** | [**EmploymentRequest**](EmploymentRequest.md) | | [optional] |
74
-
75
- ### Return type
76
-
77
- [**Employment**](Employment.md)
78
-
79
- ### Authorization
80
-
81
- [tokenAuth](../README.md#tokenAuth)
82
-
83
- ### HTTP request headers
84
-
85
- - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
86
- - **Accept**: application/json
87
-
88
-
89
11
  ## employments_list
90
12
 
91
13
  > <PaginatedEmploymentList> employments_list(x_account_token, opts)
@@ -114,9 +36,12 @@ opts = {
114
36
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
115
37
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
116
38
  employee_id: 'employee_id_example', # String | If provided, will only return employments for this employee.
39
+ expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
40
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
117
41
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
118
42
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
119
43
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
44
+ order_by: '-effective_date', # String | Overrides the default ordering for this endpoint.
120
45
  page_size: 56, # Integer | Number of results to return per page.
121
46
  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
122
47
  }
@@ -157,9 +82,12 @@ end
157
82
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
158
83
  | **cursor** | **String** | The pagination cursor value. | [optional] |
159
84
  | **employee_id** | **String** | If provided, will only return employments for this employee. | [optional] |
85
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
86
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
160
87
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
161
88
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
162
89
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
90
+ | **order_by** | **String** | Overrides the default ordering for this endpoint. | [optional] |
163
91
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
164
92
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
165
93
 
@@ -238,6 +166,7 @@ end
238
166
  | ---- | ---- | ----------- | ----- |
239
167
  | **x_account_token** | **String** | Token identifying the end user. | |
240
168
  | **id** | [**String**](.md) | | |
169
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
241
170
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
242
171
 
243
172
  ### Return type
@@ -7,7 +7,7 @@
7
7
  | **end_user_email_address** | **String** | | |
8
8
  | **end_user_organization_name** | **String** | | |
9
9
  | **end_user_origin_id** | **String** | | |
10
- | **categories** | **Array&lt;String&gt;** | | [optional] |
10
+ | **categories** | [**Array&lt;CategoriesEnum&gt;**](CategoriesEnum.md) | | [optional] |
11
11
  | **integration** | **String** | | [optional] |
12
12
 
13
13
  ## Example
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::ErrorValidationProblem
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **source** | [**ValidationProblemSource**](ValidationProblemSource.md) | | [optional] |
8
+ | **title** | **String** | | |
9
+ | **detail** | **String** | | |
10
+ | **problem_type** | **String** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::ErrorValidationProblem.new(
18
+ source: null,
19
+ title: Missing Required Field,
20
+ detail: custom_fields is a required field on model.,
21
+ problem_type: MISSING_REQUIRED_FIELD
22
+ )
23
+ ```
24
+
@@ -0,0 +1,79 @@
1
+ # MergeHRISClient::ForceResyncApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**sync_status_resync_create**](ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync | |
8
+
9
+
10
+ ## sync_status_resync_create
11
+
12
+ > <SyncStatus> sync_status_resync_create(x_account_token)
13
+
14
+
15
+
16
+ Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
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['Authorization'] = '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['Authorization'] = 'Bearer'
29
+ end
30
+
31
+ api_instance = MergeHRISClient::ForceResyncApi.new
32
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
33
+
34
+ begin
35
+
36
+ result = api_instance.sync_status_resync_create(x_account_token)
37
+ p result
38
+ rescue MergeHRISClient::ApiError => e
39
+ puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the sync_status_resync_create_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
48
+
49
+ ```ruby
50
+ begin
51
+
52
+ data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <SyncStatus>
56
+ rescue MergeHRISClient::ApiError => e
57
+ puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **x_account_token** | **String** | Token identifying the end user. | |
66
+
67
+ ### Return type
68
+
69
+ [**SyncStatus**](SyncStatus.md)
70
+
71
+ ### Authorization
72
+
73
+ [tokenAuth](../README.md#tokenAuth)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: Not defined
78
+ - **Accept**: application/json
79
+
data/docs/IssuesApi.md CHANGED
@@ -25,20 +25,21 @@ require 'merge_hris_client'
25
25
  MergeHRISClient.configure do |config|
26
26
  # Configure API key authorization: tokenAuth
27
27
  config.api_key['Authorization'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
29
  config.api_key_prefix['Authorization'] = 'Bearer'
29
30
  end
30
31
 
31
32
  api_instance = MergeHRISClient::IssuesApi.new
32
33
  opts = {
33
- account_token: 'account_token_example', # String | account_token
34
- cursor: 56, # Integer | The pagination cursor value.
34
+ account_token: 'account_token_example', # String |
35
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
35
36
  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
36
- end_user_organization_name: 'end_user_organization_name_example', # String | end_user_organization_name
37
+ end_user_organization_name: 'end_user_organization_name_example', # String |
37
38
  include_muted: 'include_muted_example', # String | If True, will include muted issues
38
- integration_name: 'integration_name_example', # String | integration_name
39
+ integration_name: 'integration_name_example', # String |
39
40
  page_size: 56, # Integer | Number of results to return per page.
40
41
  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
41
- status: 'ONGOING' # String | status
42
+ status: 'ONGOING' # String |
42
43
  }
43
44
 
44
45
  begin
@@ -72,15 +73,15 @@ end
72
73
 
73
74
  | Name | Type | Description | Notes |
74
75
  | ---- | ---- | ----------- | ----- |
75
- | **account_token** | **String** | account_token | [optional] |
76
- | **cursor** | **Integer** | The pagination cursor value. | [optional] |
76
+ | **account_token** | **String** | | [optional] |
77
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
77
78
  | **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
78
- | **end_user_organization_name** | **String** | end_user_organization_name | [optional] |
79
+ | **end_user_organization_name** | **String** | | [optional] |
79
80
  | **include_muted** | **String** | If True, will include muted issues | [optional] |
80
- | **integration_name** | **String** | integration_name | [optional] |
81
+ | **integration_name** | **String** | | [optional] |
81
82
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
82
83
  | **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
83
- | **status** | **String** | status | [optional] |
84
+ | **status** | **String** | | [optional] |
84
85
 
85
86
  ### Return type
86
87
 
@@ -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['Authorization'] = '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['Authorization'] = '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] |
@@ -23,6 +24,7 @@ require 'merge_hris_client'
23
24
  instance = MergeHRISClient::Location.new(
24
25
  id: null,
25
26
  remote_id: 93018402,
27
+ name: NYC Office,
26
28
  phone_number: +1111111111,
27
29
  street_1: 2920 Broadway,
28
30
  street_2: 2nd Floor,
data/docs/LocationsApi.md CHANGED
@@ -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] |
@@ -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
+
@@ -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
  ```
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
+