collingmedia/marketo-assets-api

This package is abandoned and no longer maintained. No replacement package was suggested.

v1.0.0 2017-03-02 18:58 UTC

Requires

• php: >=5.4
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

Marketo Rest API

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new CollingMedia\Client\Api\ChannelsApi();
$max_return = 56; // int | Maximum number of channels to return.  Max 200, default 20
$offset = 56; // int | Integer offset for paging

try {
    $result = $api_instance->getAllChannelsUsingGET($max_return, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->getAllChannelsUsingGET: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://052-SXI-468.mktorest.com/

Class	Method	HTTP request	Description
ChannelsApi	getAllChannelsUsingGET	GET /rest/asset/v1/channels.json	Get Channels
ChannelsApi	getChannelByNameUsingGET	GET /rest/asset/v1/channel/byName.json	Get Channel by Name
EmailTemplatesApi	approveDraftUsingPOST1	POST /rest/asset/v1/emailTemplate/{id}/approveDraft.json	Approve Email Template Draft
EmailTemplatesApi	cloneTemplateUsingPOST	POST /rest/asset/v1/emailTemplate/{id}/clone.json	Clone Email Template
EmailTemplatesApi	createEmailTemplateUsingPOST	POST /rest/asset/v1/emailTemplates.json	Create Email Template
EmailTemplatesApi	deleteTemplateUsingPOST	POST /rest/asset/v1/emailTemplate/{id}/delete.json	Delete Email Template
EmailTemplatesApi	discardDraftUsingPOST1	POST /rest/asset/v1/emailTemplate/{id}/discardDraft.json	Discard Email Template Draft
EmailTemplatesApi	getEmailTemplatesUsingGET	GET /rest/asset/v1/emailTemplates.json	Get Email Templates
EmailTemplatesApi	getTemplateByIdUsingGET	GET /rest/asset/v1/emailTemplate/{id}.json	Get Email Template by Id
EmailTemplatesApi	getTemplateByNameUsingGET	GET /rest/asset/v1/emailTemplate/byName.json	Get Email Template by Name
EmailTemplatesApi	getTemplateContentByIdUsingGET	GET /rest/asset/v1/emailTemplate/{id}/content	Get Email Template Content by Id
EmailTemplatesApi	unapproveDraftUsingPOST1	POST /rest/asset/v1/emailTemplate/{id}/unapprove.json	Unapprove Email Template Draft
EmailTemplatesApi	updateEmailTemplateContentUsingPOST	POST /rest/asset/v1/emailTemplate/{id}/content.json	Update Email Template Content
EmailTemplatesApi	updateEmailTemplateUsingPOST	POST /rest/asset/v1/emailTemplate/{id}.json	Update Email Template Metadata
EmailsApi	addModuleUsingPOST	POST /rest/asset/v1/email/{id}/content/{moduleId}/add.json	Add Email Module
EmailsApi	approveDraftUsingPOST	POST /rest/asset/v1/email/{id}/approveDraft.json	Approve Email Draft
EmailsApi	cloneEmailUsingPOST	POST /rest/asset/v1/email/{id}/clone.json	Clone Email
EmailsApi	createEmailUsingPOST	POST /rest/asset/v1/emails.json	Create Email
EmailsApi	deleteEmailUsingPOST	POST /rest/asset/v1/email/{id}/delete.json	Delete Email
EmailsApi	deleteModuleUsingPOST	POST /rest/asset/v1/email/{id}/content/{moduleId}/delete.json	Delete Module
EmailsApi	discardDraftUsingPOST	POST /rest/asset/v1/email/{id}/discardDraft.json	Discard Email Draft
EmailsApi	duplicateModuleUsingPOST	POST /rest/asset/v1/email/{id}/content/{moduleId}/duplicate.json	Duplicate Email Module
EmailsApi	getEmailByIdUsingGET	GET /rest/asset/v1/email/{id}.json	Get Email By Id
EmailsApi	getEmailByNameUsingGET	GET /rest/asset/v1/email/byName.json	Get Email by Name
EmailsApi	getEmailContentByIdUsingGET	GET /rest/asset/v1/email/{id}/content	Get Email Content
EmailsApi	getEmailDynamicContentUsingGET	GET /rest/asset/v1/email/{id}/dynamicContent/{dynamicContentId}.json	Get Email Dynamic Content
EmailsApi	getEmailUsingGET	GET /rest/asset/v1/emails.json	Get Emails
EmailsApi	getEmailVariablesUsingGET	GET /rest/asset/v1/email/{id}/variables.json	Get Email Variables
EmailsApi	rearrangeModulesUsingPOST	POST /rest/asset/v1/email/{id}/content/rearrange.json	Rearrange Email Modules
EmailsApi	renameUsingPOST	POST /rest/asset/v1/email/{id}/content/{moduleId}/rename.json	Rename Email Module
EmailsApi	sendSampleEmailUsingPOST	POST /rest/asset/v1/email/{id}/sendSample.json	Send Sample Email
EmailsApi	unapproveDraftUsingPOST	POST /rest/asset/v1/email/{id}/unapprove.json	Unapprove Email
EmailsApi	updateEmailComponentContentUsingPOST	POST /rest/asset/v1/email/{id}/content/{htmlId}.json	Update Email Content Section
EmailsApi	updateEmailContentUsingPOST	POST /rest/asset/v1/email/{id}/content.json	Update Email Content
EmailsApi	updateEmailDynamicContentUsingPOST	POST /rest/asset/v1/email/{id}/dynamicContent/{dynamicContentId}.json	Update Email Dynamic Content Section
EmailsApi	updateEmailUsingPOST	POST /rest/asset/v1/email/{id}.json	Update Email Metadata
EmailsApi	updateVariableUsingPOST	POST /rest/asset/v1/email/{id}/variable/{name}.json	Update Email Variable
FileContentsApi	updateContentUsingPOST	POST /rest/asset/v1/file/{id}/content.json	Update File Content
FilesApi	createFileUsingPOST	POST /rest/asset/v1/files.json	Create File
FilesApi	getFileByIdUsingGET	GET /rest/asset/v1/file/{id}.json	Get File by Id
FilesApi	getFileByNameUsingGET	GET /rest/asset/v1/file/byName.json	Get File by Name
FilesApi	getFilesUsingGET	GET /rest/asset/v1/files.json	Get Files
FoldersApi	createFolderUsingPOST	POST /rest/asset/v1/folders.json	Create Folder
FoldersApi	deleteFolderUsingPOST	POST /rest/asset/v1/folder/{id}/delete.json	Delete Folder
FoldersApi	getFolderByIdUsingGET	GET /rest/asset/v1/folder/{id}.json	Get Folder by Id
FoldersApi	getFolderByNameUsingGET	GET /rest/asset/v1/folder/byName.json	Get Folder by Name
FoldersApi	getFolderContentUsingGET	GET /rest/asset/v1/folder/{id}/content.json	Get Folder Contents
FoldersApi	getFolderUsingGET	GET /rest/asset/v1/folders.json	Get Folders
FoldersApi	updateFolderUsingPOST	POST /rest/asset/v1/folder/{id}.json	Update Folder Metadata
FormFieldsApi	addFieldSetUsingPOST	POST /rest/asset/v1/form/{id}/fieldSet.json	Add Fieldset to Form
FormFieldsApi	addFieldToAFormUsingPOST	POST /rest/asset/v1/form/{id}/fields.json	Add Field to Form
FormFieldsApi	addFormFieldVisibilityRuleUsingPOST	POST /rest/asset/v1/form/{formId}/field/{fieldId}/visibility.json	Add Form Field Visibility Rules
FormFieldsApi	addRichTextFieldUsingPOST	POST /rest/asset/v1/form/{id}/richText.json	Add Rich Text Field
FormFieldsApi	deleteFormFieldFromFieldSetUsingPOST	POST /rest/asset/v1/form/{id}/fieldSet/{fieldSetId}/field/{fieldId}/delete.json	Delete Field from Fieldset
FormFieldsApi	deleteFormFieldUsingPOST	POST /rest/asset/v1/form/{id}/field/{fieldId}/delete.json	Delete Form Field
FormFieldsApi	getAllFieldsUsingGET	GET /rest/asset/v1/form/fields.json	Get Available Form Fields
FormFieldsApi	getFormFieldByFormVidUsingGET	GET /rest/asset/v1/form/{id}/fields.json	Get Fields for Form
FormFieldsApi	updateFieldPositionsUsingPOST	POST /rest/asset/v1/form/{id}/reArrange.json	Update Field Positions
FormFieldsApi	updateFormFieldUsingPOST	POST /rest/asset/v1/form/{id}/field/{fieldId}.json	Update Form Field
FormsApi	approveFromUsingPOST	POST /rest/asset/v1/form/{id}/approveDraft.json	Approve Form Draft
FormsApi	browseForms2UsingGET	GET /rest/asset/v1/forms.json	Get Forms
FormsApi	cloneLpFormsUsingPOST	POST /rest/asset/v1/form/{id}/clone.json	Clone Form
FormsApi	createLpFormsUsingPOST	POST /rest/asset/v1/forms.json	Create Form
FormsApi	deleteFormByIdUsingPOST	POST /rest/asset/v1/form/{id}/delete.json	Delete Form
FormsApi	discardFormByIdUsingPOST	POST /rest/asset/v1/form/{id}/discardDraft.json	Discard Form Draft
FormsApi	getLpFormByIdUsingGET	GET /rest/asset/v1/form/{id}.json	Get Form By Id
FormsApi	getLpFormByNameUsingGET	GET /rest/asset/v1/form/byName.json	Get Form by Name
FormsApi	getThankYouPageByIdUsingGET	GET /rest/asset/v1/form/{id}/thankYouPage.json	Get Thank You Page by Form Id
FormsApi	updateFormSubmitButtonUsingPOST	POST /rest/asset/v1/form/{id}/submitButton.json	Update Submit Button
FormsApi	updateFormsUsingPOST	POST /rest/asset/v1/form/{id}.json	Update Form Metadata
FormsApi	updateThankYouPageByIdUsingPOST	POST /rest/asset/v1/form/{id}/thankYouPage.json	Update Thank You Page
LandingPageContentApi	addLandingPageContentUsingPOST	POST /rest/asset/v1/landingPage/{id}/content.json	Add Landing Page Content Section
LandingPageContentApi	getLandingPageContentUsingGET	GET /rest/asset/v1/landingPage/{id}/content.json	Get Landing Page Content
LandingPageContentApi	getLandingPageDynamicContentsUsingGET	GET /rest/asset/v1/landingPage/{id}/dynamicContent/{content_id}.json	Get Landing Page Dynamic Content
LandingPageContentApi	removeLandingPageContentUsingPOST	POST /rest/asset/v1/landingPage/{id}/content/{contentId}/delete.json	Delete Landing Page Content Section
LandingPageContentApi	updateLandingPageContentUsingPOST	POST /rest/asset/v1/landingPage/{id}/content/{contentId}.json	Update Landing Page Content Section
LandingPageContentApi	updateLandingPageDynamicContentUsingPOST	POST /rest/asset/v1/landingPage/{id}/dynamicContent/{dynamicContentId}.json	Update Landing Page Dynamic Content Section
LandingPageTemplatesApi	approveLandingPageTemplateUsingPOST	POST /rest/asset/v1/landingPageTemplate/{id}/approveDraft.json	Approve Landing Page Template Draft
LandingPageTemplatesApi	cloneLpTemplateUsingPOST	POST /rest/asset/v1/landingPageTemplate/{id}/clone.json	Clone Landing Page Template
LandingPageTemplatesApi	createLpTemplateUsingPOST	POST /rest/asset/v1/landingPageTemplates.json	Create Landing Page Template
LandingPageTemplatesApi	deleteLpTemplateUsingPOST	POST /rest/asset/v1/landingPageTemplate/{id}/delete.json	Delete Landing Page Template
LandingPageTemplatesApi	discardDraftUsingPOST2	POST /rest/asset/v1/landingPageTemplate/{id}/discardDraft.json	Discard Landing Page Template Draft
LandingPageTemplatesApi	getLandingPageTemplateByIdUsingGET	GET /rest/asset/v1/landingPageTemplate/{id}.json	Get Landing Page Template by Id
LandingPageTemplatesApi	getLandingPageTemplateByNameUsingGET	GET /rest/asset/v1/landingPageTemplate/byName.json	Get Landing Page Template by Name
LandingPageTemplatesApi	getLandingPageTemplateContentUsingGET	GET /rest/asset/v1/landingPageTemplate/{id}/content.json	Get Landing Page Template Content
LandingPageTemplatesApi	getLandingPageTemplatesUsingGET	GET /rest/asset/v1/landingPageTemplates.json	Get Landing Page Templates
LandingPageTemplatesApi	unapproveLandingPageTemplateUsingPOST	POST /rest/asset/v1/landingPageTemplate/{id}/unapprove.json	Unapprove Landing Page Template
LandingPageTemplatesApi	updateLandingPageTemplateContentUsingPOST	POST /rest/asset/v1/landingPageTemplate/{id}/content	Update Landing Page Template Content
LandingPageTemplatesApi	updateLpTemplateUsingPOST	POST /rest/asset/v1/landingPageTemplate/{id}.json	Update Landing Page Template Metadata
LandingPagesApi	approveLandingPageUsingPOST	POST /rest/asset/v1/landingPage/{id}/approveDraft.json	Approve Landing Page Draft
LandingPagesApi	browseLandingPagesUsingGET	GET /rest/asset/v1/landingPages.json	Get Landing Pages
LandingPagesApi	cloneLandingPageUsingPOST	POST /rest/asset/v1/landingPage/{id}/clone.json	Clone Landing Page
LandingPagesApi	createLandingPageUsingPOST	POST /rest/asset/v1/landingPages.json	Create Landing Page
LandingPagesApi	deleteLandingPageByIdUsingPOST	POST /rest/asset/v1/landingPage/{id}/delete.json	Delete Landing Page
LandingPagesApi	discardLandingPageByIdUsingPOST	POST /rest/asset/v1/landingPage/{id}/discardDraft.json	Discard Landing Page Draft
LandingPagesApi	getLandingPageByIdUsingGET	GET /rest/asset/v1/landingPage/{id}.json	Get Landing Page by Id
LandingPagesApi	getLandingPageByNameUsingGET	GET /rest/asset/v1/landingPage/byName.json	Get Landing Page by Name
LandingPagesApi	getVariablesUsingGET	GET /rest/asset/v1/landingPage/{id}/variables.json	getVariables
LandingPagesApi	unapproveLandingPageByIdUsingPOST	POST /rest/asset/v1/landingPage/{id}/unapprove.json	Unapprove Landing Page
LandingPagesApi	updateLandingPageUsingPOST	POST /rest/asset/v1/landingPage/{id}.json	Update Landing Page Metadata
LandingPagesApi	updateLandingPageVariableUsingPOST	POST /rest/asset/v1/landingPage/{id}/variable/{variableId}.json	updateLandingPageVariable
ProgramsApi	approveProgramUsingPOST	POST /rest/asset/v1/program/{id}/approve.json	Approve Program
ProgramsApi	browseProgramsUsingGET	GET /rest/asset/v1/programs.json	Get Programs
ProgramsApi	cloneProgramUsingPOST	POST /rest/asset/v1/program/{id}/clone.json	Clone Program
ProgramsApi	createProgramUsingPOST	POST /rest/asset/v1/programs.json	Create Program
ProgramsApi	deleteProgramUsingPOST	POST /rest/asset/v1/program/{id}/delete.json	Delete Program
ProgramsApi	getProgramByIdUsingGET	GET /rest/asset/v1/program/{id}.json	Get Program by Id
ProgramsApi	getProgramByNameUsingGET	GET /rest/asset/v1/program/byName.json	Get Program by Name
ProgramsApi	getProgramListByTagUsingGET	GET /rest/asset/v1/program/byTag.json	Get Programs by Tag
ProgramsApi	unapproveProgramUsingPOST	POST /rest/asset/v1/program/{id}/unapprove.json	Unapprove Program
ProgramsApi	updateProgramUsingPOST	POST /rest/asset/v1/program/{id}.json	Update Program Metadata
SegmentsApi	getSegmentationUsingGET	GET /rest/asset/v1/segmentation.json	Get Segmentations
SegmentsApi	getSegmentsForSegmentationUsingGET	GET /rest/asset/v1/segmentation/{id}/segments.json	Get Segments For Segmentation
SnippetsApi	approveSnippetUsingPOST	POST /rest/asset/v1/snippet/{id}/approveDraft.json	Approve Snippet Draft
SnippetsApi	cloneSnippetUsingPOST	POST /rest/asset/v1/snippet/{id}/clone.json	Clone Snippet
SnippetsApi	createSnippetUsingPOST	POST /rest/asset/v1/snippets.json	Create Snippet
SnippetsApi	deleteSnippetUsingPOST	POST /rest/asset/v1/snippet/{id}/delete.json	Delete Snippet
SnippetsApi	discardSnippetUsingPOST	POST /rest/asset/v1/snippet/{id}/discardDraft.json	Discard Snippet Draft
SnippetsApi	getDynamicContentUsingGET	GET /rest/asset/v1/snippet/{id}/dynamicContent.json	Get Dynamic Content
SnippetsApi	getSnippetByIdUsingGET	GET /rest/asset/v1/snippet/{id}.json	Get Snippet by Id
SnippetsApi	getSnippetContentByIdUsingGET	GET /rest/asset/v1/snippet/{id}/content.json	Get Snippet Content
SnippetsApi	getSnippetUsingGET	GET /rest/asset/v1/snippets.json	Get Snippets
SnippetsApi	unapproveSnippetUsingPOST	POST /rest/asset/v1/snippet/{id}/unapprove.json	Unapprove Snippet
SnippetsApi	updateContentUsingPOST1	POST /rest/asset/v1/snippet/{id}/content.json	Update Snippet Content
SnippetsApi	updateDynamicContentUsingPOST	POST /rest/asset/v1/snippet/{id}/dynamicContent/{segmentId}.json	Update Snippet Dynamic Content
SnippetsApi	updateSnippetUsingPOST	POST /rest/asset/v1/snippet/{id}.json	Update Snippet Metadata
TagsApi	getTagByNameUsingGET	GET /rest/asset/v1/tagType/byName.json	Get Tag By Name
TagsApi	getTagTypesUsingGET	GET /rest/asset/v1/tagTypes.json	Get Tag Types
TokensApi	addTokenTOFolderUsingPOST	POST /rest/asset/v1/folder/{id}/tokens.json	Create Token
TokensApi	deleteTokenByNameUsingPOST	POST /rest/asset/v1/folder/{id}/tokens/delete.json	Delete Token by Name
TokensApi	getTokensByFolderIdUsingGET	GET /rest/asset/v1/folder/{id}/tokens.json	Get Tokens by Folder Id

Documentation For Models

• AddFormFieldRequest
• AddFormFieldSetRequest
• AddFormFieldVisibilityRequest
• AddRichTextRequest
• BrowseAllPrograms
• ChannelProgression
• ChannelResponse
• CloneEmailRequest
• CloneEmailTemplateRequest
• CloneLandingPageRequest
• CloneLpTemplateRequest
• CloneProgramRequest
• CostRequest
• Costs
• CreateEmailRequest
• CreateFileRequest
• CreateFolderRequest
• CreateLandingPageContentRequest
• CreateLandingPageRequest
• CreateLpFormRequest
• CreateLpTemplateRequest
• CreateProgramRequest
• CreateSnippetRequest
• CreateTokenRequest
• DeleteTokenRequest
• EmailContentResponse
• EmailDynamicContentItem
• EmailDynamicContentResponse
• EmailHeaderTypeValue
• EmailResponse
• EmailTemplateContentResponse
• EmailTemplateRequest
• EmailTemplateResponse
• Error
• FieldsMetaDataResponse
• FileFolder
• FileResponse
• Folder
• FolderContentResponse
• FolderResponse
• FormFieldVisibilityRequest
• FormFieldVisibilityRuleResponse
• FormKnownVisitorDTO
• FormThankYouPageDTO
• FormVisibilityRuleDTO
• FormVisibilityRuleResponse
• GetFilesRequest
• GetTagByNameRequest
• IdResponse
• JsonNode
• LPDynamicContentResponse
• LandingPageContentResponse
• LandingPageResponse
• LandingPageVariableResponse
• LpFormFieldResponse
• LpFormResponse
• LpTemplateGetContentResponse
• LpTemplateResponse
• ModelResponse
• MultipartFile
• PickListDTO
• ProgramResponse
• ReArrangeRequest
• ResponseOfBrowseAllPrograms
• ResponseOfChannelResponse
• ResponseOfEmailContentResponse
• ResponseOfEmailDynamicContentResponse
• ResponseOfEmailResponse
• ResponseOfEmailTemplateContentResponse
• ResponseOfEmailTemplateResponse
• ResponseOfFieldsMetaDataResponse
• ResponseOfFileResponse
• ResponseOfFolderContentResponse
• ResponseOfFolderResponse
• ResponseOfFormVisibilityRuleResponse
• ResponseOfIdResponse
• ResponseOfLPDynamicContentResponse
• ResponseOfLandingPageContentResponse
• ResponseOfLandingPageResponse
• ResponseOfLandingPageVariableResponse
• ResponseOfLpFormFieldResponse
• ResponseOfLpFormResponse
• ResponseOfLpTemplateGetContentResponse
• ResponseOfLpTemplateResponse
• ResponseOfProgramResponse
• ResponseOfSegmentationResponse
• ResponseOfSegmentsResponse
• ResponseOfSnippetContentResponse
• ResponseOfSnippetResponse
• ResponseOfTagResponse
• ResponseOfTagResponseGetAll
• ResponseOfThankYouPageResponse
• ResponseOfTokenResponse
• ResponseOfobject
• SegmentContent
• SegmentationResponse
• SegmentsResponse
• SendSampleEmailRequest
• SnippetContentResponse
• SnippetResponse
• SubmitButtonRequest
• TagRequest
• TagResponse
• TagResponseGetAll
• Tags
• ThankYouPageRequest
• ThankYouPageResponse
• TokenDTO
• TokenResponse
• UpdateEmailComponentContentRequest
• UpdateEmailComponentDataRequest
• UpdateEmailDynamicContentRequest
• UpdateEmailMetaDataRequest
• UpdateEmailTemplateMetaDataRequest
• UpdateFieldPosition
• UpdateFileContentRequest
• UpdateFolderRequest
• UpdateFormFieldRequest
• UpdateFormMetaDataRequest
• UpdateLandingPageContentRequest
• UpdateLandingPageDynamicContentRequest
• UpdateLandingPageRequest
• UpdateLpTemplateRequest
• UpdateProgramRequest
• UpdateSnippetContentRequest
• UpdateSnippetDynamicContentRequest
• UpdateSnippetRequest
• UpdateThankYouPageRequest
• VisibilityRuleRequest

Documentation For Authorization

All endpoints do not require authorization.

Author