|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module FinchAPI |
| 4 | + module Models |
| 5 | + module HRIS |
| 6 | + # @see FinchAPI::Resources::HRIS::Benefits#list_supported_benefits |
| 7 | + class BenefitListSupportedBenefitsResponse < FinchAPI::Internal::Type::BaseModel |
| 8 | + # @!attribute annual_maximum |
| 9 | + # Whether the provider supports an annual maximum for this benefit. |
| 10 | + # |
| 11 | + # @return [Boolean, nil] |
| 12 | + optional :annual_maximum, FinchAPI::Internal::Type::Boolean, nil?: true |
| 13 | + |
| 14 | + # @!attribute catch_up |
| 15 | + # Whether the provider supports catch up for this benefit. This field will only be |
| 16 | + # true for retirement benefits. |
| 17 | + # |
| 18 | + # @return [Boolean, nil] |
| 19 | + optional :catch_up, FinchAPI::Internal::Type::Boolean, nil?: true |
| 20 | + |
| 21 | + # @!attribute company_contribution |
| 22 | + # Supported contribution types. An empty array indicates contributions are not |
| 23 | + # supported. |
| 24 | + # |
| 25 | + # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution, nil>, nil] |
| 26 | + optional :company_contribution, |
| 27 | + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution, nil?: true] }, |
| 28 | + nil?: true |
| 29 | + |
| 30 | + # @!attribute description |
| 31 | + # |
| 32 | + # @return [String, nil] |
| 33 | + optional :description, String, nil?: true |
| 34 | + |
| 35 | + # @!attribute employee_deduction |
| 36 | + # Supported deduction types. An empty array indicates deductions are not |
| 37 | + # supported. |
| 38 | + # |
| 39 | + # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction, nil>, nil] |
| 40 | + optional :employee_deduction, |
| 41 | + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction, nil?: true] }, |
| 42 | + nil?: true |
| 43 | + |
| 44 | + # @!attribute [r] frequencies |
| 45 | + # The list of frequencies supported by the provider for this benefit |
| 46 | + # |
| 47 | + # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>, nil] |
| 48 | + optional :frequencies, |
| 49 | + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true] } |
| 50 | + |
| 51 | + # @!parse |
| 52 | + # # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>] |
| 53 | + # attr_writer :frequencies |
| 54 | + |
| 55 | + # @!attribute hsa_contribution_limit |
| 56 | + # Whether the provider supports HSA contribution limits. Empty if this feature is |
| 57 | + # not supported for the benefit. This array only has values for HSA benefits. |
| 58 | + # |
| 59 | + # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit, nil>, nil] |
| 60 | + optional :hsa_contribution_limit, |
| 61 | + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit, nil?: true] }, |
| 62 | + nil?: true |
| 63 | + |
| 64 | + # @!parse |
| 65 | + # # @param annual_maximum [Boolean, nil] |
| 66 | + # # @param catch_up [Boolean, nil] |
| 67 | + # # @param company_contribution [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution, nil>, nil] |
| 68 | + # # @param description [String, nil] |
| 69 | + # # @param employee_deduction [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction, nil>, nil] |
| 70 | + # # @param frequencies [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>] |
| 71 | + # # @param hsa_contribution_limit [Array<Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit, nil>, nil] |
| 72 | + # # |
| 73 | + # def initialize( |
| 74 | + # annual_maximum: nil, |
| 75 | + # catch_up: nil, |
| 76 | + # company_contribution: nil, |
| 77 | + # description: nil, |
| 78 | + # employee_deduction: nil, |
| 79 | + # frequencies: nil, |
| 80 | + # hsa_contribution_limit: nil, |
| 81 | + # ** |
| 82 | + # ) |
| 83 | + # super |
| 84 | + # end |
| 85 | + |
| 86 | + # def initialize: (Hash | FinchAPI::Internal::Type::BaseModel) -> void |
| 87 | + |
| 88 | + module CompanyContribution |
| 89 | + extend FinchAPI::Internal::Type::Enum |
| 90 | + |
| 91 | + FIXED = :fixed |
| 92 | + PERCENT = :percent |
| 93 | + |
| 94 | + finalize! |
| 95 | + |
| 96 | + # @!parse |
| 97 | + # # @return [Array<Symbol>] |
| 98 | + # def self.values; end |
| 99 | + end |
| 100 | + |
| 101 | + module EmployeeDeduction |
| 102 | + extend FinchAPI::Internal::Type::Enum |
| 103 | + |
| 104 | + FIXED = :fixed |
| 105 | + PERCENT = :percent |
| 106 | + |
| 107 | + finalize! |
| 108 | + |
| 109 | + # @!parse |
| 110 | + # # @return [Array<Symbol>] |
| 111 | + # def self.values; end |
| 112 | + end |
| 113 | + |
| 114 | + module HsaContributionLimit |
| 115 | + extend FinchAPI::Internal::Type::Enum |
| 116 | + |
| 117 | + INDIVIDUAL = :individual |
| 118 | + FAMILY = :family |
| 119 | + |
| 120 | + finalize! |
| 121 | + |
| 122 | + # @!parse |
| 123 | + # # @return [Array<Symbol>] |
| 124 | + # def self.values; end |
| 125 | + end |
| 126 | + end |
| 127 | + end |
| 128 | + end |
| 129 | +end |
0 commit comments