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,341 @@
1
+ # MergeHRISClient::TimesheetEntriesApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/hris/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**timesheet_entries_create**](TimesheetEntriesApi.md#timesheet_entries_create) | **POST** /timesheet-entries | |
8
+ | [**timesheet_entries_list**](TimesheetEntriesApi.md#timesheet_entries_list) | **GET** /timesheet-entries | |
9
+ | [**timesheet_entries_meta_post_retrieve**](TimesheetEntriesApi.md#timesheet_entries_meta_post_retrieve) | **GET** /timesheet-entries/meta/post | |
10
+ | [**timesheet_entries_retrieve**](TimesheetEntriesApi.md#timesheet_entries_retrieve) | **GET** /timesheet-entries/{id} | |
11
+
12
+
13
+ ## timesheet_entries_create
14
+
15
+ > <TimesheetEntryResponse> timesheet_entries_create(x_account_token, timesheet_entry_endpoint_request, opts)
16
+
17
+
18
+
19
+ Creates a `TimesheetEntry` object with the given values.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'merge_hris_client'
26
+ # setup authorization
27
+ MergeHRISClient.configure do |config|
28
+ # Configure API key authorization: tokenAuth
29
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
35
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
36
+ timesheet_entry_endpoint_request = MergeHRISClient::TimesheetEntryEndpointRequest.new({model: MergeHRISClient::TimesheetEntryRequest.new}) # TimesheetEntryEndpointRequest |
37
+ opts = {
38
+ is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
39
+ run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
40
+ }
41
+
42
+ begin
43
+
44
+ result = api_instance.timesheet_entries_create(x_account_token, timesheet_entry_endpoint_request, opts)
45
+ p result
46
+ rescue MergeHRISClient::ApiError => e
47
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_create: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the timesheet_entries_create_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<TimesheetEntryResponse>, Integer, Hash)> timesheet_entries_create_with_http_info(x_account_token, timesheet_entry_endpoint_request, opts)
56
+
57
+ ```ruby
58
+ begin
59
+
60
+ data, status_code, headers = api_instance.timesheet_entries_create_with_http_info(x_account_token, timesheet_entry_endpoint_request, opts)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <TimesheetEntryResponse>
64
+ rescue MergeHRISClient::ApiError => e
65
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_create_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **x_account_token** | **String** | Token identifying the end user. | |
74
+ | **timesheet_entry_endpoint_request** | [**TimesheetEntryEndpointRequest**](TimesheetEntryEndpointRequest.md) | | |
75
+ | **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
76
+ | **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
77
+
78
+ ### Return type
79
+
80
+ [**TimesheetEntryResponse**](TimesheetEntryResponse.md)
81
+
82
+ ### Authorization
83
+
84
+ [tokenAuth](../README.md#tokenAuth)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
89
+ - **Accept**: application/json
90
+
91
+
92
+ ## timesheet_entries_list
93
+
94
+ > <PaginatedTimesheetEntryList> timesheet_entries_list(x_account_token, opts)
95
+
96
+
97
+
98
+ Returns a list of `TimesheetEntry` objects.
99
+
100
+ ### Examples
101
+
102
+ ```ruby
103
+ require 'time'
104
+ require 'merge_hris_client'
105
+ # setup authorization
106
+ MergeHRISClient.configure do |config|
107
+ # Configure API key authorization: tokenAuth
108
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
109
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
110
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
111
+ end
112
+
113
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
114
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
115
+ opts = {
116
+ created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
117
+ created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
118
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
119
+ employee_id: 'employee_id_example', # String | If provided, will only return timesheet entries for this employee.
120
+ ended_after: 'ended_after_example', # String | If provided, will only return timesheet entries ended after this datetime.
121
+ ended_before: 'ended_before_example', # String | If provided, will only return timesheet entries ended before this datetime.
122
+ include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
123
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
124
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
125
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
126
+ order_by: '-start_time', # String | Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
127
+ page_size: 56, # Integer | Number of results to return per page.
128
+ remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
129
+ started_after: 'started_after_example', # String | If provided, will only return timesheet entries started after this datetime.
130
+ started_before: 'started_before_example' # String | If provided, will only return timesheet entries started before this datetime.
131
+ }
132
+
133
+ begin
134
+
135
+ result = api_instance.timesheet_entries_list(x_account_token, opts)
136
+ p result
137
+ rescue MergeHRISClient::ApiError => e
138
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_list: #{e}"
139
+ end
140
+ ```
141
+
142
+ #### Using the timesheet_entries_list_with_http_info variant
143
+
144
+ This returns an Array which contains the response data, status code and headers.
145
+
146
+ > <Array(<PaginatedTimesheetEntryList>, Integer, Hash)> timesheet_entries_list_with_http_info(x_account_token, opts)
147
+
148
+ ```ruby
149
+ begin
150
+
151
+ data, status_code, headers = api_instance.timesheet_entries_list_with_http_info(x_account_token, opts)
152
+ p status_code # => 2xx
153
+ p headers # => { ... }
154
+ p data # => <PaginatedTimesheetEntryList>
155
+ rescue MergeHRISClient::ApiError => e
156
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_list_with_http_info: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ | Name | Type | Description | Notes |
163
+ | ---- | ---- | ----------- | ----- |
164
+ | **x_account_token** | **String** | Token identifying the end user. | |
165
+ | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
166
+ | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
167
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
168
+ | **employee_id** | **String** | If provided, will only return timesheet entries for this employee. | [optional] |
169
+ | **ended_after** | **String** | If provided, will only return timesheet entries ended after this datetime. | [optional] |
170
+ | **ended_before** | **String** | If provided, will only return timesheet entries ended before this datetime. | [optional] |
171
+ | **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
172
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
173
+ | **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
174
+ | **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
175
+ | **order_by** | **String** | Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. | [optional] |
176
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
177
+ | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
178
+ | **started_after** | **String** | If provided, will only return timesheet entries started after this datetime. | [optional] |
179
+ | **started_before** | **String** | If provided, will only return timesheet entries started before this datetime. | [optional] |
180
+
181
+ ### Return type
182
+
183
+ [**PaginatedTimesheetEntryList**](PaginatedTimesheetEntryList.md)
184
+
185
+ ### Authorization
186
+
187
+ [tokenAuth](../README.md#tokenAuth)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: Not defined
192
+ - **Accept**: application/json
193
+
194
+
195
+ ## timesheet_entries_meta_post_retrieve
196
+
197
+ > <MetaResponse> timesheet_entries_meta_post_retrieve(x_account_token)
198
+
199
+
200
+
201
+ Returns metadata for `TimesheetEntry` POSTs.
202
+
203
+ ### Examples
204
+
205
+ ```ruby
206
+ require 'time'
207
+ require 'merge_hris_client'
208
+ # setup authorization
209
+ MergeHRISClient.configure do |config|
210
+ # Configure API key authorization: tokenAuth
211
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
214
+ end
215
+
216
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
217
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
218
+
219
+ begin
220
+
221
+ result = api_instance.timesheet_entries_meta_post_retrieve(x_account_token)
222
+ p result
223
+ rescue MergeHRISClient::ApiError => e
224
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_meta_post_retrieve: #{e}"
225
+ end
226
+ ```
227
+
228
+ #### Using the timesheet_entries_meta_post_retrieve_with_http_info variant
229
+
230
+ This returns an Array which contains the response data, status code and headers.
231
+
232
+ > <Array(<MetaResponse>, Integer, Hash)> timesheet_entries_meta_post_retrieve_with_http_info(x_account_token)
233
+
234
+ ```ruby
235
+ begin
236
+
237
+ data, status_code, headers = api_instance.timesheet_entries_meta_post_retrieve_with_http_info(x_account_token)
238
+ p status_code # => 2xx
239
+ p headers # => { ... }
240
+ p data # => <MetaResponse>
241
+ rescue MergeHRISClient::ApiError => e
242
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_meta_post_retrieve_with_http_info: #{e}"
243
+ end
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+ | Name | Type | Description | Notes |
249
+ | ---- | ---- | ----------- | ----- |
250
+ | **x_account_token** | **String** | Token identifying the end user. | |
251
+
252
+ ### Return type
253
+
254
+ [**MetaResponse**](MetaResponse.md)
255
+
256
+ ### Authorization
257
+
258
+ [tokenAuth](../README.md#tokenAuth)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: Not defined
263
+ - **Accept**: application/json
264
+
265
+
266
+ ## timesheet_entries_retrieve
267
+
268
+ > <TimesheetEntry> timesheet_entries_retrieve(x_account_token, id, opts)
269
+
270
+
271
+
272
+ Returns a `TimesheetEntry` object with the given `id`.
273
+
274
+ ### Examples
275
+
276
+ ```ruby
277
+ require 'time'
278
+ require 'merge_hris_client'
279
+ # setup authorization
280
+ MergeHRISClient.configure do |config|
281
+ # Configure API key authorization: tokenAuth
282
+ config.api_key['tokenAuth'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ # config.api_key_prefix['tokenAuth'] = 'Bearer'
285
+ end
286
+
287
+ api_instance = MergeHRISClient::TimesheetEntriesApi.new
288
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
289
+ id = TODO # String |
290
+ opts = {
291
+ include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
292
+ }
293
+
294
+ begin
295
+
296
+ result = api_instance.timesheet_entries_retrieve(x_account_token, id, opts)
297
+ p result
298
+ rescue MergeHRISClient::ApiError => e
299
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_retrieve: #{e}"
300
+ end
301
+ ```
302
+
303
+ #### Using the timesheet_entries_retrieve_with_http_info variant
304
+
305
+ This returns an Array which contains the response data, status code and headers.
306
+
307
+ > <Array(<TimesheetEntry>, Integer, Hash)> timesheet_entries_retrieve_with_http_info(x_account_token, id, opts)
308
+
309
+ ```ruby
310
+ begin
311
+
312
+ data, status_code, headers = api_instance.timesheet_entries_retrieve_with_http_info(x_account_token, id, opts)
313
+ p status_code # => 2xx
314
+ p headers # => { ... }
315
+ p data # => <TimesheetEntry>
316
+ rescue MergeHRISClient::ApiError => e
317
+ puts "Error when calling TimesheetEntriesApi->timesheet_entries_retrieve_with_http_info: #{e}"
318
+ end
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ | Name | Type | Description | Notes |
324
+ | ---- | ---- | ----------- | ----- |
325
+ | **x_account_token** | **String** | Token identifying the end user. | |
326
+ | **id** | [**String**](.md) | | |
327
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
328
+
329
+ ### Return type
330
+
331
+ [**TimesheetEntry**](TimesheetEntry.md)
332
+
333
+ ### Authorization
334
+
335
+ [tokenAuth](../README.md#tokenAuth)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: Not defined
340
+ - **Accept**: application/json
341
+
@@ -0,0 +1,38 @@
1
+ # MergeHRISClient::TimesheetEntry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **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] |
11
+ | **employee** | **String** | The employee the timesheet entry is for. | [optional] |
12
+ | **hours_worked** | **Float** | The number of hours logged by the employee. | [optional] |
13
+ | **start_time** | **Time** | The time at which the employee started work. | [optional] |
14
+ | **end_time** | **Time** | The time at which the employee ended work. | [optional] |
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] |
17
+ | **remote_data** | **Array&lt;Hash&lt;String, AnyType&gt;&gt;** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'merge_hris_client'
23
+
24
+ instance = MergeHRISClient::TimesheetEntry.new(
25
+ id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
26
+ remote_id: 19202938,
27
+ created_at: 2021-09-15T00:00Z,
28
+ modified_at: 2021-10-16T00:00Z,
29
+ employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
30
+ hours_worked: 10.0,
31
+ start_time: 2020-11-10T00:00Z,
32
+ end_time: 2020-11-10T00:10Z,
33
+ remote_was_deleted: null,
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;}},
35
+ remote_data: [{&quot;path&quot;:&quot;/dependent&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
36
+ )
37
+ ```
38
+
@@ -0,0 +1,18 @@
1
+ # MergeHRISClient::TimesheetEntryEndpointRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**TimesheetEntryRequest**](TimesheetEntryRequest.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_hris_client'
13
+
14
+ instance = MergeHRISClient::TimesheetEntryEndpointRequest.new(
15
+ model: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,28 @@
1
+ # MergeHRISClient::TimesheetEntryRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **employee** | **String** | The employee the timesheet entry is for. | [optional] |
8
+ | **hours_worked** | **Float** | The number of hours logged by the employee. | [optional] |
9
+ | **start_time** | **Time** | The time at which the employee started work. | [optional] |
10
+ | **end_time** | **Time** | The time at which the employee ended work. | [optional] |
11
+ | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
12
+ | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'merge_hris_client'
18
+
19
+ instance = MergeHRISClient::TimesheetEntryRequest.new(
20
+ employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
21
+ hours_worked: 10.0,
22
+ start_time: 2020-11-10T00:00Z,
23
+ end_time: 2020-11-10T00:10Z,
24
+ integration_params: {&quot;unique_integration_field&quot;:&quot;unique_integration_field_value&quot;},
25
+ linked_account_params: {&quot;unique_linked_account_field&quot;:&quot;unique_linked_account_field_value&quot;}
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # MergeHRISClient::TimesheetEntryResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model** | [**TimesheetEntry**](TimesheetEntry.md) | | |
8
+ | **warnings** | [**Array&lt;WarningValidationProblem&gt;**](WarningValidationProblem.md) | | |
9
+ | **errors** | [**Array&lt;ErrorValidationProblem&gt;**](ErrorValidationProblem.md) | | |
10
+ | **logs** | [**Array&lt;DebugModeLog&gt;**](DebugModeLog.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'merge_hris_client'
16
+
17
+ instance = MergeHRISClient::TimesheetEntryResponse.new(
18
+ model: null,
19
+ warnings: null,
20
+ errors: null,
21
+ logs: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,95 @@
1
+ =begin
2
+ #Merge HRIS API
3
+
4
+ #The unified API for building rich integrations with multiple HR Information System platforms.
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: hello@merge.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MergeHRISClient
16
+ class AuditTrailApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Gets a list of audit trail events.
23
+ # @param [Hash] opts the optional parameters
24
+ # @option opts [String] :cursor The pagination cursor value.
25
+ # @option opts [String] :end_date If included, will only include audit trail events that occurred before this time
26
+ # @option opts [String] :event_type If included, will only include events with the given event type. Possible values include: &#x60;CREATED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;DELETED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;CREATED_TEST_API_KEY&#x60;, &#x60;DELETED_TEST_API_KEY&#x60;, &#x60;REGENERATED_PRODUCTION_API_KEY&#x60;, &#x60;INVITED_USER&#x60;, &#x60;TWO_FACTOR_AUTH_ENABLED&#x60;, &#x60;TWO_FACTOR_AUTH_DISABLED&#x60;, &#x60;DELETED_LINKED_ACCOUNT&#x60;, &#x60;CREATED_DESTINATION&#x60;, &#x60;DELETED_DESTINATION&#x60;, &#x60;CHANGED_DESTINATION&#x60;, &#x60;CHANGED_SCOPES&#x60;, &#x60;CHANGED_PERSONAL_INFORMATION&#x60;, &#x60;CHANGED_ORGANIZATION_SETTINGS&#x60;, &#x60;ENABLED_INTEGRATION&#x60;, &#x60;DISABLED_INTEGRATION&#x60;, &#x60;ENABLED_CATEGORY&#x60;, &#x60;DISABLED_CATEGORY&#x60;, &#x60;CHANGED_PASSWORD&#x60;, &#x60;RESET_PASSWORD&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;CREATED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CREATED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;CHANGED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CHANGED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;DELETED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;DELETED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;FORCED_LINKED_ACCOUNT_RESYNC&#x60;, &#x60;MUTED_ISSUE&#x60;, &#x60;GENERATED_MAGIC_LINK&#x60;, &#x60;ENABLED_MERGE_WEBHOOK&#x60;, &#x60;DISABLED_MERGE_WEBHOOK&#x60;, &#x60;MERGE_WEBHOOK_TARGET_CHANGED&#x60;, &#x60;END_USER_CREDENTIALS_ACCESSED&#x60;
27
+ # @option opts [Integer] :page_size Number of results to return per page.
28
+ # @option opts [String] :start_date If included, will only include audit trail events that occurred after this time
29
+ # @option opts [String] :user_email If provided, this will return events associated with the specified user email. Please note that the email address reflects the user&#39;s email at the time of the event, and may not be their current email.
30
+ # @return [PaginatedAuditLogEventList]
31
+ def audit_trail_list(opts = {})
32
+ data, _status_code, _headers = audit_trail_list_with_http_info(opts)
33
+ data
34
+ end
35
+
36
+ # Gets a list of audit trail events.
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [String] :cursor The pagination cursor value.
39
+ # @option opts [String] :end_date If included, will only include audit trail events that occurred before this time
40
+ # @option opts [String] :event_type If included, will only include events with the given event type. Possible values include: &#x60;CREATED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;DELETED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;CREATED_TEST_API_KEY&#x60;, &#x60;DELETED_TEST_API_KEY&#x60;, &#x60;REGENERATED_PRODUCTION_API_KEY&#x60;, &#x60;INVITED_USER&#x60;, &#x60;TWO_FACTOR_AUTH_ENABLED&#x60;, &#x60;TWO_FACTOR_AUTH_DISABLED&#x60;, &#x60;DELETED_LINKED_ACCOUNT&#x60;, &#x60;CREATED_DESTINATION&#x60;, &#x60;DELETED_DESTINATION&#x60;, &#x60;CHANGED_DESTINATION&#x60;, &#x60;CHANGED_SCOPES&#x60;, &#x60;CHANGED_PERSONAL_INFORMATION&#x60;, &#x60;CHANGED_ORGANIZATION_SETTINGS&#x60;, &#x60;ENABLED_INTEGRATION&#x60;, &#x60;DISABLED_INTEGRATION&#x60;, &#x60;ENABLED_CATEGORY&#x60;, &#x60;DISABLED_CATEGORY&#x60;, &#x60;CHANGED_PASSWORD&#x60;, &#x60;RESET_PASSWORD&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;CREATED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CREATED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;CHANGED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;CHANGED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;DELETED_INTEGRATION_WIDE_FIELD_MAPPING&#x60;, &#x60;DELETED_LINKED_ACCOUNT_FIELD_MAPPING&#x60;, &#x60;FORCED_LINKED_ACCOUNT_RESYNC&#x60;, &#x60;MUTED_ISSUE&#x60;, &#x60;GENERATED_MAGIC_LINK&#x60;, &#x60;ENABLED_MERGE_WEBHOOK&#x60;, &#x60;DISABLED_MERGE_WEBHOOK&#x60;, &#x60;MERGE_WEBHOOK_TARGET_CHANGED&#x60;, &#x60;END_USER_CREDENTIALS_ACCESSED&#x60;
41
+ # @option opts [Integer] :page_size Number of results to return per page.
42
+ # @option opts [String] :start_date If included, will only include audit trail events that occurred after this time
43
+ # @option opts [String] :user_email If provided, this will return events associated with the specified user email. Please note that the email address reflects the user&#39;s email at the time of the event, and may not be their current email.
44
+ # @return [Array<(PaginatedAuditLogEventList, Integer, Hash)>] PaginatedAuditLogEventList data, response status code and response headers
45
+ def audit_trail_list_with_http_info(opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: AuditTrailApi.audit_trail_list ...'
48
+ end
49
+ # resource path
50
+ local_var_path = '/audit-trail'
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
55
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
56
+ query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
57
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
58
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
59
+ query_params[:'user_email'] = opts[:'user_email'] if !opts[:'user_email'].nil?
60
+
61
+ # header parameters
62
+ header_params = opts[:header_params] || {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+
66
+ # form parameters
67
+ form_params = opts[:form_params] || {}
68
+
69
+ # http body (model)
70
+ post_body = opts[:debug_body]
71
+
72
+ # return_type
73
+ return_type = opts[:debug_return_type] || 'PaginatedAuditLogEventList'
74
+
75
+ # auth_names
76
+ auth_names = opts[:debug_auth_names] || ['tokenAuth']
77
+
78
+ new_options = opts.merge(
79
+ :operation => :"AuditTrailApi.audit_trail_list",
80
+ :header_params => header_params,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body,
84
+ :auth_names => auth_names,
85
+ :return_type => return_type
86
+ )
87
+
88
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
89
+ if @api_client.config.debugging
90
+ @api_client.config.logger.debug "API called: AuditTrailApi#audit_trail_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
91
+ end
92
+ return data, status_code, headers
93
+ end
94
+ end
95
+ end
@@ -37,7 +37,7 @@ module MergeHRISClient
37
37
  # @option opts [Integer] :page_size Number of results to return per page.
38
38
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
39
39
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
40
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
40
+ # @option opts [String] :show_enum_origins 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)
41
41
  # @return [PaginatedBankInfoList]
42
42
  def bank_info_list(x_account_token, opts = {})
43
43
  data, _status_code, _headers = bank_info_list_with_http_info(x_account_token, opts)
@@ -62,7 +62,7 @@ module MergeHRISClient
62
62
  # @option opts [Integer] :page_size Number of results to return per page.
63
63
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
64
64
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
65
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
65
+ # @option opts [String] :show_enum_origins 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)
66
66
  # @return [Array<(PaginatedBankInfoList, Integer, Hash)>] PaginatedBankInfoList data, response status code and response headers
67
67
  def bank_info_list_with_http_info(x_account_token, opts = {})
68
68
  if @api_client.config.debugging
@@ -156,7 +156,7 @@ module MergeHRISClient
156
156
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
157
157
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
158
158
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
159
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
159
+ # @option opts [String] :show_enum_origins 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)
160
160
  # @return [BankInfo]
161
161
  def bank_info_retrieve(x_account_token, id, opts = {})
162
162
  data, _status_code, _headers = bank_info_retrieve_with_http_info(x_account_token, id, opts)
@@ -170,7 +170,7 @@ module MergeHRISClient
170
170
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
171
171
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
172
172
  # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
173
- # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
173
+ # @option opts [String] :show_enum_origins 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)
174
174
  # @return [Array<(BankInfo, Integer, Hash)>] BankInfo data, response status code and response headers
175
175
  def bank_info_retrieve_with_http_info(x_account_token, id, opts = {})
176
176
  if @api_client.config.debugging