finch-api 0.1.0.pre.alpha.19 → 0.1.0.pre.alpha.20

data/rbi/finch_api/models/hris/benefit_features_and_operations.rbi

@@ -12,19 +12,12 @@ module FinchAPI
             )
           end
 
-        sig do
-          returns(
-            T.nilable(
-              FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures
-            )
-          )
-        end
+        sig { returns(T.nilable(FinchAPI::HRIS::SupportedBenefit)) }
         attr_reader :supported_features
 
         sig do
           params(
-            supported_features:
-              FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::OrHash
+            supported_features: FinchAPI::HRIS::SupportedBenefit::OrHash
           ).void
         end
         attr_writer :supported_features
@@ -41,8 +34,7 @@ module FinchAPI
 
         sig do
           params(
-            supported_features:
-              FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::OrHash,
+            supported_features: FinchAPI::HRIS::SupportedBenefit::OrHash,
             supported_operations: FinchAPI::HRIS::SupportPerBenefitType::OrHash
           ).returns(T.attached_class)
         end
@@ -52,297 +44,13 @@ module FinchAPI
         sig do
           override.returns(
             {
-              supported_features:
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures,
+              supported_features: FinchAPI::HRIS::SupportedBenefit,
               supported_operations: FinchAPI::HRIS::SupportPerBenefitType
             }
           )
         end
         def to_hash
         end
-
-        class SupportedFeatures < FinchAPI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures,
-                FinchAPI::Internal::AnyHash
-              )
-            end
-
-          # Whether the provider supports an annual maximum for this benefit.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_accessor :annual_maximum
-
-          # Whether the provider supports catch up for this benefit. This field will only be
-          # true for retirement benefits.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_accessor :catch_up
-
-          # Supported contribution types. An empty array indicates contributions are not
-          # supported.
-          sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  T.nilable(
-                    FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
-                  )
-                ]
-              )
-            )
-          end
-          attr_accessor :company_contribution
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :description
-
-          # Supported deduction types. An empty array indicates deductions are not
-          # supported.
-          sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  T.nilable(
-                    FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
-                  )
-                ]
-              )
-            )
-          end
-          attr_accessor :employee_deduction
-
-          # The list of frequencies supported by the provider for this benefit
-          sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol)
-                ]
-              )
-            )
-          end
-          attr_reader :frequencies
-
-          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::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
-                  )
-                ]
-              )
-            )
-          end
-          attr_accessor :hsa_contribution_limit
-
-          sig do
-            params(
-              annual_maximum: T.nilable(T::Boolean),
-              catch_up: T.nilable(T::Boolean),
-              company_contribution:
-                T.nilable(
-                  T::Array[
-                    T.nilable(
-                      FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::OrSymbol
-                    )
-                  ]
-                ),
-              description: T.nilable(String),
-              employee_deduction:
-                T.nilable(
-                  T::Array[
-                    T.nilable(
-                      FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::OrSymbol
-                    )
-                  ]
-                ),
-              frequencies:
-                T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)],
-              hsa_contribution_limit:
-                T.nilable(
-                  T::Array[
-                    T.nilable(
-                      FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::OrSymbol
-                    )
-                  ]
-                )
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Whether the provider supports an annual maximum for this benefit.
-            annual_maximum: nil,
-            # Whether the provider supports catch up for this benefit. This field will only be
-            # true for retirement benefits.
-            catch_up: nil,
-            # Supported contribution types. An empty array indicates contributions are not
-            # supported.
-            company_contribution: nil,
-            description: nil,
-            # Supported deduction types. An empty array indicates deductions are not
-            # supported.
-            employee_deduction: nil,
-            # The list of frequencies supported by the provider for this benefit
-            frequencies: nil,
-            # 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
-
-          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::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
-                      )
-                    ]
-                  ),
-                description: T.nilable(String),
-                employee_deduction:
-                  T.nilable(
-                    T::Array[
-                      T.nilable(
-                        FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
-                      )
-                    ]
-                  ),
-                frequencies:
-                  T::Array[
-                    T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol)
-                  ],
-                hsa_contribution_limit:
-                  T.nilable(
-                    T::Array[
-                      T.nilable(
-                        FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
-                      )
-                    ]
-                  )
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module CompanyContribution
-            extend FinchAPI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            FIXED =
-              T.let(
-                :fixed,
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
-              )
-            PERCENT =
-              T.let(
-                :percent,
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
-          module EmployeeDeduction
-            extend FinchAPI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            FIXED =
-              T.let(
-                :fixed,
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
-              )
-            PERCENT =
-              T.let(
-                :percent,
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
-          module HsaContributionLimit
-            extend FinchAPI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            INDIVIDUAL =
-              T.let(
-                :individual,
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
-              )
-            FAMILY =
-              T.let(
-                :family,
-                FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
       end
     end
   end

data/rbi/finch_api/models/hris/benefit_type.rbi

@@ -11,6 +11,8 @@ module FinchAPI
           T.type_alias { T.all(Symbol, FinchAPI::HRIS::BenefitType) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        BENEFIT_TYPE_457 =
+          T.let(:"457", FinchAPI::HRIS::BenefitType::TaggedSymbol)
         BENEFIT_TYPE_401K =
           T.let(:"401k", FinchAPI::HRIS::BenefitType::TaggedSymbol)
         BENEFIT_TYPE_401K_ROTH =
@@ -21,30 +23,28 @@ module FinchAPI
           T.let(:"403b", FinchAPI::HRIS::BenefitType::TaggedSymbol)
         BENEFIT_TYPE_403B_ROTH =
           T.let(:"403b_roth", FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        BENEFIT_TYPE_457 =
-          T.let(:"457", FinchAPI::HRIS::BenefitType::TaggedSymbol)
         BENEFIT_TYPE_457_ROTH =
           T.let(:"457_roth", FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        S125_MEDICAL =
-          T.let(:s125_medical, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        COMMUTER = T.let(:commuter, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        CUSTOM_POST_TAX =
+          T.let(:custom_post_tax, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        CUSTOM_PRE_TAX =
+          T.let(:custom_pre_tax, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        FSA_DEPENDENT_CARE =
+          T.let(:fsa_dependent_care, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        FSA_MEDICAL =
+          T.let(:fsa_medical, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        HSA_POST = T.let(:hsa_post, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        HSA_PRE = T.let(:hsa_pre, FinchAPI::HRIS::BenefitType::TaggedSymbol)
         S125_DENTAL =
           T.let(:s125_dental, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        S125_MEDICAL =
+          T.let(:s125_medical, FinchAPI::HRIS::BenefitType::TaggedSymbol)
         S125_VISION =
           T.let(:s125_vision, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        HSA_PRE = T.let(:hsa_pre, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        HSA_POST = T.let(:hsa_post, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        FSA_MEDICAL =
-          T.let(:fsa_medical, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        FSA_DEPENDENT_CARE =
-          T.let(:fsa_dependent_care, FinchAPI::HRIS::BenefitType::TaggedSymbol)
+        SIMPLE = T.let(:simple, FinchAPI::HRIS::BenefitType::TaggedSymbol)
         SIMPLE_IRA =
           T.let(:simple_ira, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        SIMPLE = T.let(:simple, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        COMMUTER = T.let(:commuter, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        CUSTOM_POST_TAX =
-          T.let(:custom_post_tax, FinchAPI::HRIS::BenefitType::TaggedSymbol)
-        CUSTOM_PRE_TAX =
-          T.let(:custom_pre_tax, FinchAPI::HRIS::BenefitType::TaggedSymbol)
 
         sig do
           override.returns(T::Array[FinchAPI::HRIS::BenefitType::TaggedSymbol])

data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi

@@ -16,9 +16,7 @@ module FinchAPI
           # The attributes of the pay statement item.
           sig do
             returns(
-              T.nilable(
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes
-              )
+              FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes
             )
           end
           attr_reader :attributes
@@ -34,27 +32,14 @@ module FinchAPI
           # The category of the pay statement item.
           sig do
             returns(
-              T.nilable(
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-              )
+              FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
             )
           end
-          attr_reader :category
-
-          sig do
-            params(
-              category:
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol
-            ).void
-          end
-          attr_writer :category
+          attr_accessor :category
 
           # The name of the pay statement item.
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
+          sig { returns(String) }
+          attr_accessor :name
 
           sig do
             params(
@@ -67,11 +52,11 @@ module FinchAPI
           end
           def self.new(
             # The attributes of the pay statement item.
-            attributes: nil,
+            attributes:,
             # The category of the pay statement item.
-            category: nil,
+            category:,
             # The name of the pay statement item.
-            name: nil
+            name:
           )
           end
 
@@ -98,16 +83,16 @@ module FinchAPI
                 )
               end
 
-            # `true` if the amount is paid by the employers. This field is only available for
-            # taxes.
-            sig { returns(T.nilable(T::Boolean)) }
-            attr_accessor :employer
-
             # The metadata of the pay statement item derived by the rules engine if available.
             # Each attribute will be a key-value pair defined by a rule.
             sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
             attr_accessor :metadata
 
+            # `true` if the amount is paid by the employers. This field is only available for
+            # taxes.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :employer
+
             # `true` if the pay statement item is pre-tax. This field is only available for
             # employee deductions.
             sig { returns(T.nilable(T::Boolean)) }
@@ -120,19 +105,19 @@ module FinchAPI
             # The attributes of the pay statement item.
             sig do
               params(
-                employer: T.nilable(T::Boolean),
                 metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+                employer: T.nilable(T::Boolean),
                 pre_tax: T.nilable(T::Boolean),
                 type: T.nilable(String)
               ).returns(T.attached_class)
             end
             def self.new(
+              # The metadata of the pay statement item derived by the rules engine if available.
+              # Each attribute will be a key-value pair defined by a rule.
+              metadata:,
               # `true` if the amount is paid by the employers. This field is only available for
               # taxes.
               employer: nil,
-              # The metadata of the pay statement item derived by the rules engine if available.
-              # Each attribute will be a key-value pair defined by a rule.
-              metadata: nil,
               # `true` if the pay statement item is pre-tax. This field is only available for
               # employee deductions.
               pre_tax: nil,
@@ -144,8 +129,8 @@ module FinchAPI
             sig do
               override.returns(
                 {
-                  employer: T.nilable(T::Boolean),
                   metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+                  employer: T.nilable(T::Boolean),
                   pre_tax: T.nilable(T::Boolean),
                   type: T.nilable(String)
                 }