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
@@ -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['Authorization'] = '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['Authorization'] = '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['Authorization'] = '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['Authorization'] = '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
  ```
@@ -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
 
@@ -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
+
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::RequestFormatEnum
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::RequestFormatEnum.new()
14
+ ```
15
+
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
14
14
 
15
15
 
16
16
 
17
- Get syncing status.
17
+ Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
18
18
 
19
19
  ### Examples
20
20
 
@@ -32,7 +32,7 @@ end
32
32
  api_instance = MergeHRISClient::SyncStatusApi.new
33
33
  x_account_token = 'x_account_token_example' # String | Token identifying the end user.
34
34
  opts = {
35
- cursor: 56, # Integer | The pagination cursor value.
35
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
36
36
  page_size: 56 # Integer | Number of results to return per page.
37
37
  }
38
38
 
@@ -68,7 +68,7 @@ end
68
68
  | Name | Type | Description | Notes |
69
69
  | ---- | ---- | ----------- | ----- |
70
70
  | **x_account_token** | **String** | Token identifying the end user. | |
71
- | **cursor** | **Integer** | The pagination cursor value. | [optional] |
71
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
72
72
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
73
73
 
74
74
  ### Return type
@@ -84,74 +84,3 @@ end
84
84
  - **Content-Type**: Not defined
85
85
  - **Accept**: application/json
86
86
 
87
-
88
- ## sync_status_resync_create
89
-
90
- > <SyncStatus> sync_status_resync_create(x_account_token)
91
-
92
-
93
-
94
- Force resync of all models.
95
-
96
- ### Examples
97
-
98
- ```ruby
99
- require 'time'
100
- require 'merge_hris_client'
101
- # setup authorization
102
- MergeHRISClient.configure do |config|
103
- # Configure API key authorization: tokenAuth
104
- config.api_key['tokenAuth'] = 'YOUR API KEY'
105
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
106
- # config.api_key_prefix['tokenAuth'] = 'Bearer'
107
- end
108
-
109
- api_instance = MergeHRISClient::SyncStatusApi.new
110
- x_account_token = 'x_account_token_example' # String | Token identifying the end user.
111
-
112
- begin
113
-
114
- result = api_instance.sync_status_resync_create(x_account_token)
115
- p result
116
- rescue MergeHRISClient::ApiError => e
117
- puts "Error when calling SyncStatusApi->sync_status_resync_create: #{e}"
118
- end
119
- ```
120
-
121
- #### Using the sync_status_resync_create_with_http_info variant
122
-
123
- This returns an Array which contains the response data, status code and headers.
124
-
125
- > <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
126
-
127
- ```ruby
128
- begin
129
-
130
- data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
131
- p status_code # => 2xx
132
- p headers # => { ... }
133
- p data # => <SyncStatus>
134
- rescue MergeHRISClient::ApiError => e
135
- puts "Error when calling SyncStatusApi->sync_status_resync_create_with_http_info: #{e}"
136
- end
137
- ```
138
-
139
- ### Parameters
140
-
141
- | Name | Type | Description | Notes |
142
- | ---- | ---- | ----------- | ----- |
143
- | **x_account_token** | **String** | Token identifying the end user. | |
144
-
145
- ### Return type
146
-
147
- [**SyncStatus**](SyncStatus.md)
148
-
149
- ### Authorization
150
-
151
- [tokenAuth](../README.md#tokenAuth)
152
-
153
- ### HTTP request headers
154
-
155
- - **Content-Type**: Not defined
156
- - **Accept**: application/json
157
-
data/docs/TeamsApi.md CHANGED
@@ -35,11 +35,13 @@ 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
+ expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
39
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
38
40
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
39
41
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
40
42
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
41
43
  page_size: 56, # Integer | Number of results to return per page.
42
- parent_team_id: TODO, # String | If provided, will only return teams with this parent team.
44
+ parent_team_id: 'parent_team_id_example', # String | If provided, will only return teams with this parent team.
43
45
  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
44
46
  }
45
47
 
@@ -78,11 +80,13 @@ end
78
80
  | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
79
81
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
80
82
  | **cursor** | **String** | The pagination cursor value. | [optional] |
83
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
84
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
81
85
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
82
86
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
83
87
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
84
88
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
85
- | **parent_team_id** | [**String**](.md) | If provided, will only return teams with this parent team. | [optional] |
89
+ | **parent_team_id** | **String** | If provided, will only return teams with this parent team. | [optional] |
86
90
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
87
91
 
88
92
  ### Return type
@@ -160,6 +164,7 @@ end
160
164
  | ---- | ---- | ----------- | ----- |
161
165
  | **x_account_token** | **String** | Token identifying the end user. | |
162
166
  | **id** | [**String**](.md) | | |
167
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
163
168
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
164
169
 
165
170
  ### Return type
data/docs/TimeOff.md CHANGED
@@ -30,10 +30,10 @@ instance = MergeHRISClient::TimeOff.new(
30
30
  status: APPROVED,
31
31
  employee_note: Trip to Iowa. Miss those cornfields!,
32
32
  units: DAYS,
33
- amount: 13,
33
+ amount: 7,
34
34
  request_type: VACATION,
35
- start_time: null,
36
- end_time: null,
35
+ start_time: 2020-11-10T00:00Z,
36
+ end_time: 2020-11-17T00:00Z,
37
37
  remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
38
38
  )
39
39
  ```
data/docs/TimeOffApi.md CHANGED
@@ -4,10 +4,88 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**time_off_create**](TimeOffApi.md#time_off_create) | **POST** /time-off | |
7
8
  | [**time_off_list**](TimeOffApi.md#time_off_list) | **GET** /time-off | |
8
9
  | [**time_off_retrieve**](TimeOffApi.md#time_off_retrieve) | **GET** /time-off/{id} | |
9
10
 
10
11
 
12
+ ## time_off_create
13
+
14
+ > <TimeOffResponse> time_off_create(x_account_token, time_off_endpoint_request, opts)
15
+
16
+
17
+
18
+ Creates a `TimeOff` 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['Authorization'] = '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['Authorization'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = MergeHRISClient::TimeOffApi.new
34
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
35
+ time_off_endpoint_request = MergeHRISClient::TimeOffEndpointRequest.new({model: MergeHRISClient::TimeOffRequest.new}) # TimeOffEndpointRequest |
36
+ opts = {
37
+ run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
38
+ }
39
+
40
+ begin
41
+
42
+ result = api_instance.time_off_create(x_account_token, time_off_endpoint_request, opts)
43
+ p result
44
+ rescue MergeHRISClient::ApiError => e
45
+ puts "Error when calling TimeOffApi->time_off_create: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the time_off_create_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<TimeOffResponse>, Integer, Hash)> time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts)
54
+
55
+ ```ruby
56
+ begin
57
+
58
+ data, status_code, headers = api_instance.time_off_create_with_http_info(x_account_token, time_off_endpoint_request, opts)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <TimeOffResponse>
62
+ rescue MergeHRISClient::ApiError => e
63
+ puts "Error when calling TimeOffApi->time_off_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
+ | **time_off_endpoint_request** | [**TimeOffEndpointRequest**](TimeOffEndpointRequest.md) | | |
73
+ | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
74
+
75
+ ### Return type
76
+
77
+ [**TimeOffResponse**](TimeOffResponse.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
+
11
89
  ## time_off_list
12
90
 
13
91
  > <PaginatedTimeOffList> time_off_list(x_account_token, opts)
@@ -26,7 +104,7 @@ MergeHRISClient.configure do |config|
26
104
  # Configure API key authorization: tokenAuth
27
105
  config.api_key['Authorization'] = 'YOUR API KEY'
28
106
  # 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'
107
+ config.api_key_prefix['Authorization'] = 'Bearer'
30
108
  end
31
109
 
32
110
  api_instance = MergeHRISClient::TimeOffApi.new
@@ -38,11 +116,14 @@ opts = {
38
116
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
39
117
  employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
40
118
  expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
119
+ include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
41
120
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
42
121
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
43
122
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
44
123
  page_size: 56, # Integer | Number of results to return per page.
45
- remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
124
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
125
+ request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
126
+ status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
46
127
  }
47
128
 
48
129
  begin
@@ -83,11 +164,14 @@ end
83
164
  | **cursor** | **String** | The pagination cursor value. | [optional] |
84
165
  | **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
85
166
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
167
+ | **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
86
168
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
87
169
  | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
88
170
  | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
89
171
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
90
172
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
173
+ | **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: (&#39;VACATION&#39;, &#39;SICK&#39;, &#39;PERSONAL&#39;, &#39;JURY_DUTY&#39;, &#39;VOLUNTEER&#39;, &#39;BEREAVEMENT&#39;) | [optional] |
174
+ | **status** | **String** | If provided, will only return TimeOff with this status. Options: (&#39;REQUESTED&#39;, &#39;APPROVED&#39;, &#39;DECLINED&#39;, &#39;CANCELLED&#39;, &#39;DELETED&#39;) | [optional] |
91
175
 
92
176
  ### Return type
93
177
 
@@ -109,7 +193,7 @@ end
109
193
 
110
194
 
111
195
 
112
- Returns an `TimeOff` object with the given `id`.
196
+ Returns a `TimeOff` object with the given `id`.
113
197
 
114
198
  ### Examples
115
199
 
@@ -121,7 +205,7 @@ MergeHRISClient.configure do |config|
121
205
  # Configure API key authorization: tokenAuth
122
206
  config.api_key['Authorization'] = 'YOUR API KEY'
123
207
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
124
- # config.api_key_prefix['Authorization'] = 'Bearer'
208
+ config.api_key_prefix['Authorization'] = 'Bearer'
125
209
  end
126
210
 
127
211
  api_instance = MergeHRISClient::TimeOffApi.new
@@ -7,8 +7,9 @@
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
9
  | **employee** | **String** | The employee the balance belongs to. | [optional] |
10
- | **balance** | **Float** | The current PTO balance. | [optional] |
11
- | **used** | **Float** | The amount of PTO used. | [optional] |
10
+ | **balance** | **Float** | The current PTO balance in terms of hours. | [optional] |
11
+ | **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
12
+ | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
12
13
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
13
14
 
14
15
  ## Example
@@ -22,6 +23,7 @@ instance = MergeHRISClient::TimeOffBalance.new(
22
23
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
23
24
  balance: 60.0,
24
25
  used: 45.0,
26
+ policy_type: VACATION,
25
27
  remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
26
28
  )
27
29
  ```