Package com.intercom.api.resources.unstable.aicontent.types

Class ExternalPage.Builder

java.lang.Object

com.intercom.api.resources.unstable.aicontent.types.ExternalPage.Builder

All Implemented Interfaces:

ExternalPage._FinalStage, ExternalPage.AiAgentAvailabilityStage, ExternalPage.AiCopilotAvailabilityStage, ExternalPage.CreatedAtStage, ExternalPage.ExternalIdStage, ExternalPage.HtmlStage, ExternalPage.IdStage, ExternalPage.LastIngestedAtStage, ExternalPage.SourceIdStage, ExternalPage.TitleStage, ExternalPage.UpdatedAtStage

Enclosing class:

ExternalPage

public static final class ExternalPage.Builder
extends java.lang.Object
implements ExternalPage.IdStage, ExternalPage.TitleStage, ExternalPage.HtmlStage, ExternalPage.AiAgentAvailabilityStage, ExternalPage.AiCopilotAvailabilityStage, ExternalPage.SourceIdStage, ExternalPage.ExternalIdStage, ExternalPage.CreatedAtStage, ExternalPage.UpdatedAtStage, ExternalPage.LastIngestedAtStage, ExternalPage._FinalStage

Method Summary

Modifier and Type	Method	Description
ExternalPage.AiCopilotAvailabilityStage	aiAgentAvailability(boolean aiAgentAvailability)	Whether the external page should be used to answer questions by AI Agent.
ExternalPage.SourceIdStage	aiCopilotAvailability(boolean aiCopilotAvailability)	Whether the external page should be used to answer questions by AI Copilot.
ExternalPage	build()
ExternalPage.UpdatedAtStage	createdAt(int createdAt)	The time when the external page was created.
ExternalPage.CreatedAtStage	externalId(java.lang.String externalId)	The identifier for the external page which was given by the source.
ExternalPage._FinalStage	finAvailability(java.lang.Boolean finAvailability)	Deprecated.
ExternalPage._FinalStage	finAvailability(java.util.Optional<java.lang.Boolean> finAvailability)	Deprecated.
ExternalPage.Builder	from(ExternalPage other)
ExternalPage.AiAgentAvailabilityStage	html(java.lang.String html)	The body of the external page in HTML.
ExternalPage.TitleStage	id(java.lang.String id)	The unique identifier for the external page which is given by Intercom.
ExternalPage._FinalStage	lastIngestedAt(int lastIngestedAt)	The time when the external page was last ingested.
ExternalPage.ExternalIdStage	sourceId(int sourceId)	The unique identifier for the source of the external page which was given by Intercom.
ExternalPage.HtmlStage	title(java.lang.String title)	The title of the external page.
ExternalPage.LastIngestedAtStage	updatedAt(int updatedAt)	The time when the external page was last updated.
ExternalPage._FinalStage	url(java.lang.String url)	The URL of the external page.
ExternalPage._FinalStage	url(java.util.Optional<java.lang.String> url)	The URL of the external page.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ExternalPage.Builder from(ExternalPage other)

Specified by:

from in interface ExternalPage.IdStage

id

public ExternalPage.TitleStage id(@NotNull
                                  java.lang.String id)

The unique identifier for the external page which is given by Intercom.

The unique identifier for the external page which is given by Intercom.

Specified by:

id in interface ExternalPage.IdStage

Returns:

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

title

public ExternalPage.HtmlStage title(@NotNull
                                    java.lang.String title)

The title of the external page.

The title of the external page.

Specified by:

title in interface ExternalPage.TitleStage

Returns:

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

html

public ExternalPage.AiAgentAvailabilityStage html(@NotNull
                                                  java.lang.String html)

The body of the external page in HTML.

The body of the external page in HTML.

Specified by:

html in interface ExternalPage.HtmlStage

Returns:

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

aiAgentAvailability

public ExternalPage.AiCopilotAvailabilityStage aiAgentAvailability(boolean aiAgentAvailability)

Whether the external page should be used to answer questions by AI Agent.

Whether the external page should be used to answer questions by AI Agent.

Specified by:

aiAgentAvailability in interface ExternalPage.AiAgentAvailabilityStage

Returns:

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

aiCopilotAvailability

public ExternalPage.SourceIdStage aiCopilotAvailability(boolean aiCopilotAvailability)

Whether the external page should be used to answer questions by AI Copilot.

Whether the external page should be used to answer questions by AI Copilot.

Specified by:

aiCopilotAvailability in interface ExternalPage.AiCopilotAvailabilityStage

Returns:

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

sourceId

public ExternalPage.ExternalIdStage sourceId(int sourceId)

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Specified by:

sourceId in interface ExternalPage.SourceIdStage

Returns:

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

externalId

public ExternalPage.CreatedAtStage externalId(@NotNull
                                              java.lang.String externalId)

The identifier for the external page which was given by the source. Must be unique for the source.

The identifier for the external page which was given by the source. Must be unique for the source.

Specified by:

externalId in interface ExternalPage.ExternalIdStage

Returns:

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

createdAt

public ExternalPage.UpdatedAtStage createdAt(int createdAt)

The time when the external page was created.

The time when the external page was created.

Specified by:

createdAt in interface ExternalPage.CreatedAtStage

Returns:

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

updatedAt

public ExternalPage.LastIngestedAtStage updatedAt(int updatedAt)

The time when the external page was last updated.

The time when the external page was last updated.

Specified by:

updatedAt in interface ExternalPage.UpdatedAtStage

Returns:

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

lastIngestedAt

public ExternalPage._FinalStage lastIngestedAt(int lastIngestedAt)

The time when the external page was last ingested.

The time when the external page was last ingested.

Specified by:

lastIngestedAt in interface ExternalPage.LastIngestedAtStage

Returns:

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

finAvailability

public ExternalPage._FinalStage finAvailability(java.lang.Boolean finAvailability)

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Specified by:

finAvailability in interface ExternalPage._FinalStage

Returns:

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

finAvailability

public ExternalPage._FinalStage finAvailability(java.util.Optional<java.lang.Boolean> finAvailability)

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

Specified by:

finAvailability in interface ExternalPage._FinalStage

url

public ExternalPage._FinalStage url(java.lang.String url)

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Specified by:

url in interface ExternalPage._FinalStage

Returns:

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

url

public ExternalPage._FinalStage url(java.util.Optional<java.lang.String> url)

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Specified by:

url in interface ExternalPage._FinalStage

build

public ExternalPage build()

Specified by:

build in interface ExternalPage._FinalStage