finch-api 2.2.0__tar.gz → 2.4.0__tar.gz

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

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

{finch_api-2.2.0 → finch_api-2.4.0}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 2.4.0 (2026-07-17)
+
+Full Changelog: [v2.3.0...v2.4.0](https://github.com/Finch-API/finch-api-python/compare/v2.3.0...v2.4.0)
+
+### Features
+
+* **api:** api update ([f616b88](https://github.com/Finch-API/finch-api-python/commit/f616b8826871f77486b927b29ed76839bb519a17))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([8848074](https://github.com/Finch-API/finch-api-python/commit/88480743771a3345f4a7f95f2cae55978d9ec37e))
+
+## 2.3.0 (2026-07-15)
+
+Full Changelog: [v2.2.0...v2.3.0](https://github.com/Finch-API/finch-api-python/compare/v2.2.0...v2.3.0)
+
+### Features
+
+* **api:** api update ([0ce8204](https://github.com/Finch-API/finch-api-python/commit/0ce82044eb0ab15456c6e0f5a920c43db35802e8))
+
 ## 2.2.0 (2026-07-13)
 
 Full Changelog: [v2.1.0...v2.2.0](https://github.com/Finch-API/finch-api-python/compare/v2.1.0...v2.2.0)

{finch_api-2.2.0 → finch_api-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: finch-api
-Version: 2.2.0
+Version: 2.4.0
 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.2.0 → finch_api-2.4.0}/pyproject.toml

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

{finch_api-2.2.0 → finch_api-2.4.0}/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.2.0"  # x-release-please-version
+__version__ = "2.4.0"  # x-release-please-version

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/benefits/benefits.py

@@ -88,7 +88,8 @@ class Benefits(SyncAPIResource):
         `/providers` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           company_contribution: The company match for this benefit.
 
@@ -146,7 +147,8 @@ class Benefits(SyncAPIResource):
         Lists deductions and contributions information for a given item
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -188,7 +190,8 @@ class Benefits(SyncAPIResource):
         Updates an existing company-wide deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           description: Updated name or description.
 
@@ -231,7 +234,8 @@ class Benefits(SyncAPIResource):
         List all company-wide deductions and contributions.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -270,7 +274,8 @@ class Benefits(SyncAPIResource):
         Get deductions metadata
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -316,7 +321,8 @@ class Benefits(SyncAPIResource):
         Please use the `/provider` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           frequency: The frequency of the benefit deduction/contribution.
 
@@ -397,7 +403,8 @@ class AsyncBenefits(AsyncAPIResource):
         `/providers` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           company_contribution: The company match for this benefit.
 
@@ -457,7 +464,8 @@ class AsyncBenefits(AsyncAPIResource):
         Lists deductions and contributions information for a given item
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -501,7 +509,8 @@ class AsyncBenefits(AsyncAPIResource):
         Updates an existing company-wide deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           description: Updated name or description.
 
@@ -546,7 +555,8 @@ class AsyncBenefits(AsyncAPIResource):
         List all company-wide deductions and contributions.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -585,7 +595,8 @@ class AsyncBenefits(AsyncAPIResource):
         Get deductions metadata
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -631,7 +642,8 @@ class AsyncBenefits(AsyncAPIResource):
         Please use the `/provider` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           frequency: The frequency of the benefit deduction/contribution.
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/benefits/individuals.py

@@ -69,7 +69,8 @@ class Individuals(SyncAPIResource):
         enrollments, but will continue to set the state of the existing enrollment.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individuals: Array of the individual_id to enroll and a configuration object.
 
@@ -115,7 +116,8 @@ class Individuals(SyncAPIResource):
         Lists individuals currently enrolled in a given deduction.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -159,7 +161,8 @@ class Individuals(SyncAPIResource):
         Get enrollment information for the given individuals.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -211,7 +214,8 @@ class Individuals(SyncAPIResource):
         Unenroll individuals from a deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individual_ids: Array of individual_ids to unenroll.
 
@@ -285,7 +289,8 @@ class AsyncIndividuals(AsyncAPIResource):
         enrollments, but will continue to set the state of the existing enrollment.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individuals: Array of the individual_id to enroll and a configuration object.
 
@@ -331,7 +336,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Lists individuals currently enrolled in a given deduction.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -375,7 +381,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Get enrollment information for the given individuals.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -427,7 +434,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Unenroll individuals from a deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individual_ids: Array of individual_ids to unenroll.
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/company.py

@@ -52,7 +52,8 @@ class CompanyResource(SyncAPIResource):
         Read basic company data
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -111,7 +112,8 @@ class AsyncCompanyResource(AsyncAPIResource):
         Read basic company data
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/directory.py

@@ -57,7 +57,8 @@ class Directory(SyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 
@@ -110,7 +111,8 @@ class Directory(SyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 
@@ -172,7 +174,8 @@ class AsyncDirectory(AsyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 
@@ -225,7 +228,8 @@ class AsyncDirectory(AsyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           limit: Number of employees to return (defaults to 100, maximum 10000)
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/documents.py

@@ -62,7 +62,8 @@ class Documents(SyncAPIResource):
         company-wide documents.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -122,7 +123,8 @@ class Documents(SyncAPIResource):
         specific document by its ID.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -194,7 +196,8 @@ class AsyncDocuments(AsyncAPIResource):
         company-wide documents.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -254,7 +257,8 @@ class AsyncDocuments(AsyncAPIResource):
         specific document by its ID.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/employments.py

@@ -58,7 +58,8 @@ class Employments(SyncAPIResource):
         Args:
           requests: The array of batch requests. Maximum 10000 items per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -125,7 +126,8 @@ class AsyncEmployments(AsyncAPIResource):
         Args:
           requests: The array of batch requests. Maximum 10000 items per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/individuals.py

@@ -59,7 +59,8 @@ class Individuals(SyncAPIResource):
         Args:
           requests: The array of batch requests. Maximum 10000 items per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -133,7 +134,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Args:
           requests: The array of batch requests. Maximum 10000 items per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/pay_statement_item/pay_statement_item.py

@@ -81,7 +81,8 @@ class PayStatementItem(SyncAPIResource):
           end_date: The end date to retrieve pay statement items by via their last seen pay date in
               `YYYY-MM-DD` format.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           name: Case-insensitive partial match search by pay statement item name.
 
@@ -174,7 +175,8 @@ class AsyncPayStatementItem(AsyncAPIResource):
           end_date: The end date to retrieve pay statement items by via their last seen pay date in
               `YYYY-MM-DD` format.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           name: Case-insensitive partial match search by pay statement item name.
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/pay_statement_item/rules.py

@@ -72,7 +72,8 @@ class Rules(SyncAPIResource):
         retrieved where pay statement item information is available.
 
         Args:
-          entity_ids: The entity IDs to create the rule for.
+          entity_ids: The entity IDs to create the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           attributes: Specifies the fields to be applied when the condition is met.
 
@@ -130,7 +131,8 @@ class Rules(SyncAPIResource):
         Update a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to update the rule for.
+          entity_ids: The entity IDs to update the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -171,7 +173,8 @@ class Rules(SyncAPIResource):
         List all rules of a connection account.
 
         Args:
-          entity_ids: The entity IDs to retrieve rules for.
+          entity_ids: The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
+              a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -211,7 +214,8 @@ class Rules(SyncAPIResource):
         Delete a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to delete the rule for.
+          entity_ids: The entity IDs to delete the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -280,7 +284,8 @@ class AsyncRules(AsyncAPIResource):
         retrieved where pay statement item information is available.
 
         Args:
-          entity_ids: The entity IDs to create the rule for.
+          entity_ids: The entity IDs to create the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           attributes: Specifies the fields to be applied when the condition is met.
 
@@ -338,7 +343,8 @@ class AsyncRules(AsyncAPIResource):
         Update a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to update the rule for.
+          entity_ids: The entity IDs to update the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -381,7 +387,8 @@ class AsyncRules(AsyncAPIResource):
         List all rules of a connection account.
 
         Args:
-          entity_ids: The entity IDs to retrieve rules for.
+          entity_ids: The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
+              a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -421,7 +428,8 @@ class AsyncRules(AsyncAPIResource):
         Delete a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to delete the rule for.
+          entity_ids: The entity IDs to delete the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/pay_statements.py

@@ -61,7 +61,8 @@ class PayStatements(SyncAPIResource):
         Args:
           requests: The array of batch requests. Maximum 10 payment_ids per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -133,7 +134,8 @@ class AsyncPayStatements(AsyncAPIResource):
         Args:
           requests: The array of batch requests. Maximum 10 payment_ids per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/hris/payments.py

@@ -64,7 +64,8 @@ class Payments(SyncAPIResource):
           start_date: The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
               format. Filters payments by their **pay_date** field.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -139,7 +140,8 @@ class AsyncPayments(AsyncAPIResource):
           start_date: The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
               format. Filters payments by their **pay_date** field.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 

{finch_api-2.2.0 → finch_api-2.4.0}/src/finch/resources/payroll/pay_groups.py

@@ -55,7 +55,8 @@ class PayGroups(SyncAPIResource):
         Read information from a single pay group
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -97,7 +98,8 @@ class PayGroups(SyncAPIResource):
         Read company pay groups and frequencies
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -165,7 +167,8 @@ class AsyncPayGroups(AsyncAPIResource):
         Read information from a single pay group
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers
 
@@ -209,7 +212,8 @@ class AsyncPayGroups(AsyncAPIResource):
         Read company pay groups and frequencies
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          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.
 
           extra_headers: Send extra headers