<div align="center">
<img src="https://github.com/dubinc/dub/assets/28986134/3815d859-afaa-48f9-a9b3-c09964e4d404" alt="Dub.co Python SDK to interact with APIs.">
<h3>Dub.co Python SDK</h3>
<a href="https://speakeasyapi.dev/"><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/>
Learn more about the Dub.co Python SDK in the [official documentation](https://dub.co/docs/sdks/python/overview).
<!-- Start Summary [summary] -->
## Summary
Dub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [SDK Installation](https://github.com/dubinc/dub-python/blob/master/#sdk-installation)
* [SDK Example Usage](https://github.com/dubinc/dub-python/blob/master/#sdk-example-usage)
* [Available Resources and Operations](https://github.com/dubinc/dub-python/blob/master/#available-resources-and-operations)
* [Error Handling](https://github.com/dubinc/dub-python/blob/master/#error-handling)
* [Server Selection](https://github.com/dubinc/dub-python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/dubinc/dub-python/blob/master/#custom-http-client)
* [Authentication](https://github.com/dubinc/dub-python/blob/master/#authentication)
* [Retries](https://github.com/dubinc/dub-python/blob/master/#retries)
* [Pagination](https://github.com/dubinc/dub-python/blob/master/#pagination)
* [Debugging](https://github.com/dubinc/dub-python/blob/master/#debugging)
* [IDE Support](https://github.com/dubinc/dub-python/blob/master/#ide-support)
* [Development](https://github.com/dubinc/dub-python/blob/master/#development)
* [Contributions](https://github.com/dubinc/dub-python/blob/master/#contributions)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
## SDK Installation
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 dub
```
### 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 dub
```
<!-- End SDK Installation [installation] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example 1
```python
# Synchronous Example
from dub import Dub
with Dub(
token="DUB_API_KEY",
) as dub:
res = dub.links.create(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# 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 dub import Dub
async def main():
async with Dub(
token="DUB_API_KEY",
) as dub:
res = await dub.links.create_async(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# Handle response
print(res)
asyncio.run(main())
```
### Example 2
```python
# Synchronous Example
from dub import Dub
with Dub(
token="DUB_API_KEY",
) as dub:
res = dub.links.upsert(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# 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 dub import Dub
async def main():
async with Dub(
token="DUB_API_KEY",
) as dub:
res = await dub.links.upsert_async(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# Handle response
print(res)
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [analytics](https://github.com/dubinc/dub-python/blob/master/docs/sdks/analytics/README.md)
* [retrieve](https://github.com/dubinc/dub-python/blob/master/docs/sdks/analytics/README.md#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
### [customers](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md)
* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#list) - Retrieve a list of customers
* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#create) - Create a customer
* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#get) - Retrieve a customer
* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#update) - Update a customer
* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#delete) - Delete a customer
### [domains](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md)
* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#create) - Create a domain
* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#list) - Retrieve a list of domains
* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#update) - Update a domain
* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#delete) - Delete a domain
### [embed_tokens](https://github.com/dubinc/dub-python/blob/master/docs/sdks/embedtokens/README.md)
* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/embedtokens/README.md#create) - Create a new embed token
### [events](https://github.com/dubinc/dub-python/blob/master/docs/sdks/events/README.md)
* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/events/README.md#list) - Retrieve a list of events
### [links](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md)
* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#create) - Create a new link
* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#list) - Retrieve a list of links
* [count](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#count) - Retrieve links count
* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#get) - Retrieve a link
* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#update) - Update a link
* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#delete) - Delete a link
* [create_many](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#create_many) - Bulk create links
* [update_many](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#update_many) - Bulk update links
* [delete_many](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#delete_many) - Bulk delete links
* [upsert](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#upsert) - Upsert a link
### [metatags](https://github.com/dubinc/dub-python/blob/master/docs/sdks/metatags/README.md)
* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/metatags/README.md#get) - Retrieve the metatags for a URL
### [qr_codes](https://github.com/dubinc/dub-python/blob/master/docs/sdks/qrcodes/README.md)
* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/qrcodes/README.md#get) - Retrieve a QR code
### [tags](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md)
* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#create) - Create a new tag
* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#list) - Retrieve a list of tags
* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#update) - Update a tag
* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#delete) - Delete a tag
### [track](https://github.com/dubinc/dub-python/blob/master/docs/sdks/track/README.md)
* [lead](https://github.com/dubinc/dub-python/blob/master/docs/sdks/track/README.md#lead) - Track a lead
* [sale](https://github.com/dubinc/dub-python/blob/master/docs/sdks/track/README.md#sale) - Track a sale
### [workspaces](https://github.com/dubinc/dub-python/blob/master/docs/sdks/workspaces/README.md)
* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/workspaces/README.md#get) - Retrieve a workspace
* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/workspaces/README.md#update) - Update a workspace
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] -->
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a errors.SDKError exception, which has the following properties:
| Property | Type | Description |
|-----------------|------------------|-----------------------|
| `.status_code` | *int* | The HTTP status code |
| `.message` | *str* | The error message |
| `.raw_response` | *httpx.Response* | The raw HTTP response |
| `.body` | *str* | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:
| Error Type | Status Code | Content Type |
| -------------------------- | ----------- | ---------------- |
| errors.BadRequest | 400 | application/json |
| errors.Unauthorized | 401 | application/json |
| errors.Forbidden | 403 | application/json |
| errors.NotFound | 404 | application/json |
| errors.Conflict | 409 | application/json |
| errors.InviteExpired | 410 | application/json |
| errors.UnprocessableEntity | 422 | application/json |
| errors.RateLimitExceeded | 429 | application/json |
| errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
### Example
```python
from dub import Dub
from dub.models import errors
with Dub(
token="DUB_API_KEY",
) as dub:
res = None
try:
res = dub.links.create(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# Handle response
print(res)
except errors.BadRequest as e:
# handle e.data: errors.BadRequestData
raise(e)
except errors.Unauthorized as e:
# handle e.data: errors.UnauthorizedData
raise(e)
except errors.Forbidden as e:
# handle e.data: errors.ForbiddenData
raise(e)
except errors.NotFound as e:
# handle e.data: errors.NotFoundData
raise(e)
except errors.Conflict as e:
# handle e.data: errors.ConflictData
raise(e)
except errors.InviteExpired as e:
# handle e.data: errors.InviteExpiredData
raise(e)
except errors.UnprocessableEntity as e:
# handle e.data: errors.UnprocessableEntityData
raise(e)
except errors.RateLimitExceeded as e:
# handle e.data: errors.RateLimitExceededData
raise(e)
except errors.InternalServerError as e:
# handle e.data: errors.InternalServerErrorData
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### 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 dub import Dub
with Dub(
server_url="https://api.dub.co",
token="DUB_API_KEY",
) as dub:
res = dub.links.create(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# 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 dub import Dub
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Dub(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from dub import Dub
from dub.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 = Dub(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------- | ---- | ----------- |
| `token` | http | HTTP Bearer |
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
```python
from dub import Dub
with Dub(
token="DUB_API_KEY",
) as dub:
res = dub.links.create(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# Handle response
print(res)
```
<!-- End Authentication [security] -->
<!-- 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 dub import Dub
from dub.utils import BackoffStrategy, RetryConfig
with Dub(
token="DUB_API_KEY",
) as dub:
res = dub.links.create(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
},
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
assert res is not None
# 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 dub import Dub
from dub.utils import BackoffStrategy, RetryConfig
with Dub(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
token="DUB_API_KEY",
) as dub:
res = dub.links.create(request={
"url": "https://google.com",
"external_id": "123456",
"tag_ids": [
"clux0rgak00011...",
],
})
assert res is not None
# Handle response
print(res)
```
<!-- End Retries [retries] -->
<!-- Start Pagination [pagination] -->
## Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.
Here's an example of one such pagination call:
```python
from dub import Dub
with Dub(
token="DUB_API_KEY",
) as dub:
res = dub.links.list(request={
"page": 1,
"page_size": 50,
})
while res is not None:
# Handle items
res = res.next()
```
<!-- End Pagination [pagination] -->
<!-- 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 dub import Dub
import logging
logging.basicConfig(level=logging.DEBUG)
s = Dub(debug_logger=logging.getLogger("dub"))
```
<!-- End Debugging [debug] -->
<!-- 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] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
Raw data
{
"_id": null,
"home_page": "https://github.com/dubinc/dub-python.git",
"name": "dub",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a9/88/92105e4223ba405c0ed6f99d6144251f01943320d32ce7aea5d57055dd4f/dub-0.16.4.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://github.com/dubinc/dub/assets/28986134/3815d859-afaa-48f9-a9b3-c09964e4d404\" alt=\"Dub.co Python SDK to interact with APIs.\">\n <h3>Dub.co Python SDK</h3>\n <a href=\"https://speakeasyapi.dev/\"><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<br/>\n\nLearn more about the Dub.co Python SDK in the [official documentation](https://dub.co/docs/sdks/python/overview).\n\n<!-- Start Summary [summary] -->\n## Summary\n\nDub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n * [SDK Installation](https://github.com/dubinc/dub-python/blob/master/#sdk-installation)\n * [SDK Example Usage](https://github.com/dubinc/dub-python/blob/master/#sdk-example-usage)\n * [Available Resources and Operations](https://github.com/dubinc/dub-python/blob/master/#available-resources-and-operations)\n * [Error Handling](https://github.com/dubinc/dub-python/blob/master/#error-handling)\n * [Server Selection](https://github.com/dubinc/dub-python/blob/master/#server-selection)\n * [Custom HTTP Client](https://github.com/dubinc/dub-python/blob/master/#custom-http-client)\n * [Authentication](https://github.com/dubinc/dub-python/blob/master/#authentication)\n * [Retries](https://github.com/dubinc/dub-python/blob/master/#retries)\n * [Pagination](https://github.com/dubinc/dub-python/blob/master/#pagination)\n * [Debugging](https://github.com/dubinc/dub-python/blob/master/#debugging)\n * [IDE Support](https://github.com/dubinc/dub-python/blob/master/#ide-support)\n* [Development](https://github.com/dubinc/dub-python/blob/master/#development)\n * [Contributions](https://github.com/dubinc/dub-python/blob/master/#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\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 dub\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 dub\n```\n<!-- End SDK Installation [installation] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example 1\n\n```python\n# Synchronous Example\nfrom dub import Dub\n\nwith Dub(\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.create(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\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 dub import Dub\n\nasync def main():\n async with Dub(\n token=\"DUB_API_KEY\",\n ) as dub:\n\n res = await dub.links.create_async(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\n\n # Handle response\n print(res)\n\nasyncio.run(main())\n```\n\n### Example 2\n\n```python\n# Synchronous Example\nfrom dub import Dub\n\nwith Dub(\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.upsert(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\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 dub import Dub\n\nasync def main():\n async with Dub(\n token=\"DUB_API_KEY\",\n ) as dub:\n\n res = await dub.links.upsert_async(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\n\n # Handle response\n print(res)\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [analytics](https://github.com/dubinc/dub-python/blob/master/docs/sdks/analytics/README.md)\n\n* [retrieve](https://github.com/dubinc/dub-python/blob/master/docs/sdks/analytics/README.md#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.\n\n### [customers](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md)\n\n* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#list) - Retrieve a list of customers\n* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#create) - Create a customer\n* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#get) - Retrieve a customer\n* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#update) - Update a customer\n* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/customers/README.md#delete) - Delete a customer\n\n### [domains](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md)\n\n* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#create) - Create a domain\n* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#list) - Retrieve a list of domains\n* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#update) - Update a domain\n* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/domains/README.md#delete) - Delete a domain\n\n\n### [embed_tokens](https://github.com/dubinc/dub-python/blob/master/docs/sdks/embedtokens/README.md)\n\n* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/embedtokens/README.md#create) - Create a new embed token\n\n### [events](https://github.com/dubinc/dub-python/blob/master/docs/sdks/events/README.md)\n\n* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/events/README.md#list) - Retrieve a list of events\n\n### [links](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md)\n\n* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#create) - Create a new link\n* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#list) - Retrieve a list of links\n* [count](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#count) - Retrieve links count\n* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#get) - Retrieve a link\n* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#update) - Update a link\n* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#delete) - Delete a link\n* [create_many](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#create_many) - Bulk create links\n* [update_many](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#update_many) - Bulk update links\n* [delete_many](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#delete_many) - Bulk delete links\n* [upsert](https://github.com/dubinc/dub-python/blob/master/docs/sdks/links/README.md#upsert) - Upsert a link\n\n### [metatags](https://github.com/dubinc/dub-python/blob/master/docs/sdks/metatags/README.md)\n\n* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/metatags/README.md#get) - Retrieve the metatags for a URL\n\n### [qr_codes](https://github.com/dubinc/dub-python/blob/master/docs/sdks/qrcodes/README.md)\n\n* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/qrcodes/README.md#get) - Retrieve a QR code\n\n### [tags](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md)\n\n* [create](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#create) - Create a new tag\n* [list](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#list) - Retrieve a list of tags\n* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#update) - Update a tag\n* [delete](https://github.com/dubinc/dub-python/blob/master/docs/sdks/tags/README.md#delete) - Delete a tag\n\n### [track](https://github.com/dubinc/dub-python/blob/master/docs/sdks/track/README.md)\n\n* [lead](https://github.com/dubinc/dub-python/blob/master/docs/sdks/track/README.md#lead) - Track a lead\n* [sale](https://github.com/dubinc/dub-python/blob/master/docs/sdks/track/README.md#sale) - Track a sale\n\n### [workspaces](https://github.com/dubinc/dub-python/blob/master/docs/sdks/workspaces/README.md)\n\n* [get](https://github.com/dubinc/dub-python/blob/master/docs/sdks/workspaces/README.md#get) - Retrieve a workspace\n* [update](https://github.com/dubinc/dub-python/blob/master/docs/sdks/workspaces/README.md#update) - Update a workspace\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.\n\nBy default, an API error will raise a errors.SDKError exception, which has the following properties:\n\n| Property | Type | Description |\n|-----------------|------------------|-----------------------|\n| `.status_code` | *int* | The HTTP status code |\n| `.message` | *str* | The error message |\n| `.raw_response` | *httpx.Response* | The raw HTTP response |\n| `.body` | *str* | The response content |\n\nWhen custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:\n\n| Error Type | Status Code | Content Type |\n| -------------------------- | ----------- | ---------------- |\n| errors.BadRequest | 400 | application/json |\n| errors.Unauthorized | 401 | application/json |\n| errors.Forbidden | 403 | application/json |\n| errors.NotFound | 404 | application/json |\n| errors.Conflict | 409 | application/json |\n| errors.InviteExpired | 410 | application/json |\n| errors.UnprocessableEntity | 422 | application/json |\n| errors.RateLimitExceeded | 429 | application/json |\n| errors.InternalServerError | 500 | application/json |\n| errors.SDKError | 4XX, 5XX | \\*/\\* |\n\n### Example\n\n```python\nfrom dub import Dub\nfrom dub.models import errors\n\nwith Dub(\n token=\"DUB_API_KEY\",\n) as dub:\n res = None\n try:\n\n res = dub.links.create(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\n\n # Handle response\n print(res)\n\n except errors.BadRequest as e:\n # handle e.data: errors.BadRequestData\n raise(e)\n except errors.Unauthorized as e:\n # handle e.data: errors.UnauthorizedData\n raise(e)\n except errors.Forbidden as e:\n # handle e.data: errors.ForbiddenData\n raise(e)\n except errors.NotFound as e:\n # handle e.data: errors.NotFoundData\n raise(e)\n except errors.Conflict as e:\n # handle e.data: errors.ConflictData\n raise(e)\n except errors.InviteExpired as e:\n # handle e.data: errors.InviteExpiredData\n raise(e)\n except errors.UnprocessableEntity as e:\n # handle e.data: errors.UnprocessableEntityData\n raise(e)\n except errors.RateLimitExceeded as e:\n # handle e.data: errors.RateLimitExceededData\n raise(e)\n except errors.InternalServerError as e:\n # handle e.data: errors.InternalServerErrorData\n raise(e)\n except errors.SDKError as e:\n # handle exception\n raise(e)\n```\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 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 dub import Dub\n\nwith Dub(\n server_url=\"https://api.dub.co\",\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.create(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\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 dub import Dub\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Dub(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom dub import Dub\nfrom dub.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 = Dub(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------- | ---- | ----------- |\n| `token` | http | HTTP Bearer |\n\nTo authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:\n```python\nfrom dub import Dub\n\nwith Dub(\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.create(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\n\n # Handle response\n print(res)\n\n```\n<!-- End Authentication [security] -->\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 dub import Dub\nfrom dub.utils import BackoffStrategy, RetryConfig\n\nwith Dub(\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.create(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n },\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n assert res is not None\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 dub import Dub\nfrom dub.utils import BackoffStrategy, RetryConfig\n\nwith Dub(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.create(request={\n \"url\": \"https://google.com\",\n \"external_id\": \"123456\",\n \"tag_ids\": [\n \"clux0rgak00011...\",\n ],\n })\n\n assert res is not None\n\n # Handle response\n print(res)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Pagination [pagination] -->\n## Pagination\n\nSome of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the\nreturned response object will have a `Next` method that can be called to pull down the next group of results. If the\nreturn value of `Next` is `None`, then there are no more pages to be fetched.\n\nHere's an example of one such pagination call:\n```python\nfrom dub import Dub\n\nwith Dub(\n token=\"DUB_API_KEY\",\n) as dub:\n\n res = dub.links.list(request={\n \"page\": 1,\n \"page_size\": 50,\n })\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n<!-- End Pagination [pagination] -->\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 dub import Dub\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Dub(debug_logger=logging.getLogger(\"dub\"))\n```\n<!-- End Debugging [debug] -->\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<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy",
"version": "0.16.4",
"project_urls": {
"Homepage": "https://github.com/dubinc/dub-python.git",
"Repository": "https://github.com/dubinc/dub-python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c7bfb9c890f0d49cbc2bfecb858048393da7caeebb2871722c3d81694cc546b",
"md5": "2f2c03cd40b50ddf5bb2bc34df1a3026",
"sha256": "1cdb6973a879c98ed1796b0c029d0d43fc5326b4aabc6267c3db0ce5f7d24a3c"
},
"downloads": -1,
"filename": "dub-0.16.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f2c03cd40b50ddf5bb2bc34df1a3026",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 177750,
"upload_time": "2025-01-06T04:32:06",
"upload_time_iso_8601": "2025-01-06T04:32:06.341102Z",
"url": "https://files.pythonhosted.org/packages/6c/7b/fb9c890f0d49cbc2bfecb858048393da7caeebb2871722c3d81694cc546b/dub-0.16.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a98892105e4223ba405c0ed6f99d6144251f01943320d32ce7aea5d57055dd4f",
"md5": "d58baef937127ce9705d0b9adac6fda8",
"sha256": "1b990c9ade72e43c1811a72c2097ccb7483149258323fa57a90354fbc360b353"
},
"downloads": -1,
"filename": "dub-0.16.4.tar.gz",
"has_sig": false,
"md5_digest": "d58baef937127ce9705d0b9adac6fda8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 114666,
"upload_time": "2025-01-06T04:32:08",
"upload_time_iso_8601": "2025-01-06T04:32:08.692283Z",
"url": "https://files.pythonhosted.org/packages/a9/88/92105e4223ba405c0ed6f99d6144251f01943320d32ce7aea5d57055dd4f/dub-0.16.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 04:32:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dubinc",
"github_project": "dub-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dub"
}
JSON
