Package com.intercom.api.resources.tags

Class TagsClient

java.lang.Object

com.intercom.api.resources.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	create(TagsCreateRequestBody request)	You can use this endpoint to perform the following operations:
Tag	create(TagsCreateRequestBody request, RequestOptions requestOptions)	You can use this endpoint to perform the following operations:
void	delete(DeleteTagRequest request)	You can delete the details of tags that are on the workspace by passing in the id.
void	delete(DeleteTagRequest request, RequestOptions requestOptions)	You can delete the details of tags that are on the workspace by passing in the id.
Tag	find(FindTagRequest request)	You can fetch the details of tags that are on the workspace by their id.
Tag	find(FindTagRequest request, RequestOptions requestOptions)	You can fetch the details of tags that are on the workspace by their id.
TagList	list()	You can fetch a list of all tags for a given workspace.
TagList	list(RequestOptions requestOptions)	You can fetch a list of all tags for a given workspace.
Tag	tagContact(TagContactRequest request)	You can tag a specific contact.
Tag	tagContact(TagContactRequest request, RequestOptions requestOptions)	You can tag a specific contact.
Tag	tagConversation(TagConversationRequest request)	You can tag a specific conversation.
Tag	tagConversation(TagConversationRequest request, RequestOptions requestOptions)	You can tag a specific conversation.
Tag	tagTicket(TagTicketRequest request)	You can tag a specific ticket.
Tag	tagTicket(TagTicketRequest request, RequestOptions requestOptions)	You can tag a specific ticket.
Tag	untagContact(UntagContactRequest request)	You can remove tag from a specific contact.
Tag	untagContact(UntagContactRequest request, RequestOptions requestOptions)	You can remove tag from a specific contact.
Tag	untagConversation(UntagConversationRequest request)	You can remove tag from a specific conversation.
Tag	untagConversation(UntagConversationRequest request, RequestOptions requestOptions)	You can remove tag from a specific conversation.
Tag	untagTicket(UntagTicketRequest request)	You can remove tag from a specific ticket.
Tag	untagTicket(UntagTicketRequest request, RequestOptions requestOptions)	You can remove tag from a specific ticket.
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

tagContact

public Tag tagContact(TagContactRequest request)

You can tag a specific contact. This will return a tag object for the tag that was added to the contact.

tagContact

public Tag tagContact(TagContactRequest request,
                      RequestOptions requestOptions)

You can tag a specific contact. This will return a tag object for the tag that was added to the contact.

untagContact

public Tag untagContact(UntagContactRequest request)

You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.

untagContact

public Tag untagContact(UntagContactRequest 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.

tagConversation

public Tag tagConversation(TagConversationRequest request)

You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.

tagConversation

public Tag tagConversation(TagConversationRequest request,
                           RequestOptions requestOptions)

You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.

untagConversation

public Tag untagConversation(UntagConversationRequest request)

You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.

untagConversation

public Tag untagConversation(UntagConversationRequest 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.

list

public TagList list()

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

list

public TagList list(RequestOptions requestOptions)

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

create

public Tag create(TagsCreateRequestBody 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.

create

public Tag create(TagsCreateRequestBody 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.

find

public Tag find(FindTagRequest request)

You can fetch the details of tags that are on the workspace by their id. This will return a tag object.

find

public Tag find(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.

delete

public void delete(DeleteTagRequest request)

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

delete

public void delete(DeleteTagRequest request,
                   RequestOptions requestOptions)

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

tagTicket

public Tag tagTicket(TagTicketRequest request)

You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.

tagTicket

public Tag tagTicket(TagTicketRequest request,
                     RequestOptions requestOptions)

You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.

untagTicket

public Tag untagTicket(UntagTicketRequest request)

You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.

untagTicket

public Tag untagTicket(UntagTicketRequest 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.