ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.543.1

Author: speakeasybot

.speakeasy/workflow.lock

@@ -1,10 +1,23 @@
-speakeasyVersion: 1.541.2
-sources: {}
+speakeasyVersion: 1.543.1
+sources:
+    Outpost API:
+        sourceNamespace: outpost-api
+        sourceRevisionDigest: sha256:a4fdcfe289a2e981c88c788be99b306751d0449d2e1aa76a6de3498f5559964c
+        sourceBlobDigest: sha256:a10a816abada79cb73fc22c859e5ea890870e42dce925fafd67710978d756693
+        tags:
+            - latest
+            - speakeasy-sdk-regen-1746795251
+            - 0.0.1
 targets:
     outpost-go:
         source: Outpost API
     outpost-python:
         source: Outpost API
+        sourceNamespace: outpost-api
+        sourceRevisionDigest: sha256:a4fdcfe289a2e981c88c788be99b306751d0449d2e1aa76a6de3498f5559964c
+        sourceBlobDigest: sha256:a10a816abada79cb73fc22c859e5ea890870e42dce925fafd67710978d756693
+        codeSamplesNamespace: outpost-api-python-code-samples
+        codeSamplesRevisionDigest: sha256:27069f573d06905336ec09c42ffaa4efaf11dac3242051bdc27c36e6bf42d156
     outpost-ts:
         source: Outpost API
 workflow:
@@ -13,7 +26,7 @@ workflow:
     sources:
         Outpost API:
             inputs:
-                - location: ./sdks/schemas/hookdeck-schema.yaml
+                - location: ./docs/apis/openapi.yaml
             overlays:
                 - location: ./sdks/schemas/speakeasy-modifications-overlay.yaml
                 - location: ./sdks/schemas/error-types.yaml
@@ -34,6 +47,9 @@ workflow:
             target: python
             source: Outpost API
             output: ./sdks/python
+            publish:
+                pypi:
+                    token: $pypi_token
             codeSamples:
                 registry:
                     location: registry.speakeasyapi.dev/hookdeck-dev/outpost/outpost-api-python-code-samples
@@ -44,6 +60,9 @@ workflow:
             target: typescript
             source: Outpost API
             output: ./sdks/typescript
+            publish:
+                npm:
+                    token: $npm_token
             codeSamples:
                 registry:
                     location: registry.speakeasyapi.dev/hookdeck-dev/outpost/outpost-api-typescript-code-samples

sdks/python/.gitignore

@@ -1,3 +1,4 @@
+**/__pycache__/
 .venv/
 venv/
 src/*.egg-info/

sdks/python/.speakeasy/gen.lock

@@ -16,7 +16,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
 python:
-  version: 0.0.1
+  version: 0.1.0
   additionalDependencies:
     dev: {}
     main: {}

sdks/python/.speakeasy/gen.yaml

@@ -45,10 +45,6 @@ Outpost API: The Outpost API is a REST-based JSON API for managing tenants, dest
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 > [!NOTE]
 > **Python version upgrade policy**
 >
@@ -61,23 +57,23 @@ 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 git+<UNSET>.git
+pip install outpost_sdk
 ```
 
 ### 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 git+<UNSET>.git
+poetry add outpost_sdk
 ```
 
 ### 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 openapi python
+uvx --from outpost_sdk python
 ```
 
 It's also possible to write a standalone Python script without needing to set up a whole project like so:
@@ -87,13 +83,13 @@ It's also possible to write a standalone Python script without needing to set up
 # /// script
 # requires-python = ">=3.9"
 # dependencies = [
-#     "openapi",
+#     "outpost_sdk",
 # ]
 # ///
 
-from openapi import SDK
+from outpost_sdk import Outpost
 
-sdk = SDK(
+sdk = Outpost(
   # SDK arguments
 )
 
@@ -121,14 +117,12 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 
 ```python
 # Synchronous Example
-from openapi import SDK
+from outpost_sdk import Outpost
 
 
-with SDK(
-    admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+with Outpost() as outpost:
 
-    res = sdk.health.check()
+    res = outpost.health.check()
 
     # Handle response
     print(res)
@@ -140,15 +134,13 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from openapi import SDK
+from outpost_sdk import Outpost
 
 async def main():
 
-    async with SDK(
-        admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-    ) as sdk:
+    async with Outpost() as outpost:
 
-        res = await sdk.health.check_async()
+        res = await outpost.health.check_async()
 
         # Handle response
         print(res)
@@ -170,14 +162,14 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `admin_api_key` parameter must be set when initializing the SDK client instance. For example:
 ```python
-from openapi import SDK
+from outpost_sdk import Outpost
 
 
-with SDK(
+with Outpost(
     admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+) as outpost:
 
-    res = sdk.health.check()
+    res = outpost.health.check()
 
     # Handle response
     print(res)
@@ -188,12 +180,12 @@ with SDK(
 
 Some operations in this SDK require the security scheme to be specified at the request level. For example:
 ```python
-from openapi import SDK, models
+from outpost_sdk import Outpost, models
 
 
-with SDK() as sdk:
+with Outpost() as outpost:
 
-    res = sdk.tenants.get(security=models.GetTenantSecurity(
+    res = outpost.tenants.get(security=models.GetTenantSecurity(
 
     ), tenant_id="<id>")
 
@@ -232,6 +224,7 @@ with SDK() as sdk:
 
 * [check](docs/sdks/health/README.md#check) - Health Check
 
+
 ### [publish](docs/sdks/publish/README.md)
 
 * [event](docs/sdks/publish/README.md#event) - Publish Event
@@ -243,7 +236,6 @@ with SDK() as sdk:
 * [list_destination_types_jwt](docs/sdks/schemas/README.md#list_destination_types_jwt) - List Destination Type Schemas (JWT Auth)
 * [get_destination_type_jwt](docs/sdks/schemas/README.md#get_destination_type_jwt) - Get Destination Type Schema (JWT Auth)
 
-
 ### [tenants](docs/sdks/tenants/README.md)
 
 * [upsert](docs/sdks/tenants/README.md#upsert) - Create or Update Tenant
@@ -281,14 +273,14 @@ The following global parameter is available.
 ### Example
 
 ```python
-from openapi import SDK
+from outpost_sdk import Outpost
 
 
-with SDK(
+with Outpost(
     admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+) as outpost:
 
-    res = sdk.tenants.upsert(tenant_id="<id>")
+    res = outpost.tenants.upsert(tenant_id="<id>")
 
     # Handle response
     print(res)
@@ -303,15 +295,13 @@ 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 openapi import SDK
-from openapi.utils import BackoffStrategy, RetryConfig
+from outpost_sdk import Outpost
+from outpost_sdk.utils import BackoffStrategy, RetryConfig
 
 
-with SDK(
-    admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+with Outpost() as outpost:
 
-    res = sdk.health.check(,
+    res = outpost.health.check(,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -321,16 +311,15 @@ with SDK(
 
 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 openapi import SDK
-from openapi.utils import BackoffStrategy, RetryConfig
+from outpost_sdk import Outpost
+from outpost_sdk.utils import BackoffStrategy, RetryConfig
 
 
-with SDK(
+with Outpost(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-    admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+) as outpost:
 
-    res = sdk.health.check()
+    res = outpost.health.check()
 
     # Handle response
     print(res)
@@ -371,16 +360,14 @@ When custom error responses are specified for an operation, the SDK may also rai
 ### Example
 
 ```python
-from openapi import SDK, errors
+from outpost_sdk import Outpost, errors
 
 
-with SDK(
-    admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+with Outpost() as outpost:
     res = None
     try:
 
-        res = sdk.health.check()
+        res = outpost.health.check()
 
         # Handle response
         print(res)
@@ -428,15 +415,14 @@ with SDK(
 
 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 openapi import SDK
+from outpost_sdk import Outpost
 
 
-with SDK(
+with Outpost(
     server_url="http://localhost:3333/api/v1",
-    admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-) as sdk:
+) as outpost:
 
-    res = sdk.health.check()
+    res = outpost.health.check()
 
     # Handle response
     print(res)
@@ -453,17 +439,17 @@ 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 openapi import SDK
+from outpost_sdk import Outpost
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
-s = SDK(client=http_client)
+s = Outpost(client=http_client)
 ```
 
 or you could wrap the client with your own custom logic:
 ```python
-from openapi import SDK
-from openapi.httpclient import AsyncHttpClient
+from outpost_sdk import Outpost
+from outpost_sdk.httpclient import AsyncHttpClient
 import httpx
 
 class CustomClient(AsyncHttpClient):
@@ -521,33 +507,29 @@ class CustomClient(AsyncHttpClient):
             extensions=extensions,
         )
 
-s = SDK(async_client=CustomClient(httpx.AsyncClient()))
+s = Outpost(async_client=CustomClient(httpx.AsyncClient()))
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
 <!-- Start Resource Management [resource-management] -->
 ## Resource Management
 
-The `SDK` 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.
+The `Outpost` 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 openapi import SDK
+from outpost_sdk import Outpost
 def main():
 
-    with SDK(
-        admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-    ) as sdk:
+    with Outpost() as outpost:
         # Rest of application here...
 
 
 # Or when using async:
 async def amain():
 
-    async with SDK(
-        admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
-    ) as sdk:
+    async with Outpost() as outpost:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->
@@ -559,11 +541,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 openapi import SDK
+from outpost_sdk import Outpost
 import logging
 
 logging.basicConfig(level=logging.DEBUG)
-s = SDK(debug_logger=logging.getLogger("openapi"))
+s = Outpost(debug_logger=logging.getLogger("outpost_sdk"))
 ```
 <!-- End Debugging [debug] -->