Package com.intercom.api.types

Class Visitor.Builder

java.lang.Object

com.intercom.api.types.Visitor.Builder

All Implemented Interfaces:

Visitor._FinalStage, Visitor.AnonymousStage, Visitor.AppIdStage, Visitor.CreatedAtStage, Visitor.EmailStage, Visitor.IdStage, Visitor.SignedUpAtStage, Visitor.UserIdStage

Enclosing class:

Visitor

public static final class Visitor.Builder
extends Object
implements Visitor.IdStage, Visitor.UserIdStage, Visitor.AnonymousStage, Visitor.EmailStage, Visitor.AppIdStage, Visitor.CreatedAtStage, Visitor.SignedUpAtStage, Visitor._FinalStage

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

from

public Visitor.Builder from(Visitor other)

Specified by:

from in interface Visitor.IdStage

id

public Visitor.UserIdStage id(@NotNull
 String id)

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.AnonymousStage userId(@NotNull
 String userId)

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.

anonymous

public Visitor.EmailStage anonymous(boolean anonymous)

Identifies if this visitor is anonymous.

Specified by:

anonymous in interface Visitor.AnonymousStage

Returns:

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

email

public Visitor.AppIdStage email(@NotNull
 String email)

The email of the visitor.

Specified by:

email in interface Visitor.EmailStage

Returns:

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

appId

public Visitor.CreatedAtStage appId(@NotNull
 String appId)

The id of the app the visitor is associated with.

Specified by:

appId in interface Visitor.AppIdStage

Returns:

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

createdAt

public Visitor.SignedUpAtStage createdAt(int createdAt)

The time the Visitor was added to Intercom.

Specified by:

createdAt in interface Visitor.CreatedAtStage

Returns:

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

signedUpAt

public Visitor._FinalStage signedUpAt(int signedUpAt)

The time the Visitor signed up for your product.

Specified by:

signedUpAt in interface Visitor.SignedUpAtStage

Returns:

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

doNotTrack

public Visitor._FinalStage doNotTrack(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(Optional<Boolean> doNotTrack)

Specified by:

doNotTrack in interface Visitor._FinalStage

utmTerm

public Visitor._FinalStage utmTerm(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(Optional<String> utmTerm)

Specified by:

utmTerm in interface Visitor._FinalStage

utmSource

public Visitor._FinalStage utmSource(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(Optional<String> utmSource)

Specified by:

utmSource in interface Visitor._FinalStage

utmMedium

public Visitor._FinalStage utmMedium(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(Optional<String> utmMedium)

Specified by:

utmMedium in interface Visitor._FinalStage

utmContent

public Visitor._FinalStage utmContent(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(Optional<String> utmContent)

Specified by:

utmContent in interface Visitor._FinalStage

utmCampaign

public Visitor._FinalStage utmCampaign(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(Optional<String> utmCampaign)

Specified by:

utmCampaign in interface Visitor._FinalStage

referrer

public Visitor._FinalStage referrer(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(Optional<String> referrer)

Specified by:

referrer in interface Visitor._FinalStage

customAttributes

public Visitor._FinalStage customAttributes(Map<String,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(Optional<Map<String,Object>> customAttributes)

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(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(Optional<Visitor.Tags> tags)

Specified by:

tags in interface Visitor._FinalStage

hasHardBounced

public Visitor._FinalStage hasHardBounced(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(Optional<Boolean> hasHardBounced)

Specified by:

hasHardBounced in interface Visitor._FinalStage

markedEmailAsSpam

public Visitor._FinalStage markedEmailAsSpam(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(Optional<Boolean> markedEmailAsSpam)

Specified by:

markedEmailAsSpam in interface Visitor._FinalStage

unsubscribedFromEmails

public Visitor._FinalStage unsubscribedFromEmails(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(Optional<Boolean> unsubscribedFromEmails)

Specified by:

unsubscribedFromEmails in interface Visitor._FinalStage

ownerId

public Visitor._FinalStage ownerId(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(Optional<String> ownerId)

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(Optional<Visitor.SocialProfiles> socialProfiles)

Specified by:

socialProfiles in interface Visitor._FinalStage

sessionCount

public Visitor._FinalStage sessionCount(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(Optional<Integer> sessionCount)

Specified by:

sessionCount in interface Visitor._FinalStage

updatedAt

public Visitor._FinalStage updatedAt(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(Optional<Integer> updatedAt)

Specified by:

updatedAt in interface Visitor._FinalStage

remoteCreatedAt

public Visitor._FinalStage remoteCreatedAt(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(Optional<Integer> remoteCreatedAt)

Specified by:

remoteCreatedAt in interface Visitor._FinalStage

lasRequestAt

public Visitor._FinalStage lasRequestAt(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(Optional<Integer> lasRequestAt)

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(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(Optional<Visitor.Companies> companies)

Specified by:

companies in interface Visitor._FinalStage

avatar

public Visitor._FinalStage avatar(Visitor.Avatar avatar)

Specified by:

avatar in interface Visitor._FinalStage

avatar

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

Specified by:

avatar in interface Visitor._FinalStage

pseudonym

public Visitor._FinalStage pseudonym(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(Optional<String> pseudonym)

Specified by:

pseudonym in interface Visitor._FinalStage

name

public Visitor._FinalStage name(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(Optional<String> name)

Specified by:

name in interface Visitor._FinalStage

phone

public Visitor._FinalStage phone(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(Optional<String> phone)

Specified by:

phone in interface Visitor._FinalStage

build

public Visitor build()

Specified by:

build in interface Visitor._FinalStage