finch-api 0.1.0.pre.alpha.59 → 0.1.0.pre.alpha.61

data/rbi/finch_api/models/connect/session_new_params.rbi

@@ -80,7 +80,9 @@ module FinchAPI
         end
         attr_writer :recordkeeping
 
-        # The URI to redirect to after the Connect flow is completed
+        # The URI to redirect to after the Connect flow is completed. Required if you use
+        # the redirect flow, and it must be registered on the Credentials tab of the Finch
+        # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
         sig { returns(T.nilable(String)) }
         attr_accessor :redirect_uri
 
@@ -137,7 +139,9 @@ module FinchAPI
           # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
           # `voya`, `empower`, `fidelity`, or `transamerica`.
           recordkeeping: nil,
-          # The URI to redirect to after the Connect flow is completed
+          # The URI to redirect to after the Connect flow is completed. Required if you use
+          # the redirect flow, and it must be registered on the Credentials tab of the Finch
+          # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
           redirect_uri: nil,
           # Sandbox mode for testing
           sandbox: nil,

data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi

@@ -41,7 +41,9 @@ module FinchAPI
         end
         attr_accessor :products
 
-        # The URI to redirect to after the Connect flow is completed
+        # The URI to redirect to after the Connect flow is completed. Required if you use
+        # the redirect flow, and it must be registered on the Credentials tab of the Finch
+        # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
         sig { returns(T.nilable(String)) }
         attr_accessor :redirect_uri
 
@@ -69,7 +71,9 @@ module FinchAPI
           # `benefits` to access deductions endpoints — `deduction` is a deprecated alias
           # that is still accepted but should not be combined with `benefits`.
           products: nil,
-          # The URI to redirect to after the Connect flow is completed
+          # The URI to redirect to after the Connect flow is completed. Required if you use
+          # the redirect flow, and it must be registered on the Credentials tab of the Finch
+          # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
           redirect_uri: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_create_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -73,7 +75,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # The company match for this benefit.
           company_contribution: nil,

data/rbi/finch_api/models/hris/benefit_list_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -31,7 +33,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -31,7 +33,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_register_params.rbi

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -48,7 +50,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           description: nil,
           # The frequency of the benefit deduction/contribution.

data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi

@@ -19,7 +19,9 @@ module FinchAPI
         attr_accessor :benefit_id
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -36,7 +38,9 @@ module FinchAPI
         def self.new(
           benefit_id:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_update_params.rbi

@@ -19,7 +19,9 @@ module FinchAPI
         attr_accessor :benefit_id
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -44,7 +46,9 @@ module FinchAPI
         def self.new(
           benefit_id:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Updated name or description.
           description: nil,

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

@@ -20,7 +20,9 @@ module FinchAPI
           attr_accessor :benefit_id
 
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -63,7 +65,9 @@ module FinchAPI
           def self.new(
             benefit_id:,
             # The entity IDs to specify which entities' data to access. Provide exactly one
-            # entity ID per request; a maximum of one is accepted.
+            # entity ID per request; a maximum of one is accepted. Required when the
+            # connection has more than one entity — omitting it returns a `400`
+            # `invalid_request_error`. Optional for single-entity connections.
             entity_ids: nil,
             # Array of the individual_id to enroll and a configuration object.
             individuals: nil,

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

@@ -20,7 +20,9 @@ module FinchAPI
           attr_accessor :benefit_id
 
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -37,7 +39,9 @@ module FinchAPI
           def self.new(
             benefit_id:,
             # The entity IDs to specify which entities' data to access. Provide exactly one
-            # entity ID per request; a maximum of one is accepted.
+            # entity ID per request; a maximum of one is accepted. Required when the
+            # connection has more than one entity — omitting it returns a `400`
+            # `invalid_request_error`. Optional for single-entity connections.
             entity_ids: nil,
             request_options: {}
           )

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

@@ -20,7 +20,9 @@ module FinchAPI
           attr_accessor :benefit_id
 
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -46,7 +48,9 @@ module FinchAPI
           def self.new(
             benefit_id:,
             # The entity IDs to specify which entities' data to access. Provide exactly one
-            # entity ID per request; a maximum of one is accepted.
+            # entity ID per request; a maximum of one is accepted. Required when the
+            # connection has more than one entity — omitting it returns a `400`
+            # `invalid_request_error`. Optional for single-entity connections.
             entity_ids: nil,
             # comma-delimited list of stable Finch uuids for each individual. If empty,
             # defaults to all individuals

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

@@ -20,7 +20,9 @@ module FinchAPI
           attr_accessor :benefit_id
 
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -45,7 +47,9 @@ module FinchAPI
           def self.new(
             benefit_id:,
             # The entity IDs to specify which entities' data to access. Provide exactly one
-            # entity ID per request; a maximum of one is accepted.
+            # entity ID per request; a maximum of one is accepted. Required when the
+            # connection has more than one entity — omitting it returns a `400`
+            # `invalid_request_error`. Optional for single-entity connections.
             entity_ids: nil,
             # Array of individual_ids to unenroll.
             individual_ids: nil,

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

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -31,7 +33,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

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

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -47,7 +49,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,

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

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -47,7 +49,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,

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

@@ -16,7 +16,9 @@ module FinchAPI
           end
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -75,7 +77,9 @@ module FinchAPI
         end
         def self.new(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals

data/rbi/finch_api/models/hris/document_retreive_params.rbi

@@ -19,7 +19,9 @@ module FinchAPI
         attr_accessor :document_id
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -36,7 +38,9 @@ module FinchAPI
         def self.new(
           document_id:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/employment_data.rbi

@@ -27,6 +27,12 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :id
 
+          # The employer defined benefit eligibility class that groups an employee into a
+          # set of eligible benefit plans, as stored by the provider. Null when not
+          # configured.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :benefit_eligibility_class
+
           # Worker's compensation classification code for this employee
           sig { returns(T.nilable(String)) }
           attr_accessor :class_code
@@ -204,6 +210,7 @@ module FinchAPI
           sig do
             params(
               id: String,
+              benefit_eligibility_class: T.nilable(String),
               class_code: T.nilable(String),
               department:
                 T.nilable(
@@ -254,6 +261,10 @@ module FinchAPI
           def self.new(
             # A stable Finch `id` (UUID v4) for an individual in the company.
             id:,
+            # The employer defined benefit eligibility class that groups an employee into a
+            # set of eligible benefit plans, as stored by the provider. Null when not
+            # configured.
+            benefit_eligibility_class:,
             # Worker's compensation classification code for this employee
             class_code:,
             # The department object.
@@ -313,6 +324,7 @@ module FinchAPI
             override.returns(
               {
                 id: String,
+                benefit_eligibility_class: T.nilable(String),
                 class_code: T.nilable(String),
                 department:
                   T.nilable(

data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi

@@ -24,7 +24,9 @@ module FinchAPI
         attr_accessor :requests
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -45,7 +47,9 @@ module FinchAPI
           # The array of batch requests. Maximum 10000 items per request.
           requests:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi

@@ -24,7 +24,9 @@ module FinchAPI
         attr_accessor :requests
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -66,7 +68,9 @@ module FinchAPI
           # The array of batch requests. Maximum 10000 items per request.
           requests:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           options: nil,
           request_options: {}

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

@@ -17,7 +17,9 @@ module FinchAPI
             end
 
           # The entity IDs to create the rule for. Provide exactly one entity ID per
-          # request; a maximum of one is accepted.
+          # request; a maximum of one is accepted. Required when the connection has more
+          # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          # for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -107,7 +109,9 @@ module FinchAPI
           end
           def self.new(
             # The entity IDs to create the rule for. Provide exactly one entity ID per
-            # request; a maximum of one is accepted.
+            # request; a maximum of one is accepted. Required when the connection has more
+            # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+            # for single-entity connections.
             entity_ids: nil,
             # Specifies the fields to be applied when the condition is met.
             attributes: nil,

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

@@ -20,7 +20,9 @@ module FinchAPI
           attr_accessor :rule_id
 
           # The entity IDs to delete the rule for. Provide exactly one entity ID per
-          # request; a maximum of one is accepted.
+          # request; a maximum of one is accepted. Required when the connection has more
+          # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          # for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -37,7 +39,9 @@ module FinchAPI
           def self.new(
             rule_id:,
             # The entity IDs to delete the rule for. Provide exactly one entity ID per
-            # request; a maximum of one is accepted.
+            # request; a maximum of one is accepted. Required when the connection has more
+            # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+            # for single-entity connections.
             entity_ids: nil,
             request_options: {}
           )

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

@@ -17,7 +17,9 @@ module FinchAPI
             end
 
           # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
-          # a maximum of one is accepted.
+          # a maximum of one is accepted. Required when the connection has more than one
+          # entity — omitting it returns a `400` `invalid_request_error`. Optional for
+          # single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -32,7 +34,9 @@ module FinchAPI
           end
           def self.new(
             # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
-            # a maximum of one is accepted.
+            # a maximum of one is accepted. Required when the connection has more than one
+            # entity — omitting it returns a `400` `invalid_request_error`. Optional for
+            # single-entity connections.
             entity_ids: nil,
             request_options: {}
           )

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

@@ -20,7 +20,9 @@ module FinchAPI
           attr_accessor :rule_id
 
           # The entity IDs to update the rule for. Provide exactly one entity ID per
-          # request; a maximum of one is accepted.
+          # request; a maximum of one is accepted. Required when the connection has more
+          # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          # for single-entity connections.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -44,7 +46,9 @@ module FinchAPI
           def self.new(
             rule_id:,
             # The entity IDs to update the rule for. Provide exactly one entity ID per
-            # request; a maximum of one is accepted.
+            # request; a maximum of one is accepted. Required when the connection has more
+            # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+            # for single-entity connections.
             entity_ids: nil,
             optional_property: nil,
             request_options: {}

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

@@ -47,7 +47,9 @@ module FinchAPI
         attr_writer :end_date
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -98,7 +100,9 @@ module FinchAPI
           # `YYYY-MM-DD` format.
           end_date: nil,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Case-insensitive partial match search by pay statement item name.
           name: nil,

data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi

@@ -24,7 +24,9 @@ module FinchAPI
         attr_accessor :requests
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -45,7 +47,9 @@ module FinchAPI
           # The array of batch requests. Maximum 10 payment_ids per request.
           requests:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/payment_list_params.rbi

@@ -26,7 +26,9 @@ module FinchAPI
         attr_accessor :start_date
 
         # The entity IDs to specify which entities' data to access. Provide exactly one
-        # entity ID per request; a maximum of one is accepted.
+        # entity ID per request; a maximum of one is accepted. Required when the
+        # connection has more than one entity — omitting it returns a `400`
+        # `invalid_request_error`. Optional for single-entity connections.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -49,7 +51,9 @@ module FinchAPI
           # format. Filters payments by their **pay_date** field.
           start_date:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )