Skip to content

Types

`types` ¶

Return types of the HelpDesk / LiveChat API

Documentation: https://api.helpdesk.com/docs

ToDo

Implement the types below correctly instead of using Extra.Allow
Find out why extra=Extra.allow causes mypy to fail. Seems like a bug in pydantic.

`Agent` ¶

`model_config = ConfigDict(extra='allow')` `class-attribute` `instance-attribute` ¶

`Assignment` ¶

`agent: Id` `instance-attribute` ¶

`model_config = ConfigDict(extra='allow')` `class-attribute` `instance-attribute` ¶

`team: Id` `instance-attribute` ¶

`Id` ¶

`ID: str` `instance-attribute` ¶

`Message` ¶

`model_config = ConfigDict(extra='allow')` `class-attribute` `instance-attribute` ¶

`text: str` `instance-attribute` ¶

`NewTicket` ¶

Object that needs to be sent when creating a NEW ticket

`assignment: Assignment | None = None` `class-attribute` `instance-attribute` ¶

`message: Message` `instance-attribute` ¶

`model_config = ConfigDict(extra='allow')` `class-attribute` `instance-attribute` ¶

`requester: Requester` `instance-attribute` ¶

`status: str | None = None` `class-attribute` `instance-attribute` ¶

`subject: str | None = None` `class-attribute` `instance-attribute` ¶

`teamIDs: list[str] | None = None` `class-attribute` `instance-attribute` ¶

`Requester` ¶

`email: str` `instance-attribute` ¶

`name: str` `instance-attribute` ¶

`Team` ¶

`model_config = ConfigDict(extra='allow')` `class-attribute` `instance-attribute` ¶

`Ticket` ¶

Actual ticket as returned by the API

`model_config = ConfigDict(extra='allow')` `class-attribute` `instance-attribute` ¶