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,188 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Merge HRIS API
|
|
3
|
+
|
|
4
|
+
#The unified API for building rich integrations with multiple HR Information System platforms.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0
|
|
7
|
+
Contact: hello@merge.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 5.1.1
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module MergeHRISClient
|
|
16
|
+
class DependentsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Returns a list of `Dependent` objects.
|
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
|
26
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
|
27
|
+
# @option opts [String] :cursor The pagination cursor value.
|
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
29
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
30
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
31
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
32
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
33
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
34
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
35
|
+
# @return [PaginatedDependentList]
|
|
36
|
+
def dependents_list(x_account_token, opts = {})
|
|
37
|
+
data, _status_code, _headers = dependents_list_with_http_info(x_account_token, opts)
|
|
38
|
+
data
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Returns a list of `Dependent` objects.
|
|
42
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
43
|
+
# @param [Hash] opts the optional parameters
|
|
44
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
|
45
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
|
46
|
+
# @option opts [String] :cursor The pagination cursor value.
|
|
47
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
48
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
49
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
50
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
51
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
52
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
53
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
54
|
+
# @return [Array<(PaginatedDependentList, Integer, Hash)>] PaginatedDependentList data, response status code and response headers
|
|
55
|
+
def dependents_list_with_http_info(x_account_token, opts = {})
|
|
56
|
+
if @api_client.config.debugging
|
|
57
|
+
@api_client.config.logger.debug 'Calling API: DependentsApi.dependents_list ...'
|
|
58
|
+
end
|
|
59
|
+
# verify the required parameter 'x_account_token' is set
|
|
60
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
61
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DependentsApi.dependents_list"
|
|
62
|
+
end
|
|
63
|
+
# resource path
|
|
64
|
+
local_var_path = '/dependents'
|
|
65
|
+
|
|
66
|
+
# query parameters
|
|
67
|
+
query_params = opts[:query_params] || {}
|
|
68
|
+
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
|
69
|
+
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
|
70
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
71
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
|
72
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
73
|
+
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
|
74
|
+
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
|
75
|
+
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
|
76
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
77
|
+
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
78
|
+
|
|
79
|
+
# header parameters
|
|
80
|
+
header_params = opts[:header_params] || {}
|
|
81
|
+
# HTTP header 'Accept' (if needed)
|
|
82
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
83
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
84
|
+
|
|
85
|
+
# form parameters
|
|
86
|
+
form_params = opts[:form_params] || {}
|
|
87
|
+
|
|
88
|
+
# http body (model)
|
|
89
|
+
post_body = opts[:debug_body]
|
|
90
|
+
|
|
91
|
+
# return_type
|
|
92
|
+
return_type = opts[:debug_return_type] || 'PaginatedDependentList'
|
|
93
|
+
|
|
94
|
+
# auth_names
|
|
95
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
96
|
+
|
|
97
|
+
new_options = opts.merge(
|
|
98
|
+
:operation => :"DependentsApi.dependents_list",
|
|
99
|
+
:header_params => header_params,
|
|
100
|
+
:query_params => query_params,
|
|
101
|
+
:form_params => form_params,
|
|
102
|
+
:body => post_body,
|
|
103
|
+
:auth_names => auth_names,
|
|
104
|
+
:return_type => return_type
|
|
105
|
+
)
|
|
106
|
+
|
|
107
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
108
|
+
if @api_client.config.debugging
|
|
109
|
+
@api_client.config.logger.debug "API called: DependentsApi#dependents_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
110
|
+
end
|
|
111
|
+
return data, status_code, headers
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Returns a `Dependent` object with the given `id`.
|
|
115
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
116
|
+
# @param id [String]
|
|
117
|
+
# @param [Hash] opts the optional parameters
|
|
118
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
119
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
120
|
+
# @return [Dependent]
|
|
121
|
+
def dependents_retrieve(x_account_token, id, opts = {})
|
|
122
|
+
data, _status_code, _headers = dependents_retrieve_with_http_info(x_account_token, id, opts)
|
|
123
|
+
data
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# Returns a `Dependent` object with the given `id`.
|
|
127
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
128
|
+
# @param id [String]
|
|
129
|
+
# @param [Hash] opts the optional parameters
|
|
130
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
131
|
+
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
132
|
+
# @return [Array<(Dependent, Integer, Hash)>] Dependent data, response status code and response headers
|
|
133
|
+
def dependents_retrieve_with_http_info(x_account_token, id, opts = {})
|
|
134
|
+
if @api_client.config.debugging
|
|
135
|
+
@api_client.config.logger.debug 'Calling API: DependentsApi.dependents_retrieve ...'
|
|
136
|
+
end
|
|
137
|
+
# verify the required parameter 'x_account_token' is set
|
|
138
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
139
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DependentsApi.dependents_retrieve"
|
|
140
|
+
end
|
|
141
|
+
# verify the required parameter 'id' is set
|
|
142
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
143
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DependentsApi.dependents_retrieve"
|
|
144
|
+
end
|
|
145
|
+
# resource path
|
|
146
|
+
local_var_path = '/dependents/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
147
|
+
|
|
148
|
+
# query parameters
|
|
149
|
+
query_params = opts[:query_params] || {}
|
|
150
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
151
|
+
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
|
152
|
+
|
|
153
|
+
# header parameters
|
|
154
|
+
header_params = opts[:header_params] || {}
|
|
155
|
+
# HTTP header 'Accept' (if needed)
|
|
156
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
157
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
158
|
+
|
|
159
|
+
# form parameters
|
|
160
|
+
form_params = opts[:form_params] || {}
|
|
161
|
+
|
|
162
|
+
# http body (model)
|
|
163
|
+
post_body = opts[:debug_body]
|
|
164
|
+
|
|
165
|
+
# return_type
|
|
166
|
+
return_type = opts[:debug_return_type] || 'Dependent'
|
|
167
|
+
|
|
168
|
+
# auth_names
|
|
169
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
170
|
+
|
|
171
|
+
new_options = opts.merge(
|
|
172
|
+
:operation => :"DependentsApi.dependents_retrieve",
|
|
173
|
+
:header_params => header_params,
|
|
174
|
+
:query_params => query_params,
|
|
175
|
+
:form_params => form_params,
|
|
176
|
+
:body => post_body,
|
|
177
|
+
:auth_names => auth_names,
|
|
178
|
+
:return_type => return_type
|
|
179
|
+
)
|
|
180
|
+
|
|
181
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
182
|
+
if @api_client.config.debugging
|
|
183
|
+
@api_client.config.logger.debug "API called: DependentsApi#dependents_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
184
|
+
end
|
|
185
|
+
return data, status_code, headers
|
|
186
|
+
end
|
|
187
|
+
end
|
|
188
|
+
end
|
|
@@ -31,8 +31,8 @@ module MergeHRISClient
|
|
|
31
31
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
32
32
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
33
33
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
34
|
-
# @option opts [Time] :modified_after If provided,
|
|
35
|
-
# @option opts [Time] :modified_before If provided,
|
|
34
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
35
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
36
36
|
# @option opts [Integer] :page_size Number of results to return per page.
|
|
37
37
|
# @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee.
|
|
38
38
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
@@ -56,8 +56,8 @@ module MergeHRISClient
|
|
|
56
56
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
57
57
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
58
58
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
59
|
-
# @option opts [Time] :modified_after If provided,
|
|
60
|
-
# @option opts [Time] :modified_before If provided,
|
|
59
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
60
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
61
61
|
# @option opts [Integer] :page_size Number of results to return per page.
|
|
62
62
|
# @option opts [String] :payroll_run_id If provided, will only return employee payroll runs for this employee.
|
|
63
63
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
@@ -100,10 +100,10 @@ module MergeHRISClient
|
|
|
100
100
|
# @param model_id [String]
|
|
101
101
|
# @param ignore_common_model_request [IgnoreCommonModelRequest]
|
|
102
102
|
# @param [Hash] opts the optional parameters
|
|
103
|
-
# @return [
|
|
103
|
+
# @return [nil]
|
|
104
104
|
def employees_ignore_create(x_account_token, model_id, ignore_common_model_request, opts = {})
|
|
105
|
-
|
|
106
|
-
|
|
105
|
+
employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts)
|
|
106
|
+
nil
|
|
107
107
|
end
|
|
108
108
|
|
|
109
109
|
# Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.
|
|
@@ -111,7 +111,7 @@ module MergeHRISClient
|
|
|
111
111
|
# @param model_id [String]
|
|
112
112
|
# @param ignore_common_model_request [IgnoreCommonModelRequest]
|
|
113
113
|
# @param [Hash] opts the optional parameters
|
|
114
|
-
# @return [Array<(
|
|
114
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
115
115
|
def employees_ignore_create_with_http_info(x_account_token, model_id, ignore_common_model_request, opts = {})
|
|
116
116
|
if @api_client.config.debugging
|
|
117
117
|
@api_client.config.logger.debug 'Calling API: EmployeesApi.employees_ignore_create ...'
|
|
@@ -136,8 +136,6 @@ module MergeHRISClient
|
|
|
136
136
|
|
|
137
137
|
# header parameters
|
|
138
138
|
header_params = opts[:header_params] || {}
|
|
139
|
-
# HTTP header 'Accept' (if needed)
|
|
140
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
141
139
|
# HTTP header 'Content-Type'
|
|
142
140
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
|
143
141
|
header_params[:'X-Account-Token'] = x_account_token
|
|
@@ -149,7 +147,7 @@ module MergeHRISClient
|
|
|
149
147
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(ignore_common_model_request)
|
|
150
148
|
|
|
151
149
|
# return_type
|
|
152
|
-
return_type = opts[:debug_return_type]
|
|
150
|
+
return_type = opts[:debug_return_type]
|
|
153
151
|
|
|
154
152
|
# auth_names
|
|
155
153
|
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
@@ -179,22 +177,31 @@ module MergeHRISClient
|
|
|
179
177
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
|
180
178
|
# @option opts [String] :cursor The pagination cursor value.
|
|
181
179
|
# @option opts [String] :display_full_name If provided, will only return employees with this display name.
|
|
182
|
-
# @option opts [String] :employment_status If provided, will only return employees with this employment status.
|
|
180
|
+
# @option opts [String] :employment_status If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
|
|
181
|
+
# @option opts [String] :employment_type If provided, will only return employees that have an employment of the specified employment_type.
|
|
183
182
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
184
183
|
# @option opts [String] :first_name If provided, will only return employees with this first name.
|
|
184
|
+
# @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
|
|
185
|
+
# @option opts [String] :home_location_id If provided, will only return employees for this home location.
|
|
185
186
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
186
187
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
187
188
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
189
|
+
# @option opts [String] :job_title If provided, will only return employees that have an employment of the specified job_title.
|
|
188
190
|
# @option opts [String] :last_name If provided, will only return employees with this last name.
|
|
189
191
|
# @option opts [String] :manager_id If provided, will only return employees for this manager.
|
|
190
|
-
# @option opts [Time] :modified_after If provided,
|
|
191
|
-
# @option opts [Time] :modified_before If provided,
|
|
192
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
193
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
192
194
|
# @option opts [Integer] :page_size Number of results to return per page.
|
|
193
195
|
# @option opts [String] :pay_group_id If provided, will only return employees for this pay group
|
|
194
196
|
# @option opts [String] :personal_email If provided, will only return Employees with this personal email
|
|
195
|
-
# @option opts [String] :remote_fields
|
|
197
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
196
198
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
199
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
200
|
+
# @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
|
|
201
|
+
# @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
|
|
197
202
|
# @option opts [String] :team_id If provided, will only return employees for this team.
|
|
203
|
+
# @option opts [Time] :terminated_after If provided, will only return employees that were terminated after this datetime.
|
|
204
|
+
# @option opts [Time] :terminated_before If provided, will only return employees that were terminated before this datetime.
|
|
198
205
|
# @option opts [String] :work_email If provided, will only return Employees with this work email
|
|
199
206
|
# @option opts [String] :work_location_id If provided, will only return employees for this location.
|
|
200
207
|
# @return [PaginatedEmployeeList]
|
|
@@ -211,22 +218,31 @@ module MergeHRISClient
|
|
|
211
218
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
|
212
219
|
# @option opts [String] :cursor The pagination cursor value.
|
|
213
220
|
# @option opts [String] :display_full_name If provided, will only return employees with this display name.
|
|
214
|
-
# @option opts [String] :employment_status If provided, will only return employees with this employment status.
|
|
221
|
+
# @option opts [String] :employment_status If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
|
|
222
|
+
# @option opts [String] :employment_type If provided, will only return employees that have an employment of the specified employment_type.
|
|
215
223
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
216
224
|
# @option opts [String] :first_name If provided, will only return employees with this first name.
|
|
225
|
+
# @option opts [String] :groups If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
|
|
226
|
+
# @option opts [String] :home_location_id If provided, will only return employees for this home location.
|
|
217
227
|
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
218
228
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
219
229
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
230
|
+
# @option opts [String] :job_title If provided, will only return employees that have an employment of the specified job_title.
|
|
220
231
|
# @option opts [String] :last_name If provided, will only return employees with this last name.
|
|
221
232
|
# @option opts [String] :manager_id If provided, will only return employees for this manager.
|
|
222
|
-
# @option opts [Time] :modified_after If provided,
|
|
223
|
-
# @option opts [Time] :modified_before If provided,
|
|
233
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
234
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
224
235
|
# @option opts [Integer] :page_size Number of results to return per page.
|
|
225
236
|
# @option opts [String] :pay_group_id If provided, will only return employees for this pay group
|
|
226
237
|
# @option opts [String] :personal_email If provided, will only return Employees with this personal email
|
|
227
|
-
# @option opts [String] :remote_fields
|
|
238
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
228
239
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
240
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
241
|
+
# @option opts [Time] :started_after If provided, will only return employees that started after this datetime.
|
|
242
|
+
# @option opts [Time] :started_before If provided, will only return employees that started before this datetime.
|
|
229
243
|
# @option opts [String] :team_id If provided, will only return employees for this team.
|
|
244
|
+
# @option opts [Time] :terminated_after If provided, will only return employees that were terminated after this datetime.
|
|
245
|
+
# @option opts [Time] :terminated_before If provided, will only return employees that were terminated before this datetime.
|
|
230
246
|
# @option opts [String] :work_email If provided, will only return Employees with this work email
|
|
231
247
|
# @option opts [String] :work_location_id If provided, will only return employees for this location.
|
|
232
248
|
# @return [Array<(PaginatedEmployeeList, Integer, Hash)>] PaginatedEmployeeList data, response status code and response headers
|
|
@@ -250,6 +266,10 @@ module MergeHRISClient
|
|
|
250
266
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
|
251
267
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
|
252
268
|
end
|
|
269
|
+
allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
|
|
270
|
+
if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
|
|
271
|
+
fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
|
|
272
|
+
end
|
|
253
273
|
# resource path
|
|
254
274
|
local_var_path = '/employees'
|
|
255
275
|
|
|
@@ -261,11 +281,15 @@ module MergeHRISClient
|
|
|
261
281
|
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
262
282
|
query_params[:'display_full_name'] = opts[:'display_full_name'] if !opts[:'display_full_name'].nil?
|
|
263
283
|
query_params[:'employment_status'] = opts[:'employment_status'] if !opts[:'employment_status'].nil?
|
|
284
|
+
query_params[:'employment_type'] = opts[:'employment_type'] if !opts[:'employment_type'].nil?
|
|
264
285
|
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
|
265
286
|
query_params[:'first_name'] = opts[:'first_name'] if !opts[:'first_name'].nil?
|
|
287
|
+
query_params[:'groups'] = opts[:'groups'] if !opts[:'groups'].nil?
|
|
288
|
+
query_params[:'home_location_id'] = opts[:'home_location_id'] if !opts[:'home_location_id'].nil?
|
|
266
289
|
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
|
267
290
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
268
291
|
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
|
292
|
+
query_params[:'job_title'] = opts[:'job_title'] if !opts[:'job_title'].nil?
|
|
269
293
|
query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
|
|
270
294
|
query_params[:'manager_id'] = opts[:'manager_id'] if !opts[:'manager_id'].nil?
|
|
271
295
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
|
@@ -275,7 +299,12 @@ module MergeHRISClient
|
|
|
275
299
|
query_params[:'personal_email'] = opts[:'personal_email'] if !opts[:'personal_email'].nil?
|
|
276
300
|
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
|
277
301
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
302
|
+
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
|
303
|
+
query_params[:'started_after'] = opts[:'started_after'] if !opts[:'started_after'].nil?
|
|
304
|
+
query_params[:'started_before'] = opts[:'started_before'] if !opts[:'started_before'].nil?
|
|
278
305
|
query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
|
|
306
|
+
query_params[:'terminated_after'] = opts[:'terminated_after'] if !opts[:'terminated_after'].nil?
|
|
307
|
+
query_params[:'terminated_before'] = opts[:'terminated_before'] if !opts[:'terminated_before'].nil?
|
|
279
308
|
query_params[:'work_email'] = opts[:'work_email'] if !opts[:'work_email'].nil?
|
|
280
309
|
query_params[:'work_location_id'] = opts[:'work_location_id'] if !opts[:'work_location_id'].nil?
|
|
281
310
|
|
|
@@ -383,7 +412,8 @@ module MergeHRISClient
|
|
|
383
412
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
384
413
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
385
414
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
386
|
-
# @option opts [String] :remote_fields
|
|
415
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
416
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
387
417
|
# @return [Employee]
|
|
388
418
|
def employees_retrieve(x_account_token, id, opts = {})
|
|
389
419
|
data, _status_code, _headers = employees_retrieve_with_http_info(x_account_token, id, opts)
|
|
@@ -397,7 +427,8 @@ module MergeHRISClient
|
|
|
397
427
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
398
428
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
399
429
|
# @option opts [Boolean] :include_sensitive_fields Whether to include sensitive fields (such as social security numbers) in the response.
|
|
400
|
-
# @option opts [String] :remote_fields
|
|
430
|
+
# @option opts [String] :remote_fields Deprecated. Use show_enum_origins.
|
|
431
|
+
# @option opts [String] :show_enum_origins A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
|
|
401
432
|
# @return [Array<(Employee, Integer, Hash)>] Employee data, response status code and response headers
|
|
402
433
|
def employees_retrieve_with_http_info(x_account_token, id, opts = {})
|
|
403
434
|
if @api_client.config.debugging
|
|
@@ -419,6 +450,10 @@ module MergeHRISClient
|
|
|
419
450
|
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
|
420
451
|
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
|
421
452
|
end
|
|
453
|
+
allowable_values = ["employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status"]
|
|
454
|
+
if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
|
|
455
|
+
fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
|
|
456
|
+
end
|
|
422
457
|
# resource path
|
|
423
458
|
local_var_path = '/employees/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
424
459
|
|
|
@@ -428,6 +463,7 @@ module MergeHRISClient
|
|
|
428
463
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
429
464
|
query_params[:'include_sensitive_fields'] = opts[:'include_sensitive_fields'] if !opts[:'include_sensitive_fields'].nil?
|
|
430
465
|
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
|
466
|
+
query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
|
|
431
467
|
|
|
432
468
|
# header parameters
|
|
433
469
|
header_params = opts[:header_params] || {}
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Merge HRIS API
|
|
3
|
+
|
|
4
|
+
#The unified API for building rich integrations with multiple HR Information System platforms.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0
|
|
7
|
+
Contact: hello@merge.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 5.1.1
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module MergeHRISClient
|
|
16
|
+
class EmployerBenefitsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Returns a list of `EmployerBenefit` objects.
|
|
23
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
|
26
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
|
27
|
+
# @option opts [String] :cursor The pagination cursor value.
|
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
29
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
30
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
31
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
32
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
33
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
34
|
+
# @return [PaginatedEmployerBenefitList]
|
|
35
|
+
def employer_benefits_list(x_account_token, opts = {})
|
|
36
|
+
data, _status_code, _headers = employer_benefits_list_with_http_info(x_account_token, opts)
|
|
37
|
+
data
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Returns a list of `EmployerBenefit` objects.
|
|
41
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
42
|
+
# @param [Hash] opts the optional parameters
|
|
43
|
+
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
|
44
|
+
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
|
45
|
+
# @option opts [String] :cursor The pagination cursor value.
|
|
46
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
|
47
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
48
|
+
# @option opts [Time] :modified_after If provided, only objects synced by Merge after this date time will be returned.
|
|
49
|
+
# @option opts [Time] :modified_before If provided, only objects synced by Merge before this date time will be returned.
|
|
50
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
51
|
+
# @option opts [String] :remote_id The API provider's ID for the given object.
|
|
52
|
+
# @return [Array<(PaginatedEmployerBenefitList, Integer, Hash)>] PaginatedEmployerBenefitList data, response status code and response headers
|
|
53
|
+
def employer_benefits_list_with_http_info(x_account_token, opts = {})
|
|
54
|
+
if @api_client.config.debugging
|
|
55
|
+
@api_client.config.logger.debug 'Calling API: EmployerBenefitsApi.employer_benefits_list ...'
|
|
56
|
+
end
|
|
57
|
+
# verify the required parameter 'x_account_token' is set
|
|
58
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
59
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployerBenefitsApi.employer_benefits_list"
|
|
60
|
+
end
|
|
61
|
+
# resource path
|
|
62
|
+
local_var_path = '/employer-benefits'
|
|
63
|
+
|
|
64
|
+
# query parameters
|
|
65
|
+
query_params = opts[:query_params] || {}
|
|
66
|
+
query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
|
67
|
+
query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
|
68
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
69
|
+
query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
|
|
70
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
71
|
+
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
|
72
|
+
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
|
73
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
74
|
+
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
|
75
|
+
|
|
76
|
+
# header parameters
|
|
77
|
+
header_params = opts[:header_params] || {}
|
|
78
|
+
# HTTP header 'Accept' (if needed)
|
|
79
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
80
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
81
|
+
|
|
82
|
+
# form parameters
|
|
83
|
+
form_params = opts[:form_params] || {}
|
|
84
|
+
|
|
85
|
+
# http body (model)
|
|
86
|
+
post_body = opts[:debug_body]
|
|
87
|
+
|
|
88
|
+
# return_type
|
|
89
|
+
return_type = opts[:debug_return_type] || 'PaginatedEmployerBenefitList'
|
|
90
|
+
|
|
91
|
+
# auth_names
|
|
92
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
93
|
+
|
|
94
|
+
new_options = opts.merge(
|
|
95
|
+
:operation => :"EmployerBenefitsApi.employer_benefits_list",
|
|
96
|
+
:header_params => header_params,
|
|
97
|
+
:query_params => query_params,
|
|
98
|
+
:form_params => form_params,
|
|
99
|
+
:body => post_body,
|
|
100
|
+
:auth_names => auth_names,
|
|
101
|
+
:return_type => return_type
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
105
|
+
if @api_client.config.debugging
|
|
106
|
+
@api_client.config.logger.debug "API called: EmployerBenefitsApi#employer_benefits_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
107
|
+
end
|
|
108
|
+
return data, status_code, headers
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# Returns an `EmployerBenefit` object with the given `id`.
|
|
112
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
113
|
+
# @param id [String]
|
|
114
|
+
# @param [Hash] opts the optional parameters
|
|
115
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
116
|
+
# @return [EmployerBenefit]
|
|
117
|
+
def employer_benefits_retrieve(x_account_token, id, opts = {})
|
|
118
|
+
data, _status_code, _headers = employer_benefits_retrieve_with_http_info(x_account_token, id, opts)
|
|
119
|
+
data
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# Returns an `EmployerBenefit` object with the given `id`.
|
|
123
|
+
# @param x_account_token [String] Token identifying the end user.
|
|
124
|
+
# @param id [String]
|
|
125
|
+
# @param [Hash] opts the optional parameters
|
|
126
|
+
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
127
|
+
# @return [Array<(EmployerBenefit, Integer, Hash)>] EmployerBenefit data, response status code and response headers
|
|
128
|
+
def employer_benefits_retrieve_with_http_info(x_account_token, id, opts = {})
|
|
129
|
+
if @api_client.config.debugging
|
|
130
|
+
@api_client.config.logger.debug 'Calling API: EmployerBenefitsApi.employer_benefits_retrieve ...'
|
|
131
|
+
end
|
|
132
|
+
# verify the required parameter 'x_account_token' is set
|
|
133
|
+
if @api_client.config.client_side_validation && x_account_token.nil?
|
|
134
|
+
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling EmployerBenefitsApi.employer_benefits_retrieve"
|
|
135
|
+
end
|
|
136
|
+
# verify the required parameter 'id' is set
|
|
137
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
138
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling EmployerBenefitsApi.employer_benefits_retrieve"
|
|
139
|
+
end
|
|
140
|
+
# resource path
|
|
141
|
+
local_var_path = '/employer-benefits/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
142
|
+
|
|
143
|
+
# query parameters
|
|
144
|
+
query_params = opts[:query_params] || {}
|
|
145
|
+
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
|
146
|
+
|
|
147
|
+
# header parameters
|
|
148
|
+
header_params = opts[:header_params] || {}
|
|
149
|
+
# HTTP header 'Accept' (if needed)
|
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
151
|
+
header_params[:'X-Account-Token'] = x_account_token
|
|
152
|
+
|
|
153
|
+
# form parameters
|
|
154
|
+
form_params = opts[:form_params] || {}
|
|
155
|
+
|
|
156
|
+
# http body (model)
|
|
157
|
+
post_body = opts[:debug_body]
|
|
158
|
+
|
|
159
|
+
# return_type
|
|
160
|
+
return_type = opts[:debug_return_type] || 'EmployerBenefit'
|
|
161
|
+
|
|
162
|
+
# auth_names
|
|
163
|
+
auth_names = opts[:debug_auth_names] || ['tokenAuth']
|
|
164
|
+
|
|
165
|
+
new_options = opts.merge(
|
|
166
|
+
:operation => :"EmployerBenefitsApi.employer_benefits_retrieve",
|
|
167
|
+
:header_params => header_params,
|
|
168
|
+
:query_params => query_params,
|
|
169
|
+
:form_params => form_params,
|
|
170
|
+
:body => post_body,
|
|
171
|
+
:auth_names => auth_names,
|
|
172
|
+
:return_type => return_type
|
|
173
|
+
)
|
|
174
|
+
|
|
175
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
176
|
+
if @api_client.config.debugging
|
|
177
|
+
@api_client.config.logger.debug "API called: EmployerBenefitsApi#employer_benefits_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
178
|
+
end
|
|
179
|
+
return data, status_code, headers
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|