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

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

@@ -1,109 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class EnrolledIndividual < FinchAPI::BaseModel
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body)) }
-          attr_reader :body
-
-          sig do
-            params(body: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash))
-              .void
-          end
-          attr_writer :body
-
-          # HTTP status code. Either 201 or 200
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)) }
-          attr_reader :code
-
-          sig { params(code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger).void }
-          attr_writer :code
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :individual_id
-
-          sig { params(individual_id: String).void }
-          attr_writer :individual_id
-
-          sig do
-            params(
-              body: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash),
-              code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger,
-              individual_id: String
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(body: nil, code: nil, individual_id: nil)
-          end
-
-          sig do
-            override
-              .returns(
-                {
-                  body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body,
-                  code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger,
-                  individual_id: String
-                }
-              )
-          end
-          def to_hash
-          end
-
-          class Body < FinchAPI::BaseModel
-            # A descriptive identifier for the response
-            sig { returns(T.nilable(String)) }
-            attr_accessor :finch_code
-
-            # Short description in English that provides more information about the response.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :message
-
-            # Identifier indicating whether the benefit was newly enrolled or updated.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :name
-
-            sig do
-              params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String))
-                .returns(T.attached_class)
-            end
-            def self.new(finch_code: nil, message: nil, name: nil)
-            end
-
-            sig do
-              override.returns(
-                {
-                  finch_code: T.nilable(String),
-                  message: T.nilable(String),
-                  name: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          # HTTP status code. Either 201 or 200
-          module Code
-            extend FinchAPI::Enum
-
-            TaggedInteger =
-              T.type_alias { T.all(Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code) }
-            OrInteger =
-              T.type_alias { T.any(Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) }
-
-            OK = T.let(200, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)
-            CREATED = T.let(201, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)
-            NOT_FOUND = T.let(404, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)
-            FORBIDDEN = T.let(403, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)
-
-            sig { override.returns(T::Array[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger]) }
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,164 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualBenefit < FinchAPI::BaseModel
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body)) }
-          attr_reader :body
-
-          sig do
-            params(body: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash))
-              .void
-          end
-          attr_writer :body
-
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :code
-
-          sig { params(code: Integer).void }
-          attr_writer :code
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :individual_id
-
-          sig { params(individual_id: String).void }
-          attr_writer :individual_id
-
-          sig do
-            params(
-              body: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash),
-              code: Integer,
-              individual_id: String
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(body: nil, code: nil, individual_id: nil)
-          end
-
-          sig do
-            override
-              .returns(
-                {body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, code: Integer, individual_id: String}
-              )
-          end
-          def to_hash
-          end
-
-          class Body < FinchAPI::BaseModel
-            # If the benefit supports annual maximum, the amount in cents for this individual.
-            sig { returns(T.nilable(Integer)) }
-            attr_accessor :annual_maximum
-
-            # If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
-            #   for this individual.
-            sig { returns(T.nilable(T::Boolean)) }
-            attr_accessor :catch_up
-
-            sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) }
-            attr_reader :company_contribution
-
-            sig do
-              params(
-                company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))
-              )
-                .void
-            end
-            attr_writer :company_contribution
-
-            sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) }
-            attr_reader :employee_deduction
-
-            sig do
-              params(
-                employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))
-              )
-                .void
-            end
-            attr_writer :employee_deduction
-
-            # Type for HSA contribution limit if the benefit is a HSA.
-            sig do
-              returns(
-                T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol)
-              )
-            end
-            attr_accessor :hsa_contribution_limit
-
-            sig do
-              params(
-                annual_maximum: T.nilable(Integer),
-                catch_up: T.nilable(T::Boolean),
-                company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)),
-                employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)),
-                hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::OrSymbol)
-              )
-                .returns(T.attached_class)
-            end
-            def self.new(
-              annual_maximum: nil,
-              catch_up: nil,
-              company_contribution: nil,
-              employee_deduction: nil,
-              hsa_contribution_limit: nil
-            )
-            end
-
-            sig do
-              override
-                .returns(
-                  {
-                    annual_maximum: T.nilable(Integer),
-                    catch_up: T.nilable(T::Boolean),
-                    company_contribution: T.nilable(FinchAPI::Models::HRIS::BenefitContribution),
-                    employee_deduction: T.nilable(FinchAPI::Models::HRIS::BenefitContribution),
-                    hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol)
-                  }
-                )
-            end
-            def to_hash
-            end
-
-            # Type for HSA contribution limit if the benefit is a HSA.
-            module HsaContributionLimit
-              extend FinchAPI::Enum
-
-              TaggedSymbol =
-                T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit) }
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol
-                  )
-                end
-
-              INDIVIDUAL =
-                T.let(
-                  :individual,
-                  FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol
-                )
-              FAMILY =
-                T.let(
-                  :family,
-                  FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol
-                )
-
-              sig do
-                override
-                  .returns(
-                    T::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol]
-                  )
-              end
-              def self.values
-              end
-            end
-          end
-        end
-      end
-
-      IndividualBenefit = Benefits::IndividualBenefit
-    end
-  end
-end

data/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi

@@ -1,426 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Benefits
-        class IndividualEnrollManyParams < FinchAPI::BaseModel
-          extend FinchAPI::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          # Array of the individual_id to enroll and a configuration object.
-          sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual])) }
-          attr_reader :individuals
-
-          sig do
-            params(
-              individuals: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)]
-            )
-              .void
-          end
-          attr_writer :individuals
-
-          sig do
-            params(
-              individuals: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)],
-              request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(individuals: nil, request_options: {})
-          end
-
-          sig do
-            override
-              .returns(
-                {
-                  individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual],
-                  request_options: FinchAPI::RequestOptions
-                }
-              )
-          end
-          def to_hash
-          end
-
-          class Individual < FinchAPI::BaseModel
-            sig do
-              returns(
-                T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration)
-              )
-            end
-            attr_reader :configuration
-
-            sig do
-              params(
-                configuration: T.any(
-                  FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration,
-                  FinchAPI::Util::AnyHash
-                )
-              )
-                .void
-            end
-            attr_writer :configuration
-
-            # Finch id (uuidv4) for the individual to enroll
-            sig { returns(T.nilable(String)) }
-            attr_reader :individual_id
-
-            sig { params(individual_id: String).void }
-            attr_writer :individual_id
-
-            sig do
-              params(
-                configuration: T.any(
-                  FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration,
-                  FinchAPI::Util::AnyHash
-                ),
-                individual_id: String
-              )
-                .returns(T.attached_class)
-            end
-            def self.new(configuration: nil, individual_id: nil)
-            end
-
-            sig do
-              override
-                .returns(
-                  {
-                    configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration,
-                    individual_id: String
-                  }
-                )
-            end
-            def to_hash
-            end
-
-            class Configuration < FinchAPI::BaseModel
-              # For HSA benefits only - whether the contribution limit is for an individual or
-              #   family
-              sig do
-                returns(
-                  T.nilable(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol
-                  )
-                )
-              end
-              attr_reader :annual_contribution_limit
-
-              sig do
-                params(
-                  annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol
-                )
-                  .void
-              end
-              attr_writer :annual_contribution_limit
-
-              # Maximum annual amount in cents
-              sig { returns(T.nilable(Integer)) }
-              attr_accessor :annual_maximum
-
-              # For retirement benefits only - whether catch up contributions are enabled
-              sig { returns(T.nilable(T::Boolean)) }
-              attr_reader :catch_up
-
-              sig { params(catch_up: T::Boolean).void }
-              attr_writer :catch_up
-
-              sig do
-                returns(
-                  T.nilable(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution
-                  )
-                )
-              end
-              attr_reader :company_contribution
-
-              sig do
-                params(
-                  company_contribution: T.any(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution,
-                    FinchAPI::Util::AnyHash
-                  )
-                )
-                  .void
-              end
-              attr_writer :company_contribution
-
-              sig do
-                returns(
-                  T.nilable(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
-                  )
-                )
-              end
-              attr_reader :employee_deduction
-
-              sig do
-                params(
-                  employee_deduction: T.any(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction,
-                    FinchAPI::Util::AnyHash
-                  )
-                )
-                  .void
-              end
-              attr_writer :employee_deduction
-
-              sig do
-                params(
-                  annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol,
-                  annual_maximum: T.nilable(Integer),
-                  catch_up: T::Boolean,
-                  company_contribution: T.any(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution,
-                    FinchAPI::Util::AnyHash
-                  ),
-                  employee_deduction: T.any(
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction,
-                    FinchAPI::Util::AnyHash
-                  )
-                )
-                  .returns(T.attached_class)
-              end
-              def self.new(
-                annual_contribution_limit: nil,
-                annual_maximum: nil,
-                catch_up: nil,
-                company_contribution: nil,
-                employee_deduction: nil
-              )
-              end
-
-              sig do
-                override
-                  .returns(
-                    {
-                      annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol,
-                      annual_maximum: T.nilable(Integer),
-                      catch_up: T::Boolean,
-                      company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution,
-                      employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
-                    }
-                  )
-              end
-              def to_hash
-              end
-
-              # For HSA benefits only - whether the contribution limit is for an individual or
-              #   family
-              module AnnualContributionLimit
-                extend FinchAPI::Enum
-
-                TaggedSymbol =
-                  T.type_alias do
-                    T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit)
-                  end
-                OrSymbol =
-                  T.type_alias do
-                    T.any(
-                      Symbol,
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
-                    )
-                  end
-
-                INDIVIDUAL =
-                  T.let(
-                    :individual,
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
-                  )
-                FAMILY =
-                  T.let(
-                    :family,
-                    FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
-                  )
-
-                sig do
-                  override
-                    .returns(
-                      T::Array[
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol
-                      ]
-                    )
-                end
-                def self.values
-                end
-              end
-
-              class CompanyContribution < FinchAPI::BaseModel
-                # Amount in cents for fixed type or basis points (1/100th of a percent) for
-                #   percent type
-                sig { returns(T.nilable(Integer)) }
-                attr_reader :amount
-
-                sig { params(amount: Integer).void }
-                attr_writer :amount
-
-                sig do
-                  returns(
-                    T.nilable(
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
-                    )
-                  )
-                end
-                attr_reader :type
-
-                sig do
-                  params(
-                    type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
-                  )
-                    .void
-                end
-                attr_writer :type
-
-                sig do
-                  params(
-                    amount: Integer,
-                    type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
-                  )
-                    .returns(T.attached_class)
-                end
-                def self.new(amount: nil, type: nil)
-                end
-
-                sig do
-                  override
-                    .returns(
-                      {
-                        amount: Integer,
-                        type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
-                      }
-                    )
-                end
-                def to_hash
-                end
-
-                module Type
-                  extend FinchAPI::Enum
-
-                  TaggedSymbol =
-                    T.type_alias do
-                      T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type)
-                    end
-                  OrSymbol =
-                    T.type_alias do
-                      T.any(
-                        Symbol,
-                        FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
-                      )
-                    end
-
-                  FIXED =
-                    T.let(
-                      :fixed,
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
-                    )
-                  PERCENT =
-                    T.let(
-                      :percent,
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
-                    )
-
-                  sig do
-                    override
-                      .returns(
-                        T::Array[
-                        FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
-                        ]
-                      )
-                  end
-                  def self.values
-                  end
-                end
-              end
-
-              class EmployeeDeduction < FinchAPI::BaseModel
-                # Amount in cents for fixed type or basis points (1/100th of a percent) for
-                #   percent type
-                sig { returns(T.nilable(Integer)) }
-                attr_reader :amount
-
-                sig { params(amount: Integer).void }
-                attr_writer :amount
-
-                sig do
-                  returns(
-                    T.nilable(
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
-                    )
-                  )
-                end
-                attr_reader :type
-
-                sig do
-                  params(
-                    type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
-                  )
-                    .void
-                end
-                attr_writer :type
-
-                sig do
-                  params(
-                    amount: Integer,
-                    type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
-                  )
-                    .returns(T.attached_class)
-                end
-                def self.new(amount: nil, type: nil)
-                end
-
-                sig do
-                  override
-                    .returns(
-                      {
-                        amount: Integer,
-                        type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol
-                      }
-                    )
-                end
-                def to_hash
-                end
-
-                module Type
-                  extend FinchAPI::Enum
-
-                  TaggedSymbol =
-                    T.type_alias do
-                      T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type)
-                    end
-                  OrSymbol =
-                    T.type_alias do
-                      T.any(
-                        Symbol,
-                        FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
-                      )
-                    end
-
-                  FIXED =
-                    T.let(
-                      :fixed,
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
-                    )
-                  PERCENT =
-                    T.let(
-                      :percent,
-                      FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
-                    )
-
-                  sig do
-                    override
-                      .returns(
-                        T::Array[
-                        FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol
-                        ]
-                      )
-                  end
-                  def self.values
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end