Class: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options

Defined in:

lib/finch_api/models/hris/individual_retrieve_many_params.rb,
sig/finch_api/models/hris/individual_retrieve_many_params.rbs

Instance Attribute Summary

• #include ⇒ Array<String>^?

Instance Method Summary

• #initialize(entity_ids: nil, options: nil, requests: nil, request_options: {}) ⇒ Options constructor

  A new instance of Options.

• #to_hash ⇒ { include: ::Array[String] }

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, options: nil, requests: nil, request_options: {}) ⇒ Options

Returns a new instance of Options.

Parameters:

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

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

• options (FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil) (defaults to: nil)
• requests (Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>) (defaults to: nil)
• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})
• include: (::Array[String])

# File 'lib/finch_api/models/hris/individual_retrieve_many_params.rb', line 37

class Options < FinchAPI::Internal::Type::BaseModel
  # @!attribute include
  #
  #   @return [Array<String>, nil]
  optional :include, FinchAPI::Internal::Type::ArrayOf[String]

  # @!method initialize(include: nil)
  #   @param include [Array<String>]
end

Instance Attribute Details

#include ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/finch_api/models/hris/individual_retrieve_many_params.rb', line 41

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

Instance Method Details

#to_hash ⇒ { include: ::Array[String] }

Returns:

• ({ include: ::Array[String] })

# File 'sig/finch_api/models/hris/individual_retrieve_many_params.rbs', line 51

def to_hash: -> { include: ::Array[String] }