Package com.merge.api.resources.crm.users

Class UsersClient

java.lang.Object

com.merge.api.resources.crm.users.UsersClient

public class UsersClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
UsersClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
void	ignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request)	Ignores a specific row based on the model_id in the url.
void	ignoreCreate(java.lang.String modelId, IgnoreCommonModelRequest request, RequestOptions requestOptions)	Ignores a specific row based on the model_id in the url.
PaginatedUserList	list()	Returns a list of User objects.
PaginatedUserList	list(UsersListRequest request)	Returns a list of User objects.
PaginatedUserList	list(UsersListRequest request, RequestOptions requestOptions)	Returns a list of User objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList()	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(UsersRemoteFieldClassesListRequest request)	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(UsersRemoteFieldClassesListRequest request, RequestOptions requestOptions)	Returns a list of RemoteFieldClass objects.
User	retrieve(java.lang.String id)	Returns a User object with the given id.
User	retrieve(java.lang.String id, UsersRetrieveRequest request)	Returns a User object with the given id.
User	retrieve(java.lang.String id, UsersRetrieveRequest request, RequestOptions requestOptions)	Returns a User object with the given id.

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

UsersClient

public UsersClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedUserList list()

Returns a list of User objects.

list

public PaginatedUserList list(UsersListRequest request)

Returns a list of User objects.

list

public PaginatedUserList list(UsersListRequest request,
                              RequestOptions requestOptions)

Returns a list of User objects.

retrieve

public User retrieve(java.lang.String id)

Returns a User object with the given id.

retrieve

public User retrieve(java.lang.String id,
                     UsersRetrieveRequest request)

Returns a User object with the given id.

retrieve

public User retrieve(java.lang.String id,
                     UsersRetrieveRequest request,
                     RequestOptions requestOptions)

Returns a User object with the given id.

ignoreCreate

public void ignoreCreate(java.lang.String modelId,
                         IgnoreCommonModelRequest request)

Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

ignoreCreate

public void ignoreCreate(java.lang.String modelId,
                         IgnoreCommonModelRequest request,
                         RequestOptions requestOptions)

Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList()

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(UsersRemoteFieldClassesListRequest request)

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(UsersRemoteFieldClassesListRequest request,
                                                            RequestOptions requestOptions)

Returns a list of RemoteFieldClass objects.