| Name | bolt-api-sdk JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Python Client SDK Generated by Speakeasy. |
| upload_time | 2025-08-07 01:22:27 |
| maintainer | None |
| docs_url | None |
| author | Speakeasy |
| requires_python | >=3.9.2 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# bolt-api-sdk
Developer-friendly & type-safe Python SDK specifically catered to leverage *bolt-api-sdk* API.
<div align="left">
<a href="https://www.speakeasy.com/?utm_source=bolt-api-sdk&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>
<br /><br />
> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/bolt/boltpublicapi). Delete this section before > publishing to a package manager.
<!-- Start Summary [summary] -->
## Summary
Subscriptions API: API for managing subscriptions and products.
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [bolt-api-sdk](#bolt-api-sdk)
* [SDK Installation](#sdk-installation)
* [IDE Support](#ide-support)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Resource Management](#resource-management)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
<!-- End Table of Contents [toc] -->
<!-- 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**
>
> 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 git+<UNSET>.git
```
### 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
```
### 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 bolt-api-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 = [
# "bolt-api-sdk",
# ]
# ///
from bolt_api_sdk import Bolt
sdk = Bolt(
# 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 bolt_api_sdk import Bolt, models
import os
with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# 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 bolt_api_sdk import Bolt, models
import os
async def main():
async with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = await bolt.products.create_async(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# 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 | Environment Variable |
| ------------------- | ------ | ------- | ------------------------ |
| `x_api_key` | apiKey | API key | `BOLT_X_API_KEY` |
| `x_publishable_key` | apiKey | API key | `BOLT_X_PUBLISHABLE_KEY` |
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 bolt_api_sdk import Bolt, models
import os
with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# Handle response
print(res)
```
<!-- End Authentication [security] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [plans](docs/sdks/plans/README.md)
* [list](docs/sdks/plans/README.md#list) - Get all subscription plans available for a product
### [products](docs/sdks/products/README.md)
* [create](docs/sdks/products/README.md#create) - Create a product
* [list](docs/sdks/products/README.md#list) - Get all products
* [get](docs/sdks/products/README.md#get) - Get a product
### [subscription_orders](docs/sdks/subscriptionorders/README.md)
* [list](docs/sdks/subscriptionorders/README.md#list) - Get all subscription orders
### [subscriptions](docs/sdks/subscriptions/README.md)
* [pause](docs/sdks/subscriptions/README.md#pause) - Pause a subscription
* [unpause](docs/sdks/subscriptions/README.md#unpause) - Unpause a subscription
* [cancel](docs/sdks/subscriptions/README.md#cancel) - Cancel a subscription
* [get](docs/sdks/subscriptions/README.md#get) - Get a subscription
* [list](docs/sdks/subscriptions/README.md#list) - Get all subscriptions
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- 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 bolt_api_sdk import Bolt, models
from bolt_api_sdk.utils import BackoffStrategy, RetryConfig
import os
with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
],
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 bolt_api_sdk import Bolt, models
from bolt_api_sdk.utils import BackoffStrategy, RetryConfig
import os
with Bolt(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# Handle response
print(res)
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
[`BoltError`](./src/bolt_api_sdk/errors/bolterror.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 |
### Example
```python
from bolt_api_sdk import Bolt, errors, models
import os
with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = None
try:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# Handle response
print(res)
except errors.BoltError 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)
```
### Error Classes
**Primary error:**
* [`BoltError`](./src/bolt_api_sdk/errors/bolterror.py): The base class for HTTP error responses.
<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 [`BoltError`](./src/bolt_api_sdk/errors/bolterror.py)**:
* [`ResponseValidationError`](./src/bolt_api_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
### Select Server by Index
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Description |
| --- | ------------------------------ | ------------------------------- |
| 0 | `https://api.bolt.com` | The Production URL (Live Data). |
| 1 | `https://api-sandbox.bolt.com` | The Sandbox URL (Test Data). |
| 2 | `https://api-staging.bolt.com` | The Staging URL (Staged Data). |
#### Example
```python
from bolt_api_sdk import Bolt, models
import os
with Bolt(
server_idx=2,
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# Handle response
print(res)
```
### 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:
```python
from bolt_api_sdk import Bolt, models
import os
with Bolt(
server_url="https://api-staging.bolt.com",
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
res = bolt.products.create(name="Bolt Subscription Product", description="This is a subscription product.", brand="Bolt", sku="BOLT-12345", unit_price=1999, plans=[
{
"sku": "BOLT-PLAN-12345",
"name": "Monthly Subscription",
"frequency": 1,
"frequency_unit": models.CreateProductFrequencyUnit.MONTH_LOWER,
},
], images=[
"https://example.com/image1.jpg",
"https://example.com/image2.jpg",
])
# 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 bolt_api_sdk import Bolt
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Bolt(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from bolt_api_sdk import Bolt
from bolt_api_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 = Bolt(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Resource Management [resource-management] -->
## Resource Management
The `Bolt` 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 bolt_api_sdk import Bolt, models
import os
def main():
with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
# Rest of application here...
# Or when using async:
async def amain():
async with Bolt(
security=models.Security(
x_api_key=os.getenv("BOLT_X_API_KEY", ""),
),
) as bolt:
# 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 bolt_api_sdk import Bolt
import logging
logging.basicConfig(level=logging.DEBUG)
s = Bolt(debug_logger=logging.getLogger("bolt_api_sdk"))
```
You can also enable a default debug logger by setting an environment variable `BOLT_DEBUG` to true.
<!-- 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=bolt-api-sdk&utm_campaign=python)
Raw data
{
"_id": null,
"home_page": null,
"name": "bolt-api-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/ab/3e/19eb7510c64cad6eef5634790fbae465ebe8671a2d1fe66fa9f5ae3f2945/bolt_api_sdk-0.3.0.tar.gz",
"platform": null,
"description": "# bolt-api-sdk\n\nDeveloper-friendly & type-safe Python SDK specifically catered to leverage *bolt-api-sdk* API.\n\n<div align=\"left\">\n <a href=\"https://www.speakeasy.com/?utm_source=bolt-api-sdk&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\n<br /><br />\n> [!IMPORTANT]\n> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/bolt/boltpublicapi). Delete this section before > publishing to a package manager.\n\n<!-- Start Summary [summary] -->\n## Summary\n\nSubscriptions API: API for managing subscriptions and products.\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [bolt-api-sdk](#bolt-api-sdk)\n * [SDK Installation](#sdk-installation)\n * [IDE Support](#ide-support)\n * [SDK Example Usage](#sdk-example-usage)\n * [Authentication](#authentication)\n * [Available Resources and Operations](#available-resources-and-operations)\n * [Retries](#retries)\n * [Error Handling](#error-handling)\n * [Server Selection](#server-selection)\n * [Custom HTTP Client](#custom-http-client)\n * [Resource Management](#resource-management)\n * [Debugging](#debugging)\n* [Development](#development)\n * [Maturity](#maturity)\n * [Contributions](#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!TIP]\n> 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).\n\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 git+<UNSET>.git\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 git+<UNSET>.git\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 bolt-api-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# \"bolt-api-sdk\",\n# ]\n# ///\n\nfrom bolt_api_sdk import Bolt\n\nsdk = Bolt(\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 bolt_api_sdk import Bolt, models\nimport os\n\n\nwith Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\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 bolt_api_sdk import Bolt, models\nimport os\n\nasync def main():\n\n async with Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n ) as bolt:\n\n res = await bolt.products.create_async(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\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 | Environment Variable |\n| ------------------- | ------ | ------- | ------------------------ |\n| `x_api_key` | apiKey | API key | `BOLT_X_API_KEY` |\n| `x_publishable_key` | apiKey | API key | `BOLT_X_PUBLISHABLE_KEY` |\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 bolt_api_sdk import Bolt, models\nimport os\n\n\nwith Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\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\n### [plans](docs/sdks/plans/README.md)\n\n* [list](docs/sdks/plans/README.md#list) - Get all subscription plans available for a product\n\n### [products](docs/sdks/products/README.md)\n\n* [create](docs/sdks/products/README.md#create) - Create a product\n* [list](docs/sdks/products/README.md#list) - Get all products\n* [get](docs/sdks/products/README.md#get) - Get a product\n\n### [subscription_orders](docs/sdks/subscriptionorders/README.md)\n\n* [list](docs/sdks/subscriptionorders/README.md#list) - Get all subscription orders\n\n### [subscriptions](docs/sdks/subscriptions/README.md)\n\n* [pause](docs/sdks/subscriptions/README.md#pause) - Pause a subscription\n* [unpause](docs/sdks/subscriptions/README.md#unpause) - Unpause a subscription\n* [cancel](docs/sdks/subscriptions/README.md#cancel) - Cancel a subscription\n* [get](docs/sdks/subscriptions/README.md#get) - Get a subscription\n* [list](docs/sdks/subscriptions/README.md#list) - Get all subscriptions\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\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 bolt_api_sdk import Bolt, models\nfrom bolt_api_sdk.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ],\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 bolt_api_sdk import Bolt, models\nfrom bolt_api_sdk.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith Bolt(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\n\n # Handle response\n print(res)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`BoltError`](./src/bolt_api_sdk/errors/bolterror.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\n### Example\n```python\nfrom bolt_api_sdk import Bolt, errors, models\nimport os\n\n\nwith Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n res = None\n try:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\n\n # Handle response\n print(res)\n\n\n except errors.BoltError 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```\n\n### Error Classes\n**Primary error:**\n* [`BoltError`](./src/bolt_api_sdk/errors/bolterror.py): The base class for HTTP error responses.\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 [`BoltError`](./src/bolt_api_sdk/errors/bolterror.py)**:\n* [`ResponseValidationError`](./src/bolt_api_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### Select Server by Index\n\nYou can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:\n\n| # | Server | Description |\n| --- | ------------------------------ | ------------------------------- |\n| 0 | `https://api.bolt.com` | The Production URL (Live Data). |\n| 1 | `https://api-sandbox.bolt.com` | The Sandbox URL (Test Data). |\n| 2 | `https://api-staging.bolt.com` | The Staging URL (Staged Data). |\n\n#### Example\n\n```python\nfrom bolt_api_sdk import Bolt, models\nimport os\n\n\nwith Bolt(\n server_idx=2,\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\n\n # Handle response\n print(res)\n\n```\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom bolt_api_sdk import Bolt, models\nimport os\n\n\nwith Bolt(\n server_url=\"https://api-staging.bolt.com\",\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n) as bolt:\n\n res = bolt.products.create(name=\"Bolt Subscription Product\", description=\"This is a subscription product.\", brand=\"Bolt\", sku=\"BOLT-12345\", unit_price=1999, plans=[\n {\n \"sku\": \"BOLT-PLAN-12345\",\n \"name\": \"Monthly Subscription\",\n \"frequency\": 1,\n \"frequency_unit\": models.CreateProductFrequencyUnit.MONTH_LOWER,\n },\n ], images=[\n \"https://example.com/image1.jpg\",\n \"https://example.com/image2.jpg\",\n ])\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 bolt_api_sdk import Bolt\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Bolt(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom bolt_api_sdk import Bolt\nfrom bolt_api_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 = Bolt(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 `Bolt` 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 bolt_api_sdk import Bolt, models\nimport os\ndef main():\n\n with Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n ) as bolt:\n # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n async with Bolt(\n security=models.Security(\n x_api_key=os.getenv(\"BOLT_X_API_KEY\", \"\"),\n ),\n ) as bolt:\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 bolt_api_sdk import Bolt\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Bolt(debug_logger=logging.getLogger(\"bolt_api_sdk\"))\n```\n\nYou can also enable a default debug logger by setting an environment variable `BOLT_DEBUG` to true.\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=bolt-api-sdk&utm_campaign=python)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c3ae6aede0b7633b585aa86b4270ca739df08db26195b1636d7cc405ea3b862e",
"md5": "6739cc05132ad7b87da673213581181f",
"sha256": "928a2b233ed21d280d22d5436c26f51779fd2b830b16607f7a660c6856699303"
},
"downloads": -1,
"filename": "bolt_api_sdk-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6739cc05132ad7b87da673213581181f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.2",
"size": 58738,
"upload_time": "2025-08-07T01:22:26",
"upload_time_iso_8601": "2025-08-07T01:22:26.740952Z",
"url": "https://files.pythonhosted.org/packages/c3/ae/6aede0b7633b585aa86b4270ca739df08db26195b1636d7cc405ea3b862e/bolt_api_sdk-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ab3e19eb7510c64cad6eef5634790fbae465ebe8671a2d1fe66fa9f5ae3f2945",
"md5": "3d8c67ac0ca3929415c7cfdbf4a44a26",
"sha256": "d64972ae5181f739d792ea82195b2bcf9589aaf46765fa49eb9e95316881b115"
},
"downloads": -1,
"filename": "bolt_api_sdk-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "3d8c67ac0ca3929415c7cfdbf4a44a26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.2",
"size": 39403,
"upload_time": "2025-08-07T01:22:27",
"upload_time_iso_8601": "2025-08-07T01:22:27.884607Z",
"url": "https://files.pythonhosted.org/packages/ab/3e/19eb7510c64cad6eef5634790fbae465ebe8671a2d1fe66fa9f5ae3f2945/bolt_api_sdk-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 01:22:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bolt-api-sdk"
}
