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

Class UpdateArticleRequest

java.lang.Object

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

public final class UpdateArticleRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateArticleRequest._FinalStage
static interface	UpdateArticleRequest.ArticleIdStage
static class	UpdateArticleRequest.Builder
static class	UpdateArticleRequest.State

Method Summary

Modifier and Type	Method	Description
static UpdateArticleRequest.ArticleIdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
int	getArticleId()
java.util.Optional<java.lang.Integer>	getAuthorId()
java.util.Optional<java.lang.String>	getBody()
java.util.Optional<java.lang.String>	getDescription()
java.util.Optional<java.lang.String>	getParentId()
java.util.Optional<java.lang.String>	getParentType()
java.util.Optional<UpdateArticleRequest.State>	getState()
java.util.Optional<java.lang.String>	getTitle()
java.util.Optional<ArticleTranslatedContent>	getTranslatedContent()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getArticleId

public int getArticleId()

Returns:

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

getTitle

public java.util.Optional<java.lang.String> getTitle()

Returns:

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

getDescription

public java.util.Optional<java.lang.String> getDescription()

Returns:

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

getBody

public java.util.Optional<java.lang.String> getBody()

Returns:

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

getAuthorId

public java.util.Optional<java.lang.Integer> getAuthorId()

Returns:

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.

getState

public java.util.Optional<UpdateArticleRequest.State> getState()

Returns:

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.

getParentId

public java.util.Optional<java.lang.String> getParentId()

Returns:

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

getParentType

public java.util.Optional<java.lang.String> getParentType()

Returns:

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

getTranslatedContent

public java.util.Optional<ArticleTranslatedContent> getTranslatedContent()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static UpdateArticleRequest.ArticleIdStage builder()