zendesk_sdk¶

Interface to Zendesk API.

Submodules¶

Exceptions¶

TicketClosedError

Raised when a ticket is closed.

Classes¶

`ZendeskServices`	A class wrapping Zendesk interaction.
`Attachment`	Attachment model.
`Ticket`	Ticket model.
`TicketComment`	Ticket model.

Package Contents¶

class zendesk_sdk.ZendeskServices(base_url: str, username: str, password: str, timeout: float)[source]¶

A class wrapping Zendesk interaction.

client[source]¶

_make_request(method: str, path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) → httpx.Response[source]¶: 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][source]¶: Search.

get_ticket(ticket_id: int) → zendesk_sdk.models.Ticket[source]¶: 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[source]¶: 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[source]¶: Update a ticket.

add_tags_to_ticket(ticket_id: int, tags: list[str]) → list[str][source]¶: Add tags to a ticket.

get_ticket_comments(ticket_id: int) → list[zendesk_sdk.models.TicketComment][source]¶: Find and load to base64.

exception zendesk_sdk.TicketClosedError[source]¶

Bases: Exception

Raised when a ticket is closed.

class zendesk_sdk.Attachment(/, **data: Any)[source]¶

Bases: _BaseModel

Attachment model.

id: int[source]¶

url: str[source]¶

file_name: str[source]¶

content_url: str[source]¶

class zendesk_sdk.Ticket(/, **data: Any)[source]¶

Bases: _BaseModel

Ticket model.

id: int[source]¶

status: Literal['new', 'open', 'pending', 'hold', 'solved', 'closed'][source]¶

url: str[source]¶

created_at: datetime.datetime = None[source]¶

tags: list[str][source]¶

class zendesk_sdk.TicketComment(/, **data: Any)[source]¶

Bases: _BaseModel

Ticket model.

id: int[source]¶

public: bool[source]¶

plain_body: str[source]¶

attachments: list[Attachment][source]¶