Package com.intercom.api.types

Class Visitor.Builder

java.lang.Object

com.intercom.api.types.Visitor.Builder

All Implemented Interfaces:

Visitor._FinalStage, Visitor.IdStage, Visitor.UserIdStage

Enclosing class:

Visitor

public static final class Visitor.Builder
extends java.lang.Object
implements Visitor.IdStage, Visitor.UserIdStage, Visitor._FinalStage

Method Summary

Modifier and Type	Method	Description
Visitor._FinalStage	anonymous(java.lang.Boolean anonymous)	Identifies if this visitor is anonymous.
Visitor._FinalStage	anonymous(java.util.Optional<java.lang.Boolean> anonymous)	Identifies if this visitor is anonymous.
Visitor._FinalStage	appId(java.lang.String appId)	The id of the app the visitor is associated with.
Visitor._FinalStage	appId(java.util.Optional<java.lang.String> appId)	The id of the app the visitor is associated with.
Visitor._FinalStage	avatar(Visitor.Avatar avatar)
Visitor._FinalStage	avatar(java.util.Optional<Visitor.Avatar> avatar)
Visitor	build()
Visitor._FinalStage	companies(Visitor.Companies companies)
Visitor._FinalStage	companies(java.util.Optional<Visitor.Companies> companies)
Visitor._FinalStage	createdAt(java.lang.Integer createdAt)	The time the Visitor was added to Intercom.
Visitor._FinalStage	createdAt(java.util.Optional<java.lang.Integer> createdAt)	The time the Visitor was added to Intercom.
Visitor._FinalStage	customAttributes(java.util.Map<java.lang.String,java.lang.Object> customAttributes)	The custom attributes you have set on the Visitor.
Visitor._FinalStage	customAttributes(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> customAttributes)	The custom attributes you have set on the Visitor.
Visitor._FinalStage	doNotTrack(java.lang.Boolean doNotTrack)	Identifies if this visitor has do not track enabled.
Visitor._FinalStage	doNotTrack(java.util.Optional<java.lang.Boolean> doNotTrack)	Identifies if this visitor has do not track enabled.
Visitor._FinalStage	email(java.lang.String email)	The email of the visitor.
Visitor._FinalStage	email(java.util.Optional<java.lang.String> email)	The email of the visitor.
Visitor.Builder	from(Visitor other)
Visitor._FinalStage	hasHardBounced(java.lang.Boolean hasHardBounced)	Identifies if this visitor has had a hard bounce.
Visitor._FinalStage	hasHardBounced(java.util.Optional<java.lang.Boolean> hasHardBounced)	Identifies if this visitor has had a hard bounce.
Visitor.UserIdStage	id(java.lang.String id)	The Intercom defined id representing the Visitor.
Visitor._FinalStage	lasRequestAt(java.lang.Integer lasRequestAt)	The time the Lead last recorded making a request.
Visitor._FinalStage	lasRequestAt(java.util.Optional<java.lang.Integer> lasRequestAt)	The time the Lead last recorded making a request.
Visitor._FinalStage	locationData(Visitor.LocationData locationData)
Visitor._FinalStage	locationData(java.util.Optional<Visitor.LocationData> locationData)
Visitor._FinalStage	markedEmailAsSpam(java.lang.Boolean markedEmailAsSpam)	Identifies if this visitor has marked an email as spam.
Visitor._FinalStage	markedEmailAsSpam(java.util.Optional<java.lang.Boolean> markedEmailAsSpam)	Identifies if this visitor has marked an email as spam.
Visitor._FinalStage	name(java.lang.String name)	The name of the visitor.
Visitor._FinalStage	name(java.util.Optional<java.lang.String> name)	The name of the visitor.
Visitor._FinalStage	ownerId(java.lang.String ownerId)	The id of the admin that owns the Visitor.
Visitor._FinalStage	ownerId(java.util.Optional<java.lang.String> ownerId)	The id of the admin that owns the Visitor.
Visitor._FinalStage	phone(java.lang.String phone)	The phone number of the visitor.
Visitor._FinalStage	phone(java.util.Optional<java.lang.String> phone)	The phone number of the visitor.
Visitor._FinalStage	pseudonym(java.lang.String pseudonym)	The pseudonym of the visitor.
Visitor._FinalStage	pseudonym(java.util.Optional<java.lang.String> pseudonym)	The pseudonym of the visitor.
Visitor._FinalStage	referrer(java.lang.String referrer)	The referer of the visitor.
Visitor._FinalStage	referrer(java.util.Optional<java.lang.String> referrer)	The referer of the visitor.
Visitor._FinalStage	remoteCreatedAt(java.lang.Integer remoteCreatedAt)	The time the Visitor was added to Intercom.
Visitor._FinalStage	remoteCreatedAt(java.util.Optional<java.lang.Integer> remoteCreatedAt)	The time the Visitor was added to Intercom.
Visitor._FinalStage	segments(Visitor.Segments segments)
Visitor._FinalStage	segments(java.util.Optional<Visitor.Segments> segments)
Visitor._FinalStage	sessionCount(java.lang.Integer sessionCount)	The number of sessions the Visitor has had.
Visitor._FinalStage	sessionCount(java.util.Optional<java.lang.Integer> sessionCount)	The number of sessions the Visitor has had.
Visitor._FinalStage	signedUpAt(java.lang.Integer signedUpAt)	The time the Visitor signed up for your product.
Visitor._FinalStage	signedUpAt(java.util.Optional<java.lang.Integer> signedUpAt)	The time the Visitor signed up for your product.
Visitor._FinalStage	socialProfiles(Visitor.SocialProfiles socialProfiles)
Visitor._FinalStage	socialProfiles(java.util.Optional<Visitor.SocialProfiles> socialProfiles)
Visitor._FinalStage	tags(Visitor.Tags tags)
Visitor._FinalStage	tags(java.util.Optional<Visitor.Tags> tags)
Visitor._FinalStage	unsubscribedFromEmails(java.lang.Boolean unsubscribedFromEmails)	Whether the Visitor is unsubscribed from emails.
Visitor._FinalStage	unsubscribedFromEmails(java.util.Optional<java.lang.Boolean> unsubscribedFromEmails)	Whether the Visitor is unsubscribed from emails.
Visitor._FinalStage	updatedAt(java.lang.Integer updatedAt)	The last time the Visitor was updated.
Visitor._FinalStage	updatedAt(java.util.Optional<java.lang.Integer> updatedAt)	The last time the Visitor was updated.
Visitor._FinalStage	userId(java.lang.String userId)	Automatically generated identifier for the Visitor.
Visitor._FinalStage	utmCampaign(java.lang.String utmCampaign)	The utm_campaign of the visitor.
Visitor._FinalStage	utmCampaign(java.util.Optional<java.lang.String> utmCampaign)	The utm_campaign of the visitor.
Visitor._FinalStage	utmContent(java.lang.String utmContent)	The utm_content of the visitor.
Visitor._FinalStage	utmContent(java.util.Optional<java.lang.String> utmContent)	The utm_content of the visitor.
Visitor._FinalStage	utmMedium(java.lang.String utmMedium)	The utm_medium of the visitor.
Visitor._FinalStage	utmMedium(java.util.Optional<java.lang.String> utmMedium)	The utm_medium of the visitor.
Visitor._FinalStage	utmSource(java.lang.String utmSource)	The utm_source of the visitor.
Visitor._FinalStage	utmSource(java.util.Optional<java.lang.String> utmSource)	The utm_source of the visitor.
Visitor._FinalStage	utmTerm(java.lang.String utmTerm)	The utm_term of the visitor.
Visitor._FinalStage	utmTerm(java.util.Optional<java.lang.String> utmTerm)	The utm_term of the visitor.

Methods inherited from class java.lang.Object

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

Method Detail

from

public Visitor.Builder from(Visitor other)

Specified by:

from in interface Visitor.IdStage

id

public Visitor.UserIdStage id(@NotNull
                              java.lang.String id)

The Intercom defined id representing the Visitor.

The Intercom defined id representing the Visitor.

Specified by:

id in interface Visitor.IdStage

Returns:

Reference to this so that method calls can be chained together.

userId

public Visitor._FinalStage userId(@NotNull
                                  java.lang.String userId)

Automatically generated identifier for the Visitor.

Automatically generated identifier for the Visitor.

Specified by:

userId in interface Visitor.UserIdStage

Returns:

Reference to this so that method calls can be chained together.

doNotTrack

public Visitor._FinalStage doNotTrack(java.lang.Boolean doNotTrack)

Identifies if this visitor has do not track enabled.

Specified by:

doNotTrack in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

doNotTrack

public Visitor._FinalStage doNotTrack(java.util.Optional<java.lang.Boolean> doNotTrack)

Identifies if this visitor has do not track enabled.

Specified by:

doNotTrack in interface Visitor._FinalStage

utmTerm

public Visitor._FinalStage utmTerm(java.lang.String utmTerm)

The utm_term of the visitor.

Specified by:

utmTerm in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

utmTerm

public Visitor._FinalStage utmTerm(java.util.Optional<java.lang.String> utmTerm)

The utm_term of the visitor.

Specified by:

utmTerm in interface Visitor._FinalStage

utmSource

public Visitor._FinalStage utmSource(java.lang.String utmSource)

The utm_source of the visitor.

Specified by:

utmSource in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

utmSource

public Visitor._FinalStage utmSource(java.util.Optional<java.lang.String> utmSource)

The utm_source of the visitor.

Specified by:

utmSource in interface Visitor._FinalStage

utmMedium

public Visitor._FinalStage utmMedium(java.lang.String utmMedium)

The utm_medium of the visitor.

Specified by:

utmMedium in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

utmMedium

public Visitor._FinalStage utmMedium(java.util.Optional<java.lang.String> utmMedium)

The utm_medium of the visitor.

Specified by:

utmMedium in interface Visitor._FinalStage

utmContent

public Visitor._FinalStage utmContent(java.lang.String utmContent)

The utm_content of the visitor.

Specified by:

utmContent in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

utmContent

public Visitor._FinalStage utmContent(java.util.Optional<java.lang.String> utmContent)

The utm_content of the visitor.

Specified by:

utmContent in interface Visitor._FinalStage

utmCampaign

public Visitor._FinalStage utmCampaign(java.lang.String utmCampaign)

The utm_campaign of the visitor.

Specified by:

utmCampaign in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

utmCampaign

public Visitor._FinalStage utmCampaign(java.util.Optional<java.lang.String> utmCampaign)

The utm_campaign of the visitor.

Specified by:

utmCampaign in interface Visitor._FinalStage

referrer

public Visitor._FinalStage referrer(java.lang.String referrer)

The referer of the visitor.

Specified by:

referrer in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

referrer

public Visitor._FinalStage referrer(java.util.Optional<java.lang.String> referrer)

The referer of the visitor.

Specified by:

referrer in interface Visitor._FinalStage

customAttributes

public Visitor._FinalStage customAttributes(java.util.Map<java.lang.String,java.lang.Object> customAttributes)

The custom attributes you have set on the Visitor.

Specified by:

customAttributes in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

customAttributes

public Visitor._FinalStage customAttributes(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> customAttributes)

The custom attributes you have set on the Visitor.

Specified by:

customAttributes in interface Visitor._FinalStage

segments

public Visitor._FinalStage segments(Visitor.Segments segments)

Specified by:

segments in interface Visitor._FinalStage

segments

public Visitor._FinalStage segments(java.util.Optional<Visitor.Segments> segments)

Specified by:

segments in interface Visitor._FinalStage

tags

public Visitor._FinalStage tags(Visitor.Tags tags)

Specified by:

tags in interface Visitor._FinalStage

tags

public Visitor._FinalStage tags(java.util.Optional<Visitor.Tags> tags)

Specified by:

tags in interface Visitor._FinalStage

hasHardBounced

public Visitor._FinalStage hasHardBounced(java.lang.Boolean hasHardBounced)

Identifies if this visitor has had a hard bounce.

Specified by:

hasHardBounced in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

hasHardBounced

public Visitor._FinalStage hasHardBounced(java.util.Optional<java.lang.Boolean> hasHardBounced)

Identifies if this visitor has had a hard bounce.

Specified by:

hasHardBounced in interface Visitor._FinalStage

markedEmailAsSpam

public Visitor._FinalStage markedEmailAsSpam(java.lang.Boolean markedEmailAsSpam)

Identifies if this visitor has marked an email as spam.

Specified by:

markedEmailAsSpam in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

markedEmailAsSpam

public Visitor._FinalStage markedEmailAsSpam(java.util.Optional<java.lang.Boolean> markedEmailAsSpam)

Identifies if this visitor has marked an email as spam.

Specified by:

markedEmailAsSpam in interface Visitor._FinalStage

unsubscribedFromEmails

public Visitor._FinalStage unsubscribedFromEmails(java.lang.Boolean unsubscribedFromEmails)

Whether the Visitor is unsubscribed from emails.

Specified by:

unsubscribedFromEmails in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

unsubscribedFromEmails

public Visitor._FinalStage unsubscribedFromEmails(java.util.Optional<java.lang.Boolean> unsubscribedFromEmails)

Whether the Visitor is unsubscribed from emails.

Specified by:

unsubscribedFromEmails in interface Visitor._FinalStage

ownerId

public Visitor._FinalStage ownerId(java.lang.String ownerId)

The id of the admin that owns the Visitor.

Specified by:

ownerId in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

ownerId

public Visitor._FinalStage ownerId(java.util.Optional<java.lang.String> ownerId)

The id of the admin that owns the Visitor.

Specified by:

ownerId in interface Visitor._FinalStage

socialProfiles

public Visitor._FinalStage socialProfiles(Visitor.SocialProfiles socialProfiles)

Specified by:

socialProfiles in interface Visitor._FinalStage

socialProfiles

public Visitor._FinalStage socialProfiles(java.util.Optional<Visitor.SocialProfiles> socialProfiles)

Specified by:

socialProfiles in interface Visitor._FinalStage

sessionCount

public Visitor._FinalStage sessionCount(java.lang.Integer sessionCount)

The number of sessions the Visitor has had.

Specified by:

sessionCount in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

sessionCount

public Visitor._FinalStage sessionCount(java.util.Optional<java.lang.Integer> sessionCount)

The number of sessions the Visitor has had.

Specified by:

sessionCount in interface Visitor._FinalStage

updatedAt

public Visitor._FinalStage updatedAt(java.lang.Integer updatedAt)

The last time the Visitor was updated.

Specified by:

updatedAt in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

updatedAt

public Visitor._FinalStage updatedAt(java.util.Optional<java.lang.Integer> updatedAt)

The last time the Visitor was updated.

Specified by:

updatedAt in interface Visitor._FinalStage

signedUpAt

public Visitor._FinalStage signedUpAt(java.lang.Integer signedUpAt)

The time the Visitor signed up for your product.

Specified by:

signedUpAt in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

signedUpAt

public Visitor._FinalStage signedUpAt(java.util.Optional<java.lang.Integer> signedUpAt)

The time the Visitor signed up for your product.

Specified by:

signedUpAt in interface Visitor._FinalStage

remoteCreatedAt

public Visitor._FinalStage remoteCreatedAt(java.lang.Integer remoteCreatedAt)

The time the Visitor was added to Intercom.

Specified by:

remoteCreatedAt in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

remoteCreatedAt

public Visitor._FinalStage remoteCreatedAt(java.util.Optional<java.lang.Integer> remoteCreatedAt)

The time the Visitor was added to Intercom.

Specified by:

remoteCreatedAt in interface Visitor._FinalStage

createdAt

public Visitor._FinalStage createdAt(java.lang.Integer createdAt)

The time the Visitor was added to Intercom.

Specified by:

createdAt in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public Visitor._FinalStage createdAt(java.util.Optional<java.lang.Integer> createdAt)

The time the Visitor was added to Intercom.

Specified by:

createdAt in interface Visitor._FinalStage

lasRequestAt

public Visitor._FinalStage lasRequestAt(java.lang.Integer lasRequestAt)

The time the Lead last recorded making a request.

Specified by:

lasRequestAt in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

lasRequestAt

public Visitor._FinalStage lasRequestAt(java.util.Optional<java.lang.Integer> lasRequestAt)

The time the Lead last recorded making a request.

Specified by:

lasRequestAt in interface Visitor._FinalStage

locationData

public Visitor._FinalStage locationData(Visitor.LocationData locationData)

Specified by:

locationData in interface Visitor._FinalStage

locationData

public Visitor._FinalStage locationData(java.util.Optional<Visitor.LocationData> locationData)

Specified by:

locationData in interface Visitor._FinalStage

companies

public Visitor._FinalStage companies(Visitor.Companies companies)

Specified by:

companies in interface Visitor._FinalStage

companies

public Visitor._FinalStage companies(java.util.Optional<Visitor.Companies> companies)

Specified by:

companies in interface Visitor._FinalStage

appId

public Visitor._FinalStage appId(java.lang.String appId)

The id of the app the visitor is associated with.

Specified by:

appId in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

appId

public Visitor._FinalStage appId(java.util.Optional<java.lang.String> appId)

The id of the app the visitor is associated with.

Specified by:

appId in interface Visitor._FinalStage

avatar

public Visitor._FinalStage avatar(Visitor.Avatar avatar)

Specified by:

avatar in interface Visitor._FinalStage

avatar

public Visitor._FinalStage avatar(java.util.Optional<Visitor.Avatar> avatar)

Specified by:

avatar in interface Visitor._FinalStage

pseudonym

public Visitor._FinalStage pseudonym(java.lang.String pseudonym)

The pseudonym of the visitor.

Specified by:

pseudonym in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

pseudonym

public Visitor._FinalStage pseudonym(java.util.Optional<java.lang.String> pseudonym)

The pseudonym of the visitor.

Specified by:

pseudonym in interface Visitor._FinalStage

name

public Visitor._FinalStage name(java.lang.String name)

The name of the visitor.

Specified by:

name in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

name

public Visitor._FinalStage name(java.util.Optional<java.lang.String> name)

The name of the visitor.

Specified by:

name in interface Visitor._FinalStage

phone

public Visitor._FinalStage phone(java.lang.String phone)

The phone number of the visitor.

Specified by:

phone in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

phone

public Visitor._FinalStage phone(java.util.Optional<java.lang.String> phone)

The phone number of the visitor.

Specified by:

phone in interface Visitor._FinalStage

email

public Visitor._FinalStage email(java.lang.String email)

The email of the visitor.

Specified by:

email in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

email

public Visitor._FinalStage email(java.util.Optional<java.lang.String> email)

The email of the visitor.

Specified by:

email in interface Visitor._FinalStage

anonymous

public Visitor._FinalStage anonymous(java.lang.Boolean anonymous)

Identifies if this visitor is anonymous.

Specified by:

anonymous in interface Visitor._FinalStage

Returns:

Reference to this so that method calls can be chained together.

anonymous

public Visitor._FinalStage anonymous(java.util.Optional<java.lang.Boolean> anonymous)

Identifies if this visitor is anonymous.

Specified by:

anonymous in interface Visitor._FinalStage

build

public Visitor build()

Specified by:

build in interface Visitor._FinalStage