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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::CompanyBenefit

Defined in:

lib/finch_api/models/hris/company_benefit.rb,
sig/finch_api/models/hris/company_benefit.rbs

Overview

See Also:

• FinchAPI::Resources::HRIS::Benefits#retrieve

Defined Under Namespace

Classes: CompanyContribution

Instance Attribute Summary

• #benefit_id ⇒ String

  The id of the benefit.

• #company_contribution ⇒ FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution^?

  The company match for this benefit.

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

  The frequency of the benefit deduction/contribution.

• #type ⇒ Symbol, ...

  Type of benefit.

Instance Method Summary

• #initialize(benefit_id:, description:, frequency:, type:, company_contribution: nil) ⇒ Object constructor
• #to_hash ⇒ {

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(benefit_id:, description:, frequency:, type:, company_contribution: nil) ⇒ Object

Parameters:

• benefit_id (String) —

  The id of the benefit.

• description (String, nil)
• frequency (Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil) —

  The frequency of the benefit deduction/contribution.

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

  Type of benefit.

• company_contribution (FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil) (defaults to: nil) —

  The company match for this benefit.

# File 'lib/finch_api/models/hris/company_benefit.rb', line 37

Instance Attribute Details

#benefit_id ⇒ String

The id of the benefit.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/finch_api/models/hris/company_benefit.rb', line 12

required :benefit_id, String

#company_contribution ⇒ FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution^?

The company match for this benefit.

Parameters:

• value (FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil)

Returns:

• (FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil)

# File 'lib/finch_api/models/hris/company_benefit.rb', line 35

optional :company_contribution, -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution }, nil?: true

#description ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/finch_api/models/hris/company_benefit.rb', line 17

required :description, String, nil?: true

#frequency ⇒ Symbol, ...

The frequency of the benefit deduction/contribution.

Parameters:

• value (FinchAPI::Models::HRIS::benefit_frequency, nil)

Returns:

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

# File 'lib/finch_api/models/hris/company_benefit.rb', line 23

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

#type ⇒ Symbol, ...

Type of benefit.

Parameters:

• value (FinchAPI::Models::HRIS::benefit_type, nil)

Returns:

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

# File 'lib/finch_api/models/hris/company_benefit.rb', line 29

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/finch_api/models/hris/company_benefit.rbs', line 32

def to_hash: -> {