Package com.intercom.api.types

Class DataExportCsv.Builder

java.lang.Object

com.intercom.api.types.DataExportCsv.Builder

All Implemented Interfaces:

DataExportCsv._FinalStage, DataExportCsv.CompanyIdStage, DataExportCsv.ContentIdStage, DataExportCsv.ContentTitleStage, DataExportCsv.ContentTypeStage, DataExportCsv.EmailStage, DataExportCsv.NameStage, DataExportCsv.RulesetIdStage, DataExportCsv.UserIdStage

Enclosing class:

DataExportCsv

public static final class DataExportCsv.Builder
extends Object
implements DataExportCsv.UserIdStage, DataExportCsv.CompanyIdStage, DataExportCsv.EmailStage, DataExportCsv.NameStage, DataExportCsv.RulesetIdStage, DataExportCsv.ContentIdStage, DataExportCsv.ContentTypeStage, DataExportCsv.ContentTitleStage, DataExportCsv._FinalStage

Method Summary

Modifier and Type	Method	Description
DataExportCsv	build()
DataExportCsv.EmailStage	companyId(String companyId)	The company ID of the user in relation to the message that was sent.
DataExportCsv.ContentTypeStage	contentId(String contentId)	The specific content that was received.
DataExportCsv._FinalStage	contentTitle(String contentTitle)	The title of the content you see in your Intercom workspace.
DataExportCsv.ContentTitleStage	contentType(String contentType)	Email, Chat, Post etc.
DataExportCsv.NameStage	email(String email)	The users email who was sent the message.
DataExportCsv._FinalStage	firstClick(Integer firstClick)	The first time the series the user clicked on a link within this message.
DataExportCsv._FinalStage	firstClick(Optional<Integer> firstClick)
DataExportCsv._FinalStage	firstCompletion(Integer firstCompletion)	The first time a user completed this message if the content was able to be completed e.g.
DataExportCsv._FinalStage	firstCompletion(Optional<Integer> firstCompletion)
DataExportCsv._FinalStage	firstDismisall(Integer firstDismisall)	The first time the series the user dismissed this message.
DataExportCsv._FinalStage	firstDismisall(Optional<Integer> firstDismisall)
DataExportCsv._FinalStage	firstGoalSuccess(Integer firstGoalSuccess)	The first time the user met this messages associated goal if one exists.
DataExportCsv._FinalStage	firstGoalSuccess(Optional<Integer> firstGoalSuccess)
DataExportCsv._FinalStage	firstHardBounce(Integer firstHardBounce)	The first time this message hard bounced for this user
DataExportCsv._FinalStage	firstHardBounce(Optional<Integer> firstHardBounce)
DataExportCsv._FinalStage	firstOpen(Integer firstOpen)	The first time the user opened this message.
DataExportCsv._FinalStage	firstOpen(Optional<Integer> firstOpen)
DataExportCsv._FinalStage	firstReply(Integer firstReply)	The first time a user replied to this message if the content was able to receive replies.
DataExportCsv._FinalStage	firstReply(Optional<Integer> firstReply)
DataExportCsv._FinalStage	firstSeriesCompletion(Integer firstSeriesCompletion)	The first time the series this message was a part of was completed by the user.
DataExportCsv._FinalStage	firstSeriesCompletion(Optional<Integer> firstSeriesCompletion)
DataExportCsv._FinalStage	firstSeriesDisengagement(Integer firstSeriesDisengagement)	The first time the series this message was a part of was disengaged by the user.
DataExportCsv._FinalStage	firstSeriesDisengagement(Optional<Integer> firstSeriesDisengagement)
DataExportCsv._FinalStage	firstSeriesExit(Integer firstSeriesExit)	The first time the series this message was a part of was exited by the user.
DataExportCsv._FinalStage	firstSeriesExit(Optional<Integer> firstSeriesExit)
DataExportCsv._FinalStage	firstUnsubscribe(Integer firstUnsubscribe)	The first time the user unsubscribed from this message.
DataExportCsv._FinalStage	firstUnsubscribe(Optional<Integer> firstUnsubscribe)
DataExportCsv.Builder	from(DataExportCsv other)
DataExportCsv.RulesetIdStage	name(String name)	The full name of the user receiving the message
DataExportCsv._FinalStage	nodeId(String nodeId)	The id of the series node that this ruleset is associated with.
DataExportCsv._FinalStage	nodeId(Optional<String> nodeId)
DataExportCsv._FinalStage	receiptId(String receiptId)	ID for this receipt.
DataExportCsv._FinalStage	receiptId(Optional<String> receiptId)
DataExportCsv._FinalStage	receivedAt(Integer receivedAt)	Timestamp for when the receipt was recorded.
DataExportCsv._FinalStage	receivedAt(Optional<Integer> receivedAt)
DataExportCsv.ContentIdStage	rulesetId(String rulesetId)	The id of the message.
DataExportCsv._FinalStage	rulesetVersionId(String rulesetVersionId)	As you edit content we record new versions.
DataExportCsv._FinalStage	rulesetVersionId(Optional<String> rulesetVersionId)
DataExportCsv._FinalStage	seriesId(String seriesId)	The id of the series that this content is part of.
DataExportCsv._FinalStage	seriesId(Optional<String> seriesId)
DataExportCsv._FinalStage	seriesTitle(String seriesTitle)	The title of the series that this content is part of.
DataExportCsv._FinalStage	seriesTitle(Optional<String> seriesTitle)
DataExportCsv._FinalStage	userExternalId(String userExternalId)	The external_user_id of the user who was sent the message
DataExportCsv._FinalStage	userExternalId(Optional<String> userExternalId)
DataExportCsv.CompanyIdStage	userId(String userId)	The user_id of the user who was sent the message.

Methods inherited from class java.lang.Object

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

Method Details

from

public DataExportCsv.Builder from(DataExportCsv other)

Specified by:

from in interface DataExportCsv.UserIdStage

userId

public DataExportCsv.CompanyIdStage userId(@NotNull
 String userId)

The user_id of the user who was sent the message.

Specified by:

userId in interface DataExportCsv.UserIdStage

Returns:

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

companyId

public DataExportCsv.EmailStage companyId(@NotNull
 String companyId)

The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.

Specified by:

companyId in interface DataExportCsv.CompanyIdStage

Returns:

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

email

public DataExportCsv.NameStage email(@NotNull
 String email)

The users email who was sent the message.

Specified by:

email in interface DataExportCsv.EmailStage

Returns:

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

name

public DataExportCsv.RulesetIdStage name(@NotNull
 String name)

The full name of the user receiving the message

Specified by:

name in interface DataExportCsv.NameStage

Returns:

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

rulesetId

public DataExportCsv.ContentIdStage rulesetId(@NotNull
 String rulesetId)

The id of the message.

Specified by:

rulesetId in interface DataExportCsv.RulesetIdStage

Returns:

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

contentId

public DataExportCsv.ContentTypeStage contentId(@NotNull
 String contentId)

The specific content that was received. In an A/B test each version has its own Content ID.

Specified by:

contentId in interface DataExportCsv.ContentIdStage

Returns:

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

contentType

public DataExportCsv.ContentTitleStage contentType(@NotNull
 String contentType)

Email, Chat, Post etc.

Specified by:

contentType in interface DataExportCsv.ContentTypeStage

Returns:

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

contentTitle

public DataExportCsv._FinalStage contentTitle(@NotNull
 String contentTitle)

The title of the content you see in your Intercom workspace.

Specified by:

contentTitle in interface DataExportCsv.ContentTitleStage

Returns:

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

firstHardBounce

public DataExportCsv._FinalStage firstHardBounce(Integer firstHardBounce)

The first time this message hard bounced for this user

Specified by:

firstHardBounce in interface DataExportCsv._FinalStage

Returns:

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

firstHardBounce

public DataExportCsv._FinalStage firstHardBounce(Optional<Integer> firstHardBounce)

Specified by:

firstHardBounce in interface DataExportCsv._FinalStage

firstUnsubscribe

public DataExportCsv._FinalStage firstUnsubscribe(Integer firstUnsubscribe)

The first time the user unsubscribed from this message.

Specified by:

firstUnsubscribe in interface DataExportCsv._FinalStage

Returns:

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

firstUnsubscribe

public DataExportCsv._FinalStage firstUnsubscribe(Optional<Integer> firstUnsubscribe)

Specified by:

firstUnsubscribe in interface DataExportCsv._FinalStage

firstDismisall

public DataExportCsv._FinalStage firstDismisall(Integer firstDismisall)

The first time the series the user dismissed this message.

Specified by:

firstDismisall in interface DataExportCsv._FinalStage

Returns:

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

firstDismisall

public DataExportCsv._FinalStage firstDismisall(Optional<Integer> firstDismisall)

Specified by:

firstDismisall in interface DataExportCsv._FinalStage

firstClick

public DataExportCsv._FinalStage firstClick(Integer firstClick)

The first time the series the user clicked on a link within this message.

Specified by:

firstClick in interface DataExportCsv._FinalStage

Returns:

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

firstClick

public DataExportCsv._FinalStage firstClick(Optional<Integer> firstClick)

Specified by:

firstClick in interface DataExportCsv._FinalStage

firstOpen

public DataExportCsv._FinalStage firstOpen(Integer firstOpen)

The first time the user opened this message.

Specified by:

firstOpen in interface DataExportCsv._FinalStage

Returns:

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

firstOpen

public DataExportCsv._FinalStage firstOpen(Optional<Integer> firstOpen)

Specified by:

firstOpen in interface DataExportCsv._FinalStage

firstGoalSuccess

public DataExportCsv._FinalStage firstGoalSuccess(Integer firstGoalSuccess)

The first time the user met this messages associated goal if one exists.

Specified by:

firstGoalSuccess in interface DataExportCsv._FinalStage

Returns:

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

firstGoalSuccess

public DataExportCsv._FinalStage firstGoalSuccess(Optional<Integer> firstGoalSuccess)

Specified by:

firstGoalSuccess in interface DataExportCsv._FinalStage

firstSeriesExit

public DataExportCsv._FinalStage firstSeriesExit(Integer firstSeriesExit)

The first time the series this message was a part of was exited by the user.

Specified by:

firstSeriesExit in interface DataExportCsv._FinalStage

Returns:

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

firstSeriesExit

public DataExportCsv._FinalStage firstSeriesExit(Optional<Integer> firstSeriesExit)

Specified by:

firstSeriesExit in interface DataExportCsv._FinalStage

firstSeriesDisengagement

public DataExportCsv._FinalStage firstSeriesDisengagement(Integer firstSeriesDisengagement)

The first time the series this message was a part of was disengaged by the user.

Specified by:

firstSeriesDisengagement in interface DataExportCsv._FinalStage

Returns:

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

firstSeriesDisengagement

public DataExportCsv._FinalStage firstSeriesDisengagement(Optional<Integer> firstSeriesDisengagement)

Specified by:

firstSeriesDisengagement in interface DataExportCsv._FinalStage

firstSeriesCompletion

public DataExportCsv._FinalStage firstSeriesCompletion(Integer firstSeriesCompletion)

The first time the series this message was a part of was completed by the user.

Specified by:

firstSeriesCompletion in interface DataExportCsv._FinalStage

Returns:

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

firstSeriesCompletion

public DataExportCsv._FinalStage firstSeriesCompletion(Optional<Integer> firstSeriesCompletion)

Specified by:

firstSeriesCompletion in interface DataExportCsv._FinalStage

firstCompletion

public DataExportCsv._FinalStage firstCompletion(Integer firstCompletion)

The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.

Specified by:

firstCompletion in interface DataExportCsv._FinalStage

Returns:

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

firstCompletion

public DataExportCsv._FinalStage firstCompletion(Optional<Integer> firstCompletion)

Specified by:

firstCompletion in interface DataExportCsv._FinalStage

firstReply

public DataExportCsv._FinalStage firstReply(Integer firstReply)

The first time a user replied to this message if the content was able to receive replies.

Specified by:

firstReply in interface DataExportCsv._FinalStage

Returns:

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

firstReply

public DataExportCsv._FinalStage firstReply(Optional<Integer> firstReply)

Specified by:

firstReply in interface DataExportCsv._FinalStage

nodeId

public DataExportCsv._FinalStage nodeId(String nodeId)

The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.

Specified by:

nodeId in interface DataExportCsv._FinalStage

Returns:

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

nodeId

public DataExportCsv._FinalStage nodeId(Optional<String> nodeId)

Specified by:

nodeId in interface DataExportCsv._FinalStage

seriesTitle

public DataExportCsv._FinalStage seriesTitle(String seriesTitle)

The title of the series that this content is part of.

Specified by:

seriesTitle in interface DataExportCsv._FinalStage

Returns:

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

seriesTitle

public DataExportCsv._FinalStage seriesTitle(Optional<String> seriesTitle)

Specified by:

seriesTitle in interface DataExportCsv._FinalStage

seriesId

public DataExportCsv._FinalStage seriesId(String seriesId)

The id of the series that this content is part of. Will return -1 if not part of a series.

Specified by:

seriesId in interface DataExportCsv._FinalStage

Returns:

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

seriesId

public DataExportCsv._FinalStage seriesId(Optional<String> seriesId)

Specified by:

seriesId in interface DataExportCsv._FinalStage

receivedAt

public DataExportCsv._FinalStage receivedAt(Integer receivedAt)

Timestamp for when the receipt was recorded.

Specified by:

receivedAt in interface DataExportCsv._FinalStage

Returns:

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

receivedAt

public DataExportCsv._FinalStage receivedAt(Optional<Integer> receivedAt)

Specified by:

receivedAt in interface DataExportCsv._FinalStage

receiptId

public DataExportCsv._FinalStage receiptId(String receiptId)

ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.

Specified by:

receiptId in interface DataExportCsv._FinalStage

Returns:

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

receiptId

public DataExportCsv._FinalStage receiptId(Optional<String> receiptId)

Specified by:

receiptId in interface DataExportCsv._FinalStage

rulesetVersionId

public DataExportCsv._FinalStage rulesetVersionId(String rulesetVersionId)

As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.

Specified by:

rulesetVersionId in interface DataExportCsv._FinalStage

Returns:

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

rulesetVersionId

public DataExportCsv._FinalStage rulesetVersionId(Optional<String> rulesetVersionId)

Specified by:

rulesetVersionId in interface DataExportCsv._FinalStage

userExternalId

public DataExportCsv._FinalStage userExternalId(String userExternalId)

The external_user_id of the user who was sent the message

Specified by:

userExternalId in interface DataExportCsv._FinalStage

Returns:

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

userExternalId

public DataExportCsv._FinalStage userExternalId(Optional<String> userExternalId)

Specified by:

userExternalId in interface DataExportCsv._FinalStage

build

public DataExportCsv build()

Specified by:

build in interface DataExportCsv._FinalStage