Struct ServiceDesk 

pub struct ServiceDesk {
    pub base_url: Url,
    pub credentials: Credentials,
    /* private fields */
}

Main client for interacting with ServiceDesk Plus API.

Use tickets() for search/create operations, or ticket(id) for single-ticket operations.

Fields

base_url: Url

credentials: Credentials

Implementations

impl ServiceDesk

pub fn tickets(&self) -> TicketsClient<'_>

Get a client for ticket collection operations.

pub fn ticket(&self, id: impl Into<TicketID>) -> TicketClient<'_>

Get a client for single ticket operations.

impl ServiceDesk

pub async fn ticket_details( &self, ticket_id: impl Into<TicketID>, ) -> Result<DetailedTicket, Error>

pub async fn edit( &self, ticket_id: impl Into<TicketID>, data: &EditTicketData, ) -> Result<(), Error>

Edit an existing ticket. Some of the fields are optional and can be left as None if not being changed. Some fields might be missing due to SDP API restrictions, like account assignment to a given ticket being immutable after creation.

pub async fn add_note( &self, ticket_id: impl Into<TicketID>, note: &NoteData, ) -> Result<Note, Error>

Add a note to a ticket (creates a new note).

pub async fn get_note( &self, ticket_id: impl Into<TicketID>, note_id: impl Into<NoteID>, ) -> Result<Note, Error>

Get a specific note from a ticket.

pub async fn list_notes( &self, ticket_id: impl Into<TicketID>, row_count: Option<u32>, start_index: Option<u32>, ) -> Result<Vec<Note>, Error>

List all notes for a ticket.

pub async fn edit_note( &self, ticket_id: impl Into<TicketID>, note_id: impl Into<NoteID>, note: &NoteData, ) -> Result<Note, Error>

Edit an existing note.

pub async fn delete_note( &self, ticket_id: impl Into<TicketID>, note_id: impl Into<NoteID>, ) -> Result<(), Error>

Delete a note from a ticket.

pub async fn assign_ticket( &self, ticket_id: impl Into<TicketID>, technician_name: &str, ) -> Result<(), Error>

Assign a ticket to a technician.

pub async fn create_ticket( &self, data: &CreateTicketData, ) -> Result<TicketResponse, Error>

Create a new ticket.

pub async fn search_tickets( &self, criteria: Criteria, ) -> Result<Vec<DetailedTicket>, Error>

Search for tickets based on specified criteria. The criteria can be built using the Criteria struct. The default method of querying is not straightforward, Criteria struct on the ‘root’ level contains a single condition, to combine multiple conditions use the ‘children’ field with appropriate ‘logical_operator’.

pub async fn close_ticket( &self, ticket_id: impl Into<TicketID>, closure_comments: &str, ) -> Result<(), Error>

Close a ticket with closure comments.

pub async fn merge( &self, ticket_id: usize, merge_ids: &[usize], ) -> Result<(), Error>

Merge multiple tickets into a single ticket. Key point to note is that the maximum number of tickets that can be merged at once is 49 + 1 (the target ticket), so the merge_ids slice must not exceed 49 IDs.

impl ServiceDesk

pub fn new( base_url: Url, credentials: Credentials, options: ServiceDeskOptions, ) -> Self

Create a new ServiceDesk client instance

Trait Implementations

impl Clone for ServiceDesk

fn clone(&self) -> ServiceDesk

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.