Package com.intercom.api.resources.conversations.types

Class Conversation.Builder

java.lang.Object

com.intercom.api.resources.conversations.types.Conversation.Builder

All Implemented Interfaces:

Conversation._FinalStage, Conversation.ContactsStage, Conversation.CreatedAtStage, Conversation.IdStage, Conversation.OpenStage, Conversation.ReadStage, Conversation.SourceStage, Conversation.StateStage, Conversation.TeammatesStage, Conversation.UpdatedAtStage

Enclosing class:

Conversation

public static final class Conversation.Builder
extends Object
implements Conversation.IdStage, Conversation.CreatedAtStage, Conversation.UpdatedAtStage, Conversation.OpenStage, Conversation.StateStage, Conversation.ReadStage, Conversation.SourceStage, Conversation.ContactsStage, Conversation.TeammatesStage, Conversation._FinalStage

Method Summary

Modifier and Type	Method	Description
Conversation._FinalStage	adminAssigneeId(Integer adminAssigneeId)	The id of the admin assigned to the conversation.
Conversation._FinalStage	adminAssigneeId(Optional<Integer> adminAssigneeId)
Conversation._FinalStage	aiAgent(AiAgent aiAgent)
Conversation._FinalStage	aiAgent(Optional<AiAgent> aiAgent)
Conversation._FinalStage	aiAgentParticipated(Boolean aiAgentParticipated)	Indicates whether the AI Agent participated in the conversation.
Conversation._FinalStage	aiAgentParticipated(Optional<Boolean> aiAgentParticipated)
Conversation	build()
Conversation.TeammatesStage	contacts(ConversationContacts contacts)
Conversation._FinalStage	conversationParts(ConversationParts conversationParts)
Conversation._FinalStage	conversationParts(Optional<ConversationParts> conversationParts)
Conversation._FinalStage	conversationRating(ConversationRating conversationRating)
Conversation._FinalStage	conversationRating(Optional<ConversationRating> conversationRating)
Conversation.UpdatedAtStage	createdAt(int createdAt)	The time the conversation was created.
Conversation._FinalStage	customAttributes(String key, Object value)
Conversation._FinalStage	customAttributes(Map<String,Object> customAttributes)
Conversation._FinalStage	firstContactReply(ConversationFirstContactReply firstContactReply)
Conversation._FinalStage	firstContactReply(Optional<ConversationFirstContactReply> firstContactReply)
Conversation.Builder	from(Conversation other)
Conversation.CreatedAtStage	id(String id)	The id representing the conversation.
Conversation._FinalStage	linkedObjects(LinkedObjectList linkedObjects)
Conversation._FinalStage	linkedObjects(Optional<LinkedObjectList> linkedObjects)
Conversation.StateStage	open(boolean open)	Indicates whether a conversation is open (true) or closed (false).
Conversation._FinalStage	priority(Conversation.Priority priority)	If marked as priority, it will return priority or else not_priority.
Conversation._FinalStage	priority(Optional<Conversation.Priority> priority)
Conversation._FinalStage	putAllCustomAttributes(Map<String,Object> customAttributes)
Conversation.SourceStage	read(boolean read)	Indicates whether a conversation has been read.
Conversation._FinalStage	slaApplied(SlaApplied slaApplied)
Conversation._FinalStage	slaApplied(Optional<SlaApplied> slaApplied)
Conversation._FinalStage	snoozedUntil(Integer snoozedUntil)	If set this is the time in the future when this conversation will be marked as open.
Conversation._FinalStage	snoozedUntil(Optional<Integer> snoozedUntil)
Conversation.ContactsStage	source(ConversationSource source)
Conversation.ReadStage	state(Conversation.State state)	Can be set to "open", "closed" or "snoozed".
Conversation._FinalStage	statistics(ConversationStatistics statistics)
Conversation._FinalStage	statistics(Optional<ConversationStatistics> statistics)
Conversation._FinalStage	tags(Tags tags)
Conversation._FinalStage	tags(Optional<Tags> tags)
Conversation._FinalStage	teamAssigneeId(String teamAssigneeId)	The id of the team assigned to the conversation.
Conversation._FinalStage	teamAssigneeId(Optional<String> teamAssigneeId)
Conversation._FinalStage	teammates(ConversationTeammates teammates)
Conversation._FinalStage	title(String title)	The title given to the conversation.
Conversation._FinalStage	title(Optional<String> title)
Conversation._FinalStage	type(String type)	Always conversation.
Conversation._FinalStage	type(Optional<String> type)
Conversation.OpenStage	updatedAt(int updatedAt)	The last time the conversation was updated.
Conversation._FinalStage	waitingSince(Integer waitingSince)	The last time a Contact responded to an Admin.
Conversation._FinalStage	waitingSince(Optional<Integer> waitingSince)

Methods inherited from class java.lang.Object

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

Method Details

from

public Conversation.Builder from(Conversation other)

Specified by:

from in interface Conversation.IdStage

id

public Conversation.CreatedAtStage id(@NotNull
 String id)

The id representing the conversation.

Specified by:

id in interface Conversation.IdStage

Returns:

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

createdAt

public Conversation.UpdatedAtStage createdAt(int createdAt)

The time the conversation was created.

Specified by:

createdAt in interface Conversation.CreatedAtStage

Returns:

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

updatedAt

public Conversation.OpenStage updatedAt(int updatedAt)

The last time the conversation was updated.

Specified by:

updatedAt in interface Conversation.UpdatedAtStage

Returns:

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

open

public Conversation.StateStage open(boolean open)

Indicates whether a conversation is open (true) or closed (false).

Specified by:

open in interface Conversation.OpenStage

Returns:

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

state

public Conversation.ReadStage state(@NotNull
 Conversation.State state)

Can be set to "open", "closed" or "snoozed".

Specified by:

state in interface Conversation.StateStage

Returns:

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

read

public Conversation.SourceStage read(boolean read)

Indicates whether a conversation has been read.

Specified by:

read in interface Conversation.ReadStage

Returns:

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

source

public Conversation.ContactsStage source(@NotNull
 ConversationSource source)

Specified by:

source in interface Conversation.SourceStage

contacts

public Conversation.TeammatesStage contacts(@NotNull
 ConversationContacts contacts)

Specified by:

contacts in interface Conversation.ContactsStage

teammates

public Conversation._FinalStage teammates(@NotNull
 ConversationTeammates teammates)

Specified by:

teammates in interface Conversation.TeammatesStage

aiAgent

public Conversation._FinalStage aiAgent(AiAgent aiAgent)

Specified by:

aiAgent in interface Conversation._FinalStage

aiAgent

public Conversation._FinalStage aiAgent(Optional<AiAgent> aiAgent)

Specified by:

aiAgent in interface Conversation._FinalStage

aiAgentParticipated

public Conversation._FinalStage aiAgentParticipated(Boolean aiAgentParticipated)

Indicates whether the AI Agent participated in the conversation.

Specified by:

aiAgentParticipated in interface Conversation._FinalStage

Returns:

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

aiAgentParticipated

public Conversation._FinalStage aiAgentParticipated(Optional<Boolean> aiAgentParticipated)

Specified by:

aiAgentParticipated in interface Conversation._FinalStage

linkedObjects

public Conversation._FinalStage linkedObjects(LinkedObjectList linkedObjects)

Specified by:

linkedObjects in interface Conversation._FinalStage

linkedObjects

public Conversation._FinalStage linkedObjects(Optional<LinkedObjectList> linkedObjects)

Specified by:

linkedObjects in interface Conversation._FinalStage

conversationParts

public Conversation._FinalStage conversationParts(ConversationParts conversationParts)

Specified by:

conversationParts in interface Conversation._FinalStage

conversationParts

public Conversation._FinalStage conversationParts(Optional<ConversationParts> conversationParts)

Specified by:

conversationParts in interface Conversation._FinalStage

statistics

public Conversation._FinalStage statistics(ConversationStatistics statistics)

Specified by:

statistics in interface Conversation._FinalStage

statistics

public Conversation._FinalStage statistics(Optional<ConversationStatistics> statistics)

Specified by:

statistics in interface Conversation._FinalStage

slaApplied

public Conversation._FinalStage slaApplied(SlaApplied slaApplied)

Specified by:

slaApplied in interface Conversation._FinalStage

slaApplied

public Conversation._FinalStage slaApplied(Optional<SlaApplied> slaApplied)

Specified by:

slaApplied in interface Conversation._FinalStage

firstContactReply

public Conversation._FinalStage firstContactReply(ConversationFirstContactReply firstContactReply)

Specified by:

firstContactReply in interface Conversation._FinalStage

firstContactReply

public Conversation._FinalStage firstContactReply(Optional<ConversationFirstContactReply> firstContactReply)

Specified by:

firstContactReply in interface Conversation._FinalStage

customAttributes

public Conversation._FinalStage customAttributes(String key,
 Object value)

Specified by:

customAttributes in interface Conversation._FinalStage

putAllCustomAttributes

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

Specified by:

putAllCustomAttributes in interface Conversation._FinalStage

customAttributes

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

Specified by:

customAttributes in interface Conversation._FinalStage

conversationRating

public Conversation._FinalStage conversationRating(ConversationRating conversationRating)

Specified by:

conversationRating in interface Conversation._FinalStage

conversationRating

public Conversation._FinalStage conversationRating(Optional<ConversationRating> conversationRating)

Specified by:

conversationRating in interface Conversation._FinalStage

tags

public Conversation._FinalStage tags(Tags tags)

Specified by:

tags in interface Conversation._FinalStage

tags

public Conversation._FinalStage tags(Optional<Tags> tags)

Specified by:

tags in interface Conversation._FinalStage

teamAssigneeId

public Conversation._FinalStage teamAssigneeId(String teamAssigneeId)

The id of the team assigned to the conversation. If it's not assigned to a team it will return null.

Specified by:

teamAssigneeId in interface Conversation._FinalStage

Returns:

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

teamAssigneeId

public Conversation._FinalStage teamAssigneeId(Optional<String> teamAssigneeId)

Specified by:

teamAssigneeId in interface Conversation._FinalStage

adminAssigneeId

public Conversation._FinalStage adminAssigneeId(Integer adminAssigneeId)

The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.

Specified by:

adminAssigneeId in interface Conversation._FinalStage

Returns:

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

adminAssigneeId

public Conversation._FinalStage adminAssigneeId(Optional<Integer> adminAssigneeId)

Specified by:

adminAssigneeId in interface Conversation._FinalStage

priority

public Conversation._FinalStage priority(Conversation.Priority priority)

If marked as priority, it will return priority or else not_priority.

Specified by:

priority in interface Conversation._FinalStage

Returns:

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

priority

public Conversation._FinalStage priority(Optional<Conversation.Priority> priority)

Specified by:

priority in interface Conversation._FinalStage

snoozedUntil

public Conversation._FinalStage snoozedUntil(Integer snoozedUntil)

If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.

Specified by:

snoozedUntil in interface Conversation._FinalStage

Returns:

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

snoozedUntil

public Conversation._FinalStage snoozedUntil(Optional<Integer> snoozedUntil)

Specified by:

snoozedUntil in interface Conversation._FinalStage

waitingSince

public Conversation._FinalStage waitingSince(Integer waitingSince)

The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.

Specified by:

waitingSince in interface Conversation._FinalStage

Returns:

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

waitingSince

public Conversation._FinalStage waitingSince(Optional<Integer> waitingSince)

Specified by:

waitingSince in interface Conversation._FinalStage

title

public Conversation._FinalStage title(String title)

The title given to the conversation.

Specified by:

title in interface Conversation._FinalStage

Returns:

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

title

public Conversation._FinalStage title(Optional<String> title)

Specified by:

title in interface Conversation._FinalStage

type

public Conversation._FinalStage type(String type)

Always conversation.

Specified by:

type in interface Conversation._FinalStage

Returns:

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

type

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

Specified by:

type in interface Conversation._FinalStage

build

public Conversation build()

Specified by:

build in interface Conversation._FinalStage