merge_hris_client 1.0.4 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (203) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -12
  3. data/docs/AccountDetails.md +11 -7
  4. data/docs/AccountDetailsAndActions.md +2 -0
  5. data/docs/AccountDetailsApi.md +10 -7
  6. data/docs/AccountIntegration.md +4 -4
  7. data/docs/AccountTokenApi.md +2 -2
  8. data/docs/AvailableActionsApi.md +2 -2
  9. data/docs/BankInfo.md +1 -1
  10. data/docs/BankInfoApi.md +8 -12
  11. data/docs/Benefit.md +2 -2
  12. data/docs/BenefitsApi.md +4 -4
  13. data/docs/CompaniesApi.md +4 -4
  14. data/docs/Company.md +2 -2
  15. data/docs/DataPassthroughRequest.md +3 -1
  16. data/docs/DebugModeLog.md +22 -0
  17. data/docs/DebugModelLogSummary.md +22 -0
  18. data/docs/Deduction.md +2 -2
  19. data/docs/DeductionsApi.md +4 -4
  20. data/docs/DeleteAccountApi.md +3 -2
  21. data/docs/Earning.md +3 -3
  22. data/docs/EarningTypeEnum.md +15 -0
  23. data/docs/Employee.md +17 -15
  24. data/docs/EmployeeEndpointRequest.md +18 -0
  25. data/docs/EmployeePayrollRun.md +2 -2
  26. data/docs/EmployeePayrollRunsApi.md +4 -4
  27. data/docs/EmployeeRequest.md +70 -0
  28. data/docs/EmployeeResponse.md +24 -0
  29. data/docs/EmployeesApi.md +232 -4
  30. data/docs/Employment.md +6 -4
  31. data/docs/EmploymentsApi.md +5 -4
  32. data/docs/EncodingEnum.md +15 -0
  33. data/docs/EndUserDetailsRequest.md +5 -3
  34. data/docs/ForceResyncApi.md +2 -2
  35. data/docs/GenerateKeyApi.md +2 -2
  36. data/docs/Group.md +28 -0
  37. data/docs/GroupTypeEnum.md +15 -0
  38. data/docs/GroupsApi.md +177 -0
  39. data/docs/IgnoreCommonModel.md +20 -0
  40. data/docs/IssuesApi.md +13 -4
  41. data/docs/LinkTokenApi.md +3 -3
  42. data/docs/LinkedAccountStatus.md +20 -0
  43. data/docs/LinkedAccountsApi.md +2 -2
  44. data/docs/Location.md +3 -1
  45. data/docs/LocationsApi.md +4 -4
  46. data/docs/MetaResponse.md +24 -0
  47. data/docs/MultipartFormFieldRequest.md +26 -0
  48. data/docs/PaginatedGroupList.md +22 -0
  49. data/docs/PassthroughApi.md +2 -2
  50. data/docs/PayGroupsApi.md +4 -4
  51. data/docs/PayrollRunsApi.md +4 -4
  52. data/docs/RegenerateKeyApi.md +2 -2
  53. data/docs/SyncStatusApi.md +0 -1
  54. data/docs/Tax.md +2 -2
  55. data/docs/Team.md +1 -1
  56. data/docs/TeamsApi.md +5 -4
  57. data/docs/TimeOff.md +4 -4
  58. data/docs/TimeOffApi.md +80 -6
  59. data/docs/TimeOffBalance.md +2 -2
  60. data/docs/TimeOffRequest.md +4 -4
  61. data/docs/TimeOffResponse.md +3 -1
  62. data/docs/WebhookReceiver.md +22 -0
  63. data/docs/WebhookReceiverRequest.md +22 -0
  64. data/docs/WebhookReceiversApi.md +153 -0
  65. data/lib/merge_hris_client/api/account_details_api.rb +10 -3
  66. data/lib/merge_hris_client/api/bank_info_api.rb +4 -9
  67. data/lib/merge_hris_client/api/employees_api.rb +216 -2
  68. data/lib/merge_hris_client/api/employments_api.rb +2 -2
  69. data/lib/merge_hris_client/api/groups_api.rb +182 -0
  70. data/lib/merge_hris_client/api/issues_api.rb +12 -0
  71. data/lib/merge_hris_client/api/linked_accounts_api.rb +1 -1
  72. data/lib/merge_hris_client/api/sync_status_api.rb +0 -62
  73. data/lib/merge_hris_client/api/time_off_api.rb +65 -0
  74. data/lib/merge_hris_client/api/webhook_receivers_api.rb +154 -0
  75. data/lib/merge_hris_client/configuration.rb +6 -4
  76. data/lib/merge_hris_client/models/account_details.rb +23 -5
  77. data/lib/merge_hris_client/models/account_details_and_actions.rb +16 -2
  78. data/lib/merge_hris_client/models/account_details_and_actions_integration.rb +1 -1
  79. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +1 -0
  80. data/lib/merge_hris_client/models/account_integration.rb +5 -27
  81. data/lib/merge_hris_client/models/account_token.rb +1 -1
  82. data/lib/merge_hris_client/models/account_type_enum.rb +1 -0
  83. data/lib/merge_hris_client/models/available_actions.rb +1 -1
  84. data/lib/merge_hris_client/models/bank_info.rb +0 -1
  85. data/lib/merge_hris_client/models/benefit.rb +1 -2
  86. data/lib/merge_hris_client/models/categories_enum.rb +1 -0
  87. data/lib/merge_hris_client/models/category_enum.rb +1 -0
  88. data/lib/merge_hris_client/models/company.rb +1 -1
  89. data/lib/merge_hris_client/models/country_enum.rb +1 -0
  90. data/lib/merge_hris_client/models/data_passthrough_request.rb +17 -3
  91. data/lib/merge_hris_client/models/debug_mode_log.rb +251 -0
  92. data/lib/merge_hris_client/models/debug_model_log_summary.rb +251 -0
  93. data/lib/merge_hris_client/models/deduction.rb +0 -1
  94. data/lib/merge_hris_client/models/earning.rb +4 -7
  95. data/lib/merge_hris_client/models/earning_type_enum.rb +38 -0
  96. data/lib/merge_hris_client/models/employee.rb +14 -9
  97. data/lib/merge_hris_client/models/employee_endpoint_request.rb +223 -0
  98. data/lib/merge_hris_client/models/employee_payroll_run.rb +1 -3
  99. data/lib/merge_hris_client/models/employee_request.rb +564 -0
  100. data/lib/merge_hris_client/models/employee_response.rb +266 -0
  101. data/lib/merge_hris_client/models/employment.rb +12 -3
  102. data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
  103. data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
  104. data/lib/merge_hris_client/models/encoding_enum.rb +36 -0
  105. data/lib/merge_hris_client/models/end_user_details_request.rb +74 -27
  106. data/lib/merge_hris_client/models/error_validation_problem.rb +1 -1
  107. data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
  108. data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
  109. data/lib/merge_hris_client/models/gender_enum.rb +1 -1
  110. data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -1
  111. data/lib/merge_hris_client/models/group.rb +275 -0
  112. data/lib/merge_hris_client/models/group_type_enum.rb +38 -0
  113. data/lib/merge_hris_client/models/ignore_common_model.rb +247 -0
  114. data/lib/merge_hris_client/models/ignore_common_model_request.rb +256 -0
  115. data/lib/merge_hris_client/models/issue.rb +1 -1
  116. data/lib/merge_hris_client/models/issue_status_enum.rb +1 -1
  117. data/lib/merge_hris_client/models/link_token.rb +1 -1
  118. data/lib/merge_hris_client/models/linked_account_status.rb +237 -0
  119. data/lib/merge_hris_client/models/location.rb +13 -2
  120. data/lib/merge_hris_client/models/location_type_enum.rb +36 -0
  121. data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
  122. data/lib/merge_hris_client/models/meta_response.rb +262 -0
  123. data/lib/merge_hris_client/models/method_enum.rb +1 -1
  124. data/lib/merge_hris_client/models/model_operation.rb +1 -1
  125. data/lib/merge_hris_client/models/multipart_form_field_request.rb +341 -0
  126. data/lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb +1 -1
  127. data/lib/merge_hris_client/models/paginated_bank_info_list.rb +1 -1
  128. data/lib/merge_hris_client/models/paginated_benefit_list.rb +1 -1
  129. data/lib/merge_hris_client/models/paginated_company_list.rb +1 -1
  130. data/lib/merge_hris_client/models/paginated_deduction_list.rb +1 -1
  131. data/lib/merge_hris_client/models/paginated_employee_list.rb +1 -1
  132. data/lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb +1 -1
  133. data/lib/merge_hris_client/models/paginated_employment_list.rb +1 -1
  134. data/lib/merge_hris_client/models/paginated_group_list.rb +240 -0
  135. data/lib/merge_hris_client/models/paginated_issue_list.rb +1 -1
  136. data/lib/merge_hris_client/models/paginated_location_list.rb +1 -1
  137. data/lib/merge_hris_client/models/paginated_pay_group_list.rb +1 -1
  138. data/lib/merge_hris_client/models/paginated_payroll_run_list.rb +1 -1
  139. data/lib/merge_hris_client/models/paginated_sync_status_list.rb +1 -1
  140. data/lib/merge_hris_client/models/paginated_team_list.rb +1 -1
  141. data/lib/merge_hris_client/models/paginated_time_off_balance_list.rb +1 -1
  142. data/lib/merge_hris_client/models/paginated_time_off_list.rb +1 -1
  143. data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
  144. data/lib/merge_hris_client/models/pay_frequency_enum.rb +1 -2
  145. data/lib/merge_hris_client/models/pay_period_enum.rb +1 -1
  146. data/lib/merge_hris_client/models/payroll_run.rb +1 -1
  147. data/lib/merge_hris_client/models/policy_type_enum.rb +1 -0
  148. data/lib/merge_hris_client/models/reason_enum.rb +37 -0
  149. data/lib/merge_hris_client/models/remote_data.rb +1 -1
  150. data/lib/merge_hris_client/models/remote_data_request.rb +1 -1
  151. data/lib/merge_hris_client/models/remote_key.rb +1 -1
  152. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -1
  153. data/lib/merge_hris_client/models/remote_response.rb +1 -1
  154. data/lib/merge_hris_client/models/request_format_enum.rb +2 -0
  155. data/lib/merge_hris_client/models/request_type_enum.rb +1 -0
  156. data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
  157. data/lib/merge_hris_client/models/run_type_enum.rb +1 -11
  158. data/lib/merge_hris_client/models/sync_status.rb +1 -1
  159. data/lib/merge_hris_client/models/sync_status_status_enum.rb +1 -2
  160. data/lib/merge_hris_client/models/tax.rb +3 -6
  161. data/lib/merge_hris_client/models/team.rb +0 -1
  162. data/lib/merge_hris_client/models/time_off.rb +0 -2
  163. data/lib/merge_hris_client/models/time_off_balance.rb +1 -2
  164. data/lib/merge_hris_client/models/time_off_endpoint_request.rb +1 -1
  165. data/lib/merge_hris_client/models/time_off_request.rb +1 -3
  166. data/lib/merge_hris_client/models/time_off_response.rb +16 -5
  167. data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
  168. data/lib/merge_hris_client/models/units_enum.rb +1 -1
  169. data/lib/merge_hris_client/models/validation_problem_source.rb +1 -1
  170. data/lib/merge_hris_client/models/warning_validation_problem.rb +1 -1
  171. data/lib/merge_hris_client/models/webhook_receiver.rb +246 -0
  172. data/lib/merge_hris_client/models/webhook_receiver_request.rb +280 -0
  173. data/lib/merge_hris_client/version.rb +1 -1
  174. data/lib/merge_hris_client.rb +21 -2
  175. data/pull_request_template.md +3 -1
  176. data/spec/api/account_details_api_spec.rb +1 -0
  177. data/spec/api/bank_info_api_spec.rb +2 -4
  178. data/spec/api/employees_api_spec.rb +38 -0
  179. data/spec/api/groups_api_spec.rb +68 -0
  180. data/spec/api/issues_api_spec.rb +4 -0
  181. data/spec/api/time_off_api_spec.rb +12 -0
  182. data/spec/models/account_details_and_actions_spec.rb +6 -0
  183. data/spec/models/account_details_spec.rb +12 -0
  184. data/spec/models/data_passthrough_request_spec.rb +6 -0
  185. data/spec/models/debug_mode_log_spec.rb +46 -0
  186. data/spec/models/debug_model_log_summary_spec.rb +46 -0
  187. data/spec/models/earning_type_enum_spec.rb +28 -0
  188. data/spec/models/employee_endpoint_request_spec.rb +34 -0
  189. data/spec/models/employee_request_spec.rb +190 -0
  190. data/spec/models/employee_response_spec.rb +52 -0
  191. data/spec/models/employee_spec.rb +6 -0
  192. data/spec/models/employment_spec.rb +6 -0
  193. data/spec/models/encoding_enum_spec.rb +28 -0
  194. data/spec/models/end_user_details_request_spec.rb +6 -0
  195. data/spec/models/group_spec.rb +64 -0
  196. data/spec/models/group_type_enum_spec.rb +28 -0
  197. data/spec/models/ignore_common_model_spec.rb +40 -0
  198. data/spec/models/location_spec.rb +6 -0
  199. data/spec/models/multipart_form_field_request_spec.rb +58 -0
  200. data/spec/models/paginated_group_list_spec.rb +46 -0
  201. data/spec/models/time_off_response_spec.rb +6 -0
  202. metadata +153 -89
  203. data/test_ruby.rb +0 -30
data/docs/GroupsApi.md ADDED
@@ -0,0 +1,177 @@
1
+ # MergeHRISClient::GroupsApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**groups_list**](GroupsApi.md#groups_list) | **GET** /groups | |
8
+ | [**groups_retrieve**](GroupsApi.md#groups_retrieve) | **GET** /groups/{id} | |
9
+
10
+
11
+ ## groups_list
12
+
13
+ > <PaginatedGroupList> groups_list(x_account_token, opts)
14
+
15
+
16
+
17
+ Returns a list of `Group` 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::GroupsApi.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.groups_list(x_account_token, opts)
49
+ p result
50
+ rescue MergeHRISClient::ApiError => e
51
+ puts "Error when calling GroupsApi->groups_list: #{e}"
52
+ end
53
+ ```
54
+
55
+ #### Using the groups_list_with_http_info variant
56
+
57
+ This returns an Array which contains the response data, status code and headers.
58
+
59
+ > <Array(<PaginatedGroupList>, Integer, Hash)> groups_list_with_http_info(x_account_token, opts)
60
+
61
+ ```ruby
62
+ begin
63
+
64
+ data, status_code, headers = api_instance.groups_list_with_http_info(x_account_token, opts)
65
+ p status_code # => 2xx
66
+ p headers # => { ... }
67
+ p data # => <PaginatedGroupList>
68
+ rescue MergeHRISClient::ApiError => e
69
+ puts "Error when calling GroupsApi->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
+ [**PaginatedGroupList**](PaginatedGroupList.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
+ ## groups_retrieve
103
+
104
+ > <Group> groups_retrieve(x_account_token, id, opts)
105
+
106
+
107
+
108
+ Returns a `Group` 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::GroupsApi.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.groups_retrieve(x_account_token, id, opts)
133
+ p result
134
+ rescue MergeHRISClient::ApiError => e
135
+ puts "Error when calling GroupsApi->groups_retrieve: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the groups_retrieve_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(<Group>, Integer, Hash)> groups_retrieve_with_http_info(x_account_token, id, opts)
144
+
145
+ ```ruby
146
+ begin
147
+
148
+ data, status_code, headers = api_instance.groups_retrieve_with_http_info(x_account_token, id, opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => <Group>
152
+ rescue MergeHRISClient::ApiError => e
153
+ puts "Error when calling GroupsApi->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
+ [**Group**](Group.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
+
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::IgnoreCommonModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **reason** | [**ReasonEnum**](ReasonEnum.md) | | |
8
+ | **message** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::IgnoreCommonModel.new(
16
+ reason: GENERAL_CUSTOMER_REQUEST,
17
+ message: deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39
18
+ )
19
+ ```
20
+
data/docs/IssuesApi.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::IssuesApi.new
@@ -35,8 +35,12 @@ opts = {
35
35
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
36
36
  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
37
37
  end_user_organization_name: 'end_user_organization_name_example', # String |
38
+ first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
39
+ first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
38
40
  include_muted: 'include_muted_example', # String | If True, will include muted issues
39
41
  integration_name: 'integration_name_example', # String |
42
+ last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
43
+ last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
40
44
  page_size: 56, # Integer | Number of results to return per page.
41
45
  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
42
46
  status: 'ONGOING' # String |
@@ -77,8 +81,12 @@ end
77
81
  | **cursor** | **String** | The pagination cursor value. | [optional] |
78
82
  | **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
79
83
  | **end_user_organization_name** | **String** | | [optional] |
84
+ | **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
85
+ | **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
80
86
  | **include_muted** | **String** | If True, will include muted issues | [optional] |
81
87
  | **integration_name** | **String** | | [optional] |
88
+ | **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
89
+ | **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
82
90
  | **page_size** | **Integer** | Number of results to return per page. | [optional] |
83
91
  | **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
84
92
  | **status** | **String** | | [optional] |
@@ -113,8 +121,9 @@ require 'merge_hris_client'
113
121
  # setup authorization
114
122
  MergeHRISClient.configure do |config|
115
123
  # Configure API key authorization: tokenAuth
116
- config.api_key['Authorization'] = 'YOUR API KEY'
117
- config.api_key_prefix['Authorization'] = 'Bearer'
124
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
125
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
126
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
118
127
  end
119
128
 
120
129
  api_instance = MergeHRISClient::IssuesApi.new
data/docs/LinkTokenApi.md CHANGED
@@ -23,13 +23,13 @@ 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::LinkTokenApi.new
32
- end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: ['hris']}) # EndUserDetailsRequest |
32
+ end_user_details_request = MergeHRISClient::EndUserDetailsRequest.new({end_user_email_address: 'end_user_email_address_example', end_user_organization_name: 'end_user_organization_name_example', end_user_origin_id: 'end_user_origin_id_example', categories: [MergeHRISClient::CategoriesEnum::HRIS]}) # EndUserDetailsRequest |
33
33
 
34
34
  begin
35
35
 
@@ -0,0 +1,20 @@
1
+ # MergeHRISClient::LinkedAccountStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **linked_account_status** | **String** | | |
8
+ | **can_make_request** | **Boolean** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'merge_hris_client'
14
+
15
+ instance = MergeHRISClient::LinkedAccountStatus.new(
16
+ linked_account_status: null,
17
+ can_make_request: null
18
+ )
19
+ ```
20
+
@@ -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::LinkedAccountsApi.new
data/docs/Location.md CHANGED
@@ -12,8 +12,9 @@
12
12
  | **street_2** | **String** | Line 2 of the location&#39;s street address. | [optional] |
13
13
  | **city** | **String** | The location&#39;s city. | [optional] |
14
14
  | **state** | **String** | The location&#39;s state. Represents a region if outside of the US. | [optional] |
15
- | **zip_code** | **String** | The location&#39;s zip code. | [optional] |
15
+ | **zip_code** | **String** | The location&#39;s zip code or postal code. | [optional] |
16
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] |
17
18
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
18
19
 
19
20
  ## Example
@@ -32,6 +33,7 @@ instance = MergeHRISClient::Location.new(
32
33
  state: NY,
33
34
  zip_code: 10027,
34
35
  country: USA,
36
+ location_type: WORK,
35
37
  remote_data: [{&quot;path&quot;:&quot;/locations&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
36
38
  )
37
39
  ```
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
@@ -115,9 +115,9 @@ require 'merge_hris_client'
115
115
  # setup authorization
116
116
  MergeHRISClient.configure do |config|
117
117
  # Configure API key authorization: tokenAuth
118
- config.api_key['Authorization'] = 'YOUR API KEY'
118
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
119
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'
120
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
121
121
  end
122
122
 
123
123
  api_instance = MergeHRISClient::LocationsApi.new
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::MetaResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_schema** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | |
8
+ | **status** | [**LinkedAccountStatus**](LinkedAccountStatus.md) | | [optional] |
9
+ | **has_conditional_params** | **Boolean** | | |
10
+ | **has_required_linked_account_params** | **Boolean** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::MetaResponse.new(
18
+ request_schema: null,
19
+ status: null,
20
+ has_conditional_params: null,
21
+ has_required_linked_account_params: null
22
+ )
23
+ ```
24
+
@@ -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::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
+
@@ -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/PayGroupsApi.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::PayGroupsApi.new
@@ -115,9 +115,9 @@ require 'merge_hris_client'
115
115
  # setup authorization
116
116
  MergeHRISClient.configure do |config|
117
117
  # Configure API key authorization: tokenAuth
118
- config.api_key['Authorization'] = 'YOUR API KEY'
118
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
119
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'
120
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
121
121
  end
122
122
 
123
123
  api_instance = MergeHRISClient::PayGroupsApi.new
@@ -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
@@ -125,9 +125,9 @@ require 'merge_hris_client'
125
125
  # setup authorization
126
126
  MergeHRISClient.configure do |config|
127
127
  # Configure API key authorization: tokenAuth
128
- config.api_key['Authorization'] = 'YOUR API KEY'
128
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
129
129
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
130
- # config.api_key_prefix['Authorization'] = 'Bearer'
130
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
131
131
  end
132
132
 
133
133
  api_instance = MergeHRISClient::PayrollRunsApi.new
@@ -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::RegenerateKeyApi.new
@@ -5,7 +5,6 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**sync_status_list**](SyncStatusApi.md#sync_status_list) | **GET** /sync-status | |
8
- | [**sync_status_resync_create**](SyncStatusApi.md#sync_status_resync_create) | **POST** /sync-status/resync | |
9
8
 
10
9
 
11
10
  ## sync_status_list
data/docs/Tax.md CHANGED
@@ -5,11 +5,11 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
- | **employee_payroll_run** | **String** | The tax&#39;s employee payroll run. | [optional] |
8
+ | **employee_payroll_run** | **String** | | [optional] |
9
9
  | **name** | **String** | The tax&#39;s name. | [optional] |
10
10
  | **amount** | **Float** | The tax amount. | [optional] |
11
11
  | **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
12
- | **remote_data** | **Array&lt;Hash&lt;String, AnyType&gt;&gt;** | | [optional] |
12
+ | **remote_data** | **String** | | [optional][readonly] |
13
13
 
14
14
  ## Example
15
15
 
data/docs/Team.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
9
  | **name** | **String** | The team&#39;s name. | [optional] |
10
- | **parent_team** | **String** | The team&#39;s parent team. | [optional] |
10
+ | **parent_team** | **String** | | [optional] |
11
11
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
12
12
 
13
13
  ## Example
data/docs/TeamsApi.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::TeamsApi.new
@@ -119,15 +119,16 @@ require 'merge_hris_client'
119
119
  # setup authorization
120
120
  MergeHRISClient.configure do |config|
121
121
  # Configure API key authorization: tokenAuth
122
- config.api_key['Authorization'] = 'YOUR API KEY'
122
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
123
123
  # 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'
124
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
125
125
  end
126
126
 
127
127
  api_instance = MergeHRISClient::TeamsApi.new
128
128
  x_account_token = 'x_account_token_example' # String | Token identifying the end user.
129
129
  id = TODO # String |
130
130
  opts = {
131
+ expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
131
132
  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
132
133
  }
133
134
 
data/docs/TimeOff.md CHANGED
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
- | **employee** | **String** | The employee requesting time off. | [optional] |
10
- | **approver** | **String** | The employee approving the time off request. | [optional] |
9
+ | **employee** | **String** | | [optional] |
10
+ | **approver** | **String** | | [optional] |
11
11
  | **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
12
12
  | **employee_note** | **String** | The employee note for this time off request. | [optional] |
13
13
  | **units** | [**UnitsEnum**](UnitsEnum.md) | The unit of time requested. | [optional] |
@@ -28,9 +28,9 @@ instance = MergeHRISClient::TimeOff.new(
28
28
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
29
29
  approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
30
30
  status: APPROVED,
31
- employee_note: Trip to Iowa. Miss those cornfields!,
31
+ employee_note: Moving into the new apartment Kendall Roy gave me!,
32
32
  units: DAYS,
33
- amount: 7,
33
+ amount: 3,
34
34
  request_type: VACATION,
35
35
  start_time: 2020-11-10T00:00Z,
36
36
  end_time: 2020-11-17T00:00Z,