Configuration

class Client(base_url, *, raise_on_unexpected_status=False, cookies=NOTHING, headers=NOTHING, timeout=None, verify_ssl=True, follow_redirects=False, httpx_args=NOTHING)

Bases: object

A class for keeping track of data related to the API

The following are accepted as keyword arguments and will be used to construct httpx Clients internally:

base_url: The base URL for the API, all requests are made to a relative path to this URL

cookies: A dictionary of cookies to be sent with every request

headers: A dictionary of headers to be sent with every request

timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if this is exceeded.

verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production, but can be set to False for testing purposes.

follow_redirects: Whether or not to follow redirects. Default value is False.

httpx_args: A dictionary of additional arguments to be passed to the httpx.Client and httpx.AsyncClient constructor.

Parameters:

• base_url (str)

• raise_on_unexpected_status (bool)

• cookies (dict[str, str])

• headers (dict[str, str])

• timeout (httpx.Timeout | None)

• verify_ssl (str | bool | ssl.SSLContext)

• follow_redirects (bool)

• httpx_args (dict[str, Any])

raise_on_unexpected_status

Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor.

Type:

bool

get_async_httpx_client()

Get the underlying httpx.AsyncClient, constructing a new one if not previously set

Return type:

AsyncClient

get_httpx_client()

Get the underlying httpx.Client, constructing a new one if not previously set

Return type:

Client

raise_on_unexpected_status: bool

set_async_httpx_client(async_client)

Manually set the underlying httpx.AsyncClient

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:

async_client (AsyncClient)

Return type:

Client

set_httpx_client(client)

Manually set the underlying httpx.Client

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:

client (Client)

Return type:

Client

with_cookies(cookies)

Get a new client matching this one with additional cookies

Parameters:

cookies (dict[str, str])

Return type:

Client

with_headers(headers)

Get a new client matching this one with additional headers

Parameters:

headers (dict[str, str])

Return type:

Client

with_timeout(timeout)

Get a new client matching this one with a new timeout configuration

Parameters:

timeout (Timeout)

Return type:

Client

class AuthenticatedClient(base_url, token, prefix='Bearer', auth_header_name='Authorization', *, raise_on_unexpected_status=False, cookies=NOTHING, headers=NOTHING, timeout=None, verify_ssl=True, follow_redirects=False, httpx_args=NOTHING)

Bases: object

A Client which has been authenticated for use on secured endpoints

The following are accepted as keyword arguments and will be used to construct httpx Clients internally:

base_url: The base URL for the API, all requests are made to a relative path to this URL

cookies: A dictionary of cookies to be sent with every request

headers: A dictionary of headers to be sent with every request

timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if this is exceeded.

verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production, but can be set to False for testing purposes.

follow_redirects: Whether or not to follow redirects. Default value is False.

httpx_args: A dictionary of additional arguments to be passed to the httpx.Client and httpx.AsyncClient constructor.

Parameters:

• base_url (str)

• token (str)

• prefix (str)

• auth_header_name (str)

• raise_on_unexpected_status (bool)

• cookies (dict[str, str])

• headers (dict[str, str])

• timeout (httpx.Timeout | None)

• verify_ssl (str | bool | ssl.SSLContext)

• follow_redirects (bool)

• httpx_args (dict[str, Any])

raise_on_unexpected_status

Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor.

Type:

bool

token

The token to use for authentication

Type:

str

prefix

The prefix to use for the Authorization header

Type:

str

auth_header_name

The name of the Authorization header

Type:

str

auth_header_name: str

get_async_httpx_client()

Get the underlying httpx.AsyncClient, constructing a new one if not previously set

Return type:

AsyncClient

get_httpx_client()

Get the underlying httpx.Client, constructing a new one if not previously set

Return type:

Client

prefix: str

raise_on_unexpected_status: bool

set_async_httpx_client(async_client)

Manually set the underlying httpx.AsyncClient

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:

async_client (AsyncClient)

Return type:

AuthenticatedClient

set_httpx_client(client)

Manually set the underlying httpx.Client

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:

client (Client)

Return type:

AuthenticatedClient

token: str

with_cookies(cookies)

Get a new client matching this one with additional cookies

Parameters:

cookies (dict[str, str])

Return type:

AuthenticatedClient

with_headers(headers)

Get a new client matching this one with additional headers

Parameters:

headers (dict[str, str])

Return type:

AuthenticatedClient

with_timeout(timeout)

Get a new client matching this one with a new timeout configuration

Parameters:

timeout (Timeout)

Return type:

AuthenticatedClient