Package com.intercom.api.resources.unstable.helpcenter

Class HelpCenterClient

java.lang.Object

com.intercom.api.resources.unstable.helpcenter.HelpCenterClient

public class HelpCenterClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
HelpCenterClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Collection	createCollection(CreateCollectionRequest request)	You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.
Collection	createCollection(CreateCollectionRequest request, RequestOptions requestOptions)	You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.
DeletedCollectionObject	deleteCollection(DeleteCollectionRequest request)	You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>.
DeletedCollectionObject	deleteCollection(DeleteCollectionRequest request, RequestOptions requestOptions)	You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>.
CollectionList	listAllCollections()	You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.
CollectionList	listAllCollections(RequestOptions requestOptions)	You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.
HelpCenterList	listHelpCenters()	You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.
HelpCenterList	listHelpCenters(RequestOptions requestOptions)	You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.
Collection	retrieveCollection(RetrieveCollectionRequest request)	You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>.
Collection	retrieveCollection(RetrieveCollectionRequest request, RequestOptions requestOptions)	You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>.
HelpCenter	retrieveHelpCenter(RetrieveHelpCenterRequest request)	You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>.
HelpCenter	retrieveHelpCenter(RetrieveHelpCenterRequest request, RequestOptions requestOptions)	You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>.
Collection	updateCollection(UpdateCollectionRequest request)	You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>.
Collection	updateCollection(UpdateCollectionRequest request, RequestOptions requestOptions)	You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>.
RawHelpCenterClient	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

HelpCenterClient

public HelpCenterClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawHelpCenterClient withRawResponse()

Get responses with HTTP metadata like headers

listAllCollections

public CollectionList listAllCollections()

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

Collections 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 collections first.

listAllCollections

public CollectionList listAllCollections(RequestOptions requestOptions)

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

Collections 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 collections first.

createCollection

public Collection createCollection(CreateCollectionRequest request)

You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.

createCollection

public Collection createCollection(CreateCollectionRequest request,
                                   RequestOptions requestOptions)

You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.

retrieveCollection

public Collection retrieveCollection(RetrieveCollectionRequest request)

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

retrieveCollection

public Collection retrieveCollection(RetrieveCollectionRequest request,
                                     RequestOptions requestOptions)

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

updateCollection

public Collection updateCollection(UpdateCollectionRequest request)

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

updateCollection

public Collection updateCollection(UpdateCollectionRequest request,
                                   RequestOptions requestOptions)

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

deleteCollection

public DeletedCollectionObject deleteCollection(DeleteCollectionRequest request)

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

deleteCollection

public DeletedCollectionObject deleteCollection(DeleteCollectionRequest request,
                                                RequestOptions requestOptions)

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

retrieveHelpCenter

public HelpCenter retrieveHelpCenter(RetrieveHelpCenterRequest request)

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

retrieveHelpCenter

public HelpCenter retrieveHelpCenter(RetrieveHelpCenterRequest request,
                                     RequestOptions requestOptions)

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

listHelpCenters

public HelpCenterList listHelpCenters()

You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.

listHelpCenters

public HelpCenterList listHelpCenters(RequestOptions requestOptions)

You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.