org.mule.modules.marketo.api

Interface LeadClient

All Known Implementing Classes:

LeadClientImpl

public interface LeadClient

Method Summary

Methods

Modifier and Type	Method and Description
MarketoResponse<LeadsList>	addLeadsToList(int listId, List<Integer> ids)
MarketoResponse<Void>	associateLead(int leadId, String cookie)
MarketoResponse<CreateOrUpdateLead>	createLead(List<Map<String,Object>> input, String lookupField, LeadsActions action, boolean asyncProcessing, String partitionName)
MarketoResponse<CreateOrUpdateLead>	deleteLead(List<LeadId> input)
MarketoResponse<Lead>	describe()
MarketoResponse<ActivityTypes>	getActivityTypes()
MarketoResponse<Campaign>	getCampaignById(int marketoId)
MarketoResponse<DailyErrors>	getDailyErrors()
MarketoResponse<DailyUsage>	getDailyUsage()
MarketoResponse<Map<String,Object>>	getDeletedLeads(String nextPageToken, Integer batchSize)
MarketoResponse<File>	getImportFailureFile(int batchId)
MarketoResponse<LeadStatus>	getImportLeadStatus(int batchId)
MarketoResponse<File>	getImportWarningFile(int batchId)
MarketoResponse<DailyErrors>	getLast7DaysErrors()
MarketoResponse<DailyUsage>	getLast7DaysUsage()
MarketoResponse<LeadActivities>	getLeadActivities(List<Integer> activityTypeIds, String nextPageToken, Integer batchSize, Integer listId, List<String> leadIds)
MarketoResponse<Map<String,Object>>	getLeadById(int leadId, List<String> fields)
MarketoResponse<LeadChanges>	getLeadChanges(String nextPageToken, Integer batchSize, Integer listId, List<String> fields)
MarketoResponse<Partition>	getLeadPartitions()
MarketoResponse<MarketoList>	getListById(int id)
MarketoResponse<Campaign>	getMultipleCampaigns(List<Integer> ids, List<String> names, List<String> programNames, List<String> workspaceNames, Integer batchSize, String nextPageToken)
MarketoResponse<Map<String,Object>>	getMultipleLeadsByFilterType(String filterType, List<String> filterValues, List<String> fields, String nextPageToken, Integer batchSize)
MarketoResponse<Map<String,Object>>	getMultipleLeadsByListId(int listId, List<String> fields, String nextPageToken, Integer batchSize)
MarketoResponse<Map<String,Object>>	getMultipleLeadsByProgramId(int programId, List<String> fields, String nextPageToken, Integer batchSize)
MarketoResponse<MarketoList>	getMultipleLists(List<Integer> ids, List<String> names, List<String> programNames, List<String> workspaceNames, Integer batchSize, String nextPageToken)
MarketoResponse<Void>	getPagingToken(Calendar sinceDateTime)
MarketoResponse<Map<String,Object>>	importLead(ImportLeadFormats format, InputStream file, String lookupField, Integer listId, String partitionName)
MarketoResponse<LeadsList>	memberOfList(int listId, List<Integer> ids)
MarketoResponse<Void>	mergeLead(int leadId, List<LeadId> losingLeadIds, boolean mergeInCRM)
MarketoResponse<LeadsList>	removeLeadsFromList(int listId, List<Integer> ids)
MarketoResponse<IdOnlyObject>	requestCampaign(int marketoId, List<Integer> leads, List<CampaignTokens> tokens)
MarketoResponse<IdOnlyObject>	scheduleCampaign(int marketoId, Calendar runAt, String cloneToProgramName, List<CampaignTokens> tokens)
MarketoResponse<PartitionResponse>	updateLeadsPartition(List<UpdateLeadPartition> input)

Method Detail

describe

MarketoResponse<Lead> describe()

createLead

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

deleteLead

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

getLeadById

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

getDailyUsage

MarketoResponse<DailyUsage> getDailyUsage()

getLast7DaysUsage

MarketoResponse<DailyUsage> getLast7DaysUsage()

getDailyErrors

MarketoResponse<DailyErrors> getDailyErrors()

getLast7DaysErrors

MarketoResponse<DailyErrors> getLast7DaysErrors()

getPagingToken

MarketoResponse<Void> getPagingToken(@NotNull
                                   Calendar sinceDateTime)

getActivityTypes

MarketoResponse<ActivityTypes> getActivityTypes()

getDeletedLeads

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

getLeadChanges

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

getLeadActivities

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

getCampaignById

MarketoResponse<Campaign> getCampaignById(int marketoId)

getMultipleCampaigns

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)

scheduleCampaign

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

requestCampaign

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

getMultipleLists

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)

getListById

MarketoResponse<MarketoList> getListById(int id)

addLeadsToList

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

removeLeadsFromList

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

memberOfList

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

importLead

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

getImportLeadStatus

MarketoResponse<LeadStatus> getImportLeadStatus(int batchId)

getImportFailureFile

MarketoResponse<File> getImportFailureFile(int batchId)
                                           throws MarketoException

Throws:

MarketoException

getImportWarningFile

MarketoResponse<File> getImportWarningFile(int batchId)
                                           throws MarketoException

Throws:

MarketoException

getLeadPartitions

MarketoResponse<Partition> getLeadPartitions()

associateLead

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

mergeLead

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

getMultipleLeadsByListId

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

getMultipleLeadsByProgramId

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

getMultipleLeadsByFilterType

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

updateLeadsPartition

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