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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::Payroll::PayGroupListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/finch_api/models/payroll/pay_group_list_params.rb

Overview

See Also:

• Resources::Payroll::PayGroups#list

Instance Attribute Summary

• #entity_ids ⇒ Array<String>^?

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

• #individual_id ⇒ String^?
• #pay_frequencies ⇒ Array<String>^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

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

Parameters:

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

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

• 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 27

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/payroll/pay_group_list_params.rb', line 15

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

#individual_id ⇒ String^?

Returns:

• (String, nil)

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

optional :individual_id, String

#pay_frequencies ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

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

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