finch-api 0.1.0.pre.alpha.48 → 0.1.0.pre.alpha.49

data/rbi/finch_api/resources/hris/company.rbi

@@ -12,7 +12,8 @@ module FinchAPI
           ).returns(FinchAPI::HRIS::HRISCompany)
         end
         def retrieve(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/directory.rbi

@@ -18,7 +18,8 @@ module FinchAPI
           )
         end
         def list(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,

data/rbi/finch_api/resources/hris/documents.rbi

@@ -17,7 +17,8 @@ module FinchAPI
           ).returns(FinchAPI::Models::HRIS::DocumentListResponse)
         end
         def list(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals
@@ -45,7 +46,8 @@ module FinchAPI
         def retreive(
           # The unique identifier of the document.
           document_id,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/employments.rbi

@@ -22,7 +22,8 @@ module FinchAPI
         def retrieve_many(
           # Body param: The array of batch requests. Maximum 10000 items per request.
           requests:,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: The entity IDs to specify which entities' data to access. Provide
+          # exactly one entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/individuals.rbi

@@ -26,7 +26,8 @@ module FinchAPI
         def retrieve_many(
           # Body param: The array of batch requests. Maximum 10000 items per request.
           requests:,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: The entity IDs to specify which entities' data to access. Provide
+          # exactly one entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # Body param
           options: nil,

data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi

@@ -28,7 +28,8 @@ module FinchAPI
             )
           end
           def create(
-            # Query param: The entity IDs to create the rule for.
+            # Query param: The entity IDs to create the rule for. Provide exactly one entity
+            # ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # Body param: Specifies the fields to be applied when the condition is met.
             attributes: nil,
@@ -59,7 +60,8 @@ module FinchAPI
           def update(
             # Path param
             rule_id,
-            # Query param: The entity IDs to update the rule for.
+            # Query param: The entity IDs to update the rule for. Provide exactly one entity
+            # ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # Body param
             optional_property: nil,
@@ -79,7 +81,8 @@ module FinchAPI
             )
           end
           def list(
-            # The entity IDs to retrieve rules for.
+            # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
+            # a maximum of one is accepted.
             entity_ids: nil,
             request_options: {}
           )
@@ -97,7 +100,8 @@ module FinchAPI
           end
           def delete(
             rule_id,
-            # The entity IDs to delete the rule for.
+            # The entity IDs to delete the rule for. Provide exactly one entity ID per
+            # request; a maximum of one is accepted.
             entity_ids: nil,
             request_options: {}
           )

data/rbi/finch_api/resources/hris/pay_statement_item.rbi

@@ -34,7 +34,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.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # Case-insensitive partial match search by pay statement item name.
           name: nil,

data/rbi/finch_api/resources/hris/pay_statements.rbi

@@ -25,7 +25,8 @@ module FinchAPI
         def retrieve_many(
           # Body param: The array of batch requests. Maximum 10 payment_ids per request.
           requests:,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: The entity IDs to specify which entities' data to access. Provide
+          # exactly one entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/payments.rbi

@@ -20,7 +20,8 @@ module FinchAPI
           # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
           # format. Filters payments by their **pay_date** field.
           start_date:,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/payroll/pay_groups.rbi

@@ -14,7 +14,8 @@ module FinchAPI
         end
         def retrieve(
           pay_group_id,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )
@@ -34,7 +35,8 @@ module FinchAPI
           )
         end
         def list(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           individual_id: nil,
           pay_frequencies: nil,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.48
+  version: 0.1.0.pre.alpha.49
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-13 00:00:00.000000000 Z
+date: 2026-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi