Class AsyncTagsClient


  • public class AsyncTagsClient
    extends java.lang.Object
    • Constructor Detail

      • AsyncTagsClient

        public AsyncTagsClient​(ClientOptions clientOptions)
    • Method Detail

      • withRawResponse

        public AsyncRawTagsClient withRawResponse()
        Get responses with HTTP metadata like headers
      • attachTagToContact

        public java.util.concurrent.CompletableFuture<Tag> attachTagToContact​(AttachTagToContactRequest request)
        You can tag a specific contact. This will return a tag object for the tag that was added to the contact.
      • attachTagToContact

        public java.util.concurrent.CompletableFuture<Tag> attachTagToContact​(AttachTagToContactRequest request,
                                                                              RequestOptions requestOptions)
        You can tag a specific contact. This will return a tag object for the tag that was added to the contact.
      • detachTagFromContact

        public java.util.concurrent.CompletableFuture<Tag> detachTagFromContact​(DetachTagFromContactRequest request)
        You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.
      • detachTagFromContact

        public java.util.concurrent.CompletableFuture<Tag> detachTagFromContact​(DetachTagFromContactRequest request,
                                                                                RequestOptions requestOptions)
        You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.
      • attachTagToConversation

        public java.util.concurrent.CompletableFuture<Tag> attachTagToConversation​(AttachTagToConversationRequest request)
        You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.
      • attachTagToConversation

        public java.util.concurrent.CompletableFuture<Tag> attachTagToConversation​(AttachTagToConversationRequest request,
                                                                                   RequestOptions requestOptions)
        You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.
      • detachTagFromConversation

        public java.util.concurrent.CompletableFuture<Tag> detachTagFromConversation​(DetachTagFromConversationRequest request)
        You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.
      • detachTagFromConversation

        public java.util.concurrent.CompletableFuture<Tag> detachTagFromConversation​(DetachTagFromConversationRequest request,
                                                                                     RequestOptions requestOptions)
        You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.
      • listTags

        public java.util.concurrent.CompletableFuture<TagList> listTags()
        You can fetch a list of all tags for a given workspace.
      • listTags

        public java.util.concurrent.CompletableFuture<TagList> listTags​(RequestOptions requestOptions)
        You can fetch a list of all tags for a given workspace.
      • createTag

        public java.util.concurrent.CompletableFuture<Tag> createTag​(CreateTagRequestBody request)
        You can use this endpoint to perform the following operations:

        1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

        2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

        3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

        4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

        5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

        Each operation will return a tag object.

      • createTag

        public java.util.concurrent.CompletableFuture<Tag> createTag​(CreateTagRequestBody request,
                                                                     RequestOptions requestOptions)
        You can use this endpoint to perform the following operations:

        1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

        2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

        3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

        4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

        5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

        Each operation will return a tag object.

      • findTag

        public java.util.concurrent.CompletableFuture<Tag> findTag​(FindTagRequest request)
        You can fetch the details of tags that are on the workspace by their id. This will return a tag object.
      • findTag

        public java.util.concurrent.CompletableFuture<Tag> findTag​(FindTagRequest request,
                                                                   RequestOptions requestOptions)
        You can fetch the details of tags that are on the workspace by their id. This will return a tag object.
      • deleteTag

        public java.util.concurrent.CompletableFuture<java.lang.Void> deleteTag​(DeleteTagRequest request)
        You can delete the details of tags that are on the workspace by passing in the id.
      • deleteTag

        public java.util.concurrent.CompletableFuture<java.lang.Void> deleteTag​(DeleteTagRequest request,
                                                                                RequestOptions requestOptions)
        You can delete the details of tags that are on the workspace by passing in the id.
      • attachTagToTicket

        public java.util.concurrent.CompletableFuture<Tag> attachTagToTicket​(AttachTagToTicketRequest request)
        You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.
      • attachTagToTicket

        public java.util.concurrent.CompletableFuture<Tag> attachTagToTicket​(AttachTagToTicketRequest request,
                                                                             RequestOptions requestOptions)
        You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.
      • detachTagFromTicket

        public java.util.concurrent.CompletableFuture<Tag> detachTagFromTicket​(DetachTagFromTicketRequest request)
        You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.
      • detachTagFromTicket

        public java.util.concurrent.CompletableFuture<Tag> detachTagFromTicket​(DetachTagFromTicketRequest request,
                                                                               RequestOptions requestOptions)
        You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.