Class: FinchAPI::Models::HRIS::CompanyBenefit

Inherits:

BaseModel

• Object
• FinchAPI::Models::HRIS::CompanyBenefit

Defined in:

lib/finch-api/models/hris/company_benefit.rb

Instance Attribute Summary

• #benefit_id ⇒ String
• #description ⇒ String^?
• #frequency ⇒ Symbol, ...
• #type ⇒ Symbol, ...

  Type of benefit.

Instance Method Summary

• #initialize(benefit_id:, description:, frequency:, type:) ⇒ CompanyBenefit constructor

  A new instance of CompanyBenefit.

Constructor Details

#initialize(benefit_id:, description:, frequency:, type:) ⇒ CompanyBenefit

Returns a new instance of CompanyBenefit.

Parameters:

• benefit_id (String)
• description (String, nil)
• frequency (Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil)
• type (Symbol, FinchAPI::Models::HRIS::BenefitType, nil)

# File 'lib/finch-api/models/hris/company_benefit.rb', line 6

def initialize(benefit_id:, description:, frequency:, type:, **) = super

Instance Attribute Details

#benefit_id ⇒ String

Returns:

• (String)

# File 'lib/finch-api/models/hris/company_benefit.rb', line 10

required :benefit_id, String

#description ⇒ String^?

Returns:

• (String, nil)

# File 'lib/finch-api/models/hris/company_benefit.rb', line 15

required :description, String, nil?: true

#frequency ⇒ Symbol, ...

Returns:

• (Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil)

# File 'lib/finch-api/models/hris/company_benefit.rb', line 20

required :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true

#type ⇒ Symbol, ...

Type of benefit.

Returns:

• (Symbol, FinchAPI::Models::HRIS::BenefitType, nil)

# File 'lib/finch-api/models/hris/company_benefit.rb', line 26

required :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true