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

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

@@ -0,0 +1,132 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # Comma-delimited list of pay statement item categories to filter on. If empty,
+          # defaults to all categories.
+          sig do
+            returns(
+              T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol])
+            )
+          end
+          attr_reader :categories
+
+          sig do
+            params(
+              categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol]
+            )
+              .void
+          end
+          attr_writer :categories
+
+          # The end date to retrieve pay statement items by via their last seen pay date in
+          # `YYYY-MM-DD` format.
+          sig { returns(T.nilable(Date)) }
+          attr_reader :end_date
+
+          sig { params(end_date: Date).void }
+          attr_writer :end_date
+
+          # Case-insensitive partial match search by pay statement item name.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # The start date to retrieve pay statement items by via their last seen pay date
+          # (inclusive) in `YYYY-MM-DD` format.
+          sig { returns(T.nilable(Date)) }
+          attr_reader :start_date
+
+          sig { params(start_date: Date).void }
+          attr_writer :start_date
+
+          # String search by pay statement item type.
+          sig { returns(T.nilable(String)) }
+          attr_reader :type
+
+          sig { params(type: String).void }
+          attr_writer :type
+
+          sig do
+            params(
+              categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol],
+              end_date: Date,
+              name: String,
+              start_date: Date,
+              type: String,
+              request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # Comma-delimited list of pay statement item categories to filter on. If empty,
+            # defaults to all categories.
+            categories: nil,
+            # The end date to retrieve pay statement items by via their last seen pay date in
+            # `YYYY-MM-DD` format.
+            end_date: nil,
+            # Case-insensitive partial match search by pay statement item name.
+            name: nil,
+            # The start date to retrieve pay statement items by via their last seen pay date
+            # (inclusive) in `YYYY-MM-DD` format.
+            start_date: nil,
+            # String search by pay statement item type.
+            type: nil,
+            request_options: {}
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol],
+                  end_date: Date,
+                  name: String,
+                  start_date: Date,
+                  type: String,
+                  request_options: FinchAPI::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+
+          module Category
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EARNINGS =
+              T.let(:earnings, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol)
+            TAXES =
+              T.let(:taxes, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol)
+            EMPLOYEE_DEDUCTIONS =
+              T.let(
+                :employee_deductions,
+                FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
+              )
+            EMPLOYER_CONTRIBUTIONS =
+              T.let(
+                :employer_contributions,
+                FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,158 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
+          # The attributes of the pay statement item.
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes)) }
+          attr_reader :attributes
+
+          sig do
+            params(
+              attributes: T.any(
+                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
+                FinchAPI::Internal::AnyHash
+              )
+            )
+              .void
+          end
+          attr_writer :attributes
+
+          # The category of the pay statement item.
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol)) }
+          attr_reader :category
+
+          sig { params(category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol).void }
+          attr_writer :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 do
+            params(
+              attributes: T.any(
+                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
+                FinchAPI::Internal::AnyHash
+              ),
+              category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol,
+              name: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The attributes of the pay statement item.
+            attributes: nil,
+            # The category of the pay statement item.
+            category: nil,
+            # The name of the pay statement item.
+            name: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  attributes: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
+                  category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol,
+                  name: String
+                }
+              )
+          end
+          def to_hash; end
+
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            # `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 pay statement item is pre-tax. This field is only available for
+            # employee deductions.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :pre_tax
+
+            # The type of the pay statement item.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :type
+
+            # 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)]),
+                pre_tax: T.nilable(T::Boolean),
+                type: T.nilable(String)
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              # `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,
+              # The type of the pay statement item.
+              type: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    employer: T.nilable(T::Boolean),
+                    metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+                    pre_tax: T.nilable(T::Boolean),
+                    type: T.nilable(String)
+                  }
+                )
+            end
+            def to_hash; end
+          end
+
+          # The category of the pay statement item.
+          module Category
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EARNINGS =
+              T.let(:earnings, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol)
+            TAXES =
+              T.let(:taxes, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol)
+            EMPLOYEE_DEDUCTIONS =
+              T.let(
+                :employee_deductions,
+                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
+              )
+            EMPLOYER_CONTRIBUTIONS =
+              T.let(
+                :employer_contributions,
+                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,303 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class HRISCompany < FinchAPI::Internal::Type::BaseModel
+        # A stable Finch `id` (UUID v4) for the company.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # An array of bank account objects associated with the payroll/HRIS system.
+        sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account])) }
+        attr_accessor :accounts
+
+        # The array of company departments.
+        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) }
+        attr_accessor :departments
+
+        # The employer identification number.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ein
+
+        # The entity type object.
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) }
+        attr_reader :entity
+
+        sig do
+          params(entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Internal::AnyHash)))
+            .void
+        end
+        attr_writer :entity
+
+        # The legal name of the company.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :legal_name
+
+        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) }
+        attr_accessor :locations
+
+        # The email of the main administrator on the account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :primary_email
+
+        # The phone number of the main administrator on the account. Format: E.164, with
+        # extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+        sig { returns(T.nilable(String)) }
+        attr_accessor :primary_phone_number
+
+        sig do
+          params(
+            id: String,
+            accounts: T.nilable(T::Array[T.any(FinchAPI::Models::HRIS::HRISCompany::Account, FinchAPI::Internal::AnyHash)]),
+            departments: T.nilable(
+              T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department, FinchAPI::Internal::AnyHash))]
+            ),
+            ein: T.nilable(String),
+            entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Internal::AnyHash)),
+            legal_name: T.nilable(String),
+            locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))]),
+            primary_email: T.nilable(String),
+            primary_phone_number: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # A stable Finch `id` (UUID v4) for the company.
+          id:,
+          # An array of bank account objects associated with the payroll/HRIS system.
+          accounts:,
+          # The array of company departments.
+          departments:,
+          # The employer identification number.
+          ein:,
+          # The entity type object.
+          entity:,
+          # The legal name of the company.
+          legal_name:,
+          locations:,
+          # The email of the main administrator on the account.
+          primary_email:,
+          # The phone number of the main administrator on the account. Format: E.164, with
+          # extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+          primary_phone_number:
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                accounts: T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account]),
+                departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)]),
+                ein: T.nilable(String),
+                entity: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity),
+                legal_name: T.nilable(String),
+                locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]),
+                primary_email: T.nilable(String),
+                primary_phone_number: T.nilable(String)
+              }
+            )
+        end
+        def to_hash; end
+
+        class Account < FinchAPI::Internal::Type::BaseModel
+          # The name of the bank associated in the payroll/HRIS system.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :account_name
+
+          # 10-12 digit number to specify the bank account
+          sig { returns(T.nilable(String)) }
+          attr_accessor :account_number
+
+          # The type of bank account.
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) }
+          attr_accessor :account_type
+
+          # Name of the banking institution.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :institution_name
+
+          # A nine-digit code that's based on the U.S. Bank location where your account was
+          # opened.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :routing_number
+
+          sig do
+            params(
+              account_name: T.nilable(String),
+              account_number: T.nilable(String),
+              account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::OrSymbol),
+              institution_name: T.nilable(String),
+              routing_number: T.nilable(String)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the bank associated in the payroll/HRIS system.
+            account_name:,
+            # 10-12 digit number to specify the bank account
+            account_number:,
+            # The type of bank account.
+            account_type:,
+            # Name of the banking institution.
+            institution_name:,
+            # A nine-digit code that's based on the U.S. Bank location where your account was
+            # opened.
+            routing_number:
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  account_name: T.nilable(String),
+                  account_number: T.nilable(String),
+                  account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol),
+                  institution_name: T.nilable(String),
+                  routing_number: T.nilable(String)
+                }
+              )
+          end
+          def to_hash; end
+
+          # The type of bank account.
+          module AccountType
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHECKING = T.let(:checking, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)
+            SAVINGS = T.let(:savings, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)
+
+            sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol]) }
+            def self.values; end
+          end
+        end
+
+        class Department < FinchAPI::Internal::Type::BaseModel
+          # The department name.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # The parent department, if present.
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) }
+          attr_reader :parent
+
+          sig do
+            params(
+              parent: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Internal::AnyHash))
+            )
+              .void
+          end
+          attr_writer :parent
+
+          sig do
+            params(
+              name: T.nilable(String),
+              parent: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Internal::AnyHash))
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The department name.
+            name:,
+            # The parent department, if present.
+            parent:
+          ); end
+          sig do
+            override
+              .returns(
+                {name: T.nilable(String), parent: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)}
+              )
+          end
+          def to_hash; end
+
+          class Parent < FinchAPI::Internal::Type::BaseModel
+            # The parent department's name.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :name
+
+            # The parent department, if present.
+            sig { params(name: T.nilable(String)).returns(T.attached_class) }
+            def self.new(
+              # The parent department's name.
+              name:
+            ); end
+            sig { override.returns({name: T.nilable(String)}) }
+            def to_hash; end
+          end
+        end
+
+        class Entity < FinchAPI::Internal::Type::BaseModel
+          # The tax payer subtype of the company.
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) }
+          attr_accessor :subtype
+
+          # The tax payer type of the company.
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) }
+          attr_accessor :type
+
+          # The entity type object.
+          sig do
+            params(
+              subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::OrSymbol),
+              type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::OrSymbol)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The tax payer subtype of the company.
+            subtype:,
+            # The tax payer type of the company.
+            type:
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol),
+                  type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+                }
+              )
+          end
+          def to_hash; end
+
+          # The tax payer subtype of the company.
+          module Subtype
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            S_CORPORATION = T.let(:s_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)
+            C_CORPORATION = T.let(:c_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)
+            B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)
+
+            sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol]) }
+            def self.values; end
+          end
+
+          # The tax payer type of the company.
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LLC = T.let(:llc, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+            LP = T.let(:lp, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+            CORPORATION = T.let(:corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+            SOLE_PROPRIETOR =
+              T.let(:sole_proprietor, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+            NON_PROFIT = T.let(:non_profit, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+            PARTNERSHIP = T.let(:partnership, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+            COOPERATIVE = T.let(:cooperative, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)
+
+            sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol]) }
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end