Class: FinchAPI::Models::Payroll::PayGroupListParams

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

Overview

See Also:

  • FinchAPI::Resources::Payroll::PayGroups#list

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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

Some parameter documentations has been truncated, see FinchAPI::Models::Payroll::PayGroupListParams for more details.

Parameters:

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

    The entity IDs to specify which entities' data to access. Provide exactly one en

  • individual_id (String) (defaults to: nil)
  • pay_frequencies (Array<String>) (defaults to: nil)
  • request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/finch_api/models/payroll/pay_group_list_params.rb', line 28

Instance Attribute Details

#entity_ids ⇒ Array<String>?

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


16
 
# File 'lib/finch_api/models/payroll/pay_group_list_params.rb', line 16

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

#individual_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


21
 
# File 'lib/finch_api/models/payroll/pay_group_list_params.rb', line 21

optional :individual_id, String

#pay_frequencies ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


26
 
# File 'lib/finch_api/models/payroll/pay_group_list_params.rb', line 26

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/finch_api/models/payroll/pay_group_list_params.rbs', line 35

def to_hash: -> {