Package com.intercom.api.resources.articles

Class ArticlesClient

java.lang.Object

com.intercom.api.resources.articles.ArticlesClient

public class ArticlesClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ArticlesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Article	create(CreateArticleRequest request)	You can create a new article by making a POST request to https://api.intercom.io/articles.
Article	create(CreateArticleRequest request, RequestOptions requestOptions)	You can create a new article by making a POST request to https://api.intercom.io/articles.
DeletedArticleObject	delete(DeleteArticleRequest request)	You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.
DeletedArticleObject	delete(DeleteArticleRequest request, RequestOptions requestOptions)	You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>.
Article	find(FindArticleRequest request)	You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.
Article	find(FindArticleRequest request, RequestOptions requestOptions)	You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>.
SyncPagingIterable<ArticleListItem>	list()	You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
SyncPagingIterable<ArticleListItem>	list(ListArticlesRequest request)	You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
SyncPagingIterable<ArticleListItem>	list(ListArticlesRequest request, RequestOptions requestOptions)	You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles.
SearchArticlesResponse	search()	You can search for articles by making a GET request to https://api.intercom.io/articles/search.
SearchArticlesResponse	search(SearchArticlesRequest request)	You can search for articles by making a GET request to https://api.intercom.io/articles/search.
SearchArticlesResponse	search(SearchArticlesRequest request, RequestOptions requestOptions)	You can search for articles by making a GET request to https://api.intercom.io/articles/search.
Article	update(UpdateArticleRequest request)	You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>.
Article	update(UpdateArticleRequest request, RequestOptions requestOptions)	You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>.
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 Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

ArticlesClient

public ArticlesClient(ClientOptions clientOptions)

Method Details

withRawResponse

public RawArticlesClient withRawResponse()

Get responses with HTTP metadata like headers

list

public SyncPagingIterable<ArticleListItem> list()

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.

list

public SyncPagingIterable<ArticleListItem> list(ListArticlesRequest request)

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.

list

public SyncPagingIterable<ArticleListItem> list(ListArticlesRequest request,
 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.

create

public Article create(CreateArticleRequest request)

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

create

public Article create(CreateArticleRequest request,
 RequestOptions requestOptions)

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

find

public Article find(FindArticleRequest request)

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

find

public Article find(FindArticleRequest request,
 RequestOptions requestOptions)

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

update

public Article update(UpdateArticleRequest request)

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

update

public Article update(UpdateArticleRequest request,
 RequestOptions requestOptions)

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

delete

public DeletedArticleObject delete(DeleteArticleRequest request)

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

delete

public DeletedArticleObject delete(DeleteArticleRequest request,
 RequestOptions requestOptions)

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

search

public SearchArticlesResponse search()

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

search

public SearchArticlesResponse search(SearchArticlesRequest request)

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

search

public SearchArticlesResponse search(SearchArticlesRequest request,
 RequestOptions requestOptions)

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