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]] = None)

Response for Get tables

ItemsList dataclass

ItemsList(value: Optional[List[Item]] = None)

Response for Get items

Item dataclass

Item(dynamic_properties: Optional[Dict[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] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None)

Response for Get item metadata

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = 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] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = 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] = field(default=None, 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] = field(default_factory=dict)

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] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

unsortable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = field(default=None, 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] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

non_filterable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = field(default=None, 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] = None

Indicates whether this table has selectable columns

DataSetsList dataclass

DataSetsList(value: Optional[List[DataSet]] = 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] = field(default_factory=dict)

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

ZendeskClient

ZendeskClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_tables_async async

get_tables_async() -> dict[str, Any] | None

Get tables

Retrieves Zendesk tables from a site

get_items_async async

get_items_async(table: str, filter: Optional[str] = None, orderby: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, select: Optional[str] = None) -> dict[str, Any] | None

Get items

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

post_item_async async

post_item_async(input: Item, table: str) -> dict[str, Any] | None

Create Item

Creates a Zendesk item

get_item_async async

get_item_async(table: str, id: str) -> dict[str, Any] | None

Get item

Retrieves a Zendesk item

delete_item_async async

delete_item_async(table: str, id: str) -> None

Delete item

Deletes a Zendesk item

patch_item_async async

patch_item_async(input: Item, table: str, id: str) -> dict[str, Any] | None

Update item

Updates an existing Zendesk item

search_articles_async async

search_articles_async(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) -> dict[str, Any] | None

Search Articles

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

get_table_async async

get_table_async(table: str) -> dict[str, Any] | None

Get item metadata

Retrieves item metadata for Zendesk object type