Package com.intercom.api.resources.unstable.articles

Class ArticlesClient

java.lang.Object

com.intercom.api.resources.unstable.articles.ArticlesClient

public class ArticlesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ArticlesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Article	createArticle(java.lang.Object request)	You can create a new article by making a POST request to https://api.intercom.io/articles.
Article	createArticle(java.lang.Object request, RequestOptions requestOptions)	You can create a new article by making a POST request to https://api.intercom.io/articles.
DeletedArticleObject	deleteArticle(DeleteArticleRequest request)	You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.
DeletedArticleObject	deleteArticle(DeleteArticleRequest request, RequestOptions requestOptions)	You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.
ArticleList	listArticles()	You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
ArticleList	listArticles(RequestOptions requestOptions)	You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
Article	retrieveArticle(RetrieveArticleRequest request)	You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.
Article	retrieveArticle(RetrieveArticleRequest request, RequestOptions requestOptions)	You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.
ArticleSearchResponse	searchArticles()	You can search for articles by making a GET request to https://api.intercom.io/articles/search.
ArticleSearchResponse	searchArticles(SearchArticlesRequest request)	You can search for articles by making a GET request to https://api.intercom.io/articles/search.
ArticleSearchResponse	searchArticles(SearchArticlesRequest request, RequestOptions requestOptions)	You can search for articles by making a GET request to https://api.intercom.io/articles/search.
RawArticlesClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

ArticlesClient

public ArticlesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawArticlesClient withRawResponse()

Get responses with HTTP metadata like headers

listArticles

public ArticleList listArticles()

You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.

📘 How are the articles sorted and ordered?

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

listArticles

public ArticleList listArticles(RequestOptions requestOptions)

You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.

📘 How are the articles sorted and ordered?

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

createArticle

public Article createArticle(java.lang.Object request)

You can create a new article by making a POST request to https://api.intercom.io/articles.

createArticle

public Article createArticle(java.lang.Object request,
                             RequestOptions requestOptions)

You can create a new article by making a POST request to https://api.intercom.io/articles.

retrieveArticle

public Article retrieveArticle(RetrieveArticleRequest request)

You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.

retrieveArticle

public Article retrieveArticle(RetrieveArticleRequest request,
                               RequestOptions requestOptions)

You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.

deleteArticle

public DeletedArticleObject deleteArticle(DeleteArticleRequest request)

You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.

deleteArticle

public DeletedArticleObject deleteArticle(DeleteArticleRequest request,
                                          RequestOptions requestOptions)

You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.

searchArticles

public ArticleSearchResponse searchArticles()

You can search for articles by making a GET request to https://api.intercom.io/articles/search.

searchArticles

public ArticleSearchResponse searchArticles(SearchArticlesRequest request)

You can search for articles by making a GET request to https://api.intercom.io/articles/search.

searchArticles

public ArticleSearchResponse searchArticles(SearchArticlesRequest request,
                                            RequestOptions requestOptions)

You can search for articles by making a GET request to https://api.intercom.io/articles/search.