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

data/lib/finch_api/models/hris/company.rb

@@ -14,17 +14,19 @@ module FinchAPI
         # @!attribute accounts
         #   An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil]
+        #   @return [Array<FinchAPI::HRIS::HRISCompany::Account>, nil]
         required :accounts,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Account] },
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Account] },
                  nil?: true
 
         # @!attribute departments
         #   The array of company departments.
         #
-        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil]
+        #   @return [Array<FinchAPI::HRIS::HRISCompany::Department, nil>, nil]
         required :departments,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Department, nil?: true] },
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Department, nil?: true]
+                 },
                  nil?: true
 
         # @!attribute ein
@@ -36,8 +38,8 @@ module FinchAPI
         # @!attribute entity
         #   The entity type object.
         #
-        #   @return [FinchAPI::Models::HRIS::HRISCompany::Entity, nil]
-        required :entity, -> { FinchAPI::Models::HRIS::HRISCompany::Entity }, nil?: true
+        #   @return [FinchAPI::HRIS::HRISCompany::Entity, nil]
+        required :entity, -> { FinchAPI::HRIS::HRISCompany::Entity }, nil?: true
 
         # @!attribute legal_name
         #   The legal name of the company.
@@ -47,9 +49,11 @@ module FinchAPI
 
         # @!attribute locations
         #
-        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
+        #   @return [Array<FinchAPI::Location, nil>, nil]
         required :locations,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] },
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
+                 },
                  nil?: true
 
         # @!attribute primary_email
@@ -67,26 +71,25 @@ module FinchAPI
 
         # @!method initialize(id:, accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:)
         #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::Models::HRIS::HRISCompany} for more details.
+        #   {FinchAPI::HRIS::HRISCompany} for more details.
         #
         #   @param id [String] A stable Finch `id` (UUID v4) for the company.
         #
-        #   @param accounts [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        #   @param accounts [Array<FinchAPI::HRIS::HRISCompany::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @param departments [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil] The array of company departments.
+        #   @param departments [Array<FinchAPI::HRIS::HRISCompany::Department, nil>, nil] The array of company departments.
         #
         #   @param ein [String, nil] The employer identification number.
         #
-        #   @param entity [FinchAPI::Models::HRIS::HRISCompany::Entity, nil] The entity type object.
+        #   @param entity [FinchAPI::HRIS::HRISCompany::Entity, nil] The entity type object.
         #
         #   @param legal_name [String, nil] The legal name of the company.
         #
-        #   @param locations [Array<FinchAPI::Models::Location, nil>, nil]
+        #   @param locations [Array<FinchAPI::Location, nil>, nil]
         #
         #   @param primary_email [String, nil] The email of the main administrator on the account.
         #
         #   @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
-        #   ...
 
         class Account < FinchAPI::Internal::Type::BaseModel
           # @!attribute account_name
@@ -104,8 +107,8 @@ module FinchAPI
           # @!attribute account_type
           #   The type of bank account.
           #
-          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil]
-          required :account_type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Account::AccountType }, nil?: true
+          #   @return [Symbol, FinchAPI::HRIS::HRISCompany::Account::AccountType, nil]
+          required :account_type, enum: -> { FinchAPI::HRIS::HRISCompany::Account::AccountType }, nil?: true
 
           # @!attribute institution_name
           #   Name of the banking institution.
@@ -122,22 +125,21 @@ module FinchAPI
 
           # @!method initialize(account_name:, account_number:, account_type:, institution_name:, routing_number:)
           #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::Models::HRIS::HRISCompany::Account} for more details.
+          #   {FinchAPI::HRIS::HRISCompany::Account} for more details.
           #
           #   @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system.
           #
           #   @param account_number [String, nil] 10-12 digit number to specify the bank account
           #
-          #   @param account_type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account.
+          #   @param account_type [Symbol, FinchAPI::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account.
           #
           #   @param institution_name [String, nil] Name of the banking institution.
           #
           #   @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was
-          #   ...
 
           # The type of bank account.
           #
-          # @see FinchAPI::Models::HRIS::HRISCompany::Account#account_type
+          # @see FinchAPI::HRIS::HRISCompany::Account#account_type
           module AccountType
             extend FinchAPI::Internal::Type::Enum
 
@@ -159,15 +161,15 @@ module FinchAPI
           # @!attribute parent
           #   The parent department, if present.
           #
-          #   @return [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil]
-          required :parent, -> { FinchAPI::Models::HRIS::HRISCompany::Department::Parent }, nil?: true
+          #   @return [FinchAPI::HRIS::HRISCompany::Department::Parent, nil]
+          required :parent, -> { FinchAPI::HRIS::HRISCompany::Department::Parent }, nil?: true
 
           # @!method initialize(name:, parent:)
           #   @param name [String, nil] The department name.
           #
-          #   @param parent [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present.
+          #   @param parent [FinchAPI::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present.
 
-          # @see FinchAPI::Models::HRIS::HRISCompany::Department#parent
+          # @see FinchAPI::HRIS::HRISCompany::Department#parent
           class Parent < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
             #   The parent department's name.
@@ -182,30 +184,30 @@ module FinchAPI
           end
         end
 
-        # @see FinchAPI::Models::HRIS::HRISCompany#entity
+        # @see FinchAPI::HRIS::HRISCompany#entity
         class Entity < FinchAPI::Internal::Type::BaseModel
           # @!attribute subtype
           #   The tax payer subtype of the company.
           #
-          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil]
-          required :subtype, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype }, nil?: true
+          #   @return [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Subtype, nil]
+          required :subtype, enum: -> { FinchAPI::HRIS::HRISCompany::Entity::Subtype }, nil?: true
 
           # @!attribute type
           #   The tax payer type of the company.
           #
-          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil]
-          required :type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Type }, nil?: true
+          #   @return [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Type, nil]
+          required :type, enum: -> { FinchAPI::HRIS::HRISCompany::Entity::Type }, nil?: true
 
           # @!method initialize(subtype:, type:)
           #   The entity type object.
           #
-          #   @param subtype [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company.
+          #   @param subtype [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company.
           #
-          #   @param type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company.
+          #   @param type [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company.
 
           # The tax payer subtype of the company.
           #
-          # @see FinchAPI::Models::HRIS::HRISCompany::Entity#subtype
+          # @see FinchAPI::HRIS::HRISCompany::Entity#subtype
           module Subtype
             extend FinchAPI::Internal::Type::Enum
 
@@ -219,7 +221,7 @@ module FinchAPI
 
           # The tax payer type of the company.
           #
-          # @see FinchAPI::Models::HRIS::HRISCompany::Entity#type
+          # @see FinchAPI::HRIS::HRISCompany::Entity#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/hris/company_benefit.rb

@@ -14,10 +14,8 @@ module FinchAPI
         # @!attribute company_contribution
         #   The company match for this benefit.
         #
-        #   @return [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil]
-        required :company_contribution,
-                 -> { FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution },
-                 nil?: true
+        #   @return [FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil]
+        required :company_contribution, -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution }, nil?: true
 
         # @!attribute description
         #
@@ -27,44 +25,46 @@ module FinchAPI
         # @!attribute frequency
         #   The frequency of the benefit deduction/contribution.
         #
-        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
-        required :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true
+        #   @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil]
+        required :frequency, enum: -> { FinchAPI::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
+        #   @return [Symbol, FinchAPI::HRIS::BenefitType, nil]
+        required :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
 
         # @!method initialize(benefit_id:, company_contribution:, description:, frequency:, type:)
         #   @param benefit_id [String] The id of the benefit.
         #
-        #   @param company_contribution [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit.
+        #   @param company_contribution [FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit.
         #
         #   @param description [String, nil]
         #
-        #   @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
+        #   @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
         #
-        #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
+        #   @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit.
 
-        # @see FinchAPI::Models::HRIS::CompanyBenefit#company_contribution
+        # @see FinchAPI::HRIS::CompanyBenefit#company_contribution
         class CompanyContribution < FinchAPI::Internal::Type::BaseModel
           # @!attribute tiers
           #
-          #   @return [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>, nil]
+          #   @return [Array<FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier>, nil]
           optional :tiers,
-                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier] }
+                   -> {
+                     FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]
+                   }
 
           # @!attribute type
           #
-          #   @return [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type, nil]
-          optional :type, enum: -> { FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type }
+          #   @return [Symbol, FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type, nil]
+          optional :type, enum: -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type }
 
           # @!method initialize(tiers: nil, type: nil)
           #   The company match for this benefit.
           #
-          #   @param tiers [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>]
-          #   @param type [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type]
+          #   @param tiers [Array<FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier>]
+          #   @param type [Symbol, FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type]
 
           class Tier < FinchAPI::Internal::Type::BaseModel
             # @!attribute match
@@ -82,7 +82,7 @@ module FinchAPI
             #   @param threshold [Integer]
           end
 
-          # @see FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution#type
+          # @see FinchAPI::HRIS::CompanyBenefit::CompanyContribution#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/hris/document_list_params.rb

@@ -31,23 +31,23 @@ module FinchAPI
         #   Comma-delimited list of document types to filter on. If empty, defaults to all
         #   types
         #
-        #   @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil]
+        #   @return [Array<Symbol, FinchAPI::HRIS::DocumentListParams::Type>, nil]
         optional :types,
-                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::DocumentListParams::Type] }
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::DocumentListParams::Type]
+                 }
 
         # @!method initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::DocumentListParams} for more details.
         #
         #   @param individual_ids [Array<String>] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul
-        #   ...
         #
         #   @param limit [Integer] Number of documents to return (defaults to all)
         #
         #   @param offset [Integer] Index to start from (defaults to 0)
         #
-        #   @param types [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
-        #   ...
+        #   @param types [Array<Symbol, FinchAPI::HRIS::DocumentListParams::Type>] Comma-delimited list of document types to filter on. If empty, defaults to all t
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/finch_api/models/hris/document_list_response.rb

@@ -7,17 +7,17 @@ module FinchAPI
       class DocumentListResponse < FinchAPI::Internal::Type::BaseModel
         # @!attribute documents
         #
-        #   @return [Array<FinchAPI::Models::HRIS::DocumentResponse>]
-        required :documents, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::DocumentResponse] }
+        #   @return [Array<FinchAPI::HRIS::DocumentResponse>]
+        required :documents, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::DocumentResponse] }
 
         # @!attribute paging
         #
-        #   @return [FinchAPI::Models::Paging]
-        required :paging, -> { FinchAPI::Models::Paging }
+        #   @return [FinchAPI::Paging]
+        required :paging, -> { FinchAPI::Paging }
 
         # @!method initialize(documents:, paging:)
-        #   @param documents [Array<FinchAPI::Models::HRIS::DocumentResponse>]
-        #   @param paging [FinchAPI::Models::Paging]
+        #   @param documents [Array<FinchAPI::HRIS::DocumentResponse>]
+        #   @param paging [FinchAPI::Paging]
       end
     end
   end

data/lib/finch_api/models/hris/document_response.rb

@@ -20,8 +20,8 @@ module FinchAPI
         # @!attribute type
         #   The type of document.
         #
-        #   @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil]
-        optional :type, enum: -> { FinchAPI::Models::HRIS::DocumentResponse::Type }
+        #   @return [Symbol, FinchAPI::HRIS::DocumentResponse::Type, nil]
+        optional :type, enum: -> { FinchAPI::HRIS::DocumentResponse::Type }
 
         # @!attribute url
         #   A URL to access the document. Format:
@@ -38,23 +38,21 @@ module FinchAPI
 
         # @!method initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil)
         #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::Models::HRIS::DocumentResponse} for more details.
+        #   {FinchAPI::HRIS::DocumentResponse} for more details.
         #
         #   @param id [String] A stable Finch id for the document.
         #
         #   @param individual_id [String, nil] The ID of the individual associated with the document. This will be null for emp
-        #   ...
         #
-        #   @param type [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type] The type of document.
+        #   @param type [Symbol, FinchAPI::HRIS::DocumentResponse::Type] The type of document.
         #
         #   @param url [String] A URL to access the document. Format: `https://api.tryfinch.com/employer/documen
-        #   ...
         #
         #   @param year [Float, nil] The year the document applies to, if available.
 
         # The type of document.
         #
-        # @see FinchAPI::Models::HRIS::DocumentResponse#type
+        # @see FinchAPI::HRIS::DocumentResponse#type
         module Type
           extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/hris/document_retreive_response.rb

@@ -13,13 +13,13 @@ module FinchAPI
         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 }
+        variant :w4_2020, -> { FinchAPI::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 }
+        variant :w4_2005, -> { FinchAPI::HRIS::W42005 }
 
         # @!method self.variants
-        #   @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)]
+        #   @return [Array(FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005)]
       end
     end
   end