Class Ticketing


  • public class Ticketing
    extends java.lang.Object
    • Method Detail

      • async

        public AsyncTicketing async()
        Switches to the async SDK.
        Returns:
        The async SDK
      • listTickets

        public TicketingListTicketsResponse listTickets​(TicketingListTicketsRequest request)
                                                 throws java.lang.Exception
        List Tickets

        Retrieve a paginated list of tickets.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listTickets

        public TicketingListTicketsResponse listTickets​(TicketingListTicketsRequest request,
                                                        java.util.Optional<Options> options)
                                                 throws java.lang.Exception
        List Tickets

        Retrieve a paginated list of tickets.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • createTicket

        public TicketingCreateTicketResponse createTicket​(java.lang.String xAccountId,
                                                          TicketingTicketCreateRequestDto ticketingTicketCreateRequestDto)
                                                   throws java.lang.Exception
        Create Ticket

        Create a new ticket record.

        Parameters:
        xAccountId - The account identifier
        ticketingTicketCreateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • createTicket

        public TicketingCreateTicketResponse createTicket​(java.lang.String xAccountId,
                                                          TicketingTicketCreateRequestDto ticketingTicketCreateRequestDto,
                                                          java.util.Optional<Options> options)
                                                   throws java.lang.Exception
        Create Ticket

        Create a new ticket record.

        Parameters:
        xAccountId - The account identifier
        ticketingTicketCreateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getTicket

        public TicketingGetTicketResponse getTicket​(TicketingGetTicketRequest request)
                                             throws java.lang.Exception
        Get Ticket

        Retrieve a single ticket by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getTicket

        public TicketingGetTicketResponse getTicket​(TicketingGetTicketRequest request,
                                                    java.util.Optional<Options> options)
                                             throws java.lang.Exception
        Get Ticket

        Retrieve a single ticket by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • updateTicket

        public TicketingUpdateTicketResponse updateTicket​(java.lang.String xAccountId,
                                                          java.lang.String id,
                                                          TicketingTicketUpdateRequestDto ticketingTicketUpdateRequestDto)
                                                   throws java.lang.Exception
        Update Ticket

        Update an existing ticket record by its identifier.

        Parameters:
        xAccountId - The account identifier
        id -
        ticketingTicketUpdateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • updateTicket

        public TicketingUpdateTicketResponse updateTicket​(java.lang.String xAccountId,
                                                          java.lang.String id,
                                                          TicketingTicketUpdateRequestDto ticketingTicketUpdateRequestDto,
                                                          java.util.Optional<Options> options)
                                                   throws java.lang.Exception
        Update Ticket

        Update an existing ticket record by its identifier.

        Parameters:
        xAccountId - The account identifier
        id -
        ticketingTicketUpdateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listUsers

        public TicketingListUsersResponse listUsers​(TicketingListUsersRequest request)
                                             throws java.lang.Exception
        List Users

        Retrieve a paginated list of users.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listUsers

        public TicketingListUsersResponse listUsers​(TicketingListUsersRequest request,
                                                    java.util.Optional<Options> options)
                                             throws java.lang.Exception
        List Users

        Retrieve a paginated list of users.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getUser

        public TicketingGetUserResponse getUser​(TicketingGetUserRequest request)
                                         throws java.lang.Exception
        Get User

        Retrieve a single user by their identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getUser

        public TicketingGetUserResponse getUser​(TicketingGetUserRequest request,
                                                java.util.Optional<Options> options)
                                         throws java.lang.Exception
        Get User

        Retrieve a single user by their identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listComments

        public TicketingListCommentsResponse listComments​(TicketingListCommentsRequest request)
                                                   throws java.lang.Exception
        List Comments

        Retrieve a paginated list of comments for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listComments

        public TicketingListCommentsResponse listComments​(TicketingListCommentsRequest request,
                                                          java.util.Optional<Options> options)
                                                   throws java.lang.Exception
        List Comments

        Retrieve a paginated list of comments for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getComment

        public TicketingGetCommentResponse getComment​(TicketingGetCommentRequest request)
                                               throws java.lang.Exception
        Get Comment

        Retrieve a single comment by its identifier for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getComment

        public TicketingGetCommentResponse getComment​(TicketingGetCommentRequest request,
                                                      java.util.Optional<Options> options)
                                               throws java.lang.Exception
        Get Comment

        Retrieve a single comment by its identifier for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • downloadTicketingAttachment

        public TicketingDownloadTicketingAttachmentResponse downloadTicketingAttachment​(TicketingDownloadTicketingAttachmentRequest request)
                                                                                 throws java.lang.Exception
        Download Attachment

        Download the attachment file from a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • downloadTicketingAttachment

        public TicketingDownloadTicketingAttachmentResponse downloadTicketingAttachment​(TicketingDownloadTicketingAttachmentRequest request,
                                                                                        java.util.Optional<Options> options)
                                                                                 throws java.lang.Exception
        Download Attachment

        Download the attachment file from a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listAttachments

        public TicketingListAttachmentsResponse listAttachments​(TicketingListAttachmentsRequest request)
                                                         throws java.lang.Exception
        List Attachments

        Retrieve a paginated list of attachment details for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listAttachments

        public TicketingListAttachmentsResponse listAttachments​(TicketingListAttachmentsRequest request,
                                                                java.util.Optional<Options> options)
                                                         throws java.lang.Exception
        List Attachments

        Retrieve a paginated list of attachment details for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getAttachment

        public TicketingGetAttachmentResponse getAttachment​(TicketingGetAttachmentRequest request)
                                                     throws java.lang.Exception
        Get Attachment

        Retrieve the details of a single attachment for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getAttachment

        public TicketingGetAttachmentResponse getAttachment​(TicketingGetAttachmentRequest request,
                                                            java.util.Optional<Options> options)
                                                     throws java.lang.Exception
        Get Attachment

        Retrieve the details of a single attachment for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listTicketTypes

        public TicketingListTicketTypesResponse listTicketTypes​(TicketingListTicketTypesRequest request)
                                                         throws java.lang.Exception
        List Ticket Types

        Retrieve a paginated list of all ticket types.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listTicketTypes

        public TicketingListTicketTypesResponse listTicketTypes​(TicketingListTicketTypesRequest request,
                                                                java.util.Optional<Options> options)
                                                         throws java.lang.Exception
        List Ticket Types

        Retrieve a paginated list of all ticket types.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getTicketType

        public TicketingGetTicketTypeResponse getTicketType​(TicketingGetTicketTypeRequest request)
                                                     throws java.lang.Exception
        Get Ticket Type

        Retrieve a single ticket type by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getTicketType

        public TicketingGetTicketTypeResponse getTicketType​(TicketingGetTicketTypeRequest request,
                                                            java.util.Optional<Options> options)
                                                     throws java.lang.Exception
        Get Ticket Type

        Retrieve a single ticket type by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listProjects

        public TicketingListProjectsResponse listProjects​(TicketingListProjectsRequest request)
                                                   throws java.lang.Exception
        List Projects

        Retrieve a paginated list of projects.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listProjects

        public TicketingListProjectsResponse listProjects​(TicketingListProjectsRequest request,
                                                          java.util.Optional<Options> options)
                                                   throws java.lang.Exception
        List Projects

        Retrieve a paginated list of projects.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getProject

        public TicketingGetProjectResponse getProject​(TicketingGetProjectRequest request)
                                               throws java.lang.Exception
        Get Project

        Retrieve a single project by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getProject

        public TicketingGetProjectResponse getProject​(TicketingGetProjectRequest request,
                                                      java.util.Optional<Options> options)
                                               throws java.lang.Exception
        Get Project

        Retrieve a single project by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listProjectComponents

        public TicketingListProjectComponentsResponse listProjectComponents​(TicketingListProjectComponentsRequest request)
                                                                     throws java.lang.Exception
        List Project Components

        Retrieve a paginated list of project components.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listProjectComponents

        public TicketingListProjectComponentsResponse listProjectComponents​(TicketingListProjectComponentsRequest request,
                                                                            java.util.Optional<Options> options)
                                                                     throws java.lang.Exception
        List Project Components

        Retrieve a paginated list of project components.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getProjectComponent

        public TicketingGetProjectComponentResponse getProjectComponent​(TicketingGetProjectComponentRequest request)
                                                                 throws java.lang.Exception
        Get Project Component

        Retrieve a single project component by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • getProjectComponent

        public TicketingGetProjectComponentResponse getProjectComponent​(TicketingGetProjectComponentRequest request,
                                                                        java.util.Optional<Options> options)
                                                                 throws java.lang.Exception
        Get Project Component

        Retrieve a single project component by its identifier.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listProjectTicketTypes

        public TicketingListProjectTicketTypesResponse listProjectTicketTypes​(TicketingListProjectTicketTypesRequest request)
                                                                       throws java.lang.Exception
        List Project Ticket Types

        Retrieve a paginated list of ticket types for a project.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listProjectTicketTypes

        public TicketingListProjectTicketTypesResponse listProjectTicketTypes​(TicketingListProjectTicketTypesRequest request,
                                                                              java.util.Optional<Options> options)
                                                                       throws java.lang.Exception
        List Project Ticket Types

        Retrieve a paginated list of ticket types for a project.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listTicketStatuses

        public TicketingListTicketStatusesResponse listTicketStatuses​(TicketingListTicketStatusesRequest request)
                                                               throws java.lang.Exception
        List Ticket Statuses

        Retrieve a paginated list of statuses for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails
      • listTicketStatuses

        public TicketingListTicketStatusesResponse listTicketStatuses​(TicketingListTicketStatusesRequest request,
                                                                      java.util.Optional<Options> options)
                                                               throws java.lang.Exception
        List Ticket Statuses

        Retrieve a paginated list of statuses for a ticket.

        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails