dub 0.0.14

Python Client SDK Generated by Speakeasy

Dub.co Python SDK

Learn more about the Dub.co Python SDK in the official documentation.

SDK Installation

pip install dub

SDK Example Usage

Example 1

import dub
from dub.models import operations

s = dub.Dub(
    token="DUB_API_KEY",
)


res = s.links.create(request=operations.CreateLinkRequestBody(
    url='https://google/com',
    external_id='123456',
    tag_ids=[
        'clux0rgak00011...',
    ],
))

if res.link_schema is not None:
    # handle response
    pass

Example 2

import dub
from dub.models import operations

s = dub.Dub(
    token="DUB_API_KEY",
)


res = s.links.upsert(request=operations.UpsertLinkRequestBody(
    url='https://google/com',
    external_id='123456',
    tag_ids=[
        'clux0rgak00011...',
    ],
))

if res.link_schema is not None:
    # handle response
    pass

Available Resources and Operations

links

• list - Retrieve a list of links
• create - Create a new link
• count - Retrieve the number of links
• get - Retrieve a link
• delete - Delete a link
• update - Update a link
• create_many - Bulk create links
• upsert - Upsert a link

qr_codes

• get - Retrieve a QR code

analytics

• retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.

workspaces

• list - Retrieve a list of workspaces
• create - Create a workspace
• get - Retrieve a workspace

tags

• list - Retrieve a list of tags
• create - Create a new tag

domains

• list - Retrieve a list of domains
• create - Create a domain
• delete - Delete a domain
• update - Update a domain
• set_primary - Set a domain as primary
• transfer - Transfer a domain

track

• lead - Track a lead
• sale - Track a sale
• customer - Track a customer

metatags

• get - Retrieve the metatags for a URL

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object	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

import dub
from dub.models import errors, operations

s = dub.Dub(
    token="DUB_API_KEY",
)

res = None
try:
    res = s.links.list(request=operations.GetLinksRequest())

except errors.BadRequest as e:
    # handle exception
    raise(e)
except errors.Unauthorized as e:
    # handle exception
    raise(e)
except errors.Forbidden as e:
    # handle exception
    raise(e)
except errors.NotFound as e:
    # handle exception
    raise(e)
except errors.Conflict as e:
    # handle exception
    raise(e)
except errors.InviteExpired as e:
    # handle exception
    raise(e)
except errors.UnprocessableEntity as e:
    # handle exception
    raise(e)
except errors.RateLimitExceeded as e:
    # handle exception
    raise(e)
except errors.InternalServerError as e:
    # handle exception
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

if res.link_schemas is not None:
    # handle response
    pass

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	Variables
0	https://api.dub.co	None

Example

import dub
from dub.models import operations

s = dub.Dub(
    server_idx=0,
    token="DUB_API_KEY",
)


res = s.links.list(request=operations.GetLinksRequest())

if res.link_schemas is not None:
    # handle response
    pass

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:

import dub
from dub.models import operations

s = dub.Dub(
    server_url="https://api.dub.co",
    token="DUB_API_KEY",
)


res = s.links.list(request=operations.GetLinksRequest())

if res.link_schemas is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the requests 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 a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import dub
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = dub.Dub(client=http_client)

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:

import dub
from dub.models import operations

s = dub.Dub(
    token="DUB_API_KEY",
)


res = s.links.list(request=operations.GetLinksRequest())

if res.link_schemas is not None:
    # handle response
    pass

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. 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