Expand description
Per-resource API handles. Reach these via methods on crate::Client.
Structs§
- Articles
Api - Ticket-article endpoints (replies, notes, emails, …).
- Create
Article - Builder for
POST /api/v1/ticket_articles. - Create
Ticket - Builder for
POST /api/v1/tickets. - Groups
Api - Group (queue) endpoints.
- KbAnswer
- A single Knowledge Base answer, flattened from Zammad’s assets bundle.
- KbAnswer
Patch - A partial update for
KnowledgeBaseApi::update_answer. Every field is optional;Noneleaves the current value untouched. - KbCategory
- A Knowledge Base category, flattened from Zammad’s assets bundle.
- KbCategory
Patch - A partial update for
KnowledgeBaseApi::update_category. Every field is optional;Noneleaves the current value untouched. - KbInfo
- A knowledge base, as listed by
KnowledgeBaseApi::list_knowledge_bases. - KbSearch
Hit - A single full-text search hit.
- Knowledge
Base Api - Knowledge Base (FAQ) endpoints.
- List
Organizations - Builder + iterator for
GET /api/v1/organizations. - List
Tickets - Builder + iterator for
GET /api/v1/tickets. - List
Users - Builder + iterator for
GET /api/v1/users. - NewKb
Answer - Fields for creating a Knowledge Base answer via
KnowledgeBaseApi::create_answer. - NewKb
Category - Fields for creating a Knowledge Base category via
KnowledgeBaseApi::create_category. - Organizations
Api - Organization endpoints.
- Priorities
Api - Ticket-priority endpoints.
- Search
Knowledge Base - Builder for
POST /api/v1/knowledge_bases/search. - Search
Organizations - Builder + iterator for
GET /api/v1/organizations/search. - Search
Tickets - Builder + iterator for
GET /api/v1/tickets/search. - Search
Users - Builder + iterator for
GET /api/v1/users/search. - States
Api - Ticket-state endpoints.
- TagList
Entry - Entry returned by
GET /api/v1/tag_list. - TagsApi
- Tag endpoints.
- Tickets
Api - Ticket endpoints.
- Users
Api - User endpoints.
Traits§
- Ticket
Shape - Marker trait selecting which ticket shape (compact vs. expanded) a
builder returns and whether
expand=trueis sent to Zammad.