Package com.intercom.api.resources.contacts.types

Class Contact.Builder

java.lang.Object

com.intercom.api.resources.contacts.types.Contact.Builder

All Implemented Interfaces:

Contact._FinalStage, Contact.CreatedAtStage, Contact.HasHardBouncedStage, Contact.IdStage, Contact.LocationStage, Contact.MarkedEmailAsSpamStage, Contact.RoleStage, Contact.SocialProfilesStage, Contact.UnsubscribedFromEmailsStage, Contact.UpdatedAtStage, Contact.WorkspaceIdStage

Enclosing class:

Contact

public static final class Contact.Builder
extends Object
implements Contact.IdStage, Contact.WorkspaceIdStage, Contact.RoleStage, Contact.HasHardBouncedStage, Contact.MarkedEmailAsSpamStage, Contact.UnsubscribedFromEmailsStage, Contact.CreatedAtStage, Contact.UpdatedAtStage, Contact.LocationStage, Contact.SocialProfilesStage, Contact._FinalStage

Method Summary

Modifier and Type	Method	Description
Contact._FinalStage	androidAppName(String androidAppName)	The name of the Android app which the contact is using.
Contact._FinalStage	androidAppName(Optional<String> androidAppName)
Contact._FinalStage	androidAppVersion(String androidAppVersion)	The version of the Android app which the contact is using.
Contact._FinalStage	androidAppVersion(Optional<String> androidAppVersion)
Contact._FinalStage	androidDevice(String androidDevice)	The Android device which the contact is using.
Contact._FinalStage	androidDevice(Optional<String> androidDevice)
Contact._FinalStage	androidLastSeenAt(Integer androidLastSeenAt)	(UNIX timestamp) The time when the contact was last seen on an Android device.
Contact._FinalStage	androidLastSeenAt(Optional<Integer> androidLastSeenAt)
Contact._FinalStage	androidOsVersion(String androidOsVersion)	The version of the Android OS which the contact is using.
Contact._FinalStage	androidOsVersion(Optional<String> androidOsVersion)
Contact._FinalStage	androidSdkVersion(String androidSdkVersion)	The version of the Android SDK which the contact is using.
Contact._FinalStage	androidSdkVersion(Optional<String> androidSdkVersion)
Contact._FinalStage	avatar(String avatar)	An image URL containing the avatar of a contact.
Contact._FinalStage	avatar(Optional<String> avatar)
Contact._FinalStage	browser(String browser)	The name of the browser which the contact is using.
Contact._FinalStage	browser(Optional<String> browser)
Contact._FinalStage	browserLanguage(String browserLanguage)	The language set by the browser which the contact is using.
Contact._FinalStage	browserLanguage(Optional<String> browserLanguage)
Contact._FinalStage	browserVersion(String browserVersion)	The version of the browser which the contact is using.
Contact._FinalStage	browserVersion(Optional<String> browserVersion)
Contact	build()
Contact._FinalStage	companies(ContactCompanies companies)
Contact._FinalStage	companies(Optional<ContactCompanies> companies)
Contact.UpdatedAtStage	createdAt(int createdAt)	(UNIX timestamp) The time when the contact was created.
Contact._FinalStage	customAttributes(Map<String,Object> customAttributes)	The custom attributes which are set for the contact.
Contact._FinalStage	customAttributes(Optional<Map<String,Object>> customAttributes)
Contact._FinalStage	email(String email)	The contact's email.
Contact._FinalStage	email(Optional<String> email)
Contact._FinalStage	emailDomain(String emailDomain)	The contact's email domain.
Contact._FinalStage	emailDomain(Optional<String> emailDomain)
Contact._FinalStage	externalId(String externalId)	The unique identifier for the contact which is provided by the Client.
Contact._FinalStage	externalId(Optional<String> externalId)
Contact._FinalStage	formattedPhone(String formattedPhone)	The contacts phone number normalized to the E164 format
Contact._FinalStage	formattedPhone(Optional<String> formattedPhone)
Contact.Builder	from(Contact other)
Contact.MarkedEmailAsSpamStage	hasHardBounced(boolean hasHardBounced)	Whether the contact has had an email sent to them hard bounce.
Contact.WorkspaceIdStage	id(String id)	The unique identifier for the contact which is given by Intercom.
Contact._FinalStage	iosAppName(String iosAppName)	The name of the iOS app which the contact is using.
Contact._FinalStage	iosAppName(Optional<String> iosAppName)
Contact._FinalStage	iosAppVersion(String iosAppVersion)	The version of the iOS app which the contact is using.
Contact._FinalStage	iosAppVersion(Optional<String> iosAppVersion)
Contact._FinalStage	iosDevice(String iosDevice)	The iOS device which the contact is using.
Contact._FinalStage	iosDevice(Optional<String> iosDevice)
Contact._FinalStage	iosLastSeenAt(Integer iosLastSeenAt)	(UNIX timestamp) The last time the contact used the iOS app.
Contact._FinalStage	iosLastSeenAt(Optional<Integer> iosLastSeenAt)
Contact._FinalStage	iosOsVersion(String iosOsVersion)	The version of iOS which the contact is using.
Contact._FinalStage	iosOsVersion(Optional<String> iosOsVersion)
Contact._FinalStage	iosSdkVersion(String iosSdkVersion)	The version of the iOS SDK which the contact is using.
Contact._FinalStage	iosSdkVersion(Optional<String> iosSdkVersion)
Contact._FinalStage	languageOverride(String languageOverride)	A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.
Contact._FinalStage	languageOverride(Optional<String> languageOverride)
Contact._FinalStage	lastContactedAt(Integer lastContactedAt)	(UNIX timestamp) The time when the contact was last messaged.
Contact._FinalStage	lastContactedAt(Optional<Integer> lastContactedAt)
Contact._FinalStage	lastEmailClickedAt(Integer lastEmailClickedAt)	(UNIX timestamp) The time when the contact last clicked a link in an email.
Contact._FinalStage	lastEmailClickedAt(Optional<Integer> lastEmailClickedAt)
Contact._FinalStage	lastEmailOpenedAt(Integer lastEmailOpenedAt)	(UNIX timestamp) The time when the contact last opened an email.
Contact._FinalStage	lastEmailOpenedAt(Optional<Integer> lastEmailOpenedAt)
Contact._FinalStage	lastRepliedAt(Integer lastRepliedAt)	(UNIX timestamp) The time when the contact last messaged in.
Contact._FinalStage	lastRepliedAt(Optional<Integer> lastRepliedAt)
Contact._FinalStage	lastSeenAt(Integer lastSeenAt)	(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
Contact._FinalStage	lastSeenAt(Optional<Integer> lastSeenAt)
Contact.SocialProfilesStage	location(ContactLocation location)
Contact.UnsubscribedFromEmailsStage	markedEmailAsSpam(boolean markedEmailAsSpam)	Whether the contact has marked an email sent to them as spam.
Contact._FinalStage	name(String name)	The contacts name.
Contact._FinalStage	name(Optional<String> name)
Contact._FinalStage	notes(ContactNotes notes)
Contact._FinalStage	notes(Optional<ContactNotes> notes)
Contact._FinalStage	os(String os)	The operating system which the contact is using.
Contact._FinalStage	os(Optional<String> os)
Contact._FinalStage	ownerId(Integer ownerId)	The id of an admin that has been assigned account ownership of the contact.
Contact._FinalStage	ownerId(Optional<Integer> ownerId)
Contact._FinalStage	phone(String phone)	The contacts phone.
Contact._FinalStage	phone(Optional<String> phone)
Contact.HasHardBouncedStage	role(String role)	The role of the contact.
Contact._FinalStage	signedUpAt(Integer signedUpAt)	(UNIX timestamp) The time specified for when a contact signed up.
Contact._FinalStage	signedUpAt(Optional<Integer> signedUpAt)
Contact._FinalStage	socialProfiles(ContactSocialProfiles socialProfiles)
Contact._FinalStage	tags(ContactTags tags)
Contact._FinalStage	tags(Optional<ContactTags> tags)
Contact._FinalStage	type(String type)	The type of object.
Contact._FinalStage	type(Optional<String> type)
Contact.CreatedAtStage	unsubscribedFromEmails(boolean unsubscribedFromEmails)	Whether the contact is unsubscribed from emails.
Contact.LocationStage	updatedAt(int updatedAt)	(UNIX timestamp) The time when the contact was last updated.
Contact.RoleStage	workspaceId(String workspaceId)	The id of the workspace which the contact belongs to.

Methods inherited from class java.lang.Object

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

Method Details

from

public Contact.Builder from(Contact other)

Specified by:

from in interface Contact.IdStage

id

public Contact.WorkspaceIdStage id(@NotNull
 String id)

The unique identifier for the contact which is given by Intercom.

Specified by:

id in interface Contact.IdStage

Returns:

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

workspaceId

public Contact.RoleStage workspaceId(@NotNull
 String workspaceId)

The id of the workspace which the contact belongs to.

Specified by:

workspaceId in interface Contact.WorkspaceIdStage

Returns:

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

role

public Contact.HasHardBouncedStage role(@NotNull
 String role)

The role of the contact.

Specified by:

role in interface Contact.RoleStage

Returns:

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

hasHardBounced

public Contact.MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced)

Whether the contact has had an email sent to them hard bounce.

Specified by:

hasHardBounced in interface Contact.HasHardBouncedStage

Returns:

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

markedEmailAsSpam

public Contact.UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam)

Whether the contact has marked an email sent to them as spam.

Specified by:

markedEmailAsSpam in interface Contact.MarkedEmailAsSpamStage

Returns:

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

unsubscribedFromEmails

public Contact.CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails)

Whether the contact is unsubscribed from emails.

Specified by:

unsubscribedFromEmails in interface Contact.UnsubscribedFromEmailsStage

Returns:

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

createdAt

public Contact.UpdatedAtStage createdAt(int createdAt)

(UNIX timestamp) The time when the contact was created.

Specified by:

createdAt in interface Contact.CreatedAtStage

Returns:

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

updatedAt

public Contact.LocationStage updatedAt(int updatedAt)

(UNIX timestamp) The time when the contact was last updated.

Specified by:

updatedAt in interface Contact.UpdatedAtStage

Returns:

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

location

public Contact.SocialProfilesStage location(@NotNull
 ContactLocation location)

Specified by:

location in interface Contact.LocationStage

socialProfiles

public Contact._FinalStage socialProfiles(@NotNull
 ContactSocialProfiles socialProfiles)

Specified by:

socialProfiles in interface Contact.SocialProfilesStage

companies

public Contact._FinalStage companies(ContactCompanies companies)

Specified by:

companies in interface Contact._FinalStage

companies

public Contact._FinalStage companies(Optional<ContactCompanies> companies)

Specified by:

companies in interface Contact._FinalStage

notes

public Contact._FinalStage notes(ContactNotes notes)

Specified by:

notes in interface Contact._FinalStage

notes

public Contact._FinalStage notes(Optional<ContactNotes> notes)

Specified by:

notes in interface Contact._FinalStage

tags

public Contact._FinalStage tags(ContactTags tags)

Specified by:

tags in interface Contact._FinalStage

tags

public Contact._FinalStage tags(Optional<ContactTags> tags)

Specified by:

tags in interface Contact._FinalStage

avatar

public Contact._FinalStage avatar(String avatar)

An image URL containing the avatar of a contact.

Specified by:

avatar in interface Contact._FinalStage

Returns:

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

avatar

public Contact._FinalStage avatar(Optional<String> avatar)

Specified by:

avatar in interface Contact._FinalStage

customAttributes

public Contact._FinalStage customAttributes(Map<String,Object> customAttributes)

The custom attributes which are set for the contact.

Specified by:

customAttributes in interface Contact._FinalStage

Returns:

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

customAttributes

public Contact._FinalStage customAttributes(Optional<Map<String,Object>> customAttributes)

Specified by:

customAttributes in interface Contact._FinalStage

iosLastSeenAt

public Contact._FinalStage iosLastSeenAt(Integer iosLastSeenAt)

(UNIX timestamp) The last time the contact used the iOS app.

Specified by:

iosLastSeenAt in interface Contact._FinalStage

Returns:

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

iosLastSeenAt

public Contact._FinalStage iosLastSeenAt(Optional<Integer> iosLastSeenAt)

Specified by:

iosLastSeenAt in interface Contact._FinalStage

iosSdkVersion

public Contact._FinalStage iosSdkVersion(String iosSdkVersion)

The version of the iOS SDK which the contact is using.

Specified by:

iosSdkVersion in interface Contact._FinalStage

Returns:

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

iosSdkVersion

public Contact._FinalStage iosSdkVersion(Optional<String> iosSdkVersion)

Specified by:

iosSdkVersion in interface Contact._FinalStage

iosOsVersion

public Contact._FinalStage iosOsVersion(String iosOsVersion)

The version of iOS which the contact is using.

Specified by:

iosOsVersion in interface Contact._FinalStage

Returns:

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

iosOsVersion

public Contact._FinalStage iosOsVersion(Optional<String> iosOsVersion)

Specified by:

iosOsVersion in interface Contact._FinalStage

iosDevice

public Contact._FinalStage iosDevice(String iosDevice)

The iOS device which the contact is using.

Specified by:

iosDevice in interface Contact._FinalStage

Returns:

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

iosDevice

public Contact._FinalStage iosDevice(Optional<String> iosDevice)

Specified by:

iosDevice in interface Contact._FinalStage

iosAppVersion

public Contact._FinalStage iosAppVersion(String iosAppVersion)

The version of the iOS app which the contact is using.

Specified by:

iosAppVersion in interface Contact._FinalStage

Returns:

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

iosAppVersion

public Contact._FinalStage iosAppVersion(Optional<String> iosAppVersion)

Specified by:

iosAppVersion in interface Contact._FinalStage

iosAppName

public Contact._FinalStage iosAppName(String iosAppName)

The name of the iOS app which the contact is using.

Specified by:

iosAppName in interface Contact._FinalStage

Returns:

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

iosAppName

public Contact._FinalStage iosAppName(Optional<String> iosAppName)

Specified by:

iosAppName in interface Contact._FinalStage

androidLastSeenAt

public Contact._FinalStage androidLastSeenAt(Integer androidLastSeenAt)

(UNIX timestamp) The time when the contact was last seen on an Android device.

Specified by:

androidLastSeenAt in interface Contact._FinalStage

Returns:

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

androidLastSeenAt

public Contact._FinalStage androidLastSeenAt(Optional<Integer> androidLastSeenAt)

Specified by:

androidLastSeenAt in interface Contact._FinalStage

androidSdkVersion

public Contact._FinalStage androidSdkVersion(String androidSdkVersion)

The version of the Android SDK which the contact is using.

Specified by:

androidSdkVersion in interface Contact._FinalStage

Returns:

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

androidSdkVersion

public Contact._FinalStage androidSdkVersion(Optional<String> androidSdkVersion)

Specified by:

androidSdkVersion in interface Contact._FinalStage

androidOsVersion

public Contact._FinalStage androidOsVersion(String androidOsVersion)

The version of the Android OS which the contact is using.

Specified by:

androidOsVersion in interface Contact._FinalStage

Returns:

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

androidOsVersion

public Contact._FinalStage androidOsVersion(Optional<String> androidOsVersion)

Specified by:

androidOsVersion in interface Contact._FinalStage

androidDevice

public Contact._FinalStage androidDevice(String androidDevice)

The Android device which the contact is using.

Specified by:

androidDevice in interface Contact._FinalStage

Returns:

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

androidDevice

public Contact._FinalStage androidDevice(Optional<String> androidDevice)

Specified by:

androidDevice in interface Contact._FinalStage

androidAppVersion

public Contact._FinalStage androidAppVersion(String androidAppVersion)

The version of the Android app which the contact is using.

Specified by:

androidAppVersion in interface Contact._FinalStage

Returns:

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

androidAppVersion

public Contact._FinalStage androidAppVersion(Optional<String> androidAppVersion)

Specified by:

androidAppVersion in interface Contact._FinalStage

androidAppName

public Contact._FinalStage androidAppName(String androidAppName)

The name of the Android app which the contact is using.

Specified by:

androidAppName in interface Contact._FinalStage

Returns:

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

androidAppName

public Contact._FinalStage androidAppName(Optional<String> androidAppName)

Specified by:

androidAppName in interface Contact._FinalStage

os

public Contact._FinalStage os(String os)

The operating system which the contact is using.

Specified by:

os in interface Contact._FinalStage

Returns:

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

os

public Contact._FinalStage os(Optional<String> os)

Specified by:

os in interface Contact._FinalStage

browserLanguage

public Contact._FinalStage browserLanguage(String browserLanguage)

The language set by the browser which the contact is using.

Specified by:

browserLanguage in interface Contact._FinalStage

Returns:

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

browserLanguage

public Contact._FinalStage browserLanguage(Optional<String> browserLanguage)

Specified by:

browserLanguage in interface Contact._FinalStage

browserVersion

public Contact._FinalStage browserVersion(String browserVersion)

The version of the browser which the contact is using.

Specified by:

browserVersion in interface Contact._FinalStage

Returns:

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

browserVersion

public Contact._FinalStage browserVersion(Optional<String> browserVersion)

Specified by:

browserVersion in interface Contact._FinalStage

browser

public Contact._FinalStage browser(String browser)

The name of the browser which the contact is using.

Specified by:

browser in interface Contact._FinalStage

Returns:

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

browser

public Contact._FinalStage browser(Optional<String> browser)

Specified by:

browser in interface Contact._FinalStage

languageOverride

public Contact._FinalStage languageOverride(String languageOverride)

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

Specified by:

languageOverride in interface Contact._FinalStage

Returns:

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

languageOverride

public Contact._FinalStage languageOverride(Optional<String> languageOverride)

Specified by:

languageOverride in interface Contact._FinalStage

lastEmailClickedAt

public Contact._FinalStage lastEmailClickedAt(Integer lastEmailClickedAt)

(UNIX timestamp) The time when the contact last clicked a link in an email.

Specified by:

lastEmailClickedAt in interface Contact._FinalStage

Returns:

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

lastEmailClickedAt

public Contact._FinalStage lastEmailClickedAt(Optional<Integer> lastEmailClickedAt)

Specified by:

lastEmailClickedAt in interface Contact._FinalStage

lastEmailOpenedAt

public Contact._FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt)

(UNIX timestamp) The time when the contact last opened an email.

Specified by:

lastEmailOpenedAt in interface Contact._FinalStage

Returns:

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

lastEmailOpenedAt

public Contact._FinalStage lastEmailOpenedAt(Optional<Integer> lastEmailOpenedAt)

Specified by:

lastEmailOpenedAt in interface Contact._FinalStage

lastContactedAt

public Contact._FinalStage lastContactedAt(Integer lastContactedAt)

(UNIX timestamp) The time when the contact was last messaged.

Specified by:

lastContactedAt in interface Contact._FinalStage

Returns:

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

lastContactedAt

public Contact._FinalStage lastContactedAt(Optional<Integer> lastContactedAt)

Specified by:

lastContactedAt in interface Contact._FinalStage

lastRepliedAt

public Contact._FinalStage lastRepliedAt(Integer lastRepliedAt)

(UNIX timestamp) The time when the contact last messaged in.

Specified by:

lastRepliedAt in interface Contact._FinalStage

Returns:

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

lastRepliedAt

public Contact._FinalStage lastRepliedAt(Optional<Integer> lastRepliedAt)

Specified by:

lastRepliedAt in interface Contact._FinalStage

lastSeenAt

public Contact._FinalStage lastSeenAt(Integer lastSeenAt)

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

Specified by:

lastSeenAt in interface Contact._FinalStage

Returns:

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

lastSeenAt

public Contact._FinalStage lastSeenAt(Optional<Integer> lastSeenAt)

Specified by:

lastSeenAt in interface Contact._FinalStage

signedUpAt

public Contact._FinalStage signedUpAt(Integer signedUpAt)

(UNIX timestamp) The time specified for when a contact signed up.

Specified by:

signedUpAt in interface Contact._FinalStage

Returns:

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

signedUpAt

public Contact._FinalStage signedUpAt(Optional<Integer> signedUpAt)

Specified by:

signedUpAt in interface Contact._FinalStage

ownerId

public Contact._FinalStage ownerId(Integer ownerId)

The id of an admin that has been assigned account ownership of the contact.

Specified by:

ownerId in interface Contact._FinalStage

Returns:

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

ownerId

public Contact._FinalStage ownerId(Optional<Integer> ownerId)

Specified by:

ownerId in interface Contact._FinalStage

name

public Contact._FinalStage name(String name)

The contacts name.

Specified by:

name in interface Contact._FinalStage

Returns:

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

name

public Contact._FinalStage name(Optional<String> name)

Specified by:

name in interface Contact._FinalStage

formattedPhone

public Contact._FinalStage formattedPhone(String formattedPhone)

The contacts phone number normalized to the E164 format

Specified by:

formattedPhone in interface Contact._FinalStage

Returns:

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

formattedPhone

public Contact._FinalStage formattedPhone(Optional<String> formattedPhone)

Specified by:

formattedPhone in interface Contact._FinalStage

phone

public Contact._FinalStage phone(String phone)

The contacts phone.

Specified by:

phone in interface Contact._FinalStage

Returns:

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

phone

public Contact._FinalStage phone(Optional<String> phone)

Specified by:

phone in interface Contact._FinalStage

emailDomain

public Contact._FinalStage emailDomain(String emailDomain)

The contact's email domain.

Specified by:

emailDomain in interface Contact._FinalStage

Returns:

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

emailDomain

public Contact._FinalStage emailDomain(Optional<String> emailDomain)

Specified by:

emailDomain in interface Contact._FinalStage

email

public Contact._FinalStage email(String email)

The contact's email.

Specified by:

email in interface Contact._FinalStage

Returns:

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

email

public Contact._FinalStage email(Optional<String> email)

Specified by:

email in interface Contact._FinalStage

externalId

public Contact._FinalStage externalId(String externalId)

The unique identifier for the contact which is provided by the Client.

Specified by:

externalId in interface Contact._FinalStage

Returns:

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

externalId

public Contact._FinalStage externalId(Optional<String> externalId)

Specified by:

externalId in interface Contact._FinalStage

type

public Contact._FinalStage type(String type)

The type of object.

Specified by:

type in interface Contact._FinalStage

Returns:

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

type

public Contact._FinalStage type(Optional<String> type)

Specified by:

type in interface Contact._FinalStage

build

public Contact build()

Specified by:

build in interface Contact._FinalStage