From 82b57286f79a75c8906c1f8a423ba603a6f52750 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2026 16:09:32 +0000 Subject: [PATCH] docs: update parameter documentation for auth methods MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Clarify that username and password parameters in authentication methods represent API credential client ID and client secret respectively, rather than user login credentials. Key changes: - Update username parameter description from "The user's username or email" to "The API credential client ID" - Update password parameter description from "The user's password" to "The API credential client secret" - Apply changes consistently across both sync and async auth clients 🌿 Generated with Fern --- .fern/metadata.json | 6 +++--- changelog.md | 11 +++++++++++ pyproject.toml | 2 +- reference.md | 4 ++-- src/phenoml/authtoken/auth/client.py | 8 ++++---- src/phenoml/authtoken/auth/raw_client.py | 8 ++++---- src/phenoml/core/client_wrapper.py | 4 ++-- 7 files changed, 27 insertions(+), 16 deletions(-) diff --git a/.fern/metadata.json b/.fern/metadata.json index 9357670..d324860 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,10 +1,10 @@ { - "cliVersion": "4.32.2", + "cliVersion": "4.42.1", "generatorName": "fernapi/fern-python-sdk", "generatorVersion": "4.61.5", "generatorConfig": { "client_class_name": "PhenomlClient" }, - "originGitCommit": "e3a7239a17a8ebeed78568e37a8bd984ce481838", - "sdkVersion": "9.2.0" + "originGitCommit": "529fd3587f1939a037d76bdad7d3c03614995ddc", + "sdkVersion": "9.2.1" } \ No newline at end of file diff --git a/changelog.md b/changelog.md index 4be4b02..2a515ce 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,14 @@ +## 9.2.1 - 2026-03-23 +* docs: update parameter documentation for auth methods +* Clarify that username and password parameters in authentication methods +* represent API credential client ID and client secret respectively, rather +* than user login credentials. +* Key changes: +* Update username parameter description from "The user's username or email" to "The API credential client ID" +* Update password parameter description from "The user's password" to "The API credential client secret" +* Apply changes consistently across both sync and async auth clients +* 🌿 Generated with Fern + ## 9.2.0 - 2026-03-17 * The SDK now supports "meditech" as a FHIR provider option, enabling integration with Meditech healthcare systems. diff --git a/pyproject.toml b/pyproject.toml index 12dd5be..235b6af 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ dynamic = ["version"] [tool.poetry] name = "phenoml" -version = "9.2.0" +version = "9.2.1" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index f935b42..b201280 100644 --- a/reference.md +++ b/reference.md @@ -1513,7 +1513,7 @@ client.authtoken.auth.generate_token(
-**username:** `str` — The user's username or email +**username:** `str` — The API credential client ID
@@ -1521,7 +1521,7 @@ client.authtoken.auth.generate_token(
-**password:** `str` — The user's password +**password:** `str` — The API credential client secret
diff --git a/src/phenoml/authtoken/auth/client.py b/src/phenoml/authtoken/auth/client.py index 4a0f014..8f91b77 100644 --- a/src/phenoml/authtoken/auth/client.py +++ b/src/phenoml/authtoken/auth/client.py @@ -36,10 +36,10 @@ def generate_token( Parameters ---------- username : str - The user's username or email + The API credential client ID password : str - The user's password + The API credential client secret request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -134,10 +134,10 @@ async def generate_token( Parameters ---------- username : str - The user's username or email + The API credential client ID password : str - The user's password + The API credential client secret request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/phenoml/authtoken/auth/raw_client.py b/src/phenoml/authtoken/auth/raw_client.py index b0f5e0f..b4afec8 100644 --- a/src/phenoml/authtoken/auth/raw_client.py +++ b/src/phenoml/authtoken/auth/raw_client.py @@ -31,10 +31,10 @@ def generate_token( Parameters ---------- username : str - The user's username or email + The API credential client ID password : str - The user's password + The API credential client secret request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -203,10 +203,10 @@ async def generate_token( Parameters ---------- username : str - The user's username or email + The API credential client ID password : str - The user's password + The API credential client secret request_options : typing.Optional[RequestOptions] Request-specific configuration. diff --git a/src/phenoml/core/client_wrapper.py b/src/phenoml/core/client_wrapper.py index 72acd22..569c43c 100644 --- a/src/phenoml/core/client_wrapper.py +++ b/src/phenoml/core/client_wrapper.py @@ -27,12 +27,12 @@ def get_headers(self) -> typing.Dict[str, str]: import platform headers: typing.Dict[str, str] = { - "User-Agent": "phenoml/9.2.0", + "User-Agent": "phenoml/9.2.1", "X-Fern-Language": "Python", "X-Fern-Runtime": f"python/{platform.python_version()}", "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}", "X-Fern-SDK-Name": "phenoml", - "X-Fern-SDK-Version": "9.2.0", + "X-Fern-SDK-Version": "9.2.1", **(self.get_custom_headers() or {}), } token = self._get_token()