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.TypeStage, Conversation.UpdatedAtStage

Enclosing class:

Conversation

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

Method Summary

Modifier and Type	Method	Description
Conversation._FinalStage	adminAssigneeId(java.lang.Integer adminAssigneeId)	The id of the admin assigned to the conversation.
Conversation._FinalStage	adminAssigneeId(java.util.Optional<java.lang.Integer> adminAssigneeId)	The id of the admin assigned to the conversation.
Conversation._FinalStage	aiAgent(AiAgent aiAgent)
Conversation._FinalStage	aiAgent(java.util.Optional<AiAgent> aiAgent)
Conversation._FinalStage	aiAgentParticipated(java.lang.Boolean aiAgentParticipated)	Indicates whether the AI Agent participated in the conversation.
Conversation._FinalStage	aiAgentParticipated(java.util.Optional<java.lang.Boolean> aiAgentParticipated)	Indicates whether the AI Agent participated in the conversation.
Conversation	build()
Conversation._FinalStage	companyId(java.lang.String companyId)	The ID of the company that the conversation is associated with.
Conversation._FinalStage	companyId(java.util.Optional<java.lang.String> companyId)	The ID of the company that the conversation is associated with.
Conversation._FinalStage	contacts(ConversationContacts contacts)
Conversation._FinalStage	conversationParts(ConversationParts conversationParts)
Conversation._FinalStage	conversationParts(java.util.Optional<ConversationParts> conversationParts)
Conversation._FinalStage	conversationRating(ConversationRating conversationRating)
Conversation._FinalStage	conversationRating(java.util.Optional<ConversationRating> conversationRating)
Conversation.UpdatedAtStage	createdAt(int createdAt)	The time the conversation was created.
Conversation._FinalStage	customAttributes(java.lang.String key, Conversation.CustomAttributesValue value)
Conversation._FinalStage	customAttributes(java.util.Map<java.lang.String,Conversation.CustomAttributesValue> customAttributes)
Conversation._FinalStage	firstContactReply(ConversationFirstContactReply firstContactReply)
Conversation._FinalStage	firstContactReply(java.util.Optional<ConversationFirstContactReply> firstContactReply)
Conversation.Builder	from(Conversation other)
Conversation.CreatedAtStage	id(java.lang.String id)	The id representing the conversation.
Conversation._FinalStage	linkedObjects(LinkedObjectList linkedObjects)
Conversation._FinalStage	linkedObjects(java.util.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(java.util.Optional<Conversation.Priority> priority)	If marked as priority, it will return priority or else not_priority.
Conversation._FinalStage	putAllCustomAttributes(java.util.Map<java.lang.String,Conversation.CustomAttributesValue> customAttributes)
Conversation.SourceStage	read(boolean read)	Indicates whether a conversation has been read.
Conversation._FinalStage	slaApplied(SlaApplied slaApplied)
Conversation._FinalStage	slaApplied(java.util.Optional<SlaApplied> slaApplied)
Conversation._FinalStage	snoozedUntil(java.lang.Integer snoozedUntil)	If set this is the time in the future when this conversation will be marked as open.
Conversation._FinalStage	snoozedUntil(java.util.Optional<java.lang.Integer> snoozedUntil)	If set this is the time in the future when this conversation will be marked as open.
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(java.util.Optional<ConversationStatistics> statistics)
Conversation._FinalStage	tags(Tags tags)
Conversation._FinalStage	tags(java.util.Optional<Tags> tags)
Conversation._FinalStage	teamAssigneeId(java.lang.String teamAssigneeId)	The id of the team assigned to the conversation.
Conversation._FinalStage	teamAssigneeId(java.util.Optional<java.lang.String> teamAssigneeId)	The id of the team assigned to the conversation.
Conversation._FinalStage	teammates(ConversationTeammates teammates)
Conversation._FinalStage	teammates(java.util.Optional<ConversationTeammates> teammates)
Conversation._FinalStage	title(java.lang.String title)	The title given to the conversation.
Conversation._FinalStage	title(java.util.Optional<java.lang.String> title)	The title given to the conversation.
Conversation.IdStage	type(java.lang.String type)	Always conversation.
Conversation.OpenStage	updatedAt(int updatedAt)	The last time the conversation was updated.
Conversation._FinalStage	waitingSince(java.lang.Integer waitingSince)	The last time a Contact responded to an Admin.
Conversation._FinalStage	waitingSince(java.util.Optional<java.lang.Integer> waitingSince)	The last time a Contact responded to an Admin.

Methods inherited from class java.lang.Object

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

Method Detail

from

public Conversation.Builder from(Conversation other)

Specified by:

from in interface Conversation.TypeStage

type

public Conversation.IdStage type(@NotNull
                                 java.lang.String type)

Always conversation.

Always conversation.

Specified by:

type in interface Conversation.TypeStage

Returns:

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

id

public Conversation.CreatedAtStage id(@NotNull
                                      java.lang.String id)

The id representing the conversation.

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.

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.

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).

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".

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.

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._FinalStage contacts(@NotNull
                                         ConversationContacts contacts)

Specified by:

contacts in interface Conversation.ContactsStage

aiAgent

public Conversation._FinalStage aiAgent(AiAgent aiAgent)

Specified by:

aiAgent in interface Conversation._FinalStage

aiAgent

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

Specified by:

aiAgent in interface Conversation._FinalStage

aiAgentParticipated

public Conversation._FinalStage aiAgentParticipated(java.lang.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(java.util.Optional<java.lang.Boolean> aiAgentParticipated)

Indicates whether the AI Agent participated in the conversation.

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(java.util.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(java.util.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(java.util.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(java.util.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(java.util.Optional<ConversationFirstContactReply> firstContactReply)

Specified by:

firstContactReply in interface Conversation._FinalStage

customAttributes

public Conversation._FinalStage customAttributes(java.lang.String key,
                                                 Conversation.CustomAttributesValue value)

Specified by:

customAttributes in interface Conversation._FinalStage

putAllCustomAttributes

public Conversation._FinalStage putAllCustomAttributes(java.util.Map<java.lang.String,Conversation.CustomAttributesValue> customAttributes)

Specified by:

putAllCustomAttributes in interface Conversation._FinalStage

customAttributes

public Conversation._FinalStage customAttributes(java.util.Map<java.lang.String,Conversation.CustomAttributesValue> customAttributes)

Specified by:

customAttributes in interface Conversation._FinalStage

teammates

public Conversation._FinalStage teammates(ConversationTeammates teammates)

Specified by:

teammates in interface Conversation._FinalStage

teammates

public Conversation._FinalStage teammates(java.util.Optional<ConversationTeammates> teammates)

Specified by:

teammates in interface Conversation._FinalStage

conversationRating

public Conversation._FinalStage conversationRating(ConversationRating conversationRating)

Specified by:

conversationRating in interface Conversation._FinalStage

conversationRating

public Conversation._FinalStage conversationRating(java.util.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(java.util.Optional<Tags> tags)

Specified by:

tags in interface Conversation._FinalStage

companyId

public Conversation._FinalStage companyId(java.lang.String companyId)

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom.

Specified by:

companyId in interface Conversation._FinalStage

Returns:

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

companyId

public Conversation._FinalStage companyId(java.util.Optional<java.lang.String> companyId)

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom.

Specified by:

companyId in interface Conversation._FinalStage

teamAssigneeId

public Conversation._FinalStage teamAssigneeId(java.lang.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(java.util.Optional<java.lang.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

adminAssigneeId

public Conversation._FinalStage adminAssigneeId(java.lang.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(java.util.Optional<java.lang.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

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(java.util.Optional<Conversation.Priority> priority)

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

Specified by:

priority in interface Conversation._FinalStage

snoozedUntil

public Conversation._FinalStage snoozedUntil(java.lang.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(java.util.Optional<java.lang.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

waitingSince

public Conversation._FinalStage waitingSince(java.lang.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(java.util.Optional<java.lang.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

title

public Conversation._FinalStage title(java.lang.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(java.util.Optional<java.lang.String> title)

The title given to the conversation.

Specified by:

title in interface Conversation._FinalStage

build

public Conversation build()

Specified by:

build in interface Conversation._FinalStage