Merge pull request #3 from unkeyed/speakeasy-sdk-regen-1730280889

chore: 🐝 Update SDK - Generate 0.2.1

.speakeasy/gen.lock

@@ -3,10 +3,10 @@ id: 8618b570-44d2-4c9e-aa91-d78e8fe5330e
 management:
   docChecksum: 6a3c4265582b7a6d51d438f935f03946
   docVersion: 1.0.0
-  speakeasyVersion: 1.423.1
+  speakeasyVersion: 1.423.2
   generationVersion: 2.442.11
-  releaseVersion: 0.2.0
-  configChecksum: 6f8d3a2df81e982a349004e60ee623a2
+  releaseVersion: 0.2.1
+  configChecksum: ab6b2b4d99cbe9ccc8b9e716725cb36f
   repoURL: https://github.com/unkeyed/unkey-py.git
   installationURL: https://github.com/unkeyed/unkey-py.git
   published: true
@@ -246,92 +246,92 @@ generatedFiles:
   - scripts/compile.sh
   - scripts/prepare-readme.py
   - scripts/publish.sh
-  - src/unkey/__init__.py
-  - src/unkey/_hooks/__init__.py
-  - src/unkey/_hooks/sdkhooks.py
-  - src/unkey/_hooks/types.py
-  - src/unkey/_version.py
-  - src/unkey/apis.py
-  - src/unkey/basesdk.py
-  - src/unkey/httpclient.py
-  - src/unkey/identities.py
-  - src/unkey/keys.py
-  - src/unkey/liveness.py
-  - src/unkey/migrations.py
-  - src/unkey/models/__init__.py
-  - src/unkey/models/addpermissionsop.py
-  - src/unkey/models/addrolesop.py
-  - src/unkey/models/createapiop.py
-  - src/unkey/models/createidentityop.py
-  - src/unkey/models/createkeyop.py
-  - src/unkey/models/createpermissionop.py
-  - src/unkey/models/createroleop.py
-  - src/unkey/models/deleteapiop.py
-  - src/unkey/models/deleteidentityop.py
-  - src/unkey/models/deletekeyop.py
-  - src/unkey/models/deletekeysop.py
-  - src/unkey/models/deletepermissionop.py
-  - src/unkey/models/deleteroleop.py
-  - src/unkey/models/errbadrequest.py
-  - src/unkey/models/errconflict.py
-  - src/unkey/models/errdeleteprotected.py
-  - src/unkey/models/errforbidden.py
-  - src/unkey/models/errinternalservererror.py
-  - src/unkey/models/errnotfound.py
-  - src/unkey/models/errtoomanyrequests.py
-  - src/unkey/models/errunauthorized.py
-  - src/unkey/models/getapiop.py
-  - src/unkey/models/getidentityop.py
-  - src/unkey/models/getkeyop.py
-  - src/unkey/models/getpermissionop.py
-  - src/unkey/models/getroleop.py
-  - src/unkey/models/getverificationsop.py
-  - src/unkey/models/httpmetadata.py
-  - src/unkey/models/key.py
-  - src/unkey/models/limitop.py
-  - src/unkey/models/listidentitiesop.py
-  - src/unkey/models/listkeysop.py
-  - src/unkey/models/listpermissionsop.py
-  - src/unkey/models/listrolesop.py
-  - src/unkey/models/permissionquery.py
-  - src/unkey/models/removepermissionsop.py
-  - src/unkey/models/removerolesop.py
-  - src/unkey/models/sdkerror.py
-  - src/unkey/models/security.py
-  - src/unkey/models/setpermissionsop.py
-  - src/unkey/models/setrolesop.py
-  - src/unkey/models/updateidentityop.py
-  - src/unkey/models/updatekeyop.py
-  - src/unkey/models/updateremainingop.py
-  - src/unkey/models/v1_livenessop.py
-  - src/unkey/models/v1_migrations_createkeysop.py
-  - src/unkey/models/v1_migrations_enqueuekeysop.py
-  - src/unkey/models/v1keysverifykeyrequest.py
-  - src/unkey/models/v1keysverifykeyresponse.py
-  - src/unkey/models/verifykeyop.py
-  - src/unkey/models/whoamiop.py
-  - src/unkey/permissions.py
-  - src/unkey/py.typed
-  - src/unkey/ratelimits.py
-  - src/unkey/sdk.py
-  - src/unkey/sdkconfiguration.py
-  - src/unkey/types/__init__.py
-  - src/unkey/types/basemodel.py
-  - src/unkey/utils/__init__.py
-  - src/unkey/utils/annotations.py
-  - src/unkey/utils/enums.py
-  - src/unkey/utils/eventstreaming.py
-  - src/unkey/utils/forms.py
-  - src/unkey/utils/headers.py
-  - src/unkey/utils/logger.py
-  - src/unkey/utils/metadata.py
-  - src/unkey/utils/queryparams.py
-  - src/unkey/utils/requestbodies.py
-  - src/unkey/utils/retries.py
-  - src/unkey/utils/security.py
-  - src/unkey/utils/serializers.py
-  - src/unkey/utils/url.py
-  - src/unkey/utils/values.py
+  - src/unkey_py/__init__.py
+  - src/unkey_py/_hooks/__init__.py
+  - src/unkey_py/_hooks/sdkhooks.py
+  - src/unkey_py/_hooks/types.py
+  - src/unkey_py/_version.py
+  - src/unkey_py/apis.py
+  - src/unkey_py/basesdk.py
+  - src/unkey_py/httpclient.py
+  - src/unkey_py/identities.py
+  - src/unkey_py/keys.py
+  - src/unkey_py/liveness.py
+  - src/unkey_py/migrations.py
+  - src/unkey_py/models/__init__.py
+  - src/unkey_py/models/addpermissionsop.py
+  - src/unkey_py/models/addrolesop.py
+  - src/unkey_py/models/createapiop.py
+  - src/unkey_py/models/createidentityop.py
+  - src/unkey_py/models/createkeyop.py
+  - src/unkey_py/models/createpermissionop.py
+  - src/unkey_py/models/createroleop.py
+  - src/unkey_py/models/deleteapiop.py
+  - src/unkey_py/models/deleteidentityop.py
+  - src/unkey_py/models/deletekeyop.py
+  - src/unkey_py/models/deletekeysop.py
+  - src/unkey_py/models/deletepermissionop.py
+  - src/unkey_py/models/deleteroleop.py
+  - src/unkey_py/models/errbadrequest.py
+  - src/unkey_py/models/errconflict.py
+  - src/unkey_py/models/errdeleteprotected.py
+  - src/unkey_py/models/errforbidden.py
+  - src/unkey_py/models/errinternalservererror.py
+  - src/unkey_py/models/errnotfound.py
+  - src/unkey_py/models/errtoomanyrequests.py
+  - src/unkey_py/models/errunauthorized.py
+  - src/unkey_py/models/getapiop.py
+  - src/unkey_py/models/getidentityop.py
+  - src/unkey_py/models/getkeyop.py
+  - src/unkey_py/models/getpermissionop.py
+  - src/unkey_py/models/getroleop.py
+  - src/unkey_py/models/getverificationsop.py
+  - src/unkey_py/models/httpmetadata.py
+  - src/unkey_py/models/key.py
+  - src/unkey_py/models/limitop.py
+  - src/unkey_py/models/listidentitiesop.py
+  - src/unkey_py/models/listkeysop.py
+  - src/unkey_py/models/listpermissionsop.py
+  - src/unkey_py/models/listrolesop.py
+  - src/unkey_py/models/permissionquery.py
+  - src/unkey_py/models/removepermissionsop.py
+  - src/unkey_py/models/removerolesop.py
+  - src/unkey_py/models/sdkerror.py
+  - src/unkey_py/models/security.py
+  - src/unkey_py/models/setpermissionsop.py
+  - src/unkey_py/models/setrolesop.py
+  - src/unkey_py/models/updateidentityop.py
+  - src/unkey_py/models/updatekeyop.py
+  - src/unkey_py/models/updateremainingop.py
+  - src/unkey_py/models/v1_livenessop.py
+  - src/unkey_py/models/v1_migrations_createkeysop.py
+  - src/unkey_py/models/v1_migrations_enqueuekeysop.py
+  - src/unkey_py/models/v1keysverifykeyrequest.py
+  - src/unkey_py/models/v1keysverifykeyresponse.py
+  - src/unkey_py/models/verifykeyop.py
+  - src/unkey_py/models/whoamiop.py
+  - src/unkey_py/permissions.py
+  - src/unkey_py/py.typed
+  - src/unkey_py/ratelimits.py
+  - src/unkey_py/sdk.py
+  - src/unkey_py/sdkconfiguration.py
+  - src/unkey_py/types/__init__.py
+  - src/unkey_py/types/basemodel.py
+  - src/unkey_py/utils/__init__.py
+  - src/unkey_py/utils/annotations.py
+  - src/unkey_py/utils/enums.py
+  - src/unkey_py/utils/eventstreaming.py
+  - src/unkey_py/utils/forms.py
+  - src/unkey_py/utils/headers.py
+  - src/unkey_py/utils/logger.py
+  - src/unkey_py/utils/metadata.py
+  - src/unkey_py/utils/queryparams.py
+  - src/unkey_py/utils/requestbodies.py
+  - src/unkey_py/utils/retries.py
+  - src/unkey_py/utils/security.py
+  - src/unkey_py/utils/serializers.py
+  - src/unkey_py/utils/url.py
+  - src/unkey_py/utils/values.py
 examples:
   v1.liveness:
     speakeasy-default-v1-liveness:

.speakeasy/gen.yaml

@@ -15,7 +15,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 python:
-  version: 0.2.0
+  version: 0.2.1
   additionalDependencies:
     dev: {}
     main: {}

.speakeasy/workflow.lock

@@ -1,8 +1,8 @@
-speakeasyVersion: 1.423.1
+speakeasyVersion: 1.423.2
 sources:
     Unkey-OAS:
         sourceNamespace: unkey-oas
-        sourceRevisionDigest: sha256:dadcd25da50cf8783e6c2fba52f0c5e004af0c77635edacdc6948b5d8cf88c51
+        sourceRevisionDigest: sha256:03047b549939407d79938b5a9f9c27c689dad8d80d6635471e89043b89848b77
         sourceBlobDigest: sha256:6af87205b63b788e53a11d7145cd48df3e627187a5a2f694c27e3b2b49b06871
         tags:
             - latest
@@ -11,10 +11,10 @@ targets:
     unkey:
         source: Unkey-OAS
         sourceNamespace: unkey-oas
-        sourceRevisionDigest: sha256:dadcd25da50cf8783e6c2fba52f0c5e004af0c77635edacdc6948b5d8cf88c51
+        sourceRevisionDigest: sha256:03047b549939407d79938b5a9f9c27c689dad8d80d6635471e89043b89848b77
         sourceBlobDigest: sha256:6af87205b63b788e53a11d7145cd48df3e627187a5a2f694c27e3b2b49b06871
         codeSamplesNamespace: unkey-oas-code-samples
-        codeSamplesRevisionDigest: sha256:7555f203175249a448e9cc199ac850a15ba297f09eb320ec9913825d0979f417
+        codeSamplesRevisionDigest: sha256:74fbb75516a01df5ebc92ddfa43bffe6d18873933719e7ffadfd16bc591f6271
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

README.md

@@ -44,15 +44,15 @@ The SDK can be installed with either *pip* or *poetry* package managers.
 *PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
 
 ```bash
-pip install unkey
+pip install unkey.py
 ```
 
 ### Poetry
 
 *Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
 
 ```bash
-poetry add unkey
+poetry add unkey.py
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -74,7 +74,7 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 ```python
 # Synchronous Example
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 s = Unkey(
     bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
@@ -94,7 +94,7 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 async def main():
     s = Unkey(
@@ -186,7 +186,7 @@ return value of `Next` is `None`, then there are no more pages to be fetched.
 Here's an example of one such pagination call:
 ```python
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 s = Unkey(
     bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
@@ -213,8 +213,8 @@ 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
 import os
-from unkey import Unkey
 from unkey.utils import BackoffStrategy, RetryConfig
+from unkey_py import Unkey
 
 s = Unkey(
     bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
@@ -232,8 +232,8 @@ if res.object is not None:
 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
 import os
-from unkey import Unkey
 from unkey.utils import BackoffStrategy, RetryConfig
+from unkey_py import Unkey
 
 s = Unkey(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
@@ -280,7 +280,7 @@ When custom error responses are specified for an operation, the SDK may also rai
 
 ```python
 import os
-from unkey import Unkey, models
+from unkey_py import Unkey, models
 
 s = Unkey(
     bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
@@ -336,7 +336,7 @@ You can override the default server globally by passing a server index to the `s
 
 ```python
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 s = Unkey(
     server_idx=0,
@@ -357,7 +357,7 @@ if res.object is not None:
 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:
 ```python
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 s = Unkey(
     server_url="https://api.unkey.dev",
@@ -382,7 +382,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu
 
 For example, you could specify a header for every request that this sdk makes as follows:
 ```python
-from unkey import Unkey
+from unkey_py import Unkey
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
@@ -391,8 +391,8 @@ s = Unkey(client=http_client)
 
 or you could wrap the client with your own custom logic:
 ```python
-from unkey import Unkey
-from unkey.httpclient import AsyncHttpClient
+from unkey_py import Unkey
+from unkey_py.httpclient import AsyncHttpClient
 import httpx
 
 class CustomClient(AsyncHttpClient):
@@ -468,7 +468,7 @@ This SDK supports the following security scheme globally:
 To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
 ```python
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 s = Unkey(
     bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
@@ -490,11 +490,11 @@ You can setup your SDK to emit debug logs for SDK requests and responses.
 
 You can pass your own logger class directly into your SDK.
 ```python
-from unkey import Unkey
+from unkey_py import Unkey
 import logging
 
 logging.basicConfig(level=logging.DEBUG)
-s = Unkey(debug_logger=logging.getLogger("unkey"))
+s = Unkey(debug_logger=logging.getLogger("unkey_py"))
 ```
 
 You can also enable a default debug logger by setting an environment variable `UNKEY_DEBUG` to true.

RELEASES.md

@@ -18,4 +18,14 @@ Based on:
 ### Generated
 - [python v0.2.0] .
 ### Releases
-- [PyPI v0.2.0] https://pypi.org/project/unkey/0.2.0 - .
+- [PyPI v0.2.0] https://pypi.org/project/unkey/0.2.0 - .
+
+## 2024-10-30 09:34:46
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.423.2 (2.442.11) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.2.1] .
+### Releases
+- [PyPI v0.2.1] https://pypi.org/project/unkey.py/0.2.1 - .

USAGE.md

@@ -2,7 +2,7 @@
 ```python
 # Synchronous Example
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 s = Unkey(
     bearer_auth=os.getenv("UNKEY_BEARER_AUTH", ""),
@@ -22,7 +22,7 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 import os
-from unkey import Unkey
+from unkey_py import Unkey
 
 async def main():
     s = Unkey(