zendesk_sdk.client

Zendesk API client.

Attributes

TOKEN_EXPIRY_MARGIN

Classes

ZendeskServices

A class wrapping Zendesk interaction.

Module Contents

zendesk_sdk.client.TOKEN_EXPIRY_MARGIN

class zendesk_sdk.client.ZendeskServices(base_url: str, client_id: str, client_secret: str, scope: str, timeout: float)

A class wrapping Zendesk interaction.

client

_client_id

_client_secret

_scope

_access_token: str | None = None

_access_token_expires_at

_get_access_token() → str

Return an access token, requesting a new one when the cached one has expired.

_make_request(method: str, path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) → niquests.Response

Make a request to Zendesk.

search(type_: Literal['ticket', 'user', 'organization'] = 'ticket', statuses: list[Literal['new', 'open', 'pending', 'hold', 'solved', 'closed']] | None = None, tags: list[str] | None = None) → list[zendesk_sdk.models.Ticket]

Search.

get_ticket(ticket_id: int) → zendesk_sdk.models.Ticket

Find and load to base64.

create_ticket(subject: str, body: str, group_id: int, priority: Literal['urgent', 'high', 'normal', 'low'] = 'normal') → zendesk_sdk.models.Ticket

Find and load to base64.

update_ticket(ticket_id: int, status: Literal['new', 'open', 'pending', 'hold', 'solved', 'closed'] | None = None, comment: str | None = None, comment_is_public: bool = True) → zendesk_sdk.models.Ticket

Update a ticket.

add_tags_to_ticket(ticket_id: int, tags: list[str]) → list[str]

Add tags to a ticket.

get_ticket_comments(ticket_id: int) → list[zendesk_sdk.models.TicketComment]

Find and load to base64.