Package com.merge.api.resources.crm.engagements

Class EngagementsClient

java.lang.Object

com.merge.api.resources.crm.engagements.EngagementsClient

public class EngagementsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
EngagementsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
EngagementResponse	create(EngagementEndpointRequest request)	Creates an Engagement object with the given values.
EngagementResponse	create(EngagementEndpointRequest request, RequestOptions requestOptions)	Creates an Engagement object with the given values.
PaginatedEngagementList	list()	Returns a list of Engagement objects.
PaginatedEngagementList	list(EngagementsListRequest request)	Returns a list of Engagement objects.
PaginatedEngagementList	list(EngagementsListRequest request, RequestOptions requestOptions)	Returns a list of Engagement objects.
MetaResponse	metaPatchRetrieve(java.lang.String id)	Returns metadata for Engagement PATCHs.
MetaResponse	metaPatchRetrieve(java.lang.String id, RequestOptions requestOptions)	Returns metadata for Engagement PATCHs.
MetaResponse	metaPostRetrieve()	Returns metadata for Engagement POSTs.
MetaResponse	metaPostRetrieve(RequestOptions requestOptions)	Returns metadata for Engagement POSTs.
EngagementResponse	partialUpdate(java.lang.String id, PatchedEngagementEndpointRequest request)	Updates an Engagement object with the given id.
EngagementResponse	partialUpdate(java.lang.String id, PatchedEngagementEndpointRequest request, RequestOptions requestOptions)	Updates an Engagement object with the given id.
PaginatedRemoteFieldClassList	remoteFieldClassesList()	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(EngagementsRemoteFieldClassesListRequest request)	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(EngagementsRemoteFieldClassesListRequest request, RequestOptions requestOptions)	Returns a list of RemoteFieldClass objects.
Engagement	retrieve(java.lang.String id)	Returns an Engagement object with the given id.
Engagement	retrieve(java.lang.String id, EngagementsRetrieveRequest request)	Returns an Engagement object with the given id.
Engagement	retrieve(java.lang.String id, EngagementsRetrieveRequest request, RequestOptions requestOptions)	Returns an Engagement 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

EngagementsClient

public EngagementsClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedEngagementList list()

Returns a list of Engagement objects.

list

public PaginatedEngagementList list(EngagementsListRequest request)

Returns a list of Engagement objects.

list

public PaginatedEngagementList list(EngagementsListRequest request,
                                    RequestOptions requestOptions)

Returns a list of Engagement objects.

create

public EngagementResponse create(EngagementEndpointRequest request)

Creates an Engagement object with the given values.

create

public EngagementResponse create(EngagementEndpointRequest request,
                                 RequestOptions requestOptions)

Creates an Engagement object with the given values.

retrieve

public Engagement retrieve(java.lang.String id)

Returns an Engagement object with the given id.

retrieve

public Engagement retrieve(java.lang.String id,
                           EngagementsRetrieveRequest request)

Returns an Engagement object with the given id.

retrieve

public Engagement retrieve(java.lang.String id,
                           EngagementsRetrieveRequest request,
                           RequestOptions requestOptions)

Returns an Engagement object with the given id.

partialUpdate

public EngagementResponse partialUpdate(java.lang.String id,
                                        PatchedEngagementEndpointRequest request)

Updates an Engagement object with the given id.

partialUpdate

public EngagementResponse partialUpdate(java.lang.String id,
                                        PatchedEngagementEndpointRequest request,
                                        RequestOptions requestOptions)

Updates an Engagement object with the given id.

metaPatchRetrieve

public MetaResponse metaPatchRetrieve(java.lang.String id)

Returns metadata for Engagement PATCHs.

metaPatchRetrieve

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

Returns metadata for Engagement PATCHs.

metaPostRetrieve

public MetaResponse metaPostRetrieve()

Returns metadata for Engagement POSTs.

metaPostRetrieve

public MetaResponse metaPostRetrieve(RequestOptions requestOptions)

Returns metadata for Engagement POSTs.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList()

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(EngagementsRemoteFieldClassesListRequest request)

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(EngagementsRemoteFieldClassesListRequest request,
                                                            RequestOptions requestOptions)

Returns a list of RemoteFieldClass objects.