Class: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution

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

Defined Under Namespace

Modules: Type Classes: Tier

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(match: nil, threshold: nil) ⇒ Object

Parameters:

  • match (Integer) (defaults to: nil)
  • threshold (Integer) (defaults to: nil) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 53

class CompanyContribution < FinchAPI::Internal::Type::BaseModel
  # @!attribute tiers
  #
  #   @return [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil]
  optional :tiers,
           -> {
             FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]
           }

  # @!attribute type
  #
  #   @return [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type, nil]
  optional :type, enum: -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type }

  # @!method initialize(tiers: nil, type: nil)
  #   The company match for this benefit.
  #
  #   @param tiers [Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>]
  #   @param type [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type]

  class Tier < FinchAPI::Internal::Type::BaseModel
    # @!attribute match
    #
    #   @return [Integer, nil]
    optional :match, Integer

    # @!attribute threshold
    #
    #   @return [Integer, nil]
    optional :threshold, Integer

    # @!method initialize(match: nil, threshold: nil)
    #   @param match [Integer]
    #   @param threshold [Integer]
  end

  # @see FinchAPI::HRIS::BenefitCreateParams::CompanyContribution#type
  module Type
    extend FinchAPI::Internal::Type::Enum

    MATCH = :match

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#tiers ⇒ Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>?

Returns:

  • (Array<FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier>, nil) 


57
58
59
60
 
# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 57

optional :tiers,
-> {
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]
}

#type ⇒ Symbol, ...

Returns:

  • (Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type, nil) 


65
 
# File 'lib/finch_api/models/hris/benefit_create_params.rb', line 65

optional :type, enum: -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type }