Package com.intercom.api.resources.visitors

Class AsyncVisitorsClient

java.lang.Object

com.intercom.api.resources.visitors.AsyncVisitorsClient

public class AsyncVisitorsClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncVisitorsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Visitor>	find(FindVisitorRequest request)	You can fetch the details of a single visitor.
CompletableFuture<Visitor>	find(FindVisitorRequest request, RequestOptions requestOptions)	You can fetch the details of a single visitor.
CompletableFuture<Contact>	mergeToContact(MergeVisitorToContactRequest request)	You can merge a Visitor to a Contact of role type lead or user.
CompletableFuture<Contact>	mergeToContact(MergeVisitorToContactRequest request, RequestOptions requestOptions)	You can merge a Visitor to a Contact of role type lead or user.
CompletableFuture<Visitor>	update(UpdateVisitorRequest request)	Sending a PUT request to /visitors will result in an update of an existing Visitor.
CompletableFuture<Visitor>	update(UpdateVisitorRequest request, RequestOptions requestOptions)	Sending a PUT request to /visitors will result in an update of an existing Visitor.
AsyncRawVisitorsClient	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 Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

AsyncVisitorsClient

public AsyncVisitorsClient(ClientOptions clientOptions)

Method Details

withRawResponse

public AsyncRawVisitorsClient withRawResponse()

Get responses with HTTP metadata like headers

find

public CompletableFuture<Visitor> find(FindVisitorRequest request)

You can fetch the details of a single visitor.

find

public CompletableFuture<Visitor> find(FindVisitorRequest request,
 RequestOptions requestOptions)

You can fetch the details of a single visitor.

update

public CompletableFuture<Visitor> update(UpdateVisitorRequest request)

Sending a PUT request to /visitors will result in an update of an existing Visitor.

Option 1. You can update a visitor by passing in the user_id of the visitor in the Request body.

Option 2. You can update a visitor by passing in the id of the visitor in the Request body.

update

public CompletableFuture<Visitor> update(UpdateVisitorRequest request,
 RequestOptions requestOptions)

Sending a PUT request to /visitors will result in an update of an existing Visitor.

Option 1. You can update a visitor by passing in the user_id of the visitor in the Request body.

Option 2. You can update a visitor by passing in the id of the visitor in the Request body.

mergeToContact

public CompletableFuture<Contact> mergeToContact(MergeVisitorToContactRequest request)

You can merge a Visitor to a Contact of role type lead or user.

📘 What happens upon a visitor being converted?

If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.

mergeToContact

public CompletableFuture<Contact> mergeToContact(MergeVisitorToContactRequest request,
 RequestOptions requestOptions)

You can merge a Visitor to a Contact of role type lead or user.

📘 What happens upon a visitor being converted?

If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.