org.mule.modules.marketo.api

Class LeadClientImpl

java.lang.Object

org.mule.modules.marketo.api.RestClient

org.mule.modules.marketo.api.LeadClientImpl

All Implemented Interfaces:

LeadClient

public class LeadClientImpl
extends RestClient
implements LeadClient

Field Summary

Fields

Modifier and Type	Field and Description
protected static javax.ws.rs.core.GenericType<MarketoResponse<ActivityTypes>>	ACTIVITY_TYPES_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<Campaign>>	CAMPAIGN_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<CreateOrUpdateLead>>	CREATE_OR_UPDATE_LEAD_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<DailyErrors>>	DAILY_ERRORS_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<DailyUsage>>	DAILY_USAGE_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<File>>	FILE_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<IdOnlyObject>>	ID_ONLY_OBJECT_RESPONSE_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<LeadActivities>>	LEAD_ACTIVITIES_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<LeadChanges>>	LEAD_CHANGES_RESPONSE_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<Lead>>	LEAD_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<LeadStatus>>	LEAD_STATUS_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<LeadsList>>	LEADS_LIST_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<MarketoList>>	MARKETO_LIST_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<Partition>>	PARTITION_GENERIC_TYPE
protected static javax.ws.rs.core.GenericType<MarketoResponse<PartitionResponse>>	PARTITION_RESPONSE_GENERIC_TYPE

Fields inherited from class org.mule.modules.marketo.api.RestClient

DATE_FORMAT_TIMEZONE, DATE_FORMAT_Z, DATE_FORMAT_Z_TIMEZONE, DATE_ONLY_FORMAT, JOINER, RESPONSE_MAP_GENERIC_TYPE, SERVICE_RESPONSE_GENERIC_TYPE, SINGLE_ENTRY_MAP_TO_STRING, VOID_GENERIC_TYPE

Constructor Summary

Constructors

Constructor and Description
LeadClientImpl(RestClientConfigProvider configProvider)

Method Summary

Methods

Modifier and Type	Method and Description
MarketoResponse<LeadsList>	addLeadsToList(int listId, List<Integer> ids) Allows the called to add leads to a list
MarketoResponse<Void>	associateLead(int leadId, String cookie) Allows the caller to associate a lead with a cookie value
MarketoResponse<CreateOrUpdateLead>	createLead(List<Map<String,Object>> input, String lookupField, LeadsActions action, boolean asyncProcessing, String partitionName) Allows the caller to create new leads within Marketo, or if the lead already exists update it with the submitted values
MarketoResponse<CreateOrUpdateLead>	deleteLead(List<LeadId> input) Allows the caller to delete leads
MarketoResponse<Lead>	describe() Allows the user to get all fields and the data type of a lead object
MarketoResponse<ActivityTypes>	getActivityTypes() Allows the caller to retrieve metadata about activity types
MarketoResponse<Campaign>	getCampaignById(int marketoId) Allows the caller to retrieve a campaign using a Marketo id
MarketoResponse<DailyErrors>	getDailyErrors() Allows the caller to retrieve error codes and their count for the day
MarketoResponse<DailyUsage>	getDailyUsage() Allows the caller to retrieve total and user-level usage count for the day
MarketoResponse<Map<String,Object>>	getDeletedLeads(String nextPageToken, Integer batchSize) Allows the caller to retrieve a list of leads that were deleted
MarketoResponse<File>	getImportFailureFile(int batchId) Allows the caller to return the failure file from Import Lead call in the same format that was used
MarketoResponse<LeadStatus>	getImportLeadStatus(int batchId) Allows the caller to retrieve the status of lead operation from Import Lead call
MarketoResponse<File>	getImportWarningFile(int batchId) Allows the caller to return the warning file from Import Lead call in the same format that was used
MarketoResponse<DailyErrors>	getLast7DaysErrors() Allows the caller to retrieve error codes and their count for the last 7 days
MarketoResponse<DailyUsage>	getLast7DaysUsage() Allows the caller to retrieve total and user-level usage count for last 7 days
MarketoResponse<LeadActivities>	getLeadActivities(List<Integer> activityTypeIds, String nextPageToken, Integer batchSize, Integer listId, List<String> leadIds) Allows the caller to retrieve activities for the requested activity types
MarketoResponse<Map<String,Object>>	getLeadById(int leadId, List<String> fields) Allows the caller to retrieve a single lead using the Lead Id
MarketoResponse<LeadChanges>	getLeadChanges(String nextPageToken, Integer batchSize, Integer listId, List<String> fields) Allows the caller to retrieve a list of changed data value for lead
MarketoResponse<Partition>	getLeadPartitions() Allows the caller to return a list of lead partitions in a Marketo instance
MarketoResponse<MarketoList>	getListById(int id) Allows the caller to retrieve a List by their id
MarketoResponse<Campaign>	getMultipleCampaigns(List<Integer> ids, List<String> names, List<String> programNames, List<String> workspaceNames, Integer batchSize, String nextPageToken) Allows the caller to retrieve multiple campaigns
MarketoResponse<Map<String,Object>>	getMultipleLeadsByFilterType(String filterType, List<String> filterValues, List<String> fields, String nextPageToken, Integer batchSize) Allows the caller to retrieve multiple leads for a given search criteria
MarketoResponse<Map<String,Object>>	getMultipleLeadsByListId(int listId, List<String> fields, String nextPageToken, Integer batchSize) Allows the caller to retrieve multiple leads from a given list id
MarketoResponse<Map<String,Object>>	getMultipleLeadsByProgramId(int programId, List<String> fields, String nextPageToken, Integer batchSize) Allows the caller to retrieve multiple leads from a given list id
MarketoResponse<MarketoList>	getMultipleLists(List<Integer> ids, List<String> names, List<String> programNames, List<String> workspaceNames, Integer batchSize, String nextPageToken) Allows the caller to retrieve multiple lists.
MarketoResponse<Void>	getPagingToken(Calendar sinceDateTime) Allows the caller to retrieve a token for a given date
MarketoResponse<Map<String,Object>>	importLead(ImportLeadFormats format, InputStream file, String lookupField, Integer listId, String partitionName) Allows the caller to sync leads in bulk
MarketoResponse<LeadsList>	memberOfList(int listId, List<Integer> ids) Allows the caller to find out if leads are a member of a given list
MarketoResponse<Void>	mergeLead(int leadId, List<LeadId> losingLeadIds, boolean mergeInCRM) Allows the caller to merge a winning lead and a list of losers leads.
MarketoResponse<LeadsList>	removeLeadsFromList(int listId, List<Integer> ids) Allows the caller to remove a lead from a list
MarketoResponse<IdOnlyObject>	requestCampaign(int marketoId, List<Integer> leads, List<CampaignTokens> tokens) Allows the user to run an existing Marketo lead in a Marketo Smart Campaign
MarketoResponse<IdOnlyObject>	scheduleCampaign(int marketoId, Calendar runAt, String cloneToProgramName, List<CampaignTokens> tokens) Allows the caller to schedule a batch Smart Campaign to run either immediately or at a future date
MarketoResponse<PartitionResponse>	updateLeadsPartition(List<UpdateLeadPartition> input) Allows the caller to updates the partition for one or more leads

Methods inherited from class org.mule.modules.marketo.api.RestClient

buildGetInvocation, buildPostInvocation, buildPostInvocation, buildPostInvocation, buildPostInvocation, bulkWebTarget, process, putIfNotNull, queryParamIfNotNull, webTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DAILY_ERRORS_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<DailyErrors>> DAILY_ERRORS_GENERIC_TYPE

DAILY_USAGE_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<DailyUsage>> DAILY_USAGE_GENERIC_TYPE

ACTIVITY_TYPES_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<ActivityTypes>> ACTIVITY_TYPES_GENERIC_TYPE

LEAD_ACTIVITIES_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<LeadActivities>> LEAD_ACTIVITIES_GENERIC_TYPE

CAMPAIGN_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<Campaign>> CAMPAIGN_GENERIC_TYPE

MARKETO_LIST_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<MarketoList>> MARKETO_LIST_GENERIC_TYPE

LEADS_LIST_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<LeadsList>> LEADS_LIST_GENERIC_TYPE

LEAD_STATUS_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<LeadStatus>> LEAD_STATUS_GENERIC_TYPE

FILE_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<File>> FILE_GENERIC_TYPE

LEAD_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<Lead>> LEAD_GENERIC_TYPE

CREATE_OR_UPDATE_LEAD_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<CreateOrUpdateLead>> CREATE_OR_UPDATE_LEAD_GENERIC_TYPE

PARTITION_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<Partition>> PARTITION_GENERIC_TYPE

PARTITION_RESPONSE_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<PartitionResponse>> PARTITION_RESPONSE_GENERIC_TYPE

ID_ONLY_OBJECT_RESPONSE_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<IdOnlyObject>> ID_ONLY_OBJECT_RESPONSE_GENERIC_TYPE

LEAD_CHANGES_RESPONSE_GENERIC_TYPE

protected static final javax.ws.rs.core.GenericType<MarketoResponse<LeadChanges>> LEAD_CHANGES_RESPONSE_GENERIC_TYPE

Constructor Detail

LeadClientImpl

public LeadClientImpl(RestClientConfigProvider configProvider)

Method Detail

describe

public MarketoResponse<Lead> describe()

Allows the user to get all fields and the data type of a lead object

Specified by:

describe in interface LeadClient

Returns:

a {org.mule.modules.marketo.model.lead.Lead} with the call response

createLead

public MarketoResponse<CreateOrUpdateLead> createLead(@NotNull
                                             List<Map<String,Object>> input,
                                             @Nullable
                                             String lookupField,
                                             @Nullable
                                             LeadsActions action,
                                             boolean asyncProcessing,
                                             String partitionName)

Allows the caller to create new leads within Marketo, or if the lead already exists update it with the submitted values

Specified by:

createLead in interface LeadClient

Parameters:

input - the list of lead records to create or update

lookupField - if specified, will use this attribute to find the duplicate. Otherwise, email will be used for deduplication

action - the action to perform

asyncProcessing - this allows you to make call asynchronously. Default is false

partitionName - lead partition name

Returns:

a {org.mule.modules.marketo.model.lead.CreateOrUpdateLead} with the call response

deleteLead

public MarketoResponse<CreateOrUpdateLead> deleteLead(@NotNull
                                             List<LeadId> input)

Allows the caller to delete leads

Specified by:

deleteLead in interface LeadClient

Parameters:

input - array of lead ids records to delete

Returns:

a {org.mule.modules.marketo.model.lead.CreateOrUpdateLead} with the call response

getLeadById

public MarketoResponse<Map<String,Object>> getLeadById(int leadId,
                                              List<String> fields)

Allows the caller to retrieve a single lead using the Lead Id

Specified by:

getLeadById in interface LeadClient

Parameters:

leadId - the id of the lead

fields - the fields to return

Returns:

a {java.util.List} with the call response

getDailyUsage

public MarketoResponse<DailyUsage> getDailyUsage()

Allows the caller to retrieve total and user-level usage count for the day

Specified by:

getDailyUsage in interface LeadClient

Returns:

a {java.util.List} with the call response

getLast7DaysUsage

public MarketoResponse<DailyUsage> getLast7DaysUsage()

Allows the caller to retrieve total and user-level usage count for last 7 days

Specified by:

getLast7DaysUsage in interface LeadClient

Returns:

a {java.util.List} with the call response

getDailyErrors

public MarketoResponse<DailyErrors> getDailyErrors()

Allows the caller to retrieve error codes and their count for the day

Specified by:

getDailyErrors in interface LeadClient

Returns:

a {java.util.List} with the call response

getLast7DaysErrors

public MarketoResponse<DailyErrors> getLast7DaysErrors()

Allows the caller to retrieve error codes and their count for the last 7 days

Specified by:

getLast7DaysErrors in interface LeadClient

Returns:

a {java.util.List} with the call response

getPagingToken

public MarketoResponse<Void> getPagingToken(@NotNull
                                   Calendar sinceDateTime)

Allows the caller to retrieve a token for a given date

Specified by:

getPagingToken in interface LeadClient

Parameters:

sinceDateTime - the timeframe for your request to the Get Lead Activities or Get Lead Changes APIs. Supported datetime format: "2014-10-06T13:22:17-08:00" "2014-10-06T13:22-07:00" "2014-10-06"

getActivityTypes

public MarketoResponse<ActivityTypes> getActivityTypes()

Allows the caller to retrieve metadata about activity types

Specified by:

getActivityTypes in interface LeadClient

Returns:

a {java.util.List} with the call response

getDeletedLeads

public MarketoResponse<Map<String,Object>> getDeletedLeads(@NotNull
                                                  String nextPageToken,
                                                  @Nullable
                                                  Integer batchSize)

Allows the caller to retrieve a list of leads that were deleted

Specified by:

getDeletedLeads in interface LeadClient

Parameters:

nextPageToken - used to paginate through large result sets

batchSize - the number of lead activities to be returned in a single call (default and max is 300)

Returns:

a {java.util.List} with the call response

getLeadChanges

public MarketoResponse<LeadChanges> getLeadChanges(@NotNull
                                          String nextPageToken,
                                          @Nullable
                                          Integer batchSize,
                                          @Nullable
                                          Integer listId,
                                          @NotNull
                                          List<String> fields)

Allows the caller to retrieve a list of changed data value for lead

Specified by:

getLeadChanges in interface LeadClient

Parameters:

nextPageToken - used to paginate through large result sets

batchSize - the number of lead activities to be returned in a single call (default and max is 300)

listId - the activities for leads with in this given list

fields - the fields to return

Returns:

a LeadChanges with the call response

getLeadActivities

public MarketoResponse<LeadActivities> getLeadActivities(@NotNull
                                                List<Integer> activityTypeIds,
                                                @NotNull
                                                String nextPageToken,
                                                @Nullable
                                                Integer batchSize,
                                                @Nullable
                                                Integer listId,
                                                @Nullable
                                                List<String> leadIds)

Allows the caller to retrieve activities for the requested activity types

Specified by:

getLeadActivities in interface LeadClient

Parameters:

activityTypeIds - a list of activity type ids (max 10)

nextPageToken - used to paginate through large result sets

batchSize - the number of lead activities to be returned in a single call (default and max is 300)

listId - the activities for leads with in this given list

leadIds - a list of lead IDs

Returns:

a LeadActivities with the call response

getCampaignById

public MarketoResponse<Campaign> getCampaignById(int marketoId)

Allows the caller to retrieve a campaign using a Marketo id

Specified by:

getCampaignById in interface LeadClient

Parameters:

marketoId - the campaign id on valid error from the endpoint

Returns:

The requested Campaign.

getMultipleCampaigns

public MarketoResponse<Campaign> getMultipleCampaigns(@NotNull
                                             List<Integer> ids,
                                             @NotNull
                                             List<String> names,
                                             @NotNull
                                             List<String> programNames,
                                             @NotNull
                                             List<String> workspaceNames,
                                             @Nullable
                                             Integer batchSize,
                                             @Nullable
                                             String nextPageToken)

Allows the caller to retrieve multiple campaigns

Specified by:

getMultipleCampaigns in interface LeadClient

Parameters:

ids - the campaigns ids

names - the campaigns names

programNames - the program names

workspaceNames - the workspaces names

batchSize - the number of lead campaigns to be returned in a single call (default and max is 300)

nextPageToken - used to paginate through large result sets

Returns:

The requested Campaign.

scheduleCampaign

public MarketoResponse<IdOnlyObject> scheduleCampaign(int marketoId,
                                             @Nullable
                                             Calendar runAt,
                                             @Nullable
                                             String cloneToProgramName,
                                             @Nullable
                                             List<CampaignTokens> tokens)

Allows the caller to schedule a batch Smart Campaign to run either immediately or at a future date

Specified by:

scheduleCampaign in interface LeadClient

Parameters:

marketoId - the Marketo id of the campaign

runAt - the time to run the scheduled campaign. If not provided, schedule it to be 5 mins later.

cloneToProgramName - when this attribute is present, the campaign’s parent program will be cloned and the newly created campaign will be scheduled.

tokens - the name of the token/s you want to send a new value for

Returns:

The requested campaign id IdOnlyObject.

requestCampaign

public MarketoResponse<IdOnlyObject> requestCampaign(int marketoId,
                                            @NotNull
                                            List<Integer> leads,
                                            @Nullable
                                            List<CampaignTokens> tokens)

Allows the user to run an existing Marketo lead in a Marketo Smart Campaign

Specified by:

requestCampaign in interface LeadClient

Parameters:

marketoId - the Marketo id of the campaign

leads - a list of leads id

tokens - the name of the token/s you want to send a new value for

Returns:

The requested campaign id IdOnlyObject.

getMultipleLists

public MarketoResponse<MarketoList> getMultipleLists(@NotNull
                                            List<Integer> ids,
                                            @NotNull
                                            List<String> names,
                                            @NotNull
                                            List<String> programNames,
                                            @NotNull
                                            List<String> workspaceNames,
                                            @Nullable
                                            Integer batchSize,
                                            @Nullable
                                            String nextPageToken)

Allows the caller to retrieve multiple lists. The response will have a max of 300 lists

Specified by:

getMultipleLists in interface LeadClient

Parameters:

ids - the list of ids

names - the list of names

programNames - the list of program names

workspaceNames - the list of workspace names

nextPageToken - used to paginate through large result sets

Returns:

The MarketoList of leads

getListById

public MarketoResponse<MarketoList> getListById(int id)

Allows the caller to retrieve a List by their id

Specified by:

getListById in interface LeadClient

Parameters:

id - the list id

Returns:

a {org.mule.modules.marketo.model.lead.MarketoList} with the call response

addLeadsToList

public MarketoResponse<LeadsList> addLeadsToList(int listId,
                                        @NotNull
                                        List<Integer> ids)

Allows the called to add leads to a list

Specified by:

addLeadsToList in interface LeadClient

Parameters:

listId - the desired list where the leads will be added

ids - the list of lead ids

Returns:

a {org.mule.modules.marketo.model.lead.LeadsList} with the call response

removeLeadsFromList

public MarketoResponse<LeadsList> removeLeadsFromList(int listId,
                                             @NotNull
                                             List<Integer> ids)

Allows the caller to remove a lead from a list

Specified by:

removeLeadsFromList in interface LeadClient

Parameters:

listId - the desired list where the leads will be removed

ids - the list of lead ids

Returns:

a {org.mule.modules.marketo.model.lead.LeadsList} with the call response

memberOfList

public MarketoResponse<LeadsList> memberOfList(int listId,
                                      @NotNull
                                      List<Integer> ids)

Allows the caller to find out if leads are a member of a given list

Specified by:

memberOfList in interface LeadClient

Parameters:

listId - the desired list where the leads will be removed

ids - the list of lead ids

Returns:

a {org.mule.modules.marketo.model.lead.LeadsList} with the call response

importLead

public MarketoResponse<Map<String,Object>> importLead(@NotNull
                                             ImportLeadFormats format,
                                             @NotNull
                                             InputStream file,
                                             @Nullable
                                             String lookupField,
                                             @Nullable
                                             Integer listId,
                                             @Nullable
                                             String partitionName)

Allows the caller to sync leads in bulk

Specified by:

importLead in interface LeadClient

Parameters:

format - the file format: csv, tst or ssv

file - the leads data

lookupField - the deduplication field

listId - if listId is not specified, this API operation will create temp static list. Workspace for the list is determined whether partitionName is given or not.

partitionName - if specified, this parameter will verify if user has access to the partition. If not specified, this API operation will use primary partition of the list workspace

Returns:

a {java.util.List} with the call response

getImportLeadStatus

public MarketoResponse<LeadStatus> getImportLeadStatus(int batchId)

Allows the caller to retrieve the status of lead operation from Import Lead call

Specified by:

getImportLeadStatus in interface LeadClient

Parameters:

batchId - the batch id returned from Import Lead call

Returns:

a {org.mule.modules.marketo.model.lead.LeadStatus} with the call response

getImportFailureFile

public MarketoResponse<File> getImportFailureFile(int batchId)
                                           throws MarketoException

Allows the caller to return the failure file from Import Lead call in the same format that was used

Specified by:

getImportFailureFile in interface LeadClient

Parameters:

batchId - the batch id returned from Import Lead call

Returns:

a {java.io.File} with the call response

Throws:

MarketoException

getImportWarningFile

public MarketoResponse<File> getImportWarningFile(int batchId)
                                           throws MarketoException

Allows the caller to return the warning file from Import Lead call in the same format that was used

Specified by:

getImportWarningFile in interface LeadClient

Parameters:

batchId - the batch id returned from Import Lead call

Returns:

a {java.io.File} with the call response

Throws:

MarketoException

getLeadPartitions

public MarketoResponse<Partition> getLeadPartitions()

Allows the caller to return a list of lead partitions in a Marketo instance

Specified by:

getLeadPartitions in interface LeadClient

Returns:

a {org.mule.modules.marketo.model.lead.Partition} with the call response

associateLead

public MarketoResponse<Void> associateLead(int leadId,
                                  @NotNull
                                  String cookie)

Allows the caller to associate a lead with a cookie value

Specified by:

associateLead in interface LeadClient

Parameters:

leadId - the id of the lead

cookie - cookie value of lead

mergeLead

public MarketoResponse<Void> mergeLead(int leadId,
                              @NotNull
                              List<LeadId> losingLeadIds,
                              boolean mergeInCRM)

Allows the caller to merge a winning lead and a list of losers leads. When merging leads, the attributes of the winning lead will take precedence.

Specified by:

mergeLead in interface LeadClient

Parameters:

leadId - the winner lead id

losingLeadIds - a list of losers leads id

mergeInCRM - set to true to merge in CRM. Default is false

Returns:

a Void MarketoResponse

getMultipleLeadsByListId

public MarketoResponse<Map<String,Object>> getMultipleLeadsByListId(int listId,
                                                           @Nullable
                                                           List<String> fields,
                                                           @Nullable
                                                           String nextPageToken,
                                                           @Nullable
                                                           Integer batchSize)

Allows the caller to retrieve multiple leads from a given list id

Specified by:

getMultipleLeadsByListId in interface LeadClient

Parameters:

listId - the id of the list. To retrieve a list id, see getMultipleLists

fields - the list of fields to return

nextPageToken - used to paginate through large result sets

batchSize - the number of lead to be returned in a single call (default and max is 300)

Returns:

a {java.util.List} with the call response

getMultipleLeadsByProgramId

public MarketoResponse<Map<String,Object>> getMultipleLeadsByProgramId(int programId,
                                                              @Nullable
                                                              List<String> fields,
                                                              @Nullable
                                                              String nextPageToken,
                                                              @Nullable
                                                              Integer batchSize)

Allows the caller to retrieve multiple leads from a given list id

Specified by:

getMultipleLeadsByProgramId in interface LeadClient

Parameters:

programId - the id of the program.

fields - the list of fields to return

nextPageToken - used to paginate through large result sets

batchSize - the number of lead to be returned in a single call (default and max is 300)

Returns:

a {java.util.List} with the call response

getMultipleLeadsByFilterType

public MarketoResponse<Map<String,Object>> getMultipleLeadsByFilterType(@NotNull
                                                               String filterType,
                                                               @NotNull
                                                               List<String> filterValues,
                                                               @Nullable
                                                               List<String> fields,
                                                               @Nullable
                                                               String nextPageToken,
                                                               @Nullable
                                                               Integer batchSize)

Allows the caller to retrieve multiple leads for a given search criteria

Specified by:

getMultipleLeadsByFilterType in interface LeadClient

Parameters:

filterType - one of the marketo supported filter types

filterValues - list of filter values

fields - the list of fields to return

nextPageToken - used to paginate through large result sets

batchSize - the number of leads to be returned in a single call (default and max is 300)

Returns:

a {java.util.List} with the call response

updateLeadsPartition

public MarketoResponse<PartitionResponse> updateLeadsPartition(@NotNull
                                                      List<UpdateLeadPartition> input)

Allows the caller to updates the partition for one or more leads

Specified by:

updateLeadsPartition in interface LeadClient

Parameters:

input - Array of input object (id and partitionName)

Returns:

a {org.mule.modules.marketo.model.lead.PartitionResponse} with the call response