Module: MergeHRISClient

Defined in:: lib/merge_hris_client/version.rb,
lib/merge_hris_client.rb,
lib/merge_hris_client/api_error.rb,
lib/merge_hris_client/api_client.rb,
lib/merge_hris_client/models/tax.rb,
lib/merge_hris_client/models/team.rb,
lib/merge_hris_client/models/group.rb,
lib/merge_hris_client/models/issue.rb,
lib/merge_hris_client/api/teams_api.rb,
lib/merge_hris_client/configuration.rb,
lib/merge_hris_client/api/groups_api.rb,
lib/merge_hris_client/api/issues_api.rb,
lib/merge_hris_client/api/scopes_api.rb,
lib/merge_hris_client/models/benefit.rb,
lib/merge_hris_client/models/company.rb,
lib/merge_hris_client/models/earning.rb,
lib/merge_hris_client/models/employee.rb,
lib/merge_hris_client/models/location.rb,
lib/merge_hris_client/models/time_off.rb,
lib/merge_hris_client/api/benefits_api.rb,
lib/merge_hris_client/api/time_off_api.rb,
lib/merge_hris_client/models/bank_info.rb,
lib/merge_hris_client/models/deduction.rb,
lib/merge_hris_client/models/dependent.rb,
lib/merge_hris_client/models/pay_group.rb,
lib/merge_hris_client/models/role_enum.rb,
lib/merge_hris_client/api/bank_info_api.rb,
lib/merge_hris_client/api/companies_api.rb,
lib/merge_hris_client/api/employees_api.rb,
lib/merge_hris_client/api/locations_api.rb,
lib/merge_hris_client/models/employment.rb,
lib/merge_hris_client/models/link_token.rb,
lib/merge_hris_client/models/remote_key.rb,
lib/merge_hris_client/models/units_enum.rb,
lib/merge_hris_client/api/deductions_api.rb,
lib/merge_hris_client/api/dependents_api.rb,
lib/merge_hris_client/api/link_token_api.rb,
lib/merge_hris_client/api/pay_groups_api.rb,
lib/merge_hris_client/models/gender_enum.rb,
lib/merge_hris_client/models/method_enum.rb,
lib/merge_hris_client/models/payroll_run.rb,
lib/merge_hris_client/models/reason_enum.rb,
lib/merge_hris_client/models/remote_data.rb,
lib/merge_hris_client/models/sync_status.rb,
lib/merge_hris_client/api/audit_trail_api.rb,
lib/merge_hris_client/api/employments_api.rb,
lib/merge_hris_client/api/passthrough_api.rb,
lib/merge_hris_client/api/sync_status_api.rb,
lib/merge_hris_client/models/country_enum.rb,
lib/merge_hris_client/api/force_resync_api.rb,
lib/merge_hris_client/api/generate_key_api.rb,
lib/merge_hris_client/api/payroll_runs_api.rb,
lib/merge_hris_client/models/account_token.rb,
lib/merge_hris_client/models/category_enum.rb,
lib/merge_hris_client/models/encoding_enum.rb,
lib/merge_hris_client/models/meta_response.rb,
lib/merge_hris_client/models/run_type_enum.rb,
lib/merge_hris_client/api/account_token_api.rb,
lib/merge_hris_client/api/field_mapping_api.rb,
lib/merge_hris_client/models/debug_mode_log.rb,
lib/merge_hris_client/models/ethnicity_enum.rb,
lib/merge_hris_client/models/run_state_enum.rb,
lib/merge_hris_client/api/delete_account_api.rb,
lib/merge_hris_client/api/regenerate_key_api.rb,
lib/merge_hris_client/api/selective_sync_api.rb,
lib/merge_hris_client/models/account_details.rb,
lib/merge_hris_client/models/audit_log_event.rb,
lib/merge_hris_client/models/categories_enum.rb,
lib/merge_hris_client/models/event_type_enum.rb,
lib/merge_hris_client/models/group_type_enum.rb,
lib/merge_hris_client/models/model_operation.rb,
lib/merge_hris_client/models/operator_schema.rb,
lib/merge_hris_client/models/pay_period_enum.rb,
lib/merge_hris_client/models/remote_response.rb,
lib/merge_hris_client/models/timesheet_entry.rb,
lib/merge_hris_client/api/account_details_api.rb,
lib/merge_hris_client/api/linked_accounts_api.rb,
lib/merge_hris_client/models/condition_schema.rb,
lib/merge_hris_client/models/employee_request.rb,
lib/merge_hris_client/models/employer_benefit.rb,
lib/merge_hris_client/models/flsa_status_enum.rb,
lib/merge_hris_client/models/policy_type_enum.rb,
lib/merge_hris_client/models/remote_field_api.rb,
lib/merge_hris_client/models/time_off_balance.rb,
lib/merge_hris_client/models/time_off_request.rb,
lib/merge_hris_client/models/webhook_receiver.rb,
lib/merge_hris_client/models/account_type_enum.rb,
lib/merge_hris_client/models/advanced_metadata.rb,
lib/merge_hris_client/models/available_actions.rb,
lib/merge_hris_client/models/earning_type_enum.rb,
lib/merge_hris_client/models/employee_response.rb,
lib/merge_hris_client/models/issue_status_enum.rb,
lib/merge_hris_client/models/pay_currency_enum.rb,
lib/merge_hris_client/models/relationship_enum.rb,
lib/merge_hris_client/models/request_type_enum.rb,
lib/merge_hris_client/models/time_off_response.rb,
lib/merge_hris_client/api/async_passthrough_api.rb,
lib/merge_hris_client/api/available_actions_api.rb,
lib/merge_hris_client/api/employer_benefits_api.rb,
lib/merge_hris_client/api/time_off_balances_api.rb,
lib/merge_hris_client/api/timesheet_entries_api.rb,
lib/merge_hris_client/api/webhook_receivers_api.rb,
lib/merge_hris_client/models/location_type_enum.rb,
lib/merge_hris_client/models/pay_frequency_enum.rb,
lib/merge_hris_client/models/response_type_enum.rb,
lib/merge_hris_client/models/account_integration.rb,
lib/merge_hris_client/models/common_model_scopes.rb,
lib/merge_hris_client/models/condition_type_enum.rb,
lib/merge_hris_client/models/ignore_common_model.rb,
lib/merge_hris_client/models/marital_status_enum.rb,
lib/merge_hris_client/models/paginated_team_list.rb,
lib/merge_hris_client/models/remote_data_request.rb,
lib/merge_hris_client/models/request_format_enum.rb,
lib/merge_hris_client/api/common_model_scopes_api.rb,
lib/merge_hris_client/models/employee_payroll_run.rb,
lib/merge_hris_client/models/employment_type_enum.rb,
lib/merge_hris_client/models/enabled_actions_enum.rb,
lib/merge_hris_client/models/paginated_group_list.rb,
lib/merge_hris_client/models/paginated_issue_list.rb,
lib/merge_hris_client/models/remote_endpoint_info.rb,
lib/merge_hris_client/models/time_off_status_enum.rb,
lib/merge_hris_client/models/linked_account_status.rb,
lib/merge_hris_client/api/employee_payroll_runs_api.rb,
lib/merge_hris_client/models/benefit_plan_type_enum.rb,
lib/merge_hris_client/models/common_model_scope_api.rb,
lib/merge_hris_client/models/employment_status_enum.rb,
lib/merge_hris_client/models/paginated_benefit_list.rb,
lib/merge_hris_client/models/paginated_company_list.rb,
lib/merge_hris_client/models/common_model_scope_data.rb,
lib/merge_hris_client/models/debug_model_log_summary.rb,
lib/merge_hris_client/models/paginated_employee_list.rb,
lib/merge_hris_client/models/paginated_location_list.rb,
lib/merge_hris_client/models/paginated_time_off_list.rb,
lib/merge_hris_client/models/sync_status_status_enum.rb,
lib/merge_hris_client/models/timesheet_entry_request.rb,
lib/merge_hris_client/models/data_passthrough_request.rb,
lib/merge_hris_client/models/end_user_details_request.rb,
lib/merge_hris_client/models/error_validation_problem.rb,
lib/merge_hris_client/models/linked_account_condition.rb,
lib/merge_hris_client/models/paginated_bank_info_list.rb,
lib/merge_hris_client/models/paginated_deduction_list.rb,
lib/merge_hris_client/models/paginated_dependent_list.rb,
lib/merge_hris_client/models/paginated_pay_group_list.rb,
lib/merge_hris_client/models/timesheet_entry_response.rb,
lib/merge_hris_client/models/webhook_receiver_request.rb,
lib/merge_hris_client/models/async_passthrough_reciept.rb,
lib/merge_hris_client/models/employee_endpoint_request.rb,
lib/merge_hris_client/models/external_target_field_api.rb,
lib/merge_hris_client/models/paginated_employment_list.rb,
lib/merge_hris_client/models/remote_field_api_response.rb,
lib/merge_hris_client/models/time_off_endpoint_request.rb,
lib/merge_hris_client/models/validation_problem_source.rb,
lib/merge_hris_client/models/field_mapping_api_instance.rb,
lib/merge_hris_client/models/paginated_payroll_run_list.rb,
lib/merge_hris_client/models/paginated_sync_status_list.rb,
lib/merge_hris_client/models/warning_validation_problem.rb,
lib/merge_hris_client/models/account_details_and_actions.rb,
lib/merge_hris_client/models/generate_remote_key_request.rb,
lib/merge_hris_client/models/ignore_common_model_request.rb,
lib/merge_hris_client/models/create_field_mapping_request.rb,
lib/merge_hris_client/models/multipart_form_field_request.rb,
lib/merge_hris_client/models/field_permission_deserializer.rb,
lib/merge_hris_client/models/model_permission_deserializer.rb,
lib/merge_hris_client/models/paginated_audit_log_event_list.rb,
lib/merge_hris_client/models/paginated_timesheet_entry_list.rb,
lib/merge_hris_client/models/field_mapping_instance_response.rb,
lib/merge_hris_client/models/paginated_condition_schema_list.rb,
lib/merge_hris_client/models/paginated_employer_benefit_list.rb,
lib/merge_hris_client/models/paginated_time_off_balance_list.rb,
lib/merge_hris_client/models/common_model_scopes_body_request.rb,
lib/merge_hris_client/models/linked_account_condition_request.rb,
lib/merge_hris_client/models/timesheet_entry_endpoint_request.rb,
lib/merge_hris_client/models/external_target_field_api_response.rb,
lib/merge_hris_client/models/patched_edit_field_mapping_request.rb,
lib/merge_hris_client/models/common_model_scopes_disabled_models.rb,
lib/merge_hris_client/models/field_mapping_api_instance_response.rb,
lib/merge_hris_client/models/paginated_employee_payroll_run_list.rb,
lib/merge_hris_client/models/remote_key_for_regeneration_request.rb,
lib/merge_hris_client/models/common_model_scopes_update_serializer.rb,
lib/merge_hris_client/models/field_permission_deserializer_request.rb,
lib/merge_hris_client/models/model_permission_deserializer_request.rb,
lib/merge_hris_client/models/account_details_and_actions_integration.rb,
lib/merge_hris_client/models/account_details_and_actions_status_enum.rb,
lib/merge_hris_client/models/field_mapping_api_instance_remote_field.rb,
lib/merge_hris_client/models/field_mapping_api_instance_target_field.rb,
lib/merge_hris_client/models/selective_sync_configurations_usage_enum.rb,
lib/merge_hris_client/models/individual_common_model_scope_deserializer.rb,
lib/merge_hris_client/models/paginated_account_details_and_actions_list.rb,
lib/merge_hris_client/models/linked_account_selective_sync_configuration.rb,
lib/merge_hris_client/models/individual_common_model_scope_deserializer_request.rb,
lib/merge_hris_client/models/common_model_scopes_post_inner_deserializer_request.rb,
lib/merge_hris_client/models/linked_account_selective_sync_configuration_request.rb,
lib/merge_hris_client/models/linked_account_common_model_scope_deserializer_request.rb,
lib/merge_hris_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb,
lib/merge_hris_client/models/linked_account_selective_sync_configuration_list_request.rb,
lib/merge_hris_client/models/field_mapping_api_instance_remote_field_remote_endpoint_info.rb

Overview

#Merge HRIS API

#The unified API for building rich integrations with multiple HR Information System platforms.

The version of the OpenAPI document: 1.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 5.1.1

Defined Under Namespace

Classes: AccountDetails, AccountDetailsAndActions, AccountDetailsAndActionsIntegration, AccountDetailsAndActionsStatusEnum, AccountDetailsApi, AccountIntegration, AccountToken, AccountTokenApi, AccountTypeEnum, AdvancedMetadata, ApiClient, ApiError, AsyncPassthroughApi, AsyncPassthroughReciept, AuditLogEvent, AuditTrailApi, AvailableActions, AvailableActionsApi, BankInfo, BankInfoApi, Benefit, BenefitPlanTypeEnum, BenefitsApi, CategoriesEnum, CategoryEnum, CommonModelScopeAPI, CommonModelScopeData, CommonModelScopes, CommonModelScopesApi, CommonModelScopesBodyRequest, CommonModelScopesDisabledModels, CommonModelScopesDisabledModelsEnabledActionsEnum, CommonModelScopesPostInnerDeserializerRequest, CommonModelScopesUpdateSerializer, CompaniesApi, Company, ConditionSchema, ConditionTypeEnum, Configuration, CountryEnum, CreateFieldMappingRequest, DataPassthroughRequest, DebugModeLog, DebugModelLogSummary, Deduction, DeductionsApi, DeleteAccountApi, Dependent, DependentsApi, Earning, EarningTypeEnum, Employee, EmployeeEndpointRequest, EmployeePayrollRun, EmployeePayrollRunsApi, EmployeeRequest, EmployeeResponse, EmployeesApi, EmployerBenefit, EmployerBenefitsApi, Employment, EmploymentStatusEnum, EmploymentTypeEnum, EmploymentsApi, EnabledActionsEnum, EncodingEnum, EndUserDetailsRequest, ErrorValidationProblem, EthnicityEnum, EventTypeEnum, ExternalTargetFieldAPI, ExternalTargetFieldAPIResponse, FieldMappingApi, FieldMappingApiInstance, FieldMappingApiInstanceRemoteField, FieldMappingApiInstanceRemoteFieldRemoteEndpointInfo, FieldMappingApiInstanceResponse, FieldMappingApiInstanceTargetField, FieldMappingInstanceResponse, FieldPermissionDeserializer, FieldPermissionDeserializerRequest, FlsaStatusEnum, ForceResyncApi, GenderEnum, GenerateKeyApi, GenerateRemoteKeyRequest, Group, GroupTypeEnum, GroupsApi, IgnoreCommonModel, IgnoreCommonModelRequest, IndividualCommonModelScopeDeserializer, IndividualCommonModelScopeDeserializerRequest, Issue, IssueStatusEnum, IssuesApi, LinkToken, LinkTokenApi, LinkedAccountCommonModelScopeDeserializerRequest, LinkedAccountCondition, LinkedAccountConditionRequest, LinkedAccountSelectiveSyncConfiguration, LinkedAccountSelectiveSyncConfigurationListRequest, LinkedAccountSelectiveSyncConfigurationRequest, LinkedAccountStatus, LinkedAccountsApi, Location, LocationTypeEnum, LocationsApi, MaritalStatusEnum, MetaResponse, MethodEnum, ModelOperation, ModelPermissionDeserializer, ModelPermissionDeserializerRequest, MultipartFormFieldRequest, OperatorSchema, PaginatedAccountDetailsAndActionsList, PaginatedAuditLogEventList, PaginatedBankInfoList, PaginatedBenefitList, PaginatedCompanyList, PaginatedConditionSchemaList, PaginatedDeductionList, PaginatedDependentList, PaginatedEmployeeList, PaginatedEmployeePayrollRunList, PaginatedEmployerBenefitList, PaginatedEmploymentList, PaginatedGroupList, PaginatedIssueList, PaginatedLocationList, PaginatedPayGroupList, PaginatedPayrollRunList, PaginatedSyncStatusList, PaginatedTeamList, PaginatedTimeOffBalanceList, PaginatedTimeOffList, PaginatedTimesheetEntryList, PassthroughApi, PatchedEditFieldMappingRequest, PayCurrencyEnum, PayFrequencyEnum, PayGroup, PayGroupsApi, PayPeriodEnum, PayrollRun, PayrollRunsApi, PolicyTypeEnum, ReasonEnum, RegenerateKeyApi, RelationshipEnum, RemoteData, RemoteDataRequest, RemoteEndpointInfo, RemoteFieldAPI, RemoteFieldAPIResponse, RemoteKey, RemoteKeyForRegenerationRequest, RemoteResponse, RequestFormatEnum, RequestTypeEnum, ResponseTypeEnum, RoleEnum, RunStateEnum, RunTypeEnum, ScopesApi, SelectiveSyncApi, SelectiveSyncConfigurationsUsageEnum, SyncStatus, SyncStatusApi, SyncStatusStatusEnum, Tax, Team, TeamsApi, TimeOff, TimeOffApi, TimeOffBalance, TimeOffBalancesApi, TimeOffEndpointRequest, TimeOffRequest, TimeOffResponse, TimeOffStatusEnum, TimesheetEntriesApi, TimesheetEntry, TimesheetEntryEndpointRequest, TimesheetEntryRequest, TimesheetEntryResponse, UnitsEnum, ValidationProblemSource, WarningValidationProblem, WebhookReceiver, WebhookReceiverRequest, WebhookReceiversApi

Constant Summary collapse

VERSION =

'3.2.2'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

MergeHRISClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/merge_hris_client.rb', line 201

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end