Package com.intercom.api.resources.helpcenters.collections

Class CollectionsClient

java.lang.Object

com.intercom.api.resources.helpcenters.collections.CollectionsClient

public class CollectionsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
CollectionsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Collection	create(CreateCollectionRequest request)	You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.
Collection	create(CreateCollectionRequest request, RequestOptions requestOptions)	You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.
DeletedCollectionObject	delete(DeleteCollectionRequest request)	You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>.
DeletedCollectionObject	delete(DeleteCollectionRequest request, RequestOptions requestOptions)	You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>.
Collection	find(FindCollectionRequest 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	find(FindCollectionRequest 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>.
SyncPagingIterable<Collection>	list()	You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.
SyncPagingIterable<Collection>	list(ListCollectionsRequest request)	You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.
SyncPagingIterable<Collection>	list(ListCollectionsRequest request, RequestOptions requestOptions)	You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.
Collection	update(UpdateCollectionRequest request)	You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>.
Collection	update(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>.
RawCollectionsClient	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

CollectionsClient

public CollectionsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawCollectionsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public SyncPagingIterable<Collection> list()

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.

list

public SyncPagingIterable<Collection> list(ListCollectionsRequest request)

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.

list

public SyncPagingIterable<Collection> list(ListCollectionsRequest request,
                                           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.

create

public Collection create(CreateCollectionRequest request)

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

create

public Collection create(CreateCollectionRequest request,
                         RequestOptions requestOptions)

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

find

public Collection find(FindCollectionRequest request)

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

find

public Collection find(FindCollectionRequest 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>.

update

public Collection update(UpdateCollectionRequest request)

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

update

public Collection update(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>.

delete

public DeletedCollectionObject delete(DeleteCollectionRequest request)

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

delete

public DeletedCollectionObject delete(DeleteCollectionRequest request,
                                      RequestOptions requestOptions)

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