Package com.courier.api.resources.users.tenants

Class TenantsClient

java.lang.Object

com.courier.api.resources.users.tenants.TenantsClient

public class TenantsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
TenantsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.String userId, java.lang.String tenantId)	This endpoint is used to add a single tenant.
void	add(java.lang.String userId, java.lang.String tenantId, AddUserToSingleTenantsParams request)	This endpoint is used to add a single tenant.
void	add(java.lang.String userId, java.lang.String tenantId, AddUserToSingleTenantsParams request, RequestOptions requestOptions)	This endpoint is used to add a single tenant.
void	addMultple(java.lang.String userId, AddUserToMultipleTenantsParams request)	This endpoint is used to add a user to multiple tenants in one call.
void	addMultple(java.lang.String userId, AddUserToMultipleTenantsParams request, RequestOptions requestOptions)	This endpoint is used to add a user to multiple tenants in one call.
ListTenantsForUserResponse	list(java.lang.String userId)	Returns a paginated list of user tenant associations.
ListTenantsForUserResponse	list(java.lang.String userId, ListTenantsForUserParams request)	Returns a paginated list of user tenant associations.
ListTenantsForUserResponse	list(java.lang.String userId, ListTenantsForUserParams request, RequestOptions requestOptions)	Returns a paginated list of user tenant associations.
void	remove(java.lang.String userId, java.lang.String tenantId)	Removes a user from the supplied tenant.
void	remove(java.lang.String userId, java.lang.String tenantId, RequestOptions requestOptions)	Removes a user from the supplied tenant.
void	removeAll(java.lang.String userId)	Removes a user from any tenants they may have been associated with.
void	removeAll(java.lang.String userId, RequestOptions requestOptions)	Removes a user from any tenants they may have been associated with.

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

TenantsClient

public TenantsClient(ClientOptions clientOptions)

Method Detail

addMultple

public void addMultple(java.lang.String userId,
                       AddUserToMultipleTenantsParams request)

This endpoint is used to add a user to multiple tenants in one call. A custom profile can also be supplied for each tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.

addMultple

public void addMultple(java.lang.String userId,
                       AddUserToMultipleTenantsParams request,
                       RequestOptions requestOptions)

This endpoint is used to add a user to multiple tenants in one call. A custom profile can also be supplied for each tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.

add

public void add(java.lang.String userId,
                java.lang.String tenantId)

This endpoint is used to add a single tenant.

A custom profile can also be supplied with the tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.

add

public void add(java.lang.String userId,
                java.lang.String tenantId,
                AddUserToSingleTenantsParams request)

This endpoint is used to add a single tenant.

A custom profile can also be supplied with the tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.

add

public void add(java.lang.String userId,
                java.lang.String tenantId,
                AddUserToSingleTenantsParams request,
                RequestOptions requestOptions)

This endpoint is used to add a single tenant.

A custom profile can also be supplied with the tenant. This profile will be merged with the user's main profile when sending to the user with that tenant.

removeAll

public void removeAll(java.lang.String userId)

Removes a user from any tenants they may have been associated with.

removeAll

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

Removes a user from any tenants they may have been associated with.

remove

public void remove(java.lang.String userId,
                   java.lang.String tenantId)

Removes a user from the supplied tenant.

remove

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

Removes a user from the supplied tenant.

list

public ListTenantsForUserResponse list(java.lang.String userId)

Returns a paginated list of user tenant associations.

list

public ListTenantsForUserResponse list(java.lang.String userId,
                                       ListTenantsForUserParams request)

Returns a paginated list of user tenant associations.

list

public ListTenantsForUserResponse list(java.lang.String userId,
                                       ListTenantsForUserParams request,
                                       RequestOptions requestOptions)

Returns a paginated list of user tenant associations.