Package com.courier.api.resources.profiles

Class ProfilesClient

java.lang.Object

com.courier.api.resources.profiles.ProfilesClient

public class ProfilesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ProfilesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
MergeProfileResponse	create(java.lang.String userId, MergeProfileRequest request)	Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.
MergeProfileResponse	create(java.lang.String userId, MergeProfileRequest request, IdempotentRequestOptions requestOptions)	Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.
void	delete(java.lang.String userId)	Deletes the specified user profile.
void	delete(java.lang.String userId, RequestOptions requestOptions)	Deletes the specified user profile.
DeleteListSubscriptionResponse	deleteListSubscription(java.lang.String userId)	Removes all list subscriptions for given user.
DeleteListSubscriptionResponse	deleteListSubscription(java.lang.String userId, RequestOptions requestOptions)	Removes all list subscriptions for given user.
ProfileGetResponse	get(java.lang.String userId)	Returns the specified user profile.
ProfileGetResponse	get(java.lang.String userId, RequestOptions requestOptions)	Returns the specified user profile.
GetListSubscriptionsResponse	getListSubscriptions(java.lang.String userId)	Returns the subscribed lists for a specified user.
GetListSubscriptionsResponse	getListSubscriptions(java.lang.String userId, GetListSubscriptionsRequest request)	Returns the subscribed lists for a specified user.
GetListSubscriptionsResponse	getListSubscriptions(java.lang.String userId, GetListSubscriptionsRequest request, RequestOptions requestOptions)	Returns the subscribed lists for a specified user.
ReplaceProfileResponse	replace(java.lang.String userId, ReplaceProfileRequest request)	When using PUT, be sure to include all the key-value pairs required by the recipient's profile.
ReplaceProfileResponse	replace(java.lang.String userId, ReplaceProfileRequest request, RequestOptions requestOptions)	When using PUT, be sure to include all the key-value pairs required by the recipient's profile.
SubscribeToListsResponse	subscribeToLists(java.lang.String userId, SubscribeToListsRequest request)	Subscribes the given user to one or more lists.
SubscribeToListsResponse	subscribeToLists(java.lang.String userId, SubscribeToListsRequest request, IdempotentRequestOptions requestOptions)	Subscribes the given user to one or more lists.

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

ProfilesClient

public ProfilesClient(ClientOptions clientOptions)

Method Detail

get

public ProfileGetResponse get(java.lang.String userId)

Returns the specified user profile.

get

public ProfileGetResponse get(java.lang.String userId,
                              RequestOptions requestOptions)

Returns the specified user profile.

create

public MergeProfileResponse create(java.lang.String userId,
                                   MergeProfileRequest request)

Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.

create

public MergeProfileResponse create(java.lang.String userId,
                                   MergeProfileRequest request,
                                   IdempotentRequestOptions requestOptions)

Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.

replace

public ReplaceProfileResponse replace(java.lang.String userId,
                                      ReplaceProfileRequest request)

When using PUT, be sure to include all the key-value pairs required by the recipient's profile. Any key-value pairs that exist in the profile but fail to be included in the PUT request will be removed from the profile. Remember, a PUT update is a full replacement of the data. For partial updates, use the Patch request.

replace

public ReplaceProfileResponse replace(java.lang.String userId,
                                      ReplaceProfileRequest request,
                                      RequestOptions requestOptions)

When using PUT, be sure to include all the key-value pairs required by the recipient's profile. Any key-value pairs that exist in the profile but fail to be included in the PUT request will be removed from the profile. Remember, a PUT update is a full replacement of the data. For partial updates, use the Patch request.

delete

public void delete(java.lang.String userId)

Deletes the specified user profile.

delete

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

Deletes the specified user profile.

getListSubscriptions

public GetListSubscriptionsResponse getListSubscriptions(java.lang.String userId)

Returns the subscribed lists for a specified user.

getListSubscriptions

public GetListSubscriptionsResponse getListSubscriptions(java.lang.String userId,
                                                         GetListSubscriptionsRequest request)

Returns the subscribed lists for a specified user.

getListSubscriptions

public GetListSubscriptionsResponse getListSubscriptions(java.lang.String userId,
                                                         GetListSubscriptionsRequest request,
                                                         RequestOptions requestOptions)

Returns the subscribed lists for a specified user.

subscribeToLists

public SubscribeToListsResponse subscribeToLists(java.lang.String userId,
                                                 SubscribeToListsRequest request)

Subscribes the given user to one or more lists. If the list does not exist, it will be created.

subscribeToLists

public SubscribeToListsResponse subscribeToLists(java.lang.String userId,
                                                 SubscribeToListsRequest request,
                                                 IdempotentRequestOptions requestOptions)

Subscribes the given user to one or more lists. If the list does not exist, it will be created.

deleteListSubscription

public DeleteListSubscriptionResponse deleteListSubscription(java.lang.String userId)

Removes all list subscriptions for given user.

deleteListSubscription

public DeleteListSubscriptionResponse deleteListSubscription(java.lang.String userId,
                                                             RequestOptions requestOptions)

Removes all list subscriptions for given user.