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

Class AsyncCollectionsClient

java.lang.Object

com.intercom.api.resources.helpcenters.collections.AsyncCollectionsClient

public class AsyncCollectionsClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncCollectionsClient(ClientOptions clientOptions)

Method Summary

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

AsyncCollectionsClient

public AsyncCollectionsClient(ClientOptions clientOptions)

Method Details

withRawResponse

public AsyncRawCollectionsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<DeletedCollectionObject> delete(DeleteCollectionRequest request)

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

delete

public CompletableFuture<DeletedCollectionObject> delete(DeleteCollectionRequest request,
 RequestOptions requestOptions)

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