finch-api 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class PayStatementDataSyncInProgress < FinchAPI::Internal::Type::BaseModel
+        # @!attribute code
+        #
+        #   @return [Float, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::Code]
+        required :code, enum: -> { FinchAPI::HRIS::PayStatementDataSyncInProgress::Code }
+
+        # @!attribute finch_code
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::FinchCode]
+        required :finch_code, enum: -> { FinchAPI::HRIS::PayStatementDataSyncInProgress::FinchCode }
+
+        # @!attribute message
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::Message]
+        required :message, enum: -> { FinchAPI::HRIS::PayStatementDataSyncInProgress::Message }
+
+        # @!attribute name
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::Name]
+        required :name, enum: -> { FinchAPI::HRIS::PayStatementDataSyncInProgress::Name }
+
+        # @!method initialize(code:, finch_code:, message:, name:)
+        #   @param code [Float, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::Code]
+        #   @param finch_code [Symbol, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::FinchCode]
+        #   @param message [Symbol, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::Message]
+        #   @param name [Symbol, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress::Name]
+
+        # @see FinchAPI::Models::HRIS::PayStatementDataSyncInProgress#code
+        module Code
+          extend FinchAPI::Internal::Type::Enum
+
+          CODE_202 = 202
+
+          # @!method self.values
+          #   @return [Array<Float>]
+        end
+
+        # @see FinchAPI::Models::HRIS::PayStatementDataSyncInProgress#finch_code
+        module FinchCode
+          extend FinchAPI::Internal::Type::Enum
+
+          DATA_SYNC_IN_PROGRESS = :data_sync_in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see FinchAPI::Models::HRIS::PayStatementDataSyncInProgress#message
+        module Message
+          extend FinchAPI::Internal::Type::Enum
+
+          THE_PAY_STATEMENTS_FOR_THIS_PAYMENT_ARE_BEING_FETCHED_PLEASE_CHECK_BACK_LATER =
+            :"The pay statements for this payment are being fetched. Please check back later."
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see FinchAPI::Models::HRIS::PayStatementDataSyncInProgress#name
+        module Name
+          extend FinchAPI::Internal::Type::Enum
+
+          ACCEPTED = :accepted
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -7,23 +7,65 @@ module FinchAPI
       class PayStatementResponse < FinchAPI::Internal::Type::BaseModel
         # @!attribute body
         #
-        #   @return [FinchAPI::HRIS::PayStatementResponseBody, nil]
-        optional :body, -> { FinchAPI::HRIS::PayStatementResponseBody }
+        #   @return [FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Models::HRIS::PayStatementResponse::Body::BatchError, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress]
+        required :body, union: -> { FinchAPI::HRIS::PayStatementResponse::Body }
 
         # @!attribute code
         #
-        #   @return [Integer, nil]
-        optional :code, Integer
+        #   @return [Integer]
+        required :code, Integer
 
         # @!attribute payment_id
         #
-        #   @return [String, nil]
-        optional :payment_id, String
+        #   @return [String]
+        required :payment_id, String
 
-        # @!method initialize(body: nil, code: nil, payment_id: nil)
-        #   @param body [FinchAPI::HRIS::PayStatementResponseBody]
+        # @!method initialize(body:, code:, payment_id:)
+        #   @param body [FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Models::HRIS::PayStatementResponse::Body::BatchError, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress]
         #   @param code [Integer]
         #   @param payment_id [String]
+
+        # @see FinchAPI::Models::HRIS::PayStatementResponse#body
+        module Body
+          extend FinchAPI::Internal::Type::Union
+
+          variant -> { FinchAPI::HRIS::PayStatementResponseBody }
+
+          variant -> { FinchAPI::HRIS::PayStatementResponse::Body::BatchError }
+
+          variant -> { FinchAPI::HRIS::PayStatementDataSyncInProgress }
+
+          class BatchError < FinchAPI::Internal::Type::BaseModel
+            # @!attribute code
+            #
+            #   @return [Float]
+            required :code, Float
+
+            # @!attribute message
+            #
+            #   @return [String]
+            required :message, String
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute finch_code
+            #
+            #   @return [String, nil]
+            optional :finch_code, String
+
+            # @!method initialize(code:, message:, name:, finch_code: nil)
+            #   @param code [Float]
+            #   @param message [String]
+            #   @param name [String]
+            #   @param finch_code [String]
+          end
+
+          # @!method self.variants
+          #   @return [Array(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Models::HRIS::PayStatementResponse::Body::BatchError, FinchAPI::Models::HRIS::PayStatementDataSyncInProgress)]
+        end
       end
     end
   end

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

@@ -6,19 +6,37 @@ module FinchAPI
       class PayStatementResponseBody < FinchAPI::Internal::Type::BaseModel
         # @!attribute paging
         #
-        #   @return [FinchAPI::Paging, nil]
-        optional :paging, -> { FinchAPI::Paging }
+        #   @return [FinchAPI::Models::HRIS::PayStatementResponseBody::Paging]
+        required :paging, -> { FinchAPI::HRIS::PayStatementResponseBody::Paging }
 
         # @!attribute pay_statements
-        #   The array of pay statements for the current payment.
         #
-        #   @return [Array<FinchAPI::HRIS::PayStatement>, nil]
-        optional :pay_statements, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement] }
+        #   @return [Array<FinchAPI::Models::HRIS::PayStatement>]
+        required :pay_statements, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement] }
 
-        # @!method initialize(paging: nil, pay_statements: nil)
-        #   @param paging [FinchAPI::Paging]
-        #
-        #   @param pay_statements [Array<FinchAPI::HRIS::PayStatement>] The array of pay statements for the current payment.
+        # @!method initialize(paging:, pay_statements:)
+        #   @param paging [FinchAPI::Models::HRIS::PayStatementResponseBody::Paging]
+        #   @param pay_statements [Array<FinchAPI::Models::HRIS::PayStatement>]
+
+        # @see FinchAPI::Models::HRIS::PayStatementResponseBody#paging
+        class Paging < FinchAPI::Internal::Type::BaseModel
+          # @!attribute offset
+          #   The current start index of the returned list of elements
+          #
+          #   @return [Integer]
+          required :offset, Integer
+
+          # @!attribute count
+          #   The total number of elements for the entire query (not just the given page)
+          #
+          #   @return [Integer, nil]
+          optional :count, Integer
+
+          # @!method initialize(offset:, count: nil)
+          #   @param offset [Integer] The current start index of the returned list of elements
+          #
+          #   @param count [Integer] The total number of elements for the entire query (not just the given page)
+        end
       end
     end
   end

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

@@ -11,14 +11,14 @@ module FinchAPI
         # @!attribute requests
         #   The array of batch requests.
         #
-        #   @return [Array<FinchAPI::HRIS::PayStatementRetrieveManyParams::Request>]
+        #   @return [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>]
         required :requests,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
                  }
 
         # @!method initialize(requests:, request_options: {})
-        #   @param requests [Array<FinchAPI::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
+        #   @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -8,55 +8,55 @@ module FinchAPI
         # @!attribute id
         #   The unique id for the payment.
         #
-        #   @return [String, nil]
-        optional :id, String
+        #   @return [String]
+        required :id, String
 
         # @!attribute company_debit
         #
-        #   @return [FinchAPI::Money, nil]
-        optional :company_debit, -> { FinchAPI::Money }, nil?: true
+        #   @return [FinchAPI::Models::Money, nil]
+        required :company_debit, -> { FinchAPI::Money }, nil?: true
 
         # @!attribute debit_date
         #
         #   @return [String, nil]
-        optional :debit_date, String, nil?: true
+        required :debit_date, String, nil?: true
 
         # @!attribute employee_taxes
         #
-        #   @return [FinchAPI::Money, nil]
-        optional :employee_taxes, -> { FinchAPI::Money }, nil?: true
+        #   @return [FinchAPI::Models::Money, nil]
+        required :employee_taxes, -> { FinchAPI::Money }, nil?: true
 
         # @!attribute employer_taxes
         #
-        #   @return [FinchAPI::Money, nil]
-        optional :employer_taxes, -> { FinchAPI::Money }, nil?: true
+        #   @return [FinchAPI::Models::Money, nil]
+        required :employer_taxes, -> { FinchAPI::Money }, nil?: true
 
         # @!attribute gross_pay
         #
-        #   @return [FinchAPI::Money, nil]
-        optional :gross_pay, -> { FinchAPI::Money }, nil?: true
+        #   @return [FinchAPI::Models::Money, nil]
+        required :gross_pay, -> { FinchAPI::Money }, nil?: true
 
         # @!attribute individual_ids
         #   Array of every individual on this payment.
         #
         #   @return [Array<String>, nil]
-        optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true
+        required :individual_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true
 
         # @!attribute net_pay
         #
-        #   @return [FinchAPI::Money, nil]
-        optional :net_pay, -> { FinchAPI::Money }, nil?: true
+        #   @return [FinchAPI::Models::Money, nil]
+        required :net_pay, -> { FinchAPI::Money }, nil?: true
 
         # @!attribute pay_date
         #
         #   @return [String, nil]
-        optional :pay_date, String, nil?: true
+        required :pay_date, String, nil?: true
 
         # @!attribute pay_frequencies
         #   List of pay frequencies associated with this payment.
         #
-        #   @return [Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil]
-        optional :pay_frequencies,
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>, nil]
+        required :pay_frequencies,
                  -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Payment::PayFrequency] },
                  nil?: true
 
@@ -64,69 +64,69 @@ module FinchAPI
         #   Array of the Finch id (uuidv4) of every pay group associated with this payment.
         #
         #   @return [Array<String>, nil]
-        optional :pay_group_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true
+        required :pay_group_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true
 
         # @!attribute pay_period
         #   The pay period object.
         #
-        #   @return [FinchAPI::HRIS::Payment::PayPeriod, nil]
-        optional :pay_period, -> { FinchAPI::HRIS::Payment::PayPeriod }, nil?: true
+        #   @return [FinchAPI::Models::HRIS::Payment::PayPeriod, nil]
+        required :pay_period, -> { FinchAPI::HRIS::Payment::PayPeriod }, nil?: true
 
-        # @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
+        # @!method initialize(id:, company_debit:, debit_date:, employee_taxes:, employer_taxes:, gross_pay:, individual_ids:, net_pay:, pay_date:, pay_frequencies:, pay_group_ids:, pay_period:)
         #   @param id [String] The unique id for the payment.
         #
-        #   @param company_debit [FinchAPI::Money, nil]
+        #   @param company_debit [FinchAPI::Models::Money, nil]
         #
         #   @param debit_date [String, nil]
         #
-        #   @param employee_taxes [FinchAPI::Money, nil]
+        #   @param employee_taxes [FinchAPI::Models::Money, nil]
         #
-        #   @param employer_taxes [FinchAPI::Money, nil]
+        #   @param employer_taxes [FinchAPI::Models::Money, nil]
         #
-        #   @param gross_pay [FinchAPI::Money, nil]
+        #   @param gross_pay [FinchAPI::Models::Money, nil]
         #
         #   @param individual_ids [Array<String>, nil] Array of every individual on this payment.
         #
-        #   @param net_pay [FinchAPI::Money, nil]
+        #   @param net_pay [FinchAPI::Models::Money, nil]
         #
         #   @param pay_date [String, nil]
         #
-        #   @param pay_frequencies [Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil] List of pay frequencies associated with this payment.
+        #   @param pay_frequencies [Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>, nil] List of pay frequencies associated with this payment.
         #
         #   @param pay_group_ids [Array<String>, nil] Array of the Finch id (uuidv4) of every pay group associated with this payment.
         #
-        #   @param pay_period [FinchAPI::HRIS::Payment::PayPeriod, nil] The pay period object.
+        #   @param pay_period [FinchAPI::Models::HRIS::Payment::PayPeriod, nil] The pay period object.
 
         module PayFrequency
           extend FinchAPI::Internal::Type::Enum
 
           ANNUALLY = :annually
-          SEMI_ANNUALLY = :semi_annually
-          QUARTERLY = :quarterly
-          MONTHLY = :monthly
-          SEMI_MONTHLY = :semi_monthly
           BI_WEEKLY = :bi_weekly
-          WEEKLY = :weekly
           DAILY = :daily
+          MONTHLY = :monthly
           OTHER = :other
+          QUARTERLY = :quarterly
+          SEMI_ANNUALLY = :semi_annually
+          SEMI_MONTHLY = :semi_monthly
+          WEEKLY = :weekly
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
 
-        # @see FinchAPI::HRIS::Payment#pay_period
+        # @see FinchAPI::Models::HRIS::Payment#pay_period
         class PayPeriod < FinchAPI::Internal::Type::BaseModel
           # @!attribute end_date
           #
           #   @return [String, nil]
-          optional :end_date, String, nil?: true
+          required :end_date, String, nil?: true
 
           # @!attribute start_date
           #
           #   @return [String, nil]
-          optional :start_date, String, nil?: true
+          required :start_date, String, nil?: true
 
-          # @!method initialize(end_date: nil, start_date: nil)
+          # @!method initialize(end_date:, start_date:)
           #   The pay period object.
           #
           #   @param end_date [String, nil]

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

@@ -6,17 +6,17 @@ module FinchAPI
       class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel
         # @!attribute company_benefits
         #
-        #   @return [FinchAPI::OperationSupportMatrix, nil]
+        #   @return [FinchAPI::Models::OperationSupportMatrix, nil]
         optional :company_benefits, -> { FinchAPI::OperationSupportMatrix }
 
         # @!attribute individual_benefits
         #
-        #   @return [FinchAPI::OperationSupportMatrix, nil]
+        #   @return [FinchAPI::Models::OperationSupportMatrix, nil]
         optional :individual_benefits, -> { FinchAPI::OperationSupportMatrix }
 
         # @!method initialize(company_benefits: nil, individual_benefits: nil)
-        #   @param company_benefits [FinchAPI::OperationSupportMatrix]
-        #   @param individual_benefits [FinchAPI::OperationSupportMatrix]
+        #   @param company_benefits [FinchAPI::Models::OperationSupportMatrix]
+        #   @param individual_benefits [FinchAPI::Models::OperationSupportMatrix]
       end
     end
   end

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

@@ -3,6 +3,7 @@
 module FinchAPI
   module Models
     module HRIS
+      # @see FinchAPI::Resources::HRIS::Benefits#list_supported_benefits
       class SupportedBenefit < FinchAPI::Internal::Type::BaseModel
         # @!attribute annual_maximum
         #   Whether the provider supports an annual maximum for this benefit.
@@ -21,7 +22,7 @@ module FinchAPI
         #   Supported contribution types. An empty array indicates contributions are not
         #   supported.
         #
-        #   @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::CompanyContribution, nil>, nil]
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution, nil>, nil]
         optional :company_contribution,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::CompanyContribution,
@@ -38,7 +39,7 @@ module FinchAPI
         #   Supported deduction types. An empty array indicates deductions are not
         #   supported.
         #
-        #   @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil]
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil]
         optional :employee_deduction,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction,
@@ -49,7 +50,7 @@ module FinchAPI
         # @!attribute frequencies
         #   The list of frequencies supported by the provider for this benefit
         #
-        #   @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>, nil]
         optional :frequencies,
                  -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] }
 
@@ -57,7 +58,7 @@ module FinchAPI
         #   Whether the provider supports HSA contribution limits. Empty if this feature is
         #   not supported for the benefit. This array only has values for HSA benefits.
         #
-        #   @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil]
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil]
         optional :hsa_contribution_limit,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit,
@@ -67,21 +68,21 @@ module FinchAPI
 
         # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil)
         #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::HRIS::SupportedBenefit} for more details.
+        #   {FinchAPI::Models::HRIS::SupportedBenefit} for more details.
         #
         #   @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
         #
         #   @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
         #
-        #   @param company_contribution [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
+        #   @param company_contribution [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
         #
         #   @param description [String, nil]
         #
-        #   @param employee_deduction [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
+        #   @param employee_deduction [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
         #
-        #   @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
+        #   @param frequencies [Array<Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
         #
-        #   @param hsa_contribution_limit [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
+        #   @param hsa_contribution_limit [Array<Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
 
         module CompanyContribution
           extend FinchAPI::Internal::Type::Enum

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

@@ -7,13 +7,13 @@ module FinchAPI
         # @!attribute data
         #   Detailed information specific to the 2005 W4 form.
         #
-        #   @return [FinchAPI::HRIS::W42005::Data, nil]
+        #   @return [FinchAPI::Models::HRIS::W42005::Data, nil]
         optional :data, -> { FinchAPI::HRIS::W42005::Data }
 
         # @!attribute type
         #   Specifies the form type, indicating that this document is a 2005 W4 form.
         #
-        #   @return [Symbol, FinchAPI::HRIS::W42005::Type, nil]
+        #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Type, nil]
         optional :type, enum: -> { FinchAPI::HRIS::W42005::Type }
 
         # @!attribute year
@@ -26,13 +26,13 @@ module FinchAPI
         #   A 2005 version of the W-4 tax form containing information on an individual's
         #   filing status, dependents, and withholding details.
         #
-        #   @param data [FinchAPI::HRIS::W42005::Data] Detailed information specific to the 2005 W4 form.
+        #   @param data [FinchAPI::Models::HRIS::W42005::Data] Detailed information specific to the 2005 W4 form.
         #
-        #   @param type [Symbol, FinchAPI::HRIS::W42005::Type] Specifies the form type, indicating that this document is a 2005 W4 form.
+        #   @param type [Symbol, FinchAPI::Models::HRIS::W42005::Type] Specifies the form type, indicating that this document is a 2005 W4 form.
         #
         #   @param year [Float, nil] The tax year this W4 document applies to.
 
-        # @see FinchAPI::HRIS::W42005#data
+        # @see FinchAPI::Models::HRIS::W42005#data
         class Data < FinchAPI::Internal::Type::BaseModel
           # @!attribute additional_withholding
           #   Additional withholding amount (in cents).
@@ -43,13 +43,13 @@ module FinchAPI
           # @!attribute exemption
           #   Indicates exemption status from federal tax withholding.
           #
-          #   @return [Symbol, FinchAPI::HRIS::W42005::Data::Exemption, nil]
+          #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption, nil]
           optional :exemption, enum: -> { FinchAPI::HRIS::W42005::Data::Exemption }
 
           # @!attribute filing_status
           #   The individual's filing status for tax purposes.
           #
-          #   @return [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil]
+          #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil]
           optional :filing_status, enum: -> { FinchAPI::HRIS::W42005::Data::FilingStatus }, nil?: true
 
           # @!attribute individual_id
@@ -69,9 +69,9 @@ module FinchAPI
           #
           #   @param additional_withholding [Integer, nil] Additional withholding amount (in cents).
           #
-          #   @param exemption [Symbol, FinchAPI::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding.
+          #   @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding.
           #
-          #   @param filing_status [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil] The individual's filing status for tax purposes.
+          #   @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil] The individual's filing status for tax purposes.
           #
           #   @param individual_id [String] The unique identifier for the individual associated with this 2005 W4 form.
           #
@@ -79,7 +79,7 @@ module FinchAPI
 
           # Indicates exemption status from federal tax withholding.
           #
-          # @see FinchAPI::HRIS::W42005::Data#exemption
+          # @see FinchAPI::Models::HRIS::W42005::Data#exemption
           module Exemption
             extend FinchAPI::Internal::Type::Enum
 
@@ -92,7 +92,7 @@ module FinchAPI
 
           # The individual's filing status for tax purposes.
           #
-          # @see FinchAPI::HRIS::W42005::Data#filing_status
+          # @see FinchAPI::Models::HRIS::W42005::Data#filing_status
           module FilingStatus
             extend FinchAPI::Internal::Type::Enum
 
@@ -107,7 +107,7 @@ module FinchAPI
 
         # Specifies the form type, indicating that this document is a 2005 W4 form.
         #
-        # @see FinchAPI::HRIS::W42005#type
+        # @see FinchAPI::Models::HRIS::W42005#type
         module Type
           extend FinchAPI::Internal::Type::Enum
 

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

@@ -7,13 +7,13 @@ module FinchAPI
         # @!attribute data
         #   Detailed information specific to the 2020 W4 form.
         #
-        #   @return [FinchAPI::HRIS::W42020::Data, nil]
+        #   @return [FinchAPI::Models::HRIS::W42020::Data, nil]
         optional :data, -> { FinchAPI::HRIS::W42020::Data }
 
         # @!attribute type
         #   Specifies the form type, indicating that this document is a 2020 W4 form.
         #
-        #   @return [Symbol, FinchAPI::HRIS::W42020::Type, nil]
+        #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Type, nil]
         optional :type, enum: -> { FinchAPI::HRIS::W42020::Type }
 
         # @!attribute year
@@ -26,13 +26,13 @@ module FinchAPI
         #   A 2020 version of the W-4 tax form containing information on an individual's
         #   filing status, dependents, and withholding details.
         #
-        #   @param data [FinchAPI::HRIS::W42020::Data] Detailed information specific to the 2020 W4 form.
+        #   @param data [FinchAPI::Models::HRIS::W42020::Data] Detailed information specific to the 2020 W4 form.
         #
-        #   @param type [Symbol, FinchAPI::HRIS::W42020::Type] Specifies the form type, indicating that this document is a 2020 W4 form.
+        #   @param type [Symbol, FinchAPI::Models::HRIS::W42020::Type] Specifies the form type, indicating that this document is a 2020 W4 form.
         #
         #   @param year [Float, nil] The tax year this W4 document applies to.
 
-        # @see FinchAPI::HRIS::W42020#data
+        # @see FinchAPI::Models::HRIS::W42020#data
         class Data < FinchAPI::Internal::Type::BaseModel
           # @!attribute amount_for_other_dependents
           #   Amount claimed for dependents other than qualifying children under 17 (in
@@ -62,7 +62,7 @@ module FinchAPI
           # @!attribute filing_status
           #   The individual's filing status for tax purposes.
           #
-          #   @return [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil]
+          #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil]
           optional :filing_status, enum: -> { FinchAPI::HRIS::W42020::Data::FilingStatus }, nil?: true
 
           # @!attribute individual_id
@@ -85,7 +85,7 @@ module FinchAPI
 
           # @!method initialize(amount_for_other_dependents: nil, amount_for_qualifying_children_under_17: nil, deductions: nil, extra_withholding: nil, filing_status: nil, individual_id: nil, other_income: nil, total_claim_dependent_and_other_credits: nil)
           #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::HRIS::W42020::Data} for more details.
+          #   {FinchAPI::Models::HRIS::W42020::Data} for more details.
           #
           #   Detailed information specific to the 2020 W4 form.
           #
@@ -97,7 +97,7 @@ module FinchAPI
           #
           #   @param extra_withholding [Integer, nil] Additional withholding amount (in cents).
           #
-          #   @param filing_status [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil] The individual's filing status for tax purposes.
+          #   @param filing_status [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil] The individual's filing status for tax purposes.
           #
           #   @param individual_id [String] The unique identifier for the individual associated with this document.
           #
@@ -107,7 +107,7 @@ module FinchAPI
 
           # The individual's filing status for tax purposes.
           #
-          # @see FinchAPI::HRIS::W42020::Data#filing_status
+          # @see FinchAPI::Models::HRIS::W42020::Data#filing_status
           module FilingStatus
             extend FinchAPI::Internal::Type::Enum
 
@@ -123,7 +123,7 @@ module FinchAPI
 
         # Specifies the form type, indicating that this document is a 2020 W4 form.
         #
-        # @see FinchAPI::HRIS::W42020#type
+        # @see FinchAPI::Models::HRIS::W42020#type
         module Type
           extend FinchAPI::Internal::Type::Enum