Package com.merge.api.resources.ticketing.collections

Class CollectionsClient

java.lang.Object

com.merge.api.resources.ticketing.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
PaginatedCollectionList	list()	Returns a list of Collection objects.
PaginatedCollectionList	list(CollectionsListRequest request)	Returns a list of Collection objects.
PaginatedCollectionList	list(CollectionsListRequest request, RequestOptions requestOptions)	Returns a list of Collection objects.
Collection	retrieve(java.lang.String id)	Returns a Collection object with the given id.
Collection	retrieve(java.lang.String id, CollectionsRetrieveRequest request)	Returns a Collection object with the given id.
Collection	retrieve(java.lang.String id, CollectionsRetrieveRequest request, RequestOptions requestOptions)	Returns a Collection object with the given id.
PaginatedUserList	usersList(java.lang.String parentId)	Returns a list of User objects.
PaginatedUserList	usersList(java.lang.String parentId, CollectionsUsersListRequest request)	Returns a list of User objects.
PaginatedUserList	usersList(java.lang.String parentId, CollectionsUsersListRequest request, RequestOptions requestOptions)	Returns a list of User objects.

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

list

public PaginatedCollectionList list()

Returns a list of Collection objects.

list

public PaginatedCollectionList list(CollectionsListRequest request)

Returns a list of Collection objects.

list

public PaginatedCollectionList list(CollectionsListRequest request,
                                    RequestOptions requestOptions)

Returns a list of Collection objects.

retrieve

public Collection retrieve(java.lang.String id)

Returns a Collection object with the given id.

retrieve

public Collection retrieve(java.lang.String id,
                           CollectionsRetrieveRequest request)

Returns a Collection object with the given id.

retrieve

public Collection retrieve(java.lang.String id,
                           CollectionsRetrieveRequest request,
                           RequestOptions requestOptions)

Returns a Collection object with the given id.

usersList

public PaginatedUserList usersList(java.lang.String parentId)

Returns a list of User objects.

usersList

public PaginatedUserList usersList(java.lang.String parentId,
                                   CollectionsUsersListRequest request)

Returns a list of User objects.

usersList

public PaginatedUserList usersList(java.lang.String parentId,
                                   CollectionsUsersListRequest request,
                                   RequestOptions requestOptions)

Returns a list of User objects.