release: 0.22.0

.github/workflows/release-doctor.yml

@@ -1,6 +1,8 @@
 name: Release Doctor
 on:
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.21.14"
+  ".": "0.22.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 37
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch-6c0cb9620225dbe9e7180b514e51b2cd94753565749de1603e77d065cb531be1.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch-15385b754979d87bd7e583f618870246e79d1430a761e5bcd653db78cfab4789.yml

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.22.0 (2024-07-19)
+
+Full Changelog: [v0.21.14...v0.22.0](https://github.com/Finch-API/finch-api-python/compare/v0.21.14...v0.22.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** authentication method type is an enum, not a plain string ([#442](https://github.com/Finch-API/finch-api-python/issues/442))
+
+### Bug Fixes
+
+* **api:** authentication method type is an enum, not a plain string ([#442](https://github.com/Finch-API/finch-api-python/issues/442)) ([697c5ad](https://github.com/Finch-API/finch-api-python/commit/697c5ad3225d900be6e158bde42cee65f8f498b4))
+
+
+### Chores
+
+* **ci:** limit release doctor target branches ([#444](https://github.com/Finch-API/finch-api-python/issues/444)) ([b49b944](https://github.com/Finch-API/finch-api-python/commit/b49b9446d1cf1347ff10130bf492798da3999046))
+* **docs:** improve docstrings ([#445](https://github.com/Finch-API/finch-api-python/issues/445)) ([0b40655](https://github.com/Finch-API/finch-api-python/commit/0b40655b37f63125a963de3d080326535ae4aba8))
+
 ## 0.21.14 (2024-07-18)
 
 Full Changelog: [v0.21.13...v0.21.14](https://github.com/Finch-API/finch-api-python/compare/v0.21.13...v0.21.14)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "finch-api"
-version = "0.21.14"
+version = "0.22.0"
 description = "The official Python library for the Finch API"
 dynamic = ["readme"]
 license = "Apache-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__ = "0.21.14"  # x-release-please-version
+__version__ = "0.22.0"  # x-release-please-version

src/finch/resources/sandbox/individual.py

@@ -93,6 +93,7 @@ def update(
           ssn: Social Security Number of the individual. This field is only available with the
               `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
               body.
+              [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
 
           extra_headers: Send extra headers
 
@@ -199,6 +200,7 @@ async def update(
           ssn: Social Security Number of the individual. This field is only available with the
               `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
               body.
+              [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
 
           extra_headers: Send extra headers
 

src/finch/types/hris/individual.py

@@ -74,4 +74,5 @@ class Individual(BaseModel):
 
     This field is only available with the `ssn` scope enabled and the
     `options: { include: ['ssn'] }` param set in the body.
+    [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
     """

src/finch/types/introspection.py

@@ -18,7 +18,8 @@ class AuthenticationMethodConnectionStatus(BaseModel):
 class AuthenticationMethod(BaseModel):
     connection_status: Optional[AuthenticationMethodConnectionStatus] = None
 
-    type: Optional[str] = None
+    type: Optional[Literal["assisted", "credential", "api_token", "api_credential", "oauth"]] = None
+    """The type of authentication method."""
 
 
 class Introspection(BaseModel):

src/finch/types/sandbox/directory_create_params.py

@@ -158,6 +158,7 @@ class Body(TypedDict, total=False):
 
     This field is only available with the `ssn` scope enabled and the
     `options: { include: ['ssn'] }` param set in the body.
+    [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
     """
 
     start_date: Optional[str]

src/finch/types/sandbox/individual_update_params.py

@@ -60,6 +60,7 @@ class IndividualUpdateParams(TypedDict, total=False):
 
     This field is only available with the `ssn` scope enabled and the
     `options: { include: ['ssn'] }` param set in the body.
+    [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
     """
 
 

src/finch/types/sandbox/individual_update_response.py

@@ -74,4 +74,5 @@ class IndividualUpdateResponse(BaseModel):
 
     This field is only available with the `ssn` scope enabled and the
     `options: { include: ['ssn'] }` param set in the body.
+    [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
     """