Package com.intercom.api.resources.articles

Class AsyncArticlesClient

java.lang.Object

com.intercom.api.resources.articles.AsyncArticlesClient

public class AsyncArticlesClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncArticlesClient(ClientOptions clientOptions)

Method Summary

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

AsyncArticlesClient

public AsyncArticlesClient(ClientOptions clientOptions)

Method Details

withRawResponse

public AsyncRawArticlesClient withRawResponse()

Get responses with HTTP metadata like headers

list

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<Article> create(CreateArticleRequest request)

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

create

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<DeletedArticleObject> delete(DeleteArticleRequest request)

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

delete

public CompletableFuture<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 CompletableFuture<SearchArticlesResponse> search()

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

search

public CompletableFuture<SearchArticlesResponse> search(SearchArticlesRequest request)

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

search

public CompletableFuture<SearchArticlesResponse> search(SearchArticlesRequest request,
 RequestOptions requestOptions)

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