merge_hris_client 2.0.5 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (217) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -8
  3. data/docs/AccountIntegration.md +6 -2
  4. data/docs/BankInfo.md +9 -5
  5. data/docs/BankInfoApi.md +15 -11
  6. data/docs/Benefit.md +8 -4
  7. data/docs/BenefitsApi.md +6 -6
  8. data/docs/CommonModelScopeData.md +20 -0
  9. data/docs/CommonModelScopes.md +20 -0
  10. data/docs/CommonModelScopesApi.md +157 -0
  11. data/docs/CommonModelScopesBodyRequest.md +22 -0
  12. data/docs/CommonModelScopesDisabledModels.md +26 -0
  13. data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
  14. data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
  15. data/docs/CommonModelScopesUpdateSerializer.md +18 -0
  16. data/docs/CompaniesApi.md +4 -4
  17. data/docs/Company.md +7 -3
  18. data/docs/ConditionSchema.md +30 -0
  19. data/docs/ConditionTypeEnum.md +15 -0
  20. data/docs/DataPassthroughRequest.md +1 -1
  21. data/docs/Deduction.md +11 -5
  22. data/docs/Earning.md +10 -2
  23. data/docs/Employee.md +19 -15
  24. data/docs/EmployeePayrollRun.md +11 -7
  25. data/docs/EmployeePayrollRunsApi.md +4 -4
  26. data/docs/EmployeeRequest.md +16 -18
  27. data/docs/EmployeesApi.md +31 -18
  28. data/docs/Employment.md +14 -10
  29. data/docs/EmploymentsApi.md +13 -9
  30. data/docs/EnabledActionsEnum.md +15 -0
  31. data/docs/EndUserDetailsRequest.md +5 -3
  32. data/docs/ForceResyncApi.md +1 -1
  33. data/docs/Group.md +8 -4
  34. data/docs/GroupsApi.md +15 -9
  35. data/docs/Issue.md +10 -8
  36. data/docs/IssuesApi.md +6 -6
  37. data/docs/LinkToken.md +1 -1
  38. data/docs/LinkedAccountCondition.md +28 -0
  39. data/docs/LinkedAccountConditionRequest.md +22 -0
  40. data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
  41. data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
  42. data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
  43. data/docs/LinkedAccountsApi.md +2 -2
  44. data/docs/Location.md +9 -5
  45. data/docs/LocationsApi.md +13 -9
  46. data/docs/MetaResponse.md +2 -0
  47. data/docs/MultipartFormFieldRequest.md +1 -1
  48. data/docs/OperatorSchema.md +20 -0
  49. data/docs/PaginatedConditionSchemaList.md +22 -0
  50. data/docs/PayGroup.md +7 -3
  51. data/docs/PayGroupsApi.md +4 -4
  52. data/docs/PayrollRun.md +9 -5
  53. data/docs/PayrollRunsApi.md +14 -10
  54. data/docs/SelectiveSyncApi.md +233 -0
  55. data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
  56. data/docs/SyncStatus.md +5 -3
  57. data/docs/Tax.md +9 -1
  58. data/docs/Team.md +8 -4
  59. data/docs/TeamsApi.md +4 -4
  60. data/docs/TimeOff.md +13 -9
  61. data/docs/TimeOffApi.md +16 -12
  62. data/docs/TimeOffBalance.md +10 -6
  63. data/docs/TimeOffBalancesApi.md +15 -11
  64. data/docs/TimeOffRequest.md +11 -9
  65. data/lib/merge_hris_client/api/bank_info_api.rb +24 -10
  66. data/lib/merge_hris_client/api/benefits_api.rb +6 -6
  67. data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
  68. data/lib/merge_hris_client/api/companies_api.rb +4 -4
  69. data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
  70. data/lib/merge_hris_client/api/employees_api.rb +44 -17
  71. data/lib/merge_hris_client/api/employments_api.rb +22 -8
  72. data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
  73. data/lib/merge_hris_client/api/groups_api.rb +25 -8
  74. data/lib/merge_hris_client/api/issues_api.rb +6 -6
  75. data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
  76. data/lib/merge_hris_client/api/locations_api.rb +22 -8
  77. data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
  78. data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
  79. data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
  80. data/lib/merge_hris_client/api/teams_api.rb +4 -4
  81. data/lib/merge_hris_client/api/time_off_api.rb +26 -12
  82. data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
  83. data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +1 -1
  84. data/lib/merge_hris_client/models/account_integration.rb +30 -8
  85. data/lib/merge_hris_client/models/account_type_enum.rb +1 -1
  86. data/lib/merge_hris_client/models/bank_info.rb +39 -16
  87. data/lib/merge_hris_client/models/benefit.rb +38 -15
  88. data/lib/merge_hris_client/models/categories_enum.rb +4 -2
  89. data/lib/merge_hris_client/models/category_enum.rb +4 -2
  90. data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
  91. data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
  92. data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
  93. data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
  94. data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
  95. data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
  96. data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
  97. data/lib/merge_hris_client/models/company.rb +37 -15
  98. data/lib/merge_hris_client/models/condition_schema.rb +298 -0
  99. data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
  100. data/lib/merge_hris_client/models/country_enum.rb +1 -1
  101. data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
  102. data/lib/merge_hris_client/models/deduction.rb +50 -17
  103. data/lib/merge_hris_client/models/earning.rb +51 -6
  104. data/lib/merge_hris_client/models/earning_type_enum.rb +1 -1
  105. data/lib/merge_hris_client/models/employee.rb +51 -23
  106. data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
  107. data/lib/merge_hris_client/models/employee_request.rb +34 -39
  108. data/lib/merge_hris_client/models/employment.rb +44 -20
  109. data/lib/merge_hris_client/models/employment_status_enum.rb +1 -1
  110. data/lib/merge_hris_client/models/employment_type_enum.rb +1 -1
  111. data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
  112. data/lib/merge_hris_client/models/encoding_enum.rb +1 -1
  113. data/lib/merge_hris_client/models/end_user_details_request.rb +20 -7
  114. data/lib/merge_hris_client/models/ethnicity_enum.rb +1 -1
  115. data/lib/merge_hris_client/models/flsa_status_enum.rb +1 -1
  116. data/lib/merge_hris_client/models/gender_enum.rb +1 -1
  117. data/lib/merge_hris_client/models/group.rb +38 -16
  118. data/lib/merge_hris_client/models/group_type_enum.rb +3 -2
  119. data/lib/merge_hris_client/models/issue.rb +16 -4
  120. data/lib/merge_hris_client/models/link_token.rb +0 -5
  121. data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
  122. data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
  123. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
  124. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
  125. data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
  126. data/lib/merge_hris_client/models/location.rb +39 -17
  127. data/lib/merge_hris_client/models/location_type_enum.rb +1 -1
  128. data/lib/merge_hris_client/models/marital_status_enum.rb +1 -1
  129. data/lib/merge_hris_client/models/meta_response.rb +12 -1
  130. data/lib/merge_hris_client/models/method_enum.rb +1 -1
  131. data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
  132. data/lib/merge_hris_client/models/operator_schema.rb +229 -0
  133. data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
  134. data/lib/merge_hris_client/models/pay_currency_enum.rb +1 -1
  135. data/lib/merge_hris_client/models/pay_frequency_enum.rb +3 -2
  136. data/lib/merge_hris_client/models/pay_group.rb +37 -15
  137. data/lib/merge_hris_client/models/pay_period_enum.rb +3 -2
  138. data/lib/merge_hris_client/models/payroll_run.rb +39 -17
  139. data/lib/merge_hris_client/models/policy_type_enum.rb +1 -1
  140. data/lib/merge_hris_client/models/reason_enum.rb +1 -1
  141. data/lib/merge_hris_client/models/request_format_enum.rb +1 -1
  142. data/lib/merge_hris_client/models/request_type_enum.rb +1 -1
  143. data/lib/merge_hris_client/models/response_type_enum.rb +1 -1
  144. data/lib/merge_hris_client/models/run_state_enum.rb +1 -1
  145. data/lib/merge_hris_client/models/run_type_enum.rb +1 -1
  146. data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
  147. data/lib/merge_hris_client/models/sync_status.rb +13 -4
  148. data/lib/merge_hris_client/models/sync_status_status_enum.rb +1 -1
  149. data/lib/merge_hris_client/models/tax.rb +50 -5
  150. data/lib/merge_hris_client/models/team.rb +38 -15
  151. data/lib/merge_hris_client/models/time_off.rb +43 -19
  152. data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
  153. data/lib/merge_hris_client/models/time_off_request.rb +36 -21
  154. data/lib/merge_hris_client/models/time_off_status_enum.rb +1 -1
  155. data/lib/merge_hris_client/models/units_enum.rb +1 -1
  156. data/lib/merge_hris_client/version.rb +1 -1
  157. data/lib/merge_hris_client.rb +20 -3
  158. data/spec/api/bank_info_api_spec.rb +7 -5
  159. data/spec/api/benefits_api_spec.rb +3 -3
  160. data/spec/api/common_model_scopes_api_spec.rb +58 -0
  161. data/spec/api/companies_api_spec.rb +2 -2
  162. data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
  163. data/spec/api/employees_api_spec.rb +13 -6
  164. data/spec/api/employments_api_spec.rb +6 -4
  165. data/spec/api/force_resync_api_spec.rb +1 -1
  166. data/spec/api/groups_api_spec.rb +7 -4
  167. data/spec/api/issues_api_spec.rb +3 -3
  168. data/spec/api/linked_accounts_api_spec.rb +1 -1
  169. data/spec/api/locations_api_spec.rb +6 -4
  170. data/spec/api/pay_groups_api_spec.rb +2 -2
  171. data/spec/api/payroll_runs_api_spec.rb +7 -5
  172. data/spec/api/selective_sync_api_spec.rb +72 -0
  173. data/spec/api/teams_api_spec.rb +2 -2
  174. data/spec/api/time_off_api_spec.rb +8 -6
  175. data/spec/api/time_off_balances_api_spec.rb +7 -5
  176. data/spec/models/account_integration_spec.rb +12 -0
  177. data/spec/models/bank_info_spec.rb +14 -2
  178. data/spec/models/benefit_spec.rb +14 -2
  179. data/spec/models/common_model_scope_data_spec.rb +40 -0
  180. data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
  181. data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
  182. data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
  183. data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
  184. data/spec/models/common_model_scopes_spec.rb +40 -0
  185. data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
  186. data/spec/models/company_spec.rb +14 -2
  187. data/spec/models/condition_schema_spec.rb +70 -0
  188. data/spec/models/condition_type_enum_spec.rb +28 -0
  189. data/spec/models/deduction_spec.rb +20 -2
  190. data/spec/models/earning_spec.rb +24 -0
  191. data/spec/models/employee_payroll_run_spec.rb +14 -2
  192. data/spec/models/employee_request_spec.rb +5 -11
  193. data/spec/models/employee_spec.rb +15 -3
  194. data/spec/models/employment_spec.rb +14 -2
  195. data/spec/models/enabled_actions_enum_spec.rb +28 -0
  196. data/spec/models/end_user_details_request_spec.rb +6 -0
  197. data/spec/models/group_spec.rb +14 -2
  198. data/spec/models/issue_spec.rb +6 -0
  199. data/spec/models/linked_account_condition_request_spec.rb +46 -0
  200. data/spec/models/linked_account_condition_spec.rb +64 -0
  201. data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
  202. data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
  203. data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
  204. data/spec/models/location_spec.rb +14 -2
  205. data/spec/models/meta_response_spec.rb +6 -0
  206. data/spec/models/operator_schema_spec.rb +40 -0
  207. data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
  208. data/spec/models/pay_group_spec.rb +14 -2
  209. data/spec/models/payroll_run_spec.rb +14 -2
  210. data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
  211. data/spec/models/sync_status_spec.rb +6 -0
  212. data/spec/models/tax_spec.rb +24 -0
  213. data/spec/models/team_spec.rb +14 -2
  214. data/spec/models/time_off_balance_spec.rb +14 -2
  215. data/spec/models/time_off_request_spec.rb +12 -6
  216. data/spec/models/time_off_spec.rb +14 -2
  217. metadata +183 -103
@@ -29,12 +29,13 @@ module MergeHRISClient
29
29
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
30
30
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
31
31
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
32
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
33
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
32
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
33
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
34
34
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
35
35
  # @option opts [Integer] :page_size Number of results to return per page.
36
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
36
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
37
37
  # @option opts [String] :remote_id The API provider's ID for the given object.
38
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
38
39
  # @return [PaginatedEmploymentList]
39
40
  def employments_list(x_account_token, opts = {})
40
41
  data, _status_code, _headers = employments_list_with_http_info(x_account_token, opts)
@@ -51,12 +52,13 @@ module MergeHRISClient
51
52
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
52
53
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
53
54
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
54
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
55
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
55
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
56
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
56
57
  # @option opts [String] :order_by Overrides the default ordering for this endpoint.
57
58
  # @option opts [Integer] :page_size Number of results to return per page.
58
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
59
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
59
60
  # @option opts [String] :remote_id The API provider's ID for the given object.
61
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
60
62
  # @return [Array<(PaginatedEmploymentList, Integer, Hash)>] PaginatedEmploymentList data, response status code and response headers
61
63
  def employments_list_with_http_info(x_account_token, opts = {})
62
64
  if @api_client.config.debugging
@@ -78,6 +80,10 @@ module MergeHRISClient
78
80
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
79
81
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
80
82
  end
83
+ allowable_values = ["employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period"]
84
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
85
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
86
+ end
81
87
  # resource path
82
88
  local_var_path = '/employments'
83
89
 
@@ -96,6 +102,7 @@ module MergeHRISClient
96
102
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
97
103
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
98
104
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
105
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
99
106
 
100
107
  # header parameters
101
108
  header_params = opts[:header_params] || {}
@@ -138,7 +145,8 @@ module MergeHRISClient
138
145
  # @param [Hash] opts the optional parameters
139
146
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
140
147
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
141
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
148
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
149
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
142
150
  # @return [Employment]
143
151
  def employments_retrieve(x_account_token, id, opts = {})
144
152
  data, _status_code, _headers = employments_retrieve_with_http_info(x_account_token, id, opts)
@@ -151,7 +159,8 @@ module MergeHRISClient
151
159
  # @param [Hash] opts the optional parameters
152
160
  # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
153
161
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
154
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
162
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
163
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
155
164
  # @return [Array<(Employment, Integer, Hash)>] Employment data, response status code and response headers
156
165
  def employments_retrieve_with_http_info(x_account_token, id, opts = {})
157
166
  if @api_client.config.debugging
@@ -173,6 +182,10 @@ module MergeHRISClient
173
182
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
174
183
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
175
184
  end
185
+ allowable_values = ["employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period"]
186
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
187
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
188
+ end
176
189
  # resource path
177
190
  local_var_path = '/employments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
178
191
 
@@ -181,6 +194,7 @@ module MergeHRISClient
181
194
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
182
195
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
183
196
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
197
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
184
198
 
185
199
  # header parameters
186
200
  header_params = opts[:header_params] || {}
@@ -19,7 +19,7 @@ module MergeHRISClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
22
+ # Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
23
23
  # @param x_account_token [String] Token identifying the end user.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [Array<SyncStatus>]
@@ -28,7 +28,7 @@ module MergeHRISClient
28
28
  data
29
29
  end
30
30
 
31
- # Force re-sync of all models. This is only available for organizations on Merge&#39;s Grow and Expand plans.
31
+ # Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
32
32
  # @param x_account_token [String] Token identifying the end user.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(Array<SyncStatus>, Integer, Hash)>] Array<SyncStatus> data, response status code and response headers
@@ -27,11 +27,13 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
30
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
31
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
33
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
34
34
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
35
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
36
+ # @option opts [String] :types If provided, will only return groups of these types. Multiple values can be separated by commas.
35
37
  # @return [PaginatedGroupList]
36
38
  def groups_list(x_account_token, opts = {})
37
39
  data, _status_code, _headers = groups_list_with_http_info(x_account_token, opts)
@@ -46,11 +48,13 @@ module MergeHRISClient
46
48
  # @option opts [String] :cursor The pagination cursor value.
47
49
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
48
50
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
49
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
50
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
51
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
52
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
51
53
  # @option opts [Integer] :page_size Number of results to return per page.
52
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
54
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
53
55
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
56
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
57
+ # @option opts [String] :types If provided, will only return groups of these types. Multiple values can be separated by commas.
54
58
  # @return [Array<(PaginatedGroupList, Integer, Hash)>] PaginatedGroupList data, response status code and response headers
55
59
  def groups_list_with_http_info(x_account_token, opts = {})
56
60
  if @api_client.config.debugging
@@ -64,6 +68,10 @@ module MergeHRISClient
64
68
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
65
69
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
66
70
  end
71
+ allowable_values = ["type"]
72
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
73
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
74
+ end
67
75
  # resource path
68
76
  local_var_path = '/groups'
69
77
 
@@ -79,6 +87,8 @@ module MergeHRISClient
79
87
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
80
88
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
81
89
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
90
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
91
+ query_params[:'types'] = opts[:'types'] if !opts[:'types'].nil?
82
92
 
83
93
  # header parameters
84
94
  header_params = opts[:header_params] || {}
@@ -120,7 +130,8 @@ module MergeHRISClient
120
130
  # @param id [String]
121
131
  # @param [Hash] opts the optional parameters
122
132
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
123
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
133
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
134
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
124
135
  # @return [Group]
125
136
  def groups_retrieve(x_account_token, id, opts = {})
126
137
  data, _status_code, _headers = groups_retrieve_with_http_info(x_account_token, id, opts)
@@ -132,7 +143,8 @@ module MergeHRISClient
132
143
  # @param id [String]
133
144
  # @param [Hash] opts the optional parameters
134
145
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
135
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
146
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
147
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
136
148
  # @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
137
149
  def groups_retrieve_with_http_info(x_account_token, id, opts = {})
138
150
  if @api_client.config.debugging
@@ -150,6 +162,10 @@ module MergeHRISClient
150
162
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
151
163
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
152
164
  end
165
+ allowable_values = ["type"]
166
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
167
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
168
+ end
153
169
  # resource path
154
170
  local_var_path = '/groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
155
171
 
@@ -157,6 +173,7 @@ module MergeHRISClient
157
173
  query_params = opts[:query_params] || {}
158
174
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
159
175
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
176
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
160
177
 
161
178
  # header parameters
162
179
  header_params = opts[:header_params] || {}
@@ -29,11 +29,11 @@ module MergeHRISClient
29
29
  # @option opts [Time] :first_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
30
30
  # @option opts [String] :include_muted If True, will include muted issues
31
31
  # @option opts [String] :integration_name
32
- # @option opts [Time] :last_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
33
- # @option opts [Time] :last_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
32
+ # @option opts [Time] :last_incident_time_after If provided, will only return issues whose last incident time was after this datetime.
33
+ # @option opts [Time] :last_incident_time_before If provided, will only return issues whose last incident time was before this datetime.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
35
  # @option opts [String] :start_date If included, will only include issues whose most recent action occurred after this time
36
- # @option opts [String] :status
36
+ # @option opts [String] :status Status of the issue. Options: (&#39;ONGOING&#39;, &#39;RESOLVED&#39;) * &#x60;ONGOING&#x60; - ONGOING * &#x60;RESOLVED&#x60; - RESOLVED
37
37
  # @return [PaginatedIssueList]
38
38
  def issues_list(opts = {})
39
39
  data, _status_code, _headers = issues_list_with_http_info(opts)
@@ -50,11 +50,11 @@ module MergeHRISClient
50
50
  # @option opts [Time] :first_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
51
51
  # @option opts [String] :include_muted If True, will include muted issues
52
52
  # @option opts [String] :integration_name
53
- # @option opts [Time] :last_incident_time_after If provided, will only return issues whose first incident time was after this datetime.
54
- # @option opts [Time] :last_incident_time_before If provided, will only return issues whose first incident time was before this datetime.
53
+ # @option opts [Time] :last_incident_time_after If provided, will only return issues whose last incident time was after this datetime.
54
+ # @option opts [Time] :last_incident_time_before If provided, will only return issues whose last incident time was before this datetime.
55
55
  # @option opts [Integer] :page_size Number of results to return per page.
56
56
  # @option opts [String] :start_date If included, will only include issues whose most recent action occurred after this time
57
- # @option opts [String] :status
57
+ # @option opts [String] :status Status of the issue. Options: (&#39;ONGOING&#39;, &#39;RESOLVED&#39;) * &#x60;ONGOING&#x60; - ONGOING * &#x60;RESOLVED&#x60; - RESOLVED
58
58
  # @return [Array<(PaginatedIssueList, Integer, Hash)>] PaginatedIssueList data, response status code and response headers
59
59
  def issues_list_with_http_info(opts = {})
60
60
  if @api_client.config.debugging
@@ -21,7 +21,7 @@ module MergeHRISClient
21
21
  end
22
22
  # List linked accounts for your organization.
23
23
  # @param [Hash] opts the optional parameters
24
- # @option opts [String] :category
24
+ # @option opts [String] :category * &#x60;hris&#x60; - hris * &#x60;ats&#x60; - ats * &#x60;accounting&#x60; - accounting * &#x60;ticketing&#x60; - ticketing * &#x60;crm&#x60; - crm * &#x60;mktg&#x60; - mktg * &#x60;filestorage&#x60; - filestorage * &#x60;hris&#x60; - hris * &#x60;ats&#x60; - ats * &#x60;accounting&#x60; - accounting * &#x60;ticketing&#x60; - ticketing * &#x60;crm&#x60; - crm * &#x60;mktg&#x60; - mktg * &#x60;filestorage&#x60; - filestorage
25
25
  # @option opts [String] :cursor The pagination cursor value.
26
26
  # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
27
27
  # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
@@ -42,7 +42,7 @@ module MergeHRISClient
42
42
 
43
43
  # List linked accounts for your organization.
44
44
  # @param [Hash] opts the optional parameters
45
- # @option opts [String] :category
45
+ # @option opts [String] :category * &#x60;hris&#x60; - hris * &#x60;ats&#x60; - ats * &#x60;accounting&#x60; - accounting * &#x60;ticketing&#x60; - ticketing * &#x60;crm&#x60; - crm * &#x60;mktg&#x60; - mktg * &#x60;filestorage&#x60; - filestorage * &#x60;hris&#x60; - hris * &#x60;ats&#x60; - ats * &#x60;accounting&#x60; - accounting * &#x60;ticketing&#x60; - ticketing * &#x60;crm&#x60; - crm * &#x60;mktg&#x60; - mktg * &#x60;filestorage&#x60; - filestorage
46
46
  # @option opts [String] :cursor The pagination cursor value.
47
47
  # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
48
48
  # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
@@ -60,7 +60,7 @@ module MergeHRISClient
60
60
  if @api_client.config.debugging
61
61
  @api_client.config.logger.debug 'Calling API: LinkedAccountsApi.linked_accounts_list ...'
62
62
  end
63
- allowable_values = ["accounting", "ats", "crm", "hris", "ticketing"]
63
+ allowable_values = ["accounting", "ats", "crm", "filestorage", "hris", "mktg", "ticketing"]
64
64
  if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
65
65
  fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
66
66
  end
@@ -27,11 +27,12 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
30
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
31
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
33
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
34
34
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
35
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
35
36
  # @return [PaginatedLocationList]
36
37
  def locations_list(x_account_token, opts = {})
37
38
  data, _status_code, _headers = locations_list_with_http_info(x_account_token, opts)
@@ -46,11 +47,12 @@ module MergeHRISClient
46
47
  # @option opts [String] :cursor The pagination cursor value.
47
48
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
48
49
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
49
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
50
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
50
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
51
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
51
52
  # @option opts [Integer] :page_size Number of results to return per page.
52
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
53
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
53
54
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
55
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
54
56
  # @return [Array<(PaginatedLocationList, Integer, Hash)>] PaginatedLocationList data, response status code and response headers
55
57
  def locations_list_with_http_info(x_account_token, opts = {})
56
58
  if @api_client.config.debugging
@@ -64,6 +66,10 @@ module MergeHRISClient
64
66
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
65
67
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
66
68
  end
69
+ allowable_values = ["location_type"]
70
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
71
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
72
+ end
67
73
  # resource path
68
74
  local_var_path = '/locations'
69
75
 
@@ -79,6 +85,7 @@ module MergeHRISClient
79
85
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
80
86
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
81
87
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
88
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
82
89
 
83
90
  # header parameters
84
91
  header_params = opts[:header_params] || {}
@@ -120,7 +127,8 @@ module MergeHRISClient
120
127
  # @param id [String]
121
128
  # @param [Hash] opts the optional parameters
122
129
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
123
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
130
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
131
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
124
132
  # @return [Location]
125
133
  def locations_retrieve(x_account_token, id, opts = {})
126
134
  data, _status_code, _headers = locations_retrieve_with_http_info(x_account_token, id, opts)
@@ -132,7 +140,8 @@ module MergeHRISClient
132
140
  # @param id [String]
133
141
  # @param [Hash] opts the optional parameters
134
142
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
135
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
143
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
144
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
136
145
  # @return [Array<(Location, Integer, Hash)>] Location data, response status code and response headers
137
146
  def locations_retrieve_with_http_info(x_account_token, id, opts = {})
138
147
  if @api_client.config.debugging
@@ -150,6 +159,10 @@ module MergeHRISClient
150
159
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
151
160
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
152
161
  end
162
+ allowable_values = ["location_type"]
163
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
164
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
165
+ end
153
166
  # resource path
154
167
  local_var_path = '/locations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
155
168
 
@@ -157,6 +170,7 @@ module MergeHRISClient
157
170
  query_params = opts[:query_params] || {}
158
171
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
159
172
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
173
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
160
174
 
161
175
  # header parameters
162
176
  header_params = opts[:header_params] || {}
@@ -27,8 +27,8 @@ module MergeHRISClient
27
27
  # @option opts [String] :cursor The pagination cursor value.
28
28
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
29
29
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
30
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
31
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
30
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
31
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
32
32
  # @option opts [Integer] :page_size Number of results to return per page.
33
33
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
34
34
  # @return [PaginatedPayGroupList]
@@ -45,8 +45,8 @@ module MergeHRISClient
45
45
  # @option opts [String] :cursor The pagination cursor value.
46
46
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
47
47
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
48
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
49
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
48
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
49
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
50
50
  # @option opts [Integer] :page_size Number of results to return per page.
51
51
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
52
52
  # @return [Array<(PaginatedPayGroupList, Integer, Hash)>] PaginatedPayGroupList data, response status code and response headers
@@ -29,12 +29,13 @@ module MergeHRISClient
29
29
  # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
30
30
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
31
31
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
32
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
33
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
32
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
33
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
34
34
  # @option opts [Integer] :page_size Number of results to return per page.
35
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
35
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
36
36
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
37
- # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;)
37
+ # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;) * &#x60;REGULAR&#x60; - REGULAR * &#x60;OFF_CYCLE&#x60; - OFF_CYCLE * &#x60;CORRECTION&#x60; - CORRECTION * &#x60;TERMINATION&#x60; - TERMINATION * &#x60;SIGN_ON_BONUS&#x60; - SIGN_ON_BONUS
38
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
38
39
  # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
39
40
  # @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
40
41
  # @return [PaginatedPayrollRunList]
@@ -53,12 +54,13 @@ module MergeHRISClient
53
54
  # @option opts [Time] :ended_before If provided, will only return payroll runs ended before this datetime.
54
55
  # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
55
56
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
56
- # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
57
- # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
57
+ # @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
58
+ # @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
58
59
  # @option opts [Integer] :page_size Number of results to return per page.
59
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
60
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
60
61
  # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
61
- # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;)
62
+ # @option opts [String] :run_type If provided, will only return PayrollRun&#39;s with this status. Options: (&#39;REGULAR&#39;, &#39;OFF_CYCLE&#39;, &#39;CORRECTION&#39;, &#39;TERMINATION&#39;, &#39;SIGN_ON_BONUS&#39;) * &#x60;REGULAR&#x60; - REGULAR * &#x60;OFF_CYCLE&#x60; - OFF_CYCLE * &#x60;CORRECTION&#x60; - CORRECTION * &#x60;TERMINATION&#x60; - TERMINATION * &#x60;SIGN_ON_BONUS&#x60; - SIGN_ON_BONUS
63
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
62
64
  # @option opts [Time] :started_after If provided, will only return payroll runs started after this datetime.
63
65
  # @option opts [Time] :started_before If provided, will only return payroll runs started before this datetime.
64
66
  # @return [Array<(PaginatedPayrollRunList, Integer, Hash)>] PaginatedPayrollRunList data, response status code and response headers
@@ -78,6 +80,10 @@ module MergeHRISClient
78
80
  if @api_client.config.client_side_validation && opts[:'run_type'] && !allowable_values.include?(opts[:'run_type'])
79
81
  fail ArgumentError, "invalid value for \"run_type\", must be one of #{allowable_values}"
80
82
  end
83
+ allowable_values = ["run_state", "run_state,run_type", "run_type"]
84
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
85
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
86
+ end
81
87
  # resource path
82
88
  local_var_path = '/payroll-runs'
83
89
 
@@ -96,6 +102,7 @@ module MergeHRISClient
96
102
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
97
103
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
98
104
  query_params[:'run_type'] = opts[:'run_type'] if !opts[:'run_type'].nil?
105
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
99
106
  query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
100
107
  query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil?
101
108
 
@@ -139,7 +146,8 @@ module MergeHRISClient
139
146
  # @param id [String]
140
147
  # @param [Hash] opts the optional parameters
141
148
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
142
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
149
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
150
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
143
151
  # @return [PayrollRun]
144
152
  def payroll_runs_retrieve(x_account_token, id, opts = {})
145
153
  data, _status_code, _headers = payroll_runs_retrieve_with_http_info(x_account_token, id, opts)
@@ -151,7 +159,8 @@ module MergeHRISClient
151
159
  # @param id [String]
152
160
  # @param [Hash] opts the optional parameters
153
161
  # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
154
- # @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
162
+ # @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
163
+ # @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
155
164
  # @return [Array<(PayrollRun, Integer, Hash)>] PayrollRun data, response status code and response headers
156
165
  def payroll_runs_retrieve_with_http_info(x_account_token, id, opts = {})
157
166
  if @api_client.config.debugging
@@ -169,6 +178,10 @@ module MergeHRISClient
169
178
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
170
179
  fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
171
180
  end
181
+ allowable_values = ["run_state", "run_state,run_type", "run_type"]
182
+ if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
183
+ fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
184
+ end
172
185
  # resource path
173
186
  local_var_path = '/payroll-runs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
174
187
 
@@ -176,6 +189,7 @@ module MergeHRISClient
176
189
  query_params = opts[:query_params] || {}
177
190
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
178
191
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
192
+ query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
179
193
 
180
194
  # header parameters
181
195
  header_params = opts[:header_params] || {}