diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 8d4bb603..16734a67 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -1,6 +1,8 @@ name: Release Doctor on: pull_request: + branches: + - main workflow_dispatch: jobs: diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 76ffaa06..cb9d2541 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.21.14" + ".": "0.22.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 8bf2d6ac..7d691507 100644 --- a/.stats.yml +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md index ec568225..1b5c394b 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/pyproject.toml b/pyproject.toml index 6a238404..83bedcf7 100644 --- a/pyproject.toml +++ b/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" diff --git a/src/finch/_version.py b/src/finch/_version.py index a06a27ce..8914ad7d 100644 --- a/src/finch/_version.py +++ b/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 diff --git a/src/finch/resources/sandbox/individual.py b/src/finch/resources/sandbox/individual.py index f08e7401..d06155b6 100644 --- a/src/finch/resources/sandbox/individual.py +++ b/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 diff --git a/src/finch/types/hris/individual.py b/src/finch/types/hris/individual.py index cc077e34..288466ad 100644 --- a/src/finch/types/hris/individual.py +++ b/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). """ diff --git a/src/finch/types/introspection.py b/src/finch/types/introspection.py index 888dd7c4..b4c3cc9a 100644 --- a/src/finch/types/introspection.py +++ b/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): diff --git a/src/finch/types/sandbox/directory_create_params.py b/src/finch/types/sandbox/directory_create_params.py index 801ca544..2875864b 100644 --- a/src/finch/types/sandbox/directory_create_params.py +++ b/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] diff --git a/src/finch/types/sandbox/individual_update_params.py b/src/finch/types/sandbox/individual_update_params.py index 15cae835..acede77e 100644 --- a/src/finch/types/sandbox/individual_update_params.py +++ b/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). """ diff --git a/src/finch/types/sandbox/individual_update_response.py b/src/finch/types/sandbox/individual_update_response.py index bb44a9a3..9076dc0e 100644 --- a/src/finch/types/sandbox/individual_update_response.py +++ b/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). """