Package com.courier.api.resources.lists

Class ListsClient

java.lang.Object

com.courier.api.resources.lists.ListsClient

public class ListsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ListsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
void	addSubscribers(java.lang.String listId, AddSubscribersToList request)	Subscribes additional users to the list, without modifying existing subscriptions.
void	addSubscribers(java.lang.String listId, AddSubscribersToList request, IdempotentRequestOptions requestOptions)	Subscribes additional users to the list, without modifying existing subscriptions.
void	delete(java.lang.String listId)	Delete a list by list ID.
void	delete(java.lang.String listId, RequestOptions requestOptions)	Delete a list by list ID.
List	get(java.lang.String listId)	Returns a list based on the list ID provided.
List	get(java.lang.String listId, RequestOptions requestOptions)	Returns a list based on the list ID provided.
ListGetSubscriptionsResponse	getSubscribers(java.lang.String listId)	Get the list's subscriptions.
ListGetSubscriptionsResponse	getSubscribers(java.lang.String listId, GetSubscriptionForListRequest request)	Get the list's subscriptions.
ListGetSubscriptionsResponse	getSubscribers(java.lang.String listId, GetSubscriptionForListRequest request, RequestOptions requestOptions)	Get the list's subscriptions.
ListGetAllResponse	list()	Returns all of the lists, with the ability to filter based on a pattern.
ListGetAllResponse	list(GetAllListsRequest request)	Returns all of the lists, with the ability to filter based on a pattern.
ListGetAllResponse	list(GetAllListsRequest request, RequestOptions requestOptions)	Returns all of the lists, with the ability to filter based on a pattern.
void	restore(java.lang.String listId)	Restore a previously deleted list.
void	restore(java.lang.String listId, RequestOptions requestOptions)	Restore a previously deleted list.
void	subscribe(java.lang.String listId, java.lang.String userId)	Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
void	subscribe(java.lang.String listId, java.lang.String userId, SubscribeUserToListRequest request)	Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
void	subscribe(java.lang.String listId, java.lang.String userId, SubscribeUserToListRequest request, RequestOptions requestOptions)	Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
void	unsubscribe(java.lang.String listId, java.lang.String userId)	Delete a subscription to a list by list ID and user ID.
void	unsubscribe(java.lang.String listId, java.lang.String userId, RequestOptions requestOptions)	Delete a subscription to a list by list ID and user ID.
List	update(java.lang.String listId, ListPutParams request)	Create or replace an existing list with the supplied values.
List	update(java.lang.String listId, ListPutParams request, RequestOptions requestOptions)	Create or replace an existing list with the supplied values.
void	updateSubscribers(java.lang.String listId, SubscribeUsersToListRequest request)	Subscribes the users to the list, overwriting existing subscriptions.
void	updateSubscribers(java.lang.String listId, SubscribeUsersToListRequest request, RequestOptions requestOptions)	Subscribes the users to the list, overwriting existing subscriptions.

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

ListsClient

public ListsClient(ClientOptions clientOptions)

Method Detail

list

public ListGetAllResponse list()

Returns all of the lists, with the ability to filter based on a pattern.

list

public ListGetAllResponse list(GetAllListsRequest request)

Returns all of the lists, with the ability to filter based on a pattern.

list

public ListGetAllResponse list(GetAllListsRequest request,
                               RequestOptions requestOptions)

Returns all of the lists, with the ability to filter based on a pattern.

get

public List get(java.lang.String listId)

Returns a list based on the list ID provided.

get

public List get(java.lang.String listId,
                RequestOptions requestOptions)

Returns a list based on the list ID provided.

update

public List update(java.lang.String listId,
                   ListPutParams request)

Create or replace an existing list with the supplied values.

update

public List update(java.lang.String listId,
                   ListPutParams request,
                   RequestOptions requestOptions)

Create or replace an existing list with the supplied values.

delete

public void delete(java.lang.String listId)

Delete a list by list ID.

delete

public void delete(java.lang.String listId,
                   RequestOptions requestOptions)

Delete a list by list ID.

restore

public void restore(java.lang.String listId)

Restore a previously deleted list.

restore

public void restore(java.lang.String listId,
                    RequestOptions requestOptions)

Restore a previously deleted list.

getSubscribers

public ListGetSubscriptionsResponse getSubscribers(java.lang.String listId)

Get the list's subscriptions.

getSubscribers

public ListGetSubscriptionsResponse getSubscribers(java.lang.String listId,
                                                   GetSubscriptionForListRequest request)

Get the list's subscriptions.

getSubscribers

public ListGetSubscriptionsResponse getSubscribers(java.lang.String listId,
                                                   GetSubscriptionForListRequest request,
                                                   RequestOptions requestOptions)

Get the list's subscriptions.

updateSubscribers

public void updateSubscribers(java.lang.String listId,
                              SubscribeUsersToListRequest request)

Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.

updateSubscribers

public void updateSubscribers(java.lang.String listId,
                              SubscribeUsersToListRequest request,
                              RequestOptions requestOptions)

Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.

addSubscribers

public void addSubscribers(java.lang.String listId,
                           AddSubscribersToList request)

Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.

addSubscribers

public void addSubscribers(java.lang.String listId,
                           AddSubscribersToList request,
                           IdempotentRequestOptions requestOptions)

Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.

subscribe

public void subscribe(java.lang.String listId,
                      java.lang.String userId)

Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).

subscribe

public void subscribe(java.lang.String listId,
                      java.lang.String userId,
                      SubscribeUserToListRequest request)

Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).

subscribe

public void subscribe(java.lang.String listId,
                      java.lang.String userId,
                      SubscribeUserToListRequest request,
                      RequestOptions requestOptions)

Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).

unsubscribe

public void unsubscribe(java.lang.String listId,
                        java.lang.String userId)

Delete a subscription to a list by list ID and user ID.

unsubscribe

public void unsubscribe(java.lang.String listId,
                        java.lang.String userId,
                        RequestOptions requestOptions)

Delete a subscription to a list by list ID and user ID.