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

Assignment

agent: Id class-attribute

team: Id class-attribute

Id

ID: str class-attribute

Message

text: str class-attribute

NewTicket

Object that needs to be sent when creating a NEW ticket

assignment: Optional[Assignment] class-attribute

message: Message class-attribute

requester: Requester class-attribute

status: Optional[str] class-attribute

subject: Optional[str] class-attribute

teamIDs: Optional[List[str]] class-attribute

Requester

email: str class-attribute

name: str class-attribute

Team

Ticket

Actual ticket as returned by the API