From 4997a5ae4b8c4934cab2f1eb4be939d829544b76 Mon Sep 17 00:00:00 2001 From: Stainless Bot <107565488+stainless-bot@users.noreply.github.com> Date: Mon, 4 Mar 2024 23:38:54 +0100 Subject: [PATCH 1/2] docs: update some doc strings (#309) --- src/finch/types/hris/employment_data.py | 11 +---------- src/finch/types/hris/individual.py | 10 ++++++---- 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/src/finch/types/hris/employment_data.py b/src/finch/types/hris/employment_data.py index a0bf1220..654a45d5 100644 --- a/src/finch/types/hris/employment_data.py +++ b/src/finch/types/hris/employment_data.py @@ -101,13 +101,4 @@ class EmploymentData(BaseModel): """The current title of the individual.""" work_id: Optional[str] = None - """Note: This property is only available if enabled for your account. - - Please reach out to your Finch representative if you would like access. - """ - - work_id_2: Optional[str] = None - """Note: This property is only available if enabled for your account. - - Please reach out to your Finch representative if you would like access. - """ + """This field is deprecated in favour of `source_id`""" diff --git a/src/finch/types/hris/individual.py b/src/finch/types/hris/individual.py index 65cd42d2..607ae581 100644 --- a/src/finch/types/hris/individual.py +++ b/src/finch/types/hris/individual.py @@ -30,9 +30,10 @@ class Individual(BaseModel): emails: Optional[List[Email]] = None encrypted_ssn: Optional[str] = None - """Note: This property is only available if enabled for your account. + """Social Security Number of the individual in **encrypted** format. - Please reach out to your Finch representative if you would like access. + This field is only available with the `ssn` scope enabled and the + `options: { include: ['ssn'] }` param set in the body. """ ethnicity: Optional[ @@ -69,7 +70,8 @@ class Individual(BaseModel): residence: Optional[Location] = None ssn: Optional[str] = None - """Note: This property is only available if enabled for your account. + """Social Security Number of the individual. - Please reach out to your Finch representative if you would like access. + This field is only available with the `ssn` scope enabled and the + `options: { include: ['ssn'] }` param set in the body. """ From 935e4facb6042af4098c90006183026821542735 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 4 Mar 2024 22:39:08 +0000 Subject: [PATCH 2/2] release: 0.16.3 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ pyproject.toml | 2 +- src/finch/_version.py | 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 6f2b4018..afe01269 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.16.2" + ".": "0.16.3" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index b78a6b0a..650770f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.16.3 (2024-03-04) + +Full Changelog: [v0.16.2...v0.16.3](https://github.com/Finch-API/finch-api-python/compare/v0.16.2...v0.16.3) + +### Documentation + +* update some doc strings ([#309](https://github.com/Finch-API/finch-api-python/issues/309)) ([4997a5a](https://github.com/Finch-API/finch-api-python/commit/4997a5ae4b8c4934cab2f1eb4be939d829544b76)) + ## 0.16.2 (2024-03-04) Full Changelog: [v0.16.1...v0.16.2](https://github.com/Finch-API/finch-api-python/compare/v0.16.1...v0.16.2) diff --git a/pyproject.toml b/pyproject.toml index 70c496ed..1bfa5ef3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "finch-api" -version = "0.16.2" +version = "0.16.3" description = "The official Python library for the Finch API" readme = "README.md" license = "Apache-2.0" diff --git a/src/finch/_version.py b/src/finch/_version.py index 827c1504..c08da305 100644 --- a/src/finch/_version.py +++ b/src/finch/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. __title__ = "finch" -__version__ = "0.16.2" # x-release-please-version +__version__ = "0.16.3" # x-release-please-version