merge_hris_client 3.2.1 → 3.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (226) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +49 -16
  3. data/docs/AccountDetails.md +3 -1
  4. data/docs/AccountDetailsAndActions.md +7 -3
  5. data/docs/AccountIntegration.md +8 -4
  6. data/docs/AdvancedMetadata.md +28 -0
  7. data/docs/AuditLogEvent.md +32 -0
  8. data/docs/AuditTrailApi.md +91 -0
  9. data/docs/BankInfo.md +6 -4
  10. data/docs/BankInfoApi.md +4 -4
  11. data/docs/Benefit.md +6 -4
  12. data/docs/CommonModelScopeAPI.md +18 -0
  13. data/docs/Company.md +6 -4
  14. data/docs/CreateFieldMappingRequest.md +28 -0
  15. data/docs/DataPassthroughRequest.md +4 -4
  16. data/docs/DebugModelLogSummary.md +1 -1
  17. data/docs/Deduction.md +6 -4
  18. data/docs/Dependent.md +6 -4
  19. data/docs/Earning.md +6 -4
  20. data/docs/Employee.md +7 -3
  21. data/docs/EmployeePayrollRun.md +6 -4
  22. data/docs/EmployeeRequest.md +2 -0
  23. data/docs/EmployeesApi.md +10 -4
  24. data/docs/EmployerBenefit.md +6 -4
  25. data/docs/Employment.md +6 -4
  26. data/docs/EmploymentsApi.md +4 -4
  27. data/docs/EndUserDetailsRequest.md +13 -7
  28. data/docs/EventTypeEnum.md +15 -0
  29. data/docs/ExternalTargetFieldAPI.md +22 -0
  30. data/docs/ExternalTargetFieldAPIResponse.md +48 -0
  31. data/docs/FieldMappingApi.md +455 -0
  32. data/docs/FieldMappingApiInstance.md +24 -0
  33. data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
  34. data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
  35. data/docs/FieldMappingApiInstanceResponse.md +48 -0
  36. data/docs/FieldMappingApiInstanceTargetField.md +22 -0
  37. data/docs/FieldMappingInstanceResponse.md +24 -0
  38. data/docs/FieldPermissionDeserializer.md +20 -0
  39. data/docs/FieldPermissionDeserializerRequest.md +20 -0
  40. data/docs/ForceResyncApi.md +1 -1
  41. data/docs/GenerateRemoteKeyRequest.md +1 -1
  42. data/docs/Group.md +9 -5
  43. data/docs/GroupsApi.md +8 -4
  44. data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
  45. data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
  46. data/docs/Issue.md +1 -1
  47. data/docs/IssuesApi.md +5 -3
  48. data/docs/LinkTokenApi.md +1 -1
  49. data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
  50. data/docs/LinkedAccountsApi.md +2 -2
  51. data/docs/Location.md +6 -4
  52. data/docs/LocationsApi.md +6 -4
  53. data/docs/MetaResponse.md +1 -1
  54. data/docs/ModelPermissionDeserializer.md +18 -0
  55. data/docs/ModelPermissionDeserializerRequest.md +18 -0
  56. data/docs/PaginatedAuditLogEventList.md +22 -0
  57. data/docs/PaginatedTimesheetEntryList.md +22 -0
  58. data/docs/PatchedEditFieldMappingRequest.md +22 -0
  59. data/docs/PayGroup.md +6 -4
  60. data/docs/PayrollRun.md +6 -4
  61. data/docs/PayrollRunsApi.md +4 -4
  62. data/docs/RemoteEndpointInfo.md +22 -0
  63. data/docs/RemoteFieldAPI.md +28 -0
  64. data/docs/RemoteFieldAPIResponse.md +48 -0
  65. data/docs/RemoteKeyForRegenerationRequest.md +1 -1
  66. data/docs/RoleEnum.md +15 -0
  67. data/docs/ScopesApi.md +222 -0
  68. data/docs/SyncStatusApi.md +1 -1
  69. data/docs/Tax.md +6 -4
  70. data/docs/Team.md +6 -4
  71. data/docs/TimeOff.md +5 -3
  72. data/docs/TimeOffApi.md +12 -4
  73. data/docs/TimeOffBalance.md +6 -4
  74. data/docs/TimeOffBalancesApi.md +4 -4
  75. data/docs/TimesheetEntriesApi.md +341 -0
  76. data/docs/TimesheetEntry.md +38 -0
  77. data/docs/TimesheetEntryEndpointRequest.md +18 -0
  78. data/docs/TimesheetEntryRequest.md +28 -0
  79. data/docs/TimesheetEntryResponse.md +24 -0
  80. data/lib/merge_hris_client/api/audit_trail_api.rb +95 -0
  81. data/lib/merge_hris_client/api/bank_info_api.rb +4 -4
  82. data/lib/merge_hris_client/api/employees_api.rb +13 -4
  83. data/lib/merge_hris_client/api/employments_api.rb +4 -4
  84. data/lib/merge_hris_client/api/field_mapping_api.rb +424 -0
  85. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  86. data/lib/merge_hris_client/api/groups_api.rb +10 -4
  87. data/lib/merge_hris_client/api/issues_api.rb +7 -4
  88. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
  89. data/lib/merge_hris_client/api/locations_api.rb +11 -4
  90. data/lib/merge_hris_client/api/payroll_runs_api.rb +4 -4
  91. data/lib/merge_hris_client/api/scopes_api.rb +209 -0
  92. data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
  93. data/lib/merge_hris_client/api/time_off_api.rb +16 -4
  94. data/lib/merge_hris_client/api/time_off_balances_api.rb +4 -4
  95. data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
  96. data/lib/merge_hris_client/configuration.rb +4 -0
  97. data/lib/merge_hris_client/models/account_details.rb +14 -5
  98. data/lib/merge_hris_client/models/account_details_and_actions.rb +28 -4
  99. data/lib/merge_hris_client/models/account_integration.rb +36 -14
  100. data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
  101. data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
  102. data/lib/merge_hris_client/models/bank_info.rb +24 -16
  103. data/lib/merge_hris_client/models/benefit.rb +24 -16
  104. data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
  105. data/lib/merge_hris_client/models/company.rb +24 -16
  106. data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
  107. data/lib/merge_hris_client/models/data_passthrough_request.rb +3 -0
  108. data/lib/merge_hris_client/models/deduction.rb +24 -16
  109. data/lib/merge_hris_client/models/dependent.rb +24 -16
  110. data/lib/merge_hris_client/models/earning.rb +24 -16
  111. data/lib/merge_hris_client/models/employee.rb +34 -15
  112. data/lib/merge_hris_client/models/employee_payroll_run.rb +24 -16
  113. data/lib/merge_hris_client/models/employee_request.rb +12 -1
  114. data/lib/merge_hris_client/models/employer_benefit.rb +24 -16
  115. data/lib/merge_hris_client/models/employment.rb +24 -16
  116. data/lib/merge_hris_client/models/end_user_details_request.rb +67 -6
  117. data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
  118. data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
  119. data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
  120. data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
  121. data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
  122. data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
  123. data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
  124. data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
  125. data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
  126. data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
  127. data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
  128. data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
  129. data/lib/merge_hris_client/models/group.rb +34 -15
  130. data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
  131. data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
  132. data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
  133. data/lib/merge_hris_client/models/location.rb +24 -16
  134. data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
  135. data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
  136. data/lib/merge_hris_client/models/paginated_audit_log_event_list.rb +240 -0
  137. data/lib/merge_hris_client/models/paginated_timesheet_entry_list.rb +240 -0
  138. data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
  139. data/lib/merge_hris_client/models/pay_group.rb +24 -16
  140. data/lib/merge_hris_client/models/payroll_run.rb +24 -16
  141. data/lib/merge_hris_client/models/remote_endpoint_info.rb +253 -0
  142. data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
  143. data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
  144. data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
  145. data/lib/merge_hris_client/models/role_enum.rb +49 -0
  146. data/lib/merge_hris_client/models/tax.rb +24 -16
  147. data/lib/merge_hris_client/models/team.rb +24 -16
  148. data/lib/merge_hris_client/models/time_off.rb +23 -15
  149. data/lib/merge_hris_client/models/time_off_balance.rb +24 -16
  150. data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
  151. data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
  152. data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
  153. data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
  154. data/lib/merge_hris_client/version.rb +1 -1
  155. data/lib/merge_hris_client.rb +35 -21
  156. data/spec/api/audit_trail_api_spec.rb +51 -0
  157. data/spec/api/bank_info_api_spec.rb +2 -2
  158. data/spec/api/employees_api_spec.rb +5 -2
  159. data/spec/api/employments_api_spec.rb +2 -2
  160. data/spec/api/field_mapping_api_spec.rb +107 -0
  161. data/spec/api/force_resync_api_spec.rb +1 -1
  162. data/spec/api/groups_api_spec.rb +4 -2
  163. data/spec/api/issues_api_spec.rb +3 -2
  164. data/spec/api/linked_accounts_api_spec.rb +1 -1
  165. data/spec/api/locations_api_spec.rb +3 -2
  166. data/spec/api/payroll_runs_api_spec.rb +2 -2
  167. data/spec/api/scopes_api_spec.rb +68 -0
  168. data/spec/api/sync_status_api_spec.rb +1 -1
  169. data/spec/api/time_off_api_spec.rb +6 -2
  170. data/spec/api/time_off_balances_api_spec.rb +2 -2
  171. data/spec/api/timesheet_entries_api_spec.rb +99 -0
  172. data/spec/models/account_details_and_actions_spec.rb +12 -0
  173. data/spec/models/account_details_spec.rb +6 -0
  174. data/spec/models/account_integration_spec.rb +14 -2
  175. data/spec/models/advanced_metadata_spec.rb +64 -0
  176. data/spec/models/audit_log_event_spec.rb +76 -0
  177. data/spec/models/bank_info_spec.rb +12 -6
  178. data/spec/models/benefit_spec.rb +12 -6
  179. data/spec/models/common_model_scope_api_spec.rb +34 -0
  180. data/spec/models/company_spec.rb +11 -5
  181. data/spec/models/create_field_mapping_request_spec.rb +64 -0
  182. data/spec/models/deduction_spec.rb +12 -6
  183. data/spec/models/dependent_spec.rb +12 -6
  184. data/spec/models/earning_spec.rb +11 -5
  185. data/spec/models/employee_payroll_run_spec.rb +12 -6
  186. data/spec/models/employee_request_spec.rb +6 -0
  187. data/spec/models/employee_spec.rb +18 -6
  188. data/spec/models/employer_benefit_spec.rb +12 -6
  189. data/spec/models/employment_spec.rb +12 -6
  190. data/spec/models/end_user_details_request_spec.rb +18 -0
  191. data/spec/models/event_type_enum_spec.rb +28 -0
  192. data/spec/models/external_target_field_api_response_spec.rb +124 -0
  193. data/spec/models/external_target_field_api_spec.rb +46 -0
  194. data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
  195. data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
  196. data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
  197. data/spec/models/field_mapping_api_instance_spec.rb +52 -0
  198. data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
  199. data/spec/models/field_mapping_instance_response_spec.rb +52 -0
  200. data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
  201. data/spec/models/field_permission_deserializer_spec.rb +40 -0
  202. data/spec/models/group_spec.rb +13 -1
  203. data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
  204. data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
  205. data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -0
  206. data/spec/models/location_spec.rb +12 -6
  207. data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
  208. data/spec/models/model_permission_deserializer_spec.rb +34 -0
  209. data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
  210. data/spec/models/paginated_timesheet_entry_list_spec.rb +46 -0
  211. data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
  212. data/spec/models/pay_group_spec.rb +9 -3
  213. data/spec/models/payroll_run_spec.rb +12 -6
  214. data/spec/models/remote_endpoint_info_spec.rb +46 -0
  215. data/spec/models/remote_field_api_response_spec.rb +124 -0
  216. data/spec/models/remote_field_api_spec.rb +64 -0
  217. data/spec/models/role_enum_spec.rb +28 -0
  218. data/spec/models/tax_spec.rb +12 -6
  219. data/spec/models/team_spec.rb +10 -4
  220. data/spec/models/time_off_balance_spec.rb +12 -6
  221. data/spec/models/time_off_spec.rb +12 -6
  222. data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
  223. data/spec/models/timesheet_entry_request_spec.rb +64 -0
  224. data/spec/models/timesheet_entry_response_spec.rb +52 -0
  225. data/spec/models/timesheet_entry_spec.rb +94 -0
  226. metadata +266 -126
@@ -0,0 +1,28 @@
1
+ # MergeHRISClient::RemoteFieldAPI
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
8
+ | **remote_key_name** | **String** | | |
9
+ | **remote_endpoint_info** | [**RemoteEndpointInfo**](RemoteEndpointInfo.md) | | |
10
+ | **example_values** | [**Array<AnyType>**](AnyType.md) | | [optional] |
11
+ | **advanced_metadata** | [**AdvancedMetadata**](AdvancedMetadata.md) | | |
12
+ | **coverage** | [**OneOfintegerdouble**](OneOfintegerdouble.md) | | [optional][readonly] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'merge_hris_client'
18
+
19
+ instance = MergeHRISClient::RemoteFieldAPI.new(
20
+ schema: {"type":"string"},
21
+ remote_key_name: example_remote_key_name,
22
+ remote_endpoint_info: null,
23
+ example_values: ["example"],
24
+ advanced_metadata: null,
25
+ coverage: 0.33
26
+ )
27
+ ```
28
+
@@ -0,0 +1,48 @@
1
+ # MergeHRISClient::RemoteFieldAPIResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **benefit** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
8
+ | **employer_benefit** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
9
+ | **company** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
10
+ | **employee_payroll_run** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
11
+ | **employee** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
12
+ | **employment** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
13
+ | **location** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
14
+ | **payroll_run** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
15
+ | **team** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
16
+ | **time_off** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
17
+ | **time_off_balance** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
18
+ | **bank_info** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
19
+ | **pay_group** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
20
+ | **group** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
21
+ | **dependent** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
22
+ | **timesheet_entry** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'merge_hris_client'
28
+
29
+ instance = MergeHRISClient::RemoteFieldAPIResponse.new(
30
+ benefit: null,
31
+ employer_benefit: null,
32
+ company: null,
33
+ employee_payroll_run: null,
34
+ employee: null,
35
+ employment: null,
36
+ location: null,
37
+ payroll_run: null,
38
+ team: null,
39
+ time_off: null,
40
+ time_off_balance: null,
41
+ bank_info: null,
42
+ pay_group: null,
43
+ group: null,
44
+ dependent: null,
45
+ timesheet_entry: null
46
+ )
47
+ ```
48
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | |
7
+ | **name** | **String** | The name of the remote key | |
8
8
 
9
9
  ## Example
10
10
 
data/docs/RoleEnum.md ADDED
@@ -0,0 +1,15 @@
1
+ # MergeHRISClient::RoleEnum
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::RoleEnum.new()
14
+ ```
15
+
data/docs/ScopesApi.md ADDED
@@ -0,0 +1,222 @@
1
+ # MergeHRISClient::ScopesApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**default_scopes_retrieve**](ScopesApi.md#default_scopes_retrieve) | **GET** /default-scopes | |
8
+ | [**linked_account_scopes_create**](ScopesApi.md#linked_account_scopes_create) | **POST** /linked-account-scopes | |
9
+ | [**linked_account_scopes_retrieve**](ScopesApi.md#linked_account_scopes_retrieve) | **GET** /linked-account-scopes | |
10
+
11
+
12
+ ## default_scopes_retrieve
13
+
14
+ > <CommonModelScopeAPI> default_scopes_retrieve
15
+
16
+
17
+
18
+ Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
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::ScopesApi.new
34
+
35
+ begin
36
+
37
+ result = api_instance.default_scopes_retrieve
38
+ p result
39
+ rescue MergeHRISClient::ApiError => e
40
+ puts "Error when calling ScopesApi->default_scopes_retrieve: #{e}"
41
+ end
42
+ ```
43
+
44
+ #### Using the default_scopes_retrieve_with_http_info variant
45
+
46
+ This returns an Array which contains the response data, status code and headers.
47
+
48
+ > <Array(<CommonModelScopeAPI>, Integer, Hash)> default_scopes_retrieve_with_http_info
49
+
50
+ ```ruby
51
+ begin
52
+
53
+ data, status_code, headers = api_instance.default_scopes_retrieve_with_http_info
54
+ p status_code # => 2xx
55
+ p headers # => { ... }
56
+ p data # => <CommonModelScopeAPI>
57
+ rescue MergeHRISClient::ApiError => e
58
+ puts "Error when calling ScopesApi->default_scopes_retrieve_with_http_info: #{e}"
59
+ end
60
+ ```
61
+
62
+ ### Parameters
63
+
64
+ This endpoint does not need any parameter.
65
+
66
+ ### Return type
67
+
68
+ [**CommonModelScopeAPI**](CommonModelScopeAPI.md)
69
+
70
+ ### Authorization
71
+
72
+ [tokenAuth](../README.md#tokenAuth)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
78
+
79
+
80
+ ## linked_account_scopes_create
81
+
82
+ > <CommonModelScopeAPI> linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request)
83
+
84
+
85
+
86
+ Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
87
+
88
+ ### Examples
89
+
90
+ ```ruby
91
+ require 'time'
92
+ require 'merge_hris_client'
93
+ # setup authorization
94
+ MergeHRISClient.configure do |config|
95
+ # Configure API key authorization: tokenAuth
96
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
97
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
98
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
99
+ end
100
+
101
+ api_instance = MergeHRISClient::ScopesApi.new
102
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
103
+ linked_account_common_model_scope_deserializer_request = MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest.new({common_models: [MergeHRISClient::IndividualCommonModelScopeDeserializerRequest.new({model_name: 'model_name_example'})]}) # LinkedAccountCommonModelScopeDeserializerRequest |
104
+
105
+ begin
106
+
107
+ result = api_instance.linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request)
108
+ p result
109
+ rescue MergeHRISClient::ApiError => e
110
+ puts "Error when calling ScopesApi->linked_account_scopes_create: #{e}"
111
+ end
112
+ ```
113
+
114
+ #### Using the linked_account_scopes_create_with_http_info variant
115
+
116
+ This returns an Array which contains the response data, status code and headers.
117
+
118
+ > <Array(<CommonModelScopeAPI>, Integer, Hash)> linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request)
119
+
120
+ ```ruby
121
+ begin
122
+
123
+ data, status_code, headers = api_instance.linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request)
124
+ p status_code # => 2xx
125
+ p headers # => { ... }
126
+ p data # => <CommonModelScopeAPI>
127
+ rescue MergeHRISClient::ApiError => e
128
+ puts "Error when calling ScopesApi->linked_account_scopes_create_with_http_info: #{e}"
129
+ end
130
+ ```
131
+
132
+ ### Parameters
133
+
134
+ | Name | Type | Description | Notes |
135
+ | ---- | ---- | ----------- | ----- |
136
+ | **x_account_token** | **String** | Token identifying the end user. | |
137
+ | **linked_account_common_model_scope_deserializer_request** | [**LinkedAccountCommonModelScopeDeserializerRequest**](LinkedAccountCommonModelScopeDeserializerRequest.md) | | |
138
+
139
+ ### Return type
140
+
141
+ [**CommonModelScopeAPI**](CommonModelScopeAPI.md)
142
+
143
+ ### Authorization
144
+
145
+ [tokenAuth](../README.md#tokenAuth)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
150
+ - **Accept**: application/json
151
+
152
+
153
+ ## linked_account_scopes_retrieve
154
+
155
+ > <CommonModelScopeAPI> linked_account_scopes_retrieve(x_account_token)
156
+
157
+
158
+
159
+ Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
160
+
161
+ ### Examples
162
+
163
+ ```ruby
164
+ require 'time'
165
+ require 'merge_hris_client'
166
+ # setup authorization
167
+ MergeHRISClient.configure do |config|
168
+ # Configure API key authorization: tokenAuth
169
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
170
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
171
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
172
+ end
173
+
174
+ api_instance = MergeHRISClient::ScopesApi.new
175
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
176
+
177
+ begin
178
+
179
+ result = api_instance.linked_account_scopes_retrieve(x_account_token)
180
+ p result
181
+ rescue MergeHRISClient::ApiError => e
182
+ puts "Error when calling ScopesApi->linked_account_scopes_retrieve: #{e}"
183
+ end
184
+ ```
185
+
186
+ #### Using the linked_account_scopes_retrieve_with_http_info variant
187
+
188
+ This returns an Array which contains the response data, status code and headers.
189
+
190
+ > <Array(<CommonModelScopeAPI>, Integer, Hash)> linked_account_scopes_retrieve_with_http_info(x_account_token)
191
+
192
+ ```ruby
193
+ begin
194
+
195
+ data, status_code, headers = api_instance.linked_account_scopes_retrieve_with_http_info(x_account_token)
196
+ p status_code # => 2xx
197
+ p headers # => { ... }
198
+ p data # => <CommonModelScopeAPI>
199
+ rescue MergeHRISClient::ApiError => e
200
+ puts "Error when calling ScopesApi->linked_account_scopes_retrieve_with_http_info: #{e}"
201
+ end
202
+ ```
203
+
204
+ ### Parameters
205
+
206
+ | Name | Type | Description | Notes |
207
+ | ---- | ---- | ----------- | ----- |
208
+ | **x_account_token** | **String** | Token identifying the end user. | |
209
+
210
+ ### Return type
211
+
212
+ [**CommonModelScopeAPI**](CommonModelScopeAPI.md)
213
+
214
+ ### Authorization
215
+
216
+ [tokenAuth](../README.md#tokenAuth)
217
+
218
+ ### HTTP request headers
219
+
220
+ - **Content-Type**: Not defined
221
+ - **Accept**: application/json
222
+
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
13
13
 
14
14
 
15
15
 
16
- Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`
16
+ Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
17
17
 
18
18
  ### Examples
19
19
 
data/docs/Tax.md CHANGED
@@ -6,13 +6,14 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
10
+ | **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
9
11
  | **employee_payroll_run** | **String** | | [optional] |
10
12
  | **name** | **String** | The tax&#39;s name. | [optional] |
11
13
  | **amount** | **Float** | The tax amount. | [optional] |
12
14
  | **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
13
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional] |
14
- | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
15
- | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
15
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional] |
16
+ | **field_mappings** | **Object** | | [optional][readonly] |
16
17
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
17
18
 
18
19
  ## Example
@@ -23,12 +24,13 @@ require 'merge_hris_client'
23
24
  instance = MergeHRISClient::Tax.new(
24
25
  id: e3a825fd-c38d-4095-a717-df98c4cb9ebc,
25
26
  remote_id: 26806834,
27
+ created_at: 2021-09-15T00:00Z,
28
+ modified_at: 2021-10-16T00:00Z,
26
29
  employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
27
30
  name: California State Income Tax,
28
31
  amount: 100.25,
29
32
  employer_tax: false,
30
33
  remote_was_deleted: null,
31
- modified_at: 2021-10-16T00:00Z,
32
34
  field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
33
35
  remote_data: null
34
36
  )
data/docs/Team.md CHANGED
@@ -6,11 +6,12 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
10
+ | **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
9
11
  | **name** | **String** | The team&#39;s name. | [optional] |
10
12
  | **parent_team** | **String** | The team&#39;s parent team. | [optional] |
11
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
12
- | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
13
- | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
13
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
14
+ | **field_mappings** | **Object** | | [optional][readonly] |
14
15
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
15
16
 
16
17
  ## Example
@@ -21,10 +22,11 @@ require 'merge_hris_client'
21
22
  instance = MergeHRISClient::Team.new(
22
23
  id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba,
23
24
  remote_id: 19202938,
25
+ created_at: 2021-09-15T00:00Z,
26
+ modified_at: 2021-10-16T00:00Z,
24
27
  name: Engineering,
25
28
  parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
26
29
  remote_was_deleted: null,
27
- modified_at: 2021-10-16T00:00Z,
28
30
  field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
29
31
  remote_data: [{&quot;path&quot;:&quot;/teams&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
30
32
  )
data/docs/TimeOff.md CHANGED
@@ -6,6 +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
+ | **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
10
+ | **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
9
11
  | **employee** | **String** | The employee requesting time off. | [optional] |
10
12
  | **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
11
13
  | **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * &#x60;REQUESTED&#x60; - REQUESTED * &#x60;APPROVED&#x60; - APPROVED * &#x60;DECLINED&#x60; - DECLINED * &#x60;CANCELLED&#x60; - CANCELLED * &#x60;DELETED&#x60; - DELETED | [optional] |
@@ -16,8 +18,7 @@
16
18
  | **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
17
19
  | **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
18
20
  | **remote_was_deleted** | **Boolean** | | [optional][readonly] |
19
- | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
20
- | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
21
+ | **field_mappings** | **Object** | | [optional][readonly] |
21
22
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
22
23
 
23
24
  ## Example
@@ -28,6 +29,8 @@ require 'merge_hris_client'
28
29
  instance = MergeHRISClient::TimeOff.new(
29
30
  id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
30
31
  remote_id: 19202938,
32
+ created_at: 2021-09-15T00:00Z,
33
+ modified_at: 2021-10-16T00:00Z,
31
34
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
32
35
  approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
33
36
  status: APPROVED,
@@ -38,7 +41,6 @@ instance = MergeHRISClient::TimeOff.new(
38
41
  start_time: 2020-11-10T00:00Z,
39
42
  end_time: 2020-11-17T00:00Z,
40
43
  remote_was_deleted: null,
41
- modified_at: 2021-10-16T00:00Z,
42
44
  field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
43
45
  remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
44
46
  )
data/docs/TimeOffApi.md CHANGED
@@ -118,6 +118,8 @@ opts = {
118
118
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
119
119
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
120
120
  employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
121
+ ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that ended after this datetime.
122
+ ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return time-offs that ended before this datetime.
121
123
  expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
122
124
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
123
125
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -127,7 +129,9 @@ opts = {
127
129
  remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
128
130
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
129
131
  request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
130
- show_enum_origins: 'request_type', # String | Which fields should be returned in non-normalized form.
132
+ show_enum_origins: 'request_type', # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
133
+ started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return time-offs that started after this datetime.
134
+ started_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return time-offs that started before this datetime.
131
135
  status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
132
136
  }
133
137
 
@@ -168,6 +172,8 @@ end
168
172
  | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
169
173
  | **cursor** | **String** | The pagination cursor value. | [optional] |
170
174
  | **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
175
+ | **ended_after** | **Time** | If provided, will only return employees that ended after this datetime. | [optional] |
176
+ | **ended_before** | **Time** | If provided, will only return time-offs that ended before this datetime. | [optional] |
171
177
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
172
178
  | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
173
179
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
@@ -177,7 +183,9 @@ end
177
183
  | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
178
184
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
179
185
  | **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;) * &#x60;VACATION&#x60; - VACATION * &#x60;SICK&#x60; - SICK * &#x60;PERSONAL&#x60; - PERSONAL * &#x60;JURY_DUTY&#x60; - JURY_DUTY * &#x60;VOLUNTEER&#x60; - VOLUNTEER * &#x60;BEREAVEMENT&#x60; - BEREAVEMENT | [optional] |
180
- | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
186
+ | **show_enum_origins** | **String** | A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
187
+ | **started_after** | **Time** | If provided, will only return time-offs that started after this datetime. | [optional] |
188
+ | **started_before** | **Time** | If provided, will only return time-offs that started before this datetime. | [optional] |
181
189
  | **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;) * &#x60;REQUESTED&#x60; - REQUESTED * &#x60;APPROVED&#x60; - APPROVED * &#x60;DECLINED&#x60; - DECLINED * &#x60;CANCELLED&#x60; - CANCELLED * &#x60;DELETED&#x60; - DELETED | [optional] |
182
190
 
183
191
  ### Return type
@@ -293,7 +301,7 @@ opts = {
293
301
  expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
294
302
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
295
303
  remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
296
- show_enum_origins: 'request_type' # String | Which fields should be returned in non-normalized form.
304
+ show_enum_origins: 'request_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
297
305
  }
298
306
 
299
307
  begin
@@ -332,7 +340,7 @@ end
332
340
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
333
341
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
334
342
  | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
335
- | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
343
+ | **show_enum_origins** | **String** | A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
336
344
 
337
345
  ### Return type
338
346
 
@@ -6,13 +6,14 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional][readonly] |
8
8
  | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
10
+ | **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
9
11
  | **employee** | **String** | The employee the balance belongs to. | [optional] |
10
12
  | **balance** | **Float** | The current remaining PTO balance, always measured in terms of hours. | [optional] |
11
13
  | **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
12
14
  | **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. * &#x60;VACATION&#x60; - VACATION * &#x60;SICK&#x60; - SICK * &#x60;PERSONAL&#x60; - PERSONAL * &#x60;JURY_DUTY&#x60; - JURY_DUTY * &#x60;VOLUNTEER&#x60; - VOLUNTEER * &#x60;BEREAVEMENT&#x60; - BEREAVEMENT | [optional] |
13
- | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
14
- | **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
15
- | **field_mappings** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional][readonly] |
15
+ | **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
16
+ | **field_mappings** | **Object** | | [optional][readonly] |
16
17
  | **remote_data** | [**Array&lt;RemoteData&gt;**](RemoteData.md) | | [optional][readonly] |
17
18
 
18
19
  ## Example
@@ -23,12 +24,13 @@ require 'merge_hris_client'
23
24
  instance = MergeHRISClient::TimeOffBalance.new(
24
25
  id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
25
26
  remote_id: 19202938,
27
+ created_at: 2021-09-15T00:00Z,
28
+ modified_at: 2021-10-16T00:00Z,
26
29
  employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
27
30
  balance: 60.0,
28
31
  used: 45.0,
29
32
  policy_type: VACATION,
30
33
  remote_was_deleted: null,
31
- modified_at: 2021-10-16T00:00Z,
32
34
  field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
33
35
  remote_data: [{&quot;path&quot;:&quot;/leave&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
34
36
  )
@@ -45,7 +45,7 @@ opts = {
45
45
  policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
46
46
  remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
47
47
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
48
- show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
48
+ show_enum_origins: 'policy_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
49
49
  }
50
50
 
51
51
  begin
@@ -93,7 +93,7 @@ end
93
93
  | **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: (&#39;VACATION&#39;, &#39;SICK&#39;, &#39;PERSONAL&#39;, &#39;JURY_DUTY&#39;, &#39;VOLUNTEER&#39;, &#39;BEREAVEMENT&#39;) * &#x60;VACATION&#x60; - VACATION * &#x60;SICK&#x60; - SICK * &#x60;PERSONAL&#x60; - PERSONAL * &#x60;JURY_DUTY&#x60; - JURY_DUTY * &#x60;VOLUNTEER&#x60; - VOLUNTEER * &#x60;BEREAVEMENT&#x60; - BEREAVEMENT | [optional] |
94
94
  | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
95
95
  | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
96
- | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
96
+ | **show_enum_origins** | **String** | A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
97
97
 
98
98
  ### Return type
99
99
 
@@ -137,7 +137,7 @@ opts = {
137
137
  expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
138
138
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
139
139
  remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
140
- show_enum_origins: 'policy_type' # String | Which fields should be returned in non-normalized form.
140
+ show_enum_origins: 'policy_type' # String | A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
141
141
  }
142
142
 
143
143
  begin
@@ -176,7 +176,7 @@ end
176
176
  | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
177
177
  | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
178
178
  | **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
179
- | **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
179
+ | **show_enum_origins** | **String** | A comma separated list of enum field names for which you&#39;d like the original values to be returned, instead of Merge&#39;s normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) | [optional] |
180
180
 
181
181
  ### Return type
182
182