release: 1.33.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.32.0"
+  ".": "1.33.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-73c284d36c1ed2d9963fc733e421005fad76e559de8efe9baa6511a43dd72668.yml
-openapi_spec_hash: 1e58c4445919b71c77e5c7f16bd6fa7d
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-e8b684dbd61d1724b5e516a573a952bb6906d63840e27ebda7731a2f71061aff.yml
+openapi_spec_hash: 8baff9577d4e721d0494ff315da267ca
 config_hash: 5146b12344dae76238940989dac1e8a0

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 1.33.0 (2025-08-12)
+
+Full Changelog: [v1.32.0...v1.33.0](https://github.com/Finch-API/finch-api-python/compare/v1.32.0...v1.33.0)
+
+### Features
+
+* **api:** api update ([030c07d](https://github.com/Finch-API/finch-api-python/commit/030c07d05d08d04d4732134e285c51f74ce06d5a))
+* **api:** api update ([00792da](https://github.com/Finch-API/finch-api-python/commit/00792da673687c39f2f15a522b00cd54508a956c))
+
+
+### Chores
+
+* **internal:** update comment in script ([9efeb7a](https://github.com/Finch-API/finch-api-python/commit/9efeb7a90337849c2cf09fc40884f8943d31714c))
+* update @stainless-api/prism-cli to v5.15.0 ([0a5c874](https://github.com/Finch-API/finch-api-python/commit/0a5c874efeed941fa4fca1f5237ffee632b00ba0))
+
 ## 1.32.0 (2025-08-05)
 
 Full Changelog: [v1.31.0...v1.32.0](https://github.com/Finch-API/finch-api-python/compare/v1.31.0...v1.32.0)

api.md

@@ -281,7 +281,7 @@ from finch.types.jobs import AutomatedAsyncJob, AutomatedCreateResponse, Automat
 Methods:
 
 - <code title="post /jobs/automated">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">create</a>(\*\*<a href="src/finch/types/jobs/automated_create_params.py">params</a>) -> <a href="./src/finch/types/jobs/automated_create_response.py">AutomatedCreateResponse</a></code>
-- <code title="get /jobs/automated/{job_id}">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">retrieve</a>(job_id) -> <a href="./src/finch/types/jobs/automated_async_job.py">AutomatedAsyncJob</a></code>
+- <code title="get /jobs/automated/{job_id}">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">retrieve</a>(job_id, \*\*<a href="src/finch/types/jobs/automated_retrieve_params.py">params</a>) -> <a href="./src/finch/types/jobs/automated_async_job.py">AutomatedAsyncJob</a></code>
 - <code title="get /jobs/automated">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">list</a>(\*\*<a href="src/finch/types/jobs/automated_list_params.py">params</a>) -> <a href="./src/finch/types/jobs/automated_list_response.py">AutomatedListResponse</a></code>
 
 ## Manual
@@ -294,7 +294,7 @@ from finch.types.jobs import ManualAsyncJob
 
 Methods:
 
-- <code title="get /jobs/manual/{job_id}">client.jobs.manual.<a href="./src/finch/resources/jobs/manual.py">retrieve</a>(job_id) -> <a href="./src/finch/types/jobs/manual_async_job.py">ManualAsyncJob</a></code>
+- <code title="get /jobs/manual/{job_id}">client.jobs.manual.<a href="./src/finch/resources/jobs/manual.py">retrieve</a>(job_id, \*\*<a href="src/finch/types/jobs/manual_retrieve_params.py">params</a>) -> <a href="./src/finch/types/jobs/manual_async_job.py">ManualAsyncJob</a></code>
 
 # Sandbox
 

pyproject.toml

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

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL"
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
 fi

scripts/test

@@ -43,7 +43,7 @@ elif ! prism_is_running ; then
   echo -e "To run the server, pass in the path or url of your OpenAPI"
   echo -e "spec to the prism command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
   echo
 
   exit 1

src/finch/_version.py

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

src/finch/resources/jobs/automated.py

@@ -12,7 +12,7 @@
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
-from ...types.jobs import automated_list_params, automated_create_params
+from ...types.jobs import automated_list_params, automated_create_params, automated_retrieve_params
 from ..._base_client import make_request_options
 from ...types.jobs.automated_async_job import AutomatedAsyncJob
 from ...types.jobs.automated_list_response import AutomatedListResponse
@@ -156,6 +156,7 @@ def retrieve(
         self,
         job_id: str,
         *,
+        entity_id: str | NotGiven = NOT_GIVEN,
         # 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,
@@ -167,6 +168,10 @@ def retrieve(
         Get an automated job by `job_id`.
 
         Args:
+          entity_id: The entity ID to use when authenticating with a multi-account token. Required
+              when using a multi-account token to specify which entity's data to access.
+              Example: `123e4567-e89b-12d3-a456-426614174000`
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -180,14 +185,19 @@ def retrieve(
         return self._get(
             f"/jobs/automated/{job_id}",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"entity_id": entity_id}, automated_retrieve_params.AutomatedRetrieveParams),
             ),
             cast_to=AutomatedAsyncJob,
         )
 
     def list(
         self,
         *,
+        entity_id: str | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         offset: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -204,6 +214,10 @@ def list(
         as data syncs, only the next scheduled job is shown.
 
         Args:
+          entity_id: The entity ID to use when authenticating with a multi-account token. Required
+              when using a multi-account token to specify which entity's data to access.
+              Example: `123e4567-e89b-12d3-a456-426614174000`
+
           limit: Number of items to return
 
           offset: Index to start from (defaults to 0)
@@ -225,6 +239,7 @@ def list(
                 timeout=timeout,
                 query=maybe_transform(
                     {
+                        "entity_id": entity_id,
                         "limit": limit,
                         "offset": offset,
                     },
@@ -370,6 +385,7 @@ async def retrieve(
         self,
         job_id: str,
         *,
+        entity_id: str | NotGiven = NOT_GIVEN,
         # 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,
@@ -381,6 +397,10 @@ async def retrieve(
         Get an automated job by `job_id`.
 
         Args:
+          entity_id: The entity ID to use when authenticating with a multi-account token. Required
+              when using a multi-account token to specify which entity's data to access.
+              Example: `123e4567-e89b-12d3-a456-426614174000`
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -394,14 +414,21 @@ async def retrieve(
         return await self._get(
             f"/jobs/automated/{job_id}",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"entity_id": entity_id}, automated_retrieve_params.AutomatedRetrieveParams
+                ),
             ),
             cast_to=AutomatedAsyncJob,
         )
 
     async def list(
         self,
         *,
+        entity_id: str | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         offset: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -418,6 +445,10 @@ async def list(
         as data syncs, only the next scheduled job is shown.
 
         Args:
+          entity_id: The entity ID to use when authenticating with a multi-account token. Required
+              when using a multi-account token to specify which entity's data to access.
+              Example: `123e4567-e89b-12d3-a456-426614174000`
+
           limit: Number of items to return
 
           offset: Index to start from (defaults to 0)
@@ -439,6 +470,7 @@ async def list(
                 timeout=timeout,
                 query=await async_maybe_transform(
                     {
+                        "entity_id": entity_id,
                         "limit": limit,
                         "offset": offset,
                     },

src/finch/resources/jobs/manual.py

@@ -6,9 +6,11 @@
 
 from ... import _legacy_response
 from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
+from ...types.jobs import manual_retrieve_params
 from ..._base_client import make_request_options
 from ...types.jobs.manual_async_job import ManualAsyncJob
 
@@ -39,6 +41,7 @@ def retrieve(
         self,
         job_id: str,
         *,
+        entity_id: str | NotGiven = NOT_GIVEN,
         # 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,
@@ -52,6 +55,10 @@ def retrieve(
         Assisted Benefits jobs.
 
         Args:
+          entity_id: The entity ID to use when authenticating with a multi-account token. Required
+              when using a multi-account token to specify which entity's data to access.
+              Example: `123e4567-e89b-12d3-a456-426614174000`
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -65,7 +72,11 @@ def retrieve(
         return self._get(
             f"/jobs/manual/{job_id}",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"entity_id": entity_id}, manual_retrieve_params.ManualRetrieveParams),
             ),
             cast_to=ManualAsyncJob,
         )
@@ -95,6 +106,7 @@ async def retrieve(
         self,
         job_id: str,
         *,
+        entity_id: str | NotGiven = NOT_GIVEN,
         # 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,
@@ -108,6 +120,10 @@ async def retrieve(
         Assisted Benefits jobs.
 
         Args:
+          entity_id: The entity ID to use when authenticating with a multi-account token. Required
+              when using a multi-account token to specify which entity's data to access.
+              Example: `123e4567-e89b-12d3-a456-426614174000`
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -121,7 +137,13 @@ async def retrieve(
         return await self._get(
             f"/jobs/manual/{job_id}",
             options=make_request_options(
-                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {"entity_id": entity_id}, manual_retrieve_params.ManualRetrieveParams
+                ),
             ),
             cast_to=ManualAsyncJob,
         )

src/finch/resources/request_forwarding.py

@@ -57,8 +57,8 @@ def forward(
         """The Forward API allows you to make direct requests to an employment system.
 
         If
-        Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
-        Forward allows you to push or pull data models directly against an integration’s
+        Finch's unified API doesn't have a data model that cleanly fits your needs, then
+        Forward allows you to push or pull data models directly against an integration's
         API.
 
         Args:
@@ -144,8 +144,8 @@ async def forward(
         """The Forward API allows you to make direct requests to an employment system.
 
         If
-        Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
-        Forward allows you to push or pull data models directly against an integration’s
+        Finch's unified API doesn't have a data model that cleanly fits your needs, then
+        Forward allows you to push or pull data models directly against an integration's
         API.
 
         Args:

src/finch/types/disconnect_response.py

@@ -7,4 +7,4 @@
 
 class DisconnectResponse(BaseModel):
     status: str
-    """If the request is successful, Finch will return “success” (HTTP 200 status)."""
+    """If the request is successful, Finch will return "success" (HTTP 200 status)."""

src/finch/types/jobs/__init__.py

@@ -5,6 +5,8 @@
 from .manual_async_job import ManualAsyncJob as ManualAsyncJob
 from .automated_async_job import AutomatedAsyncJob as AutomatedAsyncJob
 from .automated_list_params import AutomatedListParams as AutomatedListParams
+from .manual_retrieve_params import ManualRetrieveParams as ManualRetrieveParams
 from .automated_create_params import AutomatedCreateParams as AutomatedCreateParams
 from .automated_list_response import AutomatedListResponse as AutomatedListResponse
 from .automated_create_response import AutomatedCreateResponse as AutomatedCreateResponse
+from .automated_retrieve_params import AutomatedRetrieveParams as AutomatedRetrieveParams

src/finch/types/jobs/automated_async_job.py

@@ -38,7 +38,7 @@ class AutomatedAsyncJob(BaseModel):
     """The datetime a job is scheduled to be run.
 
     For scheduled jobs, this datetime can be in the future if the job has not yet
-    been enqueued. For ad-hoc jobs, this field will be null.
+    been enqueued. For ad-hoc jobs, this field will be null.
     """
 
     started_at: Optional[datetime] = None

src/finch/types/jobs/automated_list_params.py

@@ -8,6 +8,13 @@
 
 
 class AutomatedListParams(TypedDict, total=False):
+    entity_id: str
+    """The entity ID to use when authenticating with a multi-account token.
+
+    Required when using a multi-account token to specify which entity's data to
+    access. Example: `123e4567-e89b-12d3-a456-426614174000`
+    """
+
     limit: int
     """Number of items to return"""
 

src/finch/types/jobs/automated_retrieve_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["AutomatedRetrieveParams"]
+
+
+class AutomatedRetrieveParams(TypedDict, total=False):
+    entity_id: str
+    """The entity ID to use when authenticating with a multi-account token.
+
+    Required when using a multi-account token to specify which entity's data to
+    access. Example: `123e4567-e89b-12d3-a456-426614174000`
+    """

src/finch/types/jobs/manual_async_job.py

@@ -9,7 +9,7 @@
 
 
 class ManualAsyncJob(BaseModel):
-    body: Optional[List[object]] = None
+    body: Optional[List[Optional[object]]] = None
     """Specific information about the job, such as individual statuses for batch jobs."""
 
     job_id: str