Package com.intercom.api.resources.internalarticles

Class InternalArticlesClient

java.lang.Object

com.intercom.api.resources.internalarticles.InternalArticlesClient

public class InternalArticlesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
InternalArticlesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
InternalArticleListItem	createInternalArticle()	You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles.
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.
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.
DeletedInternalArticleObject	deleteInternalArticle(DeleteInternalArticleRequest request)	You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>.
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>.
InternalArticleList	listInternalArticles()	You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles.
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.
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>.
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>.
InternalArticleSearchResponse	searchInternalArticles()	You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search.
InternalArticleSearchResponse	searchInternalArticles(SearchInternalArticlesRequest request)	You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search.
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.
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>.
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>.
RawInternalArticlesClient	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

InternalArticlesClient

public InternalArticlesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawInternalArticlesClient withRawResponse()

Get responses with HTTP metadata like headers

listInternalArticles

public 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 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 InternalArticleListItem createInternalArticle()

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

createInternalArticle

public 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 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 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 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 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 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 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 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 InternalArticleSearchResponse searchInternalArticles()

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

searchInternalArticles

public 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 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.