python-dialpad 3.1.0

A python wrapper for the Dialpad REST API

Python Dialpad API Client

A python wrapper around the Dialpad REST API

This document describes the installation, usage, and development practices of this python library. For information about the API itself, head on over to our API Documentation page!

Installation

Just use everyone's new favourite python package manager: uv

uv add python-dialpad

Usage

The Short Version

TL;DR, this library provides a DialpadClient class, which can be instantiated with an API token and a dialpad URL.

Once a DialpadClient object has been constructed, it can be used to call our API endpoints:

from dialpad import DialpadClient

dp_client = DialpadClient(sandbox=True, token='API_TOKEN_HERE')

print(dp_client.users.get(user_id='1234567'))

Client Constructor Arguments

• token (required) The API token that will be used to authenticate API requests.
• sandbox (optional) If the sandbox argument is set to True, then API calls will be routed to https://sandbox.dialpad.com.
• base_url (optional) Routes requests to a specific url.

API Resources

In general, resources that we support in our public API will be exposed as properties of the client object. For example, the User resource can be accessed using the users property (as demonstrated above).

Each of these resource properties will expose related HTTP methods as methods of that resource property.

For example, GET /api/v2/users/{id} translates to dp_client.users.get('a_user_id').

When in doubt, type annotations and docstrings are sourced directly from the Dialpad API spec, and should behave well with most editors' autocomplete/tooltip features:

API Responses

In cases where our API responds with a single JSON object, the client method will return a Python dict (as demonstrated above)

In cases where our API responds with a paginated list of many JSON objects, the client method will return an iterator which will lazily request the next page as the iterator is iterated upon.

from dialpad import DialpadClient

dp_client = DialpadClient(sandbox=True, token='API_TOKEN_HERE')

for user in dp_client.users.list():
  print(user)

Async Support

AsyncDialpadClient is a thing now 🌈

from dialpad import AsyncDialpadClient

dp_client = AsyncDialpadClient(sandbox=True, token='API_TOKEN_HERE')

async for user in dp_client.users.list():
  print(user)

Development

This project is now managed with uv, and exposes a cli tool to automate most maintenance tasks. uv run cli --help for details.

Maintenance Releases

Changes/additions to the Dialpad API can be handled (mostly) automatically 👍

Update Procedure

• Run uv run cli interactive-update

This will take care of pulling down the latest OAS from dialpad.com, updating the client accordingly, and bumping the package version number.

• Run uv run pytest

  • Never hurts to confirm that nothing got borked 👍

• Commit the changes, tag the commit, and push up the changes

  • interactive-update provides these in its output for convenience 👍

Pushing up a version tag will trigger GHA to build, test, and publish to PyPI 🍻

Feature Releases

The schema and resource classes in this project are now automatically-generated, but the rest of the project files can still be directly edited to add features or extend functionality