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

data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi

@@ -16,6 +16,13 @@ module FinchAPI
               )
             end
 
+          # The entity IDs to specify which entities' data to access.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :entity_ids
+
+          sig { params(entity_ids: T::Array[String]).void }
+          attr_writer :entity_ids
+
           # Array of the individual_id to enroll and a configuration object.
           sig do
             returns(
@@ -40,6 +47,7 @@ module FinchAPI
 
           sig do
             params(
+              entity_ids: T::Array[String],
               individuals:
                 T::Array[
                   FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::OrHash
@@ -48,6 +56,8 @@ module FinchAPI
             ).returns(T.attached_class)
           end
           def self.new(
+            # The entity IDs to specify which entities' data to access.
+            entity_ids: nil,
             # Array of the individual_id to enroll and a configuration object.
             individuals: nil,
             request_options: {}
@@ -57,6 +67,7 @@ module FinchAPI
           sig do
             override.returns(
               {
+                entity_ids: T::Array[String],
                 individuals:
                   T::Array[
                     FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual
@@ -306,6 +317,29 @@ module FinchAPI
                 sig { params(amount: Integer).void }
                 attr_writer :amount
 
+                # Array of tier objects for tiered contribution matching (required when type is
+                # tiered)
+                sig do
+                  returns(
+                    T.nilable(
+                      T::Array[
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier
+                      ]
+                    )
+                  )
+                end
+                attr_reader :tiers
+
+                sig do
+                  params(
+                    tiers:
+                      T::Array[
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier::OrHash
+                      ]
+                  ).void
+                end
+                attr_writer :tiers
+
                 sig do
                   returns(
                     T.nilable(
@@ -326,6 +360,10 @@ module FinchAPI
                 sig do
                   params(
                     amount: Integer,
+                    tiers:
+                      T::Array[
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier::OrHash
+                      ],
                     type:
                       FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
                   ).returns(T.attached_class)
@@ -334,6 +372,9 @@ module FinchAPI
                   # Amount in cents for fixed type or basis points (1/100th of a percent) for
                   # percent type
                   amount: nil,
+                  # Array of tier objects for tiered contribution matching (required when type is
+                  # tiered)
+                  tiers: nil,
                   type: nil
                 )
                 end
@@ -342,6 +383,10 @@ module FinchAPI
                   override.returns(
                     {
                       amount: Integer,
+                      tiers:
+                        T::Array[
+                          FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier
+                        ],
                       type:
                         FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol
                     }
@@ -350,6 +395,43 @@ module FinchAPI
                 def to_hash
                 end
 
+                class Tier < FinchAPI::Internal::Type::BaseModel
+                  OrHash =
+                    T.type_alias do
+                      T.any(
+                        FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Tier,
+                        FinchAPI::Internal::AnyHash
+                      )
+                    end
+
+                  # The employer match percentage in basis points (0-10000 = 0-100%)
+                  sig { returns(Integer) }
+                  attr_accessor :match
+
+                  # The employee contribution threshold in basis points (0-10000 = 0-100%)
+                  sig { returns(Integer) }
+                  attr_accessor :threshold
+
+                  sig do
+                    params(match: Integer, threshold: Integer).returns(
+                      T.attached_class
+                    )
+                  end
+                  def self.new(
+                    # The employer match percentage in basis points (0-10000 = 0-100%)
+                    match:,
+                    # The employee contribution threshold in basis points (0-10000 = 0-100%)
+                    threshold:
+                  )
+                  end
+
+                  sig do
+                    override.returns({ match: Integer, threshold: Integer })
+                  end
+                  def to_hash
+                  end
+                end
+
                 module Type
                   extend FinchAPI::Internal::Type::Enum
 
@@ -372,6 +454,11 @@ module FinchAPI
                       :percent,
                       FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
                     )
+                  TIERED =
+                    T.let(
+                      :tiered,
+                      FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol
+                    )
 
                   sig do
                     override.returns(

data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi

@@ -16,16 +16,33 @@ module FinchAPI
               )
             end
 
+          # The entity IDs to specify which entities' data to access.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :entity_ids
+
+          sig { params(entity_ids: T::Array[String]).void }
+          attr_writer :entity_ids
+
           sig do
-            params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-              T.attached_class
-            )
+            params(
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(T.attached_class)
           end
-          def self.new(request_options: {})
+          def self.new(
+            # The entity IDs to specify which entities' data to access.
+            entity_ids: nil,
+            request_options: {}
+          )
           end
 
           sig do
-            override.returns({ request_options: FinchAPI::RequestOptions })
+            override.returns(
+              {
+                entity_ids: T::Array[String],
+                request_options: FinchAPI::RequestOptions
+              }
+            )
           end
           def to_hash
           end

data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi

@@ -16,6 +16,13 @@ module FinchAPI
               )
             end
 
+          # The entity IDs to specify which entities' data to access.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :entity_ids
+
+          sig { params(entity_ids: T::Array[String]).void }
+          attr_writer :entity_ids
+
           # comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals
           sig { returns(T.nilable(String)) }
@@ -26,11 +33,14 @@ module FinchAPI
 
           sig do
             params(
+              entity_ids: T::Array[String],
               individual_ids: String,
               request_options: FinchAPI::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
+            # The entity IDs to specify which entities' data to access.
+            entity_ids: nil,
             # comma-delimited list of stable Finch uuids for each individual. If empty,
             # defaults to all individuals
             individual_ids: nil,
@@ -41,6 +51,7 @@ module FinchAPI
           sig do
             override.returns(
               {
+                entity_ids: T::Array[String],
                 individual_ids: String,
                 request_options: FinchAPI::RequestOptions
               }

data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi

@@ -16,6 +16,13 @@ module FinchAPI
               )
             end
 
+          # The entity IDs to specify which entities' data to access.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :entity_ids
+
+          sig { params(entity_ids: T::Array[String]).void }
+          attr_writer :entity_ids
+
           # Array of individual_ids to unenroll.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :individual_ids
@@ -25,11 +32,14 @@ module FinchAPI
 
           sig do
             params(
+              entity_ids: T::Array[String],
               individual_ids: T::Array[String],
               request_options: FinchAPI::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
+            # The entity IDs to specify which entities' data to access.
+            entity_ids: nil,
             # Array of individual_ids to unenroll.
             individual_ids: nil,
             request_options: {}
@@ -39,6 +49,7 @@ module FinchAPI
           sig do
             override.returns(
               {
+                entity_ids: T::Array[String],
                 individual_ids: T::Array[String],
                 request_options: FinchAPI::RequestOptions
               }

data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi

@@ -17,6 +17,13 @@ module FinchAPI
                 )
               end
 
+            # The entity IDs to create the rule for.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :entity_ids
+
+            sig { params(entity_ids: T::Array[String]).void }
+            attr_writer :entity_ids
+
             # Specifies the fields to be applied when the condition is met.
             sig do
               returns(
@@ -84,6 +91,7 @@ module FinchAPI
 
             sig do
               params(
+                entity_ids: T::Array[String],
                 attributes:
                   FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash,
                 conditions:
@@ -98,6 +106,8 @@ module FinchAPI
               ).returns(T.attached_class)
             end
             def self.new(
+              # The entity IDs to create the rule for.
+              entity_ids: nil,
               # Specifies the fields to be applied when the condition is met.
               attributes: nil,
               conditions: nil,
@@ -114,6 +124,7 @@ module FinchAPI
             sig do
               override.returns(
                 {
+                  entity_ids: T::Array[String],
                   attributes:
                     FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes,
                   conditions:

data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi

@@ -17,16 +17,33 @@ module FinchAPI
                 )
               end
 
+            # The entity IDs to delete the rule for.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :entity_ids
+
+            sig { params(entity_ids: T::Array[String]).void }
+            attr_writer :entity_ids
+
             sig do
-              params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-                T.attached_class
-              )
+              params(
+                entity_ids: T::Array[String],
+                request_options: FinchAPI::RequestOptions::OrHash
+              ).returns(T.attached_class)
             end
-            def self.new(request_options: {})
+            def self.new(
+              # The entity IDs to delete the rule for.
+              entity_ids: nil,
+              request_options: {}
+            )
             end
 
             sig do
-              override.returns({ request_options: FinchAPI::RequestOptions })
+              override.returns(
+                {
+                  entity_ids: T::Array[String],
+                  request_options: FinchAPI::RequestOptions
+                }
+              )
             end
             def to_hash
             end

data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi

@@ -17,16 +17,33 @@ module FinchAPI
                 )
               end
 
+            # The entity IDs to retrieve rules for.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :entity_ids
+
+            sig { params(entity_ids: T::Array[String]).void }
+            attr_writer :entity_ids
+
             sig do
-              params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-                T.attached_class
-              )
+              params(
+                entity_ids: T::Array[String],
+                request_options: FinchAPI::RequestOptions::OrHash
+              ).returns(T.attached_class)
             end
-            def self.new(request_options: {})
+            def self.new(
+              # The entity IDs to retrieve rules for.
+              entity_ids: nil,
+              request_options: {}
+            )
             end
 
             sig do
-              override.returns({ request_options: FinchAPI::RequestOptions })
+              override.returns(
+                {
+                  entity_ids: T::Array[String],
+                  request_options: FinchAPI::RequestOptions
+                }
+              )
             end
             def to_hash
             end

data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi

@@ -17,6 +17,13 @@ module FinchAPI
                 )
               end
 
+            # The entity IDs to update the rule for.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :entity_ids
+
+            sig { params(entity_ids: T::Array[String]).void }
+            attr_writer :entity_ids
+
             sig { returns(T.nilable(T.anything)) }
             attr_reader :optional_property
 
@@ -25,16 +32,23 @@ module FinchAPI
 
             sig do
               params(
+                entity_ids: T::Array[String],
                 optional_property: T.anything,
                 request_options: FinchAPI::RequestOptions::OrHash
               ).returns(T.attached_class)
             end
-            def self.new(optional_property: nil, request_options: {})
+            def self.new(
+              # The entity IDs to update the rule for.
+              entity_ids: nil,
+              optional_property: nil,
+              request_options: {}
+            )
             end
 
             sig do
               override.returns(
                 {
+                  entity_ids: T::Array[String],
                   optional_property: T.anything,
                   request_options: FinchAPI::RequestOptions
                 }

data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi

@@ -47,6 +47,13 @@ module FinchAPI
           sig { params(end_date: Date).void }
           attr_writer :end_date
 
+          # The entity IDs to specify which entities' data to access.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :entity_ids
+
+          sig { params(entity_ids: T::Array[String]).void }
+          attr_writer :entity_ids
+
           # Case-insensitive partial match search by pay statement item name.
           sig { returns(T.nilable(String)) }
           attr_reader :name
@@ -76,6 +83,7 @@ module FinchAPI
                   FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
                 ],
               end_date: Date,
+              entity_ids: T::Array[String],
               name: String,
               start_date: Date,
               type: String,
@@ -89,6 +97,8 @@ module FinchAPI
             # The end date to retrieve pay statement items by via their last seen pay date in
             # `YYYY-MM-DD` format.
             end_date: nil,
+            # The entity IDs to specify which entities' data to access.
+            entity_ids: nil,
             # Case-insensitive partial match search by pay statement item name.
             name: nil,
             # The start date to retrieve pay statement items by via their last seen pay date
@@ -108,6 +118,7 @@ module FinchAPI
                     FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
                   ],
                 end_date: Date,
+                entity_ids: T::Array[String],
                 name: String,
                 start_date: Date,
                 type: String,

data/rbi/finch_api/models/hris/company_retrieve_params.rbi

@@ -15,15 +15,34 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            {
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi

@@ -15,6 +15,13 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         # Number of employees to return (defaults to all)
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
@@ -31,12 +38,15 @@ module FinchAPI
 
         sig do
           params(
+            entity_ids: T::Array[String],
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # Number of employees to return (defaults to all)
           limit: nil,
           # Index to start from (defaults to 0)
@@ -48,6 +58,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              entity_ids: T::Array[String],
               limit: Integer,
               offset: Integer,
               request_options: FinchAPI::RequestOptions

data/rbi/finch_api/models/hris/directory_list_params.rbi

@@ -15,6 +15,13 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         # Number of employees to return (defaults to all)
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
@@ -31,12 +38,15 @@ module FinchAPI
 
         sig do
           params(
+            entity_ids: T::Array[String],
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # Number of employees to return (defaults to all)
           limit: nil,
           # Index to start from (defaults to 0)
@@ -48,6 +58,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              entity_ids: T::Array[String],
               limit: Integer,
               offset: Integer,
               request_options: FinchAPI::RequestOptions

data/rbi/finch_api/models/hris/document_list_params.rbi

@@ -15,6 +15,13 @@ module FinchAPI
             )
           end
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         # Comma-delimited list of stable Finch uuids for each individual. If empty,
         # defaults to all individuals
         sig { returns(T.nilable(T::Array[String])) }
@@ -57,6 +64,7 @@ module FinchAPI
 
         sig do
           params(
+            entity_ids: T::Array[String],
             individual_ids: T::Array[String],
             limit: Integer,
             offset: Integer,
@@ -65,6 +73,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals
           individual_ids: nil,
@@ -82,6 +92,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              entity_ids: T::Array[String],
               individual_ids: T::Array[String],
               limit: Integer,
               offset: Integer,