Package com.intercom.api.resources.visitors

Class VisitorsClient

java.lang.Object

com.intercom.api.resources.visitors.VisitorsClient

public class VisitorsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
VisitorsClient(ClientOptions clientOptions)

Method Summary

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

VisitorsClient

public VisitorsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawVisitorsClient withRawResponse()

Get responses with HTTP metadata like headers

find

public java.util.Optional<Visitor> find(FindVisitorRequest request)

You can fetch the details of a single visitor.

find

public java.util.Optional<Visitor> find(FindVisitorRequest request,
                                        RequestOptions requestOptions)

You can fetch the details of a single visitor.

update

public java.util.Optional<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 java.util.Optional<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 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 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.