Package com.merge.api.resources.crm.leads

Class LeadsClient

java.lang.Object

com.merge.api.resources.crm.leads.LeadsClient

public class LeadsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
LeadsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
LeadResponse	create(LeadEndpointRequest request)	Creates a Lead object with the given values.
LeadResponse	create(LeadEndpointRequest request, RequestOptions requestOptions)	Creates a Lead object with the given values.
PaginatedLeadList	list()	Returns a list of Lead objects.
PaginatedLeadList	list(LeadsListRequest request)	Returns a list of Lead objects.
PaginatedLeadList	list(LeadsListRequest request, RequestOptions requestOptions)	Returns a list of Lead objects.
MetaResponse	metaPostRetrieve()	Returns metadata for Lead POSTs.
MetaResponse	metaPostRetrieve(RequestOptions requestOptions)	Returns metadata for Lead POSTs.
PaginatedRemoteFieldClassList	remoteFieldClassesList()	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(LeadsRemoteFieldClassesListRequest request)	Returns a list of RemoteFieldClass objects.
PaginatedRemoteFieldClassList	remoteFieldClassesList(LeadsRemoteFieldClassesListRequest request, RequestOptions requestOptions)	Returns a list of RemoteFieldClass objects.
Lead	retrieve(java.lang.String id)	Returns a Lead object with the given id.
Lead	retrieve(java.lang.String id, LeadsRetrieveRequest request)	Returns a Lead object with the given id.
Lead	retrieve(java.lang.String id, LeadsRetrieveRequest request, RequestOptions requestOptions)	Returns a Lead 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

LeadsClient

public LeadsClient(ClientOptions clientOptions)

Method Detail

list

public PaginatedLeadList list()

Returns a list of Lead objects.

list

public PaginatedLeadList list(LeadsListRequest request)

Returns a list of Lead objects.

list

public PaginatedLeadList list(LeadsListRequest request,
                              RequestOptions requestOptions)

Returns a list of Lead objects.

create

public LeadResponse create(LeadEndpointRequest request)

Creates a Lead object with the given values.

create

public LeadResponse create(LeadEndpointRequest request,
                           RequestOptions requestOptions)

Creates a Lead object with the given values.

retrieve

public Lead retrieve(java.lang.String id)

Returns a Lead object with the given id.

retrieve

public Lead retrieve(java.lang.String id,
                     LeadsRetrieveRequest request)

Returns a Lead object with the given id.

retrieve

public Lead retrieve(java.lang.String id,
                     LeadsRetrieveRequest request,
                     RequestOptions requestOptions)

Returns a Lead object with the given id.

metaPostRetrieve

public MetaResponse metaPostRetrieve()

Returns metadata for Lead POSTs.

metaPostRetrieve

public MetaResponse metaPostRetrieve(RequestOptions requestOptions)

Returns metadata for Lead POSTs.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList()

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(LeadsRemoteFieldClassesListRequest request)

Returns a list of RemoteFieldClass objects.

remoteFieldClassesList

public PaginatedRemoteFieldClassList remoteFieldClassesList(LeadsRemoteFieldClassesListRequest request,
                                                            RequestOptions requestOptions)

Returns a list of RemoteFieldClass objects.