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

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

@@ -1,48 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class CompanyBenefit < FinchAPI::BaseModel
-        sig { returns(String) }
-        attr_accessor :benefit_id
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) }
-        attr_accessor :frequency
-
-        # Type of benefit.
-        sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) }
-        attr_accessor :type
-
-        sig do
-          params(
-            benefit_id: String,
-            description: T.nilable(String),
-            frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol),
-            type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(benefit_id:, description:, frequency:, type:)
-        end
-
-        sig do
-          override
-            .returns(
-              {
-                benefit_id: String,
-                description: T.nilable(String),
-                frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol),
-                type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)
-              }
-            )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class CompanyRetrieveParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        sig do
-          params(
-            request_options: T.any(
-              FinchAPI::RequestOptions,
-              FinchAPI::Util::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/lib/finch-api/models/hris/create_company_benefits_response.rbi

@@ -1,20 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class CreateCompanyBenefitsResponse < FinchAPI::BaseModel
-        sig { returns(String) }
-        attr_accessor :benefit_id
-
-        sig { params(benefit_id: String).returns(T.attached_class) }
-        def self.new(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

@@ -1,41 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DirectoryListIndividualsParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # Number of employees to return (defaults to all)
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :limit
-
-        sig { params(limit: Integer).void }
-        attr_writer :limit
-
-        # Index to start from (defaults to 0)
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :offset
-
-        sig { params(offset: Integer).void }
-        attr_writer :offset
-
-        sig do
-          params(
-            limit: Integer,
-            offset: Integer,
-            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(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

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

@@ -1,41 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DirectoryListParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # Number of employees to return (defaults to all)
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :limit
-
-        sig { params(limit: Integer).void }
-        attr_writer :limit
-
-        # Index to start from (defaults to 0)
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :offset
-
-        sig { params(offset: Integer).void }
-        attr_writer :offset
-
-        sig do
-          params(
-            limit: Integer,
-            offset: Integer,
-            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(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

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

@@ -1,84 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentListParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # Comma-delimited list of stable Finch uuids for each individual. If empty,
-        #   defaults to all individuals
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :individual_ids
-
-        sig { params(individual_ids: T::Array[String]).void }
-        attr_writer :individual_ids
-
-        # Number of documents to return (defaults to all)
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :limit
-
-        sig { params(limit: Integer).void }
-        attr_writer :limit
-
-        # Index to start from (defaults to 0)
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :offset
-
-        sig { params(offset: Integer).void }
-        attr_writer :offset
-
-        # Comma-delimited list of document types to filter on. If empty, defaults to all
-        #   types
-        sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol])) }
-        attr_reader :types
-
-        sig { params(types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]).void }
-        attr_writer :types
-
-        sig do
-          params(
-            individual_ids: T::Array[String],
-            limit: Integer,
-            offset: Integer,
-            types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol],
-            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
-        end
-
-        sig do
-          override
-            .returns(
-              {
-                individual_ids: T::Array[String],
-                limit: Integer,
-                offset: Integer,
-                types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol],
-                request_options: FinchAPI::RequestOptions
-              }
-            )
-        end
-        def to_hash
-        end
-
-        module Type
-          extend FinchAPI::Enum
-
-          TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type) }
-          OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) }
-
-          W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol)
-          W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol)
-
-          sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol]) }
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentListResponse < FinchAPI::BaseModel
-        sig { returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse]) }
-        attr_accessor :documents
-
-        sig { returns(FinchAPI::Models::Paging) }
-        attr_reader :paging
-
-        sig { params(paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)).void }
-        attr_writer :paging
-
-        sig do
-          params(
-            documents: T::Array[T.any(FinchAPI::Models::HRIS::DocumentResponse, FinchAPI::Util::AnyHash)],
-            paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(documents:, paging:)
-        end
-
-        sig do
-          override
-            .returns({documents: T::Array[FinchAPI::Models::HRIS::DocumentResponse], paging: FinchAPI::Models::Paging})
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentResponse < FinchAPI::BaseModel
-        # A stable Finch id for the document.
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        # The ID of the individual associated with the document. This will be null for
-        #   employer-level documents.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :individual_id
-
-        # The type of document.
-        sig { returns(T.nilable(FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol)) }
-        attr_reader :type
-
-        sig { params(type: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol).void }
-        attr_writer :type
-
-        # A URL to access the document. Format:
-        #   `https://api.tryfinch.com/employer/documents/:document_id`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :url
-
-        sig { params(url: String).void }
-        attr_writer :url
-
-        # The year the document applies to, if available.
-        sig { returns(T.nilable(Float)) }
-        attr_accessor :year
-
-        sig do
-          params(
-            id: String,
-            individual_id: T.nilable(String),
-            type: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol,
-            url: String,
-            year: T.nilable(Float)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(id: nil, individual_id: nil, type: nil, url: nil, year: nil)
-        end
-
-        sig do
-          override
-            .returns(
-              {
-                id: String,
-                individual_id: T.nilable(String),
-                type: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol,
-                url: String,
-                year: T.nilable(Float)
-              }
-            )
-        end
-        def to_hash
-        end
-
-        # The type of document.
-        module Type
-          extend FinchAPI::Enum
-
-          TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type) }
-          OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) }
-
-          W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol)
-          W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol)
-
-          sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol]) }
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentRetreiveParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        sig do
-          params(
-            request_options: T.any(
-              FinchAPI::RequestOptions,
-              FinchAPI::Util::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/lib/finch-api/models/hris/document_retreive_response.rbi

@@ -1,17 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      # A 2020 version of the W-4 tax form containing information on an individual's
-      #   filing status, dependents, and withholding details.
-      module DocumentRetreiveResponse
-        extend FinchAPI::Union
-
-        sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) }
-        def self.variants
-        end
-      end
-    end
-  end
-end