MarketoConnector (Mule Marketo Connector 2.0.2 API)

java.lang.Object
- org.mule.modules.marketo.MarketoConnector

@Connector(name="marketo",
           minMuleVersion="3.7",
           friendlyName="Marketo")
@RequiresEnterpriseLicense(allowEval=true)
public class MarketoConnector
extends Object

Marketo Connector.

Author:: Mulesoft

Constructor Summary

Constructors
Constructor and Description

MarketoConnector()

Constructors
Constructor and Description
`MarketoConnector()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<LeadsList>`	`addLeadsToList(int listId, List<Integer> leadIds, org.mule.api.MuleMessage muleMessage)` Allows the called to add leads to a list
`EmailId`	`approveEmailById(int emailId, org.mule.api.MuleMessage muleMessage)` Allows the caller to approve the draft version of an email by ID.
`EmailTemplate`	`approveEmailTemplateById(int templateId, org.mule.api.MuleMessage muleMessage)` Allows the caller to approve an email template by its ID.
`IdOnlyProgram`	`approveProgram(int programId, org.mule.api.MuleMessage muleMessage)` Allows the caller to approve a program by ID.
`Snippet`	`approveSnippetById(int snippetId, org.mule.api.MuleMessage muleMessage)` Allows the caller to approve the draft version of a snippet by ID.
`void`	`associateLead(int leadId, String cookie, org.mule.api.MuleMessage muleMessage)` Allows the caller to associate a lead with a cookie value
`org.mule.streaming.ProviderAwarePagingDelegate<Folder,MarketoConnector>`	`browseFolders(FolderId root, Integer maxDepth, String workSpace, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the contents of a folder.
`org.mule.streaming.ProviderAwarePagingDelegate<ProgramResponse,MarketoConnector>`	`browsePrograms(ProgramStatus status, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Retrieves a list of programs.
`EmailResponse`	`cloneEmailById(int emailId, String emailName, FolderId folder, String description, Boolean isOperational, org.mule.api.MuleMessage muleMessage)` Allows the caller to clone an email by its ID.
`EmailTemplate`	`cloneEmailTemplate(int templateId, String emailTemplateName, FolderId folder, org.mule.api.MuleMessage muleMessage)` Allows the caller to clone an email template.
`ProgramResponse`	`cloneProgram(int programId, String programName, FolderId folder, String description, org.mule.api.MuleMessage muleMessage)` Allows to user to clone a program and its underlying assets to a target folder with the designated name and description.
`Snippet`	`cloneSnippetById(int snippetId, String snippetName, FolderId folder, String description, org.mule.api.MuleMessage muleMessage)` Allows the caller to clone a snippet by its ID.
`EmailResponse`	`createEmail(Email email, org.mule.api.MuleMessage muleMessage)` Allows the caller to create an email.
`EmailTemplate`	`createEmailTemplate(String emailTemplateName, FolderId folder, Object content, String description, org.mule.api.MuleMessage muleMessage)` Allows the caller to create an email template.
`AssetFile`	`createFile(String fileName, Object content, FolderId folder, String description, Boolean insertOnly, org.mule.api.MuleMessage muleMessage)` Allows the caller to upload a file.
`Folder`	`createFolder(String folderName, FolderId parent, String description, org.mule.api.MuleMessage muleMessage)` Allows the caller to create a folder.
`LandingPageTemplate`	`createLandingPageTemplate(String templateName, FolderId folder, String description, TemplateType templateType, org.mule.api.MuleMessage muleMessage)` Allows the caller create Landing Page Template.
`List<CustomObject>`	`createOrUpdateCustomObjects(String customObjectName, List<Map<String,Object>> customObjects, CustomObjectsActions actions, DedupeBy dedupeBy, org.mule.api.MuleMessage muleMessage)` Allows the caller to create, update, or upsert data for specified custom objects.
`List<CreateOrUpdateLead>`	`createOrUpdateLead(List<Map<String,Object>> records, String lookupField, LeadsActions action, boolean asyncProcessing, String partitionName, org.mule.api.MuleMessage muleMessage)` Allows the caller to create new leads within Marketo, or if the lead already exists update it with the submitted values
`List<OpportunityResponse>`	`createOrUpdateOpportunity(List<Map<String,Object>> objectDefinitions, EntityActions action, DedupeBy dedupeBy, org.mule.api.MuleMessage muleMessage)` Allows the caller to create/update or upsert opportunity object metadata.
`List<OpportunityResponse>`	`createOrUpdateOpportunityRoles(List<Map<String,Object>> objectDefinitions, EntityActions action, DedupeBy dedupeBy, org.mule.api.MuleMessage muleMessage)` Allows the caller to create/update or upsert opportunity role object
`ProgramResponse`	`createProgram(FolderId folder, String programName, ProgramType type, String description, String channel, List<Tag> tags, List<Cost> costs, org.mule.api.MuleMessage muleMessage)` Alows for the creation of a new program.
`Snippet`	`createSnippet(String snippetName, FolderId folder, String description, org.mule.api.MuleMessage muleMessage)` Allows the caller to create a snippet.
`TokenResponse`	`createToken(TokenCreateInput token, org.mule.api.MuleMessage muleMessage)` Allows the caller to create custom tokens for a folder or program.
`List<CreateOrUpdateEntity>`	`createUpdateUpsertCompanies(String key, List<Map<String,Object>> inputCompanies, org.mule.api.MuleMessage muleMessage)` Allows the caller to create/update or upsert company object metadata.
`List<CreateOrUpdateEntity>`	`createUpdateUpsertSalesPersons(String key, List<Map<String,Object>> inputSalesPersons, org.mule.api.MuleMessage muleMessage)` Allows the caller to create/update or upsert sales person objects records.
`List<DeletedEntity>`	`deleteCompanies(String deleteBy, List<Map<String,Object>> criteria, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete companies by dedupe fields or ID field.
`List<CustomObject>`	`deleteCustomObjects(String key, List<Map<String,Object>> criteria, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete custom objects by dedupe fields or id field
`EmailId`	`deleteEmailById(int emailId, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete an email by its ID.
`EmailTemplateId`	`deleteEmailTemplateById(int templateId, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete an email template by its ID.
`DeletedFolder`	`deleteFolderById(FolderId folderId, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete a folder by folder ID.
`List<CreateOrUpdateLead>`	`deleteLead(List<LeadId> records, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete leads
`List<OpportunityResponse>`	`deleteOpportunities(List<Map<String,Object>> searchValues, String deleteBy, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete opportunities by dedupe fields or id field
`List<OpportunityResponse>`	`deleteOpportunityRoles(List<Map<String,Object>> searchValues, String deleteBy, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete opportunity by dedupe fields or id field.
`IdOnlyProgram`	`deleteProgramById(int programId, org.mule.api.MuleMessage muleMessage)` Allows deletion of program by Id.
`List<DeletedEntity>`	`deleteSalesPersons(String deleteBy, List<Map<String,Object>> criteria, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete sales persons by dedupe fields or ID field.
`SnippetId`	`deleteSnippet(int snippetId, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete a snippet by id.
`List<DeletedToken>`	`deleteTokensByFolderId(TokenDeleteInput token, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete a token by folder ID.
`EntityDescription`	`describeCompany(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve company object metadata.
`Map<String,Object>`	`describeCustomObjects(String customObjectName, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve the metadata for a specified custom object.
`List<Lead>`	`describeLead(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve all fields and the data type of a lead object.
`Opportunity`	`describeOpportunity(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve opportunity object metadata.
`Opportunity`	`describeOpportunityRole(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve opportunity role object metadata
`EntityDescription`	`describeSalesPerson(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve all fields and the data type of a sales person object.
`EmailId`	`discardEmailDraftById(int emailId, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete a draft email by ID.
`EmailTemplateId`	`discardEmailTemplateDraftById(int templateId, org.mule.api.MuleMessage muleMessage)` Allows the caller to discard a draft of an email template.
`SnippetId`	`discardSnippetDraftById(int snippetId, org.mule.api.MuleMessage muleMessage)` Allows the caller to delete a draft snippet by ID.
`List<ActivityTypes>`	`getActivityTypes(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve metadata about activity types
`Campaign`	`getCampaignById(int campaignId, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve a campaign using a Marketo ID
`Channel`	`getChannelByName(String channelName, org.mule.api.MuleMessage muleMessage)` Returns a channel by its name.
`org.mule.streaming.ProviderAwarePagingDelegate<Channel,MarketoConnector>`	`getChannels(org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Get Channels.
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getCompanies(String filterType, List<Map<String,Object>> filterValues, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve companies using specified input parameters.
`Config`	`getConfig()`
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getCustomObjects(String key, List<Map<String,Object>> searchValues, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve custom objects using specified input parameters
`DailyErrors`	`getDailyErrors(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve error codes and their count for the day
`DailyUsage`	`getDailyUsage(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve total and user-level usage count for the day
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getDeletedLeads(String nextPageToken, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve a list of leads that were deleted
`EmailResponse`	`getEmailById(int emailId, EmailStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to get an email based on its ID.
`EmailResponse`	`getEmailByName(String emailName, EmailStatus status, FolderId folder, org.mule.api.MuleMessage muleMessage)` Allows the caller to get an email by name.
`EmailContent`	`getEmailContentById(int emailId, EmailStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the content associated with an email by its ID.
`EmailDynamicContentResponse`	`getEmailDynamicContentById(int emailId, String dynamicContentId, org.mule.api.MuleMessage muleMessage)` Allows the caller to associate static or dynamic content to a given editable section of an email.
`org.mule.streaming.ProviderAwarePagingDelegate<EmailResponse,MarketoConnector>`	`getEmails(EmailStatus status, FolderId folder, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a list of emails.
`EmailTemplate`	`getEmailTemplateById(int templateId, EmailTemplateStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to get an email template by its ID.
`EmailTemplate`	`getEmailTemplateByName(String emailTemplateName, EmailTemplateStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to get an email template by its ID.
`EmailTemplateContent`	`getEmailTemplateContentById(int templateId, EmailTemplateStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the content associated with an email template by the template ID.
`org.mule.streaming.ProviderAwarePagingDelegate<EmailTemplate,MarketoConnector>`	`getEmailTemplates(EmailTemplateStatus status, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a list of email templates.
`AssetFile`	`getFileById(Integer fileId, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the contents of a file based on its ID.
`AssetFile`	`getFileByName(String fileName, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the contents of a file based on its name.
`org.mule.streaming.ProviderAwarePagingDelegate<AssetFile,MarketoConnector>`	`getFileList(FolderId folder, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a list of files from a folder.
`Folder`	`getFolderById(FolderId folderId, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a folder or program based on its ID.
`List<Folder>`	`getFolderByName(String folderName, FolderType type, Integer root, String workSpace, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a folder or program by name.
`org.mule.streaming.ProviderAwarePagingDelegate<FolderContents,MarketoConnector>`	`getFolderContents(FolderId folderId, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the contents of a folder.
`File`	`getImportFailureFile(int batchId, org.mule.api.MuleMessage muleMessage)` Allows the caller to return the failure file from Import Lead call in the same format that was used
`List<LeadStatus>`	`getImportLeadStatus(int batchId, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve the status of lead operation from Import Lead call
`File`	`getImportWarningFile(int batchId, org.mule.api.MuleMessage muleMessage)` Allows the caller to return the warning file from Import Lead call in the same format that was used
`LandingPageTemplateContent`	`getLandingPageContent(int templateId, LandingPageTemplateStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve Landing Page Template content.
`LandingPageTemplate`	`getLandingPageTemplateById(int templateId, LandingPageTemplateStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve Landing Page Template metadata.
`LandingPageTemplate`	`getLandingPageTemplateByName(String templateName, LandingPageTemplateStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve Landing Page Template metadata by Name.
`List<DailyErrors>`	`getLast7DaysErrors(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve error codes and their count for the last 7 days
`List<DailyUsage>`	`getLast7DaysUsage(org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve total and user-level usage count for last 7 days
`org.mule.streaming.ProviderAwarePagingDelegate<LeadActivities,MarketoConnector>`	`getLeadActivities(List<Integer> activityTypeIds, String nextPageToken, Integer listId, List<String> leadIds, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve activities for the requested activity types
`Map<String,Object>`	`getLeadById(int leadId, List<String> fields, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve a single lead using the Lead Id
`org.mule.streaming.ProviderAwarePagingDelegate<LeadChanges,MarketoConnector>`	`getLeadChanges(String nextPageToken, Integer listId, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve a list of changed data value for lead
`List<Partition>`	`getLeadPartitions(org.mule.api.MuleMessage muleMessage)` Allows the caller to return a list of lead partitions in a Marketo instance
`MarketoList`	`getListById(int listId, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve a List by their id
`List<Map<String,Object>>`	`getListOfCustomObjects(List<String> customObjectNames, org.mule.api.MuleMessage muleMessage)` Allows the called to retrieve a list of custom object definitions based on a specified search criteria
`org.mule.streaming.ProviderAwarePagingDelegate<Campaign,MarketoConnector>`	`getMultipleCampaigns(List<Integer> campaignIds, List<String> names, List<String> programNames, List<String> workspaceNames, String nextPageToken, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve multiple campaigns
`org.mule.streaming.ProviderAwarePagingDelegate<LandingPageTemplate,MarketoConnector>`	`getMultipleLandingPageTemplates(LandingPageTemplateStatus status, FolderId folder, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve metadata for multiple Landing Page Templates.
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getMultipleLeadsByFilterType(String filterType, List<String> filterValues, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve multiple leads for a given search criteria
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getMultipleLeadsByListId(int listId, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve multiple leads from a given list id
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getMultipleLeadsByProgramId(int programId, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve multiple leads from a given list id
`org.mule.streaming.ProviderAwarePagingDelegate<MarketoList,MarketoConnector>`	`getMultipleLists(List<Integer> listIds, List<String> names, List<String> programNames, List<String> workspaceNames, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve multiple lists.
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getOpportunities(String filterType, List<String> filterValues, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve opportunities using specified input parameters
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getOpportunityRoles(String filterType, List<String> filterValues, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve opportunity roles using specified input parameters
`String`	`getPagingToken(Calendar sinceDateTime, org.mule.api.MuleMessage muleMessage)` Allows the caller to retrieve a token for a given date
`ProgramResponse`	`getProgramById(int programId, org.mule.api.MuleMessage muleMessage)` Allows the user to retrieve a `program` based on its ID.
`ProgramResponse`	`getProgramByName(String programName, org.mule.api.MuleMessage muleMessage)` Allows a user to specify a name parameter to use to retrieve program data.
`List<ProgramResponse>`	`getProgramByTag(Tag tag, org.mule.api.MuleMessage muleMessage)` Allows a user to specify a `Tag` (type and value) parameter to use to retrieve program data.
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector>`	`getSalesPersons(String filterType, List<Map<String,Object>> filterValues, List<String> fields, org.mule.streaming.PagingConfiguration pagingConfiguration)` Allows the caller to retrieve sales persons using specified input parameters.
`org.mule.streaming.ProviderAwarePagingDelegate<Segmentation,MarketoConnector>`	`getSegmentations(SegmentStatus status, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Returns a list of segmentations present in the instance.
`org.mule.streaming.ProviderAwarePagingDelegate<Segment,MarketoConnector>`	`getSegments(int segmentationId, SegmentStatus status, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Retrieves a list of segments from a parent segmentation.
`Snippet`	`getSnippetById(int snippetId, SnippetStatus status, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a snippet based on its id.
`List<AssetContent<SnippetDynamicContentType>>`	`getSnippetContentById(int snippetId, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the content of a snippet by its ID.
`SnippetDynamicContentResponse`	`getSnippetDynamicContentById(int snippetId, org.mule.api.MuleMessage muleMessage)` Allows the caller to get the content of a segment that is associated with a snippet.
`org.mule.streaming.ProviderAwarePagingDelegate<Snippet,MarketoConnector>`	`getSnippets(SnippetStatus status, org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Allows the caller to get a list of snippets.
`TagType`	`getTagByName(String tagName, org.mule.api.MuleMessage muleMessage)` Returns a tag by its name.
`org.mule.streaming.ProviderAwarePagingDelegate<TagType,MarketoConnector>`	`getTags(org.mule.streaming.PagingConfiguration pagingConfiguration, org.mule.api.MuleMessage muleMessage)` Returns a list of all available tags in the target instance.
`TokenResponse`	`getTokenByFolderId(FolderId folderId, org.mule.api.MuleMessage muleMessage)` Allows the caller to get tokens for a folder based on the folder ID.
`List<Map<String,Object>>`	`importLead(ImportLeadFormats format, Object file, String lookupField, Integer listId, String partitionName, org.mule.api.MuleMessage muleMessage)` Allows the caller to sync leads in bulk
`List<LeadsList>`	`memberOfList(int listId, List<Integer> leadIds, org.mule.api.MuleMessage muleMessage)` Allows the caller to find out if leads are a member of a given list
`void`	`mergeLead(int leadId, List<LeadId> losingLeadIds, boolean mergeInCRM, org.mule.api.MuleMessage muleMessage)` Allows the caller to merge a winning lead and a list of losers leads.
`List<LeadsList>`	`removeLeadsFromList(int listId, List<Integer> leadIds, org.mule.api.MuleMessage muleMessage)` Allows the caller to remove a lead from a list
`IdOnlyObject`	`requestCampaign(int campaignId, List<Integer> leads, List<CampaignTokens> tokens, org.mule.api.MuleMessage muleMessage)` Allows the user to run an existing Marketo lead in a Marketo Smart Campaign
`IdOnlyObject`	`scheduleCampaign(int campaignId, Calendar runAt, String cloneToProgramName, List<CampaignTokens> token, org.mule.api.MuleMessage muleMessage)` Allows the caller to schedule a batch Smart Campaign to run either immediately or at a future date
`ServiceResponse`	`sendSampleEmail(int emailId, String emailAddress, Boolean textOnly, Integer leadId, org.mule.api.MuleMessage muleMessage)` Allows the caller to send a sample email to a given address.
`void`	`setConfig(Config config)`
`EmailId`	`unapproveEmailById(int emailId, org.mule.api.MuleMessage muleMessage)` Allows the caller to unapprove an email by ID.
`EmailTemplate`	`unapproveEmailTemplateById(int templateId, org.mule.api.MuleMessage muleMessage)` Allows the caller to unapprove an email template by its ID.
`IdOnlyProgram`	`unapproveProgram(int programId, org.mule.api.MuleMessage muleMessage)` Allows the caller to unapprove a program.
`Snippet`	`unapproveSnippetById(int snippetId, org.mule.api.MuleMessage muleMessage)` Allows the caller to unapprove a snippet by ID.
`EmailResponse`	`updateEmail(int emailId, String description, String emailName, org.mule.api.MuleMessage muleMessage)` Allows the caller to update an email using its ID.
`EmailId`	`updateEmailContentById(int emailId, EmailField subject, EmailField fromEmail, EmailField fromName, EmailField replyTo, org.mule.api.MuleMessage muleMessage)` Allows the caller to update an email's content by id.
`EmailId`	`updateEmailContentInEditableSection(int emailId, String htmlId, EmailContentType type, Object value, String textValue, org.mule.api.MuleMessage muleMessage)` Allows the caller to associate static or dynamic content to a given editable section of an email.
`EmailId`	`updateEmailDynamicContentById(int emailId, String dynamicContentId, String segment, String value, EmailDynamicContentType type, org.mule.api.MuleMessage muleMessage)` Allows the caller to create or update a section of the dynamic content of an email by segment ID.
`EmailTemplate`	`updateEmailTemplate(int templateId, String description, String emailTemplateName, org.mule.api.MuleMessage muleMessage)` Allows the caller to update an email template.
`EmailTemplateId`	`updateEmailTemplateContentById(int templateId, Object content, org.mule.api.MuleMessage muleMessage)` Allows the caller to update the content of an email template by the template ID.
`AssetFile`	`updateFile(Integer fileId, Object content, org.mule.api.MuleMessage muleMessage)` Allows the caller to replace the content of the file with the given id.
`Folder`	`updateFolder(FolderId folderId, String description, String newFolderName, Boolean isArchive, org.mule.api.MuleMessage muleMessage)` Allows the caller to update a folder using its ID.
`LandingPageTemplate`	`updateLandingPageTemplate(int templateId, String templateName, String description, org.mule.api.MuleMessage muleMessage)` Allows the caller to update Landing Page Template metadata.
`UpdatedLandingPageTemplate`	`updateLandingPageTemplateContentById(LandingPageTemplateContent landingPageTemplateContent, org.mule.api.MuleMessage muleMessage)` Allows the caller to update the content of a landing page template.
`List<PartitionResponse>`	`updateLeadsPartition(List<UpdateLeadPartition> input, org.mule.api.MuleMessage muleMessage)` Allows the caller to update the partition for one or more leads
`ProgramResponse`	`updateProgram(int programId, String description, String programName, List<Tag> tags, List<Cost> costs, boolean costsDestructiveUpdate, org.mule.api.MuleMessage muleMessage)` Allows the user to update fields on the target program.
`Snippet`	`updateSnippetById(int snippetId, String description, String snippetName, org.mule.api.MuleMessage muleMessage)` Allows the caller to update a snippet using its id.
`SnippetId`	`updateSnippetContentById(int snippetId, SnippetDynamicContentType type, String content, org.mule.api.MuleMessage muleMessage)` Allows the caller to update the content of a snippet by its ID.
`SnippetId`	`updateSnippetDynamicContentById(int snippetId, int segmentId, SnippetDynamicContentType type, String value, org.mule.api.MuleMessage muleMessage)` Allows the caller to update the content of a segment that is associated with a snippet.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MarketoConnector
```
public MarketoConnector()
```

Method Detail

getConfig
```
public Config getConfig()
```

setConfig
```
public void setConfig(Config config)
```

getChannels

@Processor(friendlyName="Program | Get Channels")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Channel,MarketoConnector> getChannels(@RefOnly
                                                                                                   org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                   org.mule.api.MuleMessage muleMessage)
                                                                                     throws MarketoException

Get Channels.

This function retrieves the following information about a channel set up in Marketo:

Progression status(es)
Step number of each progression status
Whether a specific progression status has been defined as success

Parameters:: pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of Channels.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/get-channels/

getChannelByName
```
@Processor(friendlyName="Program | Get Channel by Name")
public Channel getChannelByName(@Default(value="#[payload]")
                                 String channelName,
                                 org.mule.api.MuleMessage muleMessage)
                         throws MarketoException
```
Returns a channel by its name.

Parameters:
channelName - The name of the channel to retrieve.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The requested Channel.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/get-channel-by-name/

describeCustomObjects

@Processor(friendlyName="Custom Objects | Describe Custom Objects")
@MetaDataScope(value=GetCustomObjectsNamesMetaData.class)
public Map<String,Object> describeCustomObjects(@MetaDataKeyParam
                                                                                                  String customObjectName,
                                                                                                  org.mule.api.MuleMessage muleMessage)
                                         throws MarketoException

Allows the caller to retrieve the metadata for a specified custom object.

Parameters:: customObjectName - the name of the custom object; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a {java.util.List} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/custom-api/describe-custom-object/

createOrUpdateCustomObjects

@Processor(friendlyName="Custom Objects | Create or Update Custom Objects")
@MetaDataScope(value=CreateUpdateCustomObjectsMetaData.class)
public List<CustomObject> createOrUpdateCustomObjects(@MetaDataKeyParam(affects=INPUT)
                                                                                                            String customObjectName,
                                                                                                            @RefOnly@Default(value="#[payload]")
                                                                                                            List<Map<String,Object>> customObjects,
                                                                                                            @Default(value="CREATE_OR_UPDATE")
                                                                                                            CustomObjectsActions actions,
                                                                                                            @Default(value="DEDUPE_FIELDS")
                                                                                                            DedupeBy dedupeBy,
                                                                                                            org.mule.api.MuleMessage muleMessage)
                                               throws MarketoException

Allows the caller to create, update, or upsert data for specified custom objects.

Parameters:: customObjectName - the name of the custom object; customObjects - the custom object definitions; actions - the storage operation. Default: createOrUpdate; dedupeBy - the deduplication method. Only valid if actions is UpdateOnly. Default: dedupeFields; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a List of {org.mule.modules.marketo.model.customobject.CustomObject} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/custom-api/createupdateupsert-custom-objects/

getListOfCustomObjects
```
@Processor(friendlyName="Custom Objects | Get List of Custom Objects")
public List<Map<String,Object>> getListOfCustomObjects(@Default(value="#[payload]")
                                                        List<String> customObjectNames,
                                                        org.mule.api.MuleMessage muleMessage)
                                                throws MarketoException
```
Allows the called to retrieve a list of custom object definitions based on a specified search criteria

Parameters:
customObjectNames - list of custom object names. If not specified, then all custom objects are returned
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/custom-api/get-list-of-custom-objects/

deleteCustomObjects

@Processor(friendlyName="Custom Objects | Delete Custom Objects")
@MetaDataScope(value=DeleteCustomObjectsMetaData.class)
public List<CustomObject> deleteCustomObjects(@MetaDataKeyParam(affects=INPUT,labels={"Custom Object Name","Dedupe By"})
                                                                                              String key,
                                                                                              @RefOnly@Default(value="#[payload]")
                                                                                              List<Map<String,Object>> criteria,
                                                                                              org.mule.api.MuleMessage muleMessage)
                                       throws MarketoException

Allows the caller to delete custom objects by dedupe fields or id field

Parameters:: criteria - deletion criteria; key - the MetaDataKey. Must have the following format: (customObjectName)||(dedupeBy). DedupeBy can be dedupeFields or idField.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a List of {org.mule.modules.marketo.model.customobject.CustomObject} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/custom-api/delete-custom-objects/

getCustomObjects

@Processor(friendlyName="Custom Objects | Get Custom Objects")
@Paged
@MetaDataScope(value=GetCustomObjectsMetaData.class)
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getCustomObjects(@MetaDataKeyParam(affects=BOTH,labels={"Custom Object Name","Filter Type"})
                                                                                                                                                               String key,
                                                                                                                                                               @RefOnly@Default(value="#[payload]")
                                                                                                                                                               List<Map<String,Object>> searchValues,
                                                                                                                                                               @Optional
                                                                                                                                                               List<String> fields,
                                                                                                                                                               @RefOnly
                                                                                                                                                               org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                     throws MarketoException

Allows the caller to retrieve custom objects using specified input parameters

Parameters:: searchValues - search values; key - the MetaDataKey. Must have the following format: (customObjectName)||(filterType). FilterType can be be any of the searchableFields set that has a single field in it.; fields - list of fields to return. If not specified, then contains the following fields: marketoGuid, dedupeFields, updatedAt, createdAt and filterType; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/custom-api/get-custom-objects/

getDailyUsage
```
@Processor(friendlyName="Usage and Error Counts | Get Daily Usage")
public DailyUsage getDailyUsage(org.mule.api.MuleMessage muleMessage)
                         throws MarketoException
```
Allows the caller to retrieve total and user-level usage count for the day

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-daily-usage

getLast7DaysUsage
```
@Processor(friendlyName="Usage and Error Counts | Get Last 7 Days Usage")
public List<DailyUsage> getLast7DaysUsage(org.mule.api.MuleMessage muleMessage)
                                   throws MarketoException
```
Allows the caller to retrieve total and user-level usage count for last 7 days

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-last-7-days-usage

getDailyErrors
```
@Processor(friendlyName="Usage and Error Counts | Get Daily Errors")
public DailyErrors getDailyErrors(org.mule.api.MuleMessage muleMessage)
                           throws MarketoException
```
Allows the caller to retrieve error codes and their count for the day

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-daily-errors

getLast7DaysErrors
```
@Processor(friendlyName="Usage and Error Counts | Get Last 7 Days Errors")
public List<DailyErrors> getLast7DaysErrors(org.mule.api.MuleMessage muleMessage)
                                     throws MarketoException
```
Allows the caller to retrieve error codes and their count for the last 7 days

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-last-7-days-errors

getPagingToken
```
@Processor(friendlyName="Activities | Get Paging Token")
public String getPagingToken(@Default(value="#[payload]")
                              Calendar sinceDateTime,
                              org.mule.api.MuleMessage muleMessage)
                      throws MarketoException
```
Allows the caller to retrieve a token for a given date

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"
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-paging-token/

getActivityTypes
```
@Processor(friendlyName="Activities | Get Activity Types")
public List<ActivityTypes> getActivityTypes(org.mule.api.MuleMessage muleMessage)
                                     throws MarketoException
```
Allows the caller to retrieve metadata about activity types

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-activity-types/

getDeletedLeads

@Processor(friendlyName="Activities | Get Deleted Leads")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getDeletedLeads(@Default(value="#[payload]")
                                                                                                                  String nextPageToken,
                                                                                                                  @RefOnly
                                                                                                                  org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                    throws MarketoException

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

Parameters:: nextPageToken - used to paginate through large result sets; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-deleted-leads/

getLeadChanges

@Processor(friendlyName="Activities | Get Lead Changes")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<LeadChanges,MarketoConnector> getLeadChanges(@Default(value="#[payload]")
                                                                                                          String nextPageToken,
                                                                                                          @Optional
                                                                                                          Integer listId,
                                                                                                          @Optional
                                                                                                          List<String> fields,
                                                                                                          @RefOnly
                                                                                                          org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                            throws MarketoException

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

Parameters:: nextPageToken - used to paginate through large result sets; listId - the activities for leads with in this given list; fields - the fields to return; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.
Returns:: LeadChanges with the call response} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-lead-changes/

getLeadActivities

@Processor(friendlyName="Activities | Get Lead Activities")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<LeadActivities,MarketoConnector> getLeadActivities(@RefOnly
                                                                                                                List<Integer> activityTypeIds,
                                                                                                                @Default(value="#[payload]")
                                                                                                                String nextPageToken,
                                                                                                                @Optional
                                                                                                                Integer listId,
                                                                                                                @Optional
                                                                                                                List<String> leadIds,
                                                                                                                @RefOnly
                                                                                                                org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                  throws MarketoException

Allows the caller to retrieve activities for the requested activity types

Parameters:: activityTypeIds - a list of activity type ids (max 10); nextPageToken - used to paginate through large result sets; listId - the activities for leads with in this given list; leadIds - a list of lead IDs; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of LeadActivities with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-lead-activities/

getCampaignById
```
@Processor(friendlyName="Campaigns | Get Campaign By Id")
public Campaign getCampaignById(int campaignId,
                                 org.mule.api.MuleMessage muleMessage)
                         throws MarketoException
```
Allows the caller to retrieve a campaign using a Marketo ID

Parameters:
campaignId - the campaign ID
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a Campaign with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-campaign-by-id/

getMultipleCampaigns

@Paged
@Processor(friendlyName="Campaigns | Get Multiple Campaigns")
public org.mule.streaming.ProviderAwarePagingDelegate<Campaign,MarketoConnector> getMultipleCampaigns(@RefOnly@Optional
                                                                                                             List<Integer> campaignIds,
                                                                                                             @Default(value="#[payload]")
                                                                                                             List<String> names,
                                                                                                             @Optional
                                                                                                             List<String> programNames,
                                                                                                             @Optional
                                                                                                             List<String> workspaceNames,
                                                                                                             @Optional
                                                                                                             String nextPageToken,
                                                                                                             @RefOnly
                                                                                                             org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                               throws MarketoException

Allows the caller to retrieve multiple campaigns

Parameters:: campaignIds - the campaigns ids; names - the campaigns names; programNames - the program names; workspaceNames - the workspaces names; nextPageToken - used to paginate through large result sets; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Campaign with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-multiple-campaigns/

scheduleCampaign

@Processor(friendlyName="Campaigns | Schedule Campaign")
public IdOnlyObject scheduleCampaign(int campaignId,
                                      @Optional
                                      Calendar runAt,
                                      @Optional
                                      String cloneToProgramName,
                                      @RefOnly@Default(value="#[payload]")
                                      List<CampaignTokens> token,
                                      org.mule.api.MuleMessage muleMessage)
                              throws MarketoException

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

Parameters:: campaignId - the campaign ID; 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.; token - The name of the token/s you want to send a new value for.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested campaign id IdOnlyObject.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/schedule-campaign/

requestCampaign

@Processor(friendlyName="Campaigns | Request Campaign")
public IdOnlyObject requestCampaign(int campaignId,
                                     @RefOnly
                                     List<Integer> leads,
                                     @RefOnly@Default(value="#[payload]")
                                     List<CampaignTokens> tokens,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException

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

Parameters:: campaignId - the campaign ID; leads - a list of lead IDs; tokens - the name of the token/s you want to send a new value for; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested campaign id IdOnlyObject.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/request-campaign/

createFolder
```
@Processor(friendlyName="Assets | Folder | Create Folder")
public Folder createFolder(@Default(value="#[payload]")
                            String folderName,
                            @RefOnly
                            FolderId parent,
                            @Optional
                            String description,
                            org.mule.api.MuleMessage muleMessage)
                    throws MarketoException
```
Allows the caller to create a folder.

Parameters:
folderName - Name for the folder shown in UI. Name has to be unique under the parent folder. Maximum length 255 characters.
parent - Parent folder under which the folder will be created.
description - Description for the folder. Data type: String. Maximum length 2000 characters.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The Folder that was created.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/create-folder

getFolderById
```
@Processor(friendlyName="Assets | Folder | Get Folder by ID")
public Folder getFolderById(@RefOnly@Default(value="#[payload]")
                             FolderId folderId,
                             org.mule.api.MuleMessage muleMessage)
                     throws MarketoException
```
Allows the caller to get a folder or program based on its ID.

Parameters:
folderId - The ID for folder in database.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The requested Folder.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/get-folder-by-id

getFolderByName

@Processor(friendlyName="Assets | Folder | Get Folder by name")
public List<Folder> getFolderByName(@Default(value="#[payload]")
                                     String folderName,
                                     @RefOnly@Optional
                                     FolderType type,
                                     @Optional
                                     Integer root,
                                     @Optional
                                     String workSpace,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException

Allows the caller to get a folder or program by name.

Parameters:: folderName - Name of folder in the database. Case insensitive.; type - Type of folder to retrieve.; root - ID of the parent folder in the database.; workSpace - Workspace that folder belongs to.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested List of Folders.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-folder-by-name

getFolderContents

@Processor(friendlyName="Assets | Folder | Get Folder Contents")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<FolderContents,MarketoConnector> getFolderContents(@RefOnly@Default(value="#[payload]")
                                                                                                                FolderId folderId,
                                                                                                                @RefOnly
                                                                                                                org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                                org.mule.api.MuleMessage muleMessage)
                                                                                                  throws MarketoException

Allows the caller to get the contents of a folder.

Parameters:: folderId - ID and Type of folder to retrieve.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The contents of the folder, as a List of FolderContents.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-folder-contents/

updateFolder

@Processor(friendlyName="Assets | Folder | Update Folder")
public Folder updateFolder(@RefOnly@Default(value="#[payload]")
                            FolderId folderId,
                            @Optional
                            String description,
                            @Optional
                            String newFolderName,
                            @Optional
                            Boolean isArchive,
                            org.mule.api.MuleMessage muleMessage)
                    throws MarketoException

Allows the caller to update a folder using its ID.

Parameters:: folderId - ID and Type of folder to update.; description - Update folder with this description. Maximum length 2000 characters.; newFolderName - Update folder with this name. Maximum length 255 characters. Must be unique to the workspace. Name cannot be updated for programs.; isArchive - Set to true to archive the folder. If true, then all children folders will be archived as well.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The updated Folder.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-folder

deleteFolderById
```
@Processor(friendlyName="Assets | Folder | Delete Folder by ID")
public DeletedFolder deleteFolderById(@RefOnly@Default(value="#[payload]")
                                       FolderId folderId,
                                       org.mule.api.MuleMessage muleMessage)
                               throws MarketoException
```
Allows the caller to delete a folder by folder ID.

Parameters:
folderId - ID and Type of folder to be deleted.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The deleted Folder, with only its ID populated.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/delete-folder-by-id

browseFolders

@Processor(friendlyName="Assets | Folder | Browse Folders")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Folder,MarketoConnector> browseFolders(@RefOnly@Default(value="#[payload]")
                                                                                                    FolderId root,
                                                                                                    @Optional
                                                                                                    Integer maxDepth,
                                                                                                    @Optional
                                                                                                    String workSpace,
                                                                                                    @RefOnly
                                                                                                    org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                    org.mule.api.MuleMessage muleMessage)
                                                                                      throws MarketoException

Allows the caller to get the contents of a folder.

Parameters:: root - ID and Type of Root folder in the database.; maxDepth - Maximum number of levels to inspect in directory hierarchy. Default value is 2; workSpace - Workspace filter.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of Folders inside the root Folder.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/browse-folders

createFile

@Processor(friendlyName="Assets | File | Create file")
public AssetFile createFile(String fileName,
                             @RefOnly@Default(value="#[payload]")
                             Object content,
                             @RefOnly
                             FolderId folder,
                             @Optional
                             String description,
                             @Optional
                             Boolean insertOnly,
                             org.mule.api.MuleMessage muleMessage)
                     throws MarketoException

Allows the caller to upload a file.

Parameters:: fileName - The name of the file to be uploaded.; content - The content of the file.; folder - The ID and Type of the parent folder under which the file will be created.; description - The name of the file to be uploaded.; insertOnly - Sets if existing files are overwritten.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The created AssetFile.
Throws:: MarketoException - on valid error from the endpoint.
Api.doc:: http://developers.marketo.com/documentation/asset-api/create-a-file

getFileById
```
@Processor(friendlyName="Assets | File | Get file by ID")
public AssetFile getFileById(Integer fileId,
                              org.mule.api.MuleMessage muleMessage)
                      throws MarketoException
```
Allows the caller to get the contents of a file based on its ID.

Parameters:
fileId - ID of the file to be retrieved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The AssetFile with the given id.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/get-file-by-id

getSegmentations

@Processor(friendlyName="Assets | Segmentations | Get Segmentations")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Segmentation,MarketoConnector> getSegmentations(@Optional
                                                                                                             SegmentStatus status,
                                                                                                             @RefOnly
                                                                                                             org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                             org.mule.api.MuleMessage muleMessage)
                                                                                               throws MarketoException

Returns a list of segmentations present in the instance.

Parameters:: status - Optional status filter for segmentations.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of Segmentations.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-segmentation-by-id/

getSegments

@Processor(friendlyName="Assets | Segmentations | Get Segments")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Segment,MarketoConnector> getSegments(int segmentationId,
                                                                                                   @Optional
                                                                                                   SegmentStatus status,
                                                                                                   @RefOnly
                                                                                                   org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                   org.mule.api.MuleMessage muleMessage)
                                                                                     throws MarketoException

Retrieves a list of segments from a parent segmentation.

Parameters:: segmentationId - ID of the parent segmentation.; status - Query parameter to filter on draft or approved set of segments.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of Segments.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-segments/

getMultipleLists

@Paged
@Processor(friendlyName="Lists | Get Multiple Lists")
public org.mule.streaming.ProviderAwarePagingDelegate<MarketoList,MarketoConnector> getMultipleLists(@RefOnly@Optional
                                                                                                            List<Integer> listIds,
                                                                                                            @Default(value="#[payload]")
                                                                                                            List<String> names,
                                                                                                            @Optional
                                                                                                            List<String> programNames,
                                                                                                            @Optional
                                                                                                            List<String> workspaceNames,
                                                                                                            @RefOnly
                                                                                                            org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                              throws MarketoException

Allows the caller to retrieve multiple lists.

Parameters:: listIds - the list of ids; names - the list of names; programNames - the list of program names; workspaceNames - the list of workspace names; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of MarketoList with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-multiple-lists/

getListById
```
@Processor(friendlyName="Lists | Get List By Id")
public MarketoList getListById(int listId,
                                org.mule.api.MuleMessage muleMessage)
                        throws MarketoException
```
Allows the caller to retrieve a List by their id

Parameters:
listId - the list id
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-list-by-id/

getFileByName
```
@Processor(friendlyName="Assets | File | Get file by name")
public AssetFile getFileByName(@Default(value="#[payload]")
                                String fileName,
                                org.mule.api.MuleMessage muleMessage)
                        throws MarketoException
```
Allows the caller to get the contents of a file based on its name.

Parameters:
fileName - Name of the file to be retrieved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The AssetFile with the given name.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/get-file-by-name

createToken

@Processor(friendlyName="Assets | Tokens | Create Token")
public TokenResponse createToken(@RefOnly@Default(value="#[payload]")
                                  TokenCreateInput token,
                                  org.mule.api.MuleMessage muleMessage)
                          throws MarketoException

Allows the caller to create custom tokens for a folder or program.

Parameters:: token - The token to create.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The created Token.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/create-token-by-folder-id/

getFileList

@Processor(friendlyName="Assets | File | List files")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<AssetFile,MarketoConnector> getFileList(@RefOnly@Default(value="#[payload]")
                                                                                                     FolderId folder,
                                                                                                     @RefOnly
                                                                                                     org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                     org.mule.api.MuleMessage muleMessage)
                                                                                       throws MarketoException

Allows the caller to get a list of files from a folder.

Parameters:: folder - ID and Type of folder to retrieve.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The contents of the folder, as a List of AssetFiles.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/list-files

getTokenByFolderId

@Processor(friendlyName="Assets | Tokens | Get Tokens by Folder ID")
public TokenResponse getTokenByFolderId(@RefOnly@Default(value="#[payload]")
                                         FolderId folderId,
                                         org.mule.api.MuleMessage muleMessage)
                                 throws MarketoException

Allows the caller to get tokens for a folder based on the folder ID.

Parameters:: folderId - ID of folder or program.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of Tokens.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-tokens-by-folder-id/

addLeadsToList
```
@Processor(friendlyName="Lists | Add Leads To List")
public List<LeadsList> addLeadsToList(int listId,
                                       @RefOnly
                                       List<Integer> leadIds,
                                       org.mule.api.MuleMessage muleMessage)
                               throws MarketoException
```
Allows the called to add leads to a list

Parameters:
listId - the desired list where the leads will be added
leadIds - the list of lead ids
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/add-leads-to-list/

updateFile

@Processor(friendlyName="Assets | File | Update file content")
public AssetFile updateFile(@RefOnly
                             Integer fileId,
                             @RefOnly@Default(value="#[payload]")
                             Object content,
                             org.mule.api.MuleMessage muleMessage)
                     throws MarketoException

Allows the caller to replace the content of the file with the given id.

Parameters:: fileId - ID of the file to update.; content - The new content of the file.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The updated AssetFile.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/get-channels/

removeLeadsFromList
```
@Processor(friendlyName="Lists | Remove Leads From List")
public List<LeadsList> removeLeadsFromList(int listId,
                                            @RefOnly@Optional
                                            List<Integer> leadIds,
                                            org.mule.api.MuleMessage muleMessage)
                                    throws MarketoException
```
Allows the caller to remove a lead from a list

Parameters:
listId - the desired list where the leads will be removed
leadIds - the list of lead ids
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/remove-leads-from-list/

memberOfList
```
@Processor(friendlyName="Lists | Member Of List")
public List<LeadsList> memberOfList(int listId,
                                     @RefOnly
                                     List<Integer> leadIds,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException
```
Allows the caller to find out if leads are a member of a given list

Parameters:
listId - the desired list where the leads will be removed
leadIds - the list of lead ids
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/remove-leads-from-list/

importLead

@Processor(friendlyName="Lists | Import Lead")
public List<Map<String,Object>> importLead(@Default(value="CSV")
                                            ImportLeadFormats format,
                                            @RefOnly@Default(value="#[payload]")
                                            Object file,
                                            @Optional
                                            String lookupField,
                                            @Optional
                                            Integer listId,
                                            @Optional
                                            String partitionName,
                                            org.mule.api.MuleMessage muleMessage)
                                    throws MarketoException

Allows the caller to sync leads in bulk

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; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a {java.util.List} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/import-lead/

getImportLeadStatus
```
@Processor(friendlyName="Lists | Get Import Lead Status")
public List<LeadStatus> getImportLeadStatus(int batchId,
                                             org.mule.api.MuleMessage muleMessage)
                                     throws MarketoException
```
Allows the caller to retrieve the status of lead operation from Import Lead call

Parameters:
batchId - the batch id returned from Import Lead call
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-import-lead-status/

getImportFailureFile
```
@Processor(friendlyName="Lists | Get Import Failure File")
public File getImportFailureFile(int batchId,
                                  org.mule.api.MuleMessage muleMessage)
                          throws MarketoException
```
Allows the caller to return the failure file from Import Lead call in the same format that was used

Parameters:
batchId - the batch id returned from Import Lead call
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-import-failure-file/

getImportWarningFile
```
@Processor(friendlyName="Lists | Get Import Warning File")
public File getImportWarningFile(int batchId,
                                  org.mule.api.MuleMessage muleMessage)
                          throws MarketoException
```
Allows the caller to return the warning file from Import Lead call in the same format that was used

Parameters:
batchId - the batch id returned from Import Lead call
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-import-warning-file/

deleteTokensByFolderId

@Processor(friendlyName="Assets | Tokens | Delete Tokens by Folder ID")
public List<DeletedToken> deleteTokensByFolderId(@RefOnly@Default(value="#[payload]")
                                                  TokenDeleteInput token,
                                                  org.mule.api.MuleMessage muleMessage)
                                          throws MarketoException

Allows the caller to delete a token by folder ID.

Parameters:: token - The token to delete.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The DeletedTokens, containing only their folder IDs.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/delete-tokens-by-folder-id/

createOrUpdateLead

@Processor(friendlyName="Leads | Create Or Update")
@MetaDataScope(value=CreateLeadFieldsMetaData.class)
public List<CreateOrUpdateLead> createOrUpdateLead(@RefOnly@Default(value="#[payload]")
                                                                                                List<Map<String,Object>> records,
                                                                                                @Optional
                                                                                                String lookupField,
                                                                                                @Default(value="CREATE_OR_UPDATE")
                                                                                                LeadsActions action,
                                                                                                @Default(value="false")
                                                                                                boolean asyncProcessing,
                                                                                                @Optional
                                                                                                String partitionName,
                                                                                                org.mule.api.MuleMessage muleMessage)
                                            throws MarketoException

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

Parameters:: records - 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
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/createupdate-leads/

deleteLead

@Processor(friendlyName="Leads | Delete Lead")
public List<CreateOrUpdateLead> deleteLead(@RefOnly@Default(value="#[payload]")
                                            List<LeadId> records,
                                            org.mule.api.MuleMessage muleMessage)
                                    throws MarketoException

Allows the caller to delete leads

Parameters:: records - array of lead ids records to delete
Returns:: a {org.mule.modules.marketo.model.lead.CreateOrUpdateLead} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/delete-lead/

getLeadById

@MetaDataScope(value=CreateLeadFieldsMetaData.class)
@Processor(friendlyName="Leads | Get Lead By Id")
public Map<String,Object> getLeadById(int leadId,
                                                                                   @Optional
                                                                                   List<String> fields,
                                                                                   org.mule.api.MuleMessage muleMessage)
                               throws MarketoException

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

Parameters:: leadId - the id of the lead; fields - the fields parameter is not included, the following default fields will be returned: email, updatedAt, createdAt, lastName, firstName, and id
Returns:: a {java.util.List} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-lead-by-id/

getLeadPartitions
```
@Processor(friendlyName="Leads | Get Lead Partitions")
public List<Partition> getLeadPartitions(org.mule.api.MuleMessage muleMessage)
                                  throws MarketoException
```
Allows the caller to return a list of lead partitions in a Marketo instance

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

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

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/get-lead-partitions/

describeLead
```
@Processor(friendlyName="Leads | Describe")
public List<Lead> describeLead(org.mule.api.MuleMessage muleMessage)
                        throws MarketoException
```
Allows the caller to retrieve all fields and the data type of a lead object.

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
All the fields and their corresponding types.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/describe/

associateLead
```
@Processor(friendlyName="Leads | Associate Lead")
public void associateLead(int leadId,
                           @Default(value="#[payload]")
                           String cookie,
                           org.mule.api.MuleMessage muleMessage)
                   throws MarketoException
```
Allows the caller to associate a lead with a cookie value

Parameters:
leadId - the id of the lead
cookie - cookie value of lead
muleMessage - injected by Mule, used for adding Outbound Properties

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/associate-lead/

mergeLead
```
@Processor(friendlyName="Leads | Merge Lead")
public void mergeLead(int leadId,
                       @RefOnly@Default(value="#[payload]")
                       List<LeadId> losingLeadIds,
                       @FriendlyName(value="Merge in CRM")@Default(value="false")
                       boolean mergeInCRM,
                       org.mule.api.MuleMessage muleMessage)
               throws MarketoException
```
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.

Parameters:
leadId - the winner lead id
losingLeadIds - a list of losers leadId
mergeInCRM - set to true to merge in CRM. Default is false
muleMessage - injected by Mule, used for adding Outbound Properties

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/rest/merge-lead/

getMultipleLeadsByListId

@Paged
@MetaDataScope(value=CreateLeadFieldsMetaData.class)
@Processor(friendlyName="Leads | Get Multiple Leads By List Id")
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getMultipleLeadsByListId(int listId,
                                                                                                                                                                       @Optional
                                                                                                                                                                       List<String> fields,
                                                                                                                                                                       @RefOnly
                                                                                                                                                                       org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                             throws MarketoException

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

Parameters:: listId - the id of the list. To retrieve a list id, see getMultipleLists; fields - the list of fields to return; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-list-id

getMultipleLeadsByProgramId

@Paged
@MetaDataScope(value=CreateLeadFieldsMetaData.class)
@Processor(friendlyName="Leads | Get Multiple Leads By Program Id")
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getMultipleLeadsByProgramId(int programId,
                                                                                                                                                                          @Optional
                                                                                                                                                                          List<String> fields,
                                                                                                                                                                          @RefOnly
                                                                                                                                                                          org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                                throws MarketoException

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

Parameters:: programId - the id of the program.; fields - the list of fields to return; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-program-id/

getMultipleLeadsByFilterType

@Paged
@MetaDataScope(value=CreateLeadFieldsMetaData.class)
@Processor(friendlyName="Leads | Get Multiple Leads By Filter Type")
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getMultipleLeadsByFilterType(String filterType,
                                                                                                                                                                           List<String> filterValues,
                                                                                                                                                                           @Optional
                                                                                                                                                                           List<String> fields,
                                                                                                                                                                           @RefOnly
                                                                                                                                                                           org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                                 throws MarketoException

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

Parameters:: filterType - one of the Marketo supported filter types; filterValues - list of filter values; fields - the list of fields to return; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-filter-type

createLandingPageTemplate

@Processor(friendlyName="Assets | Landing Page Templates | Create Landing Page Template")
public LandingPageTemplate createLandingPageTemplate(@Default(value="#[payload]")
                                                      String templateName,
                                                      @RefOnly
                                                      FolderId folder,
                                                      String description,
                                                      TemplateType templateType,
                                                      org.mule.api.MuleMessage muleMessage)
                                              throws MarketoException

Allows the caller create Landing Page Template.

Parameters:: templateName - Name for the Landing Page Template shown in UI. It has to be unique. Maximum length 255 characters.; folder - Folder in which the template will be created. Must be Folder for Landing Page Templates.; description - Description for the template. Maximum length 2000 characters.; templateType - Type of the template. Expects "freeForm" or "guided" and defaults to freeForm.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The created LandingPageTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/create-landing-page-template/

getLandingPageTemplateById

@Processor(friendlyName="Assets | Landing Page Templates | Get Landing Page Template by ID")
public LandingPageTemplate getLandingPageTemplateById(int templateId,
                                                       @RefOnly
                                                       LandingPageTemplateStatus status,
                                                       org.mule.api.MuleMessage muleMessage)
                                               throws MarketoException

Allows the caller to retrieve Landing Page Template metadata.

Parameters:: templateId - ID of the Landing Page Template to retrieve.; status - Status of template to retrieve.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested LandingPageTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-landing-page-template-by-id/

getLandingPageTemplateByName

@Processor(friendlyName="Assets | Landing Page Templates | Get Landing Page Template by name")
public LandingPageTemplate getLandingPageTemplateByName(@Default(value="#[payload]")
                                                         String templateName,
                                                         @RefOnly
                                                         LandingPageTemplateStatus status,
                                                         org.mule.api.MuleMessage muleMessage)
                                                 throws MarketoException

Allows the caller to retrieve Landing Page Template metadata by Name.

Parameters:: templateName - The name of the Landing Page Template to retrieve.; status - Status of template to retrieve.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested LandingPageTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-landing-page-template-by-name/

getMultipleLandingPageTemplates

@Processor(friendlyName="Assets | Landing Page Templates | Get multiple Landing Page Templates")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<LandingPageTemplate,MarketoConnector> getMultipleLandingPageTemplates(@RefOnly
                                                                                                                                   LandingPageTemplateStatus status,
                                                                                                                                   @RefOnly@Default(value="#[payload]")
                                                                                                                                   FolderId folder,
                                                                                                                                   @RefOnly
                                                                                                                                   org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                                                   org.mule.api.MuleMessage muleMessage)
                                                                                                                     throws MarketoException

Allows the caller to retrieve metadata for multiple Landing Page Templates.

Parameters:: status - Status of template to retrieve.; folder - Parent folder to retrieve templates from. Must be a Folder for Landing Page Templates.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested List of LandingPageTemplates.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-multiple-landing-page-templates/

getLandingPageContent

@Processor(friendlyName="Assets | Landing Page Templates | Get Landing Page Template Content")
public LandingPageTemplateContent getLandingPageContent(int templateId,
                                                         @RefOnly
                                                         LandingPageTemplateStatus status,
                                                         org.mule.api.MuleMessage muleMessage)
                                                 throws MarketoException

Allows the caller to retrieve Landing Page Template content.

Parameters:: templateId - ID of the Landing Page Template to retrieve.; status - Status of template to retrieve.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The LandingPageTemplateContent.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-landing-page-template-content/

updateLandingPageTemplateContentById

@Processor(friendlyName="Assets | Landing Page Templates | Update Landing Page Template Content by Id")
public UpdatedLandingPageTemplate updateLandingPageTemplateContentById(@RefOnly@Default(value="#[payload]")
                                                                        LandingPageTemplateContent landingPageTemplateContent,
                                                                        org.mule.api.MuleMessage muleMessage)
                                                                throws MarketoException

Allows the caller to update the content of a landing page template.

Parameters:: landingPageTemplateContent - The ID and content of the Landing Page Template to update.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The UpdatedLandingPageTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-landing-page-template-content-by-id/

updateLandingPageTemplate

@Processor(friendlyName="Assets | Landing Page Templates | Update Landing Page Template")
public LandingPageTemplate updateLandingPageTemplate(int templateId,
                                                      String templateName,
                                                      String description,
                                                      org.mule.api.MuleMessage muleMessage)
                                              throws MarketoException

Allows the caller to update Landing Page Template metadata.

Parameters:: templateId - ID of the Landing Page Template to update.; templateName - Name of the landing page template.; description - Description of the template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The updated LandingPageTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-landing-page-template/

updateLeadsPartition

@Processor(friendlyName="Leads | Update Leads Partition")
public List<PartitionResponse> updateLeadsPartition(@RefOnly@Default(value="#[payload]")
                                                     List<UpdateLeadPartition> input,
                                                     org.mule.api.MuleMessage muleMessage)
                                             throws MarketoException

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

Parameters:: input - Array of input object (id and partitionName); muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a {org.mule.modules.marketo.model.lead.PartitionResponse} with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/rest/update-leads-partition/

createSnippet

@Processor(friendlyName="Assets | Snippets | Create")
public Snippet createSnippet(@Default(value="#[payload]")
                              String snippetName,
                              @RefOnly
                              FolderId folder,
                              String description,
                              org.mule.api.MuleMessage muleMessage)
                      throws MarketoException

Allows the caller to create a snippet.

Parameters:: snippetName - The name of the snippet. Maximum length 100 characters.; folder - The folder associated with the snippet.; description - The description of the snippet. Maximum length 2000 characters.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a Snippet with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/create-snippet/

getSnippetById
```
@Processor(friendlyName="Assets | Snippets | Get by ID")
public Snippet getSnippetById(int snippetId,
                               @RefOnly
                               SnippetStatus status,
                               org.mule.api.MuleMessage muleMessage)
                       throws MarketoException
```
Allows the caller to get a snippet based on its id.

Parameters:
snippetId - The ID of the required snippet.
status - The status of the snippet.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a Snippet with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/get-snippet-by-id/

deleteSnippet
```
@Processor(friendlyName="Assets | Snippets | Delete by ID")
public SnippetId deleteSnippet(int snippetId,
                                org.mule.api.MuleMessage muleMessage)
                        throws MarketoException
```
Allows the caller to delete a snippet by id.

Parameters:
snippetId - The ID of the snippet to be deleted.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a SnippetId with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/delete-snippet-by-id/

updateSnippetById
```
@Processor(friendlyName="Assets | Snippets | Update")
public Snippet updateSnippetById(int snippetId,
                                  @Optional
                                  String description,
                                  @Optional
                                  String snippetName,
                                  org.mule.api.MuleMessage muleMessage)
                          throws MarketoException
```
Allows the caller to update a snippet using its id.

Parameters:
snippetId - The ID of the snippet to be updated.
description - The updated description of the snippet. Maximum length 2000 characters.
snippetName - The updated name for the snippet. Maximum length 100 characters.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a Snippet with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/update-snippet/

getSnippets

@Processor(friendlyName="Assets | Snippets | Get list")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Snippet,MarketoConnector> getSnippets(@Optional
                                                                                                   SnippetStatus status,
                                                                                                   @RefOnly
                                                                                                   org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                   org.mule.api.MuleMessage muleMessage)
                                                                                     throws MarketoException

Allows the caller to get a list of snippets.

Parameters:: status - Snippet status.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of Snippets.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-snippets/

getSnippetContentById
```
@Processor(friendlyName="Assets | Snippets | Get content by ID")
public List<AssetContent<SnippetDynamicContentType>> getSnippetContentById(int snippetId,
                                                                            org.mule.api.MuleMessage muleMessage)
                                                                    throws MarketoException
```
Allows the caller to get the content of a snippet by its ID.

Parameters:
snippetId - The ID of the required snippet content.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
the List of Snippets.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/get-snippet-content-by-id/

updateSnippetContentById

@Processor(friendlyName="Assets | Snippets | Update content by ID")
public SnippetId updateSnippetContentById(int snippetId,
                                           @RefOnly
                                           SnippetDynamicContentType type,
                                           String content,
                                           org.mule.api.MuleMessage muleMessage)
                                   throws MarketoException

Allows the caller to update the content of a snippet by its ID.

Parameters:: snippetId - The ID of the snippet which content is to be updated.; type - The content type of the snippet.; content - The content of the snippet.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a SnippetId with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-snippet-content-by-id/

approveSnippetById
```
@Processor(friendlyName="Assets | Snippets | Approve by ID")
public Snippet approveSnippetById(int snippetId,
                                   org.mule.api.MuleMessage muleMessage)
                           throws MarketoException
```
Allows the caller to approve the draft version of a snippet by ID.

Parameters:
snippetId - The ID of the snippet to be approved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a Snippet with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/approve-snippet-by-id/

unapproveSnippetById
```
@Processor(friendlyName="Assets | Snippets | Unapprove by ID")
public Snippet unapproveSnippetById(int snippetId,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException
```
Allows the caller to unapprove a snippet by ID. Note: Disapprove operation can be only on approved snippets.

Parameters:
snippetId - The ID of the snippet to be unapproved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a Snippet with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/unapprove-snippet-by-id/

discardSnippetDraftById
```
@Processor(friendlyName="Assets | Snippets | Disapprove by ID")
public SnippetId discardSnippetDraftById(int snippetId,
                                          org.mule.api.MuleMessage muleMessage)
                                  throws MarketoException
```
Allows the caller to delete a draft snippet by ID. Note: Snippet must be in draft status to be discarded. An approved snippet cannot be discarded.

Parameters:
snippetId - The ID of the snippet which draft is to be discarded.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a SnippetId with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/discard-snippet-draft-by-id/

cloneSnippetById
```
@Processor(friendlyName="Assets | Snippets | Clone snippet by ID")
public Snippet cloneSnippetById(int snippetId,
                                 String snippetName,
                                 @RefOnly
                                 FolderId folder,
                                 @Optional
                                 String description,
                                 org.mule.api.MuleMessage muleMessage)
                         throws MarketoException
```
Allows the caller to clone a snippet by its ID. Note: Creates a clone of approved snippet. If no approved version exists, then the draft version will be cloned.

Parameters:
snippetId - The ID of the snippet to be cloned.
snippetName - The name of the cloned snippet.
folder - The folder in which the cloned snippet will be created.
description - The description of the snippet.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a Snippet with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/clone-snippet/

updateSnippetDynamicContentById

@Processor(friendlyName="Assets | Snippets | Update snippet dynamic content by ID")
public SnippetId updateSnippetDynamicContentById(int snippetId,
                                                  int segmentId,
                                                  @RefOnly@Optional
                                                  SnippetDynamicContentType type,
                                                  @Optional
                                                  String value,
                                                  org.mule.api.MuleMessage muleMessage)
                                          throws MarketoException

Allows the caller to update the content of a segment that is associated with a snippet.

Parameters:: snippetId - The ID of the snippet to be updated.; segmentId - The segment ID associated with the snippet.; type - The type of the new content.; value - The content for the segment.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a SnippetId with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-snippet-dynamic-content-by-id/

getSnippetDynamicContentById
```
@Processor(friendlyName="Assets | Snippets | Get snippet dynamic content by ID")
public SnippetDynamicContentResponse getSnippetDynamicContentById(int snippetId,
                                                                   org.mule.api.MuleMessage muleMessage)
                                                           throws MarketoException
```
Allows the caller to get the content of a segment that is associated with a snippet.

Parameters:
snippetId - The ID of the snippet which dynamic content will be retrieved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a SnippetId with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/get-snippet-dynamic-content-by-id/

createEmailTemplate

@Processor(friendlyName="Assets | Email templates | Create email template")
public EmailTemplate createEmailTemplate(String emailTemplateName,
                                          @RefOnly
                                          FolderId folder,
                                          @RefOnly@Default(value="#[payload]")
                                          Object content,
                                          @Optional
                                          String description,
                                          org.mule.api.MuleMessage muleMessage)
                                  throws MarketoException

Allows the caller to create an email template.

Parameters:: emailTemplateName - Name of the email template. Must be unique under parent folder. Maximum of 100 characters.; folder - The ID and Type of the parent folder under which the template will be created.; content - File containing HTML content for the email.; description - Description of the template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The created EmailTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/create-email-template

getEmailTemplateById

@Processor(friendlyName="Assets | Email templates | Get email template by ID")
public EmailTemplate getEmailTemplateById(int templateId,
                                           @Optional
                                           EmailTemplateStatus status,
                                           org.mule.api.MuleMessage muleMessage)
                                   throws MarketoException

Allows the caller to get an email template by its ID.

Parameters:: templateId - ID of the email template.; status - The status of the template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested EmailTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-template-by-id

getEmailTemplateByName

@Processor(friendlyName="Assets | Email templates | Get email template by name")
public EmailTemplate getEmailTemplateByName(String emailTemplateName,
                                             @Optional
                                             EmailTemplateStatus status,
                                             org.mule.api.MuleMessage muleMessage)
                                     throws MarketoException

Allows the caller to get an email template by its ID.

Parameters:: emailTemplateName - Name of the email template.; status - The status of the template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested EmailTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-template-by-name

updateEmailTemplate

@Processor(friendlyName="Assets | Email templates | Get email template by name")
public EmailTemplate updateEmailTemplate(int templateId,
                                          @Optional
                                          String description,
                                          @Optional
                                          String emailTemplateName,
                                          org.mule.api.MuleMessage muleMessage)
                                  throws MarketoException

Allows the caller to update an email template.

Parameters:: templateId - ID of the email template to update.; description - Updated description for the email template.; emailTemplateName - Updated name for the email template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested EmailTemplate.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-email-template

deleteEmailTemplateById
```
@Processor(friendlyName="Assets | Email templates | Delete email template by ID")
public EmailTemplateId deleteEmailTemplateById(int templateId,
                                                org.mule.api.MuleMessage muleMessage)
                                        throws MarketoException
```
Allows the caller to delete an email template by its ID.

Parameters:
templateId - ID of the email template to be deleted.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
An EmailTemplateId with the deleted email template ID.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/delete-email-template-by-id

getEmailTemplates

@Processor(friendlyName="Assets | Email templates | Get email templates")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<EmailTemplate,MarketoConnector> getEmailTemplates(@RefOnly@Optional
                                                                                                               EmailTemplateStatus status,
                                                                                                               @RefOnly
                                                                                                               org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                               org.mule.api.MuleMessage muleMessage)
                                                                                                 throws MarketoException

Allows the caller to get a list of email templates.

Parameters:: status - Status of the template to retrieve.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested List of EmailTemplates.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-templates

getEmailTemplateContentById

@Processor(friendlyName="Assets | Email templates | Get email template content by ID")
public EmailTemplateContent getEmailTemplateContentById(int templateId,
                                                         @Optional
                                                         EmailTemplateStatus status,
                                                         org.mule.api.MuleMessage muleMessage)
                                                 throws MarketoException

Allows the caller to get the content associated with an email template by the template ID.

Parameters:: templateId - ID of the email template.; status - The status of the template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested EmailTemplateContent.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-template-content-by-id

updateEmailTemplateContentById

@Processor(friendlyName="Assets | Email templates | Update email template content by ID")
public EmailTemplateId updateEmailTemplateContentById(int templateId,
                                                       @RefOnly@Default(value="#[payload]")
                                                       Object content,
                                                       org.mule.api.MuleMessage muleMessage)
                                               throws MarketoException

Allows the caller to update the content of an email template by the template ID.

Parameters:: templateId - ID of the email template.; content - The ID and content of the Landing Page Template to update.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The updated EmailTemplateContent.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-email-template-content-by-id

approveEmailTemplateById
```
@Processor(friendlyName="Assets | Email templates | Approve email template by ID")
public EmailTemplate approveEmailTemplateById(int templateId,
                                               org.mule.api.MuleMessage muleMessage)
                                       throws MarketoException
```
Allows the caller to approve an email template by its ID.

Parameters:
templateId - ID of the email template.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The updated EmailTemplate.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/approve-email-template-by-id

unapproveEmailTemplateById
```
@Processor(friendlyName="Assets | Email templates | Unapprove email template by ID")
public EmailTemplate unapproveEmailTemplateById(int templateId,
                                                 org.mule.api.MuleMessage muleMessage)
                                         throws MarketoException
```
Allows the caller to unapprove an email template by its ID.

Parameters:
templateId - ID of the email template.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The updated EmailTemplate.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/unapprove-email-template-by-id

discardEmailTemplateDraftById
```
@Processor(friendlyName="Assets | Email templates | Discard email template by ID")
public EmailTemplateId discardEmailTemplateDraftById(int templateId,
                                                      org.mule.api.MuleMessage muleMessage)
                                              throws MarketoException
```
Allows the caller to discard a draft of an email template. Note: The draft version of the template is created after an approved email is updated.

Parameters:
templateId - ID of the email template to discard.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The updated EmailTemplate.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/discard-email-template-draft-by-id

cloneEmailTemplate
```
@Processor(friendlyName="Assets | Email templates | Clone email template")
public EmailTemplate cloneEmailTemplate(int templateId,
                                         String emailTemplateName,
                                         @RefOnly
                                         FolderId folder,
                                         org.mule.api.MuleMessage muleMessage)
                                 throws MarketoException
```
Allows the caller to clone an email template.

Parameters:
templateId - ID of the email template to clone.
emailTemplateName - Name of the clone email template. Must be unique under parent folder. Maximum of 100 characters.
folder - The ID and Type of the parent folder under which the template will be created.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The cloned EmailTemplate.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/clone-email-template

describeCompany
```
@Processor(friendlyName="Company | Describe Company")
public EntityDescription describeCompany(org.mule.api.MuleMessage muleMessage)
                                  throws MarketoException
```
Allows the caller to retrieve company object metadata.

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The EntityDescription.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/company-api/describe-company/

getCompanies

@Paged
@MetaDataScope(value=GetCompaniesMetaData.class)
@Processor(friendlyName="Company | Get Companies")
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getCompanies(@MetaDataKeyParam(affects=BOTH)
                                                                                                                                                       String filterType,
                                                                                                                                                       @RefOnly@Default(value="#[payload]")
                                                                                                                                                       List<Map<String,Object>> filterValues,
                                                                                                                                                       @Optional
                                                                                                                                                       List<String> fields,
                                                                                                                                                       @RefOnly
                                                                                                                                                       org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                 throws MarketoException

Allows the caller to retrieve companies using specified input parameters.

Parameters:: filterType - Can be any one of the searchable fields as indicated by the The describeOpportunity(org.mule.api.MuleMessage) company call.; filterValues - List of values corresponding to the field in 'filterType', to use to perform de query.; fields - List of company fields required. If not specified, the response will contain the following fields: id, dedupeFields, updatedAt, createdAt.; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/company-api/get-companies/

createUpdateUpsertCompanies

@MetaDataScope(value=CreateUpdateUpsertCompaniesMetaData.class)
@Processor(friendlyName="Company | Create/Update/Upsert Companies")
public List<CreateOrUpdateEntity> createUpdateUpsertCompanies(@MetaDataKeyParam(labels={"Action","Dedupe By"})
                                                                                                                      String key,
                                                                                                                      @RefOnly@Default(value="#[payload]")
                                                                                                                      List<Map<String,Object>> inputCompanies,
                                                                                                                      org.mule.api.MuleMessage muleMessage)
                                                       throws MarketoException

Allows the caller to create/update or upsert company object metadata. A maximum of 300 records may be included in an individual call.

Parameters:: key - The MetaDataKey. Must have the following format: (action)||(dedupeBy). Action can be createOnly, updateOnly, or createOrUpdate. DedupeBy can be dedupeFields or idField.; inputCompanies - The Company Object definitions.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of created/updated/upserted companies.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/company-api/createupdateupsert-companies/

deleteCompanies

@MetaDataScope(value=DeleteCompaniesMetaData.class)
@Processor(friendlyName="Company | Delete Companies")
public List<DeletedEntity> deleteCompanies(@MetaDataKeyParam(affects=INPUT)
                                                                                       String deleteBy,
                                                                                       @RefOnly@Default(value="#[payload]")
                                                                                       List<Map<String,Object>> criteria,
                                                                                       org.mule.api.MuleMessage muleMessage)
                                    throws MarketoException

Allows the caller to delete companies by dedupe fields or ID field.

Parameters:: deleteBy - The deletion method. Can be "dedupeFields" or "idField".; criteria - Deletion criteria.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of deleted companies.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/company-api/delete-companies/

createProgram

@Processor(friendlyName="Program | Create Program")
public ProgramResponse createProgram(@RefOnly
                                      FolderId folder,
                                      @Default(value="#[payload]")
                                      String programName,
                                      @Default(value="DEFAULT")
                                      ProgramType type,
                                      @Optional
                                      String description,
                                      String channel,
                                      @RefOnly@Optional
                                      List<Tag> tags,
                                      @RefOnly@Optional
                                      List<Cost> costs,
                                      org.mule.api.MuleMessage muleMessage)
                              throws MarketoException

Alows for the creation of a new program.

Parameters:: folder - ID and Type of folder where the program is to be created.; programName - Name of the new program. This name must be globally unique to the target instance.; type - Type of program.; description - Description of the new program.; channel - The channel of the program. Must be one of the available channels in the target instance. Obtain list of valid channels by calling getChannels(org.mule.streaming.PagingConfiguration, org.mule.api.MuleMessage).; tags - List of tag keys and values for the program. Obtain list of valid tag types by calling getTags(org.mule.streaming.PagingConfiguration, org.mule.api.MuleMessage). Obtain list of valid tag values by calling getTagByName(java.lang.String, org.mule.api.MuleMessage).; costs - List of period costs for the program.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The created program.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/create-a-program/

deleteProgramById
```
@Processor(friendlyName="Program | Delete Program by ID")
public IdOnlyProgram deleteProgramById(int programId,
                                        org.mule.api.MuleMessage muleMessage)
                                throws MarketoException
```
Allows deletion of program by Id. Programs can not be deleted if they are referenced by assets outside of the program itself.

Parameters:
programId - ID of the program to delete.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The ID of the deleted program.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/delete-program-by-id/

getProgramById
```
@Processor(friendlyName="Program | Get Program by ID")
public ProgramResponse getProgramById(int programId,
                                       org.mule.api.MuleMessage muleMessage)
                               throws MarketoException
```
Allows the user to retrieve a program based on its ID.

Parameters:
programId - ID of the program.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The requested program.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/get-program-by-id/

getProgramByName

@Processor(friendlyName="Program | Get Program by Name")
public ProgramResponse getProgramByName(@Default(value="#[payload]")
                                         String programName,
                                         org.mule.api.MuleMessage muleMessage)
                                 throws MarketoException

Allows a user to specify a name parameter to use to retrieve program data.

Parameters:: programName - Name of program to retrieve.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested program.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/get-program-by-name/

getProgramByTag

@Processor(friendlyName="Program | Get Program by Tag")
public List<ProgramResponse> getProgramByTag(@RefOnly@Default(value="#[payload]")
                                              Tag tag,
                                              org.mule.api.MuleMessage muleMessage)
                                      throws MarketoException

Allows a user to specify a Tag (type and value) parameter to use to retrieve program data.

Parameters:: tag - Tag type and value to filter on.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested List of programs.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/get-programs-by-tag-type/

browsePrograms

@Processor(friendlyName="Program | Browse Programs")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<ProgramResponse,MarketoConnector> browsePrograms(@Optional
                                                                                                              ProgramStatus status,
                                                                                                              @RefOnly
                                                                                                              org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                              org.mule.api.MuleMessage muleMessage)
                                                                                                throws MarketoException

Retrieves a list of programs.

Parameters:: status - A status filter for Engagement and Email type programs. Can be used to filter on "on," "off," and "unlocked"; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of programs.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/browse-programs/

approveProgram
```
@Processor(friendlyName="Program | Approve Program")
public IdOnlyProgram approveProgram(int programId,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException
```
Allows the caller to approve a program by ID. This operation is only valid for Email Programs.

Parameters:
programId - ID of the program to be approved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The ID of the approved program.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/approve-program/

unapproveProgram
```
@Processor(friendlyName="Program | Unapprove Program")
public IdOnlyProgram unapproveProgram(int programId,
                                       org.mule.api.MuleMessage muleMessage)
                               throws MarketoException
```
Allows the caller to unapprove a program. This operation is only valid for Email Programs.

Parameters:
programId - ID of the program to be unapproved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The ID of the unapproved program.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/unapprove-program/

cloneProgram
```
@Processor(friendlyName="Program | Clone Program")
public ProgramResponse cloneProgram(int programId,
                                     String programName,
                                     @RefOnly
                                     FolderId folder,
                                     @Optional
                                     String description,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException
```
Allows to user to clone a program and its underlying assets to a target folder with the designated name and description.

Parameters:
programId - ID of the program to clone.
programName - Name of the resulting program. Must be globally unique to the target instance.
folder - Parent folder. May not be in a different workspace from the program being cloned.
description - Description of the resulting program.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The cloned program.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/clone-program/

updateProgram

@Processor(friendlyName="Program | Update Program")
public ProgramResponse updateProgram(int programId,
                                      @Optional
                                      String description,
                                      @Optional
                                      String programName,
                                      @RefOnly@Optional
                                      List<Tag> tags,
                                      @RefOnly@Optional
                                      List<Cost> costs,
                                      @Default(value="false")
                                      boolean costsDestructiveUpdate,
                                      org.mule.api.MuleMessage muleMessage)
                              throws MarketoException

Allows the user to update fields on the target program.

Parameters:: programId - ID of the program to update.; description - New description for the target program.; programName - New name for the target program.; tags - New set of tags for the target program.; costs - List of period costs for the program.; costsDestructiveUpdate - Boolean flag to destroy existing costs and replace them with the included costs. Defaults to false.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The updated program.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/update-program/

describeOpportunity
```
@Processor(friendlyName="Opportunity | Describe Opportunity")
public Opportunity describeOpportunity(org.mule.api.MuleMessage muleMessage)
                                throws MarketoException
```
Allows the caller to retrieve opportunity object metadata.

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The requested List of Opportunity.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/opportunity-api/describe-opportunity/

describeOpportunityRole
```
@Processor(friendlyName="Opportunity | Describe Opportunity Role")
public Opportunity describeOpportunityRole(org.mule.api.MuleMessage muleMessage)
                                    throws MarketoException
```
Allows the caller to retrieve opportunity role object metadata

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The requested List of Opportunity.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/opportunity-api/describe-opportunity-role/

getTags

@Processor(friendlyName="Program | Get Tags")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<TagType,MarketoConnector> getTags(@RefOnly
                                                                                               org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                               org.mule.api.MuleMessage muleMessage)
                                                                                 throws MarketoException

Returns a list of all available tags in the target instance.

Parameters:: pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of tags.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/programs/get-tags/

getTagByName
```
@Processor(friendlyName="Program | Get Tag by Name")
public TagType getTagByName(@Default(value="#[payload]")
                             String tagName,
                             org.mule.api.MuleMessage muleMessage)
                     throws MarketoException
```
Returns a tag by its name.

Parameters:
tagName - The name of the tag to retrieve.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The requested tag.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/programs/get-tag-by-name/

createOrUpdateOpportunity

@Processor(friendlyName="Opportunity | Create Or Update Opportunity")
@MetaDataScope(value=CreateOpportunityFieldsMetaData.class)
public List<OpportunityResponse> createOrUpdateOpportunity(@RefOnly@Default(value="#[payload]")
                                                                                                               List<Map<String,Object>> objectDefinitions,
                                                                                                               @Default(value="CREATE_OR_UPDATE")
                                                                                                               EntityActions action,
                                                                                                               @Default(value="DEDUPE_FIELDS")
                                                                                                               DedupeBy dedupeBy,
                                                                                                               org.mule.api.MuleMessage muleMessage)
                                                    throws MarketoException

Allows the caller to create/update or upsert opportunity object metadata.

Parameters:: objectDefinitions - the Opportunity Object definitions.; action - the storage operation; dedupeBy - the deduplication method; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested OpportunityResponse.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/opportunity-api/createupdateupsert-opportunities/

deleteOpportunities

@Processor(friendlyName="Opportunity | Delete Opportunities")
@MetaDataScope(value=DeleteOpportunityMetaData.class)
public List<OpportunityResponse> deleteOpportunities(@RefOnly@Default(value="#[payload]")
                                                                                                   List<Map<String,Object>> searchValues,
                                                                                                   @MetaDataKeyParam(affects=INPUT)
                                                                                                   String deleteBy,
                                                                                                   org.mule.api.MuleMessage muleMessage)
                                              throws MarketoException

Allows the caller to delete opportunities by dedupe fields or id field

Parameters:: searchValues - the Opportunity Objects search values; deleteBy - the deletion method; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested OpportunityResponse.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/opportunity-api/delete-opportunities/

getOpportunities

@Processor(friendlyName="Opportunity | Get Opportunities")
@MetaDataScope(value=CreateOpportunityFieldsMetaData.class)
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getOpportunities(String filterType,
                                                                                                                                                                      @Default(value="#[payload]")
                                                                                                                                                                      List<String> filterValues,
                                                                                                                                                                      @Optional
                                                                                                                                                                      List<String> fields,
                                                                                                                                                                      @RefOnly
                                                                                                                                                                      org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                     throws MarketoException

Allows the caller to retrieve opportunities using specified input parameters

Parameters:: filterType - can be any field from searchableFields set; filterValues - a list of search values; fields - a list of fields. If not specified, the response will retrieve "marketoGuid", "dedupeFields", "udpatedAt", "createdAt"; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/opportunity-api/get-opportunities/

createOrUpdateOpportunityRoles

@Processor(friendlyName="Opportunity | Create Or Update Opportunity Roles")
@MetaDataScope(value=CreateOpportunityFieldsMetaData.class)
public List<OpportunityResponse> createOrUpdateOpportunityRoles(@RefOnly@Default(value="#[payload]")
                                                                                                                    List<Map<String,Object>> objectDefinitions,
                                                                                                                    @Default(value="CREATE_OR_UPDATE")
                                                                                                                    EntityActions action,
                                                                                                                    @Default(value="DEDUPE_FIELDS")
                                                                                                                    DedupeBy dedupeBy,
                                                                                                                    org.mule.api.MuleMessage muleMessage)
                                                         throws MarketoException

Allows the caller to create/update or upsert opportunity role object

Parameters:: objectDefinitions - the Opportunity Role Object definitions; action - the storage operation; dedupeBy - the deduplication method; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested OpportunityResponse.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/opportunity-api/createupdateupsert-opportunities-roles/

describeSalesPerson
```
@Processor(friendlyName="Sales Person | Describe Sales Person")
public EntityDescription describeSalesPerson(org.mule.api.MuleMessage muleMessage)
                                      throws MarketoException
```
Allows the caller to retrieve all fields and the data type of a sales person object.

Parameters:
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
The EntityDescription.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/sales-persons/describe-sales-person/

createUpdateUpsertSalesPersons

@MetaDataScope(value=CreateUpdateUpsertSalesPersonsMetaData.class)
@Processor(friendlyName="Sales Person | Create/Update/Upsert Sales Persons")
public List<CreateOrUpdateEntity> createUpdateUpsertSalesPersons(@MetaDataKeyParam(labels={"Action","Dedupe By"})
                                                                                                                            String key,
                                                                                                                            @RefOnly@Default(value="#[payload]")
                                                                                                                            List<Map<String,Object>> inputSalesPersons,
                                                                                                                            org.mule.api.MuleMessage muleMessage)
                                                          throws MarketoException

Allows the caller to create/update or upsert sales person objects records. A maximum of 300 records may be included in an individual call.

Parameters:: key - The MetaDataKey. Must have the following format: (action)||(dedupeBy). Action can be createOnly, updateOnly, or createOrUpdate. DedupeBy can be dedupeFields or idField.; inputSalesPersons - The Sales Person Object definitions.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of created/updated/upserted companies.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/sales-persons/createupdateupsert-sales-persons/

deleteOpportunityRoles

@Processor(friendlyName="Opportunity | Delete Opportunity Roles")
@MetaDataScope(value=DeleteOpportunityRolesMetaData.class)
public List<OpportunityResponse> deleteOpportunityRoles(@RefOnly@Default(value="#[payload]")
                                                                                                           List<Map<String,Object>> searchValues,
                                                                                                           @MetaDataKeyParam(affects=INPUT)
                                                                                                           String deleteBy,
                                                                                                           org.mule.api.MuleMessage muleMessage)
                                                 throws MarketoException

Allows the caller to delete opportunity by dedupe fields or id field.

Parameters:: searchValues - the Opportunity Roles Objects search values; deleteBy - the deletion method; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested OpportunityResponse.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/opportunity-api/delete-opportunity-roles/

deleteSalesPersons

@MetaDataScope(value=DeleteSalesPersonsMetaData.class)
@Processor(friendlyName="Sales Person | Delete Sales Persons")
public List<DeletedEntity> deleteSalesPersons(@MetaDataKeyParam(affects=INPUT)
                                                                                             String deleteBy,
                                                                                             @RefOnly@Default(value="#[payload]")
                                                                                             List<Map<String,Object>> criteria,
                                                                                             org.mule.api.MuleMessage muleMessage)
                                       throws MarketoException

Allows the caller to delete sales persons by dedupe fields or ID field.

Parameters:: deleteBy - The deletion method. Can be "dedupeFields" or "idField".; criteria - Deletion criteria.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of deleted companies.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/sales-persons/delete-sales-persons/

getOpportunityRoles

@Paged
@Processor(friendlyName="Opportunity | Get Opportunity Roles")
@MetaDataScope(value=CreateOpportunityFieldsMetaData.class)
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getOpportunityRoles(String filterType,
                                                                                                                                                                         @Default(value="#[payload]")
                                                                                                                                                                         List<String> filterValues,
                                                                                                                                                                         @Optional
                                                                                                                                                                         List<String> fields,
                                                                                                                                                                         @RefOnly
                                                                                                                                                                         org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                        throws MarketoException

Allows the caller to retrieve opportunity roles using specified input parameters

Parameters:: filterType - can be any searchableFields set that has a single field in it; filterValues - a list of search values; fields - a list of fields. If not specified, the response will retrieve "marketoGuid", "dedupeFields", "udpatedAt", "createdAt"; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/opportunity-api/get-opportunity-roles/

getSalesPersons

@Paged
@MetaDataScope(value=GetSalesPersonsMetaData.class)
@Processor(friendlyName="Sales Person | Get Sales Persons")
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> getSalesPersons(@MetaDataKeyParam(affects=BOTH)
                                                                                                                                                             String filterType,
                                                                                                                                                             @RefOnly@Default(value="#[payload]")
                                                                                                                                                             List<Map<String,Object>> filterValues,
                                                                                                                                                             @Optional
                                                                                                                                                             List<String> fields,
                                                                                                                                                             @RefOnly
                                                                                                                                                             org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                    throws MarketoException

Allows the caller to retrieve sales persons using specified input parameters.

Parameters:: filterType - Can be any one of the searchable fields as indicated by the describeSalesPerson(org.mule.api.MuleMessage) call.; filterValues - List of values corresponding to the field in 'filterType', to use to perform de query.; fields - List of sales person fields required. If not specified, the response will contain the following fields: id, dedupeFields, updatedAt, createdAt.; pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.
Returns:: a List of Map with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/sales-persons/get-sales-persons/

createEmail
```
@Processor(friendlyName="Assets | Email | Create email")
public EmailResponse createEmail(@RefOnly@Default(value="#[payload]")
                                  Email email,
                                  org.mule.api.MuleMessage muleMessage)
                          throws MarketoException
```
Allows the caller to create an email.

Parameters:
email - A POJO with the data of the Email to be created.
muleMessage - Injected by Mule, used for adding Outbound Properties

Returns:
The created EmailResponse.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/create-email

getEmailById

@Processor(friendlyName="Assets | Email | Get email by ID")
public EmailResponse getEmailById(int emailId,
                                   @Optional
                                   EmailStatus status,
                                   org.mule.api.MuleMessage muleMessage)
                           throws MarketoException

Allows the caller to get an email based on its ID.

Parameters:: emailId - The email ID.; status - The email status.; muleMessage - Injected by Mule, used for adding Outbound Properties
Returns:: The requested EmailResponse.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-by-id

deleteEmailById
```
@Processor(friendlyName="Assets | Email | Delete email by ID")
public EmailId deleteEmailById(int emailId,
                                org.mule.api.MuleMessage muleMessage)
                        throws MarketoException
```
Allows the caller to delete an email by its ID.

Parameters:
emailId - ID of the email to be deleted.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
An EmailId with the deleted email ID.

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/delete-email-by-id

updateEmail

@Processor(friendlyName="Assets | Email | Update email")
public EmailResponse updateEmail(int emailId,
                                  @Optional
                                  String description,
                                  @Optional
                                  String emailName,
                                  org.mule.api.MuleMessage muleMessage)
                          throws MarketoException

Allows the caller to update an email using its ID.

Parameters:: emailId - ID of the email template to update.; description - Updated description for the email template.; emailName - Updated name for the email template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: An EmailId with the updated email ID.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-email

getEmails

@Processor(friendlyName="Assets | Email | Get emails")
@Paged
public org.mule.streaming.ProviderAwarePagingDelegate<EmailResponse,MarketoConnector> getEmails(@Optional
                                                                                                       EmailStatus status,
                                                                                                       @RefOnly@Default(value="#[payload]")
                                                                                                       FolderId folder,
                                                                                                       @RefOnly
                                                                                                       org.mule.streaming.PagingConfiguration pagingConfiguration,
                                                                                                       org.mule.api.MuleMessage muleMessage)
                                                                                         throws MarketoException

Allows the caller to get a list of emails.

Parameters:: status - Email status.; folder - The folder under which the search is performed.; pagingConfiguration - the PagingConfiguration object with the needed parameters for paged queries.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The List of EmailResponses.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-emails

getEmailContentById

@Processor(friendlyName="Assets | Email | Get email content by ID")
public EmailContent getEmailContentById(int emailId,
                                         @Optional
                                         EmailStatus status,
                                         org.mule.api.MuleMessage muleMessage)
                                 throws MarketoException

Allows the caller to get the content associated with an email by its ID.

Parameters:: emailId - ID of the email.; status - The status of the template.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The requested EmailContent.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-content-by-id

updateEmailContentById

@Processor(friendlyName="Assets | Email | Update email content by ID")
public EmailId updateEmailContentById(int emailId,
                                       @RefOnly@Optional
                                       EmailField subject,
                                       @RefOnly@Optional
                                       EmailField fromEmail,
                                       @RefOnly@Optional
                                       EmailField fromName,
                                       @RefOnly@Optional
                                       EmailField replyTo,
                                       org.mule.api.MuleMessage muleMessage)
                               throws MarketoException

Allows the caller to update an email's content by id.

Parameters:: emailId - ID of the email.; subject - The subject for the email.; fromEmail - The from address for the email.; fromName - The from name for the email.; replyTo - The reply email address for the email.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: An EmailId with the updated email ID.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-email-content-by-id

updateEmailContentInEditableSection

@Processor(friendlyName="Assets | Email | Update email content in editable section")
public EmailId updateEmailContentInEditableSection(int emailId,
                                                    String htmlId,
                                                    @Optional
                                                    EmailContentType type,
                                                    @RefOnly@Optional
                                                    Object value,
                                                    @Optional
                                                    String textValue,
                                                    org.mule.api.MuleMessage muleMessage)
                                            throws MarketoException

Allows the caller to associate static or dynamic content to a given editable section of an email.

Parameters:: emailId - ID of the email.; htmlId - The HTML ID of the editable section.; type - The type of the editable section.; value - Depends of the type of the specified editable section: - Text: A String containing the HTML content. - DynamicContent: An Integer with the ID of the segmentation. - Snippet: An Integer with the ID of the snippet.; textValue - The text content if the type is text.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: An EmailId with the updated email ID.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-email-content-in-editable-section/

getEmailDynamicContentById

@Processor(friendlyName="Assets | Email | Get email dynamic content by ID")
public EmailDynamicContentResponse getEmailDynamicContentById(int emailId,
                                                               @Default(value="#[payload]")
                                                               String dynamicContentId,
                                                               org.mule.api.MuleMessage muleMessage)
                                                       throws MarketoException

Allows the caller to associate static or dynamic content to a given editable section of an email.

Parameters:: emailId - ID of the email.; dynamicContentId - ID of the dynamic content.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: An EmailId with the updated email ID.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-dynamic-content-by-id/

updateEmailDynamicContentById

@Processor(friendlyName="Assets | Email | Update email dynamic content by ID")
public EmailId updateEmailDynamicContentById(int emailId,
                                              @Default(value="#[payload]")
                                              String dynamicContentId,
                                              @Optional
                                              String segment,
                                              @Optional
                                              String value,
                                              EmailDynamicContentType type,
                                              org.mule.api.MuleMessage muleMessage)
                                      throws MarketoException

Allows the caller to create or update a section of the dynamic content of an email by segment ID.

Parameters:: emailId - The ID of the email to be updated.; dynamicContentId - The segment ID associated with the email.; segment - The segment name.; value - The content for the segment.; type - The type of the new content.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a EmailId with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/update-email-dynamic-content-by-id/

approveEmailById
```
@Processor(friendlyName="Assets | Email | Approve by ID")
public EmailId approveEmailById(int emailId,
                                 org.mule.api.MuleMessage muleMessage)
                         throws MarketoException
```
Allows the caller to approve the draft version of an email by ID.

Parameters:
emailId - The ID of the email to be approved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
an EmailId with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/approve-email-by-id

unapproveEmailById
```
@Processor(friendlyName="Assets | Email | Unapprove by ID")
public EmailId unapproveEmailById(int emailId,
                                   org.mule.api.MuleMessage muleMessage)
                           throws MarketoException
```
Allows the caller to unapprove an email by ID. Note: Disapprove operation can only be used on approved emails.

Parameters:
emailId - The ID of the email to be unapproved.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a EmailResponse with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/unapprove-email-by-id

discardEmailDraftById
```
@Processor(friendlyName="Assets | Email | Discard draft by ID")
public EmailId discardEmailDraftById(int emailId,
                                      org.mule.api.MuleMessage muleMessage)
                              throws MarketoException
```
Allows the caller to delete a draft email by ID. Note: Email must be in draft status to be discarded. An approved email cannot be discarded but, you can discard an approved email that was modified after approval and hence you will have an email approved with draft state.

Parameters:
emailId - The ID of the email which draft is to be discarded.
muleMessage - injected by Mule, used for adding Outbound Properties

Returns:
a EmailId with the call response

Throws:

MarketoException - on valid error from the endpoint
Api.doc:

http://developers.marketo.com/documentation/asset-api/discard-email-draft-by-id/

cloneEmailById

@Processor(friendlyName="Assets | Email | Clone email by ID")
public EmailResponse cloneEmailById(int emailId,
                                     @Default(value="#[payload]")
                                     String emailName,
                                     @RefOnly
                                     FolderId folder,
                                     @Optional
                                     String description,
                                     @Optional
                                     Boolean isOperational,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException

Allows the caller to clone an email by its ID. Note: Creates a clone of approved email. If no approved version exists, then the draft version will be cloned.

Parameters:: emailId - The ID of the email to be cloned.; emailName - The name of the cloned email.; folder - The folder in which the cloned email will be created.; description - The description of the email.; isOperational - Indicates if this is an operational email. Default: false.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: a EmailResponse with the call response
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/clone-email

getEmailByName

@Processor(friendlyName="Assets | File | Get email by name")
public EmailResponse getEmailByName(@Default(value="#[payload]")
                                     String emailName,
                                     @Optional
                                     EmailStatus status,
                                     @RefOnly@Optional
                                     FolderId folder,
                                     org.mule.api.MuleMessage muleMessage)
                             throws MarketoException

Allows the caller to get an email by name.

Parameters:: emailName - Name of the email to be retrieved.; status - The email status.; folder - The parent folder of the email.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The EmailResponse with the given name.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/get-email-by-name

sendSampleEmail

@Processor(friendlyName="Assets | File | Send sample email")
public ServiceResponse sendSampleEmail(int emailId,
                                        @Default(value="#[payload]")
                                        String emailAddress,
                                        @Optional
                                        Boolean textOnly,
                                        @Optional
                                        Integer leadId,
                                        org.mule.api.MuleMessage muleMessage)
                                throws MarketoException

Allows the caller to send a sample email to a given address.

Parameters:: emailId - The ID of the email to be sent.; emailAddress - The email address to receive the sample email.; textOnly - Sends the text version of the sample in addition to the HTML version. Default is false.; leadId - The lead id. If specified, then the token values for the lead are populated when the email is sent.; muleMessage - injected by Mule, used for adding Outbound Properties
Returns:: The EmailId with the sent email.
Throws:: MarketoException - on valid error from the endpoint
Api.doc:: http://developers.marketo.com/documentation/asset-api/send-sample-email/

Class MarketoConnector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MarketoConnector

Method Detail

getConfig

setConfig

getChannels

getChannelByName

describeCustomObjects

createOrUpdateCustomObjects

getListOfCustomObjects

deleteCustomObjects

getCustomObjects

getDailyUsage

getLast7DaysUsage

getDailyErrors

getLast7DaysErrors

getPagingToken

getActivityTypes

getDeletedLeads

getLeadChanges

getLeadActivities

getCampaignById

getMultipleCampaigns

scheduleCampaign

requestCampaign

createFolder

getFolderById

getFolderByName

getFolderContents

updateFolder

deleteFolderById

browseFolders

createFile

getFileById

getSegmentations

getSegments

getMultipleLists

getListById

getFileByName

createToken

getFileList

getTokenByFolderId

addLeadsToList

updateFile

removeLeadsFromList

memberOfList

importLead

getImportLeadStatus

getImportFailureFile

getImportWarningFile

deleteTokensByFolderId

createOrUpdateLead

deleteLead

getLeadById

getLeadPartitions

describeLead

associateLead

mergeLead