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
data/docs/Team.md
CHANGED
|
@@ -6,10 +6,13 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
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] |
|
|
9
11
|
| **name** | **String** | The team's name. | [optional] |
|
|
10
|
-
| **parent_team** | **String** |
|
|
12
|
+
| **parent_team** | **String** | The team's parent team. | [optional] |
|
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
|
14
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
|
11
15
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
13
16
|
|
|
14
17
|
## Example
|
|
15
18
|
|
|
@@ -19,10 +22,13 @@ require 'merge_hris_client'
|
|
|
19
22
|
instance = MergeHRISClient::Team.new(
|
|
20
23
|
id: 13a72919-9fae-4f54-81ca-ddfd8712a1ba,
|
|
21
24
|
remote_id: 19202938,
|
|
25
|
+
created_at: 2021-09-15T00:00Z,
|
|
26
|
+
modified_at: 2021-10-16T00:00Z,
|
|
22
27
|
name: Engineering,
|
|
23
28
|
parent_team: 1b998423-db0a-4037-a4cf-f79c60cb67b3,
|
|
24
|
-
|
|
25
|
-
|
|
29
|
+
remote_was_deleted: null,
|
|
30
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
|
31
|
+
remote_data: [{"path":"/teams","data":["Varies by platform"]}]
|
|
26
32
|
)
|
|
27
33
|
```
|
|
28
34
|
|
data/docs/TeamsApi.md
CHANGED
|
@@ -38,8 +38,8 @@ opts = {
|
|
|
38
38
|
expand: 'parent_team', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
39
39
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
41
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
42
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
|
44
44
|
parent_team_id: 'parent_team_id_example', # String | If provided, will only return teams with this parent team.
|
|
45
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
@@ -83,8 +83,8 @@ end
|
|
|
83
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
84
84
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
85
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
86
|
-
| **modified_after** | **Time** | If provided,
|
|
87
|
-
| **modified_before** | **Time** | If provided,
|
|
86
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
|
87
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
|
88
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
89
89
|
| **parent_team_id** | **String** | If provided, will only return teams with this parent team. | [optional] |
|
|
90
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
data/docs/TimeOff.md
CHANGED
|
@@ -6,17 +6,20 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
9
|
+
| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
|
|
10
|
+
| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
|
|
11
|
+
| **employee** | **String** | The employee requesting time off. | [optional] |
|
|
12
|
+
| **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
|
|
13
|
+
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
|
12
14
|
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
|
13
|
-
| **units** | [**UnitsEnum**](UnitsEnum.md) | The
|
|
14
|
-
| **amount** | **Float** | The
|
|
15
|
-
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
|
|
15
|
+
| **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
|
|
16
|
+
| **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
|
|
17
|
+
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
16
18
|
| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
|
|
17
19
|
| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
|
|
18
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
19
20
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
|
21
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
|
22
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
20
23
|
|
|
21
24
|
## Example
|
|
22
25
|
|
|
@@ -26,6 +29,8 @@ require 'merge_hris_client'
|
|
|
26
29
|
instance = MergeHRISClient::TimeOff.new(
|
|
27
30
|
id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
|
|
28
31
|
remote_id: 19202938,
|
|
32
|
+
created_at: 2021-09-15T00:00Z,
|
|
33
|
+
modified_at: 2021-10-16T00:00Z,
|
|
29
34
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
30
35
|
approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
|
31
36
|
status: APPROVED,
|
|
@@ -35,8 +40,9 @@ instance = MergeHRISClient::TimeOff.new(
|
|
|
35
40
|
request_type: VACATION,
|
|
36
41
|
start_time: 2020-11-10T00:00Z,
|
|
37
42
|
end_time: 2020-11-17T00:00Z,
|
|
38
|
-
|
|
39
|
-
|
|
43
|
+
remote_was_deleted: null,
|
|
44
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
|
45
|
+
remote_data: [{"path":"/leave","data":["Varies by platform"]}]
|
|
40
46
|
)
|
|
41
47
|
```
|
|
42
48
|
|
data/docs/TimeOffApi.md
CHANGED
|
@@ -118,16 +118,21 @@ opts = {
|
|
|
118
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
|
119
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
|
120
120
|
employee_id: 'employee_id_example', # String | If provided, will only return time off for this employee.
|
|
121
|
+
ended_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return employees that ended after this datetime.
|
|
122
|
+
ended_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return time-offs that ended before this datetime.
|
|
121
123
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
122
124
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
123
125
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
124
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
125
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
126
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
|
127
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
|
126
128
|
page_size: 56, # Integer | Number of results to return per page.
|
|
127
|
-
remote_fields: 'request_type', # String |
|
|
129
|
+
remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
|
|
128
130
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
|
129
|
-
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
|
130
|
-
|
|
131
|
+
request_type: 'BEREAVEMENT', # String | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
|
132
|
+
show_enum_origins: 'request_type', # String | 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)
|
|
133
|
+
started_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return time-offs that started after this datetime.
|
|
134
|
+
started_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return time-offs that started before this datetime.
|
|
135
|
+
status: 'APPROVED' # String | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
|
|
131
136
|
}
|
|
132
137
|
|
|
133
138
|
begin
|
|
@@ -167,16 +172,21 @@ end
|
|
|
167
172
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
|
168
173
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
|
169
174
|
| **employee_id** | **String** | If provided, will only return time off for this employee. | [optional] |
|
|
175
|
+
| **ended_after** | **Time** | If provided, will only return employees that ended after this datetime. | [optional] |
|
|
176
|
+
| **ended_before** | **Time** | If provided, will only return time-offs that ended before this datetime. | [optional] |
|
|
170
177
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
171
178
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
172
179
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
173
|
-
| **modified_after** | **Time** | If provided,
|
|
174
|
-
| **modified_before** | **Time** | If provided,
|
|
180
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
|
181
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
|
175
182
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
176
|
-
| **remote_fields** | **String** |
|
|
183
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
177
184
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
178
|
-
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
|
179
|
-
| **
|
|
185
|
+
| **request_type** | **String** | If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
186
|
+
| **show_enum_origins** | **String** | 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) | [optional] |
|
|
187
|
+
| **started_after** | **Time** | If provided, will only return time-offs that started after this datetime. | [optional] |
|
|
188
|
+
| **started_before** | **Time** | If provided, will only return time-offs that started before this datetime. | [optional] |
|
|
189
|
+
| **status** | **String** | If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
|
180
190
|
|
|
181
191
|
### Return type
|
|
182
192
|
|
|
@@ -290,7 +300,8 @@ id = TODO # String |
|
|
|
290
300
|
opts = {
|
|
291
301
|
expand: 'approver', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
292
302
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
293
|
-
remote_fields: 'request_type' # String |
|
|
303
|
+
remote_fields: 'request_type', # String | Deprecated. Use show_enum_origins.
|
|
304
|
+
show_enum_origins: 'request_type' # String | 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)
|
|
294
305
|
}
|
|
295
306
|
|
|
296
307
|
begin
|
|
@@ -328,7 +339,8 @@ end
|
|
|
328
339
|
| **id** | [**String**](.md) | | |
|
|
329
340
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
330
341
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
331
|
-
| **remote_fields** | **String** |
|
|
342
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
343
|
+
| **show_enum_origins** | **String** | 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) | [optional] |
|
|
332
344
|
|
|
333
345
|
### Return type
|
|
334
346
|
|
data/docs/TimeOffBalance.md
CHANGED
|
@@ -6,12 +6,15 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
9
|
+
| **created_at** | **Time** | The datetime that this object was created by Merge. | [optional][readonly] |
|
|
10
|
+
| **modified_at** | **Time** | The datetime that this object was modified by Merge. | [optional][readonly] |
|
|
11
|
+
| **employee** | **String** | The employee the balance belongs to. | [optional] |
|
|
12
|
+
| **balance** | **Float** | The current remaining PTO balance, always measured in terms of hours. | [optional] |
|
|
11
13
|
| **used** | **Float** | The amount of PTO used in terms of hours. | [optional] |
|
|
12
|
-
| **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. | [optional] |
|
|
14
|
+
| **policy_type** | [**PolicyTypeEnum**](PolicyTypeEnum.md) | The policy type of this time off balance. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
|
16
|
+
| **field_mappings** | **Object** | | [optional][readonly] |
|
|
13
17
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
|
14
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -21,12 +24,15 @@ require 'merge_hris_client'
|
|
|
21
24
|
instance = MergeHRISClient::TimeOffBalance.new(
|
|
22
25
|
id: 91b2b905-e866-40c8-8be2-efe53827a0aa,
|
|
23
26
|
remote_id: 19202938,
|
|
27
|
+
created_at: 2021-09-15T00:00Z,
|
|
28
|
+
modified_at: 2021-10-16T00:00Z,
|
|
24
29
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
25
30
|
balance: 60.0,
|
|
26
31
|
used: 45.0,
|
|
27
32
|
policy_type: VACATION,
|
|
28
|
-
|
|
29
|
-
|
|
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: [{"path":"/leave","data":["Varies by platform"]}]
|
|
30
36
|
)
|
|
31
37
|
```
|
|
32
38
|
|
data/docs/TimeOffBalancesApi.md
CHANGED
|
@@ -39,12 +39,13 @@ opts = {
|
|
|
39
39
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
40
40
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
|
41
41
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
42
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
43
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
|
42
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
|
43
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
|
45
|
-
policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
|
|
46
|
-
remote_fields: 'policy_type', # String |
|
|
47
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
|
45
|
+
policy_type: 'BEREAVEMENT', # String | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
|
|
46
|
+
remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
|
|
47
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
|
48
|
+
show_enum_origins: 'policy_type' # String | 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)
|
|
48
49
|
}
|
|
49
50
|
|
|
50
51
|
begin
|
|
@@ -86,12 +87,13 @@ end
|
|
|
86
87
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
87
88
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
|
88
89
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
89
|
-
| **modified_after** | **Time** | If provided,
|
|
90
|
-
| **modified_before** | **Time** | If provided,
|
|
90
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
|
91
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
|
91
92
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
|
92
|
-
| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') | [optional] |
|
|
93
|
-
| **remote_fields** | **String** |
|
|
93
|
+
| **policy_type** | **String** | If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
94
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
94
95
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
|
96
|
+
| **show_enum_origins** | **String** | 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) | [optional] |
|
|
95
97
|
|
|
96
98
|
### Return type
|
|
97
99
|
|
|
@@ -134,7 +136,8 @@ id = TODO # String |
|
|
|
134
136
|
opts = {
|
|
135
137
|
expand: 'employee', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
136
138
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
137
|
-
remote_fields: 'policy_type' # String |
|
|
139
|
+
remote_fields: 'policy_type', # String | Deprecated. Use show_enum_origins.
|
|
140
|
+
show_enum_origins: 'policy_type' # String | 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)
|
|
138
141
|
}
|
|
139
142
|
|
|
140
143
|
begin
|
|
@@ -172,7 +175,8 @@ end
|
|
|
172
175
|
| **id** | [**String**](.md) | | |
|
|
173
176
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
|
174
177
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
|
175
|
-
| **remote_fields** | **String** |
|
|
178
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
|
179
|
+
| **show_enum_origins** | **String** | 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) | [optional] |
|
|
176
180
|
|
|
177
181
|
### Return type
|
|
178
182
|
|
data/docs/TimeOffRequest.md
CHANGED
|
@@ -4,16 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. | [optional] |
|
|
7
|
+
| **employee** | **String** | The employee requesting time off. | [optional] |
|
|
8
|
+
| **approver** | **String** | The Merge ID of the employee with the ability to approve the time off request. | [optional] |
|
|
9
|
+
| **status** | [**TimeOffStatusEnum**](TimeOffStatusEnum.md) | The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED | [optional] |
|
|
11
10
|
| **employee_note** | **String** | The employee note for this time off request. | [optional] |
|
|
12
|
-
| **units** | [**UnitsEnum**](UnitsEnum.md) | The
|
|
13
|
-
| **amount** | **Float** | The
|
|
14
|
-
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. | [optional] |
|
|
11
|
+
| **units** | [**UnitsEnum**](UnitsEnum.md) | The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS | [optional] |
|
|
12
|
+
| **amount** | **Float** | The time off quantity measured by the prescribed “units”. | [optional] |
|
|
13
|
+
| **request_type** | [**RequestTypeEnum**](RequestTypeEnum.md) | The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT | [optional] |
|
|
15
14
|
| **start_time** | **Time** | The day and time of the start of the time requested off. | [optional] |
|
|
16
15
|
| **end_time** | **Time** | The day and time of the end of the time requested off. | [optional] |
|
|
16
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
17
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -21,7 +22,6 @@
|
|
|
21
22
|
require 'merge_hris_client'
|
|
22
23
|
|
|
23
24
|
instance = MergeHRISClient::TimeOffRequest.new(
|
|
24
|
-
remote_id: 19202938,
|
|
25
25
|
employee: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
|
26
26
|
approver: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
|
|
27
27
|
status: APPROVED,
|
|
@@ -30,7 +30,9 @@ instance = MergeHRISClient::TimeOffRequest.new(
|
|
|
30
30
|
amount: 3,
|
|
31
31
|
request_type: VACATION,
|
|
32
32
|
start_time: 2020-11-10T00:00Z,
|
|
33
|
-
end_time: 2020-11-17T00:00Z
|
|
33
|
+
end_time: 2020-11-17T00:00Z,
|
|
34
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
|
35
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
|
34
36
|
)
|
|
35
37
|
```
|
|
36
38
|
|