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

data/rbi/finch_api/models/payroll/pay_group_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
 
@@ -45,7 +47,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,
           individual_id: nil,
           pay_frequencies: nil,

data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi

@@ -19,7 +19,9 @@ module FinchAPI
         attr_accessor :pay_group_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(
           pay_group_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: {}
         )