finch-api 0.1.0.pre.alpha.4 → 0.1.0.pre.alpha.13

data/lib/finch-api/models/hris/benefit_contribution.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitContribution < FinchAPI::BaseModel
-        # @!attribute amount
-        #   Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-        #
-        #   @return [Integer, nil]
-        optional :amount, Integer, nil?: true
-
-        # @!attribute type
-        #   Contribution type.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil]
-        optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitContribution::Type }, nil?: true
-
-        # @!parse
-        #   # @param amount [Integer, nil]
-        #   # @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil]
-        #   #
-        #   def initialize(amount: nil, type: nil, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        # Contribution type.
-        module Type
-          extend FinchAPI::Enum
-
-          FIXED = :fixed
-          PERCENT = :percent
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_create_params.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitCreateParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute [r] description
-        #   Name of the benefit as it appears in the provider and pay statements. Recommend
-        #     limiting this to <30 characters due to limitations in specific providers (e.g.
-        #     Justworks).
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :description
-
-        # @!attribute frequency
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
-        optional :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true
-
-        # @!attribute type
-        #   Type of benefit.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
-        optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
-
-        # @!parse
-        #   # @param description [String]
-        #   # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
-        #   # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(description: nil, frequency: nil, type: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_features_and_operations.rb

@@ -1,169 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitFeaturesAndOperations < FinchAPI::BaseModel
-        # @!attribute [r] supported_features
-        #
-        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, nil]
-        optional :supported_features,
-                 -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures }
-
-        # @!parse
-        #   # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures]
-        #   attr_writer :supported_features
-
-        # @!attribute [r] supported_operations
-        #
-        #   @return [FinchAPI::Models::HRIS::SupportPerBenefitType, nil]
-        optional :supported_operations, -> { FinchAPI::Models::HRIS::SupportPerBenefitType }
-
-        # @!parse
-        #   # @return [FinchAPI::Models::HRIS::SupportPerBenefitType]
-        #   attr_writer :supported_operations
-
-        # @!parse
-        #   # @param supported_features [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures]
-        #   # @param supported_operations [FinchAPI::Models::HRIS::SupportPerBenefitType]
-        #   #
-        #   def initialize(supported_features: nil, supported_operations: nil, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class SupportedFeatures < FinchAPI::BaseModel
-          # @!attribute annual_maximum
-          #   Whether the provider supports an annual maximum for this benefit.
-          #
-          #   @return [Boolean, nil]
-          optional :annual_maximum, FinchAPI::BooleanModel, nil?: true
-
-          # @!attribute catch_up
-          #   Whether the provider supports catch up for this benefit. This field will only be
-          #     true for retirement benefits.
-          #
-          #   @return [Boolean, nil]
-          optional :catch_up, FinchAPI::BooleanModel, nil?: true
-
-          # @!attribute company_contribution
-          #   Supported contribution types. An empty array indicates contributions are not
-          #     supported.
-          #
-          #   @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil]
-          optional :company_contribution,
-                   -> do
-                     FinchAPI::ArrayOf[
-                     enum: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil?: true
-                     ]
-                   end,
-                   nil?: true
-
-          # @!attribute description
-          #
-          #   @return [String, nil]
-          optional :description, String, nil?: true
-
-          # @!attribute employee_deduction
-          #   Supported deduction types. An empty array indicates deductions are not
-          #     supported.
-          #
-          #   @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil]
-          optional :employee_deduction,
-                   -> do
-                     FinchAPI::ArrayOf[
-                     enum: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil?: true
-                     ]
-                   end,
-                   nil?: true
-
-          # @!attribute [r] frequencies
-          #   The list of frequencies supported by the provider for this benefit
-          #
-          #   @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>, nil]
-          optional :frequencies,
-                   -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true] }
-
-          # @!parse
-          #   # @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>]
-          #   attr_writer :frequencies
-
-          # @!attribute hsa_contribution_limit
-          #   Whether the provider supports HSA contribution limits. Empty if this feature is
-          #     not supported for the benefit. This array only has values for HSA benefits.
-          #
-          #   @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil]
-          optional :hsa_contribution_limit,
-                   -> do
-                     FinchAPI::ArrayOf[
-                     enum: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil?: true
-                     ]
-                   end,
-                   nil?: true
-
-          # @!parse
-          #   # @param annual_maximum [Boolean, nil]
-          #   # @param catch_up [Boolean, nil]
-          #   # @param company_contribution [Array<Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, nil>, nil]
-          #   # @param description [String, nil]
-          #   # @param employee_deduction [Array<Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil>, nil]
-          #   # @param frequencies [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>]
-          #   # @param hsa_contribution_limit [Array<Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, nil>, nil]
-          #   #
-          #   def initialize(
-          #     annual_maximum: nil,
-          #     catch_up: nil,
-          #     company_contribution: nil,
-          #     description: nil,
-          #     employee_deduction: nil,
-          #     frequencies: nil,
-          #     hsa_contribution_limit: nil,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          module CompanyContribution
-            extend FinchAPI::Enum
-
-            FIXED = :fixed
-            PERCENT = :percent
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-
-          module EmployeeDeduction
-            extend FinchAPI::Enum
-
-            FIXED = :fixed
-            PERCENT = :percent
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-
-          module HsaContributionLimit
-            extend FinchAPI::Enum
-
-            INDIVIDUAL = :individual
-            FAMILY = :family
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_frequency.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module BenefitFrequency
-        extend FinchAPI::Enum
-
-        ONE_TIME = :one_time
-        EVERY_PAYCHECK = :every_paycheck
-        MONTHLY = :monthly
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_list_params.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitListParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!parse
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitListSupportedBenefitsParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!parse
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_retrieve_params.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitRetrieveParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!parse
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_type.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      # Type of benefit.
-      module BenefitType
-        extend FinchAPI::Enum
-
-        NUMBER_401K = :"401k"
-        NUMBER_401K_ROTH = :"401k_roth"
-        NUMBER_401K_LOAN = :"401k_loan"
-        NUMBER_403B = :"403b"
-        NUMBER_403B_ROTH = :"403b_roth"
-        NUMBER_457 = :"457"
-        NUMBER_457_ROTH = :"457_roth"
-        S125_MEDICAL = :s125_medical
-        S125_DENTAL = :s125_dental
-        S125_VISION = :s125_vision
-        HSA_PRE = :hsa_pre
-        HSA_POST = :hsa_post
-        FSA_MEDICAL = :fsa_medical
-        FSA_DEPENDENT_CARE = :fsa_dependent_care
-        SIMPLE_IRA = :simple_ira
-        SIMPLE = :simple
-        COMMUTER = :commuter
-        CUSTOM_POST_TAX = :custom_post_tax
-        CUSTOM_PRE_TAX = :custom_pre_tax
-
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefit_update_params.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class BenefitUpdateParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute [r] description
-        #   Updated name or description.
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :description
-
-        # @!parse
-        #   # @param description [String]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(description: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/enrolled_individual.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class EnrolledIndividual < FinchAPI::BaseModel
-          # @!attribute [r] body
-          #
-          #   @return [FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, nil]
-          optional :body, -> { FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body }
-
-          # @!parse
-          #   # @return [FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body]
-          #   attr_writer :body
-
-          # @!attribute [r] code
-          #   HTTP status code. Either 201 or 200
-          #
-          #   @return [Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code, nil]
-          optional :code, enum: -> { FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code }
-
-          # @!parse
-          #   # @return [Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code]
-          #   attr_writer :code
-
-          # @!attribute [r] individual_id
-          #
-          #   @return [String, nil]
-          optional :individual_id, String
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :individual_id
-
-          # @!parse
-          #   # @param body [FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body]
-          #   # @param code [Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code]
-          #   # @param individual_id [String]
-          #   #
-          #   def initialize(body: nil, code: nil, individual_id: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Body < FinchAPI::BaseModel
-            # @!attribute finch_code
-            #   A descriptive identifier for the response
-            #
-            #   @return [String, nil]
-            optional :finch_code, String, nil?: true
-
-            # @!attribute message
-            #   Short description in English that provides more information about the response.
-            #
-            #   @return [String, nil]
-            optional :message, String, nil?: true
-
-            # @!attribute name
-            #   Identifier indicating whether the benefit was newly enrolled or updated.
-            #
-            #   @return [String, nil]
-            optional :name, String, nil?: true
-
-            # @!parse
-            #   # @param finch_code [String, nil]
-            #   # @param message [String, nil]
-            #   # @param name [String, nil]
-            #   #
-            #   def initialize(finch_code: nil, message: nil, name: nil, **) = super
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-          end
-
-          # HTTP status code. Either 201 or 200
-          module Code
-            extend FinchAPI::Enum
-
-            OK = 200
-            CREATED = 201
-            NOT_FOUND = 404
-            FORBIDDEN = 403
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Integer>]
-            #   def self.values; end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/benefits/individual_benefit.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualBenefit < FinchAPI::BaseModel
-          # @!attribute [r] body
-          #
-          #   @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, nil]
-          optional :body, -> { FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body }
-
-          # @!parse
-          #   # @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body]
-          #   attr_writer :body
-
-          # @!attribute [r] code
-          #
-          #   @return [Integer, nil]
-          optional :code, Integer
-
-          # @!parse
-          #   # @return [Integer]
-          #   attr_writer :code
-
-          # @!attribute [r] individual_id
-          #
-          #   @return [String, nil]
-          optional :individual_id, String
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :individual_id
-
-          # @!parse
-          #   # @param body [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body]
-          #   # @param code [Integer]
-          #   # @param individual_id [String]
-          #   #
-          #   def initialize(body: nil, code: nil, individual_id: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Body < FinchAPI::BaseModel
-            # @!attribute annual_maximum
-            #   If the benefit supports annual maximum, the amount in cents for this individual.
-            #
-            #   @return [Integer, nil]
-            optional :annual_maximum, Integer, nil?: true
-
-            # @!attribute catch_up
-            #   If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
-            #     for this individual.
-            #
-            #   @return [Boolean, nil]
-            optional :catch_up, FinchAPI::BooleanModel, nil?: true
-
-            # @!attribute company_contribution
-            #
-            #   @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
-            optional :company_contribution, -> { FinchAPI::Models::HRIS::BenefitContribution }, nil?: true
-
-            # @!attribute employee_deduction
-            #
-            #   @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
-            optional :employee_deduction, -> { FinchAPI::Models::HRIS::BenefitContribution }, nil?: true
-
-            # @!attribute hsa_contribution_limit
-            #   Type for HSA contribution limit if the benefit is a HSA.
-            #
-            #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
-            optional :hsa_contribution_limit,
-                     enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit },
-                     nil?: true
-
-            # @!parse
-            #   # @param annual_maximum [Integer, nil]
-            #   # @param catch_up [Boolean, nil]
-            #   # @param company_contribution [FinchAPI::Models::HRIS::BenefitContribution, nil]
-            #   # @param employee_deduction [FinchAPI::Models::HRIS::BenefitContribution, nil]
-            #   # @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil]
-            #   #
-            #   def initialize(
-            #     annual_maximum: nil,
-            #     catch_up: nil,
-            #     company_contribution: nil,
-            #     employee_deduction: nil,
-            #     hsa_contribution_limit: nil,
-            #     **
-            #   )
-            #     super
-            #   end
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-            # Type for HSA contribution limit if the benefit is a HSA.
-            module HsaContributionLimit
-              extend FinchAPI::Enum
-
-              INDIVIDUAL = :individual
-              FAMILY = :family
-
-              finalize!
-
-              # @!parse
-              #   # @return [Array<Symbol>]
-              #   def self.values; end
-            end
-          end
-        end
-      end
-
-      IndividualBenefit = Benefits::IndividualBenefit
-    end
-  end
-end