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
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MergeHRISClient::RemoteFieldAPI
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **schema** | [**Hash<String, AnyType>**](AnyType.md) | | |
|
|
8
|
+
| **remote_key_name** | **String** | | |
|
|
9
|
+
| **remote_endpoint_info** | [**RemoteEndpointInfo**](RemoteEndpointInfo.md) | | |
|
|
10
|
+
| **example_values** | [**Array<AnyType>**](AnyType.md) | | [optional] |
|
|
11
|
+
| **advanced_metadata** | [**AdvancedMetadata**](AdvancedMetadata.md) | | |
|
|
12
|
+
| **coverage** | [**OneOfintegerdouble**](OneOfintegerdouble.md) | | [optional][readonly] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'merge_hris_client'
|
|
18
|
+
|
|
19
|
+
instance = MergeHRISClient::RemoteFieldAPI.new(
|
|
20
|
+
schema: {"type":"string"},
|
|
21
|
+
remote_key_name: example_remote_key_name,
|
|
22
|
+
remote_endpoint_info: null,
|
|
23
|
+
example_values: ["example"],
|
|
24
|
+
advanced_metadata: null,
|
|
25
|
+
coverage: 0.33
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# MergeHRISClient::RemoteFieldAPIResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **benefit** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
8
|
+
| **employer_benefit** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
9
|
+
| **company** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
10
|
+
| **employee_payroll_run** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
11
|
+
| **employee** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
12
|
+
| **employment** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
13
|
+
| **location** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
14
|
+
| **payroll_run** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
15
|
+
| **team** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
16
|
+
| **time_off** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
17
|
+
| **time_off_balance** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
18
|
+
| **bank_info** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
19
|
+
| **pay_group** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
20
|
+
| **group** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
21
|
+
| **dependent** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
22
|
+
| **timesheet_entry** | [**Array<RemoteFieldAPI>**](RemoteFieldAPI.md) | | [optional] |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'merge_hris_client'
|
|
28
|
+
|
|
29
|
+
instance = MergeHRISClient::RemoteFieldAPIResponse.new(
|
|
30
|
+
benefit: null,
|
|
31
|
+
employer_benefit: null,
|
|
32
|
+
company: null,
|
|
33
|
+
employee_payroll_run: null,
|
|
34
|
+
employee: null,
|
|
35
|
+
employment: null,
|
|
36
|
+
location: null,
|
|
37
|
+
payroll_run: null,
|
|
38
|
+
team: null,
|
|
39
|
+
time_off: null,
|
|
40
|
+
time_off_balance: null,
|
|
41
|
+
bank_info: null,
|
|
42
|
+
pay_group: null,
|
|
43
|
+
group: null,
|
|
44
|
+
dependent: null,
|
|
45
|
+
timesheet_entry: null
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
data/docs/RemoteResponse.md
CHANGED
|
@@ -7,8 +7,9 @@
|
|
|
7
7
|
| **method** | **String** | | |
|
|
8
8
|
| **path** | **String** | | |
|
|
9
9
|
| **status** | **Integer** | | |
|
|
10
|
-
| **response** | [**
|
|
10
|
+
| **response** | [**AnyType**](.md) | | |
|
|
11
11
|
| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
12
|
+
| **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
|
|
12
13
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -22,6 +23,7 @@ instance = MergeHRISClient::RemoteResponse.new(
|
|
|
22
23
|
status: 200,
|
|
23
24
|
response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
|
24
25
|
response_headers: {"X-Page-Token":"value"},
|
|
26
|
+
response_type: JSON,
|
|
25
27
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
|
26
28
|
)
|
|
27
29
|
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MergeHRISClient::ResponseTypeEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'merge_hris_client'
|
|
12
|
+
|
|
13
|
+
instance = MergeHRISClient::ResponseTypeEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/RoleEnum.md
ADDED
data/docs/ScopesApi.md
ADDED
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
# MergeHRISClient::ScopesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**default_scopes_retrieve**](ScopesApi.md#default_scopes_retrieve) | **GET** /default-scopes | |
|
|
8
|
+
| [**linked_account_scopes_create**](ScopesApi.md#linked_account_scopes_create) | **POST** /linked-account-scopes | |
|
|
9
|
+
| [**linked_account_scopes_retrieve**](ScopesApi.md#linked_account_scopes_retrieve) | **GET** /linked-account-scopes | |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## default_scopes_retrieve
|
|
13
|
+
|
|
14
|
+
> <CommonModelScopeAPI> default_scopes_retrieve
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'merge_hris_client'
|
|
25
|
+
# setup authorization
|
|
26
|
+
MergeHRISClient.configure do |config|
|
|
27
|
+
# Configure API key authorization: tokenAuth
|
|
28
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
30
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = MergeHRISClient::ScopesApi.new
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
|
|
37
|
+
result = api_instance.default_scopes_retrieve
|
|
38
|
+
p result
|
|
39
|
+
rescue MergeHRISClient::ApiError => e
|
|
40
|
+
puts "Error when calling ScopesApi->default_scopes_retrieve: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the default_scopes_retrieve_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(<CommonModelScopeAPI>, Integer, Hash)> default_scopes_retrieve_with_http_info
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
|
|
53
|
+
data, status_code, headers = api_instance.default_scopes_retrieve_with_http_info
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => <CommonModelScopeAPI>
|
|
57
|
+
rescue MergeHRISClient::ApiError => e
|
|
58
|
+
puts "Error when calling ScopesApi->default_scopes_retrieve_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
This endpoint does not need any parameter.
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**CommonModelScopeAPI**](CommonModelScopeAPI.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: Not defined
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## linked_account_scopes_create
|
|
81
|
+
|
|
82
|
+
> <CommonModelScopeAPI> linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request)
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
|
|
87
|
+
|
|
88
|
+
### Examples
|
|
89
|
+
|
|
90
|
+
```ruby
|
|
91
|
+
require 'time'
|
|
92
|
+
require 'merge_hris_client'
|
|
93
|
+
# setup authorization
|
|
94
|
+
MergeHRISClient.configure do |config|
|
|
95
|
+
# Configure API key authorization: tokenAuth
|
|
96
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
97
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
98
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = MergeHRISClient::ScopesApi.new
|
|
102
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
103
|
+
linked_account_common_model_scope_deserializer_request = MergeHRISClient::LinkedAccountCommonModelScopeDeserializerRequest.new({common_models: [MergeHRISClient::IndividualCommonModelScopeDeserializerRequest.new({model_name: 'model_name_example'})]}) # LinkedAccountCommonModelScopeDeserializerRequest |
|
|
104
|
+
|
|
105
|
+
begin
|
|
106
|
+
|
|
107
|
+
result = api_instance.linked_account_scopes_create(x_account_token, linked_account_common_model_scope_deserializer_request)
|
|
108
|
+
p result
|
|
109
|
+
rescue MergeHRISClient::ApiError => e
|
|
110
|
+
puts "Error when calling ScopesApi->linked_account_scopes_create: #{e}"
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Using the linked_account_scopes_create_with_http_info variant
|
|
115
|
+
|
|
116
|
+
This returns an Array which contains the response data, status code and headers.
|
|
117
|
+
|
|
118
|
+
> <Array(<CommonModelScopeAPI>, Integer, Hash)> linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request)
|
|
119
|
+
|
|
120
|
+
```ruby
|
|
121
|
+
begin
|
|
122
|
+
|
|
123
|
+
data, status_code, headers = api_instance.linked_account_scopes_create_with_http_info(x_account_token, linked_account_common_model_scope_deserializer_request)
|
|
124
|
+
p status_code # => 2xx
|
|
125
|
+
p headers # => { ... }
|
|
126
|
+
p data # => <CommonModelScopeAPI>
|
|
127
|
+
rescue MergeHRISClient::ApiError => e
|
|
128
|
+
puts "Error when calling ScopesApi->linked_account_scopes_create_with_http_info: #{e}"
|
|
129
|
+
end
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Parameters
|
|
133
|
+
|
|
134
|
+
| Name | Type | Description | Notes |
|
|
135
|
+
| ---- | ---- | ----------- | ----- |
|
|
136
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
137
|
+
| **linked_account_common_model_scope_deserializer_request** | [**LinkedAccountCommonModelScopeDeserializerRequest**](LinkedAccountCommonModelScopeDeserializerRequest.md) | | |
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**CommonModelScopeAPI**](CommonModelScopeAPI.md)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
150
|
+
- **Accept**: application/json
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
## linked_account_scopes_retrieve
|
|
154
|
+
|
|
155
|
+
> <CommonModelScopeAPI> linked_account_scopes_retrieve(x_account_token)
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
|
|
160
|
+
|
|
161
|
+
### Examples
|
|
162
|
+
|
|
163
|
+
```ruby
|
|
164
|
+
require 'time'
|
|
165
|
+
require 'merge_hris_client'
|
|
166
|
+
# setup authorization
|
|
167
|
+
MergeHRISClient.configure do |config|
|
|
168
|
+
# Configure API key authorization: tokenAuth
|
|
169
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
170
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
171
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
api_instance = MergeHRISClient::ScopesApi.new
|
|
175
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
176
|
+
|
|
177
|
+
begin
|
|
178
|
+
|
|
179
|
+
result = api_instance.linked_account_scopes_retrieve(x_account_token)
|
|
180
|
+
p result
|
|
181
|
+
rescue MergeHRISClient::ApiError => e
|
|
182
|
+
puts "Error when calling ScopesApi->linked_account_scopes_retrieve: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
#### Using the linked_account_scopes_retrieve_with_http_info variant
|
|
187
|
+
|
|
188
|
+
This returns an Array which contains the response data, status code and headers.
|
|
189
|
+
|
|
190
|
+
> <Array(<CommonModelScopeAPI>, Integer, Hash)> linked_account_scopes_retrieve_with_http_info(x_account_token)
|
|
191
|
+
|
|
192
|
+
```ruby
|
|
193
|
+
begin
|
|
194
|
+
|
|
195
|
+
data, status_code, headers = api_instance.linked_account_scopes_retrieve_with_http_info(x_account_token)
|
|
196
|
+
p status_code # => 2xx
|
|
197
|
+
p headers # => { ... }
|
|
198
|
+
p data # => <CommonModelScopeAPI>
|
|
199
|
+
rescue MergeHRISClient::ApiError => e
|
|
200
|
+
puts "Error when calling ScopesApi->linked_account_scopes_retrieve_with_http_info: #{e}"
|
|
201
|
+
end
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Parameters
|
|
205
|
+
|
|
206
|
+
| Name | Type | Description | Notes |
|
|
207
|
+
| ---- | ---- | ----------- | ----- |
|
|
208
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
209
|
+
|
|
210
|
+
### Return type
|
|
211
|
+
|
|
212
|
+
[**CommonModelScopeAPI**](CommonModelScopeAPI.md)
|
|
213
|
+
|
|
214
|
+
### Authorization
|
|
215
|
+
|
|
216
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
217
|
+
|
|
218
|
+
### HTTP request headers
|
|
219
|
+
|
|
220
|
+
- **Content-Type**: Not defined
|
|
221
|
+
- **Accept**: application/json
|
|
222
|
+
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
# MergeHRISClient::SelectiveSyncApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**selective_sync_configurations_list**](SelectiveSyncApi.md#selective_sync_configurations_list) | **GET** /selective-sync/configurations | |
|
|
8
|
+
| [**selective_sync_configurations_update**](SelectiveSyncApi.md#selective_sync_configurations_update) | **PUT** /selective-sync/configurations | |
|
|
9
|
+
| [**selective_sync_meta_list**](SelectiveSyncApi.md#selective_sync_meta_list) | **GET** /selective-sync/meta | |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## selective_sync_configurations_list
|
|
13
|
+
|
|
14
|
+
> <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_list(x_account_token)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
Get a linked account's selective syncs.
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'merge_hris_client'
|
|
25
|
+
# setup authorization
|
|
26
|
+
MergeHRISClient.configure do |config|
|
|
27
|
+
# Configure API key authorization: tokenAuth
|
|
28
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
30
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = MergeHRISClient::SelectiveSyncApi.new
|
|
34
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
|
|
38
|
+
result = api_instance.selective_sync_configurations_list(x_account_token)
|
|
39
|
+
p result
|
|
40
|
+
rescue MergeHRISClient::ApiError => e
|
|
41
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Using the selective_sync_configurations_list_with_http_info variant
|
|
46
|
+
|
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
|
48
|
+
|
|
49
|
+
> <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_list_with_http_info(x_account_token)
|
|
50
|
+
|
|
51
|
+
```ruby
|
|
52
|
+
begin
|
|
53
|
+
|
|
54
|
+
data, status_code, headers = api_instance.selective_sync_configurations_list_with_http_info(x_account_token)
|
|
55
|
+
p status_code # => 2xx
|
|
56
|
+
p headers # => { ... }
|
|
57
|
+
p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
|
|
58
|
+
rescue MergeHRISClient::ApiError => e
|
|
59
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_list_with_http_info: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**Array<LinkedAccountSelectiveSyncConfiguration>**](LinkedAccountSelectiveSyncConfiguration.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: Not defined
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## selective_sync_configurations_update
|
|
84
|
+
|
|
85
|
+
> <Array<LinkedAccountSelectiveSyncConfiguration>> selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
Replace a linked account's selective syncs.
|
|
90
|
+
|
|
91
|
+
### Examples
|
|
92
|
+
|
|
93
|
+
```ruby
|
|
94
|
+
require 'time'
|
|
95
|
+
require 'merge_hris_client'
|
|
96
|
+
# setup authorization
|
|
97
|
+
MergeHRISClient.configure do |config|
|
|
98
|
+
# Configure API key authorization: tokenAuth
|
|
99
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
100
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
101
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
api_instance = MergeHRISClient::SelectiveSyncApi.new
|
|
105
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
106
|
+
linked_account_selective_sync_configuration_list_request = MergeHRISClient::LinkedAccountSelectiveSyncConfigurationListRequest.new({sync_configurations: [MergeHRISClient::LinkedAccountSelectiveSyncConfigurationRequest.new({linked_account_conditions: [MergeHRISClient::LinkedAccountConditionRequest.new({condition_schema_id: 'condition_schema_id_example', operator: 'operator_example', value: TODO})]})]}) # LinkedAccountSelectiveSyncConfigurationListRequest |
|
|
107
|
+
|
|
108
|
+
begin
|
|
109
|
+
|
|
110
|
+
result = api_instance.selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
|
|
111
|
+
p result
|
|
112
|
+
rescue MergeHRISClient::ApiError => e
|
|
113
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update: #{e}"
|
|
114
|
+
end
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
#### Using the selective_sync_configurations_update_with_http_info variant
|
|
118
|
+
|
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
|
120
|
+
|
|
121
|
+
> <Array(<Array<LinkedAccountSelectiveSyncConfiguration>>, Integer, Hash)> selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
|
|
122
|
+
|
|
123
|
+
```ruby
|
|
124
|
+
begin
|
|
125
|
+
|
|
126
|
+
data, status_code, headers = api_instance.selective_sync_configurations_update_with_http_info(x_account_token, linked_account_selective_sync_configuration_list_request)
|
|
127
|
+
p status_code # => 2xx
|
|
128
|
+
p headers # => { ... }
|
|
129
|
+
p data # => <Array<LinkedAccountSelectiveSyncConfiguration>>
|
|
130
|
+
rescue MergeHRISClient::ApiError => e
|
|
131
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_configurations_update_with_http_info: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
| Name | Type | Description | Notes |
|
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
|
139
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
140
|
+
| **linked_account_selective_sync_configuration_list_request** | [**LinkedAccountSelectiveSyncConfigurationListRequest**](LinkedAccountSelectiveSyncConfigurationListRequest.md) | | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
[**Array<LinkedAccountSelectiveSyncConfiguration>**](LinkedAccountSelectiveSyncConfiguration.md)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: application/json
|
|
153
|
+
- **Accept**: application/json
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
## selective_sync_meta_list
|
|
157
|
+
|
|
158
|
+
> <PaginatedConditionSchemaList> selective_sync_meta_list(x_account_token, opts)
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
Get metadata for the conditions available to a linked account.
|
|
163
|
+
|
|
164
|
+
### Examples
|
|
165
|
+
|
|
166
|
+
```ruby
|
|
167
|
+
require 'time'
|
|
168
|
+
require 'merge_hris_client'
|
|
169
|
+
# setup authorization
|
|
170
|
+
MergeHRISClient.configure do |config|
|
|
171
|
+
# Configure API key authorization: tokenAuth
|
|
172
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
|
173
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
174
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = MergeHRISClient::SelectiveSyncApi.new
|
|
178
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
|
179
|
+
opts = {
|
|
180
|
+
common_model: 'common_model_example', # String |
|
|
181
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
182
|
+
page_size: 56 # Integer | Number of results to return per page.
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
begin
|
|
186
|
+
|
|
187
|
+
result = api_instance.selective_sync_meta_list(x_account_token, opts)
|
|
188
|
+
p result
|
|
189
|
+
rescue MergeHRISClient::ApiError => e
|
|
190
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_meta_list: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
#### Using the selective_sync_meta_list_with_http_info variant
|
|
195
|
+
|
|
196
|
+
This returns an Array which contains the response data, status code and headers.
|
|
197
|
+
|
|
198
|
+
> <Array(<PaginatedConditionSchemaList>, Integer, Hash)> selective_sync_meta_list_with_http_info(x_account_token, opts)
|
|
199
|
+
|
|
200
|
+
```ruby
|
|
201
|
+
begin
|
|
202
|
+
|
|
203
|
+
data, status_code, headers = api_instance.selective_sync_meta_list_with_http_info(x_account_token, opts)
|
|
204
|
+
p status_code # => 2xx
|
|
205
|
+
p headers # => { ... }
|
|
206
|
+
p data # => <PaginatedConditionSchemaList>
|
|
207
|
+
rescue MergeHRISClient::ApiError => e
|
|
208
|
+
puts "Error when calling SelectiveSyncApi->selective_sync_meta_list_with_http_info: #{e}"
|
|
209
|
+
end
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
| Name | Type | Description | Notes |
|
|
215
|
+
| ---- | ---- | ----------- | ----- |
|
|
216
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
|
217
|
+
| **common_model** | **String** | | [optional] |
|
|
218
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
219
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**PaginatedConditionSchemaList**](PaginatedConditionSchemaList.md)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[tokenAuth](../README.md#tokenAuth)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: Not defined
|
|
232
|
+
- **Accept**: application/json
|
|
233
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# MergeHRISClient::SelectiveSyncConfigurationsUsageEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'merge_hris_client'
|
|
12
|
+
|
|
13
|
+
instance = MergeHRISClient::SelectiveSyncConfigurationsUsageEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/SyncStatus.md
CHANGED
|
@@ -6,10 +6,11 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **model_name** | **String** | | |
|
|
8
8
|
| **model_id** | **String** | | |
|
|
9
|
-
| **last_sync_start** | **Time** | |
|
|
10
|
-
| **next_sync_start** | **Time** | |
|
|
9
|
+
| **last_sync_start** | **Time** | | [optional] |
|
|
10
|
+
| **next_sync_start** | **Time** | | [optional] |
|
|
11
11
|
| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
|
|
12
12
|
| **is_initial_sync** | **Boolean** | | |
|
|
13
|
+
| **selective_sync_configurations_usage** | [**SelectiveSyncConfigurationsUsageEnum**](SelectiveSyncConfigurationsUsageEnum.md) | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -17,12 +18,13 @@
|
|
|
17
18
|
require 'merge_hris_client'
|
|
18
19
|
|
|
19
20
|
instance = MergeHRISClient::SyncStatus.new(
|
|
20
|
-
model_name:
|
|
21
|
-
model_id:
|
|
21
|
+
model_name: Employee,
|
|
22
|
+
model_id: hris.Employee,
|
|
22
23
|
last_sync_start: 2021-03-30T19:44:18.695973Z,
|
|
23
24
|
next_sync_start: 2021-03-30T20:44:18.662942Z,
|
|
24
25
|
status: SYNCING,
|
|
25
|
-
is_initial_sync: true
|
|
26
|
+
is_initial_sync: true,
|
|
27
|
+
selective_sync_configurations_usage: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/SyncStatusApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/hris/v1*
|
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING
|
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
|
|
17
17
|
|
|
18
18
|
### Examples
|
|
19
19
|
|
data/docs/Tax.md
CHANGED
|
@@ -5,12 +5,16 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
+
| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
|
|
10
|
+
| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
|
|
8
11
|
| **employee_payroll_run** | **String** | | [optional] |
|
|
9
12
|
| **name** | **String** | The tax's name. | [optional] |
|
|
10
13
|
| **amount** | **Float** | The tax amount. | [optional] |
|
|
11
14
|
| **employer_tax** | **Boolean** | Whether or not the employer is responsible for paying the tax. | [optional] |
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional] |
|
|
16
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
|
17
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
14
18
|
|
|
15
19
|
## Example
|
|
16
20
|
|
|
@@ -19,12 +23,16 @@ require 'merge_hris_client'
|
|
|
19
23
|
|
|
20
24
|
instance = MergeHRISClient::Tax.new(
|
|
21
25
|
id: e3a825fd-c38d-4095-a717-df98c4cb9ebc,
|
|
26
|
+
remote_id: 26806834,
|
|
27
|
+
created_at: 2021-09-15T00:00Z,
|
|
28
|
+
modified_at: 2021-10-16T00:00Z,
|
|
22
29
|
employee_payroll_run: 35347df1-95e7-46e2-93cc-66f1191edca5,
|
|
23
30
|
name: California State Income Tax,
|
|
24
31
|
amount: 100.25,
|
|
25
32
|
employer_tax: false,
|
|
26
|
-
|
|
27
|
-
|
|
33
|
+
remote_was_deleted: null,
|
|
34
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
|
35
|
+
remote_data: null
|
|
28
36
|
)
|
|
29
37
|
```
|
|
30
38
|
|