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

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

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

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

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([2e8eab2](https://github.com/Finch-API/finch-api-python/commit/2e8eab2ee284482e6ed1070156bb378570cbc194))
+
+## 2.1.0 (2026-07-01)
+
+Full Changelog: [v2.0.0...v2.1.0](https://github.com/Finch-API/finch-api-python/compare/v2.0.0...v2.1.0)
+
+### Features
+
+* **api:** api update ([cd40e57](https://github.com/Finch-API/finch-api-python/commit/cd40e57ab21198dd2bba3c97711c30d8adf30fe4))
+
 ## 2.0.0 (2026-06-22)
 
 Full Changelog: [v1.46.0...v2.0.0](https://github.com/Finch-API/finch-api-python/compare/v1.46.0...v2.0.0)

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

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

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

{finch_api-2.0.0 → finch_api-2.2.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.0.0"  # x-release-please-version
+__version__ = "2.2.0"  # x-release-please-version

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

@@ -59,7 +59,7 @@ class Directory(SyncAPIResource):
         Args:
           entity_ids: The entity IDs to specify which entities' data to access.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 
@@ -112,7 +112,7 @@ class Directory(SyncAPIResource):
         Args:
           entity_ids: The entity IDs to specify which entities' data to access.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 
@@ -174,7 +174,7 @@ class AsyncDirectory(AsyncAPIResource):
         Args:
           entity_ids: The entity IDs to specify which entities' data to access.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 
@@ -227,7 +227,7 @@ class AsyncDirectory(AsyncAPIResource):
         Args:
           entity_ids: The entity IDs to specify which entities' data to access.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 

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

@@ -56,7 +56,7 @@ class Employments(SyncAPIResource):
         Read individual employment and income data
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10000 items per request.
 
           entity_ids: The entity IDs to specify which entities' data to access.
 
@@ -123,7 +123,7 @@ class AsyncEmployments(AsyncAPIResource):
         Read individual employment and income data
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10000 items per request.
 
           entity_ids: The entity IDs to specify which entities' data to access.
 

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

@@ -43,9 +43,9 @@ class Individuals(SyncAPIResource):
     def retrieve_many(
         self,
         *,
+        requests: Iterable[individual_retrieve_many_params.Request],
         entity_ids: SequenceNotStr[str] | Omit = omit,
         options: Optional[individual_retrieve_many_params.Options] | Omit = omit,
-        requests: Iterable[individual_retrieve_many_params.Request] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -57,6 +57,8 @@ class Individuals(SyncAPIResource):
         Read individual data, excluding income and employment data
 
         Args:
+          requests: The array of batch requests. Maximum 10000 items per request.
+
           entity_ids: The entity IDs to specify which entities' data to access.
 
           extra_headers: Send extra headers
@@ -72,8 +74,8 @@ class Individuals(SyncAPIResource):
             page=SyncResponsesPage[IndividualResponse],
             body=maybe_transform(
                 {
-                    "options": options,
                     "requests": requests,
+                    "options": options,
                 },
                 individual_retrieve_many_params.IndividualRetrieveManyParams,
             ),
@@ -115,9 +117,9 @@ class AsyncIndividuals(AsyncAPIResource):
     def retrieve_many(
         self,
         *,
+        requests: Iterable[individual_retrieve_many_params.Request],
         entity_ids: SequenceNotStr[str] | Omit = omit,
         options: Optional[individual_retrieve_many_params.Options] | Omit = omit,
-        requests: Iterable[individual_retrieve_many_params.Request] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -129,6 +131,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Read individual data, excluding income and employment data
 
         Args:
+          requests: The array of batch requests. Maximum 10000 items per request.
+
           entity_ids: The entity IDs to specify which entities' data to access.
 
           extra_headers: Send extra headers
@@ -144,8 +148,8 @@ class AsyncIndividuals(AsyncAPIResource):
             page=AsyncResponsesPage[IndividualResponse],
             body=maybe_transform(
                 {
-                    "options": options,
                     "requests": requests,
+                    "options": options,
                 },
                 individual_retrieve_many_params.IndividualRetrieveManyParams,
             ),

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

@@ -59,7 +59,7 @@ class PayStatements(SyncAPIResource):
         supports Benefits.
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10 payment_ids per request.
 
           entity_ids: The entity IDs to specify which entities' data to access.
 
@@ -131,7 +131,7 @@ class AsyncPayStatements(AsyncAPIResource):
         supports Benefits.
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10 payment_ids per request.
 
           entity_ids: The entity IDs to specify which entities' data to access.
 

{finch_api-2.0.0 → finch_api-2.2.0}/src/finch/types/hris/directory_list_individuals_params.py

@@ -14,7 +14,7 @@ class DirectoryListIndividualsParams(TypedDict, total=False):
     """The entity IDs to specify which entities' data to access."""
 
     limit: int
-    """Number of employees to return (defaults to all)"""
+    """Number of employees to return (defaults to 100, maximum 10000)"""
 
     offset: int
     """Index to start from (defaults to 0)"""

{finch_api-2.0.0 → finch_api-2.2.0}/src/finch/types/hris/directory_list_params.py

@@ -14,7 +14,7 @@ class DirectoryListParams(TypedDict, total=False):
     """The entity IDs to specify which entities' data to access."""
 
     limit: int
-    """Number of employees to return (defaults to all)"""
+    """Number of employees to return (defaults to 100, maximum 10000)"""
 
     offset: int
     """Index to start from (defaults to 0)"""

{finch_api-2.0.0 → finch_api-2.2.0}/src/finch/types/hris/employment_retrieve_many_params.py

@@ -12,7 +12,7 @@ __all__ = ["EmploymentRetrieveManyParams", "Request"]
 
 class EmploymentRetrieveManyParams(TypedDict, total=False):
     requests: Required[Iterable[Request]]
-    """The array of batch requests."""
+    """The array of batch requests. Maximum 10000 items per request."""
 
     entity_ids: SequenceNotStr[str]
     """The entity IDs to specify which entities' data to access."""
@@ -20,9 +20,4 @@ class EmploymentRetrieveManyParams(TypedDict, total=False):
 
 class Request(TypedDict, total=False):
     individual_id: Required[str]
-    """A stable Finch `id` (UUID v4) for an individual in the company.
-
-    There is no limit to the number of `individual_id` to send per request. It is
-    preferantial to send all ids in a single request for Finch to optimize provider
-    rate-limits.
-    """
+    """A stable Finch `id` (UUID v4) for an individual in the company."""

{finch_api-2.0.0 → finch_api-2.2.0}/src/finch/types/hris/individual_retrieve_many_params.py

@@ -3,25 +3,26 @@
 from __future__ import annotations
 
 from typing import Iterable, Optional
-from typing_extensions import TypedDict
+from typing_extensions import Required, TypedDict
 
 from ..._types import SequenceNotStr
 
-__all__ = ["IndividualRetrieveManyParams", "Options", "Request"]
+__all__ = ["IndividualRetrieveManyParams", "Request", "Options"]
 
 
 class IndividualRetrieveManyParams(TypedDict, total=False):
+    requests: Required[Iterable[Request]]
+    """The array of batch requests. Maximum 10000 items per request."""
+
     entity_ids: SequenceNotStr[str]
     """The entity IDs to specify which entities' data to access."""
 
     options: Optional[Options]
 
-    requests: Iterable[Request]
+
+class Request(TypedDict, total=False):
+    individual_id: Required[str]
 
 
 class Options(TypedDict, total=False):
     include: SequenceNotStr[str]
-
-
-class Request(TypedDict, total=False):
-    individual_id: str

{finch_api-2.0.0 → finch_api-2.2.0}/src/finch/types/hris/pay_statement.py

@@ -44,7 +44,7 @@ class Earning(BaseModel):
     """
 
     name: Optional[str] = None
-    """The exact name of the deduction from the pay statement."""
+    """The exact name of the earning from the pay statement."""
 
     type: Optional[
         Literal[

{finch_api-2.0.0 → finch_api-2.2.0}/src/finch/types/hris/pay_statement_retrieve_many_params.py

@@ -12,7 +12,7 @@ __all__ = ["PayStatementRetrieveManyParams", "Request"]
 
 class PayStatementRetrieveManyParams(TypedDict, total=False):
     requests: Required[Iterable[Request]]
-    """The array of batch requests."""
+    """The array of batch requests. Maximum 10 payment_ids per request."""
 
     entity_ids: SequenceNotStr[str]
     """The entity IDs to specify which entities' data to access."""
@@ -23,7 +23,7 @@ class Request(TypedDict, total=False):
     """A stable Finch `id` (UUID v4) for a payment."""
 
     limit: int
-    """Number of pay statements to return (defaults to all)."""
+    """Number of pay statements to return (defaults to 100, maximum 5000)."""
 
     offset: int
     """Index to start from."""

{finch_api-2.0.0 → finch_api-2.2.0}/tests/api_resources/hris/test_directory.py

@@ -29,7 +29,7 @@ class TestDirectory:
     def test_method_list_with_all_params(self, client: Finch) -> None:
         directory = client.hris.directory.list(
             entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
-            limit=0,
+            limit=10000,
             offset=0,
         )
         assert_matches_type(SyncIndividualsPage[IndividualInDirectory], directory, path=["response"])
@@ -66,7 +66,7 @@ class TestDirectory:
         with pytest.warns(DeprecationWarning):
             directory = client.hris.directory.list_individuals(
                 entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
-                limit=0,
+                limit=10000,
                 offset=0,
             )
 
@@ -109,7 +109,7 @@ class TestAsyncDirectory:
     async def test_method_list_with_all_params(self, async_client: AsyncFinch) -> None:
         directory = await async_client.hris.directory.list(
             entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
-            limit=0,
+            limit=10000,
             offset=0,
         )
         assert_matches_type(AsyncIndividualsPage[IndividualInDirectory], directory, path=["response"])
@@ -146,7 +146,7 @@ class TestAsyncDirectory:
         with pytest.warns(DeprecationWarning):
             directory = await async_client.hris.directory.list_individuals(
                 entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
-                limit=0,
+                limit=10000,
                 offset=0,
             )
 

{finch_api-2.0.0 → finch_api-2.2.0}/tests/api_resources/hris/test_individuals.py

@@ -20,21 +20,25 @@ class TestIndividuals:
 
     @parametrize
     def test_method_retrieve_many(self, client: Finch) -> None:
-        individual = client.hris.individuals.retrieve_many()
+        individual = client.hris.individuals.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
+        )
         assert_matches_type(SyncResponsesPage[IndividualResponse], individual, path=["response"])
 
     @parametrize
     def test_method_retrieve_many_with_all_params(self, client: Finch) -> None:
         individual = client.hris.individuals.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
             entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
             options={"include": ["string"]},
-            requests=[{"individual_id": "individual_id"}],
         )
         assert_matches_type(SyncResponsesPage[IndividualResponse], individual, path=["response"])
 
     @parametrize
     def test_raw_response_retrieve_many(self, client: Finch) -> None:
-        response = client.hris.individuals.with_raw_response.retrieve_many()
+        response = client.hris.individuals.with_raw_response.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
+        )
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -43,7 +47,9 @@ class TestIndividuals:
 
     @parametrize
     def test_streaming_response_retrieve_many(self, client: Finch) -> None:
-        with client.hris.individuals.with_streaming_response.retrieve_many() as response:
+        with client.hris.individuals.with_streaming_response.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
+        ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
@@ -60,21 +66,25 @@ class TestAsyncIndividuals:
 
     @parametrize
     async def test_method_retrieve_many(self, async_client: AsyncFinch) -> None:
-        individual = await async_client.hris.individuals.retrieve_many()
+        individual = await async_client.hris.individuals.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
+        )
         assert_matches_type(AsyncResponsesPage[IndividualResponse], individual, path=["response"])
 
     @parametrize
     async def test_method_retrieve_many_with_all_params(self, async_client: AsyncFinch) -> None:
         individual = await async_client.hris.individuals.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
             entity_ids=["550e8400-e29b-41d4-a716-446655440000"],
             options={"include": ["string"]},
-            requests=[{"individual_id": "individual_id"}],
         )
         assert_matches_type(AsyncResponsesPage[IndividualResponse], individual, path=["response"])
 
     @parametrize
     async def test_raw_response_retrieve_many(self, async_client: AsyncFinch) -> None:
-        response = await async_client.hris.individuals.with_raw_response.retrieve_many()
+        response = await async_client.hris.individuals.with_raw_response.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
+        )
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -83,7 +93,9 @@ class TestAsyncIndividuals:
 
     @parametrize
     async def test_streaming_response_retrieve_many(self, async_client: AsyncFinch) -> None:
-        async with async_client.hris.individuals.with_streaming_response.retrieve_many() as response:
+        async with async_client.hris.individuals.with_streaming_response.retrieve_many(
+            requests=[{"individual_id": "individual_id"}],
+        ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 

{finch_api-2.0.0 → finch_api-2.2.0}/tests/api_resources/hris/test_pay_statements.py

@@ -21,7 +21,7 @@ class TestPayStatements:
     @parametrize
     def test_method_retrieve_many(self, client: Finch) -> None:
         pay_statement = client.hris.pay_statements.retrieve_many(
-            requests=[{"payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],
+            requests=[{"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"}],
         )
         assert_matches_type(SyncResponsesPage[PayStatementResponse], pay_statement, path=["response"])
 
@@ -30,8 +30,8 @@ class TestPayStatements:
         pay_statement = client.hris.pay_statements.retrieve_many(
             requests=[
                 {
-                    "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
-                    "limit": 50,
+                    "payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142",
+                    "limit": 100,
                     "offset": 0,
                 }
             ],
@@ -42,7 +42,7 @@ class TestPayStatements:
     @parametrize
     def test_raw_response_retrieve_many(self, client: Finch) -> None:
         response = client.hris.pay_statements.with_raw_response.retrieve_many(
-            requests=[{"payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],
+            requests=[{"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"}],
         )
 
         assert response.is_closed is True
@@ -53,7 +53,7 @@ class TestPayStatements:
     @parametrize
     def test_streaming_response_retrieve_many(self, client: Finch) -> None:
         with client.hris.pay_statements.with_streaming_response.retrieve_many(
-            requests=[{"payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],
+            requests=[{"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"}],
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -72,7 +72,7 @@ class TestAsyncPayStatements:
     @parametrize
     async def test_method_retrieve_many(self, async_client: AsyncFinch) -> None:
         pay_statement = await async_client.hris.pay_statements.retrieve_many(
-            requests=[{"payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],
+            requests=[{"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"}],
         )
         assert_matches_type(AsyncResponsesPage[PayStatementResponse], pay_statement, path=["response"])
 
@@ -81,8 +81,8 @@ class TestAsyncPayStatements:
         pay_statement = await async_client.hris.pay_statements.retrieve_many(
             requests=[
                 {
-                    "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
-                    "limit": 50,
+                    "payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142",
+                    "limit": 100,
                     "offset": 0,
                 }
             ],
@@ -93,7 +93,7 @@ class TestAsyncPayStatements:
     @parametrize
     async def test_raw_response_retrieve_many(self, async_client: AsyncFinch) -> None:
         response = await async_client.hris.pay_statements.with_raw_response.retrieve_many(
-            requests=[{"payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],
+            requests=[{"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"}],
         )
 
         assert response.is_closed is True
@@ -104,7 +104,7 @@ class TestAsyncPayStatements:
     @parametrize
     async def test_streaming_response_retrieve_many(self, async_client: AsyncFinch) -> None:
         async with async_client.hris.pay_statements.with_streaming_response.retrieve_many(
-            requests=[{"payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],
+            requests=[{"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142"}],
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"

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

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