finch-api 0.1.0.pre.alpha.1

data/rbi/lib/finch-api/models/hris/benefits_support.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitsSupport < FinchAPI::BaseModel
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def commuter
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def commuter=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def custom_post_tax
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def custom_post_tax=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def custom_pre_tax
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def custom_pre_tax=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def fsa_dependent_care
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def fsa_dependent_care=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def fsa_medical
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def fsa_medical=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def hsa_post
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def hsa_post=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def hsa_pre
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def hsa_pre=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def s125_dental
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def s125_dental=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def s125_medical
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def s125_medical=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def s125_vision
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def s125_vision=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def simple
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def simple=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
+        def simple_ira
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
+        end
+        def simple_ira=(_)
+        end
+
+        sig do
+          params(
+            commuter: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            custom_post_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            custom_pre_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            fsa_dependent_care: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            fsa_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            hsa_post: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            hsa_pre: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            s125_dental: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            s125_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            s125_vision: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            simple: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+            simple_ira: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)
+          )
+            .void
+        end
+        def initialize(
+          commuter: nil,
+          custom_post_tax: nil,
+          custom_pre_tax: nil,
+          fsa_dependent_care: nil,
+          fsa_medical: nil,
+          hsa_post: nil,
+          hsa_pre: nil,
+          s125_dental: nil,
+          s125_medical: nil,
+          s125_vision: nil,
+          simple: nil,
+          simple_ira: nil
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                commuter: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                custom_post_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                custom_pre_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                fsa_dependent_care: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                fsa_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                hsa_post: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                hsa_pre: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                s125_dental: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                s125_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                s125_vision: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                simple: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
+                simple_ira: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi

@@ -0,0 +1,9 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      BenfitContribution = T.type_alias { FinchAPI::Models::HRIS::BenefitContribution }
+    end
+  end
+end

data/rbi/lib/finch-api/models/hris/company.rbi

@@ -0,0 +1,338 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class HRISCompany < FinchAPI::BaseModel
+        sig { returns(String) }
+        def id
+        end
+
+        sig { params(_: String).returns(String) }
+        def id=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account])) }
+        def accounts
+        end
+
+        sig do
+          params(_: T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account]))
+            .returns(T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account]))
+        end
+        def accounts=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) }
+        def departments
+        end
+
+        sig do
+          params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)]))
+            .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)]))
+        end
+        def departments=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def ein
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def ein=(_)
+        end
+
+        sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) }
+        def entity
+        end
+
+        sig do
+          params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity))
+            .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity))
+        end
+        def entity=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def legal_name
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def legal_name=(_)
+        end
+
+        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) }
+        def locations
+        end
+
+        sig do
+          params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]))
+            .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]))
+        end
+        def locations=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def primary_email
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def primary_email=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def primary_phone_number
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def primary_phone_number=(_)
+        end
+
+        sig do
+          params(
+            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)
+          )
+            .void
+        end
+        def initialize(
+          id:,
+          accounts:,
+          departments:,
+          ein:,
+          entity:,
+          legal_name:,
+          locations:,
+          primary_email:,
+          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::BaseModel
+          sig { returns(T.nilable(String)) }
+          def account_name
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def account_name=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def account_number
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def account_number=(_)
+          end
+
+          sig { returns(T.nilable(Symbol)) }
+          def account_type
+          end
+
+          sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+          def account_type=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def institution_name
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def institution_name=(_)
+          end
+
+          sig { returns(T.nilable(String)) }
+          def routing_number
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def routing_number=(_)
+          end
+
+          sig do
+            params(
+              account_name: T.nilable(String),
+              account_number: T.nilable(String),
+              account_type: T.nilable(Symbol),
+              institution_name: T.nilable(String),
+              routing_number: T.nilable(String)
+            )
+              .void
+          end
+          def initialize(
+            account_name: nil,
+            account_number: nil,
+            account_type: nil,
+            institution_name: nil,
+            routing_number: nil
+          )
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  account_name: T.nilable(String),
+                  account_number: T.nilable(String),
+                  account_type: T.nilable(Symbol),
+                  institution_name: T.nilable(String),
+                  routing_number: T.nilable(String)
+                }
+              )
+          end
+          def to_hash
+          end
+
+          class AccountType < FinchAPI::Enum
+            abstract!
+
+            CHECKING = T.let(:checking, T.nilable(Symbol))
+            SAVINGS = T.let(:savings, T.nilable(Symbol))
+
+            sig { override.returns(T::Array[Symbol]) }
+            def self.values
+            end
+          end
+        end
+
+        class Department < FinchAPI::BaseModel
+          sig { returns(T.nilable(String)) }
+          def name
+          end
+
+          sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+          def name=(_)
+          end
+
+          sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) }
+          def parent
+          end
+
+          sig do
+            params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent))
+              .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent))
+          end
+          def parent=(_)
+          end
+
+          sig do
+            params(
+              name: T.nilable(String),
+              parent: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)
+            )
+              .void
+          end
+          def initialize(name: nil, parent: nil)
+          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::BaseModel
+            sig { returns(T.nilable(String)) }
+            def name
+            end
+
+            sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+            def name=(_)
+            end
+
+            sig { params(name: T.nilable(String)).void }
+            def initialize(name: nil)
+            end
+
+            sig { override.returns({name: T.nilable(String)}) }
+            def to_hash
+            end
+          end
+        end
+
+        class Entity < FinchAPI::BaseModel
+          sig { returns(T.nilable(Symbol)) }
+          def subtype
+          end
+
+          sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+          def subtype=(_)
+          end
+
+          sig { returns(T.nilable(Symbol)) }
+          def type
+          end
+
+          sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+          def type=(_)
+          end
+
+          sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void }
+          def initialize(subtype: nil, type: nil)
+          end
+
+          sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) }
+          def to_hash
+          end
+
+          class Subtype < FinchAPI::Enum
+            abstract!
+
+            S_CORPORATION = T.let(:s_corporation, T.nilable(Symbol))
+            C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol))
+            B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol))
+
+            sig { override.returns(T::Array[Symbol]) }
+            def self.values
+            end
+          end
+
+          class Type < FinchAPI::Enum
+            abstract!
+
+            LLC = T.let(:llc, T.nilable(Symbol))
+            LP = T.let(:lp, T.nilable(Symbol))
+            CORPORATION = T.let(:corporation, T.nilable(Symbol))
+            SOLE_PROPRIETOR = T.let(:sole_proprietor, T.nilable(Symbol))
+            NON_PROFIT = T.let(:non_profit, T.nilable(Symbol))
+            PARTNERSHIP = T.let(:partnership, T.nilable(Symbol))
+            COOPERATIVE = T.let(:cooperative, T.nilable(Symbol))
+
+            sig { override.returns(T::Array[Symbol]) }
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/models/hris/company_benefit.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class CompanyBenefit < FinchAPI::BaseModel
+        sig { returns(String) }
+        def benefit_id
+        end
+
+        sig { params(_: String).returns(String) }
+        def benefit_id=(_)
+        end
+
+        sig { returns(T.nilable(String)) }
+        def description
+        end
+
+        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
+        def description=(_)
+        end
+
+        sig { returns(T.nilable(Symbol)) }
+        def frequency
+        end
+
+        sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+        def frequency=(_)
+        end
+
+        sig { returns(T.nilable(Symbol)) }
+        def type
+        end
+
+        sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
+        def type=(_)
+        end
+
+        sig do
+          params(
+            benefit_id: String,
+            description: T.nilable(String),
+            frequency: T.nilable(Symbol),
+            type: T.nilable(Symbol)
+          )
+            .void
+        end
+        def initialize(benefit_id:, description:, frequency:, type:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                benefit_id: String,
+                description: T.nilable(String),
+                frequency: T.nilable(Symbol),
+                type: T.nilable(Symbol)
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class CompanyRetrieveParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void }
+        def initialize(request_options: {})
+        end
+
+        sig { override.returns({request_options: FinchAPI::RequestOptions}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class CreateCompanyBenefitsResponse < FinchAPI::BaseModel
+        sig { returns(String) }
+        def benefit_id
+        end
+
+        sig { params(_: String).returns(String) }
+        def benefit_id=(_)
+        end
+
+        sig { params(benefit_id: String).void }
+        def initialize(benefit_id:)
+        end
+
+        sig { override.returns({benefit_id: String}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DirectoryListIndividualsParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        sig { returns(T.nilable(Integer)) }
+        def limit
+        end
+
+        sig { params(_: Integer).returns(Integer) }
+        def limit=(_)
+        end
+
+        sig { returns(T.nilable(Integer)) }
+        def offset
+        end
+
+        sig { params(_: Integer).returns(Integer) }
+        def offset=(_)
+        end
+
+        sig do
+          params(
+            limit: Integer,
+            offset: Integer,
+            request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])
+          )
+            .void
+        end
+        def initialize(limit: nil, offset: nil, request_options: {})
+        end
+
+        sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end