Class: FinchAPI::Models::Payroll::PayGroupRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/payroll/pay_group_retrieve_response.rb,
sig/finch_api/models/payroll/pay_group_retrieve_response.rbs

Overview

See Also:

  • FinchAPI::Resources::Payroll::PayGroups#retrieve

Defined Under Namespace

Modules: PayFrequency

Instance Attribute Summary collapse

Instance Method Summary collapse

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

#initializeObject



21
# File 'sig/finch_api/models/payroll/pay_group_retrieve_response.rbs', line 21

def initialize: (

Instance Attribute Details

#idString

Finch id (uuidv4) for the pay group

Parameters:

  • value (String)

Returns:

  • (String)


12
# File 'lib/finch_api/models/payroll/pay_group_retrieve_response.rb', line 12

required :id, String

#individual_idsArray<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>)


17
# File 'lib/finch_api/models/payroll/pay_group_retrieve_response.rb', line 17

required :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]

#nameString

Name of the pay group

Parameters:

  • value (String)

Returns:

  • (String)


23
# File 'lib/finch_api/models/payroll/pay_group_retrieve_response.rb', line 23

required :name, String

#pay_frequenciesArray<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>

List of pay frequencies associated with this pay group

Parameters:

  • value (::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency])

Returns:



29
30
# File 'lib/finch_api/models/payroll/pay_group_retrieve_response.rb', line 29

required :pay_frequencies,
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency] }

Instance Method Details

#to_hash{

Returns:

  • ({)


28
# File 'sig/finch_api/models/payroll/pay_group_retrieve_response.rbs', line 28

def to_hash: -> {