Package com.merge.api.resources.crm.contacts

Class ContactsClient

java.lang.Object

com.merge.api.resources.crm.contacts.ContactsClient

public class ContactsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ContactsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
CrmContactResponse	create(CrmContactEndpointRequest request)	Creates a Contact object with the given values.
CrmContactResponse	create(CrmContactEndpointRequest request, RequestOptions requestOptions)	Creates a Contact object with the given values.
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.
PaginatedContactList	list()	Returns a list of Contact objects.
PaginatedContactList	list(ContactsListRequest request)	Returns a list of Contact objects.
PaginatedContactList	list(ContactsListRequest request, RequestOptions requestOptions)	Returns a list of Contact objects.
MetaResponse	metaPatchRetrieve(java.lang.String id)	Returns metadata for CRMContact PATCHs.
MetaResponse	metaPatchRetrieve(java.lang.String id, RequestOptions requestOptions)	Returns metadata for CRMContact PATCHs.
MetaResponse	metaPostRetrieve()	Returns metadata for CRMContact POSTs.
MetaResponse	metaPostRetrieve(RequestOptions requestOptions)	Returns metadata for CRMContact POSTs.
CrmContactResponse	partialUpdate(java.lang.String id, PatchedCrmContactEndpointRequest request)	Updates a Contact object with the given id.
CrmContactResponse	partialUpdate(java.lang.String id, PatchedCrmContactEndpointRequest request, RequestOptions requestOptions)	Updates a Contact object with the given id.
PaginatedRemoteFieldClassList	remoteFieldClassesList()	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(ContactsRemoteFieldClassesListRequest request)	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(ContactsRemoteFieldClassesListRequest request, RequestOptions requestOptions)	Returns a list of RemoteFieldClass objects.
Contact	retrieve(java.lang.String id)	Returns a Contact object with the given id.
Contact	retrieve(java.lang.String id, ContactsRetrieveRequest request)	Returns a Contact object with the given id.
Contact	retrieve(java.lang.String id, ContactsRetrieveRequest request, RequestOptions requestOptions)	Returns a Contact 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

ContactsClient

public ContactsClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedContactList list()

Returns a list of Contact objects.

list

public PaginatedContactList list(ContactsListRequest request)

Returns a list of Contact objects.

list

public PaginatedContactList list(ContactsListRequest request,
                                 RequestOptions requestOptions)

Returns a list of Contact objects.

create

public CrmContactResponse create(CrmContactEndpointRequest request)

Creates a Contact object with the given values.

create

public CrmContactResponse create(CrmContactEndpointRequest request,
                                 RequestOptions requestOptions)

Creates a Contact object with the given values.

retrieve

public Contact retrieve(java.lang.String id)

Returns a Contact object with the given id.

retrieve

public Contact retrieve(java.lang.String id,
                        ContactsRetrieveRequest request)

Returns a Contact object with the given id.

retrieve

public Contact retrieve(java.lang.String id,
                        ContactsRetrieveRequest request,
                        RequestOptions requestOptions)

Returns a Contact object with the given id.

partialUpdate

public CrmContactResponse partialUpdate(java.lang.String id,
                                        PatchedCrmContactEndpointRequest request)

Updates a Contact object with the given id.

partialUpdate

public CrmContactResponse partialUpdate(java.lang.String id,
                                        PatchedCrmContactEndpointRequest request,
                                        RequestOptions requestOptions)

Updates a Contact 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.

metaPatchRetrieve

public MetaResponse metaPatchRetrieve(java.lang.String id)

Returns metadata for CRMContact PATCHs.

metaPatchRetrieve

public MetaResponse metaPatchRetrieve(java.lang.String id,
                                      RequestOptions requestOptions)

Returns metadata for CRMContact PATCHs.

metaPostRetrieve

public MetaResponse metaPostRetrieve()

Returns metadata for CRMContact POSTs.

metaPostRetrieve

public MetaResponse metaPostRetrieve(RequestOptions requestOptions)

Returns metadata for CRMContact POSTs.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList()

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(ContactsRemoteFieldClassesListRequest request)

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(ContactsRemoteFieldClassesListRequest request,
                                                            RequestOptions requestOptions)

Returns a list of RemoteFieldClass objects.