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

Inherits:

BaseModel

• Object
• FinchAPI::Models::Payroll::PayGroupRetrieveResponse

Defined in:

lib/finch-api/models/payroll/pay_group_retrieve_response.rb

Defined Under Namespace

Modules: PayFrequency

Instance Attribute Summary

• #id ⇒ String

  Finch id (uuidv4) for the pay group.

• #individual_ids ⇒ Array<String>
• #name ⇒ String

  Name of the pay group.

• #pay_frequencies ⇒ Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>

  List of pay frequencies associated with this pay group.

Instance Method Summary

• #initialize(id:, individual_ids:, name:, pay_frequencies:) ⇒ PayGroupRetrieveResponse constructor

  A new instance of PayGroupRetrieveResponse.

Constructor Details

#initialize(id:, individual_ids:, name:, pay_frequencies:) ⇒ PayGroupRetrieveResponse

Returns a new instance of PayGroupRetrieveResponse.

Parameters:

• id (String)
• individual_ids (Array<String>)
• name (String)
• pay_frequencies (Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>)

# File 'lib/finch-api/models/payroll/pay_group_retrieve_response.rb', line 6

def initialize(id:, individual_ids:, name:, pay_frequencies:, **) = super

Instance Attribute Details

#id ⇒ String

Finch id (uuidv4) for the pay group

Returns:

• (String)

# File 'lib/finch-api/models/payroll/pay_group_retrieve_response.rb', line 11

required :id, String

#individual_ids ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/finch-api/models/payroll/pay_group_retrieve_response.rb', line 16

required :individual_ids, FinchAPI::ArrayOf[String]

#name ⇒ String

Name of the pay group

Returns:

• (String)

# File 'lib/finch-api/models/payroll/pay_group_retrieve_response.rb', line 22

required :name, String

#pay_frequencies ⇒ Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>

List of pay frequencies associated with this pay group

Returns:

• (Array<Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency>)

# File 'lib/finch-api/models/payroll/pay_group_retrieve_response.rb', line 28

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