Skip to main content

Module models

Module models 

Source
Expand description

Strongly typed Zammad entities.

Every record type carries an extra field that captures custom attributes Zammad returns but that aren’t covered by the typed schema. Use it to read or write Object-Manager custom fields without having to redefine the whole model.

For tickets the crate exposes two shapes: the compact Ticket (default) and TicketExpanded, which carries human-readable name strings Zammad adds when expand=true is sent. Select between them at call site via crate::api::TicketsApi::list vs crate::api::TicketsApi::list_expanded.

Structs§

Article
A ticket article (note, email, phone log, …).
Attachment
Attachment metadata returned by Zammad.
Group
A Zammad group (queue).
NewArticle
Payload for POST /api/v1/ticket_articles and inline article on ticket creation.
NewAttachment
Attachment payload for outbound articles. data is base64-encoded.
NewOrganization
Payload for POST /api/v1/organizations.
NewUser
Payload for POST /api/v1/users.
Organization
A Zammad organization.
Ticket
A Zammad ticket (compact form - IDs only).
TicketExpanded
A Zammad ticket returned with expand=true.
TicketPriority
A configurable ticket priority.
TicketState
A configurable ticket state.
User
A Zammad user (agent or customer).