finch-api 0.1.0.pre.alpha.29 → 0.1.0.pre.alpha.31

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

@@ -7,36 +7,36 @@ module FinchAPI
         # @!attribute id
         #   A stable Finch id for the document.
         #
-        #   @return [String, nil]
-        optional :id, String
+        #   @return [String]
+        required :id, String
 
         # @!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
+        required :individual_id, String, nil?: true
 
         # @!attribute type
         #   The type of document.
         #
-        #   @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil]
-        optional :type, enum: -> { FinchAPI::HRIS::DocumentResponse::Type }
+        #   @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type]
+        required :type, enum: -> { FinchAPI::HRIS::DocumentResponse::Type }
 
         # @!attribute url
         #   A URL to access the document. Format:
         #   `https://api.tryfinch.com/employer/documents/:document_id`.
         #
-        #   @return [String, nil]
-        optional :url, String
+        #   @return [String]
+        required :url, String
 
         # @!attribute year
         #   The year the document applies to, if available.
         #
-        #   @return [Float, nil]
-        optional :year, Float, nil?: true
+        #   @return [Float]
+        required :year, Float
 
-        # @!method initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil)
+        # @!method initialize(id:, individual_id:, type:, url:, year:)
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::DocumentResponse} for more details.
         #
@@ -48,7 +48,7 @@ module FinchAPI
         #
         #   @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.
+        #   @param year [Float] The year the document applies to, if available.
 
         # The type of document.
         #

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

@@ -8,7 +8,15 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(entity_ids: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -15,9 +15,17 @@ module FinchAPI
         required :requests,
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] }
 
-        # @!method initialize(requests:, request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(requests:, entity_ids: nil, request_options: {})
         #   @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
         #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         class Request < FinchAPI::Internal::Type::BaseModel

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

@@ -8,6 +8,12 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
         # @!attribute options
         #
         #   @return [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
@@ -19,9 +25,13 @@ module FinchAPI
         optional :requests,
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
 
-        # @!method initialize(options: nil, requests: nil, request_options: {})
+        # @!method initialize(entity_ids: nil, options: nil, requests: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
+        #
         #   @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         class Options < FinchAPI::Internal::Type::BaseModel

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

@@ -15,22 +15,16 @@ module FinchAPI
         # @!attribute employee_deductions
         #   The array of deductions objects associated with this pay statement.
         #
-        #   @return [Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil>, nil]
+        #   @return [Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction>, nil]
         required :employee_deductions,
-                 -> {
-                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployeeDeduction,
-                                                     nil?: true]
-                 },
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployeeDeduction] },
                  nil?: true
 
         # @!attribute employer_contributions
         #
-        #   @return [Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil>, nil]
+        #   @return [Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution>, nil]
         required :employer_contributions,
-                 -> {
-                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployerContribution,
-                                                     nil?: true]
-                 },
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployerContribution] },
                  nil?: true
 
         # @!attribute gross_pay
@@ -58,9 +52,11 @@ module FinchAPI
         # @!attribute taxes
         #   The array of taxes objects associated with this pay statement.
         #
-        #   @return [Array<FinchAPI::Models::HRIS::PayStatement::Tax, nil>, nil]
+        #   @return [Array<FinchAPI::Models::HRIS::PayStatement::Tax>, nil]
         required :taxes,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Tax, nil?: true] },
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Tax]
+                 },
                  nil?: true
 
         # @!attribute total_hours
@@ -78,9 +74,9 @@ module FinchAPI
         # @!method initialize(earnings:, employee_deductions:, employer_contributions:, gross_pay:, individual_id:, net_pay:, payment_method:, taxes:, total_hours:, type:)
         #   @param earnings [Array<FinchAPI::Models::HRIS::PayStatement::Earning, nil>, nil] The array of earnings objects associated with this pay statement
         #
-        #   @param employee_deductions [Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil>, nil] The array of deductions objects associated with this pay statement.
+        #   @param employee_deductions [Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction>, nil] The array of deductions objects associated with this pay statement.
         #
-        #   @param employer_contributions [Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil>, nil]
+        #   @param employer_contributions [Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution>, nil]
         #
         #   @param gross_pay [FinchAPI::Models::Money, nil]
         #
@@ -90,7 +86,7 @@ module FinchAPI
         #
         #   @param payment_method [Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod, nil] The payment method.
         #
-        #   @param taxes [Array<FinchAPI::Models::HRIS::PayStatement::Tax, nil>, nil] The array of taxes objects associated with this pay statement.
+        #   @param taxes [Array<FinchAPI::Models::HRIS::PayStatement::Tax>, nil] The array of taxes objects associated with this pay statement.
         #
         #   @param total_hours [Float, nil] The number of hours worked for this pay period
         #
@@ -176,31 +172,19 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::Earning#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::Earning::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata} for more
-              #   details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::Earning::Attributes} for more details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 
@@ -256,31 +240,20 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata}
-              #   for more details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes} for more
+            #   details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 
@@ -332,31 +305,20 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata}
-              #   for more details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes} for
+            #   more details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 
@@ -441,31 +403,19 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::Tax#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::Tax::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata} for more
-              #   details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::Tax::Attributes} for more details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 

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

@@ -15,9 +15,17 @@ module FinchAPI
         required :requests,
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] }
 
-        # @!method initialize(requests:, request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(requests:, entity_ids: nil, request_options: {})
         #   @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests.
         #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         class Request < FinchAPI::Internal::Type::BaseModel

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

@@ -22,7 +22,13 @@ module FinchAPI
         #   @return [Date]
         required :start_date, Date
 
-        # @!method initialize(end_date:, start_date:, request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(end_date:, start_date:, entity_ids: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::PaymentListParams} for more details.
         #
@@ -30,6 +36,8 @@ module FinchAPI
         #
         #   @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for
         #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -89,6 +89,7 @@ module FinchAPI
 
           FIXED = :fixed
           PERCENT = :percent
+          TIERED = :tiered
 
           # @!method self.values
           #   @return [Array<Symbol>]

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

@@ -7,22 +7,22 @@ module FinchAPI
         # @!attribute data
         #   Detailed information specific to the 2005 W4 form.
         #
-        #   @return [FinchAPI::Models::HRIS::W42005::Data, nil]
-        optional :data, -> { FinchAPI::HRIS::W42005::Data }
+        #   @return [FinchAPI::Models::HRIS::W42005::Data]
+        required :data, -> { FinchAPI::HRIS::W42005::Data }
 
         # @!attribute type
         #   Specifies the form type, indicating that this document is a 2005 W4 form.
         #
-        #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Type, nil]
-        optional :type, enum: -> { FinchAPI::HRIS::W42005::Type }
+        #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Type]
+        required :type, enum: -> { FinchAPI::HRIS::W42005::Type }
 
         # @!attribute year
         #   The tax year this W4 document applies to.
         #
-        #   @return [Float, nil]
-        optional :year, Float, nil?: true
+        #   @return [Float]
+        required :year, Float
 
-        # @!method initialize(data: nil, type: nil, year: nil)
+        # @!method initialize(data:, type:, year:)
         #   A 2005 version of the W-4 tax form containing information on an individual's
         #   filing status, dependents, and withholding details.
         #
@@ -30,52 +30,52 @@ module FinchAPI
         #
         #   @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.
+        #   @param year [Float] The tax year this W4 document applies to.
 
         # @see FinchAPI::Models::HRIS::W42005#data
         class Data < FinchAPI::Internal::Type::BaseModel
           # @!attribute additional_withholding
           #   Additional withholding amount (in cents).
           #
-          #   @return [Integer, nil]
-          optional :additional_withholding, Integer, nil?: true
+          #   @return [Integer]
+          required :additional_withholding, Integer
 
           # @!attribute exemption
           #   Indicates exemption status from federal tax withholding.
           #
           #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption, nil]
-          optional :exemption, enum: -> { FinchAPI::HRIS::W42005::Data::Exemption }
+          required :exemption, enum: -> { FinchAPI::HRIS::W42005::Data::Exemption }, nil?: true
 
           # @!attribute filing_status
           #   The individual's filing status for tax purposes.
           #
           #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil]
-          optional :filing_status, enum: -> { FinchAPI::HRIS::W42005::Data::FilingStatus }, nil?: true
+          required :filing_status, enum: -> { FinchAPI::HRIS::W42005::Data::FilingStatus }, nil?: true
 
           # @!attribute individual_id
           #   The unique identifier for the individual associated with this 2005 W4 form.
           #
-          #   @return [String, nil]
-          optional :individual_id, String
+          #   @return [String]
+          required :individual_id, String
 
           # @!attribute total_number_of_allowances
           #   Total number of allowances claimed (in cents).
           #
-          #   @return [Integer, nil]
-          optional :total_number_of_allowances, Integer, nil?: true
+          #   @return [Integer]
+          required :total_number_of_allowances, Integer
 
-          # @!method initialize(additional_withholding: nil, exemption: nil, filing_status: nil, individual_id: nil, total_number_of_allowances: nil)
+          # @!method initialize(additional_withholding:, exemption:, filing_status:, individual_id:, total_number_of_allowances:)
           #   Detailed information specific to the 2005 W4 form.
           #
-          #   @param additional_withholding [Integer, nil] Additional withholding amount (in cents).
+          #   @param additional_withholding [Integer] Additional withholding amount (in cents).
           #
-          #   @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding.
+          #   @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption, nil] Indicates exemption status from federal tax withholding.
           #
           #   @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.
           #
-          #   @param total_number_of_allowances [Integer, nil] Total number of allowances claimed (in cents).
+          #   @param total_number_of_allowances [Integer] Total number of allowances claimed (in cents).
 
           # Indicates exemption status from federal tax withholding.
           #

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

@@ -7,22 +7,22 @@ module FinchAPI
         # @!attribute data
         #   Detailed information specific to the 2020 W4 form.
         #
-        #   @return [FinchAPI::Models::HRIS::W42020::Data, nil]
-        optional :data, -> { FinchAPI::HRIS::W42020::Data }
+        #   @return [FinchAPI::Models::HRIS::W42020::Data]
+        required :data, -> { FinchAPI::HRIS::W42020::Data }
 
         # @!attribute type
         #   Specifies the form type, indicating that this document is a 2020 W4 form.
         #
-        #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Type, nil]
-        optional :type, enum: -> { FinchAPI::HRIS::W42020::Type }
+        #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Type]
+        required :type, enum: -> { FinchAPI::HRIS::W42020::Type }
 
         # @!attribute year
         #   The tax year this W4 document applies to.
         #
-        #   @return [Float, nil]
-        optional :year, Float, nil?: true
+        #   @return [Float]
+        required :year, Float
 
-        # @!method initialize(data: nil, type: nil, year: nil)
+        # @!method initialize(data:, type:, year:)
         #   A 2020 version of the W-4 tax form containing information on an individual's
         #   filing status, dependents, and withholding details.
         #
@@ -30,7 +30,7 @@ module FinchAPI
         #
         #   @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.
+        #   @param year [Float] The tax year this W4 document applies to.
 
         # @see FinchAPI::Models::HRIS::W42020#data
         class Data < FinchAPI::Internal::Type::BaseModel
@@ -38,72 +38,72 @@ module FinchAPI
           #   Amount claimed for dependents other than qualifying children under 17 (in
           #   cents).
           #
-          #   @return [Integer, nil]
-          optional :amount_for_other_dependents, Integer, nil?: true
+          #   @return [Integer]
+          required :amount_for_other_dependents, Integer
 
           # @!attribute amount_for_qualifying_children_under_17
           #   Amount claimed for dependents under 17 years old (in cents).
           #
-          #   @return [Integer, nil]
-          optional :amount_for_qualifying_children_under_17, Integer, nil?: true
+          #   @return [Integer]
+          required :amount_for_qualifying_children_under_17, Integer
 
           # @!attribute deductions
           #   Deductible expenses (in cents).
           #
-          #   @return [Integer, nil]
-          optional :deductions, Integer, nil?: true
+          #   @return [Integer]
+          required :deductions, Integer
 
           # @!attribute extra_withholding
           #   Additional withholding amount (in cents).
           #
-          #   @return [Integer, nil]
-          optional :extra_withholding, Integer, nil?: true
+          #   @return [Integer]
+          required :extra_withholding, Integer
 
           # @!attribute filing_status
           #   The individual's filing status for tax purposes.
           #
           #   @return [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil]
-          optional :filing_status, enum: -> { FinchAPI::HRIS::W42020::Data::FilingStatus }, nil?: true
+          required :filing_status, enum: -> { FinchAPI::HRIS::W42020::Data::FilingStatus }, nil?: true
 
           # @!attribute individual_id
           #   The unique identifier for the individual associated with this document.
           #
-          #   @return [String, nil]
-          optional :individual_id, String
+          #   @return [String]
+          required :individual_id, String
 
           # @!attribute other_income
           #   Additional income from sources outside of primary employment (in cents).
           #
-          #   @return [Integer, nil]
-          optional :other_income, Integer, nil?: true
+          #   @return [Integer]
+          required :other_income, Integer
 
           # @!attribute total_claim_dependent_and_other_credits
           #   Total amount claimed for dependents and other credits (in cents).
           #
-          #   @return [Integer, nil]
-          optional :total_claim_dependent_and_other_credits, Integer, nil?: true
+          #   @return [Integer]
+          required :total_claim_dependent_and_other_credits, Integer
 
-          # @!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)
+          # @!method initialize(amount_for_other_dependents:, amount_for_qualifying_children_under_17:, deductions:, extra_withholding:, filing_status:, individual_id:, other_income:, total_claim_dependent_and_other_credits:)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::W42020::Data} for more details.
           #
           #   Detailed information specific to the 2020 W4 form.
           #
-          #   @param amount_for_other_dependents [Integer, nil] Amount claimed for dependents other than qualifying children under 17 (in cents)
+          #   @param amount_for_other_dependents [Integer] Amount claimed for dependents other than qualifying children under 17 (in cents)
           #
-          #   @param amount_for_qualifying_children_under_17 [Integer, nil] Amount claimed for dependents under 17 years old (in cents).
+          #   @param amount_for_qualifying_children_under_17 [Integer] Amount claimed for dependents under 17 years old (in cents).
           #
-          #   @param deductions [Integer, nil] Deductible expenses (in cents).
+          #   @param deductions [Integer] Deductible expenses (in cents).
           #
-          #   @param extra_withholding [Integer, nil] Additional withholding amount (in cents).
+          #   @param extra_withholding [Integer] Additional withholding amount (in cents).
           #
           #   @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.
           #
-          #   @param other_income [Integer, nil] Additional income from sources outside of primary employment (in cents).
+          #   @param other_income [Integer] Additional income from sources outside of primary employment (in cents).
           #
-          #   @param total_claim_dependent_and_other_credits [Integer, nil] Total amount claimed for dependents and other credits (in cents).
+          #   @param total_claim_dependent_and_other_credits [Integer] Total amount claimed for dependents and other credits (in cents).
 
           # The individual's filing status for tax purposes.
           #