Package com.intercom.api.resources.unstable.tags

Class TagsClient

java.lang.Object

com.intercom.api.resources.unstable.tags.TagsClient

public class TagsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
TagsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Tag	attachTagToContact(AttachTagToContactRequest request)	You can tag a specific contact.
Tag	attachTagToContact(AttachTagToContactRequest request, RequestOptions requestOptions)	You can tag a specific contact.
Tag	attachTagToConversation(AttachTagToConversationRequest request)	You can tag a specific conversation.
Tag	attachTagToConversation(AttachTagToConversationRequest request, RequestOptions requestOptions)	You can tag a specific conversation.
Tag	attachTagToTicket(AttachTagToTicketRequest request)	You can tag a specific ticket.
Tag	attachTagToTicket(AttachTagToTicketRequest request, RequestOptions requestOptions)	You can tag a specific ticket.
Tag	createTag(CreateTagRequestBody request)	You can use this endpoint to perform the following operations:
Tag	createTag(CreateTagRequestBody request, RequestOptions requestOptions)	You can use this endpoint to perform the following operations:
void	deleteTag(DeleteTagRequest request)	You can delete the details of tags that are on the workspace by passing in the id.
void	deleteTag(DeleteTagRequest request, RequestOptions requestOptions)	You can delete the details of tags that are on the workspace by passing in the id.
Tag	detachTagFromContact(DetachTagFromContactRequest request)	You can remove tag from a specific contact.
Tag	detachTagFromContact(DetachTagFromContactRequest request, RequestOptions requestOptions)	You can remove tag from a specific contact.
Tag	detachTagFromConversation(DetachTagFromConversationRequest request)	You can remove tag from a specific conversation.
Tag	detachTagFromConversation(DetachTagFromConversationRequest request, RequestOptions requestOptions)	You can remove tag from a specific conversation.
Tag	detachTagFromTicket(DetachTagFromTicketRequest request)	You can remove tag from a specific ticket.
Tag	detachTagFromTicket(DetachTagFromTicketRequest request, RequestOptions requestOptions)	You can remove tag from a specific ticket.
Tag	findTag(FindTagRequest request)	You can fetch the details of tags that are on the workspace by their id.
Tag	findTag(FindTagRequest request, RequestOptions requestOptions)	You can fetch the details of tags that are on the workspace by their id.
TagList	listTags()	You can fetch a list of all tags for a given workspace.
TagList	listTags(RequestOptions requestOptions)	You can fetch a list of all tags for a given workspace.
RawTagsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

TagsClient

public TagsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawTagsClient withRawResponse()

Get responses with HTTP metadata like headers

attachTagToContact

public 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 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 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 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 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 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 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 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 TagList listTags()

You can fetch a list of all tags for a given workspace.

listTags

public TagList listTags(RequestOptions requestOptions)

You can fetch a list of all tags for a given workspace.

createTag

public 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 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 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 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 void deleteTag(DeleteTagRequest request)

You can delete the details of tags that are on the workspace by passing in the id.

deleteTag

public 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 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 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 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 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.