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

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

@@ -1,247 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class HRISCompany < FinchAPI::BaseModel
-        # @!attribute id
-        #   A stable Finch `id` (UUID v4) for the company.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute accounts
-        #   An array of bank account objects associated with the payroll/HRIS system.
-        #
-        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil]
-        required :accounts, -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Account] }, nil?: true
-
-        # @!attribute departments
-        #   The array of company departments.
-        #
-        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil]
-        required :departments,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Department, nil?: true] },
-                 nil?: true
-
-        # @!attribute ein
-        #   The employer identification number.
-        #
-        #   @return [String, nil]
-        required :ein, String, nil?: true
-
-        # @!attribute entity
-        #   The entity type object.
-        #
-        #   @return [FinchAPI::Models::HRIS::HRISCompany::Entity, nil]
-        required :entity, -> { FinchAPI::Models::HRIS::HRISCompany::Entity }, nil?: true
-
-        # @!attribute legal_name
-        #   The legal name of the company.
-        #
-        #   @return [String, nil]
-        required :legal_name, String, nil?: true
-
-        # @!attribute locations
-        #
-        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
-        required :locations, -> { FinchAPI::ArrayOf[FinchAPI::Models::Location, nil?: true] }, nil?: true
-
-        # @!attribute primary_email
-        #   The email of the main administrator on the account.
-        #
-        #   @return [String, nil]
-        required :primary_email, String, nil?: true
-
-        # @!attribute primary_phone_number
-        #   The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
-        #
-        #   @return [String, nil]
-        required :primary_phone_number, String, nil?: true
-
-        # @!parse
-        #   # @param id [String]
-        #   # @param accounts [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil]
-        #   # @param departments [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil]
-        #   # @param ein [String, nil]
-        #   # @param entity [FinchAPI::Models::HRIS::HRISCompany::Entity, nil]
-        #   # @param legal_name [String, nil]
-        #   # @param locations [Array<FinchAPI::Models::Location, nil>, nil]
-        #   # @param primary_email [String, nil]
-        #   # @param primary_phone_number [String, nil]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     accounts:,
-        #     departments:,
-        #     ein:,
-        #     entity:,
-        #     legal_name:,
-        #     locations:,
-        #     primary_email:,
-        #     primary_phone_number:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class Account < FinchAPI::BaseModel
-          # @!attribute account_name
-          #   The name of the bank associated in the payroll/HRIS system.
-          #
-          #   @return [String, nil]
-          optional :account_name, String, nil?: true
-
-          # @!attribute account_number
-          #   10-12 digit number to specify the bank account
-          #
-          #   @return [String, nil]
-          optional :account_number, String, nil?: true
-
-          # @!attribute account_type
-          #   The type of bank account.
-          #
-          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil]
-          optional :account_type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Account::AccountType }, nil?: true
-
-          # @!attribute institution_name
-          #   Name of the banking institution.
-          #
-          #   @return [String, nil]
-          optional :institution_name, String, nil?: true
-
-          # @!attribute routing_number
-          #   A nine-digit code that's based on the U.S. Bank location where your account was
-          #     opened.
-          #
-          #   @return [String, nil]
-          optional :routing_number, String, nil?: true
-
-          # @!parse
-          #   # @param account_name [String, nil]
-          #   # @param account_number [String, nil]
-          #   # @param account_type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil]
-          #   # @param institution_name [String, nil]
-          #   # @param routing_number [String, nil]
-          #   #
-          #   def initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          # The type of bank account.
-          module AccountType
-            extend FinchAPI::Enum
-
-            CHECKING = :checking
-            SAVINGS = :savings
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-
-        class Department < FinchAPI::BaseModel
-          # @!attribute name
-          #   The department name.
-          #
-          #   @return [String, nil]
-          optional :name, String, nil?: true
-
-          # @!attribute parent
-          #   The parent department, if present.
-          #
-          #   @return [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil]
-          optional :parent, -> { FinchAPI::Models::HRIS::HRISCompany::Department::Parent }, nil?: true
-
-          # @!parse
-          #   # @param name [String, nil]
-          #   # @param parent [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil]
-          #   #
-          #   def initialize(name: nil, parent: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Parent < FinchAPI::BaseModel
-            # @!attribute name
-            #   The parent department's name.
-            #
-            #   @return [String, nil]
-            optional :name, String, nil?: true
-
-            # @!parse
-            #   # The parent department, if present.
-            #   #
-            #   # @param name [String, nil]
-            #   #
-            #   def initialize(name: nil, **) = super
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-          end
-        end
-
-        class Entity < FinchAPI::BaseModel
-          # @!attribute subtype
-          #   The tax payer subtype of the company.
-          #
-          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil]
-          optional :subtype, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype }, nil?: true
-
-          # @!attribute type
-          #   The tax payer type of the company.
-          #
-          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil]
-          optional :type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Type }, nil?: true
-
-          # @!parse
-          #   # The entity type object.
-          #   #
-          #   # @param subtype [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil]
-          #   # @param type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil]
-          #   #
-          #   def initialize(subtype: nil, type: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          # The tax payer subtype of the company.
-          module Subtype
-            extend FinchAPI::Enum
-
-            S_CORPORATION = :s_corporation
-            C_CORPORATION = :c_corporation
-            B_CORPORATION = :b_corporation
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-
-          # The tax payer type of the company.
-          module Type
-            extend FinchAPI::Enum
-
-            LLC = :llc
-            LP = :lp
-            CORPORATION = :corporation
-            SOLE_PROPRIETOR = :sole_proprietor
-            NON_PROFIT = :non_profit
-            PARTNERSHIP = :partnership
-            COOPERATIVE = :cooperative
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class CompanyBenefit < FinchAPI::BaseModel
-        # @!attribute benefit_id
-        #
-        #   @return [String]
-        required :benefit_id, String
-
-        # @!attribute description
-        #
-        #   @return [String, nil]
-        required :description, String, nil?: true
-
-        # @!attribute frequency
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
-        required :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true
-
-        # @!attribute type
-        #   Type of benefit.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
-        required :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
-
-        # @!parse
-        #   # @param benefit_id [String]
-        #   # @param description [String, nil]
-        #   # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
-        #   # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
-        #   #
-        #   def initialize(benefit_id:, description:, frequency:, type:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class CompanyRetrieveParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!parse
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class CreateCompanyBenefitsResponse < FinchAPI::BaseModel
-        # @!attribute benefit_id
-        #
-        #   @return [String]
-        required :benefit_id, String
-
-        # @!parse
-        #   # @param benefit_id [String]
-        #   #
-        #   def initialize(benefit_id:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DirectoryListIndividualsParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute [r] limit
-        #   Number of employees to return (defaults to all)
-        #
-        #   @return [Integer, nil]
-        optional :limit, Integer
-
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :limit
-
-        # @!attribute [r] offset
-        #   Index to start from (defaults to 0)
-        #
-        #   @return [Integer, nil]
-        optional :offset, Integer
-
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :offset
-
-        # @!parse
-        #   # @param limit [Integer]
-        #   # @param offset [Integer]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(limit: nil, offset: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DirectoryListParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute [r] limit
-        #   Number of employees to return (defaults to all)
-        #
-        #   @return [Integer, nil]
-        optional :limit, Integer
-
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :limit
-
-        # @!attribute [r] offset
-        #   Index to start from (defaults to 0)
-        #
-        #   @return [Integer, nil]
-        optional :offset, Integer
-
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :offset
-
-        # @!parse
-        #   # @param limit [Integer]
-        #   # @param offset [Integer]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(limit: nil, offset: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentListParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute [r] individual_ids
-        #   Comma-delimited list of stable Finch uuids for each individual. If empty,
-        #     defaults to all individuals
-        #
-        #   @return [Array<String>, nil]
-        optional :individual_ids, FinchAPI::ArrayOf[String]
-
-        # @!parse
-        #   # @return [Array<String>]
-        #   attr_writer :individual_ids
-
-        # @!attribute [r] limit
-        #   Number of documents to return (defaults to all)
-        #
-        #   @return [Integer, nil]
-        optional :limit, Integer
-
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :limit
-
-        # @!attribute [r] offset
-        #   Index to start from (defaults to 0)
-        #
-        #   @return [Integer, nil]
-        optional :offset, Integer
-
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :offset
-
-        # @!attribute [r] types
-        #   Comma-delimited list of document types to filter on. If empty, defaults to all
-        #     types
-        #
-        #   @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil]
-        optional :types, -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::DocumentListParams::Type] }
-
-        # @!parse
-        #   # @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>]
-        #   attr_writer :types
-
-        # @!parse
-        #   # @param individual_ids [Array<String>]
-        #   # @param limit [Integer]
-        #   # @param offset [Integer]
-        #   # @param types [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        module Type
-          extend FinchAPI::Enum
-
-          W4_2020 = :w4_2020
-          W4_2005 = :w4_2005
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentListResponse < FinchAPI::BaseModel
-        # @!attribute documents
-        #
-        #   @return [Array<FinchAPI::Models::HRIS::DocumentResponse>]
-        required :documents, -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::DocumentResponse] }
-
-        # @!attribute paging
-        #
-        #   @return [FinchAPI::Models::Paging]
-        required :paging, -> { FinchAPI::Models::Paging }
-
-        # @!parse
-        #   # @param documents [Array<FinchAPI::Models::HRIS::DocumentResponse>]
-        #   # @param paging [FinchAPI::Models::Paging]
-        #   #
-        #   def initialize(documents:, paging:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

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

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentResponse < FinchAPI::BaseModel
-        # @!attribute [r] id
-        #   A stable Finch id for the document.
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :id
-
-        # @!attribute individual_id
-        #   The ID of the individual associated with the document. This will be null for
-        #     employer-level documents.
-        #
-        #   @return [String, nil]
-        optional :individual_id, String, nil?: true
-
-        # @!attribute [r] type
-        #   The type of document.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil]
-        optional :type, enum: -> { FinchAPI::Models::HRIS::DocumentResponse::Type }
-
-        # @!parse
-        #   # @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type]
-        #   attr_writer :type
-
-        # @!attribute [r] url
-        #   A URL to access the document. Format:
-        #     `https://api.tryfinch.com/employer/documents/:document_id`.
-        #
-        #   @return [String, nil]
-        optional :url, String
-
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :url
-
-        # @!attribute year
-        #   The year the document applies to, if available.
-        #
-        #   @return [Float, nil]
-        optional :year, Float, nil?: true
-
-        # @!parse
-        #   # @param id [String]
-        #   # @param individual_id [String, nil]
-        #   # @param type [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type]
-        #   # @param url [String]
-        #   # @param year [Float, nil]
-        #   #
-        #   def initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        # The type of document.
-        module Type
-          extend FinchAPI::Enum
-
-          W4_2020 = :w4_2020
-          W4_2005 = :w4_2005
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class DocumentRetreiveParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!parse
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/hris/document_retreive_response.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-        discriminator :type
-
-        # A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.
-        variant :w4_2020, -> { FinchAPI::Models::HRIS::W42020 }
-
-        # A 2005 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.
-        variant :w4_2005, -> { FinchAPI::Models::HRIS::W42005 }
-
-        # @!parse
-        #   # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)]
-        #   def self.variants; end
-      end
-    end
-  end
-end