Merge pull request #145 from criblio/speakeasy-sdk-regen-openapi-prerelease-1760613899

michalbiesek · web-flow · commit 46fe5c5b9fa6 · 2025-10-16T13:45:56.000+02:00
chore: 🐝 Update SDK - Generate RC SDK (Prerelease) [openapi-prerelease] 0.1.1rc6
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: cfa345be-20bc-4980-a260-c3fa74040ac2
 management:
-  docChecksum: f0436d64c919795f51be04910839f5de
+  docChecksum: 3ce8e7e8d6960ec2415b14c009e61a4d
   docVersion: 4.15.0-alpha.1760607052180-31a53a17
   speakeasyVersion: 1.636.3
   generationVersion: 2.723.11
-  releaseVersion: 0.1.1rc5
-  configChecksum: d891ce86d0ccddf6f08435d8df2cf3bc
+  releaseVersion: 0.1.1rc6
+  configChecksum: 80d03e0ceb51cb6bc253b71f0e0c49f6
   repoURL: https://github.com/criblio/cribl_control_plane_sdk_python.git
   installationURL: https://github.com/criblio/cribl_control_plane_sdk_python.git
   published: true
@@ -1022,6 +1022,7 @@ generatedFiles:
   - docs/models/listroutesresponse.md
   - docs/models/loggedinusers.md
   - docs/models/logininfo.md
+  - docs/models/loginresponse.md
   - docs/models/loglabel.md
   - docs/models/loglocationtype.md
   - docs/models/lokiauthoauthheader1.md
@@ -2206,6 +2207,7 @@ generatedFiles:
   - src/cribl_control_plane/models/listpipelineop.py
   - src/cribl_control_plane/models/listroutesop.py
   - src/cribl_control_plane/models/logininfo.py
+  - src/cribl_control_plane/models/loginop.py
   - src/cribl_control_plane/models/lookupversions.py
   - src/cribl_control_plane/models/masterworkerentry.py
   - src/cribl_control_plane/models/nodeactiveupgradestatus.py
@@ -2367,7 +2369,7 @@ examples:
         application/json: {"username": "Nikko.Connelly", "password": "Ljp4BunfMR9hNyM"}
       responses:
         "200":
-          application/json: {"token": "<value>"}
+          application/json: {"token": "<value>", "forcePasswordChange": false}
   listInput:
     speakeasy-default-list-input:
       responses:
@@ -3324,3 +3326,6 @@ generatedTests:
   updatePacksById: "2025-08-01T02:34:48Z"
   deleteGroupsById: "2025-08-04T02:32:44Z"
   updateGroupsById: "2025-08-04T02:32:44Z"
+releaseNotes: |
+  ## Python SDK Changes Detected:
+  * `cribl_control_plane.auth.tokens.get()`:  `response.force_password_change` **Added**
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -26,7 +26,7 @@ generation:
     generateNewTests: false
     skipResponseBodyAssertions: false
 python:
-  version: 0.1.1rc5
+  version: 0.1.1rc6
   additionalDependencies:
     dev: {}
     main: {}
diff --git a/.speakeasy/out.openapi.yaml b/.speakeasy/out.openapi.yaml
@@ -40945,9 +40945,12 @@ components:
       type: object
       required:
         - token
+        - forcePasswordChange
       properties:
         token:
           type: string
+        forcePasswordChange:
+          type: boolean
     DistributedSummary:
       type: object
       properties:
@@ -43518,6 +43521,12 @@ paths:
           description: Access denied
         "429":
           description: Rate limit exceeded
+          headers:
+            Retry-After:
+              description: Number of seconds to wait before retrying the request
+              schema:
+                type: integer
+                example: 60
   /master/summary:
     get:
       operationId: getSummary
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,20 +2,20 @@ speakeasyVersion: 1.636.3
 sources:
     Cribl API Reference:
         sourceNamespace: cribl-api-reference
-        sourceRevisionDigest: sha256:8b700b7bb839e9e46f8268aae9eb74ce73644375221ee5a2aa4e309d13aec861
-        sourceBlobDigest: sha256:eff34ccf49f07c1d7898d2f5daaf9fe376fcdfbe566c271072aaa55603d70be4
+        sourceRevisionDigest: sha256:b664790eb635307de4cd040982c4345aeb61bc94062c8d74b2bb0341a04c3fcc
+        sourceBlobDigest: sha256:cba1f20a82e49790278c2fb219ee0704fac254277dc3b4bc338c6194c5993a83
         tags:
             - latest
-            - speakeasy-sdk-regen-openapi-prerelease-1760607693
+            - speakeasy-sdk-regen-openapi-prerelease-1760613899
             - 4.15.0-alpha.1760607052180-31a53a17
 targets:
     cribl-control-plane:
         source: Cribl API Reference
         sourceNamespace: cribl-api-reference
-        sourceRevisionDigest: sha256:8b700b7bb839e9e46f8268aae9eb74ce73644375221ee5a2aa4e309d13aec861
-        sourceBlobDigest: sha256:eff34ccf49f07c1d7898d2f5daaf9fe376fcdfbe566c271072aaa55603d70be4
+        sourceRevisionDigest: sha256:b664790eb635307de4cd040982c4345aeb61bc94062c8d74b2bb0341a04c3fcc
+        sourceBlobDigest: sha256:cba1f20a82e49790278c2fb219ee0704fac254277dc3b4bc338c6194c5993a83
         codeSamplesNamespace: cribl-api-reference-python-code-samples
-        codeSamplesRevisionDigest: sha256:eaa1fafe180eb4111e5fab614cd0aef39c95944c1a38c334f7c7d0a56a9b800f
+        codeSamplesRevisionDigest: sha256:cb161c9f69cf086010334a5cc4012596e7b83b23ef4b707ecb1771572425f0d3
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: 1.636.3
diff --git a/RELEASES.md b/RELEASES.md
@@ -498,4 +498,14 @@ Based on:
 ### Generated
 - [python v0.1.1rc5] .
 ### Releases
-- [PyPI v0.1.1rc5] https://pypi.org/project/cribl-control-plane/0.1.1rc5 - .
+- [PyPI v0.1.1rc5] https://pypi.org/project/cribl-control-plane/0.1.1rc5 - .
+
+## 2025-10-16 11:24:39
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.636.3 (2.723.11) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.1.1rc6] .
+### Releases
+- [PyPI v0.1.1rc6] https://pypi.org/project/cribl-control-plane/0.1.1rc6 - .
diff --git a/docs/models/authtoken.md b/docs/models/authtoken.md
@@ -3,6 +3,7 @@
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `token`            | *str*              | :heavy_check_mark: | N/A                |
+| Field                   | Type                    | Required                | Description             |
+| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
+| `token`                 | *str*                   | :heavy_check_mark:      | N/A                     |
+| `force_password_change` | *bool*                  | :heavy_check_mark:      | N/A                     |
diff --git a/docs/models/loginresponse.md b/docs/models/loginresponse.md
@@ -0,0 +1,9 @@
+# LoginResponse
+
+
+## Fields
+
+| Field                                      | Type                                       | Required                                   | Description                                |
+| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
+| `headers`                                  | Dict[str, List[*str*]]                     | :heavy_check_mark:                         | N/A                                        |
+| `result`                                   | [models.AuthToken](../models/authtoken.md) | :heavy_check_mark:                         | N/A                                        |
diff --git a/docs/sdks/tokens/README.md b/docs/sdks/tokens/README.md
@@ -39,7 +39,7 @@ with CriblControlPlane(
 
 ### Response
 
-**[models.AuthToken](../../models/authtoken.md)**
+**[models.LoginResponse](../../models/loginresponse.md)**
 
 ### Errors
 
diff --git a/examples/auth.py b/examples/auth.py
@@ -169,7 +169,7 @@ async def get_client(self) -> CriblControlPlane:
                 username=self.username,
                 password=self.password
             )
-            token = response.token
+            token = response.result.token
 
             security = Security(bearer_auth=token)
             self.client = CriblControlPlane(
diff --git a/examples/example_onprem_auth.py b/examples/example_onprem_auth.py
@@ -36,7 +36,7 @@ async def main():
         username=ONPREM_USERNAME,
         password=ONPREM_PASSWORD
     )
-    token = response.token
+    token = response.result.token
     print(f"✅ Authenticated with on-prem server, token: {token}")
 
     # Create authenticated SDK client
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 
 [project]
 name = "cribl-control-plane"
-version = "0.1.1rc5"
+version = "0.1.1rc6"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"
diff --git a/src/cribl_control_plane/_version.py b/src/cribl_control_plane/_version.py
@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "cribl-control-plane"
-__version__: str = "0.1.1rc5"
+__version__: str = "0.1.1rc6"
 __openapi_doc_version__: str = "4.15.0-alpha.1760607052180-31a53a17"
 __gen_version__: str = "2.723.11"
-__user_agent__: str = "speakeasy-sdk/python 0.1.1rc5 2.723.11 4.15.0-alpha.1760607052180-31a53a17 cribl-control-plane"
+__user_agent__: str = "speakeasy-sdk/python 0.1.1rc6 2.723.11 4.15.0-alpha.1760607052180-31a53a17 cribl-control-plane"
 
 try:
     if __package__ is not None:
diff --git a/src/cribl_control_plane/models/__init__.py b/src/cribl_control_plane/models/__init__.py
@@ -1803,6 +1803,7 @@
     from .listpipelineop import ListPipelineResponse, ListPipelineResponseTypedDict
     from .listroutesop import ListRoutesResponse, ListRoutesResponseTypedDict
     from .logininfo import LoginInfo, LoginInfoTypedDict
+    from .loginop import LoginResponse, LoginResponseTypedDict
     from .lookupversions import LookupVersions, LookupVersionsTypedDict
     from .masterworkerentry import (
         LastMetrics,
@@ -4908,6 +4909,8 @@
     "LoggedInUsersTypedDict",
     "LoginInfo",
     "LoginInfoTypedDict",
+    "LoginResponse",
+    "LoginResponseTypedDict",
     "LokiAuthOauthHeader1",
     "LokiAuthOauthHeader1TypedDict",
     "LokiAuthOauthHeader2",
@@ -7876,6 +7879,8 @@
     "ListRoutesResponseTypedDict": ".listroutesop",
     "LoginInfo": ".logininfo",
     "LoginInfoTypedDict": ".logininfo",
+    "LoginResponse": ".loginop",
+    "LoginResponseTypedDict": ".loginop",
     "LookupVersions": ".lookupversions",
     "LookupVersionsTypedDict": ".lookupversions",
     "LastMetrics": ".masterworkerentry",
diff --git a/src/cribl_control_plane/models/authtoken.py b/src/cribl_control_plane/models/authtoken.py
@@ -2,12 +2,16 @@
 
 from __future__ import annotations
 from cribl_control_plane.types import BaseModel
-from typing_extensions import TypedDict
+import pydantic
+from typing_extensions import Annotated, TypedDict
 
 
 class AuthTokenTypedDict(TypedDict):
     token: str
+    force_password_change: bool
 
 
 class AuthToken(BaseModel):
     token: str
+
+    force_password_change: Annotated[bool, pydantic.Field(alias="forcePasswordChange")]
diff --git a/src/cribl_control_plane/models/loginop.py b/src/cribl_control_plane/models/loginop.py
@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .authtoken import AuthToken, AuthTokenTypedDict
+from cribl_control_plane.types import BaseModel
+from typing import Dict, List
+from typing_extensions import TypedDict
+
+
+class LoginResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+    result: AuthTokenTypedDict
+
+
+class LoginResponse(BaseModel):
+    headers: Dict[str, List[str]]
+
+    result: AuthToken
diff --git a/src/cribl_control_plane/tokens.py b/src/cribl_control_plane/tokens.py
@@ -18,7 +18,7 @@ def get(
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.AuthToken:
+    ) -> models.LoginResponse:
         r"""Log in and fetch an authentication token
 
         This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
@@ -85,8 +85,13 @@ def get(
         )
 
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.AuthToken, http_res)
-        if utils.match_response(http_res, ["401", "403", "429", "4XX"], "*"):
+            return models.LoginResponse(
+                result=unmarshal_json_response(models.AuthToken, http_res), headers={}
+            )
+        if utils.match_response(http_res, "429", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, ["401", "403", "4XX"], "*"):
             http_res_text = utils.stream_to_text(http_res)
             raise errors.APIError("API error occurred", http_res, http_res_text)
         if utils.match_response(http_res, "5XX", "*"):
@@ -104,7 +109,7 @@ async def get_async(
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.AuthToken:
+    ) -> models.LoginResponse:
         r"""Log in and fetch an authentication token
 
         This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
@@ -171,8 +176,13 @@ async def get_async(
         )
 
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.AuthToken, http_res)
-        if utils.match_response(http_res, ["401", "403", "429", "4XX"], "*"):
+            return models.LoginResponse(
+                result=unmarshal_json_response(models.AuthToken, http_res), headers={}
+            )
+        if utils.match_response(http_res, "429", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, ["401", "403", "4XX"], "*"):
             http_res_text = await utils.stream_to_text_async(http_res)
             raise errors.APIError("API error occurred", http_res, http_res_text)
         if utils.match_response(http_res, "5XX", "*"):

Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ async def get_client(self) -> CriblControlPlane:`
`169`	`169`	`username=self.username,`
`170`	`170`	`password=self.password`
`171`	`171`	`)`
`172`		`- token = response.token`
	`172`	`+ token = response.result.token`
`173`	`173`
`174`	`174`	`security = Security(bearer_auth=token)`
`175`	`175`	`self.client = CriblControlPlane(`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ async def main():`
`36`	`36`	`username=ONPREM_USERNAME,`
`37`	`37`	`password=ONPREM_PASSWORD`
`38`	`38`	`)`
`39`		`- token = response.token`
	`39`	`+ token = response.result.token`
`40`	`40`	`print(f"✅ Authenticated with on-prem server, token: {token}")`
`41`	`41`
`42`	`42`	`# Create authenticated SDK client`