Class: FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb

Overview

See Also:

• Resources::HRIS::Benefits::Individuals#retrieve_many_benefits

Instance Attribute Summary

• #entity_ids ⇒ Array<String>^?

  The entity IDs to specify which entities’ data to access.

• #individual_ids ⇒ String^?

  comma-delimited list of stable Finch uuids for each individual.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(entity_ids: nil, individual_ids: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see IndividualRetrieveManyBenefitsParams for more details.

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(entity_ids: nil, individual_ids: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams for more details.

Parameters:

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

  The entity IDs to specify which entities’ data to access.

• individual_ids (String) (defaults to: nil) —

  comma-delimited list of stable Finch uuids for each individual. If empty, defaul

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

# File 'lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb', line 25

Instance Attribute Details

#entity_ids ⇒ Array<String>^?

The entity IDs to specify which entities’ data to access.

Returns:

• (Array<String>, nil)

# File 'lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb', line 16

optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

#individual_ids ⇒ String^?

comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

Returns:

• (String, nil)

# File 'lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb', line 23

optional :individual_ids, String