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

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

@@ -50,13 +50,21 @@ module FinchAPI
 
               # @!attribute company_contribution
               #
-              #   @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
-              required :company_contribution, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
+              #   @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2, nil]
+              required :company_contribution,
+                       union: -> {
+                         FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution
+                       },
+                       nil?: true
 
               # @!attribute employee_deduction
               #
-              #   @return [FinchAPI::Models::HRIS::BenefitContribution, nil]
-              required :employee_deduction, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true
+              #   @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1, nil]
+              required :employee_deduction,
+                       union: -> {
+                         FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction
+                       },
+                       nil?: true
 
               # @!attribute hsa_contribution_limit
               #   Type for HSA contribution limit if the benefit is a HSA.
@@ -77,12 +85,220 @@ module FinchAPI
               #
               #   @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
               #
-              #   @param company_contribution [FinchAPI::Models::HRIS::BenefitContribution, nil]
+              #   @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2, nil]
               #
-              #   @param employee_deduction [FinchAPI::Models::HRIS::BenefitContribution, nil]
+              #   @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1, nil]
               #
               #   @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA.
 
+              # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0#company_contribution
+              module CompanyContribution
+                extend FinchAPI::Internal::Type::Union
+
+                variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0 }
+
+                variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1 }
+
+                variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2 }
+
+                class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute amount
+                  #   Contribution amount in cents.
+                  #
+                  #   @return [Integer]
+                  required :amount, Integer
+
+                  # @!attribute type
+                  #   Fixed contribution type.
+                  #
+                  #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type]
+                  required :type,
+                           enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type }
+
+                  # @!method initialize(amount:, type:)
+                  #   @param amount [Integer] Contribution amount in cents.
+                  #
+                  #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0::Type] Fixed contribution type.
+
+                  # Fixed contribution type.
+                  #
+                  # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0#type
+                  module Type
+                    extend FinchAPI::Internal::Type::Enum
+
+                    FIXED = :fixed
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                class UnionMember1 < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute amount
+                  #   Contribution amount in basis points (1/100th of a percent).
+                  #
+                  #   @return [Integer]
+                  required :amount, Integer
+
+                  # @!attribute type
+                  #   Percentage contribution type.
+                  #
+                  #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type]
+                  required :type,
+                           enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type }
+
+                  # @!method initialize(amount:, type:)
+                  #   @param amount [Integer] Contribution amount in basis points (1/100th of a percent).
+                  #
+                  #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1::Type] Percentage contribution type.
+
+                  # Percentage contribution type.
+                  #
+                  # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1#type
+                  module Type
+                    extend FinchAPI::Internal::Type::Enum
+
+                    PERCENT = :percent
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                class UnionMember2 < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute tiers
+                  #   Array of tier objects defining employer match tiers based on employee
+                  #   contribution thresholds.
+                  #
+                  #   @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Tier>]
+                  required :tiers,
+                           -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Tier] }
+
+                  # @!attribute type
+                  #   Tiered contribution type (only valid for company_contribution).
+                  #
+                  #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Type]
+                  required :type,
+                           enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Type }
+
+                  # @!method initialize(tiers:, type:)
+                  #   Some parameter documentations has been truncated, see
+                  #   {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2}
+                  #   for more details.
+                  #
+                  #   @param tiers [Array<FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Tier>] Array of tier objects defining employer match tiers based on employee contributi
+                  #
+                  #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2::Type] Tiered contribution type (only valid for company_contribution).
+
+                  class Tier < FinchAPI::Internal::Type::BaseModel
+                    # @!attribute match
+                    #
+                    #   @return [Integer]
+                    required :match, Integer
+
+                    # @!attribute threshold
+                    #
+                    #   @return [Integer]
+                    required :threshold, Integer
+
+                    # @!method initialize(match:, threshold:)
+                    #   @param match [Integer]
+                    #   @param threshold [Integer]
+                  end
+
+                  # Tiered contribution type (only valid for company_contribution).
+                  #
+                  # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2#type
+                  module Type
+                    extend FinchAPI::Internal::Type::Enum
+
+                    TIERED = :tiered
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                # @!method self.variants
+                #   @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember1, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::CompanyContribution::UnionMember2)]
+              end
+
+              # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0#employee_deduction
+              module EmployeeDeduction
+                extend FinchAPI::Internal::Type::Union
+
+                variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0 }
+
+                variant -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1 }
+
+                class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute amount
+                  #   Contribution amount in cents.
+                  #
+                  #   @return [Integer]
+                  required :amount, Integer
+
+                  # @!attribute type
+                  #   Fixed contribution type.
+                  #
+                  #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type]
+                  required :type,
+                           enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type }
+
+                  # @!method initialize(amount:, type:)
+                  #   @param amount [Integer] Contribution amount in cents.
+                  #
+                  #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0::Type] Fixed contribution type.
+
+                  # Fixed contribution type.
+                  #
+                  # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0#type
+                  module Type
+                    extend FinchAPI::Internal::Type::Enum
+
+                    FIXED = :fixed
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                class UnionMember1 < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute amount
+                  #   Contribution amount in basis points (1/100th of a percent).
+                  #
+                  #   @return [Integer]
+                  required :amount, Integer
+
+                  # @!attribute type
+                  #   Percentage contribution type.
+                  #
+                  #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type]
+                  required :type,
+                           enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type }
+
+                  # @!method initialize(amount:, type:)
+                  #   @param amount [Integer] Contribution amount in basis points (1/100th of a percent).
+                  #
+                  #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1::Type] Percentage contribution type.
+
+                  # Percentage contribution type.
+                  #
+                  # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1#type
+                  module Type
+                    extend FinchAPI::Internal::Type::Enum
+
+                    PERCENT = :percent
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                # @!method self.variants
+                #   @return [Array(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember0, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0::EmployeeDeduction::UnionMember1)]
+              end
+
               # Type for HSA contribution limit if the benefit is a HSA.
               #
               # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::UnionMember0#hsa_contribution_limit

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

@@ -9,6 +9,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 individuals
           #   Array of the individual_id to enroll and a configuration object.
           #
@@ -16,7 +22,9 @@ module FinchAPI
           optional :individuals,
                    -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] }
 
-          # @!method initialize(individuals: nil, request_options: {})
+          # @!method initialize(entity_ids: nil, individuals: nil, request_options: {})
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #
           #   @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}]
@@ -119,27 +127,57 @@ module FinchAPI
                 #   @return [Integer, nil]
                 optional :amount, Integer
 
+                # @!attribute tiers
+                #   Array of tier objects for tiered contribution matching (required when type is
+                #   tiered)
+                #
+                #   @return [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier>, nil]
+                optional :tiers,
+                         -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier] }
+
                 # @!attribute type
                 #
                 #   @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil]
                 optional :type,
                          enum: -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type }
 
-                # @!method initialize(amount: nil, type: nil)
+                # @!method initialize(amount: nil, tiers: nil, type: nil)
                 #   Some parameter documentations has been truncated, see
                 #   {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 tiers [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier>] Array of tier objects for tiered contribution matching (required when type is ti
+                #
                 #   @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type]
 
+                class Tier < FinchAPI::Internal::Type::BaseModel
+                  # @!attribute match
+                  #   The employer match percentage in basis points (0-10000 = 0-100%)
+                  #
+                  #   @return [Integer]
+                  required :match, Integer
+
+                  # @!attribute threshold
+                  #   The employee contribution threshold in basis points (0-10000 = 0-100%)
+                  #
+                  #   @return [Integer]
+                  required :threshold, Integer
+
+                  # @!method initialize(match:, threshold:)
+                  #   @param match [Integer] The employer match percentage in basis points (0-10000 = 0-100%)
+                  #
+                  #   @param threshold [Integer] The employee contribution threshold in basis points (0-10000 = 0-100%)
+                end
+
                 # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type
                 module Type
                   extend FinchAPI::Internal::Type::Enum
 
                   FIXED = :fixed
                   PERCENT = :percent
+                  TIERED = :tiered
 
                   # @!method self.values
                   #   @return [Array<Symbol>]

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

@@ -9,7 +9,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/benefits/individual_retrieve_many_benefits_params.rb

@@ -9,6 +9,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 individual_ids
           #   comma-delimited list of stable Finch uuids for each individual. If empty,
           #   defaults to all individuals
@@ -16,11 +22,13 @@ module FinchAPI
           #   @return [String, nil]
           optional :individual_ids, String
 
-          # @!method initialize(individual_ids: nil, request_options: {})
+          # @!method initialize(entity_ids: nil, individual_ids: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams} for
           #   more details.
           #
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #
           #   @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]

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

@@ -9,13 +9,21 @@ 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 individual_ids
           #   Array of individual_ids to unenroll.
           #
           #   @return [Array<String>, nil]
           optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
-          # @!method initialize(individual_ids: nil, request_options: {})
+          # @!method initialize(entity_ids: nil, individual_ids: nil, request_options: {})
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #
           #   @param individual_ids [Array<String>] Array of individual_ids to unenroll.
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]

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

@@ -10,6 +10,12 @@ module FinchAPI
             extend FinchAPI::Internal::Type::RequestParameters::Converter
             include FinchAPI::Internal::Type::RequestParameters
 
+            # @!attribute entity_ids
+            #   The entity IDs to create the rule for.
+            #
+            #   @return [Array<String>, nil]
+            optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
             # @!attribute attributes
             #   Specifies the fields to be applied when the condition is met.
             #
@@ -41,7 +47,9 @@ module FinchAPI
             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: {})
+            # @!method initialize(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
+            #   @param entity_ids [Array<String>] The entity IDs to create the rule for.
+            #
             #   @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
             #
             #   @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>]

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

@@ -10,7 +10,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 delete the rule for.
+            #
+            #   @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 delete the rule for.
+            #
             #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
           end
         end

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

@@ -10,7 +10,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 retrieve rules for.
+            #
+            #   @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 retrieve rules for.
+            #
             #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
           end
         end

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

@@ -10,13 +10,22 @@ module FinchAPI
             extend FinchAPI::Internal::Type::RequestParameters::Converter
             include FinchAPI::Internal::Type::RequestParameters
 
+            # @!attribute entity_ids
+            #   The entity IDs to update the rule for.
+            #
+            #   @return [Array<String>, nil]
+            optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
             # @!attribute optional_property
             #
             #   @return [Object, nil]
             optional :optional_property, FinchAPI::Internal::Type::Unknown, api_name: :optionalProperty
 
-            # @!method initialize(optional_property: nil, request_options: {})
+            # @!method initialize(entity_ids: nil, optional_property: nil, request_options: {})
+            #   @param entity_ids [Array<String>] The entity IDs to update the rule for.
+            #
             #   @param optional_property [Object]
+            #
             #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
           end
         end

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

@@ -24,6 +24,12 @@ module FinchAPI
           #   @return [Date, nil]
           optional :end_date, Date
 
+          # @!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 name
           #   Case-insensitive partial match search by pay statement item name.
           #
@@ -43,7 +49,7 @@ module FinchAPI
           #   @return [String, nil]
           optional :type, String
 
-          # @!method initialize(categories: nil, end_date: nil, name: nil, start_date: nil, type: nil, request_options: {})
+          # @!method initialize(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
           #
@@ -51,6 +57,8 @@ module FinchAPI
           #
           #   @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
           #
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #
           #   @param name [String] Case-insensitive partial match search by pay statement item name.
           #
           #   @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date (

data/lib/finch_api/models/hris/company_retrieve_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/directory_list_individuals_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 limit
         #   Number of employees to return (defaults to all)
         #
@@ -20,7 +26,9 @@ module FinchAPI
         #   @return [Integer, nil]
         optional :offset, Integer
 
-        # @!method initialize(limit: nil, offset: nil, request_options: {})
+        # @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param limit [Integer] Number of employees to return (defaults to all)
         #
         #   @param offset [Integer] Index to start from (defaults to 0)

data/lib/finch_api/models/hris/directory_list_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 limit
         #   Number of employees to return (defaults to all)
         #
@@ -20,7 +26,9 @@ module FinchAPI
         #   @return [Integer, nil]
         optional :offset, Integer
 
-        # @!method initialize(limit: nil, offset: nil, request_options: {})
+        # @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param limit [Integer] Number of employees to return (defaults to all)
         #
         #   @param offset [Integer] Index to start from (defaults to 0)

data/lib/finch_api/models/hris/document_list_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 individual_ids
         #   Comma-delimited list of stable Finch uuids for each individual. If empty,
         #   defaults to all individuals
@@ -34,10 +40,12 @@ module FinchAPI
         #   @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil]
         optional :types, -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::DocumentListParams::Type] }
 
-        # @!method initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
+        # @!method initialize(entity_ids: nil, individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::DocumentListParams} for more details.
         #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param individual_ids [Array<String>] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul
         #
         #   @param limit [Integer] Number of documents to return (defaults to all)