Skip to content

ZendeskClient

Attributes

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GetOnNewItems': {'operation_id': 'GetOnNewItems', 'path': '/{connectionId}/datasets/default/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'ItemsList'}, 'GetOnUpdatedItemsV2': {'operation_id': 'GetOnUpdatedItemsV2', 'path': '/{connectionId}/v2/datasets/default/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'ItemsList'}}

Classes

TablesList dataclass 

TablesList(*, value: Optional[List[Table | Mapping[str, Any]]] = None)

Response for Get tables

ItemsList dataclass 

ItemsList(*, value: Optional[List[Item | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Get items

Attributes

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

Item dataclass 

Item(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Response for Create Item

SearchResult dataclass 

SearchResult(*, results: Optional[List[Dict[str, Any]]] = None)

Response for Search Articles

TableMetadata dataclass 

TableMetadata(*, name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None, referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get item metadata

DataSetsMetadata dataclass 

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass 

TabularDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

BlobDataSetsMetadata dataclass 

BlobDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

TableCapabilitiesMetadata dataclass 

TableCapabilitiesMetadata(*, sort_restrictions: Optional[TableSortRestrictionsMetadata | Mapping[str, Any]] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata | Mapping[str, Any]] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata | Mapping[str, Any]] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute 
is_only_server_pagable: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

ObjectEntity dataclass 

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TableSortRestrictionsMetadata dataclass 

TableSortRestrictionsMetadata(*, sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute 
sortable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute 
unsortable_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute 
ascending_only_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TableFilterRestrictionsMetadata dataclass 

TableFilterRestrictionsMetadata(*, filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute 
filterable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute 
non_filterable_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute 
required_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass 

TableSelectRestrictionsMetadata(*, selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute 
selectable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has selectable columns

DataSetsList dataclass 

DataSetsList(*, value: Optional[List[DataSet | Mapping[str, Any]]] = None)

Definition: DataSetsList

DataSet dataclass 

DataSet(*, name: Optional[str] = None, display_name: Optional[str] = None)

Definition: DataSet

Table dataclass 

Table(*, name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Table

GetCurrentUserInfoResponse dataclass 

GetCurrentUserInfoResponse(*, additional_properties: Dict[str, Any] = dict())

Definition: GetCurrentUserInfoResponse

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ZendeskClient 

ZendeskClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for zendesk connector.

Initialize a ZendeskClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
credential AsyncTokenCredential | AzureKeyCredential

Caller-owned Azure Core credential.

 required
max_retry_attempts int

The maximum number of request attempts.

 3
timeout float

The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.

 30.0
use_exponential_backoff bool

Whether retries use exponential backoff.

 True
initial_retry_delay_seconds float

The initial retry delay in seconds.

 0.5
maximum_retry_delay_seconds float

The maximum retry delay in seconds.

 120.0
retry_jitter_factor float

The jitter fraction applied to retry delays.

 0.1
retry_unsafe_http_methods bool

Whether unsafe HTTP methods may be retried.

 False
transport Optional[AsyncHttpTransport]

Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.

 None
**kwargs Any

Optional Azure Core pipeline policy settings.

 {}

Methods:

list_tables 
list_tables(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get tables

Retrieves Zendesk tables from a site

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_items 
list_items(table: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get items

Retrieves Zendesk items of a certain Zendesk type (example: 'Ticket')

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems.

Parameters:

Name Type Description Default
table str

Zendesk item type (example: 'Ticket').

 required
filter Optional[str]

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

 None
orderby Optional[str]

An ODATA orderBy query for specifying the order of entries.

 None
skip Optional[int]

Number of entries to skip (default = 0).

 None
top Optional[int]

Maximum number of entries to retrieve (default = 512).

 None
select Optional[str]

Specific fields to retrieve from entries (default = all).

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
post_item async 
post_item(input: Item | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create Item

Creates a Zendesk item

Swagger operation ID: PostItem.

Parameters:

Name Type Description Default
input Item | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
table str

Zendesk item type (example: 'Ticket').

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
get_item async 
get_item(table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get item

Retrieves a Zendesk item

Swagger operation ID: GetItem.

Parameters:

Name Type Description Default
table str

Zendesk item type (example: 'Ticket').

 required
id str

Unique identifier of the item to retrieve.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
delete_item async 
delete_item(table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete item

Deletes a Zendesk item

Swagger operation ID: DeleteItem.

Parameters:

Name Type Description Default
table str

Zendesk item type (example: 'Ticket').

 required
id str

Unique identifier of the item to delete.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
patch_item async 
patch_item(input: Item | Mapping[str, Any], table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update item

Updates an existing Zendesk item

Swagger operation ID: PatchItem.

Parameters:

Name Type Description Default
input Item | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

 required
table str

Zendesk item type (example: 'Ticket').

 required
id str

Unique identifier of the item to update.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_search_articles 
list_search_articles(query: str, *, locale: Optional[str] = None, brand_id: Optional[int] = None, category: Optional[int] = None, section: Optional[int] = None, label_names: Optional[str] = None, multibrand: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Search Articles

Returns a default number of 25 articles per page, up to a maximum of 1000 results.

Returns a single-page Azure Core async collection.

Swagger operation ID: SearchArticles.

Parameters:

Name Type Description Default
query str

Article to search for.

 required
locale Optional[str]

The locale the item is displayed in.

 None
brand_id Optional[int]

Search for articles in the specified brand.

 None
category Optional[int]

Limit the search to this category id.

 None
section Optional[int]

Limit the search to this section id.

 None
label_names Optional[str]

A comma-separated list of label names.

 None
multibrand Optional[bool]

Enable search across all brands if true.

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
get_table async 
get_table(table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get item metadata

Retrieves item metadata for Zendesk object type

Swagger operation ID: GetTable.

Parameters:

Name Type Description Default
table str

Zendesk item type (example: 'Ticket').

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.