merge_hris_client 3.0.0 → 3.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +33 -9
- data/docs/AccountIntegration.md +6 -2
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/BankInfo.md +9 -5
- data/docs/BankInfoApi.md +17 -13
- data/docs/Benefit.md +15 -5
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/BenefitsApi.md +6 -6
- data/docs/CommonModelScopeData.md +20 -0
- data/docs/CommonModelScopes.md +20 -0
- data/docs/CommonModelScopesApi.md +157 -0
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/CommonModelScopesDisabledModels.md +26 -0
- data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
- data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
- data/docs/CommonModelScopesUpdateSerializer.md +18 -0
- data/docs/CompaniesApi.md +4 -4
- data/docs/Company.md +7 -3
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/Deduction.md +11 -5
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/Dependent.md +50 -0
- data/docs/DependentsApi.md +181 -0
- data/docs/Earning.md +10 -2
- data/docs/Employee.md +19 -15
- data/docs/EmployeePayrollRun.md +11 -7
- data/docs/EmployeePayrollRunsApi.md +4 -4
- data/docs/EmployeeRequest.md +16 -18
- data/docs/EmployeesApi.md +31 -18
- data/docs/EmployerBenefit.md +36 -0
- data/docs/EmployerBenefitsApi.md +177 -0
- data/docs/Employment.md +14 -10
- data/docs/EmploymentsApi.md +15 -11
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +6 -4
- data/docs/ForceResyncApi.md +1 -1
- data/docs/Group.md +8 -4
- data/docs/GroupsApi.md +15 -9
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +6 -6
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/Location.md +10 -6
- data/docs/LocationsApi.md +13 -9
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PaginatedDependentList.md +22 -0
- data/docs/PaginatedEmployerBenefitList.md +22 -0
- data/docs/PayGroup.md +7 -3
- data/docs/PayGroupsApi.md +4 -4
- data/docs/PayrollRun.md +9 -5
- data/docs/PayrollRunsApi.md +14 -10
- data/docs/RelationshipEnum.md +15 -0
- data/docs/RemoteData.md +1 -1
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +9 -1
- data/docs/Team.md +8 -4
- data/docs/TeamsApi.md +4 -4
- data/docs/TimeOff.md +13 -9
- data/docs/TimeOffApi.md +16 -12
- data/docs/TimeOffBalance.md +10 -6
- data/docs/TimeOffBalancesApi.md +15 -11
- data/docs/TimeOffRequest.md +11 -9
- data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_hris_client/api/bank_info_api.rb +26 -12
- data/lib/merge_hris_client/api/benefits_api.rb +6 -6
- data/lib/merge_hris_client/api/common_model_scopes_api.rb +146 -0
- data/lib/merge_hris_client/api/companies_api.rb +4 -4
- data/lib/merge_hris_client/api/delete_account_api.rb +7 -7
- data/lib/merge_hris_client/api/dependents_api.rb +188 -0
- data/lib/merge_hris_client/api/employee_payroll_runs_api.rb +4 -4
- data/lib/merge_hris_client/api/employees_api.rb +44 -17
- data/lib/merge_hris_client/api/employer_benefits_api.rb +182 -0
- data/lib/merge_hris_client/api/employments_api.rb +24 -10
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +25 -8
- data/lib/merge_hris_client/api/issues_api.rb +6 -6
- data/lib/merge_hris_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_hris_client/api/locations_api.rb +22 -8
- data/lib/merge_hris_client/api/pay_groups_api.rb +4 -4
- data/lib/merge_hris_client/api/payroll_runs_api.rb +24 -10
- data/lib/merge_hris_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_hris_client/api/sync_status_api.rb +2 -2
- data/lib/merge_hris_client/api/teams_api.rb +4 -4
- data/lib/merge_hris_client/api/time_off_api.rb +26 -12
- data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
- data/lib/merge_hris_client/models/account_integration.rb +30 -8
- data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_hris_client/models/bank_info.rb +39 -16
- data/lib/merge_hris_client/models/benefit.rb +70 -14
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
- data/lib/merge_hris_client/models/categories_enum.rb +3 -1
- data/lib/merge_hris_client/models/category_enum.rb +3 -1
- data/lib/merge_hris_client/models/common_model_scope_data.rb +234 -0
- data/lib/merge_hris_client/models/common_model_scopes.rb +234 -0
- data/lib/merge_hris_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_hris_client/models/common_model_scopes_disabled_models.rb +283 -0
- data/lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
- data/lib/merge_hris_client/models/common_model_scopes_update_serializer.rb +226 -0
- data/lib/merge_hris_client/models/company.rb +37 -15
- data/lib/merge_hris_client/models/condition_schema.rb +298 -0
- data/lib/merge_hris_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_hris_client/models/deduction.rb +50 -17
- data/lib/merge_hris_client/models/dependent.rb +470 -0
- data/lib/merge_hris_client/models/earning.rb +51 -6
- data/lib/merge_hris_client/models/employee.rb +51 -23
- data/lib/merge_hris_client/models/employee_payroll_run.rb +41 -17
- data/lib/merge_hris_client/models/employee_request.rb +34 -39
- data/lib/merge_hris_client/models/employer_benefit.rb +363 -0
- data/lib/merge_hris_client/models/employment.rb +44 -20
- data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/end_user_details_request.rb +21 -8
- data/lib/merge_hris_client/models/group.rb +38 -16
- data/lib/merge_hris_client/models/group_type_enum.rb +2 -1
- data/lib/merge_hris_client/models/issue.rb +16 -4
- data/lib/merge_hris_client/models/link_token.rb +0 -5
- data/lib/merge_hris_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_hris_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_hris_client/models/location.rb +39 -17
- data/lib/merge_hris_client/models/meta_response.rb +12 -1
- data/lib/merge_hris_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_hris_client/models/operator_schema.rb +229 -0
- data/lib/merge_hris_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_dependent_list.rb +240 -0
- data/lib/merge_hris_client/models/paginated_employer_benefit_list.rb +240 -0
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +2 -1
- data/lib/merge_hris_client/models/pay_group.rb +37 -15
- data/lib/merge_hris_client/models/pay_period_enum.rb +2 -1
- data/lib/merge_hris_client/models/payroll_run.rb +39 -17
- data/lib/merge_hris_client/models/relationship_enum.rb +46 -0
- data/lib/merge_hris_client/models/remote_data.rb +3 -4
- data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_hris_client/models/sync_status.rb +13 -4
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +2 -1
- data/lib/merge_hris_client/models/tax.rb +50 -5
- data/lib/merge_hris_client/models/team.rb +38 -15
- data/lib/merge_hris_client/models/time_off.rb +43 -19
- data/lib/merge_hris_client/models/time_off_balance.rb +40 -17
- data/lib/merge_hris_client/models/time_off_request.rb +36 -21
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +31 -0
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/bank_info_api_spec.rb +8 -6
- data/spec/api/benefits_api_spec.rb +3 -3
- data/spec/api/common_model_scopes_api_spec.rb +58 -0
- data/spec/api/companies_api_spec.rb +2 -2
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/api/dependents_api_spec.rb +70 -0
- data/spec/api/employee_payroll_runs_api_spec.rb +2 -2
- data/spec/api/employees_api_spec.rb +13 -6
- data/spec/api/employer_benefits_api_spec.rb +68 -0
- data/spec/api/employments_api_spec.rb +7 -5
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +7 -4
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/locations_api_spec.rb +6 -4
- data/spec/api/pay_groups_api_spec.rb +2 -2
- data/spec/api/payroll_runs_api_spec.rb +7 -5
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/teams_api_spec.rb +2 -2
- data/spec/api/time_off_api_spec.rb +8 -6
- data/spec/api/time_off_balances_api_spec.rb +7 -5
- data/spec/models/account_integration_spec.rb +12 -0
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/bank_info_spec.rb +14 -2
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +31 -1
- data/spec/models/common_model_scope_data_spec.rb +40 -0
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
- data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
- data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_spec.rb +40 -0
- data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
- data/spec/models/company_spec.rb +14 -2
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/deduction_spec.rb +20 -2
- data/spec/models/dependent_spec.rb +130 -0
- data/spec/models/earning_spec.rb +24 -0
- data/spec/models/employee_payroll_run_spec.rb +14 -2
- data/spec/models/employee_request_spec.rb +5 -11
- data/spec/models/employee_spec.rb +15 -3
- data/spec/models/employer_benefit_spec.rb +88 -0
- data/spec/models/employment_spec.rb +14 -2
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/group_spec.rb +14 -2
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/location_spec.rb +14 -2
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/paginated_dependent_list_spec.rb +46 -0
- data/spec/models/paginated_employer_benefit_list_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +14 -2
- data/spec/models/payroll_run_spec.rb +14 -2
- data/spec/models/relationship_enum_spec.rb +28 -0
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tax_spec.rb +24 -0
- data/spec/models/team_spec.rb +14 -2
- data/spec/models/time_off_balance_spec.rb +14 -2
- data/spec/models/time_off_request_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +14 -2
- metadata +225 -105
@@ -100,10 +100,10 @@ module MergeHRISClient
|
|
100
100
|
# @param model_id [String]
|
101
101
|
# @param ignore_common_model_request [IgnoreCommonModelRequest]
|
102
102
|
# @param [Hash] opts the optional parameters
|
103
|
-
# @return [
|
103
|
+
# @return [nil]
|
104
104
|
def employees_ignore_create(x_account_token, model_id, ignore_common_model_request, opts = {})
|
105
|
-
|
106
|
-
|
105
|
+
employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts)
|
106
|
+
nil
|
107
107
|
end
|
108
108
|
|
109
109
|
# Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.
|
@@ -111,7 +111,7 @@ module MergeHRISClient
|
|
111
111
|
# @param model_id [String]
|
112
112
|
# @param ignore_common_model_request [IgnoreCommonModelRequest]
|
113
113
|
# @param [Hash] opts the optional parameters
|
114
|
-
# @return [Array<(
|
114
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
115
115
|
def employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts = {})
|
116
116
|
if @api_client.config.debugging
|
117
117
|
@api_client.config.logger.debug 'Calling API: EmployeesApi.employees_ignore_create ...'
|
@@ -136,8 +136,6 @@ module MergeHRISClient
|
|
136
136
|
|
137
137
|
# header parameters
|
138
138
|
header_params = opts[:header_params] || {}
|
139
|
-
# HTTP header 'Accept' (if needed)
|
140
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
141
139
|
# HTTP header 'Content-Type'
|
142
140
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
143
141
|
header_params[:'X-Account-Token'] = x_account_token
|
@@ -149,7 +147,7 @@ module MergeHRISClient
|
|
149
147
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(ignore_common_model_request)
|
150
148
|
|
151
149
|
# return_type
|
152
|
-
return_type = opts[:debug_return_type]
|
150
|
+
return_type = opts[:debug_return_type]
|
153
151
|
|
154
152
|
# auth_names
|
155
153
|
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
@@ -179,22 +177,28 @@ module MergeHRISClient
|
|
179
177
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
180
178
|
# @option opts [String] :cursor The pagination cursor value.
|
181
179
|
# @option opts [String] :display_full_name If provided, will only return employees with this display name.
|
182
|
-
# @option opts [String] :employment_status If provided, will only return employees with this employment status.
|
180
|
+
# @option opts [String] :employment_status If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
|
183
181
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
184
182
|
# @option opts [String] :first_name If provided, will only return employees with this first name.
|
183
|
+
# @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
|
185
184
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
186
185
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
187
186
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
188
187
|
# @option opts [String] :last_name If provided, will only return employees with this last name.
|
189
188
|
# @option opts [String] :manager_id If provided, will only return employees for this manager.
|
190
|
-
# @option opts [Time] :modified_after If provided,
|
191
|
-
# @option opts [Time] :modified_before If provided,
|
189
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
190
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
192
191
|
# @option opts [Integer] :page_size Number of results to return per page.
|
193
192
|
# @option opts [String] :pay_group_id If provided, will only return employees for this pay group
|
194
193
|
# @option opts [String] :personal_email If provided, will only return Employees with this personal email
|
195
|
-
# @option opts [String] :remote_fields
|
194
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
196
195
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
196
|
+
# @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
|
197
|
+
# @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
|
198
|
+
# @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
|
197
199
|
# @option opts [String] :team_id If provided, will only return employees for this team.
|
200
|
+
# @option opts [Time] :terminated_after If provided, will only return employees that were terminated after this datetime.
|
201
|
+
# @option opts [Time] :terminated_before If provided, will only return employees that were terminated before this datetime.
|
198
202
|
# @option opts [String] :work_email If provided, will only return Employees with this work email
|
199
203
|
# @option opts [String] :work_location_id If provided, will only return employees for this location.
|
200
204
|
# @return [PaginatedEmployeeList]
|
@@ -211,22 +215,28 @@ module MergeHRISClient
|
|
211
215
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
212
216
|
# @option opts [String] :cursor The pagination cursor value.
|
213
217
|
# @option opts [String] :display_full_name If provided, will only return employees with this display name.
|
214
|
-
# @option opts [String] :employment_status If provided, will only return employees with this employment status.
|
218
|
+
# @option opts [String] :employment_status If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
|
215
219
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
216
220
|
# @option opts [String] :first_name If provided, will only return employees with this first name.
|
221
|
+
# @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
|
217
222
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
218
223
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
219
224
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
220
225
|
# @option opts [String] :last_name If provided, will only return employees with this last name.
|
221
226
|
# @option opts [String] :manager_id If provided, will only return employees for this manager.
|
222
|
-
# @option opts [Time] :modified_after If provided,
|
223
|
-
# @option opts [Time] :modified_before If provided,
|
227
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
228
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
224
229
|
# @option opts [Integer] :page_size Number of results to return per page.
|
225
230
|
# @option opts [String] :pay_group_id If provided, will only return employees for this pay group
|
226
231
|
# @option opts [String] :personal_email If provided, will only return Employees with this personal email
|
227
|
-
# @option opts [String] :remote_fields
|
232
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
228
233
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
234
|
+
# @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
|
235
|
+
# @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
|
236
|
+
# @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
|
229
237
|
# @option opts [String] :team_id If provided, will only return employees for this team.
|
238
|
+
# @option opts [Time] :terminated_after If provided, will only return employees that were terminated after this datetime.
|
239
|
+
# @option opts [Time] :terminated_before If provided, will only return employees that were terminated before this datetime.
|
230
240
|
# @option opts [String] :work_email If provided, will only return Employees with this work email
|
231
241
|
# @option opts [String] :work_location_id If provided, will only return employees for this location.
|
232
242
|
# @return [Array<(PaginatedEmployeeList, Integer, Hash)>] PaginatedEmployeeList data, response status code and response headers
|
@@ -250,6 +260,10 @@ module MergeHRISClient
|
|
250
260
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
251
261
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
252
262
|
end
|
263
|
+
allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
|
264
|
+
if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
|
265
|
+
fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
|
266
|
+
end
|
253
267
|
# resource path
|
254
268
|
local_var_path = '/employees'
|
255
269
|
|
@@ -263,6 +277,7 @@ module MergeHRISClient
|
|
263
277
|
query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
|
264
278
|
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
265
279
|
query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
|
280
|
+
query_params[:'groups'] = opts[:'groups'] if !opts[:'groups'].nil?
|
266
281
|
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
267
282
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
268
283
|
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
@@ -275,7 +290,12 @@ module MergeHRISClient
|
|
275
290
|
query_params[:'personal_email'] = opts[:'personal_email'] if !opts[:'personal_email'].nil?
|
276
291
|
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
277
292
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
293
|
+
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
294
|
+
query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
|
295
|
+
query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil?
|
278
296
|
query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
|
297
|
+
query_params[:'terminated_after'] = opts[:'terminated_after'] if !opts[:'terminated_after'].nil?
|
298
|
+
query_params[:'terminated_before'] = opts[:'terminated_before'] if !opts[:'terminated_before'].nil?
|
279
299
|
query_params[:'work_email'] = opts[:'work_email'] if !opts[:'work_email'].nil?
|
280
300
|
query_params[:'work_location_id'] = opts[:'work_location_id'] if !opts[:'work_location_id'].nil?
|
281
301
|
|
@@ -383,7 +403,8 @@ module MergeHRISClient
|
|
383
403
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
384
404
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
385
405
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
386
|
-
# @option opts [String] :remote_fields
|
406
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
407
|
+
# @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
|
387
408
|
# @return [Employee]
|
388
409
|
def employees_retrieve(x_account_token, id, opts = {})
|
389
410
|
data, _status_code, _headers = employees_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -397,7 +418,8 @@ module MergeHRISClient
|
|
397
418
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
398
419
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
399
420
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
400
|
-
# @option opts [String] :remote_fields
|
421
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
422
|
+
# @option opts [String] :show_enum_origins Which fields should be returned in non-normalized form.
|
401
423
|
# @return [Array<(Employee, Integer, Hash)>] Employee data, response status code and response headers
|
402
424
|
def employees_retrieve_with_http_info(x_account_token, id, opts = {})
|
403
425
|
if @api_client.config.debugging
|
@@ -419,6 +441,10 @@ module MergeHRISClient
|
|
419
441
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
420
442
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
421
443
|
end
|
444
|
+
allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
|
445
|
+
if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
|
446
|
+
fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
|
447
|
+
end
|
422
448
|
# resource path
|
423
449
|
local_var_path = '/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
424
450
|
|
@@ -428,6 +454,7 @@ module MergeHRISClient
|
|
428
454
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
429
455
|
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
430
456
|
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
457
|
+
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
431
458
|
|
432
459
|
# header parameters
|
433
460
|
header_params = opts[:header_params] || {}
|
@@ -0,0 +1,182 @@
|
|
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 EmployerBenefitsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Returns a list of `EmployerBenefit` objects.
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
|
+
# @option opts [String] :cursor The pagination cursor value.
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
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, 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
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
33
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
34
|
+
# @return [PaginatedEmployerBenefitList]
|
35
|
+
def employer_benefits_list(x_account_token, opts = {})
|
36
|
+
data, _status_code, _headers = employer_benefits_list_with_http_info(x_account_token, opts)
|
37
|
+
data
|
38
|
+
end
|
39
|
+
|
40
|
+
# Returns a list of `EmployerBenefit` objects.
|
41
|
+
# @param x_account_token [String] Token identifying the end user.
|
42
|
+
# @param [Hash] opts the optional parameters
|
43
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
44
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
45
|
+
# @option opts [String] :cursor The pagination cursor value.
|
46
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
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, 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
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
51
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
52
|
+
# @return [Array<(PaginatedEmployerBenefitList, Integer, Hash)>] PaginatedEmployerBenefitList data, response status code and response headers
|
53
|
+
def employer_benefits_list_with_http_info(x_account_token, opts = {})
|
54
|
+
if @api_client.config.debugging
|
55
|
+
@api_client.config.logger.debug 'Calling API: EmployerBenefitsApi.employer_benefits_list ...'
|
56
|
+
end
|
57
|
+
# verify the required parameter 'x_account_token' is set
|
58
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
59
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployerBenefitsApi.employer_benefits_list"
|
60
|
+
end
|
61
|
+
# resource path
|
62
|
+
local_var_path = '/employer-benefits'
|
63
|
+
|
64
|
+
# query parameters
|
65
|
+
query_params = opts[:query_params] || {}
|
66
|
+
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
67
|
+
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
68
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
69
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
70
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
71
|
+
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
72
|
+
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
73
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
74
|
+
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
75
|
+
|
76
|
+
# header parameters
|
77
|
+
header_params = opts[:header_params] || {}
|
78
|
+
# HTTP header 'Accept' (if needed)
|
79
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
80
|
+
header_params[:'X-Account-Token'] = x_account_token
|
81
|
+
|
82
|
+
# form parameters
|
83
|
+
form_params = opts[:form_params] || {}
|
84
|
+
|
85
|
+
# http body (model)
|
86
|
+
post_body = opts[:debug_body]
|
87
|
+
|
88
|
+
# return_type
|
89
|
+
return_type = opts[:debug_return_type] || 'PaginatedEmployerBenefitList'
|
90
|
+
|
91
|
+
# auth_names
|
92
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
93
|
+
|
94
|
+
new_options = opts.merge(
|
95
|
+
:operation => :"EmployerBenefitsApi.employer_benefits_list",
|
96
|
+
:header_params => header_params,
|
97
|
+
:query_params => query_params,
|
98
|
+
:form_params => form_params,
|
99
|
+
:body => post_body,
|
100
|
+
:auth_names => auth_names,
|
101
|
+
:return_type => return_type
|
102
|
+
)
|
103
|
+
|
104
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
105
|
+
if @api_client.config.debugging
|
106
|
+
@api_client.config.logger.debug "API called: EmployerBenefitsApi#employer_benefits_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
107
|
+
end
|
108
|
+
return data, status_code, headers
|
109
|
+
end
|
110
|
+
|
111
|
+
# Returns an `EmployerBenefit` object with the given `id`.
|
112
|
+
# @param x_account_token [String] Token identifying the end user.
|
113
|
+
# @param id [String]
|
114
|
+
# @param [Hash] opts the optional parameters
|
115
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
116
|
+
# @return [EmployerBenefit]
|
117
|
+
def employer_benefits_retrieve(x_account_token, id, opts = {})
|
118
|
+
data, _status_code, _headers = employer_benefits_retrieve_with_http_info(x_account_token, id, opts)
|
119
|
+
data
|
120
|
+
end
|
121
|
+
|
122
|
+
# Returns an `EmployerBenefit` object with the given `id`.
|
123
|
+
# @param x_account_token [String] Token identifying the end user.
|
124
|
+
# @param id [String]
|
125
|
+
# @param [Hash] opts the optional parameters
|
126
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
127
|
+
# @return [Array<(EmployerBenefit, Integer, Hash)>] EmployerBenefit data, response status code and response headers
|
128
|
+
def employer_benefits_retrieve_with_http_info(x_account_token, id, opts = {})
|
129
|
+
if @api_client.config.debugging
|
130
|
+
@api_client.config.logger.debug 'Calling API: EmployerBenefitsApi.employer_benefits_retrieve ...'
|
131
|
+
end
|
132
|
+
# verify the required parameter 'x_account_token' is set
|
133
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
134
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployerBenefitsApi.employer_benefits_retrieve"
|
135
|
+
end
|
136
|
+
# verify the required parameter 'id' is set
|
137
|
+
if @api_client.config.client_side_validation && id.nil?
|
138
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EmployerBenefitsApi.employer_benefits_retrieve"
|
139
|
+
end
|
140
|
+
# resource path
|
141
|
+
local_var_path = '/employer-benefits/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
142
|
+
|
143
|
+
# query parameters
|
144
|
+
query_params = opts[:query_params] || {}
|
145
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
146
|
+
|
147
|
+
# header parameters
|
148
|
+
header_params = opts[:header_params] || {}
|
149
|
+
# HTTP header 'Accept' (if needed)
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
151
|
+
header_params[:'X-Account-Token'] = x_account_token
|
152
|
+
|
153
|
+
# form parameters
|
154
|
+
form_params = opts[:form_params] || {}
|
155
|
+
|
156
|
+
# http body (model)
|
157
|
+
post_body = opts[:debug_body]
|
158
|
+
|
159
|
+
# return_type
|
160
|
+
return_type = opts[:debug_return_type] || 'EmployerBenefit'
|
161
|
+
|
162
|
+
# auth_names
|
163
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
164
|
+
|
165
|
+
new_options = opts.merge(
|
166
|
+
:operation => :"EmployerBenefitsApi.employer_benefits_retrieve",
|
167
|
+
:header_params => header_params,
|
168
|
+
:query_params => query_params,
|
169
|
+
:form_params => form_params,
|
170
|
+
:body => post_body,
|
171
|
+
:auth_names => auth_names,
|
172
|
+
:return_type => return_type
|
173
|
+
)
|
174
|
+
|
175
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
176
|
+
if @api_client.config.debugging
|
177
|
+
@api_client.config.logger.debug "API called: EmployerBenefitsApi#employer_benefits_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
178
|
+
end
|
179
|
+
return data, status_code, headers
|
180
|
+
end
|
181
|
+
end
|
182
|
+
end
|
@@ -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,
|
33
|
-
# @option opts [Time] :modified_before If provided,
|
34
|
-
# @option opts [String] :order_by Overrides the default ordering for this endpoint.
|
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
|
+
# @option opts [String] :order_by Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
|
35
35
|
# @option opts [Integer] :page_size Number of results to return per page.
|
36
|
-
# @option opts [String] :remote_fields
|
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,
|
55
|
-
# @option opts [Time] :modified_before If provided,
|
56
|
-
# @option opts [String] :order_by Overrides the default ordering for this endpoint.
|
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.
|
57
|
+
# @option opts [String] :order_by Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
|
57
58
|
# @option opts [Integer] :page_size Number of results to return per page.
|
58
|
-
# @option opts [String] :remote_fields
|
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
|
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
|
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
|
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
|
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,
|
31
|
-
# @option opts [Time] :modified_before If provided,
|
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
|
33
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
34
34
|
# @option opts [String] :remote_id The API provider'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,
|
50
|
-
# @option opts [Time] :modified_before If provided,
|
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
|
54
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
53
55
|
# @option opts [String] :remote_id The API provider'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
|
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
|
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
|
33
|
-
# @option opts [Time] :last_incident_time_before If provided, will only return issues whose
|
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: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - 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
|
54
|
-
# @option opts [Time] :last_incident_time_before If provided, will only return issues whose
|
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: ('ONGOING', 'RESOLVED') * `ONGOING` - ONGOING * `RESOLVED` - 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
|