Python Client SDK for Zendesk Support API.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for memben from gravatar.com memben

Unverified details

These details have not been verified by PyPI
Meta
  • Author: Ben Meyer-Meisel
  • Requires: Python >=3.9.2
Classifiers
Report project as malware

Project description

python-zendesk

Provided by botBrains. This SDK is generated for the Zendesk Support API openapi spec (also known as Zendesk Ticketing API). We slightly modified it to comply with the OpenAPI spec and to work with the speakeasy codegen tool, as well as adding partial pagination support.

How to regenerate the SDK

sh scripts/generate.sh

Summary

Support API: Zendesk Support API endpoints

Table of Contents

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, 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.

pip install python-zendesk

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.

poetry add python-zendesk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from python-zendesk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "python-zendesk",
# ]
# ///

from zendesk import Zendesk

sdk = Zendesk(
  # 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.

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.

SDK Example Usage

Example

# Synchronous Example
from zendesk import Zendesk, models


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from zendesk import Zendesk, models

async def main():

    async with Zendesk(
        security=models.Security(
            username="",
            password="",
        ),
    ) as z_client:

        res = await z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search_async(name="Johnny Agent")

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
username
password		 http HTTP Basic ZENDESK_USERNAME
ZENDESK_PASSWORD

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

from zendesk import Zendesk, models


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)

Available Resources and Operations

Available methods

account_settings

activity_stream

approval_requests

approval_workflow_instances

assignee_field_assignable_agents

assignee_field_assignable_groups

attachments

audit_logs

automations

basics

bookmarks

brand_agents

brands

channel_framework

conversation_log

custom_object_fields

custom_object_records

custom_objects

custom_roles

custom_ticket_statuses

deletion_schedules

dynamic_content

dynamic_content_item_variants

email_notifications

essentials_card

global_clients

grant_type_tokens

group_memberships

group_sla_policies

groups

incremental_export

incremental_skill_based_routing

job_statuses

locales

lookup_relationships

macros

o_auth_clients

o_auth_tokens

object_triggers

omnichannel_routing_queues

organization_fields

organization_memberships

organization_subscriptions

organizations

push_notification_devices

requests

reseller

resource_collections

satisfaction_ratings

satisfaction_reasons

search

sessions

sharing_agreements

skill_based_routing

sla_policies

support_addresses

suspended_tickets

tags

target_failures

targets

ticket_audits

ticket_comments

ticket_fields

ticket_form_statuses

ticket_forms

ticket_import

ticket_metric_events

ticket_metrics

ticket_skips

tickets

trigger_categories

triggers

user_fields

user_identities

user_passwords

users

views

webhook_invocations

webhooks

workspaces

x_channel

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:

from zendesk import Zendesk, models


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.lookup_relationships.get_sources_by_target(target_type="zen:custom_object:apartment", target_id=1234, field_id=1234, source_type="zen:custom_object:apartment", page_size=100)

    while res is not None:
        # Handle items

        res = res.next()

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:

from zendesk import Zendesk, models
from zendesk.utils import BackoffStrategy, RetryConfig


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent",
        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:

from zendesk import Zendesk, models
from zendesk.utils import BackoffStrategy, RetryConfig


with Zendesk(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)

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.APIError 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 list_ticket_tags_async method may raise the following exceptions:

Error Type Status Code Content Type
errors.Error 404 application/json
errors.APIError 4XX, 5XX */*

Example

from zendesk import Zendesk, errors, models


with Zendesk(
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:
    res = None
    try:

        res = z_client.tags.list_ticket_tags(ticket_id=123456)

        # Handle response
        print(res)

    except errors.Error as e:
        # handle e.data: errors.ErrorData
        raise(e)
    except errors.APIError as e:
        # handle exception
        raise(e)

Server Selection

Server Variables

The default server https://{subdomain}.{domain}.com contains variables and is set to https://example.zendesk.com by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable Parameter Default Description
domain domain: str "zendesk"
subdomain subdomain: str "example"

Example

from zendesk import Zendesk, models


with Zendesk(
    domain="unwelcome-bidet.info"
    subdomain="<value>"
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from zendesk import Zendesk, models


with Zendesk(
    server_url="https://example.zendesk.com",
    security=models.Security(
        username="",
        password="",
    ),
) as z_client:

    res = z_client.assignee_field_assignable_groups.list_assignee_field_assignable_groups_and_agents_search(name="Johnny Agent")

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx 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:

from zendesk import Zendesk
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Zendesk(client=http_client)

or you could wrap the client with your own custom logic:

from zendesk import Zendesk
from zendesk.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 = Zendesk(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Zendesk 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 and reuse it across the application.

from zendesk import Zendesk, models
def main():

    with Zendesk(
        security=models.Security(
            username="",
            password="",
        ),
    ) as z_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Zendesk(
        security=models.Security(
            username="",
            password="",
        ),
    ) as z_client:
        # Rest of application here...

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.

from zendesk import Zendesk
import logging

logging.basicConfig(level=logging.DEBUG)
s = Zendesk(debug_logger=logging.getLogger("zendesk"))

You can also enable a default debug logger by setting an environment variable ZENDESK_DEBUG to true.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for memben from gravatar.com memben

Unverified details

These details have not been verified by PyPI
Meta
  • Author: Ben Meyer-Meisel
  • Requires: Python >=3.9.2
Classifiers

Release history Release notifications | RSS feed

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.17

0.1.15

0.1.14

0.1.13

0.1.12

This version

0.1.11

0.1.10

0.1.7

0.1.6

0.1.5

0.1.3

0.1.2

0.0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_zendesk-0.1.11.tar.gz (429.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_zendesk-0.1.11-py3-none-any.whl (951.8 kB view details)

Uploaded Python 3

File details

Details for the file python_zendesk-0.1.11.tar.gz.

File metadata

  • Download URL: python_zendesk-0.1.11.tar.gz
  • Upload date:
  • Size: 429.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for python_zendesk-0.1.11.tar.gz
Algorithm Hash digest
SHA256 2f529e8f03b338fb55f6fa348e1417f97a2f910cc5376e74542860f7519f6314
MD5 6d5265dc4d2e73a4c05b35af2b85dca2
BLAKE2b-256 bd235f08995a38acacea4d8fdb06b527a9bf4ef17743a607b1e34b9f52f66d30

See more details on using hashes here.

File details

Details for the file python_zendesk-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: python_zendesk-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 951.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for python_zendesk-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 45ef9526d42c0bd8ab1f6ff12f61936d922dc20d940d375c5b9dfd4df2da29dc
MD5 bd81822d32773b0e66392abaf65151fb
BLAKE2b-256 24f7dd459537262762a44ec3f53ae6f8bb474a1c20ae6e10bf874566d245f9a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page