# Outpost Python SDK
Developer-friendly & type-safe Python SDK specifically catered to leverage the Outpost API.
<div align="left">
<a href="https://www.speakeasy.com/?utm_source=outpost-github&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
<!-- Start Summary [summary] -->
## Summary
Outpost API: The Outpost API is a REST-based JSON API for managing tenants, destinations, and publishing events.
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [Outpost Python SDK](https://github.com/hookdeck/outpost/blob/master/#outpost-python-sdk)
* [SDK Installation](https://github.com/hookdeck/outpost/blob/master/#sdk-installation)
* [IDE Support](https://github.com/hookdeck/outpost/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/hookdeck/outpost/blob/master/#sdk-example-usage)
* [Authentication](https://github.com/hookdeck/outpost/blob/master/#authentication)
* [Available Resources and Operations](https://github.com/hookdeck/outpost/blob/master/#available-resources-and-operations)
* [Global Parameters](https://github.com/hookdeck/outpost/blob/master/#global-parameters)
* [Retries](https://github.com/hookdeck/outpost/blob/master/#retries)
* [Error Handling](https://github.com/hookdeck/outpost/blob/master/#error-handling)
* [Server Selection](https://github.com/hookdeck/outpost/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/hookdeck/outpost/blob/master/#custom-http-client)
* [Resource Management](https://github.com/hookdeck/outpost/blob/master/#resource-management)
* [Debugging](https://github.com/hookdeck/outpost/blob/master/#debugging)
* [Development](https://github.com/hookdeck/outpost/blob/master/#development)
* [Maturity](https://github.com/hookdeck/outpost/blob/master/#maturity)
* [Contributions](https://github.com/hookdeck/outpost/blob/master/#contributions)
<!-- End Table of Contents [toc] -->
<!-- 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
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
```bash
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 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 outpost_sdk 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 = [
# "outpost_sdk",
# ]
# ///
from outpost_sdk import Outpost
sdk = Outpost(
# 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] -->
## IDE Support
### PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from outpost_sdk import Outpost
with Outpost() as outpost:
res = outpost.health.check()
# Handle response
print(res)
```
</br>
The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from outpost_sdk import Outpost
async def main():
async with Outpost() as outpost:
res = await outpost.health.check_async()
# Handle response
print(res)
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
| --------------- | ---- | ----------- |
| `admin_api_key` | http | HTTP Bearer |
| `tenant_jwt` | http | HTTP Bearer |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```python
from outpost_sdk import Outpost, models
with Outpost(
security=models.Security(
admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
),
) as outpost:
res = outpost.health.check()
# Handle response
print(res)
```
<!-- End Authentication [security] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [destinations](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md)
* [list](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#list) - List Destinations
* [create](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#create) - Create Destination
* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#get) - Get Destination
* [update](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#update) - Update Destination
* [delete](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#delete) - Delete Destination
* [enable](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#enable) - Enable Destination
* [disable](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#disable) - Disable Destination
### [events](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md)
* [list](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#list) - List Events
* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#get) - Get Event
* [list_deliveries](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#list_deliveries) - List Event Delivery Attempts
* [list_by_destination](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#list_by_destination) - List Events by Destination
* [get_by_destination](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#get_by_destination) - Get Event by Destination
* [retry](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#retry) - Retry Event Delivery
### [health](https://github.com/hookdeck/outpost/blob/master/docs/sdks/health/README.md)
* [check](https://github.com/hookdeck/outpost/blob/master/docs/sdks/health/README.md#check) - Health Check
### [publish](https://github.com/hookdeck/outpost/blob/master/docs/sdks/publish/README.md)
* [event](https://github.com/hookdeck/outpost/blob/master/docs/sdks/publish/README.md#event) - Publish Event
### [schemas](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md)
* [list_tenant_destination_types](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#list_tenant_destination_types) - List Destination Type Schemas (for Tenant)
* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#get) - Get Destination Type Schema (for Tenant)
* [list_destination_types_jwt](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#list_destination_types_jwt) - List Destination Type Schemas (JWT Auth)
* [get_destination_type_jwt](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#get_destination_type_jwt) - Get Destination Type Schema
### [tenants](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md)
* [upsert](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#upsert) - Create or Update Tenant
* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#get) - Get Tenant
* [delete](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#delete) - Delete Tenant
* [get_portal_url](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#get_portal_url) - Get Portal Redirect URL
* [get_token](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#get_token) - Get Tenant JWT Token
### [topics](https://github.com/hookdeck/outpost/blob/master/docs/sdks/topicssdk/README.md)
* [list](https://github.com/hookdeck/outpost/blob/master/docs/sdks/topicssdk/README.md#list) - List Available Topics (for Tenant)
* [list_jwt](https://github.com/hookdeck/outpost/blob/master/docs/sdks/topicssdk/README.md#list_jwt) - List Available Topics)
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Global Parameters [global-parameters] -->
## Global Parameters
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `tenant_id` to `"<id>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `upsert`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals
The following global parameter is available.
| Name | Type | Description |
| --------- | ---- | ------------------------ |
| tenant_id | str | The tenant_id parameter. |
### Example
```python
from outpost_sdk import Outpost, models
with Outpost(
tenant_id="<id>",
security=models.Security(
admin_api_key="<YOUR_BEARER_TOKEN_HERE>",
),
) as outpost:
res = outpost.tenants.upsert()
# Handle response
print(res)
```
<!-- End Global Parameters [global-parameters] -->
<!-- Start Retries [retries] -->
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from outpost_sdk import Outpost
from outpost_sdk.utils import BackoffStrategy, RetryConfig
with Outpost() as outpost:
res = outpost.health.check(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle response
print(res)
```
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 outpost_sdk import Outpost
from outpost_sdk.utils import BackoffStrategy, RetryConfig
with Outpost(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as outpost:
res = outpost.health.check()
# Handle response
print(res)
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
[`OutpostError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/outposterror.py) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message` | `str` | Error message |
| `err.status_code` | `int` | HTTP response status code eg `404` |
| `err.headers` | `httpx.Headers` | HTTP response headers |
| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |
| `err.raw_response` | `httpx.Response` | Raw HTTP response |
| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/hookdeck/outpost/blob/master/#error-classes). |
### Example
```python
from outpost_sdk import Outpost, errors
with Outpost() as outpost:
res = None
try:
res = outpost.health.check()
# Handle response
print(res)
except errors.OutpostError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, errors.NotFoundError):
print(e.data.message) # Optional[str]
print(e.data.additional_properties) # Optional[Dict[str, Any]]
```
### Error Classes
**Primary errors:**
* [`OutpostError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/outposterror.py): The base class for HTTP error responses.
* [`BadRequestError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/badrequesterror.py): A collection of codes that generally means the end user got something wrong in making the request.
* [`UnauthorizedError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/unauthorizederror.py): A collection of codes that generally means the client was not authenticated correctly for the request they want to make.
* [`NotFoundError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/notfounderror.py): Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing.
* [`TimeoutErrorT`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/timeouterrort.py): Timeouts occurred with the request.
* [`RateLimitedError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/ratelimitederror.py): Status codes relating to the client being rate limited by the server. Status code `429`.
* [`InternalServerError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/internalservererror.py): A collection of status codes that generally mean the server failed in an unexpected way.
<details><summary>Less common errors (5)</summary>
<br />
**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
* [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
* [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
**Inherit from [`OutpostError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/outposterror.py)**:
* [`ResponseValidationError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
</details>
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Override Server URL Per-Client
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 outpost_sdk import Outpost
with Outpost(
server_url="http://localhost:3333/api/v1",
) as outpost:
res = outpost.health.check()
# Handle response
print(res)
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
For example, you could specify a header for every request that this sdk makes as follows:
```python
from outpost_sdk import Outpost
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Outpost(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from outpost_sdk import Outpost
from outpost_sdk.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Outpost(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Resource Management [resource-management] -->
## Resource Management
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 outpost_sdk import Outpost
def main():
with Outpost() as outpost:
# Rest of application here...
# Or when using async:
async def amain():
async with Outpost() as outpost:
# Rest of application here...
```
<!-- End Resource Management [resource-management] -->
<!-- Start Debugging [debug] -->
## Debugging
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 outpost_sdk import Outpost
import logging
logging.basicConfig(level=logging.DEBUG)
s = Outpost(debug_logger=logging.getLogger("outpost_sdk"))
```
<!-- End Debugging [debug] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python)
Raw data
{
"_id": null,
"home_page": "https://github.com/hookdeck/outpost.git",
"name": "outpost_sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.2",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/25/30/f4b46a1335f7854bd0ba7b128b84764a5511e85bd964a3277f235c23a49c/outpost_sdk-0.3.0.tar.gz",
"platform": null,
"description": "# Outpost Python SDK\n\nDeveloper-friendly & type-safe Python SDK specifically catered to leverage the Outpost API.\n\n<div align=\"left\">\n <a href=\"https://www.speakeasy.com/?utm_source=outpost-github&utm_campaign=python\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n<!-- Start Summary [summary] -->\n## Summary\n\nOutpost API: The Outpost API is a REST-based JSON API for managing tenants, destinations, and publishing events.\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [Outpost Python SDK](https://github.com/hookdeck/outpost/blob/master/#outpost-python-sdk)\n * [SDK Installation](https://github.com/hookdeck/outpost/blob/master/#sdk-installation)\n * [IDE Support](https://github.com/hookdeck/outpost/blob/master/#ide-support)\n * [SDK Example Usage](https://github.com/hookdeck/outpost/blob/master/#sdk-example-usage)\n * [Authentication](https://github.com/hookdeck/outpost/blob/master/#authentication)\n * [Available Resources and Operations](https://github.com/hookdeck/outpost/blob/master/#available-resources-and-operations)\n * [Global Parameters](https://github.com/hookdeck/outpost/blob/master/#global-parameters)\n * [Retries](https://github.com/hookdeck/outpost/blob/master/#retries)\n * [Error Handling](https://github.com/hookdeck/outpost/blob/master/#error-handling)\n * [Server Selection](https://github.com/hookdeck/outpost/blob/master/#server-selection)\n * [Custom HTTP Client](https://github.com/hookdeck/outpost/blob/master/#custom-http-client)\n * [Resource Management](https://github.com/hookdeck/outpost/blob/master/#resource-management)\n * [Debugging](https://github.com/hookdeck/outpost/blob/master/#debugging)\n* [Development](https://github.com/hookdeck/outpost/blob/master/#development)\n * [Maturity](https://github.com/hookdeck/outpost/blob/master/#maturity)\n * [Contributions](https://github.com/hookdeck/outpost/blob/master/#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!NOTE]\n> **Python version upgrade policy**\n>\n> 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.\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install outpost_sdk\n```\n\n### Poetry\n\n*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.\n\n```bash\npoetry add outpost_sdk\n```\n\n### Shell and script usage with `uv`\n\nYou 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:\n\n```shell\nuvx --from outpost_sdk python\n```\n\nIt's also possible to write a standalone Python script without needing to set up a whole project like so:\n\n```python\n#!/usr/bin/env -S uv run --script\n# /// script\n# requires-python = \">=3.9\"\n# dependencies = [\n# \"outpost_sdk\",\n# ]\n# ///\n\nfrom outpost_sdk import Outpost\n\nsdk = Outpost(\n # SDK arguments\n)\n\n# Rest of script here...\n```\n\nOnce that is saved to a file, you can run it with `uv run script.py` where\n`script.py` can be replaced with the actual file name.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom outpost_sdk import Outpost\n\n\nwith Outpost() as outpost:\n\n res = outpost.health.check()\n\n # Handle response\n print(res)\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom outpost_sdk import Outpost\n\nasync def main():\n\n async with Outpost() as outpost:\n\n res = await outpost.health.check_async()\n\n # Handle response\n print(res)\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security schemes globally:\n\n| Name | Type | Scheme |\n| --------------- | ---- | ----------- |\n| `admin_api_key` | http | HTTP Bearer |\n| `tenant_jwt` | http | HTTP Bearer |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:\n```python\nfrom outpost_sdk import Outpost, models\n\n\nwith Outpost(\n security=models.Security(\n admin_api_key=\"<YOUR_BEARER_TOKEN_HERE>\",\n ),\n) as outpost:\n\n res = outpost.health.check()\n\n # Handle response\n print(res)\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [destinations](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md)\n\n* [list](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#list) - List Destinations\n* [create](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#create) - Create Destination\n* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#get) - Get Destination\n* [update](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#update) - Update Destination\n* [delete](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#delete) - Delete Destination\n* [enable](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#enable) - Enable Destination\n* [disable](https://github.com/hookdeck/outpost/blob/master/docs/sdks/destinations/README.md#disable) - Disable Destination\n\n### [events](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md)\n\n* [list](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#list) - List Events\n* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#get) - Get Event\n* [list_deliveries](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#list_deliveries) - List Event Delivery Attempts\n* [list_by_destination](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#list_by_destination) - List Events by Destination\n* [get_by_destination](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#get_by_destination) - Get Event by Destination\n* [retry](https://github.com/hookdeck/outpost/blob/master/docs/sdks/events/README.md#retry) - Retry Event Delivery\n\n### [health](https://github.com/hookdeck/outpost/blob/master/docs/sdks/health/README.md)\n\n* [check](https://github.com/hookdeck/outpost/blob/master/docs/sdks/health/README.md#check) - Health Check\n\n\n### [publish](https://github.com/hookdeck/outpost/blob/master/docs/sdks/publish/README.md)\n\n* [event](https://github.com/hookdeck/outpost/blob/master/docs/sdks/publish/README.md#event) - Publish Event\n\n### [schemas](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md)\n\n* [list_tenant_destination_types](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#list_tenant_destination_types) - List Destination Type Schemas (for Tenant)\n* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#get) - Get Destination Type Schema (for Tenant)\n* [list_destination_types_jwt](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#list_destination_types_jwt) - List Destination Type Schemas (JWT Auth)\n* [get_destination_type_jwt](https://github.com/hookdeck/outpost/blob/master/docs/sdks/schemas/README.md#get_destination_type_jwt) - Get Destination Type Schema\n\n### [tenants](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md)\n\n* [upsert](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#upsert) - Create or Update Tenant\n* [get](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#get) - Get Tenant\n* [delete](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#delete) - Delete Tenant\n* [get_portal_url](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#get_portal_url) - Get Portal Redirect URL\n* [get_token](https://github.com/hookdeck/outpost/blob/master/docs/sdks/tenants/README.md#get_token) - Get Tenant JWT Token\n\n### [topics](https://github.com/hookdeck/outpost/blob/master/docs/sdks/topicssdk/README.md)\n\n* [list](https://github.com/hookdeck/outpost/blob/master/docs/sdks/topicssdk/README.md#list) - List Available Topics (for Tenant)\n* [list_jwt](https://github.com/hookdeck/outpost/blob/master/docs/sdks/topicssdk/README.md#list_jwt) - List Available Topics)\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Global Parameters [global-parameters] -->\n## Global Parameters\n\nA parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.\n\nFor example, you can set `tenant_id` to `\"<id>\"` at SDK initialization and then you do not have to pass the same value on calls to operations like `upsert`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.\n\n\n### Available Globals\n\nThe following global parameter is available.\n\n| Name | Type | Description |\n| --------- | ---- | ------------------------ |\n| tenant_id | str | The tenant_id parameter. |\n\n### Example\n\n```python\nfrom outpost_sdk import Outpost, models\n\n\nwith Outpost(\n tenant_id=\"<id>\",\n security=models.Security(\n admin_api_key=\"<YOUR_BEARER_TOKEN_HERE>\",\n ),\n) as outpost:\n\n res = outpost.tenants.upsert()\n\n # Handle response\n print(res)\n\n```\n<!-- End Global Parameters [global-parameters] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom outpost_sdk import Outpost\nfrom outpost_sdk.utils import BackoffStrategy, RetryConfig\n\n\nwith Outpost() as outpost:\n\n res = outpost.health.check(,\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n # Handle response\n print(res)\n\n```\n\nIf 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:\n```python\nfrom outpost_sdk import Outpost\nfrom outpost_sdk.utils import BackoffStrategy, RetryConfig\n\n\nwith Outpost(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n) as outpost:\n\n res = outpost.health.check()\n\n # Handle response\n print(res)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`OutpostError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/outposterror.py) is the base class for all HTTP error responses. It has the following properties:\n\n| Property | Type | Description |\n| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |\n| `err.message` | `str` | Error message |\n| `err.status_code` | `int` | HTTP response status code eg `404` |\n| `err.headers` | `httpx.Headers` | HTTP response headers |\n| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |\n| `err.raw_response` | `httpx.Response` | Raw HTTP response |\n| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/hookdeck/outpost/blob/master/#error-classes). |\n\n### Example\n```python\nfrom outpost_sdk import Outpost, errors\n\n\nwith Outpost() as outpost:\n res = None\n try:\n\n res = outpost.health.check()\n\n # Handle response\n print(res)\n\n\n except errors.OutpostError as e:\n # The base class for HTTP error responses\n print(e.message)\n print(e.status_code)\n print(e.body)\n print(e.headers)\n print(e.raw_response)\n\n # Depending on the method different errors may be thrown\n if isinstance(e, errors.NotFoundError):\n print(e.data.message) # Optional[str]\n print(e.data.additional_properties) # Optional[Dict[str, Any]]\n```\n\n### Error Classes\n**Primary errors:**\n* [`OutpostError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/outposterror.py): The base class for HTTP error responses.\n * [`BadRequestError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/badrequesterror.py): A collection of codes that generally means the end user got something wrong in making the request.\n * [`UnauthorizedError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/unauthorizederror.py): A collection of codes that generally means the client was not authenticated correctly for the request they want to make.\n * [`NotFoundError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/notfounderror.py): Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing.\n * [`TimeoutErrorT`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/timeouterrort.py): Timeouts occurred with the request.\n * [`RateLimitedError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/ratelimitederror.py): Status codes relating to the client being rate limited by the server. Status code `429`.\n * [`InternalServerError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/internalservererror.py): A collection of status codes that generally mean the server failed in an unexpected way.\n\n<details><summary>Less common errors (5)</summary>\n\n<br />\n\n**Network errors:**\n* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.\n * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.\n * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.\n\n\n**Inherit from [`OutpostError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/outposterror.py)**:\n* [`ResponseValidationError`](https://github.com/hookdeck/outpost/blob/master/./src/outpost_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.\n\n</details>\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom outpost_sdk import Outpost\n\n\nwith Outpost(\n server_url=\"http://localhost:3333/api/v1\",\n) as outpost:\n\n res = outpost.health.check()\n\n # Handle response\n print(res)\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom outpost_sdk import Outpost\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Outpost(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom outpost_sdk import Outpost\nfrom outpost_sdk.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = Outpost(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Resource Management [resource-management] -->\n## Resource Management\n\nThe `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.\n\n[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers\n\n```python\nfrom outpost_sdk import Outpost\ndef main():\n\n with Outpost() as outpost:\n # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n async with Outpost() as outpost:\n # Rest of application here...\n```\n<!-- End Resource Management [resource-management] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom outpost_sdk import Outpost\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Outpost(debug_logger=logging.getLogger(\"outpost_sdk\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. \nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi&utm_campaign=python)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/hookdeck/outpost.git",
"Repository": "https://github.com/hookdeck/outpost.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c0e7b5dd71740dbe7f41be491e264d2c0fb64973f3522bb0877f0deea86be50",
"md5": "2efbcac6d06a169fb9f4c1874c83d686",
"sha256": "c879d26d943cad9175714e5aa7c25db9c4dfce507113d42e257fb192f465bdcf"
},
"downloads": -1,
"filename": "outpost_sdk-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2efbcac6d06a169fb9f4c1874c83d686",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.2",
"size": 112522,
"upload_time": "2025-07-31T16:20:24",
"upload_time_iso_8601": "2025-07-31T16:20:24.099137Z",
"url": "https://files.pythonhosted.org/packages/0c/0e/7b5dd71740dbe7f41be491e264d2c0fb64973f3522bb0877f0deea86be50/outpost_sdk-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2530f4b46a1335f7854bd0ba7b128b84764a5511e85bd964a3277f235c23a49c",
"md5": "e0dca9e58ccea08aa336002a4e2693b3",
"sha256": "21011de3b70e350d27beab99fa51a74275d5a1e216b8c090204644239393afa2"
},
"downloads": -1,
"filename": "outpost_sdk-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "e0dca9e58ccea08aa336002a4e2693b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.2",
"size": 59350,
"upload_time": "2025-07-31T16:20:24",
"upload_time_iso_8601": "2025-07-31T16:20:24.981002Z",
"url": "https://files.pythonhosted.org/packages/25/30/f4b46a1335f7854bd0ba7b128b84764a5511e85bd964a3277f235c23a49c/outpost_sdk-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 16:20:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hookdeck",
"github_project": "outpost",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "outpost_sdk"
}
JSON
