finch-api 2.9.0__tar.gz → 2.9.2__tar.gz

finch_api-2.9.2/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.9.2"
+}

{finch_api-2.9.0 → finch_api-2.9.2}/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [2.9.2](https://github.com/Finch-API/finch-api-python/compare/v2.9.1...v2.9.2) (2026-10-30)
+
+
+### Documentation
+
+* **spec:** fix OpenAPI lint errors flagged by Unum's Spectral review [DDR-984] ([68113a0](https://github.com/Finch-API/finch-api-python/commit/68113a01e87a6dad5f442b6524a053e7808c79fe))
+
+## [2.9.1](https://github.com/Finch-API/finch-api-python/compare/v2.9.0...v2.9.1) (2026-10-22)
+
+
+### Documentation
+
+* **spec:** clarify redirect_uri requirement on connect and token endpoints [DDR-1050] ([3eca067](https://github.com/Finch-API/finch-api-python/commit/3eca067f301fa924c977fe7e6b49233906e3ac44))
+* **spec:** document missing entity_ids error for multi-entity connections [DDR-1051] ([b66faa8](https://github.com/Finch-API/finch-api-python/commit/b66faa896620ec693a3aef28a01decd90b402b13))
+
 ## [2.9.0](https://github.com/Finch-API/finch-api-python/compare/v2.8.3...v2.9.0) (2026-10-13)
 
 

{finch_api-2.9.0 → finch_api-2.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: finch-api
-Version: 2.9.0
+Version: 2.9.2
 Summary: The official Python library for the Finch API
 Project-URL: Homepage, https://github.com/Finch-API/finch-api-python
 Project-URL: Repository, https://github.com/Finch-API/finch-api-python

{finch_api-2.9.0 → finch_api-2.9.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "finch-api"
-version = "2.9.0"
+version = "2.9.2"
 description = "The official Python library for the Finch API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "finch"
-__version__ = "2.9.0"  # x-release-please-version
+__version__ = "2.9.2"  # x-release-please-version

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/access_tokens.py

@@ -61,7 +61,10 @@ class AccessTokens(SyncAPIResource):
 
           client_secret: The client secret for your application
 
-          redirect_uri: The redirect URI used in the authorization request (optional)
+          redirect_uri: The redirect URI used when creating the Connect session. Required if the
+              authorization code came from the redirect flow, and it must match the
+              `redirect_uri` used to create the session. Omit it if the code came from the
+              embedded flow (Connect SDK).
 
           extra_headers: Send extra headers
 
@@ -153,7 +156,10 @@ class AsyncAccessTokens(AsyncAPIResource):
 
           client_secret: The client secret for your application
 
-          redirect_uri: The redirect URI used in the authorization request (optional)
+          redirect_uri: The redirect URI used when creating the Connect session. Required if the
+              authorization code came from the redirect flow, and it must match the
+              `redirect_uri` used to create the session. Omit it if the code came from the
+              embedded flow (Connect SDK).
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/connect/sessions.py

@@ -103,7 +103,9 @@ class Sessions(SyncAPIResource):
               `recordkeeping` product is requested. Currently supports `recordkeeper` set to
               `voya`, `empower`, `fidelity`, or `transamerica`.
 
-          redirect_uri: The URI to redirect to after the Connect flow is completed
+          redirect_uri: 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).
 
           sandbox: Sandbox mode for testing
 
@@ -183,13 +185,15 @@ class Sessions(SyncAPIResource):
           connection_id: The ID of the existing connection to reauthenticate
 
           minutes_to_expire: The number of minutes until the session expires (defaults to 43,200, which is 30
-              days)
+              days). Must be between 1 and 129,600 (90 days).
 
           products: The products to request access to (optional for reauthentication). Use
               `benefits` to access deductions endpoints — `deduction` is a deprecated alias
               that is still accepted but should not be combined with `benefits`.
 
-          redirect_uri: The URI to redirect to after the Connect flow is completed
+          redirect_uri: 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).
 
           extra_headers: Send extra headers
 
@@ -303,7 +307,9 @@ class AsyncSessions(AsyncAPIResource):
               `recordkeeping` product is requested. Currently supports `recordkeeper` set to
               `voya`, `empower`, `fidelity`, or `transamerica`.
 
-          redirect_uri: The URI to redirect to after the Connect flow is completed
+          redirect_uri: 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).
 
           sandbox: Sandbox mode for testing
 
@@ -383,13 +389,15 @@ class AsyncSessions(AsyncAPIResource):
           connection_id: The ID of the existing connection to reauthenticate
 
           minutes_to_expire: The number of minutes until the session expires (defaults to 43,200, which is 30
-              days)
+              days). Must be between 1 and 129,600 (90 days).
 
           products: The products to request access to (optional for reauthentication). Use
               `benefits` to access deductions endpoints — `deduction` is a deprecated alias
               that is still accepted but should not be combined with `benefits`.
 
-          redirect_uri: The URI to redirect to after the Connect flow is completed
+          redirect_uri: 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).
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/benefits/benefits.py

@@ -89,7 +89,9 @@ class Benefits(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           company_contribution: The company match for this benefit.
 
@@ -148,7 +150,9 @@ class Benefits(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -191,7 +195,9 @@ class Benefits(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           description: Updated name or description.
 
@@ -235,7 +241,9 @@ class Benefits(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -275,7 +283,9 @@ class Benefits(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -322,7 +332,9 @@ class Benefits(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           frequency: The frequency of the benefit deduction/contribution.
 
@@ -404,7 +416,9 @@ class AsyncBenefits(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           company_contribution: The company match for this benefit.
 
@@ -465,7 +479,9 @@ class AsyncBenefits(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -510,7 +526,9 @@ class AsyncBenefits(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           description: Updated name or description.
 
@@ -556,7 +574,9 @@ class AsyncBenefits(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -596,7 +616,9 @@ class AsyncBenefits(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -643,7 +665,9 @@ class AsyncBenefits(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           frequency: The frequency of the benefit deduction/contribution.
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/benefits/individuals.py

@@ -70,7 +70,9 @@ class Individuals(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individuals: Array of the individual_id to enroll and a configuration object.
 
@@ -117,7 +119,9 @@ class Individuals(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -162,7 +166,9 @@ class Individuals(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -215,7 +221,9 @@ class Individuals(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individual_ids: Array of individual_ids to unenroll.
 
@@ -290,7 +298,9 @@ class AsyncIndividuals(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individuals: Array of the individual_id to enroll and a configuration object.
 
@@ -337,7 +347,9 @@ class AsyncIndividuals(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -382,7 +394,9 @@ class AsyncIndividuals(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -435,7 +449,9 @@ class AsyncIndividuals(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individual_ids: Array of individual_ids to unenroll.
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/company.py

@@ -53,7 +53,9 @@ class CompanyResource(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -113,7 +115,9 @@ class AsyncCompanyResource(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/directory.py

@@ -58,7 +58,9 @@ class Directory(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 
@@ -112,7 +114,9 @@ class Directory(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 
@@ -175,7 +179,9 @@ class AsyncDirectory(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 
@@ -229,7 +235,9 @@ class AsyncDirectory(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/documents.py

@@ -63,7 +63,9 @@ class Documents(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -124,7 +126,9 @@ class Documents(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -197,7 +201,9 @@ class AsyncDocuments(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -258,7 +264,9 @@ class AsyncDocuments(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/employments.py

@@ -59,7 +59,9 @@ class Employments(SyncAPIResource):
           requests: The array of batch requests. Maximum 10000 items per request.
 
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -127,7 +129,9 @@ class AsyncEmployments(AsyncAPIResource):
           requests: The array of batch requests. Maximum 10000 items per request.
 
           entity_ids: 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.
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/individuals.py

@@ -60,7 +60,9 @@ class Individuals(SyncAPIResource):
           requests: The array of batch requests. Maximum 10000 items per request.
 
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -135,7 +137,9 @@ class AsyncIndividuals(AsyncAPIResource):
           requests: The array of batch requests. Maximum 10000 items per request.
 
           entity_ids: 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.
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/pay_statement_item/pay_statement_item.py

@@ -82,7 +82,9 @@ class PayStatementItem(SyncAPIResource):
               `YYYY-MM-DD` format.
 
           entity_ids: 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.
 
           name: Case-insensitive partial match search by pay statement item name.
 
@@ -176,7 +178,9 @@ class AsyncPayStatementItem(AsyncAPIResource):
               `YYYY-MM-DD` format.
 
           entity_ids: 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.
 
           name: Case-insensitive partial match search by pay statement item name.
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/pay_statement_item/rules.py

@@ -73,7 +73,9 @@ class Rules(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           attributes: Specifies the fields to be applied when the condition is met.
 
@@ -132,7 +134,9 @@ class Rules(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -174,7 +178,9 @@ class Rules(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -215,7 +221,9 @@ class Rules(SyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -285,7 +293,9 @@ class AsyncRules(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           attributes: Specifies the fields to be applied when the condition is met.
 
@@ -344,7 +354,9 @@ class AsyncRules(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -388,7 +400,9 @@ class AsyncRules(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -429,7 +443,9 @@ class AsyncRules(AsyncAPIResource):
 
         Args:
           entity_ids: 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.
 
           extra_headers: Send extra headers
 

{finch_api-2.9.0 → finch_api-2.9.2}/src/finch/resources/hris/pay_statements.py

@@ -62,7 +62,9 @@ class PayStatements(SyncAPIResource):
           requests: The array of batch requests. Maximum 10 payment_ids per request.
 
           entity_ids: 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.
 
           extra_headers: Send extra headers
 
@@ -135,7 +137,9 @@ class AsyncPayStatements(AsyncAPIResource):
           requests: The array of batch requests. Maximum 10 payment_ids per request.
 
           entity_ids: 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.
 
           extra_headers: Send extra headers