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

data/rbi/finch_api/models/hris/supported_benefit.rbi

@@ -4,6 +4,9 @@ module FinchAPI
   module Models
     module HRIS
       class SupportedBenefit < FinchAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
         # Whether the provider supports an annual maximum for this benefit.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :annual_maximum
@@ -17,7 +20,13 @@ module FinchAPI
         # supported.
         sig do
           returns(
-            T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::OrSymbol)])
+            T.nilable(
+              T::Array[
+                T.nilable(
+                  FinchAPI::HRIS::SupportedBenefit::CompanyContribution::OrSymbol
+                )
+              ]
+            )
           )
         end
         attr_accessor :company_contribution
@@ -29,23 +38,46 @@ module FinchAPI
         # supported.
         sig do
           returns(
-            T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol)])
+            T.nilable(
+              T::Array[
+                T.nilable(
+                  FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol
+                )
+              ]
+            )
           )
         end
         attr_accessor :employee_deduction
 
         # The list of frequencies supported by the provider for this benefit
-        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)])) }
+        sig do
+          returns(
+            T.nilable(
+              T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)]
+            )
+          )
+        end
         attr_reader :frequencies
 
-        sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void }
+        sig do
+          params(
+            frequencies:
+              T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)]
+          ).void
+        end
         attr_writer :frequencies
 
         # 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.
         sig do
           returns(
-            T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol)])
+            T.nilable(
+              T::Array[
+                T.nilable(
+                  FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol
+                )
+              ]
+            )
           )
         end
         attr_accessor :hsa_contribution_limit
@@ -54,13 +86,34 @@ module FinchAPI
           params(
             annual_maximum: T.nilable(T::Boolean),
             catch_up: T.nilable(T::Boolean),
-            company_contribution: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::OrSymbol)]),
+            company_contribution:
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::HRIS::SupportedBenefit::CompanyContribution::OrSymbol
+                  )
+                ]
+              ),
             description: T.nilable(String),
-            employee_deduction: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol)]),
-            frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)],
-            hsa_contribution_limit: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol)])
-          )
-            .returns(T.attached_class)
+            employee_deduction:
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol
+                  )
+                ]
+              ),
+            frequencies:
+              T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)],
+            hsa_contribution_limit:
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol
+                  )
+                ]
+              )
+          ).returns(T.attached_class)
         end
         def self.new(
           # Whether the provider supports an annual maximum for this benefit.
@@ -80,64 +133,144 @@ module FinchAPI
           # 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.
           hsa_contribution_limit: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                annual_maximum: T.nilable(T::Boolean),
-                catch_up: T.nilable(T::Boolean),
-                company_contribution: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::OrSymbol)]),
-                description: T.nilable(String),
-                employee_deduction: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol)]),
-                frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)],
-                hsa_contribution_limit: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol)])
-              }
-            )
+          override.returns(
+            {
+              annual_maximum: T.nilable(T::Boolean),
+              catch_up: T.nilable(T::Boolean),
+              company_contribution:
+                T.nilable(
+                  T::Array[
+                    T.nilable(
+                      FinchAPI::HRIS::SupportedBenefit::CompanyContribution::OrSymbol
+                    )
+                  ]
+                ),
+              description: T.nilable(String),
+              employee_deduction:
+                T.nilable(
+                  T::Array[
+                    T.nilable(
+                      FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol
+                    )
+                  ]
+                ),
+              frequencies:
+                T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)],
+              hsa_contribution_limit:
+                T.nilable(
+                  T::Array[
+                    T.nilable(
+                      FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol
+                    )
+                  ]
+                )
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         module CompanyContribution
           extend FinchAPI::Internal::Type::Enum
 
           TaggedSymbol =
-            T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution) }
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::HRIS::SupportedBenefit::CompanyContribution
+              )
+            end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)
-          PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)
+          FIXED =
+            T.let(
+              :fixed,
+              FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol
+            )
+          PERCENT =
+            T.let(
+              :percent,
+              FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol
+            )
 
-          sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol]) }
-          def self.values; end
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
         end
 
         module EmployeeDeduction
           extend FinchAPI::Internal::Type::Enum
 
           TaggedSymbol =
-            T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction) }
+            T.type_alias do
+              T.all(Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction)
+            end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)
-          PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)
+          FIXED =
+            T.let(
+              :fixed,
+              FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol
+            )
+          PERCENT =
+            T.let(
+              :percent,
+              FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol
+            )
 
-          sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol]) }
-          def self.values; end
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
         end
 
         module HsaContributionLimit
           extend FinchAPI::Internal::Type::Enum
 
           TaggedSymbol =
-            T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit) }
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit
+              )
+            end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           INDIVIDUAL =
-            T.let(:individual, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)
-          FAMILY = T.let(:family, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)
+            T.let(
+              :individual,
+              FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol
+            )
+          FAMILY =
+            T.let(
+              :family,
+              FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol
+            )
 
-          sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol]) }
-          def self.values; end
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
         end
       end
     end

data/rbi/finch_api/models/hris/update_company_benefit_response.rbi

@@ -4,6 +4,9 @@ module FinchAPI
   module Models
     module HRIS
       class UpdateCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
         # The id of the benefit.
         sig { returns(String) }
         attr_accessor :benefit_id
@@ -11,14 +14,19 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :job_id
 
-        sig { params(benefit_id: String, job_id: String).returns(T.attached_class) }
+        sig do
+          params(benefit_id: String, job_id: String).returns(T.attached_class)
+        end
         def self.new(
           # The id of the benefit.
           benefit_id:,
           job_id:
-        ); end
-        sig { override.returns({benefit_id: String, job_id: String}) }
-        def to_hash; end
+        )
+        end
+
+        sig { override.returns({ benefit_id: String, job_id: String }) }
+        def to_hash
+        end
       end
     end
   end

data/rbi/finch_api/models/hris/w42005.rbi

@@ -4,18 +4,21 @@ module FinchAPI
   module Models
     module HRIS
       class W42005 < FinchAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
         # Detailed information specific to the 2005 W4 form.
-        sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data)) }
+        sig { returns(T.nilable(FinchAPI::HRIS::W42005::Data)) }
         attr_reader :data
 
-        sig { params(data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Internal::AnyHash)).void }
+        sig { params(data: FinchAPI::HRIS::W42005::Data::OrHash).void }
         attr_writer :data
 
         # Specifies the form type, indicating that this document is a 2005 W4 form.
-        sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol)) }
+        sig { returns(T.nilable(FinchAPI::HRIS::W42005::Type::TaggedSymbol)) }
         attr_reader :type
 
-        sig { params(type: FinchAPI::Models::HRIS::W42005::Type::OrSymbol).void }
+        sig { params(type: FinchAPI::HRIS::W42005::Type::OrSymbol).void }
         attr_writer :type
 
         # The tax year this W4 document applies to.
@@ -26,11 +29,10 @@ module FinchAPI
         # filing status, dependents, and withholding details.
         sig do
           params(
-            data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Internal::AnyHash),
-            type: FinchAPI::Models::HRIS::W42005::Type::OrSymbol,
+            data: FinchAPI::HRIS::W42005::Data::OrHash,
+            type: FinchAPI::HRIS::W42005::Type::OrSymbol,
             year: T.nilable(Float)
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
         end
         def self.new(
           # Detailed information specific to the 2005 W4 form.
@@ -39,33 +41,52 @@ module FinchAPI
           type: nil,
           # The tax year this W4 document applies to.
           year: nil
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                data: FinchAPI::Models::HRIS::W42005::Data,
-                type: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol,
-                year: T.nilable(Float)
-              }
-            )
+          override.returns(
+            {
+              data: FinchAPI::HRIS::W42005::Data,
+              type: FinchAPI::HRIS::W42005::Type::TaggedSymbol,
+              year: T.nilable(Float)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class Data < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
           # Additional withholding amount (in cents).
           sig { returns(T.nilable(Integer)) }
           attr_accessor :additional_withholding
 
           # Indicates exemption status from federal tax withholding.
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol)) }
+          sig do
+            returns(
+              T.nilable(FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol)
+            )
+          end
           attr_reader :exemption
 
-          sig { params(exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol).void }
+          sig do
+            params(
+              exemption: FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol
+            ).void
+          end
           attr_writer :exemption
 
           # The individual's filing status for tax purposes.
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)) }
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
+              )
+            )
+          end
           attr_accessor :filing_status
 
           # The unique identifier for the individual associated with this 2005 W4 form.
@@ -83,12 +104,12 @@ module FinchAPI
           sig do
             params(
               additional_withholding: T.nilable(Integer),
-              exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol,
-              filing_status: T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol),
+              exemption: FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol,
+              filing_status:
+                T.nilable(FinchAPI::HRIS::W42005::Data::FilingStatus::OrSymbol),
               individual_id: String,
               total_number_of_allowances: T.nilable(Integer)
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
           end
           def self.new(
             # Additional withholding amount (in cents).
@@ -101,52 +122,92 @@ module FinchAPI
             individual_id: nil,
             # Total number of allowances claimed (in cents).
             total_number_of_allowances: nil
-          ); end
+          )
+          end
+
           sig do
-            override
-              .returns(
-                {
-                  additional_withholding: T.nilable(Integer),
-                  exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol,
-                  filing_status: T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol),
-                  individual_id: String,
-                  total_number_of_allowances: T.nilable(Integer)
-                }
-              )
+            override.returns(
+              {
+                additional_withholding: T.nilable(Integer),
+                exemption:
+                  FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol,
+                filing_status:
+                  T.nilable(
+                    FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
+                  ),
+                individual_id: String,
+                total_number_of_allowances: T.nilable(Integer)
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
 
           # Indicates exemption status from federal tax withholding.
           module Exemption
             extend FinchAPI::Internal::Type::Enum
 
-            TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption) }
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, FinchAPI::HRIS::W42005::Data::Exemption)
+              end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            EXEMPT = T.let(:exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol)
-            NON_EXEMPT = T.let(:non_exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol)
+            EXEMPT =
+              T.let(
+                :exempt,
+                FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol
+              )
+            NON_EXEMPT =
+              T.let(
+                :non_exempt,
+                FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol
+              )
 
-            sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol]) }
-            def self.values; end
+            sig do
+              override.returns(
+                T::Array[FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol]
+              )
+            end
+            def self.values
+            end
           end
 
           # The individual's filing status for tax purposes.
           module FilingStatus
             extend FinchAPI::Internal::Type::Enum
 
-            TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus) }
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus)
+              end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            MARRIED = T.let(:married, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)
+            MARRIED =
+              T.let(
+                :married,
+                FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
+              )
             MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE =
               T.let(
                 :married_but_withhold_at_higher_single_rate,
-                FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol
+                FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
+              )
+            SINGLE =
+              T.let(
+                :single,
+                FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
               )
-            SINGLE = T.let(:single, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)
 
-            sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol]) }
-            def self.values; end
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
         end
 
@@ -154,13 +215,19 @@ module FinchAPI
         module Type
           extend FinchAPI::Internal::Type::Enum
 
-          TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Type) }
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, FinchAPI::HRIS::W42005::Type) }
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol)
+          W4_2005 = T.let(:w4_2005, FinchAPI::HRIS::W42005::Type::TaggedSymbol)
 
-          sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol]) }
-          def self.values; end
+          sig do
+            override.returns(
+              T::Array[FinchAPI::HRIS::W42005::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
         end
       end
     end