finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/models/hris/benefits/unenrolled_individual.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        class UnenrolledIndividual < FinchAPI::BaseModel
+          # @!attribute [r] body
+          #
+          #   @return [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, nil]
+          optional :body, -> { FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body }
+
+          # @!parse
+          #   # @return [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body]
+          #   attr_writer :body
+
+          # @!attribute [r] code
+          #   HTTP status code
+          #
+          #   @return [Integer, nil]
+          optional :code, Integer
+
+          # @!parse
+          #   # @return [Integer]
+          #   attr_writer :code
+
+          # @!attribute [r] individual_id
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :individual_id
+
+          # @!parse
+          #   # @param body [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body]
+          #   # @param code [Integer]
+          #   # @param individual_id [String]
+          #   #
+          #   def initialize(body: nil, code: nil, individual_id: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          class Body < FinchAPI::BaseModel
+            # @!attribute finch_code
+            #   A descriptive identifier for the response.
+            #
+            #   @return [String, nil]
+            optional :finch_code, String, nil?: true
+
+            # @!attribute message
+            #   Short description in English that provides more information about the response.
+            #
+            #   @return [String, nil]
+            optional :message, String, nil?: true
+
+            # @!attribute name
+            #   Identifier indicating whether the benefit was newly enrolled or updated.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!parse
+            #   # @param finch_code [String, nil]
+            #   # @param message [String, nil]
+            #   # @param name [String, nil]
+            #   #
+            #   def initialize(finch_code: nil, message: nil, name: nil, **) = super
+
+            # def initialize: (Hash | FinchAPI::BaseModel) -> void
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class BenefitsSupport < FinchAPI::BaseModel
+        # @!attribute commuter
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :commuter, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute custom_post_tax
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :custom_post_tax, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute custom_pre_tax
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :custom_pre_tax, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute fsa_dependent_care
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :fsa_dependent_care, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute fsa_medical
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :fsa_medical, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute hsa_post
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :hsa_post, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute hsa_pre
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :hsa_pre, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute s125_dental
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :s125_dental, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute s125_medical
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :s125_medical, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute s125_vision
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :s125_vision, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute simple
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :simple, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!attribute simple_ira
+        #
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        optional :simple_ira, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true
+
+        # @!parse
+        #   # Each benefit type and their supported features. If the benefit type is not
+        #   #   supported, the property will be null
+        #   #
+        #   # @param commuter [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param custom_post_tax [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param custom_pre_tax [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param fsa_dependent_care [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param fsa_medical [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param hsa_post [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param hsa_pre [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param s125_dental [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param s125_medical [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param s125_vision [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param simple [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   # @param simple_ira [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
+        #   #
+        #   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,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      BenfitContribution = FinchAPI::Models::HRIS::BenefitContribution
+    end
+  end
+end

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

@@ -0,0 +1,290 @@
+# 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
+
+          # @abstract
+          #
+          # The type of bank account.
+          #
+          # @example
+          # ```ruby
+          # case account_type
+          # in :checking
+          #   # ...
+          # in :savings
+          #   # ...
+          # end
+          # ```
+          class AccountType < 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
+
+          # @abstract
+          #
+          # The tax payer subtype of the company.
+          #
+          # @example
+          # ```ruby
+          # case subtype
+          # in :s_corporation
+          #   # ...
+          # in :c_corporation
+          #   # ...
+          # in :b_corporation
+          #   # ...
+          # end
+          # ```
+          class Subtype < FinchAPI::Enum
+            S_CORPORATION = :s_corporation
+            C_CORPORATION = :c_corporation
+            B_CORPORATION = :b_corporation
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+
+          # @abstract
+          #
+          # The tax payer type of the company.
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :llc
+          #   # ...
+          # in :lp
+          #   # ...
+          # in :corporation
+          #   # ...
+          # in :sole_proprietor
+          #   # ...
+          # in :non_profit
+          #   # ...
+          # in ...
+          #   #...
+          # end
+          # ```
+          class Type < 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

@@ -0,0 +1,40 @@
+# 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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class CompanyRetrieveParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DirectoryListIndividualsParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DirectoryListParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::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