Class: VitableConnect::Models::EmployerListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/vitable_connect/models/employer_list_params.rb,
sig/vitable_connect/models/employer_list_params.rbs

Overview

See Also:

  • VitableConnect::Resources::Employers#list

Defined Under Namespace

Modules: BenefitFamily, BenefitLifecycleStage, HRISStatus

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(benefit_family: nil, benefit_lifecycle_stage: nil, hris_provider: nil, hris_status: nil, include_cancelled: nil, limit: nil, page: nil, search: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::EmployerListParams for more details.

Parameters:

  • benefit_family (Array<Symbol, VitableConnect::Models::EmployerListParams::BenefitFamily>) (defaults to: nil) —

    Filter to employers with at least one active benefit in these families.

  • benefit_lifecycle_stage (Array<Symbol, VitableConnect::Models::EmployerListParams::BenefitLifecycleStage>) (defaults to: nil) —

    Filter to employers in one of these computed benefit-lifecycle stages.

  • hris_provider (Array<String>) (defaults to: nil) —

    Filter to employers whose HRIS connection is with one of these payroll providers

  • hris_status (Array<Symbol, VitableConnect::Models::EmployerListParams::HRISStatus>) (defaults to: nil) —

    Filter to employers whose HRIS connection is in one of these statuses.

  • include_cancelled (Boolean) (defaults to: nil) —

    Include cancelled employers (hidden by default unless their stage is explicitly

  • limit (Integer) (defaults to: nil) —

    Items per page.

  • page (Integer) (defaults to: nil) —

    Page number.

  • search (String, nil) (defaults to: nil) —

    Case-insensitive employer-name substring filter.

  • request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/vitable_connect/models/employer_list_params.rb', line 64

Instance Attribute Details

#benefit_family ⇒ Array<Symbol, VitableConnect::Models::EmployerListParams::BenefitFamily>?

Filter to employers with at least one active benefit in these families.

Returns:



14
15
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 14

optional :benefit_family,
-> { VitableConnect::Internal::Type::ArrayOf[enum: VitableConnect::EmployerListParams::BenefitFamily] }

#benefit_lifecycle_stage ⇒ Array<Symbol, VitableConnect::Models::EmployerListParams::BenefitLifecycleStage>?

Filter to employers in one of these computed benefit-lifecycle stages.

Returns:



21
22
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 21

optional :benefit_lifecycle_stage,
-> { VitableConnect::Internal::Type::ArrayOf[enum: VitableConnect::EmployerListParams::BenefitLifecycleStage] }

#hris_provider ⇒ Array<String>?

Filter to employers whose HRIS connection is with one of these payroll providers (e.g. ADP RUN). Matched case-insensitively; free text, so read the available values from the HRIS-providers endpoint rather than assuming a fixed set.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


30
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 30

optional :hris_provider, VitableConnect::Internal::Type::ArrayOf[String]

#hris_status ⇒ Array<Symbol, VitableConnect::Models::EmployerListParams::HRISStatus>?

Filter to employers whose HRIS connection is in one of these statuses.

Returns:



36
37
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 36

optional :hris_status,
-> { VitableConnect::Internal::Type::ArrayOf[enum: VitableConnect::EmployerListParams::HRISStatus] }

#include_cancelled ⇒ Boolean?

Include cancelled employers (hidden by default unless their stage is explicitly requested).

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


44
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 44

optional :include_cancelled, VitableConnect::Internal::Type::Boolean

#limit ⇒ Integer?

Items per page.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


50
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 50

optional :limit, Integer

#page ⇒ Integer?

Page number.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


56
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 56

optional :page, Integer

#search ⇒ String?

Case-insensitive employer-name substring filter.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


62
 
# File 'lib/vitable_connect/models/employer_list_params.rb', line 62

optional :search, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/employer_list_params.rb', line 102

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/vitable_connect/models/employer_list_params.rbs', line 68

def to_hash: -> {