merge_hris_client 2.0.4 → 3.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +67 -10
- data/docs/AccountDetails.md +5 -1
- data/docs/AccountDetailsAndActions.md +9 -3
- data/docs/AccountIntegration.md +10 -2
- data/docs/AdvancedMetadata.md +28 -0
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/AuditLogEvent.md +32 -0
- data/docs/AuditTrailApi.md +91 -0
- data/docs/BankInfo.md +11 -5
- data/docs/BankInfoApi.md +17 -13
- data/docs/Benefit.md +17 -5
- data/docs/BenefitPlanTypeEnum.md +15 -0
- data/docs/BenefitsApi.md +6 -6
- data/docs/CommonModelScopeAPI.md +18 -0
- 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 +9 -3
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/CreateFieldMappingRequest.md +28 -0
- data/docs/DataPassthroughRequest.md +5 -5
- data/docs/DebugModelLogSummary.md +1 -1
- data/docs/Deduction.md +13 -5
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/Dependent.md +52 -0
- data/docs/DependentsApi.md +181 -0
- data/docs/Earning.md +13 -5
- data/docs/Employee.md +27 -15
- data/docs/EmployeePayrollRun.md +13 -7
- data/docs/EmployeePayrollRunsApi.md +4 -4
- data/docs/EmployeeRequest.md +20 -16
- data/docs/EmployeesApi.md +37 -18
- data/docs/EmployerBenefit.md +38 -0
- data/docs/EmployerBenefitsApi.md +177 -0
- data/docs/Employment.md +16 -10
- data/docs/EmploymentsApi.md +15 -11
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +22 -12
- data/docs/EventTypeEnum.md +15 -0
- data/docs/ExternalTargetFieldAPI.md +22 -0
- data/docs/ExternalTargetFieldAPIResponse.md +48 -0
- data/docs/FieldMappingApi.md +455 -0
- data/docs/FieldMappingApiInstance.md +24 -0
- data/docs/FieldMappingApiInstanceRemoteField.md +22 -0
- data/docs/FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo.md +22 -0
- data/docs/FieldMappingApiInstanceResponse.md +48 -0
- data/docs/FieldMappingApiInstanceTargetField.md +22 -0
- data/docs/FieldMappingInstanceResponse.md +24 -0
- data/docs/FieldPermissionDeserializer.md +20 -0
- data/docs/FieldPermissionDeserializerRequest.md +20 -0
- data/docs/ForceResyncApi.md +1 -1
- data/docs/GenerateRemoteKeyRequest.md +1 -1
- data/docs/Group.md +12 -4
- data/docs/GroupsApi.md +19 -9
- data/docs/IndividualCommonModelScopeDeserializer.md +22 -0
- data/docs/IndividualCommonModelScopeDeserializerRequest.md +22 -0
- data/docs/Issue.md +10 -8
- data/docs/IssuesApi.md +11 -9
- data/docs/LinkToken.md +4 -2
- data/docs/LinkTokenApi.md +1 -1
- data/docs/LinkedAccountCommonModelScopeDeserializerRequest.md +18 -0
- 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 +4 -2
- data/docs/Location.md +12 -6
- data/docs/LocationsApi.md +15 -9
- data/docs/MetaResponse.md +3 -1
- data/docs/ModelPermissionDeserializer.md +18 -0
- data/docs/ModelPermissionDeserializerRequest.md +18 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedAuditLogEventList.md +22 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/PaginatedDependentList.md +22 -0
- data/docs/PaginatedEmployerBenefitList.md +22 -0
- data/docs/PaginatedTimesheetEntryList.md +22 -0
- data/docs/PatchedEditFieldMappingRequest.md +22 -0
- data/docs/PayGroup.md +9 -3
- data/docs/PayGroupsApi.md +4 -4
- data/docs/PayrollRun.md +11 -5
- data/docs/PayrollRunsApi.md +14 -10
- data/docs/RelationshipEnum.md +15 -0
- data/docs/RemoteData.md +1 -1
- data/docs/RemoteEndpointInfo.md +22 -0
- data/docs/RemoteFieldAPI.md +28 -0
- data/docs/RemoteFieldAPIResponse.md +48 -0
- data/docs/RemoteKeyForRegenerationRequest.md +1 -1
- data/docs/RemoteResponse.md +3 -1
- data/docs/ResponseTypeEnum.md +15 -0
- data/docs/RoleEnum.md +15 -0
- data/docs/ScopesApi.md +222 -0
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +7 -5
- data/docs/SyncStatusApi.md +1 -1
- data/docs/Tax.md +12 -4
- data/docs/Team.md +10 -4
- data/docs/TeamsApi.md +4 -4
- data/docs/TimeOff.md +15 -9
- data/docs/TimeOffApi.md +24 -12
- data/docs/TimeOffBalance.md +12 -6
- data/docs/TimeOffBalancesApi.md +15 -11
- data/docs/TimeOffRequest.md +11 -9
- data/docs/TimesheetEntriesApi.md +341 -0
- data/docs/TimesheetEntry.md +38 -0
- data/docs/TimesheetEntryEndpointRequest.md +18 -0
- data/docs/TimesheetEntryRequest.md +28 -0
- data/docs/TimesheetEntryResponse.md +24 -0
- data/lib/merge_hris_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_hris_client/api/audit_trail_api.rb +95 -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 +53 -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/field_mapping_api.rb +424 -0
- data/lib/merge_hris_client/api/force_resync_api.rb +2 -2
- data/lib/merge_hris_client/api/groups_api.rb +31 -8
- data/lib/merge_hris_client/api/issues_api.rb +13 -10
- data/lib/merge_hris_client/api/linked_accounts_api.rb +6 -3
- data/lib/merge_hris_client/api/locations_api.rb +29 -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/scopes_api.rb +209 -0
- 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 +38 -12
- data/lib/merge_hris_client/api/time_off_balances_api.rb +24 -10
- data/lib/merge_hris_client/api/timesheet_entries_api.rb +342 -0
- data/lib/merge_hris_client/configuration.rb +4 -0
- data/lib/merge_hris_client/models/account_details.rb +24 -4
- data/lib/merge_hris_client/models/account_details_and_actions.rb +39 -4
- data/lib/merge_hris_client/models/account_details_and_actions_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/account_integration.rb +52 -8
- data/lib/merge_hris_client/models/account_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/advanced_metadata.rb +270 -0
- data/lib/merge_hris_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_hris_client/models/audit_log_event.rb +356 -0
- data/lib/merge_hris_client/models/bank_info.rb +48 -17
- data/lib/merge_hris_client/models/benefit.rb +79 -15
- data/lib/merge_hris_client/models/benefit_plan_type_enum.rb +48 -0
- data/lib/merge_hris_client/models/categories_enum.rb +19 -7
- data/lib/merge_hris_client/models/category_enum.rb +19 -7
- data/lib/merge_hris_client/models/common_model_scope_api.rb +226 -0
- 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 +46 -16
- 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/country_enum.rb +17 -7
- data/lib/merge_hris_client/models/create_field_mapping_request.rb +396 -0
- data/lib/merge_hris_client/models/data_passthrough_request.rb +5 -1
- data/lib/merge_hris_client/models/deduction.rb +59 -18
- data/lib/merge_hris_client/models/dependent.rb +478 -0
- data/lib/merge_hris_client/models/earning.rb +58 -17
- data/lib/merge_hris_client/models/earning_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/employee.rb +93 -24
- data/lib/merge_hris_client/models/employee_payroll_run.rb +50 -18
- data/lib/merge_hris_client/models/employee_request.rb +56 -28
- data/lib/merge_hris_client/models/employer_benefit.rb +371 -0
- data/lib/merge_hris_client/models/employment.rb +53 -21
- data/lib/merge_hris_client/models/employment_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/employment_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_hris_client/models/encoding_enum.rb +17 -7
- data/lib/merge_hris_client/models/end_user_details_request.rb +102 -11
- data/lib/merge_hris_client/models/ethnicity_enum.rb +17 -7
- data/lib/merge_hris_client/models/event_type_enum.rb +81 -0
- data/lib/merge_hris_client/models/external_target_field_api.rb +239 -0
- data/lib/merge_hris_client/models/external_target_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance.rb +247 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb +253 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb +241 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_response.rb +385 -0
- data/lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb +251 -0
- data/lib/merge_hris_client/models/field_mapping_instance_response.rb +266 -0
- data/lib/merge_hris_client/models/field_permission_deserializer.rb +231 -0
- data/lib/merge_hris_client/models/field_permission_deserializer_request.rb +231 -0
- data/lib/merge_hris_client/models/flsa_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/gender_enum.rb +17 -7
- data/lib/merge_hris_client/models/generate_remote_key_request.rb +1 -0
- data/lib/merge_hris_client/models/group.rb +58 -17
- data/lib/merge_hris_client/models/group_type_enum.rb +18 -7
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb +243 -0
- data/lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb +262 -0
- data/lib/merge_hris_client/models/issue.rb +17 -5
- data/lib/merge_hris_client/models/issue_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/link_token.rb +13 -9
- data/lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb +226 -0
- 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 +48 -18
- data/lib/merge_hris_client/models/location_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/marital_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/meta_response.rb +13 -2
- data/lib/merge_hris_client/models/method_enum.rb +17 -7
- data/lib/merge_hris_client/models/model_permission_deserializer.rb +218 -0
- data/lib/merge_hris_client/models/model_permission_deserializer_request.rb +218 -0
- 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_audit_log_event_list.rb +240 -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/paginated_timesheet_entry_list.rb +240 -0
- data/lib/merge_hris_client/models/patched_edit_field_mapping_request.rb +271 -0
- data/lib/merge_hris_client/models/pay_currency_enum.rb +17 -7
- data/lib/merge_hris_client/models/pay_frequency_enum.rb +18 -7
- data/lib/merge_hris_client/models/pay_group.rb +46 -16
- data/lib/merge_hris_client/models/pay_period_enum.rb +18 -7
- data/lib/merge_hris_client/models/payroll_run.rb +48 -18
- data/lib/merge_hris_client/models/policy_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/reason_enum.rb +17 -7
- 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/remote_endpoint_info.rb +253 -0
- data/lib/merge_hris_client/models/remote_field_api.rb +285 -0
- data/lib/merge_hris_client/models/remote_field_api_response.rb +385 -0
- data/lib/merge_hris_client/models/remote_key_for_regeneration_request.rb +1 -0
- data/lib/merge_hris_client/models/remote_response.rb +14 -11
- data/lib/merge_hris_client/models/request_format_enum.rb +17 -7
- data/lib/merge_hris_client/models/request_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/response_type_enum.rb +45 -0
- data/lib/merge_hris_client/models/role_enum.rb +49 -0
- data/lib/merge_hris_client/models/run_state_enum.rb +17 -7
- data/lib/merge_hris_client/models/run_type_enum.rb +17 -7
- data/lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_hris_client/models/sync_status.rb +13 -14
- data/lib/merge_hris_client/models/sync_status_status_enum.rb +19 -7
- data/lib/merge_hris_client/models/tax.rb +57 -16
- data/lib/merge_hris_client/models/team.rb +47 -16
- data/lib/merge_hris_client/models/time_off.rb +51 -19
- data/lib/merge_hris_client/models/time_off_balance.rb +49 -18
- data/lib/merge_hris_client/models/time_off_request.rb +36 -21
- data/lib/merge_hris_client/models/time_off_status_enum.rb +17 -7
- data/lib/merge_hris_client/models/timesheet_entry.rb +326 -0
- data/lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb +223 -0
- data/lib/merge_hris_client/models/timesheet_entry_request.rb +278 -0
- data/lib/merge_hris_client/models/timesheet_entry_response.rb +266 -0
- data/lib/merge_hris_client/models/units_enum.rb +17 -7
- data/lib/merge_hris_client/version.rb +1 -1
- data/lib/merge_hris_client.rb +49 -4
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/audit_trail_api_spec.rb +51 -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 +16 -6
- data/spec/api/employer_benefits_api_spec.rb +68 -0
- data/spec/api/employments_api_spec.rb +7 -5
- data/spec/api/field_mapping_api_spec.rb +107 -0
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/groups_api_spec.rb +9 -4
- data/spec/api/issues_api_spec.rb +6 -5
- data/spec/api/linked_accounts_api_spec.rb +2 -1
- data/spec/api/locations_api_spec.rb +7 -4
- data/spec/api/pay_groups_api_spec.rb +2 -2
- data/spec/api/payroll_runs_api_spec.rb +7 -5
- data/spec/api/scopes_api_spec.rb +68 -0
- 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 +12 -6
- data/spec/api/time_off_balances_api_spec.rb +7 -5
- data/spec/api/timesheet_entries_api_spec.rb +99 -0
- data/spec/models/account_details_and_actions_spec.rb +18 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/account_integration_spec.rb +24 -0
- data/spec/models/advanced_metadata_spec.rb +64 -0
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/audit_log_event_spec.rb +76 -0
- data/spec/models/bank_info_spec.rb +24 -0
- data/spec/models/benefit_plan_type_enum_spec.rb +28 -0
- data/spec/models/benefit_spec.rb +42 -0
- data/spec/models/common_model_scope_api_spec.rb +34 -0
- 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 +24 -0
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/create_field_mapping_request_spec.rb +64 -0
- data/spec/models/deduction_spec.rb +30 -0
- data/spec/models/dependent_spec.rb +136 -0
- data/spec/models/earning_spec.rb +30 -0
- data/spec/models/employee_payroll_run_spec.rb +24 -0
- data/spec/models/employee_request_spec.rb +18 -6
- data/spec/models/employee_spec.rb +42 -0
- data/spec/models/employer_benefit_spec.rb +94 -0
- data/spec/models/employment_spec.rb +24 -0
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +30 -0
- data/spec/models/event_type_enum_spec.rb +28 -0
- data/spec/models/external_target_field_api_response_spec.rb +124 -0
- data/spec/models/external_target_field_api_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_remote_endpoint_info_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_remote_field_spec.rb +46 -0
- data/spec/models/field_mapping_api_instance_response_spec.rb +124 -0
- data/spec/models/field_mapping_api_instance_spec.rb +52 -0
- data/spec/models/field_mapping_api_instance_target_field_spec.rb +46 -0
- data/spec/models/field_mapping_instance_response_spec.rb +52 -0
- data/spec/models/field_permission_deserializer_request_spec.rb +40 -0
- data/spec/models/field_permission_deserializer_spec.rb +40 -0
- data/spec/models/group_spec.rb +30 -0
- data/spec/models/individual_common_model_scope_deserializer_request_spec.rb +46 -0
- data/spec/models/individual_common_model_scope_deserializer_spec.rb +46 -0
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/link_token_spec.rb +6 -0
- data/spec/models/linked_account_common_model_scope_deserializer_request_spec.rb +34 -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 +24 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/model_permission_deserializer_request_spec.rb +34 -0
- data/spec/models/model_permission_deserializer_spec.rb +34 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_audit_log_event_list_spec.rb +46 -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/paginated_timesheet_entry_list_spec.rb +46 -0
- data/spec/models/patched_edit_field_mapping_request_spec.rb +46 -0
- data/spec/models/pay_group_spec.rb +24 -0
- data/spec/models/payroll_run_spec.rb +24 -0
- data/spec/models/relationship_enum_spec.rb +28 -0
- data/spec/models/remote_endpoint_info_spec.rb +46 -0
- data/spec/models/remote_field_api_response_spec.rb +124 -0
- data/spec/models/remote_field_api_spec.rb +64 -0
- data/spec/models/remote_response_spec.rb +6 -0
- data/spec/models/response_type_enum_spec.rb +28 -0
- data/spec/models/role_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 +30 -0
- data/spec/models/team_spec.rb +24 -0
- data/spec/models/time_off_balance_spec.rb +24 -0
- data/spec/models/time_off_request_spec.rb +12 -6
- data/spec/models/time_off_spec.rb +24 -0
- data/spec/models/timesheet_entry_endpoint_request_spec.rb +34 -0
- data/spec/models/timesheet_entry_request_spec.rb +64 -0
- data/spec/models/timesheet_entry_response_spec.rb +52 -0
- data/spec/models/timesheet_entry_spec.rb +94 -0
- metadata +368 -104
|
@@ -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 A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
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 A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
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 A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
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 A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
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] || {}
|
|
@@ -0,0 +1,424 @@
|
|
|
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 FieldMappingApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
24
|
+
# @param create_field_mapping_request [CreateFieldMappingRequest]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [FieldMappingInstanceResponse]
|
|
27
|
+
def field_mappings_create(x_account_token, create_field_mapping_request, opts = {})
|
|
28
|
+
data, _status_code, _headers = field_mappings_create_with_http_info(x_account_token, create_field_mapping_request, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
|
33
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
34
|
+
# @param create_field_mapping_request [CreateFieldMappingRequest]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(FieldMappingInstanceResponse, Integer, Hash)>] FieldMappingInstanceResponse data, response status code and response headers
|
|
37
|
+
def field_mappings_create_with_http_info(x_account_token, create_field_mapping_request, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_create ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'x_account_token' is set
|
|
42
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_create"
|
|
44
|
+
end
|
|
45
|
+
# verify the required parameter 'create_field_mapping_request' is set
|
|
46
|
+
if @api_client.config.client_side_validation && create_field_mapping_request.nil?
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'create_field_mapping_request' when calling FieldMappingApi.field_mappings_create"
|
|
48
|
+
end
|
|
49
|
+
# resource path
|
|
50
|
+
local_var_path = '/field-mappings'
|
|
51
|
+
|
|
52
|
+
# query parameters
|
|
53
|
+
query_params = opts[:query_params] || {}
|
|
54
|
+
|
|
55
|
+
# header parameters
|
|
56
|
+
header_params = opts[:header_params] || {}
|
|
57
|
+
# HTTP header 'Accept' (if needed)
|
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
59
|
+
# HTTP header 'Content-Type'
|
|
60
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
|
61
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
62
|
+
|
|
63
|
+
# form parameters
|
|
64
|
+
form_params = opts[:form_params] || {}
|
|
65
|
+
|
|
66
|
+
# http body (model)
|
|
67
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_field_mapping_request)
|
|
68
|
+
|
|
69
|
+
# return_type
|
|
70
|
+
return_type = opts[:debug_return_type] || 'FieldMappingInstanceResponse'
|
|
71
|
+
|
|
72
|
+
# auth_names
|
|
73
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
74
|
+
|
|
75
|
+
new_options = opts.merge(
|
|
76
|
+
:operation => :"FieldMappingApi.field_mappings_create",
|
|
77
|
+
:header_params => header_params,
|
|
78
|
+
:query_params => query_params,
|
|
79
|
+
:form_params => form_params,
|
|
80
|
+
:body => post_body,
|
|
81
|
+
:auth_names => auth_names,
|
|
82
|
+
:return_type => return_type
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
86
|
+
if @api_client.config.debugging
|
|
87
|
+
@api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
88
|
+
end
|
|
89
|
+
return data, status_code, headers
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
|
93
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
94
|
+
# @param field_mapping_id [String]
|
|
95
|
+
# @param [Hash] opts the optional parameters
|
|
96
|
+
# @return [FieldMappingInstanceResponse]
|
|
97
|
+
def field_mappings_destroy(x_account_token, field_mapping_id, opts = {})
|
|
98
|
+
data, _status_code, _headers = field_mappings_destroy_with_http_info(x_account_token, field_mapping_id, opts)
|
|
99
|
+
data
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
|
103
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
104
|
+
# @param field_mapping_id [String]
|
|
105
|
+
# @param [Hash] opts the optional parameters
|
|
106
|
+
# @return [Array<(FieldMappingInstanceResponse, Integer, Hash)>] FieldMappingInstanceResponse data, response status code and response headers
|
|
107
|
+
def field_mappings_destroy_with_http_info(x_account_token, field_mapping_id, opts = {})
|
|
108
|
+
if @api_client.config.debugging
|
|
109
|
+
@api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_destroy ...'
|
|
110
|
+
end
|
|
111
|
+
# verify the required parameter 'x_account_token' is set
|
|
112
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
113
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_destroy"
|
|
114
|
+
end
|
|
115
|
+
# verify the required parameter 'field_mapping_id' is set
|
|
116
|
+
if @api_client.config.client_side_validation && field_mapping_id.nil?
|
|
117
|
+
fail ArgumentError, "Missing the required parameter 'field_mapping_id' when calling FieldMappingApi.field_mappings_destroy"
|
|
118
|
+
end
|
|
119
|
+
# resource path
|
|
120
|
+
local_var_path = '/field-mappings/{field_mapping_id}'.sub('{' + 'field_mapping_id' + '}', CGI.escape(field_mapping_id.to_s))
|
|
121
|
+
|
|
122
|
+
# query parameters
|
|
123
|
+
query_params = opts[:query_params] || {}
|
|
124
|
+
|
|
125
|
+
# header parameters
|
|
126
|
+
header_params = opts[:header_params] || {}
|
|
127
|
+
# HTTP header 'Accept' (if needed)
|
|
128
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
129
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
130
|
+
|
|
131
|
+
# form parameters
|
|
132
|
+
form_params = opts[:form_params] || {}
|
|
133
|
+
|
|
134
|
+
# http body (model)
|
|
135
|
+
post_body = opts[:debug_body]
|
|
136
|
+
|
|
137
|
+
# return_type
|
|
138
|
+
return_type = opts[:debug_return_type] || 'FieldMappingInstanceResponse'
|
|
139
|
+
|
|
140
|
+
# auth_names
|
|
141
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
142
|
+
|
|
143
|
+
new_options = opts.merge(
|
|
144
|
+
:operation => :"FieldMappingApi.field_mappings_destroy",
|
|
145
|
+
:header_params => header_params,
|
|
146
|
+
:query_params => query_params,
|
|
147
|
+
:form_params => form_params,
|
|
148
|
+
:body => post_body,
|
|
149
|
+
:auth_names => auth_names,
|
|
150
|
+
:return_type => return_type
|
|
151
|
+
)
|
|
152
|
+
|
|
153
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
154
|
+
if @api_client.config.debugging
|
|
155
|
+
@api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
156
|
+
end
|
|
157
|
+
return data, status_code, headers
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
|
161
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
162
|
+
# @param field_mapping_id [String]
|
|
163
|
+
# @param [Hash] opts the optional parameters
|
|
164
|
+
# @option opts [PatchedEditFieldMappingRequest] :patched_edit_field_mapping_request
|
|
165
|
+
# @return [FieldMappingInstanceResponse]
|
|
166
|
+
def field_mappings_partial_update(x_account_token, field_mapping_id, opts = {})
|
|
167
|
+
data, _status_code, _headers = field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts)
|
|
168
|
+
data
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
|
|
172
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
173
|
+
# @param field_mapping_id [String]
|
|
174
|
+
# @param [Hash] opts the optional parameters
|
|
175
|
+
# @option opts [PatchedEditFieldMappingRequest] :patched_edit_field_mapping_request
|
|
176
|
+
# @return [Array<(FieldMappingInstanceResponse, Integer, Hash)>] FieldMappingInstanceResponse data, response status code and response headers
|
|
177
|
+
def field_mappings_partial_update_with_http_info(x_account_token, field_mapping_id, opts = {})
|
|
178
|
+
if @api_client.config.debugging
|
|
179
|
+
@api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_partial_update ...'
|
|
180
|
+
end
|
|
181
|
+
# verify the required parameter 'x_account_token' is set
|
|
182
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
183
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_partial_update"
|
|
184
|
+
end
|
|
185
|
+
# verify the required parameter 'field_mapping_id' is set
|
|
186
|
+
if @api_client.config.client_side_validation && field_mapping_id.nil?
|
|
187
|
+
fail ArgumentError, "Missing the required parameter 'field_mapping_id' when calling FieldMappingApi.field_mappings_partial_update"
|
|
188
|
+
end
|
|
189
|
+
# resource path
|
|
190
|
+
local_var_path = '/field-mappings/{field_mapping_id}'.sub('{' + 'field_mapping_id' + '}', CGI.escape(field_mapping_id.to_s))
|
|
191
|
+
|
|
192
|
+
# query parameters
|
|
193
|
+
query_params = opts[:query_params] || {}
|
|
194
|
+
|
|
195
|
+
# header parameters
|
|
196
|
+
header_params = opts[:header_params] || {}
|
|
197
|
+
# HTTP header 'Accept' (if needed)
|
|
198
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
199
|
+
# HTTP header 'Content-Type'
|
|
200
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
|
201
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
202
|
+
|
|
203
|
+
# form parameters
|
|
204
|
+
form_params = opts[:form_params] || {}
|
|
205
|
+
|
|
206
|
+
# http body (model)
|
|
207
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patched_edit_field_mapping_request'])
|
|
208
|
+
|
|
209
|
+
# return_type
|
|
210
|
+
return_type = opts[:debug_return_type] || 'FieldMappingInstanceResponse'
|
|
211
|
+
|
|
212
|
+
# auth_names
|
|
213
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
214
|
+
|
|
215
|
+
new_options = opts.merge(
|
|
216
|
+
:operation => :"FieldMappingApi.field_mappings_partial_update",
|
|
217
|
+
:header_params => header_params,
|
|
218
|
+
:query_params => query_params,
|
|
219
|
+
:form_params => form_params,
|
|
220
|
+
:body => post_body,
|
|
221
|
+
:auth_names => auth_names,
|
|
222
|
+
:return_type => return_type
|
|
223
|
+
)
|
|
224
|
+
|
|
225
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
226
|
+
if @api_client.config.debugging
|
|
227
|
+
@api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
228
|
+
end
|
|
229
|
+
return data, status_code, headers
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
# Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
|
|
233
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
234
|
+
# @param [Hash] opts the optional parameters
|
|
235
|
+
# @return [FieldMappingApiInstanceResponse]
|
|
236
|
+
def field_mappings_retrieve(x_account_token, opts = {})
|
|
237
|
+
data, _status_code, _headers = field_mappings_retrieve_with_http_info(x_account_token, opts)
|
|
238
|
+
data
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
# Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
|
|
242
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
243
|
+
# @param [Hash] opts the optional parameters
|
|
244
|
+
# @return [Array<(FieldMappingApiInstanceResponse, Integer, Hash)>] FieldMappingApiInstanceResponse data, response status code and response headers
|
|
245
|
+
def field_mappings_retrieve_with_http_info(x_account_token, opts = {})
|
|
246
|
+
if @api_client.config.debugging
|
|
247
|
+
@api_client.config.logger.debug 'Calling API: FieldMappingApi.field_mappings_retrieve ...'
|
|
248
|
+
end
|
|
249
|
+
# verify the required parameter 'x_account_token' is set
|
|
250
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
251
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.field_mappings_retrieve"
|
|
252
|
+
end
|
|
253
|
+
# resource path
|
|
254
|
+
local_var_path = '/field-mappings'
|
|
255
|
+
|
|
256
|
+
# query parameters
|
|
257
|
+
query_params = opts[:query_params] || {}
|
|
258
|
+
|
|
259
|
+
# header parameters
|
|
260
|
+
header_params = opts[:header_params] || {}
|
|
261
|
+
# HTTP header 'Accept' (if needed)
|
|
262
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
263
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
264
|
+
|
|
265
|
+
# form parameters
|
|
266
|
+
form_params = opts[:form_params] || {}
|
|
267
|
+
|
|
268
|
+
# http body (model)
|
|
269
|
+
post_body = opts[:debug_body]
|
|
270
|
+
|
|
271
|
+
# return_type
|
|
272
|
+
return_type = opts[:debug_return_type] || 'FieldMappingApiInstanceResponse'
|
|
273
|
+
|
|
274
|
+
# auth_names
|
|
275
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
276
|
+
|
|
277
|
+
new_options = opts.merge(
|
|
278
|
+
:operation => :"FieldMappingApi.field_mappings_retrieve",
|
|
279
|
+
:header_params => header_params,
|
|
280
|
+
:query_params => query_params,
|
|
281
|
+
:form_params => form_params,
|
|
282
|
+
:body => post_body,
|
|
283
|
+
:auth_names => auth_names,
|
|
284
|
+
:return_type => return_type
|
|
285
|
+
)
|
|
286
|
+
|
|
287
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
288
|
+
if @api_client.config.debugging
|
|
289
|
+
@api_client.config.logger.debug "API called: FieldMappingApi#field_mappings_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
290
|
+
end
|
|
291
|
+
return data, status_code, headers
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
|
|
295
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
296
|
+
# @param [Hash] opts the optional parameters
|
|
297
|
+
# @option opts [String] :common_models A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
|
|
298
|
+
# @option opts [String] :include_example_values If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
|
|
299
|
+
# @return [RemoteFieldAPIResponse]
|
|
300
|
+
def remote_fields_retrieve(x_account_token, opts = {})
|
|
301
|
+
data, _status_code, _headers = remote_fields_retrieve_with_http_info(x_account_token, opts)
|
|
302
|
+
data
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
# Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
|
|
306
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
307
|
+
# @param [Hash] opts the optional parameters
|
|
308
|
+
# @option opts [String] :common_models A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
|
|
309
|
+
# @option opts [String] :include_example_values If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
|
|
310
|
+
# @return [Array<(RemoteFieldAPIResponse, Integer, Hash)>] RemoteFieldAPIResponse data, response status code and response headers
|
|
311
|
+
def remote_fields_retrieve_with_http_info(x_account_token, opts = {})
|
|
312
|
+
if @api_client.config.debugging
|
|
313
|
+
@api_client.config.logger.debug 'Calling API: FieldMappingApi.remote_fields_retrieve ...'
|
|
314
|
+
end
|
|
315
|
+
# verify the required parameter 'x_account_token' is set
|
|
316
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
317
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.remote_fields_retrieve"
|
|
318
|
+
end
|
|
319
|
+
# resource path
|
|
320
|
+
local_var_path = '/remote-fields'
|
|
321
|
+
|
|
322
|
+
# query parameters
|
|
323
|
+
query_params = opts[:query_params] || {}
|
|
324
|
+
query_params[:'common_models'] = opts[:'common_models'] if !opts[:'common_models'].nil?
|
|
325
|
+
query_params[:'include_example_values'] = opts[:'include_example_values'] if !opts[:'include_example_values'].nil?
|
|
326
|
+
|
|
327
|
+
# header parameters
|
|
328
|
+
header_params = opts[:header_params] || {}
|
|
329
|
+
# HTTP header 'Accept' (if needed)
|
|
330
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
331
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
332
|
+
|
|
333
|
+
# form parameters
|
|
334
|
+
form_params = opts[:form_params] || {}
|
|
335
|
+
|
|
336
|
+
# http body (model)
|
|
337
|
+
post_body = opts[:debug_body]
|
|
338
|
+
|
|
339
|
+
# return_type
|
|
340
|
+
return_type = opts[:debug_return_type] || 'RemoteFieldAPIResponse'
|
|
341
|
+
|
|
342
|
+
# auth_names
|
|
343
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
344
|
+
|
|
345
|
+
new_options = opts.merge(
|
|
346
|
+
:operation => :"FieldMappingApi.remote_fields_retrieve",
|
|
347
|
+
:header_params => header_params,
|
|
348
|
+
:query_params => query_params,
|
|
349
|
+
:form_params => form_params,
|
|
350
|
+
:body => post_body,
|
|
351
|
+
:auth_names => auth_names,
|
|
352
|
+
:return_type => return_type
|
|
353
|
+
)
|
|
354
|
+
|
|
355
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
356
|
+
if @api_client.config.debugging
|
|
357
|
+
@api_client.config.logger.debug "API called: FieldMappingApi#remote_fields_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
358
|
+
end
|
|
359
|
+
return data, status_code, headers
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
# Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
|
|
363
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
364
|
+
# @param [Hash] opts the optional parameters
|
|
365
|
+
# @return [ExternalTargetFieldAPIResponse]
|
|
366
|
+
def target_fields_retrieve(x_account_token, opts = {})
|
|
367
|
+
data, _status_code, _headers = target_fields_retrieve_with_http_info(x_account_token, opts)
|
|
368
|
+
data
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
# Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
|
|
372
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
373
|
+
# @param [Hash] opts the optional parameters
|
|
374
|
+
# @return [Array<(ExternalTargetFieldAPIResponse, Integer, Hash)>] ExternalTargetFieldAPIResponse data, response status code and response headers
|
|
375
|
+
def target_fields_retrieve_with_http_info(x_account_token, opts = {})
|
|
376
|
+
if @api_client.config.debugging
|
|
377
|
+
@api_client.config.logger.debug 'Calling API: FieldMappingApi.target_fields_retrieve ...'
|
|
378
|
+
end
|
|
379
|
+
# verify the required parameter 'x_account_token' is set
|
|
380
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
381
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling FieldMappingApi.target_fields_retrieve"
|
|
382
|
+
end
|
|
383
|
+
# resource path
|
|
384
|
+
local_var_path = '/target-fields'
|
|
385
|
+
|
|
386
|
+
# query parameters
|
|
387
|
+
query_params = opts[:query_params] || {}
|
|
388
|
+
|
|
389
|
+
# header parameters
|
|
390
|
+
header_params = opts[:header_params] || {}
|
|
391
|
+
# HTTP header 'Accept' (if needed)
|
|
392
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
393
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
394
|
+
|
|
395
|
+
# form parameters
|
|
396
|
+
form_params = opts[:form_params] || {}
|
|
397
|
+
|
|
398
|
+
# http body (model)
|
|
399
|
+
post_body = opts[:debug_body]
|
|
400
|
+
|
|
401
|
+
# return_type
|
|
402
|
+
return_type = opts[:debug_return_type] || 'ExternalTargetFieldAPIResponse'
|
|
403
|
+
|
|
404
|
+
# auth_names
|
|
405
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
406
|
+
|
|
407
|
+
new_options = opts.merge(
|
|
408
|
+
:operation => :"FieldMappingApi.target_fields_retrieve",
|
|
409
|
+
:header_params => header_params,
|
|
410
|
+
:query_params => query_params,
|
|
411
|
+
:form_params => form_params,
|
|
412
|
+
:body => post_body,
|
|
413
|
+
:auth_names => auth_names,
|
|
414
|
+
:return_type => return_type
|
|
415
|
+
)
|
|
416
|
+
|
|
417
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
418
|
+
if @api_client.config.debugging
|
|
419
|
+
@api_client.config.logger.debug "API called: FieldMappingApi#target_fields_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
420
|
+
end
|
|
421
|
+
return data, status_code, headers
|
|
422
|
+
end
|
|
423
|
+
end
|
|
424
|
+
end
|
|
@@ -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 Launch, 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 Launch, 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,15 @@ 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 [
|
|
31
|
-
# @option opts [Time] :
|
|
30
|
+
# @option opts [String] :is_commonly_used_as_team If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
|
|
31
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
32
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
33
|
+
# @option opts [String] :names If provided, will only return groups with these names. Multiple values can be separated by commas.
|
|
32
34
|
# @option opts [Integer] :page_size Number of results to return per page.
|
|
33
|
-
# @option opts [String] :remote_fields
|
|
35
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
34
36
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
37
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
38
|
+
# @option opts [String] :types If provided, will only return groups of these types. Multiple values can be separated by commas.
|
|
35
39
|
# @return [PaginatedGroupList]
|
|
36
40
|
def groups_list(x_account_token, opts = {})
|
|
37
41
|
data, _status_code, _headers = groups_list_with_http_info(x_account_token, opts)
|
|
@@ -46,11 +50,15 @@ module MergeHRISClient
|
|
|
46
50
|
# @option opts [String] :cursor The pagination cursor value.
|
|
47
51
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
48
52
|
# @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 [
|
|
50
|
-
# @option opts [Time] :
|
|
53
|
+
# @option opts [String] :is_commonly_used_as_team If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
|
|
54
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
55
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
56
|
+
# @option opts [String] :names If provided, will only return groups with these names. Multiple values can be separated by commas.
|
|
51
57
|
# @option opts [Integer] :page_size Number of results to return per page.
|
|
52
|
-
# @option opts [String] :remote_fields
|
|
58
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
53
59
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
60
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
61
|
+
# @option opts [String] :types If provided, will only return groups of these types. Multiple values can be separated by commas.
|
|
54
62
|
# @return [Array<(PaginatedGroupList, Integer, Hash)>] PaginatedGroupList data, response status code and response headers
|
|
55
63
|
def groups_list_with_http_info(x_account_token, opts = {})
|
|
56
64
|
if @api_client.config.debugging
|
|
@@ -64,6 +72,10 @@ module MergeHRISClient
|
|
|
64
72
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
|
65
73
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
|
66
74
|
end
|
|
75
|
+
allowable_values = ["type"]
|
|
76
|
+
if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
|
|
77
|
+
fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
|
|
78
|
+
end
|
|
67
79
|
# resource path
|
|
68
80
|
local_var_path = '/groups'
|
|
69
81
|
|
|
@@ -74,11 +86,15 @@ module MergeHRISClient
|
|
|
74
86
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
75
87
|
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
|
76
88
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
89
|
+
query_params[:'is_commonly_used_as_team'] = opts[:'is_commonly_used_as_team'] if !opts[:'is_commonly_used_as_team'].nil?
|
|
77
90
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
|
78
91
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
|
92
|
+
query_params[:'names'] = opts[:'names'] if !opts[:'names'].nil?
|
|
79
93
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
80
94
|
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
|
81
95
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
96
|
+
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
|
97
|
+
query_params[:'types'] = opts[:'types'] if !opts[:'types'].nil?
|
|
82
98
|
|
|
83
99
|
# header parameters
|
|
84
100
|
header_params = opts[:header_params] || {}
|
|
@@ -120,7 +136,8 @@ module MergeHRISClient
|
|
|
120
136
|
# @param id [String]
|
|
121
137
|
# @param [Hash] opts the optional parameters
|
|
122
138
|
# @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
|
|
139
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
140
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
124
141
|
# @return [Group]
|
|
125
142
|
def groups_retrieve(x_account_token, id, opts = {})
|
|
126
143
|
data, _status_code, _headers = groups_retrieve_with_http_info(x_account_token, id, opts)
|
|
@@ -132,7 +149,8 @@ module MergeHRISClient
|
|
|
132
149
|
# @param id [String]
|
|
133
150
|
# @param [Hash] opts the optional parameters
|
|
134
151
|
# @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
|
|
152
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
153
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
136
154
|
# @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
|
|
137
155
|
def groups_retrieve_with_http_info(x_account_token, id, opts = {})
|
|
138
156
|
if @api_client.config.debugging
|
|
@@ -150,6 +168,10 @@ module MergeHRISClient
|
|
|
150
168
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
|
151
169
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
|
152
170
|
end
|
|
171
|
+
allowable_values = ["type"]
|
|
172
|
+
if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
|
|
173
|
+
fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
|
|
174
|
+
end
|
|
153
175
|
# resource path
|
|
154
176
|
local_var_path = '/groups/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
155
177
|
|
|
@@ -157,6 +179,7 @@ module MergeHRISClient
|
|
|
157
179
|
query_params = opts[:query_params] || {}
|
|
158
180
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
159
181
|
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
|
182
|
+
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
|
160
183
|
|
|
161
184
|
# header parameters
|
|
162
185
|
header_params = opts[:header_params] || {}
|