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

data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb

@@ -12,21 +12,21 @@ module FinchAPI
           # @!attribute individuals
           #   Array of the individual_id to enroll and a configuration object.
           #
-          #   @return [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>, nil]
+          #   @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>, nil]
           optional :individuals,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual]
                    }
 
           # @!method initialize(individuals: nil, request_options: {})
-          #   @param individuals [Array<FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
+          #   @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
           class Individual < FinchAPI::Internal::Type::BaseModel
             # @!attribute configuration
             #
-            #   @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil]
+            #   @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil]
             optional :configuration,
                      -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration }
 
@@ -37,17 +37,17 @@ module FinchAPI
             optional :individual_id, String
 
             # @!method initialize(configuration: nil, individual_id: nil)
-            #   @param configuration [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration]
+            #   @param configuration [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration]
             #
             #   @param individual_id [String] Finch id (uuidv4) for the individual to enroll
 
-            # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual#configuration
+            # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual#configuration
             class Configuration < FinchAPI::Internal::Type::BaseModel
               # @!attribute annual_contribution_limit
               #   For HSA benefits only - whether the contribution limit is for an individual or
               #   family
               #
-              #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil]
+              #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil]
               optional :annual_contribution_limit,
                        enum: -> {
                          FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit
@@ -67,7 +67,7 @@ module FinchAPI
 
               # @!attribute company_contribution
               #
-              #   @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil]
+              #   @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil]
               optional :company_contribution,
                        -> {
                          FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution
@@ -81,7 +81,7 @@ module FinchAPI
 
               # @!attribute employee_deduction
               #
-              #   @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil]
+              #   @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil]
               optional :employee_deduction,
                        -> {
                          FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction
@@ -89,25 +89,25 @@ module FinchAPI
 
               # @!method initialize(annual_contribution_limit: nil, annual_maximum: nil, catch_up: nil, company_contribution: nil, effective_date: nil, employee_deduction: nil)
               #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration}
+              #   {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration}
               #   for more details.
               #
-              #   @param annual_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit] For HSA benefits only - whether the contribution limit is for an individual or f
+              #   @param annual_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit] For HSA benefits only - whether the contribution limit is for an individual or f
               #
               #   @param annual_maximum [Integer, nil] Maximum annual amount in cents
               #
               #   @param catch_up [Boolean] For retirement benefits only - whether catch up contributions are enabled
               #
-              #   @param company_contribution [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution]
+              #   @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution]
               #
               #   @param effective_date [Date] The date the enrollment will take effect
               #
-              #   @param employee_deduction [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction]
+              #   @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction]
 
               # For HSA benefits only - whether the contribution limit is for an individual or
               # family
               #
-              # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#annual_contribution_limit
+              # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#annual_contribution_limit
               module AnnualContributionLimit
                 extend FinchAPI::Internal::Type::Enum
 
@@ -118,7 +118,7 @@ module FinchAPI
                 #   @return [Array<Symbol>]
               end
 
-              # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#company_contribution
+              # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#company_contribution
               class CompanyContribution < FinchAPI::Internal::Type::BaseModel
                 # @!attribute amount
                 #   Amount in cents for fixed type or basis points (1/100th of a percent) for
@@ -129,7 +129,7 @@ module FinchAPI
 
                 # @!attribute type
                 #
-                #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
+                #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
                 optional :type,
                          enum: -> {
                            FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type
@@ -137,14 +137,14 @@ module FinchAPI
 
                 # @!method initialize(amount: nil, type: nil)
                 #   Some parameter documentations has been truncated, see
-                #   {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution}
+                #   {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution}
                 #   for more details.
                 #
                 #   @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen
                 #
-                #   @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
+                #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
 
-                # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type
+                # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type
                 module Type
                   extend FinchAPI::Internal::Type::Enum
 
@@ -156,7 +156,7 @@ module FinchAPI
                 end
               end
 
-              # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#employee_deduction
+              # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#employee_deduction
               class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
                 # @!attribute amount
                 #   Amount in cents for fixed type or basis points (1/100th of a percent) for
@@ -167,7 +167,7 @@ module FinchAPI
 
                 # @!attribute type
                 #
-                #   @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil]
+                #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil]
                 optional :type,
                          enum: -> {
                            FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type
@@ -175,14 +175,14 @@ module FinchAPI
 
                 # @!method initialize(amount: nil, type: nil)
                 #   Some parameter documentations has been truncated, see
-                #   {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction}
+                #   {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction}
                 #   for more details.
                 #
                 #   @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen
                 #
-                #   @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type]
+                #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type]
 
-                # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction#type
+                # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction#type
                 module Type
                   extend FinchAPI::Internal::Type::Enum
 

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

@@ -6,80 +6,80 @@ module FinchAPI
       class BenefitsSupport < FinchAPI::Internal::Type::BaseModel
         # @!attribute commuter
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :commuter, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute custom_post_tax
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :custom_post_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute custom_pre_tax
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :custom_pre_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute fsa_dependent_care
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :fsa_dependent_care, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute fsa_medical
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :fsa_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute hsa_post
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :hsa_post, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute hsa_pre
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :hsa_pre, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute s125_dental
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :s125_dental, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute s125_medical
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :s125_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute s125_vision
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :s125_vision, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute simple
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :simple, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!attribute simple_ira
         #
-        #   @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil]
         optional :simple_ira, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true
 
         # @!method 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)
         #   Each benefit type and their supported features. If the benefit type is not
         #   supported, the property will be null
         #
-        #   @param commuter [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param custom_post_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param custom_pre_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param fsa_dependent_care [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param fsa_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param hsa_post [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param hsa_pre [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param s125_dental [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param s125_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param s125_vision [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param simple [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
-        #   @param simple_ira [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil]
+        #   @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]
       end
     end
   end

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

@@ -13,7 +13,7 @@ module FinchAPI
             # @!attribute attributes
             #   Specifies the fields to be applied when the condition is met.
             #
-            #   @return [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, nil]
+            #   @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, nil]
             optional :attributes,
                      -> {
                        FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes
@@ -21,7 +21,7 @@ module FinchAPI
 
             # @!attribute conditions
             #
-            #   @return [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>, nil]
+            #   @return [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>, nil]
             optional :conditions,
                      -> {
                        FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition]
@@ -42,20 +42,20 @@ module FinchAPI
             # @!attribute entity_type
             #   The entity type to which the rule is applied.
             #
-            #   @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType, nil]
+            #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType, nil]
             optional :entity_type,
                      enum: -> { FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType }
 
             # @!method initialize(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
-            #   @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
+            #   @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
             #
-            #   @param conditions [Array<FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
+            #   @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]
             #
             #   @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
             #
             #   @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
             #
-            #   @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
+            #   @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied.
             #
             #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -69,8 +69,8 @@ module FinchAPI
 
               # @!method initialize(metadata: nil)
               #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes} for
-              #   more details.
+              #   {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes}
+              #   for more details.
               #
               #   Specifies the fields to be applied when the condition is met.
               #
@@ -87,7 +87,7 @@ module FinchAPI
               # @!attribute operator
               #   The operator to be used in the rule.
               #
-              #   @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator, nil]
+              #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator, nil]
               optional :operator,
                        enum: -> {
                          FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator
@@ -102,13 +102,13 @@ module FinchAPI
               # @!method initialize(field: nil, operator: nil, value: nil)
               #   @param field [String] The field to be checked in the rule.
               #
-              #   @param operator [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule.
+              #   @param operator [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule.
               #
               #   @param value [String] The value of the field to be checked in the rule.
 
               # The operator to be used in the rule.
               #
-              # @see FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition#operator
+              # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition#operator
               module Operator
                 extend FinchAPI::Internal::Type::Enum
 

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

@@ -13,7 +13,7 @@ module FinchAPI
           #   Comma-delimited list of pay statement item categories to filter on. If empty,
           #   defaults to all categories.
           #
-          #   @return [Array<Symbol, FinchAPI::HRIS::Company::PayStatementItemListParams::Category>, nil]
+          #   @return [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>, nil]
           optional :categories,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Company::PayStatementItemListParams::Category]
@@ -49,7 +49,7 @@ module FinchAPI
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
           #
-          #   @param categories [Array<Symbol, FinchAPI::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
+          #   @param categories [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
           #
           #   @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
           #

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

@@ -9,22 +9,22 @@ module FinchAPI
           # @!attribute attributes
           #   The attributes of the pay statement item.
           #
-          #   @return [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, nil]
-          optional :attributes, -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes }
+          #   @return [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes]
+          required :attributes, -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes }
 
           # @!attribute category
           #   The category of the pay statement item.
           #
-          #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category, nil]
-          optional :category, enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category }
+          #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category]
+          required :category, enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category }
 
           # @!attribute name
           #   The name of the pay statement item.
           #
-          #   @return [String, nil]
-          optional :name, String
+          #   @return [String]
+          required :name, String
 
-          # @!method initialize(attributes: nil, category: nil, name: nil)
+          # @!method initialize(attributes:, category:, name:)
           #   @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes] The attributes of the pay statement item.
           #
           #   @param category [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category] The category of the pay statement item.
@@ -33,22 +33,22 @@ module FinchAPI
 
           # @see FinchAPI::Models::HRIS::Company::PayStatementItemListResponse#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
-            # @!attribute employer
-            #   `true` if the amount is paid by the employers. This field is only available for
-            #   taxes.
-            #
-            #   @return [Boolean, nil]
-            optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
-
             # @!attribute metadata
             #   The metadata of the pay statement item derived by the rules engine if available.
             #   Each attribute will be a key-value pair defined by a rule.
             #
             #   @return [Hash{Symbol=>Object, nil}, nil]
-            optional :metadata,
+            required :metadata,
                      FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
                      nil?: true
 
+            # @!attribute employer
+            #   `true` if the amount is paid by the employers. This field is only available for
+            #   taxes.
+            #
+            #   @return [Boolean, nil]
+            optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
+
             # @!attribute pre_tax
             #   `true` if the pay statement item is pre-tax. This field is only available for
             #   employee deductions.
@@ -62,17 +62,17 @@ module FinchAPI
             #   @return [String, nil]
             optional :type, String, nil?: true
 
-            # @!method initialize(employer: nil, metadata: nil, pre_tax: nil, type: nil)
+            # @!method initialize(metadata:, employer: nil, pre_tax: nil, type: nil)
             #   Some parameter documentations has been truncated, see
             #   {FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes} for
             #   more details.
             #
             #   The attributes of the pay statement item.
             #
-            #   @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
-            #
             #   @param metadata [Hash{Symbol=>Object, nil}, nil] The metadata of the pay statement item derived by the rules engine if available.
             #
+            #   @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
+            #
             #   @param pre_tax [Boolean, nil] `true` if the pay statement item is pre-tax. This field is only available for em
             #
             #   @param type [String, nil] The type of the pay statement item.

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

@@ -14,7 +14,7 @@ module FinchAPI
         # @!attribute accounts
         #   An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @return [Array<FinchAPI::HRIS::HRISCompany::Account>, nil]
+        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil]
         required :accounts,
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Account] },
                  nil?: true
@@ -22,7 +22,7 @@ module FinchAPI
         # @!attribute departments
         #   The array of company departments.
         #
-        #   @return [Array<FinchAPI::HRIS::HRISCompany::Department, nil>, nil]
+        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil]
         required :departments,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Department, nil?: true]
@@ -38,7 +38,7 @@ module FinchAPI
         # @!attribute entity
         #   The entity type object.
         #
-        #   @return [FinchAPI::HRIS::HRISCompany::Entity, nil]
+        #   @return [FinchAPI::Models::HRIS::HRISCompany::Entity, nil]
         required :entity, -> { FinchAPI::HRIS::HRISCompany::Entity }, nil?: true
 
         # @!attribute legal_name
@@ -49,7 +49,7 @@ module FinchAPI
 
         # @!attribute locations
         #
-        #   @return [Array<FinchAPI::Location, nil>, nil]
+        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
         required :locations,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
@@ -71,21 +71,21 @@ 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::HRIS::HRISCompany} for more details.
+        #   {FinchAPI::Models::HRIS::HRISCompany} for more details.
         #
         #   @param id [String] A stable Finch `id` (UUID v4) for the company.
         #
-        #   @param accounts [Array<FinchAPI::HRIS::HRISCompany::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        #   @param accounts [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @param departments [Array<FinchAPI::HRIS::HRISCompany::Department, nil>, nil] The array of company departments.
+        #   @param departments [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil] The array of company departments.
         #
         #   @param ein [String, nil] The employer identification number.
         #
-        #   @param entity [FinchAPI::HRIS::HRISCompany::Entity, nil] The entity type object.
+        #   @param entity [FinchAPI::Models::HRIS::HRISCompany::Entity, nil] The entity type object.
         #
         #   @param legal_name [String, nil] The legal name of the company.
         #
-        #   @param locations [Array<FinchAPI::Location, nil>, nil]
+        #   @param locations [Array<FinchAPI::Models::Location, nil>, nil]
         #
         #   @param primary_email [String, nil] The email of the main administrator on the account.
         #
@@ -107,7 +107,7 @@ module FinchAPI
           # @!attribute account_type
           #   The type of bank account.
           #
-          #   @return [Symbol, FinchAPI::HRIS::HRISCompany::Account::AccountType, nil]
+          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil]
           required :account_type, enum: -> { FinchAPI::HRIS::HRISCompany::Account::AccountType }, nil?: true
 
           # @!attribute institution_name
@@ -125,13 +125,13 @@ module FinchAPI
 
           # @!method initialize(account_name:, account_number:, account_type:, institution_name:, routing_number:)
           #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::HRIS::HRISCompany::Account} for more details.
+          #   {FinchAPI::Models::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::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account.
+          #   @param account_type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account.
           #
           #   @param institution_name [String, nil] Name of the banking institution.
           #
@@ -139,7 +139,7 @@ module FinchAPI
 
           # The type of bank account.
           #
-          # @see FinchAPI::HRIS::HRISCompany::Account#account_type
+          # @see FinchAPI::Models::HRIS::HRISCompany::Account#account_type
           module AccountType
             extend FinchAPI::Internal::Type::Enum
 
@@ -161,15 +161,15 @@ module FinchAPI
           # @!attribute parent
           #   The parent department, if present.
           #
-          #   @return [FinchAPI::HRIS::HRISCompany::Department::Parent, nil]
+          #   @return [FinchAPI::Models::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::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present.
+          #   @param parent [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present.
 
-          # @see FinchAPI::HRIS::HRISCompany::Department#parent
+          # @see FinchAPI::Models::HRIS::HRISCompany::Department#parent
           class Parent < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
             #   The parent department's name.
@@ -184,30 +184,30 @@ module FinchAPI
           end
         end
 
-        # @see FinchAPI::HRIS::HRISCompany#entity
+        # @see FinchAPI::Models::HRIS::HRISCompany#entity
         class Entity < FinchAPI::Internal::Type::BaseModel
           # @!attribute subtype
           #   The tax payer subtype of the company.
           #
-          #   @return [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Subtype, nil]
+          #   @return [Symbol, FinchAPI::Models::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::HRIS::HRISCompany::Entity::Type, nil]
+          #   @return [Symbol, FinchAPI::Models::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::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company.
+          #   @param subtype [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company.
           #
-          #   @param type [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company.
+          #   @param type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company.
 
           # The tax payer subtype of the company.
           #
-          # @see FinchAPI::HRIS::HRISCompany::Entity#subtype
+          # @see FinchAPI::Models::HRIS::HRISCompany::Entity#subtype
           module Subtype
             extend FinchAPI::Internal::Type::Enum
 
@@ -221,7 +221,7 @@ module FinchAPI
 
           # The tax payer type of the company.
           #
-          # @see FinchAPI::HRIS::HRISCompany::Entity#type
+          # @see FinchAPI::Models::HRIS::HRISCompany::Entity#type
           module Type
             extend FinchAPI::Internal::Type::Enum