Package com.intercom.api.resources.articles.requests

Class UpdateArticleRequest.Builder

java.lang.Object

com.intercom.api.resources.articles.requests.UpdateArticleRequest.Builder

All Implemented Interfaces:

UpdateArticleRequest._FinalStage, UpdateArticleRequest.ArticleIdStage

Enclosing class:

UpdateArticleRequest

public static final class UpdateArticleRequest.Builder
extends Object
implements UpdateArticleRequest.ArticleIdStage, UpdateArticleRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
UpdateArticleRequest._FinalStage	articleId(String articleId)	The unique identifier for the article which is given by Intercom.
UpdateArticleRequest._FinalStage	authorId(Integer authorId)	The id of the author of the article.
UpdateArticleRequest._FinalStage	authorId(Optional<Integer> authorId)
UpdateArticleRequest._FinalStage	body(String body)	The content of the article.
UpdateArticleRequest._FinalStage	body(Optional<String> body)
UpdateArticleRequest	build()
UpdateArticleRequest._FinalStage	description(String description)	The description of the article.
UpdateArticleRequest._FinalStage	description(Optional<String> description)
UpdateArticleRequest.Builder	from(UpdateArticleRequest other)
UpdateArticleRequest._FinalStage	parentId(String parentId)	The id of the article's parent collection or section.
UpdateArticleRequest._FinalStage	parentId(Optional<String> parentId)
UpdateArticleRequest._FinalStage	parentType(UpdateArticleRequest.ParentType parentType)	The type of parent, which can either be a collection or section.
UpdateArticleRequest._FinalStage	parentType(Optional<UpdateArticleRequest.ParentType> parentType)
UpdateArticleRequest._FinalStage	state(UpdateArticleRequest.State state)	Whether the article will be published or will be a draft.
UpdateArticleRequest._FinalStage	state(Optional<UpdateArticleRequest.State> state)
UpdateArticleRequest._FinalStage	title(String title)	The title of the article.For multilingual articles, this will be the title of the default language's content.
UpdateArticleRequest._FinalStage	title(Optional<String> title)
UpdateArticleRequest._FinalStage	translatedContent(ArticleTranslatedContent translatedContent)
UpdateArticleRequest._FinalStage	translatedContent(Optional<ArticleTranslatedContent> translatedContent)

Methods inherited from class java.lang.Object

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

Method Details

from

public UpdateArticleRequest.Builder from(UpdateArticleRequest other)

Specified by:

from in interface UpdateArticleRequest.ArticleIdStage

articleId

public UpdateArticleRequest._FinalStage articleId(@NotNull
 String articleId)

The unique identifier for the article which is given by Intercom.

Specified by:

articleId in interface UpdateArticleRequest.ArticleIdStage

Returns:

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

translatedContent

public UpdateArticleRequest._FinalStage translatedContent(ArticleTranslatedContent translatedContent)

Specified by:

translatedContent in interface UpdateArticleRequest._FinalStage

translatedContent

public UpdateArticleRequest._FinalStage translatedContent(Optional<ArticleTranslatedContent> translatedContent)

Specified by:

translatedContent in interface UpdateArticleRequest._FinalStage

parentType

public UpdateArticleRequest._FinalStage parentType(UpdateArticleRequest.ParentType parentType)

The type of parent, which can either be a collection or section.

Specified by:

parentType in interface UpdateArticleRequest._FinalStage

Returns:

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

parentType

public UpdateArticleRequest._FinalStage parentType(Optional<UpdateArticleRequest.ParentType> parentType)

Specified by:

parentType in interface UpdateArticleRequest._FinalStage

parentId

public UpdateArticleRequest._FinalStage parentId(String parentId)

The id of the article's parent collection or section. An article without this field stands alone.

Specified by:

parentId in interface UpdateArticleRequest._FinalStage

Returns:

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

parentId

public UpdateArticleRequest._FinalStage parentId(Optional<String> parentId)

Specified by:

parentId in interface UpdateArticleRequest._FinalStage

state

public UpdateArticleRequest._FinalStage state(UpdateArticleRequest.State state)

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

Specified by:

state in interface UpdateArticleRequest._FinalStage

Returns:

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

state

public UpdateArticleRequest._FinalStage state(Optional<UpdateArticleRequest.State> state)

Specified by:

state in interface UpdateArticleRequest._FinalStage

authorId

public UpdateArticleRequest._FinalStage authorId(Integer authorId)

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

Specified by:

authorId in interface UpdateArticleRequest._FinalStage

Returns:

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

authorId

public UpdateArticleRequest._FinalStage authorId(Optional<Integer> authorId)

Specified by:

authorId in interface UpdateArticleRequest._FinalStage

body

public UpdateArticleRequest._FinalStage body(String body)

The content of the article. For multilingual articles, this will be the body of the default language's content.

Specified by:

body in interface UpdateArticleRequest._FinalStage

Returns:

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

body

public UpdateArticleRequest._FinalStage body(Optional<String> body)

Specified by:

body in interface UpdateArticleRequest._FinalStage

description

public UpdateArticleRequest._FinalStage description(String description)

The description of the article. For multilingual articles, this will be the description of the default language's content.

Specified by:

description in interface UpdateArticleRequest._FinalStage

Returns:

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

description

public UpdateArticleRequest._FinalStage description(Optional<String> description)

Specified by:

description in interface UpdateArticleRequest._FinalStage

title

public UpdateArticleRequest._FinalStage title(String title)

The title of the article.For multilingual articles, this will be the title of the default language's content.

Specified by:

title in interface UpdateArticleRequest._FinalStage

Returns:

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

title

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

Specified by:

title in interface UpdateArticleRequest._FinalStage

build

public UpdateArticleRequest build()

Specified by:

build in interface UpdateArticleRequest._FinalStage