Skip to main content

Module api

Module api 

Source
Expand description

Per-resource API handles. Reach these via methods on crate::Client.

Structs§

ArticlesApi
Ticket-article endpoints (replies, notes, emails, …).
CreateArticle
Builder for POST /api/v1/ticket_articles.
CreateTicket
Builder for POST /api/v1/tickets.
GroupsApi
Group (queue) endpoints.
KbAnswer
A single Knowledge Base answer, flattened from Zammad’s assets bundle.
KbAnswerPatch
A partial update for KnowledgeBaseApi::update_answer. Every field is optional; None leaves the current value untouched.
KbCategory
A Knowledge Base category, flattened from Zammad’s assets bundle.
KbCategoryPatch
A partial update for KnowledgeBaseApi::update_category. Every field is optional; None leaves the current value untouched.
KbInfo
A knowledge base, as listed by KnowledgeBaseApi::list_knowledge_bases.
KbSearchHit
A single full-text search hit.
KnowledgeBaseApi
Knowledge Base (FAQ) endpoints.
ListOrganizations
Builder + iterator for GET /api/v1/organizations.
ListTickets
Builder + iterator for GET /api/v1/tickets.
ListUsers
Builder + iterator for GET /api/v1/users.
NewKbAnswer
Fields for creating a Knowledge Base answer via KnowledgeBaseApi::create_answer.
NewKbCategory
Fields for creating a Knowledge Base category via KnowledgeBaseApi::create_category.
OrganizationsApi
Organization endpoints.
PrioritiesApi
Ticket-priority endpoints.
SearchKnowledgeBase
Builder for POST /api/v1/knowledge_bases/search.
SearchOrganizations
Builder + iterator for GET /api/v1/organizations/search.
SearchTickets
Builder + iterator for GET /api/v1/tickets/search.
SearchUsers
Builder + iterator for GET /api/v1/users/search.
StatesApi
Ticket-state endpoints.
TagListEntry
Entry returned by GET /api/v1/tag_list.
TagsApi
Tag endpoints.
TicketsApi
Ticket endpoints.
UsersApi
User endpoints.

Traits§

TicketShape
Marker trait selecting which ticket shape (compact vs. expanded) a builder returns and whether expand=true is sent to Zammad.