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

data/rbi/finch_api/models/employment_event.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent
+      sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::Data)) }
+      attr_reader :data
+
+      sig { params(data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Internal::AnyHash)).void }
+      attr_writer :data
+
+      sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)) }
+      attr_reader :event_type
+
+      sig { params(event_type: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol).void }
+      attr_writer :event_type
+
+      sig do
+        params(
+          data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Internal::AnyHash),
+          event_type: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(data: nil, event_type: nil); end
+
+      sig do
+        override
+          .returns(
+            {
+              data: FinchAPI::Models::EmploymentEvent::Data,
+              event_type: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol
+            }
+          )
+      end
+      def to_hash; end
+
+      class Data < FinchAPI::Internal::Type::BaseModel
+        # The ID of the individual related to the event.
+        sig { returns(T.nilable(String)) }
+        attr_reader :individual_id
+
+        sig { params(individual_id: String).void }
+        attr_writer :individual_id
+
+        sig { params(individual_id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the individual related to the event.
+          individual_id: nil
+        ); end
+        sig { override.returns({individual_id: String}) }
+        def to_hash; end
+      end
+
+      module EventType
+        extend FinchAPI::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::EmploymentEvent::EventType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMPLOYMENT_CREATED =
+          T.let(:"employment.created", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)
+        EMPLOYMENT_UPDATED =
+          T.let(:"employment.updated", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)
+        EMPLOYMENT_DELETED =
+          T.let(:"employment.deleted", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)
+
+        sig { override.returns(T::Array[FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol]) }
+        def self.values; end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefit_contribution.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitContribution < FinchAPI::Internal::Type::BaseModel
+        # Contribution amount in cents (if `fixed`) or basis points (if `percent`).
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :amount
+
+        # Contribution type.
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) }
+        attr_accessor :type
+
+        sig do
+          params(
+            amount: T.nilable(Integer),
+            type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::OrSymbol)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # Contribution amount in cents (if `fixed`) or basis points (if `percent`).
+          amount: nil,
+          # Contribution type.
+          type: nil
+        ); end
+        sig do
+          override
+            .returns(
+              {amount: T.nilable(Integer), type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)}
+            )
+        end
+        def to_hash; end
+
+        # Contribution type.
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FIXED = T.let(:fixed, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)
+          PERCENT = T.let(:percent, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)
+
+          sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol]) }
+          def self.values; end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefit_create_params.rbi

@@ -0,0 +1,159 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # The company match for this benefit.
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution)) }
+        attr_reader :company_contribution
+
+        sig do
+          params(
+            company_contribution: T.nilable(
+              T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, FinchAPI::Internal::AnyHash)
+            )
+          )
+            .void
+        end
+        attr_writer :company_contribution
+
+        # 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).
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # The frequency of the benefit deduction/contribution.
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) }
+        attr_accessor :frequency
+
+        # Type of benefit.
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) }
+        attr_accessor :type
+
+        sig do
+          params(
+            company_contribution: T.nilable(
+              T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, FinchAPI::Internal::AnyHash)
+            ),
+            description: String,
+            frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol),
+            type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol),
+            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # The company match for this benefit.
+          company_contribution: nil,
+          # 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).
+          description: nil,
+          # The frequency of the benefit deduction/contribution.
+          frequency: nil,
+          # Type of benefit.
+          type: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                company_contribution: T.nilable(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution),
+                description: String,
+                frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol),
+                type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol),
+                request_options: FinchAPI::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        class CompanyContribution < FinchAPI::Internal::Type::BaseModel
+          sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier])) }
+          attr_reader :tiers
+
+          sig do
+            params(
+              tiers: T::Array[T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier, FinchAPI::Internal::AnyHash)]
+            )
+              .void
+          end
+          attr_writer :tiers
+
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol)) }
+          attr_reader :type
+
+          sig { params(type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol).void }
+          attr_writer :type
+
+          # The company match for this benefit.
+          sig do
+            params(
+              tiers: T::Array[T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier, FinchAPI::Internal::AnyHash)],
+              type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(tiers: nil, type: nil); end
+
+          sig do
+            override
+              .returns(
+                {
+                  tiers: T::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier],
+                  type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol
+                }
+              )
+          end
+          def to_hash; end
+
+          class Tier < FinchAPI::Internal::Type::BaseModel
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :match
+
+            sig { params(match: Integer).void }
+            attr_writer :match
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :threshold
+
+            sig { params(threshold: Integer).void }
+            attr_writer :threshold
+
+            sig { params(match: Integer, threshold: Integer).returns(T.attached_class) }
+            def self.new(match: nil, threshold: nil); end
+
+            sig { override.returns({match: Integer, threshold: Integer}) }
+            def to_hash; end
+          end
+
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MATCH =
+              T.let(:match, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::TaggedSymbol)
+
+            sig do
+              override
+                .returns(T::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,293 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures)) }
+        attr_reader :supported_features
+
+        sig do
+          params(
+            supported_features: T.any(
+              FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures,
+              FinchAPI::Internal::AnyHash
+            )
+          )
+            .void
+        end
+        attr_writer :supported_features
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::SupportPerBenefitType)) }
+        attr_reader :supported_operations
+
+        sig do
+          params(
+            supported_operations: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Internal::AnyHash)
+          )
+            .void
+        end
+        attr_writer :supported_operations
+
+        sig do
+          params(
+            supported_features: T.any(
+              FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures,
+              FinchAPI::Internal::AnyHash
+            ),
+            supported_operations: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(supported_features: nil, supported_operations: nil); end
+
+        sig do
+          override
+            .returns(
+              {
+                supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures,
+                supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType
+              }
+            )
+        end
+        def to_hash; end
+
+        class SupportedFeatures < FinchAPI::Internal::Type::BaseModel
+          # 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::Models::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::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
+                  )
+                ]
+              )
+            )
+          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::TaggedSymbol)])) }
+          attr_reader :frequencies
+
+          sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void }
+          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::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::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::OrSymbol
+                  )
+                ]
+              ),
+              description: T.nilable(String),
+              employee_deduction: T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::OrSymbol
+                  )
+                ]
+              ),
+              frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)],
+              hsa_contribution_limit: T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::Models::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::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
+                      )
+                    ]
+                  ),
+                  description: T.nilable(String),
+                  employee_deduction: T.nilable(
+                    T::Array[
+                      T.nilable(
+                        FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
+                      )
+                    ]
+                  ),
+                  frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)],
+                  hsa_contribution_limit: T.nilable(
+                    T::Array[
+                      T.nilable(
+                        FinchAPI::Models::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::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIXED =
+              T.let(
+                :fixed,
+                FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
+              )
+            PERCENT =
+              T.let(
+                :percent,
+                FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::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::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIXED =
+              T.let(
+                :fixed,
+                FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
+              )
+            PERCENT =
+              T.let(
+                :percent,
+                FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[FinchAPI::Models::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::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INDIVIDUAL =
+              T.let(
+                :individual,
+                FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
+              )
+            FAMILY =
+              T.let(
+                :family,
+                FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[
+                    FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol
+                  ]
+                )
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefit_frequency.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      # The frequency of the benefit deduction/contribution.
+      module BenefitFrequency
+        extend FinchAPI::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitFrequency) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ONE_TIME = T.let(:one_time, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)
+        EVERY_PAYCHECK = T.let(:every_paycheck, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)
+        MONTHLY = T.let(:monthly, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)
+
+        sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol]) }
+        def self.values; end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefit_list_params.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        sig do
+          params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
+            .returns(T.attached_class)
+        end
+        def self.new(request_options: {}); end
+
+        sig { override.returns({request_options: FinchAPI::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitListSupportedBenefitsParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        sig do
+          params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash))
+            .returns(T.attached_class)
+        end
+        def self.new(request_options: {}); end
+
+        sig { override.returns({request_options: FinchAPI::RequestOptions}) }
+        def to_hash; end
+      end
+    end
+  end
+end