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

Class CreateExternalPageRequest.Builder

java.lang.Object

com.intercom.api.resources.unstable.aicontent.requests.CreateExternalPageRequest.Builder

All Implemented Interfaces:

CreateExternalPageRequest._FinalStage, CreateExternalPageRequest.ExternalIdStage, CreateExternalPageRequest.HtmlStage, CreateExternalPageRequest.SourceIdStage, CreateExternalPageRequest.TitleStage

Enclosing class:

CreateExternalPageRequest

public static final class CreateExternalPageRequest.Builder
extends java.lang.Object
implements CreateExternalPageRequest.TitleStage, CreateExternalPageRequest.HtmlStage, CreateExternalPageRequest.SourceIdStage, CreateExternalPageRequest.ExternalIdStage, CreateExternalPageRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
CreateExternalPageRequest._FinalStage	aiAgentAvailability(java.lang.Boolean aiAgentAvailability)	Whether the external page should be used to answer questions by AI Agent.
CreateExternalPageRequest._FinalStage	aiAgentAvailability(java.util.Optional<java.lang.Boolean> aiAgentAvailability)	Whether the external page should be used to answer questions by AI Agent.
CreateExternalPageRequest._FinalStage	aiCopilotAvailability(java.lang.Boolean aiCopilotAvailability)	Whether the external page should be used to answer questions by AI Copilot.
CreateExternalPageRequest._FinalStage	aiCopilotAvailability(java.util.Optional<java.lang.Boolean> aiCopilotAvailability)	Whether the external page should be used to answer questions by AI Copilot.
CreateExternalPageRequest	build()
CreateExternalPageRequest._FinalStage	externalId(java.lang.String externalId)	The identifier for the external page which was given by the source.
CreateExternalPageRequest.Builder	from(CreateExternalPageRequest other)
CreateExternalPageRequest.SourceIdStage	html(java.lang.String html)	The body of the external page in HTML.
CreateExternalPageRequest.ExternalIdStage	sourceId(int sourceId)	The unique identifier for the source of the external page which was given by Intercom.
CreateExternalPageRequest.HtmlStage	title(java.lang.String title)	The title of the external page.
CreateExternalPageRequest._FinalStage	url(java.lang.String url)	The URL of the external page.
CreateExternalPageRequest._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 CreateExternalPageRequest.Builder from(CreateExternalPageRequest other)

Specified by:

from in interface CreateExternalPageRequest.TitleStage

title

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

The title of the external page.

The title of the external page.

Specified by:

title in interface CreateExternalPageRequest.TitleStage

Returns:

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

html

public CreateExternalPageRequest.SourceIdStage 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 CreateExternalPageRequest.HtmlStage

Returns:

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

sourceId

public CreateExternalPageRequest.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 CreateExternalPageRequest.SourceIdStage

Returns:

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

externalId

public CreateExternalPageRequest._FinalStage 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 CreateExternalPageRequest.ExternalIdStage

Returns:

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

aiCopilotAvailability

public CreateExternalPageRequest._FinalStage aiCopilotAvailability(java.lang.Boolean aiCopilotAvailability)

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

Specified by:

aiCopilotAvailability in interface CreateExternalPageRequest._FinalStage

Returns:

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

aiCopilotAvailability

public CreateExternalPageRequest._FinalStage aiCopilotAvailability(java.util.Optional<java.lang.Boolean> aiCopilotAvailability)

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

Specified by:

aiCopilotAvailability in interface CreateExternalPageRequest._FinalStage

aiAgentAvailability

public CreateExternalPageRequest._FinalStage aiAgentAvailability(java.lang.Boolean aiAgentAvailability)

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

Specified by:

aiAgentAvailability in interface CreateExternalPageRequest._FinalStage

Returns:

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

aiAgentAvailability

public CreateExternalPageRequest._FinalStage aiAgentAvailability(java.util.Optional<java.lang.Boolean> aiAgentAvailability)

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

Specified by:

aiAgentAvailability in interface CreateExternalPageRequest._FinalStage

url

public CreateExternalPageRequest._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. When a URL is not present, Fin will not reference the source.

Specified by:

url in interface CreateExternalPageRequest._FinalStage

Returns:

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

url

public CreateExternalPageRequest._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. When a URL is not present, Fin will not reference the source.

Specified by:

url in interface CreateExternalPageRequest._FinalStage

build

public CreateExternalPageRequest build()

Specified by:

build in interface CreateExternalPageRequest._FinalStage