ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.540.0

Author: speakeasybot

.gitignore

@@ -1,3 +1,5 @@
+.speakeasy/temp/
+.speakeasy/reports
 .venv/
 src/*.egg-info/
 .python-version

.speakeasy/gen.lock

@@ -10,13 +10,15 @@ generation:
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
+    nameResolutionFeb2025: false
     parameterOrderingFeb2024: true
     requestResponseComponentNamesFeb2024: true
+    securityFeb2025: false
   auth:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 python:
-  version: 0.9.0
+  version: 0.10.0
   additionalDependencies:
     dev: {}
     main: {}
@@ -25,6 +27,7 @@ python:
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
   description: Python Client SDK for unkey.com.
+  enableCustomCodeRegions: false
   enumFormat: enum
   envVarPrefix: UNKEY
   fixFlags:
@@ -45,5 +48,6 @@ python:
   methodArguments: infer-optional-args
   outputModelSuffix: output
   packageName: unkey.py
+  pytestTimeout: 0
   responseFormat: envelope-http
   templateVersion: v2

.speakeasy/gen.yaml

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.453.4
+speakeasyVersion: 1.540.0
 sources:
     Unkey-OAS:
         sourceNamespace: unkey-oas
-        sourceRevisionDigest: sha256:8195101f876a2dee27540ad46a0ff11904f6f41eaab663ca7e6d6ec88adf8c68
-        sourceBlobDigest: sha256:2ec7e32aea77a854bdd608875cfcd1110ba479f365389e3707bfff61885ff102
+        sourceRevisionDigest: sha256:87b7088b14a4906fc3a9d47a6426aa4e2bb5e327048c3bfb05c92013b8ccfd0c
+        sourceBlobDigest: sha256:90a47f37016a08f227995de7d5aae2bf27a7ec8e63ce9e722b2243d161307128
         tags:
             - latest
-            - speakeasy-sdk-regen-1730334330
+            - speakeasy-sdk-regen-1739752037
             - 1.0.0
 targets:
     unkey:
         source: Unkey-OAS
         sourceNamespace: unkey-oas
-        sourceRevisionDigest: sha256:8195101f876a2dee27540ad46a0ff11904f6f41eaab663ca7e6d6ec88adf8c68
-        sourceBlobDigest: sha256:2ec7e32aea77a854bdd608875cfcd1110ba479f365389e3707bfff61885ff102
+        sourceRevisionDigest: sha256:87b7088b14a4906fc3a9d47a6426aa4e2bb5e327048c3bfb05c92013b8ccfd0c
+        sourceBlobDigest: sha256:90a47f37016a08f227995de7d5aae2bf27a7ec8e63ce9e722b2243d161307128
         codeSamplesNamespace: unkey-oas-python-code-samples
-        codeSamplesRevisionDigest: sha256:4c557e4115ee27d060ee91bebe3faa42dfaea6651b128997b9f722c7992a96fc
+        codeSamplesRevisionDigest: sha256:2df834896b75976a16a6ccc505428d2e9553bfdb2d6366942ca24cb389635359
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

.speakeasy/workflow.lock

@@ -32,6 +32,7 @@ Developer-friendly & type-safe Python SDK for Unkey's API.
   * [Server Selection](#server-selection)
   * [Custom HTTP Client](#custom-http-client)
   * [Authentication](#authentication)
+  * [Resource Management](#resource-management)
   * [Debugging](#debugging)
 * [Development](#development)
   * [Maturity](#maturity)
@@ -42,6 +43,11 @@ Developer-friendly & type-safe Python SDK for Unkey's API.
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+> [!NOTE]
+> **Python version upgrade policy**
+>
+> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
+
 The SDK can be installed with either *pip* or *poetry* package managers.
 
 ### PIP
@@ -59,6 +65,37 @@ pip install unkey.py
 ```bash
 poetry add unkey.py
 ```
+
+### Shell and script usage with `uv`
+
+You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
+
+```shell
+uvx --from unkey.py python
+```
+
+It's also possible to write a standalone Python script without needing to set up a whole project like so:
+
+```python
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.9"
+# dependencies = [
+#     "unkey.py",
+# ]
+# ///
+
+from unkey_py import Unkey
+
+sdk = Unkey(
+  # SDK arguments
+)
+
+# Rest of script here...
+```
+
+Once that is saved to a file, you can run it with `uv run script.py` where
+`script.py` can be replaced with the actual file name.
 <!-- End SDK Installation [installation] -->
 
 <!-- Start IDE Support [idesupport] -->
@@ -80,14 +117,17 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 # Synchronous Example
 from unkey_py import Unkey
 
+
 with Unkey(
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
-    res = s.liveness.check()
+) as unkey:
+
+    res = unkey.liveness.check()
 
-    if res.object is not None:
-        # handle response
-        pass
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 ```
 
 </br>
@@ -99,14 +139,17 @@ import asyncio
 from unkey_py import Unkey
 
 async def main():
+
     async with Unkey(
         bearer_auth="UNKEY_ROOT_KEY",
-    ) as s:
-        res = await s.liveness.check_async()
+    ) as unkey:
 
-        if res.object is not None:
-            # handle response
-            pass
+        res = await unkey.liveness.check_async()
+
+        assert res.object is not None
+
+        # Handle response
+        print(res.object)
 
 asyncio.run(main())
 ```
@@ -118,6 +161,10 @@ asyncio.run(main())
 <details open>
 <summary>Available methods</summary>
 
+### [analytics](docs/sdks/analytics/README.md)
+
+* [get_verifications](docs/sdks/analytics/README.md#get_verifications)
+
 ### [apis](docs/sdks/apis/README.md)
 
 * [get](docs/sdks/apis/README.md#get)
@@ -173,7 +220,7 @@ asyncio.run(main())
 
 ### [ratelimit](docs/sdks/ratelimit/README.md)
 
-* [ratelimit_set_override](docs/sdks/ratelimit/README.md#ratelimit_set_override)
+* [set_override](docs/sdks/ratelimit/README.md#set_override)
 * [list_overrides](docs/sdks/ratelimit/README.md#list_overrides)
 * [get_override](docs/sdks/ratelimit/README.md#get_override)
 
@@ -197,18 +244,17 @@ Here's an example of one such pagination call:
 ```python
 from unkey_py import Unkey
 
+
 with Unkey(
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
-    res = s.identities.list(limit=100)
+) as unkey:
+
+    res = unkey.identities.list()
 
-    if res.object is not None:
-        while True:
-            # handle items
+    while res is not None:
+        # Handle items
 
-            res = res.next()
-            if res is None:
-                break
+        res = res.next()
 
 ```
 <!-- End Pagination [pagination] -->
@@ -220,35 +266,41 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from unkey.utils import BackoffStrategy, RetryConfig
 from unkey_py import Unkey
+from unkey_py.utils import BackoffStrategy, RetryConfig
+
 
 with Unkey(
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
-    res = s.liveness.check(,
+) as unkey:
+
+    res = unkey.liveness.check(,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-    if res.object is not None:
-        # handle response
-        pass
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from unkey.utils import BackoffStrategy, RetryConfig
 from unkey_py import Unkey
+from unkey_py.utils import BackoffStrategy, RetryConfig
+
 
 with Unkey(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
-    res = s.liveness.check()
+) as unkey:
+
+    res = unkey.liveness.check()
 
-    if res.object is not None:
-        # handle response
-        pass
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Retries [retries] -->
@@ -276,6 +328,7 @@ When custom error responses are specified for an operation, the SDK may also rai
 | models.ErrForbidden           | 403         | application/json |
 | models.ErrNotFound            | 404         | application/json |
 | models.ErrConflict            | 409         | application/json |
+| models.ErrPreconditionFailed  | 412         | application/json |
 | models.ErrTooManyRequests     | 429         | application/json |
 | models.ErrInternalServerError | 500         | application/json |
 | models.SDKError               | 4XX, 5XX    | \*/\*            |
@@ -285,16 +338,19 @@ When custom error responses are specified for an operation, the SDK may also rai
 ```python
 from unkey_py import Unkey, models
 
+
 with Unkey(
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
+) as unkey:
     res = None
     try:
-        res = s.liveness.check()
 
-        if res.object is not None:
-            # handle response
-            pass
+        res = unkey.liveness.check()
+
+        assert res.object is not None
+
+        # Handle response
+        print(res.object)
 
     except models.ErrBadRequest as e:
         # handle e.data: models.ErrBadRequestData
@@ -311,6 +367,9 @@ with Unkey(
     except models.ErrConflict as e:
         # handle e.data: models.ErrConflictData
         raise(e)
+    except models.ErrPreconditionFailed as e:
+        # handle e.data: models.ErrPreconditionFailedData
+        raise(e)
     except models.ErrTooManyRequests as e:
         # handle e.data: models.ErrTooManyRequestsData
         raise(e)
@@ -328,19 +387,22 @@ with Unkey(
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
+The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from unkey_py import Unkey
 
+
 with Unkey(
     server_url="https://api.unkey.dev",
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
-    res = s.liveness.check()
+) as unkey:
+
+    res = unkey.liveness.check()
 
-    if res.object is not None:
-        # handle response
-        pass
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Server Selection [server] -->
@@ -441,18 +503,48 @@ To authenticate with the API the `bearer_auth` parameter must be set when initia
 ```python
 from unkey_py import Unkey
 
+
 with Unkey(
     bearer_auth="UNKEY_ROOT_KEY",
-) as s:
-    res = s.liveness.check()
+) as unkey:
 
-    if res.object is not None:
-        # handle response
-        pass
+    res = unkey.liveness.check()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Resource Management [resource-management] -->
+## Resource Management
+
+The `Unkey` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+
+[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
+
+```python
+from unkey_py import Unkey
+def main():
+
+    with Unkey(
+        bearer_auth="UNKEY_ROOT_KEY",
+    ) as unkey:
+        # Rest of application here...
+
+
+# Or when using async:
+async def amain():
+
+    async with Unkey(
+        bearer_auth="UNKEY_ROOT_KEY",
+    ) as unkey:
+        # Rest of application here...
+```
+<!-- End Resource Management [resource-management] -->
+
 <!-- Start Debugging [debug] -->
 ## Debugging