Package com.intercom.api.resources.internalarticles

Class AsyncInternalArticlesClient

java.lang.Object

com.intercom.api.resources.internalarticles.AsyncInternalArticlesClient

public class AsyncInternalArticlesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncInternalArticlesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<InternalArticleListItem>	createInternalArticle()	You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles.
java.util.concurrent.CompletableFuture<InternalArticleListItem>	createInternalArticle(java.util.Optional<CreateInternalArticleRequest> request)	You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles.
java.util.concurrent.CompletableFuture<InternalArticleListItem>	createInternalArticle(java.util.Optional<CreateInternalArticleRequest> request, RequestOptions requestOptions)	You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles.
java.util.concurrent.CompletableFuture<DeletedInternalArticleObject>	deleteInternalArticle(DeleteInternalArticleRequest request)	You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>.
java.util.concurrent.CompletableFuture<DeletedInternalArticleObject>	deleteInternalArticle(DeleteInternalArticleRequest request, RequestOptions requestOptions)	You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>.
java.util.concurrent.CompletableFuture<InternalArticleList>	listInternalArticles()	You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles.
java.util.concurrent.CompletableFuture<InternalArticleList>	listInternalArticles(RequestOptions requestOptions)	You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles.
java.util.concurrent.CompletableFuture<InternalArticleListItem>	retrieveInternalArticle(RetrieveInternalArticleRequest request)	You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>.
java.util.concurrent.CompletableFuture<InternalArticleListItem>	retrieveInternalArticle(RetrieveInternalArticleRequest request, RequestOptions requestOptions)	You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>.
java.util.concurrent.CompletableFuture<InternalArticleSearchResponse>	searchInternalArticles()	You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search.
java.util.concurrent.CompletableFuture<InternalArticleSearchResponse>	searchInternalArticles(SearchInternalArticlesRequest request)	You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search.
java.util.concurrent.CompletableFuture<InternalArticleSearchResponse>	searchInternalArticles(SearchInternalArticlesRequest request, RequestOptions requestOptions)	You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search.
java.util.concurrent.CompletableFuture<InternalArticleListItem>	updateInternalArticle(UpdateInternalArticleRequestBody request)	You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>.
java.util.concurrent.CompletableFuture<InternalArticleListItem>	updateInternalArticle(UpdateInternalArticleRequestBody request, RequestOptions requestOptions)	You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>.
AsyncRawInternalArticlesClient	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

AsyncInternalArticlesClient

public AsyncInternalArticlesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawInternalArticlesClient withRawResponse()

Get responses with HTTP metadata like headers

listInternalArticles

public java.util.concurrent.CompletableFuture<InternalArticleList> listInternalArticles()

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

listInternalArticles

public java.util.concurrent.CompletableFuture<InternalArticleList> listInternalArticles(RequestOptions requestOptions)

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

createInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> createInternalArticle()

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

createInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> createInternalArticle(java.util.Optional<CreateInternalArticleRequest> request)

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

createInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> createInternalArticle(java.util.Optional<CreateInternalArticleRequest> request,
                                                                                             RequestOptions requestOptions)

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

retrieveInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> retrieveInternalArticle(RetrieveInternalArticleRequest request)

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

retrieveInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> retrieveInternalArticle(RetrieveInternalArticleRequest request,
                                                                                               RequestOptions requestOptions)

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

updateInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> updateInternalArticle(UpdateInternalArticleRequestBody request)

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

updateInternalArticle

public java.util.concurrent.CompletableFuture<InternalArticleListItem> updateInternalArticle(UpdateInternalArticleRequestBody request,
                                                                                             RequestOptions requestOptions)

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

deleteInternalArticle

public java.util.concurrent.CompletableFuture<DeletedInternalArticleObject> deleteInternalArticle(DeleteInternalArticleRequest request)

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

deleteInternalArticle

public java.util.concurrent.CompletableFuture<DeletedInternalArticleObject> deleteInternalArticle(DeleteInternalArticleRequest request,
                                                                                                  RequestOptions requestOptions)

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

searchInternalArticles

public java.util.concurrent.CompletableFuture<InternalArticleSearchResponse> searchInternalArticles()

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

searchInternalArticles

public java.util.concurrent.CompletableFuture<InternalArticleSearchResponse> searchInternalArticles(SearchInternalArticlesRequest request)

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

searchInternalArticles

public java.util.concurrent.CompletableFuture<InternalArticleSearchResponse> searchInternalArticles(SearchInternalArticlesRequest request,
                                                                                                    RequestOptions requestOptions)

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