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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/company_benefit.rb

Overview

See Also:

Defined Under Namespace

Classes: CompanyContribution

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_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Constructor Details

#initialize(benefit_id: , company_contribution: , description: , frequency: , type: ) ⇒ Object

Parameters:

  • benefit_id (String) (defaults to: ) —

    The id of the benefit.

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

    The company match for this benefit.

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

    The frequency of the benefit deduction/contribution.

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

    Type of benefit.




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

Instance Attribute Details

#benefit_id ⇒ String

The id of the benefit.

Returns:

  • (String) 


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

required :benefit_id, String

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

The company match for this benefit.

Returns:

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


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

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

#description ⇒ String?

Returns:

  • (String, nil) 


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

required :description, String, nil?: true

#frequency ⇒ Symbol, ...

The frequency of the benefit deduction/contribution.

Returns:



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

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

#type ⇒ Symbol, ...

Type of benefit.

Returns:



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

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