From 5d3325dfdabacb2c8d3f2ca1fb7b9d569e85103d Mon Sep 17 00:00:00 2001 From: Sivakumar Munuswami Date: Tue, 24 Oct 2017 08:04:23 -0400 Subject: [PATCH] v1.1.0 release (#93) * documentation link added to readme * Added disclosure * Update sample-sendable-dataextension.php * from Platform * Development (#85) v1.1.0 changes * Development (#87) * from platform * overwrite * namespace added in src * namespace added under tests folder * namespace objsamples * composer * changelog * change log * change * autoload without composer * readme * composer * readme * readme comment * readme * readme * bounce * docs * composer * Development (#88) * from platform * overwrite * namespace added in src * namespace added under tests folder * namespace objsamples * composer * changelog * change log * change * autoload without composer * readme * composer * readme * readme comment * readme * readme * bounce * docs * composer * Development (#89) dependency update * V1.1.0 (#92) * Development (#85) (#86) v1.1.0 changes * Development dependency (#91) * from platform * overwrite * namespace added in src * namespace added under tests folder * namespace objsamples * composer * changelog * change log * change * autoload without composer * readme * composer * readme * readme comment * readme * readme * bounce * docs * composer * dependency update * Config file path update * Update README.md * Update README.md --- .gitignore | 6 +- ChangeLog.md | 8 + README.md | 47 +- composer.json | 11 +- composer.lock | 156 +- docs/classes/FuelSdk.ET_Asset.html | 879 +++++++ docs/classes/FuelSdk.ET_BaseObject.html | 562 +++++ docs/classes/FuelSdk.ET_BaseObjectRest.html | 562 +++++ docs/classes/FuelSdk.ET_BounceEvent.html | 733 ++++++ docs/classes/FuelSdk.ET_CUDSupport.html | 771 +++++++ docs/classes/FuelSdk.ET_CUDSupportRest.html | 816 +++++++ .../FuelSdk.ET_CUDWithUpsertSupport.html | 809 +++++++ docs/classes/FuelSdk.ET_Campaign.html | 855 +++++++ docs/classes/FuelSdk.ET_Campaign_Asset.html | 855 +++++++ docs/classes/FuelSdk.ET_ClickEvent.html | 733 ++++++ docs/classes/FuelSdk.ET_Client.html | 1866 +++++++++++++++ docs/classes/FuelSdk.ET_Configure.html | 607 +++++ docs/classes/FuelSdk.ET_Constructor.html | 588 +++++ docs/classes/FuelSdk.ET_ContentArea.html | 832 +++++++ docs/classes/FuelSdk.ET_Continue.html | 597 +++++ docs/classes/FuelSdk.ET_DataExtension.html | 827 +++++++ .../FuelSdk.ET_DataExtension_Column.html | 706 ++++++ .../classes/FuelSdk.ET_DataExtension_Row.html | 935 ++++++++ .../FuelSdk.ET_DataExtractActivity.html | 904 ++++++++ docs/classes/FuelSdk.ET_Delete.html | 602 +++++ docs/classes/FuelSdk.ET_DeleteRest.html | 602 +++++ docs/classes/FuelSdk.ET_Email.html | 831 +++++++ .../FuelSdk.ET_Email_SendDefinition.html | 916 ++++++++ .../FuelSdk.ET_ExtractDescription.html | 708 ++++++ docs/classes/FuelSdk.ET_Folder.html | 806 +++++++ docs/classes/FuelSdk.ET_Get.html | 612 +++++ docs/classes/FuelSdk.ET_GetRest.html | 602 +++++ docs/classes/FuelSdk.ET_GetSupport.html | 673 ++++++ docs/classes/FuelSdk.ET_GetSupportRest.html | 668 ++++++ docs/classes/FuelSdk.ET_Import.html | 889 ++++++++ docs/classes/FuelSdk.ET_Info.html | 602 +++++ docs/classes/FuelSdk.ET_List.html | 865 +++++++ docs/classes/FuelSdk.ET_List_Subscriber.html | 708 ++++++ docs/classes/FuelSdk.ET_Message_Guide.html | 943 ++++++++ docs/classes/FuelSdk.ET_OEM_Client.html | 2019 +++++++++++++++++ docs/classes/FuelSdk.ET_OpenEvent.html | 733 ++++++ docs/classes/FuelSdk.ET_Organization.html | 806 +++++++ docs/classes/FuelSdk.ET_Patch.html | 607 +++++ docs/classes/FuelSdk.ET_PatchRest.html | 607 +++++ docs/classes/FuelSdk.ET_Perform.html | 607 +++++ docs/classes/FuelSdk.ET_PerformExtract.html | 597 +++++ docs/classes/FuelSdk.ET_Post.html | 607 +++++ docs/classes/FuelSdk.ET_PostRest.html | 607 +++++ docs/classes/FuelSdk.ET_ProfileAttribute.html | 730 ++++++ docs/classes/FuelSdk.ET_PutRest.html | 607 +++++ docs/classes/FuelSdk.ET_ResultMessage.html | 708 ++++++ docs/classes/FuelSdk.ET_SMSKeyword.html | 856 +++++++ docs/classes/FuelSdk.ET_Send.html | 806 +++++++ docs/classes/FuelSdk.ET_SentEvent.html | 733 ++++++ docs/classes/FuelSdk.ET_Subscriber.html | 840 +++++++ docs/classes/FuelSdk.ET_TriggeredSend.html | 886 ++++++++ .../FuelSdk.ET_TriggeredSendSummary.html | 708 ++++++ docs/classes/FuelSdk.ET_UnsubEvent.html | 733 ++++++ docs/classes/FuelSdk.ET_User.html | 806 +++++++ docs/classes/FuelSdk.ET_Util.html | 722 ++++++ docs/files/ET_Asset.html | 143 +- docs/files/ET_Asset.php.txt | 8 +- docs/files/ET_BaseObject.html | 143 +- docs/files/ET_BaseObject.php.txt | 2 +- docs/files/ET_BaseObjectRest.html | 143 +- docs/files/ET_BaseObjectRest.php.txt | 1 + docs/files/ET_BounceEvent.html | 143 +- docs/files/ET_BounceEvent.php.txt | 7 +- docs/files/ET_CUDSupport.html | 143 +- docs/files/ET_CUDSupport.php.txt | 8 +- docs/files/ET_CUDSupportRest.html | 143 +- docs/files/ET_CUDSupportRest.php.txt | 32 +- docs/files/ET_CUDWithUpsertSupport.html | 143 +- docs/files/ET_CUDWithUpsertSupport.php.txt | 7 +- docs/files/ET_Campaign.html | 143 +- docs/files/ET_Campaign.php.txt | 7 +- docs/files/ET_Campaign_Asset.html | 143 +- docs/files/ET_Campaign_Asset.php.txt | 7 +- docs/files/ET_ClickEvent.html | 143 +- docs/files/ET_ClickEvent.php.txt | 7 +- docs/files/ET_Client.html | 143 +- docs/files/ET_Client.php.txt | 36 +- docs/files/ET_Configure.html | 143 +- docs/files/ET_Configure.php.txt | 8 +- docs/files/ET_Constructor.html | 143 +- docs/files/ET_Constructor.php.txt | 1 + docs/files/ET_ContentArea.html | 143 +- docs/files/ET_ContentArea.php.txt | 7 +- docs/files/ET_Continue.html | 143 +- docs/files/ET_Continue.php.txt | 7 +- docs/files/ET_DataExtension.html | 143 +- docs/files/ET_DataExtension.php.txt | 7 +- docs/files/ET_DataExtension_Column.html | 143 +- docs/files/ET_DataExtension_Column.php.txt | 7 +- docs/files/ET_DataExtension_Row.html | 143 +- docs/files/ET_DataExtension_Row.php.txt | 8 +- docs/files/ET_DataExtractActivity.html | 332 +++ docs/files/ET_DataExtractActivity.php.txt | 99 + docs/files/ET_Delete.html | 143 +- docs/files/ET_Delete.php.txt | 8 +- docs/files/ET_DeleteRest.html | 143 +- docs/files/ET_DeleteRest.php.txt | 12 +- docs/files/ET_Email.html | 143 +- docs/files/ET_Email.php.txt | 7 +- docs/files/ET_Email_SendDefinition.html | 143 +- docs/files/ET_Email_SendDefinition.php.txt | 7 +- docs/files/ET_ExtractDescription.html | 332 +++ docs/files/ET_ExtractDescription.php.txt | 26 + docs/files/ET_Folder.html | 143 +- docs/files/ET_Folder.php.txt | 7 +- docs/files/ET_Get.html | 143 +- docs/files/ET_Get.php.txt | 10 +- docs/files/ET_GetRest.html | 143 +- docs/files/ET_GetRest.php.txt | 15 +- docs/files/ET_GetSupport.html | 143 +- docs/files/ET_GetSupport.php.txt | 7 +- docs/files/ET_GetSupportRest.html | 143 +- docs/files/ET_GetSupportRest.php.txt | 17 +- docs/files/ET_Import.html | 143 +- docs/files/ET_Import.php.txt | 9 +- docs/files/ET_Info.html | 143 +- docs/files/ET_Info.php.txt | 7 +- docs/files/ET_List.html | 143 +- docs/files/ET_List.php.txt | 7 +- docs/files/ET_List_Subscriber.html | 143 +- docs/files/ET_List_Subscriber.php.txt | 7 +- docs/files/ET_Message_Guide.html | 143 +- docs/files/ET_Message_Guide.php.txt | 7 +- docs/files/ET_OEM_Client.html | 143 +- docs/files/ET_OEM_Client.php.txt | 7 +- docs/files/ET_OpenEvent.html | 143 +- docs/files/ET_OpenEvent.php.txt | 7 +- docs/files/ET_Organization.html | 143 +- docs/files/ET_Organization.php.txt | 7 +- docs/files/ET_Patch.html | 143 +- docs/files/ET_Patch.php.txt | 9 +- docs/files/ET_PatchRest.html | 143 +- docs/files/ET_PatchRest.php.txt | 12 +- docs/files/ET_Perform.html | 143 +- docs/files/ET_Perform.php.txt | 10 +- docs/files/ET_PerformExtract.html | 332 +++ docs/files/ET_PerformExtract.php.txt | 32 + docs/files/ET_Post.html | 143 +- docs/files/ET_Post.php.txt | 9 +- docs/files/ET_PostRest.html | 143 +- docs/files/ET_PostRest.php.txt | 12 +- docs/files/ET_ProfileAttribute.html | 143 +- docs/files/ET_ProfileAttribute.php.txt | 7 +- docs/files/ET_PutRest.html | 143 +- docs/files/ET_PutRest.php.txt | 12 +- docs/files/ET_ResultMessage.html | 332 +++ docs/files/ET_ResultMessage.php.txt | 21 + docs/files/ET_SMSKeyword.html | 333 +++ docs/files/ET_SMSKeyword.php.txt | 22 + docs/files/ET_Send.html | 143 +- docs/files/ET_Send.php.txt | 7 +- docs/files/ET_SentEvent.html | 143 +- docs/files/ET_SentEvent.php.txt | 7 +- docs/files/ET_Subscriber.html | 143 +- docs/files/ET_Subscriber.php.txt | 7 +- docs/files/ET_TriggeredSend.html | 143 +- docs/files/ET_TriggeredSend.php.txt | 7 +- docs/files/ET_TriggeredSendSummary.html | 332 +++ docs/files/ET_TriggeredSendSummary.php.txt | 21 + docs/files/ET_UnsubEvent.html | 143 +- docs/files/ET_UnsubEvent.php.txt | 7 +- docs/files/ET_User.html | 143 +- docs/files/ET_User.php.txt | 7 +- docs/files/ET_Util.html | 143 +- docs/files/ET_Util.php.txt | 38 +- docs/files/autoload.html | 325 +++ docs/files/autoload.php.txt | 12 + docs/files/config.html | 141 +- docs/graphs/class.html | 17 +- docs/index.html | 346 +-- docs/namespaces/FuelSdk.html | 481 ++++ docs/namespaces/default.html | 346 +-- docs/reports/deprecated.html | 17 +- docs/reports/errors.html | 1135 ++++----- docs/reports/markers.html | 21 +- objsamples/sample-AddSubscriberToList.php | 9 +- objsamples/sample-AddSubscribersToLists.php | 9 +- ...mple-CreateAndStartDataExtensionImport.php | 7 +- .../sample-CreateAndStartListImport.php | 7 +- objsamples/sample-CreateContentAreas.php | 9 +- objsamples/sample-CreateDataExtensions.php | 9 +- objsamples/sample-CreateProfileAttributes.php | 10 +- .../sample-SendEmailToDataExtension.php | 7 +- objsamples/sample-SendEmailToList.php | 7 +- objsamples/sample-asset.php | 10 +- objsamples/sample-bounceevent.php | 11 +- objsamples/sample-campaign.php | 13 +- objsamples/sample-clickevent.php | 9 +- objsamples/sample-contentarea.php | 9 +- objsamples/sample-data-extract-activity.php | 58 + objsamples/sample-dataextension.php | 14 +- objsamples/sample-email-senddefinition.php | 9 +- objsamples/sample-email.php | 9 +- objsamples/sample-extract-description.php | 56 + objsamples/sample-folder.php | 9 +- objsamples/sample-import.php | 9 +- objsamples/sample-list.php | 9 +- objsamples/sample-list.subscriber.php | 13 +- objsamples/sample-message.php | 13 +- objsamples/sample-openevent.php | 9 +- objsamples/sample-organization.php | 9 +- objsamples/sample-profileattribute.php | 9 +- objsamples/sample-resultmessage.php | 42 + objsamples/sample-send.php | 10 +- objsamples/sample-sendable-dataextension.php | 26 +- objsamples/sample-sentevent.php | 9 +- objsamples/sample-subscriber.php | 14 +- objsamples/sample-tenant.php | 9 +- objsamples/sample-triggeredsend.php | 9 +- objsamples/sample-triggeredsendsummary.php | 30 + objsamples/sample-unsubevent.php | 9 +- src/ET_Asset.php | 8 +- src/ET_BaseObject.php | 2 +- src/ET_BaseObjectRest.php | 1 + src/ET_BounceEvent.php | 7 +- src/ET_CUDSupport.php | 8 +- src/ET_CUDSupportRest.php | 32 +- src/ET_CUDWithUpsertSupport.php | 7 +- src/ET_Campaign.php | 7 +- src/ET_Campaign_Asset.php | 7 +- src/ET_ClickEvent.php | 7 +- src/ET_Client.php | 32 +- src/ET_Configure.php | 8 +- src/ET_Constructor.php | 1 + src/ET_ContentArea.php | 7 +- src/ET_Continue.php | 7 +- src/ET_DataExtension.php | 7 +- src/ET_DataExtension_Column.php | 7 +- src/ET_DataExtension_Row.php | 8 +- src/ET_DataExtractActivity.php | 97 + src/ET_Delete.php | 8 +- src/ET_DeleteRest.php | 12 +- src/ET_Email.php | 7 +- src/ET_Email_SendDefinition.php | 7 +- src/ET_ExtractDescription.php | 24 + src/ET_Folder.php | 7 +- src/ET_Get.php | 10 +- src/ET_GetRest.php | 15 +- src/ET_GetSupport.php | 7 +- src/ET_GetSupportRest.php | 17 +- src/ET_Import.php | 9 +- src/ET_Info.php | 7 +- src/ET_List.php | 7 +- src/ET_List_Subscriber.php | 7 +- src/ET_Message_Guide.php | 7 +- src/ET_OEM_Client.php | 7 +- src/ET_OpenEvent.php | 7 +- src/ET_Organization.php | 7 +- src/ET_Patch.php | 9 +- src/ET_PatchRest.php | 12 +- src/ET_Perform.php | 10 +- src/ET_PerformExtract.php | 30 + src/ET_Post.php | 9 +- src/ET_PostRest.php | 12 +- src/ET_ProfileAttribute.php | 7 +- src/ET_PutRest.php | 12 +- src/ET_ResultMessage.php | 19 + src/ET_Send.php | 7 +- src/ET_SentEvent.php | 7 +- src/ET_Subscriber.php | 7 +- src/ET_TriggeredSend.php | 7 +- src/ET_TriggeredSendSummary.php | 18 + src/ET_UnsubEvent.php | 7 +- src/ET_User.php | 7 +- src/ET_Util.php | 38 +- src/autoload.php | 12 + tests/AssetTest.php | 5 +- tests/BounceEventTest.php | 3 + tests/CampaignTest.php | 3 + tests/ClickEventTest.php | 3 + tests/ContentAreaTest.php | 3 + tests/DataExtensionTest.php | 3 + tests/DataExtractTest.php | 134 ++ tests/EmailTest.php | 3 + tests/FolderTest.php | 3 + tests/ImportTest.php | 3 + tests/ListSubscriberTest.php | 5 + tests/ListTest.php | 3 + tests/MessageTest.php | 13 +- tests/OpenEventTest.php | 3 + tests/OrganizationTest.php | 3 + tests/ProfileAttributeTest.php | 5 +- tests/ResultMessageTest.php | 38 + tests/SendTest.php | 3 + tests/SentEventTest.php | 3 + tests/SubscriberTest.php | 3 + tests/TriggeredSendSummaryTest.php | 39 + tests/TriggeredSendTest.php | 3 + tests/UnitBootstrap.php | 17 +- tests/UnsubEventTest.php | 3 + tests/UserTest.php | 3 + tests/phpunit.xml | 6 +- tests/testdox.html | 167 ++ 298 files changed, 52621 insertions(+), 4576 deletions(-) create mode 100644 docs/classes/FuelSdk.ET_Asset.html create mode 100644 docs/classes/FuelSdk.ET_BaseObject.html create mode 100644 docs/classes/FuelSdk.ET_BaseObjectRest.html create mode 100644 docs/classes/FuelSdk.ET_BounceEvent.html create mode 100644 docs/classes/FuelSdk.ET_CUDSupport.html create mode 100644 docs/classes/FuelSdk.ET_CUDSupportRest.html create mode 100644 docs/classes/FuelSdk.ET_CUDWithUpsertSupport.html create mode 100644 docs/classes/FuelSdk.ET_Campaign.html create mode 100644 docs/classes/FuelSdk.ET_Campaign_Asset.html create mode 100644 docs/classes/FuelSdk.ET_ClickEvent.html create mode 100644 docs/classes/FuelSdk.ET_Client.html create mode 100644 docs/classes/FuelSdk.ET_Configure.html create mode 100644 docs/classes/FuelSdk.ET_Constructor.html create mode 100644 docs/classes/FuelSdk.ET_ContentArea.html create mode 100644 docs/classes/FuelSdk.ET_Continue.html create mode 100644 docs/classes/FuelSdk.ET_DataExtension.html create mode 100644 docs/classes/FuelSdk.ET_DataExtension_Column.html create mode 100644 docs/classes/FuelSdk.ET_DataExtension_Row.html create mode 100644 docs/classes/FuelSdk.ET_DataExtractActivity.html create mode 100644 docs/classes/FuelSdk.ET_Delete.html create mode 100644 docs/classes/FuelSdk.ET_DeleteRest.html create mode 100644 docs/classes/FuelSdk.ET_Email.html create mode 100644 docs/classes/FuelSdk.ET_Email_SendDefinition.html create mode 100644 docs/classes/FuelSdk.ET_ExtractDescription.html create mode 100644 docs/classes/FuelSdk.ET_Folder.html create mode 100644 docs/classes/FuelSdk.ET_Get.html create mode 100644 docs/classes/FuelSdk.ET_GetRest.html create mode 100644 docs/classes/FuelSdk.ET_GetSupport.html create mode 100644 docs/classes/FuelSdk.ET_GetSupportRest.html create mode 100644 docs/classes/FuelSdk.ET_Import.html create mode 100644 docs/classes/FuelSdk.ET_Info.html create mode 100644 docs/classes/FuelSdk.ET_List.html create mode 100644 docs/classes/FuelSdk.ET_List_Subscriber.html create mode 100644 docs/classes/FuelSdk.ET_Message_Guide.html create mode 100644 docs/classes/FuelSdk.ET_OEM_Client.html create mode 100644 docs/classes/FuelSdk.ET_OpenEvent.html create mode 100644 docs/classes/FuelSdk.ET_Organization.html create mode 100644 docs/classes/FuelSdk.ET_Patch.html create mode 100644 docs/classes/FuelSdk.ET_PatchRest.html create mode 100644 docs/classes/FuelSdk.ET_Perform.html create mode 100644 docs/classes/FuelSdk.ET_PerformExtract.html create mode 100644 docs/classes/FuelSdk.ET_Post.html create mode 100644 docs/classes/FuelSdk.ET_PostRest.html create mode 100644 docs/classes/FuelSdk.ET_ProfileAttribute.html create mode 100644 docs/classes/FuelSdk.ET_PutRest.html create mode 100644 docs/classes/FuelSdk.ET_ResultMessage.html create mode 100644 docs/classes/FuelSdk.ET_SMSKeyword.html create mode 100644 docs/classes/FuelSdk.ET_Send.html create mode 100644 docs/classes/FuelSdk.ET_SentEvent.html create mode 100644 docs/classes/FuelSdk.ET_Subscriber.html create mode 100644 docs/classes/FuelSdk.ET_TriggeredSend.html create mode 100644 docs/classes/FuelSdk.ET_TriggeredSendSummary.html create mode 100644 docs/classes/FuelSdk.ET_UnsubEvent.html create mode 100644 docs/classes/FuelSdk.ET_User.html create mode 100644 docs/classes/FuelSdk.ET_Util.html create mode 100644 docs/files/ET_DataExtractActivity.html create mode 100644 docs/files/ET_DataExtractActivity.php.txt create mode 100644 docs/files/ET_ExtractDescription.html create mode 100644 docs/files/ET_ExtractDescription.php.txt create mode 100644 docs/files/ET_PerformExtract.html create mode 100644 docs/files/ET_PerformExtract.php.txt create mode 100644 docs/files/ET_ResultMessage.html create mode 100644 docs/files/ET_ResultMessage.php.txt create mode 100644 docs/files/ET_SMSKeyword.html create mode 100644 docs/files/ET_SMSKeyword.php.txt create mode 100644 docs/files/ET_TriggeredSendSummary.html create mode 100644 docs/files/ET_TriggeredSendSummary.php.txt create mode 100644 docs/files/autoload.html create mode 100644 docs/files/autoload.php.txt create mode 100644 docs/namespaces/FuelSdk.html create mode 100644 objsamples/sample-data-extract-activity.php create mode 100644 objsamples/sample-extract-description.php create mode 100644 objsamples/sample-resultmessage.php create mode 100644 objsamples/sample-triggeredsendsummary.php create mode 100644 src/ET_DataExtractActivity.php create mode 100644 src/ET_ExtractDescription.php create mode 100644 src/ET_PerformExtract.php create mode 100644 src/ET_ResultMessage.php create mode 100644 src/ET_TriggeredSendSummary.php create mode 100644 src/autoload.php create mode 100644 tests/DataExtractTest.php create mode 100644 tests/ResultMessageTest.php create mode 100644 tests/TriggeredSendSummaryTest.php create mode 100644 tests/testdox.html diff --git a/.gitignore b/.gitignore index b7bbccf..9c1bb1c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,8 @@ config.php /objsamples/AllTest.bat .DS_Store objsamples/sample-testing.php -/vendor \ No newline at end of file +/vendor +/objsamples/sample-asset-TestFilePath.txt +/objsamples/sample-asset-upload.php +/tests/CampaignAssetTest.php +/tests/ImportListTest.php diff --git a/ChangeLog.md b/ChangeLog.md index 3eb2581..0fe2320 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,3 +1,11 @@ +# 1.1.0 (2017-10-19) +* namespace integration in all source, test and sample code +* composer autoload issue fix +* newly supported objects: + - Result Message + - Data Extract + - Triggered Send Summary + # 1.0.0 (2017-07-18) ### New Features diff --git a/README.md b/README.md index 41c84d4..7a61bef 100755 --- a/README.md +++ b/README.md @@ -3,11 +3,24 @@ FuelSDK-PHP Salesforce Marketing Cloud Fuel SDK for PHP +> Salesforce Marketing Cloud Fuel SDK for PHP is free to use but are not official Salesforce Marketing Cloud products and should be considered community projects. This SDK is not officially tested or documented. For help on any Salesforce Marketing Cloud Fuel SDK for PHP, please consult the Salesforce message boards or the issues section of this repository. Salesforce Marketing Cloud support is not available for this SDK. + ## Overview ## The Fuel SDK for PHP provides easy access to Salesforce Marketic Cloud's Fuel API Family services, including a collection of REST and SOAP API. These APIs provide access to Salesforce Marketing Cloud (previously called ExactTarget) functionality via common collection types such as array/hash. -## New Features in Version 1.0.0 ## +## New Features in Version 1.1.0 ## + +* **namespace :** namespace is introduced. + +* **newly supported objects:** + - Result Message + - Data Extract + - Triggered Send Summary + +* composer autoload issue fix + + + ## Requirements ## PHP Version >=5.6.24 @@ -46,21 +61,23 @@ Extensions: - SOAP - curl +## API Documentation ## + +http://salesforce-marketingcloud.github.io/FuelSDK-PHP/index.html ## Installation ## ### Manual Installation -After downloading the project, rename the config.php.template file to config.php. +After downloading the project, rename the config.php.template file to config.php. Most importantly, you also need to download all dependencies manually and include accordingly. That's why we highly encourage to get it from composer. ### Composer -Add a dependency to composer require salesforce-mc/fuel-sdk-php and robrichards/xmlseclibs to the require section of your project's composer.json configuration file, and update your application. +Add a dependency to composer require salesforce-mc/fuel-sdk-php to the require section of your project's composer.json configuration file, and update your application. The following code is an example of a minimal composer.json file: 
 {
     "require": {
-        "salesforce-mc/fuel-sdk-php": "1.0.0",
-        "robrichards/xmlseclibs": "3.0.0 as 2.0.1"
+        "salesforce-mc/fuel-sdk-php": "1.1.0"
     }
 }
@@ -70,14 +87,24 @@ Edit config.php so you can input the ClientID and ClientSecret values provided w See the ET_Client section below for details on how to specify these values at the time the ET_Client object is instantiated if you would prefer to store the ClientID and ClientSecret values in a database or other configuration storage mechanism. -If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community](http://code.exacttarget.com/appcenter "Code@ App Center"). +If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to Salesforce Marketing Cloud App Center. ## Example Request ## -All ExactTarget objects exposed through the Fuel SDK begin with be prefixed with "ET\_". Start by working with the ET_List object: +All ExactTarget objects exposed through the Fuel SDK begin with be prefixed with "ET\_". Start by working with the ET_List object: + +Get the config.php.template file (under vendor/salesforce-mc/ using composer), rename it to config.php and update clientId & clientSecret. +Most importantly, put it in your project's root directory where composer.json file exists. +Add composer's auto generated autoload.php file, change the path according to your directory structure: +> require \_\_DIR\_\_ . '/../vendor/autoload.php'; + +Add use statement to reference the FuelSdk namespace: +> use FuelSdk\ET_Client; +> use FuelSdk\ET_List; + Next, create an instance of the ET_Client class: > $myclient = new ET_Client(); @@ -174,11 +201,15 @@ Sample List: - [ClickEvent](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-clickevent.php) - [ContentArea](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-contentarea.php) - [DataExtension](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-dataextension.php) + - [DataExtractActivity](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-data-extract-activity.php) - [Email](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-email.php) + - [Folder](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-folder.php) - [List](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-list.php) - [List > Subscriber](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-list.subscriber.php) - [OpenEvent](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-openevent.php) + - [ResultMessage](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-resultmessage.php) - [SentEvent](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-sentevent.php) - [Subscriber](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-subscriber.php) - [TriggeredSend](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-triggeredsend.php) + - [TriggeredSendSummary](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-triggeredsendsummary.php) - [UnsubEvent](https://github.com/ExactTarget/FuelSDK-PHP/blob/master/objsamples/sample-unsubevent.php) diff --git a/composer.json b/composer.json index 161cb06..a738eaf 100755 --- a/composer.json +++ b/composer.json @@ -10,7 +10,7 @@ "ext-openssl": "*", "ext-soap": "*", "php": ">=5.6.24", - "robrichards/wse-php":"2.0.1", + "robrichards/wse-php":"3.0.0 as 2.0.1", "firebase/php-jwt":">=5.0.0" }, "require-dev": { @@ -29,7 +29,12 @@ ], "autoload": { "psr-4": { - "\\" : "src/" + "FuelSdk\\" : "src/" + } + }, + "autoload-dev": { + "psr-4": { + "FuelSdk\\Test\\": "tests/" } } -} +} \ No newline at end of file diff --git a/composer.lock b/composer.lock index b68e3d6..c997075 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "content-hash": "0b26bc3fd000db231207d952ec28108e", + "content-hash": "279d7d9b366d26fb6554dc836af1bca9", "packages": [ { "name": "firebase/php-jwt", @@ -98,23 +98,24 @@ }, { "name": "robrichards/xmlseclibs", - "version": "3.0.0", + "version": "2.0.1", "source": { "type": "git", "url": "https://github.com/robrichards/xmlseclibs.git", - "reference": "a29eb3100eb6c5a427d6a3f9e61aff37492405ae" + "reference": "53bb1e9cae490a8f93af41bd9df6ea897161ca05" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/robrichards/xmlseclibs/zipball/a29eb3100eb6c5a427d6a3f9e61aff37492405ae", - "reference": "a29eb3100eb6c5a427d6a3f9e61aff37492405ae", + "url": "https://api.github.com/repos/robrichards/xmlseclibs/zipball/53bb1e9cae490a8f93af41bd9df6ea897161ca05", + "reference": "53bb1e9cae490a8f93af41bd9df6ea897161ca05", "shasum": "" }, "require": { - "php": ">= 5.6" + "php": ">= 5.3" }, "suggest": { - "ext-openssl": "OpenSSL extension" + "ext/mcrypt": "MCrypt extension", + "ext/openssl": "OpenSSL extension" }, "type": "library", "autoload": { @@ -134,7 +135,7 @@ "xml", "xmldsig" ], - "time": "2017-05-25T15:25:34+00:00" + "time": "2016-09-08T13:15:00+00:00" } ], "packages-dev": [ @@ -1854,22 +1855,22 @@ }, { "name": "phpspec/prophecy", - "version": "v1.7.0", + "version": "v1.7.2", "source": { "type": "git", "url": "https://github.com/phpspec/prophecy.git", - "reference": "93d39f1f7f9326d746203c7c056f300f7f126073" + "reference": "c9b8c6088acd19d769d4cc0ffa60a9fe34344bd6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpspec/prophecy/zipball/93d39f1f7f9326d746203c7c056f300f7f126073", - "reference": "93d39f1f7f9326d746203c7c056f300f7f126073", + "url": "https://api.github.com/repos/phpspec/prophecy/zipball/c9b8c6088acd19d769d4cc0ffa60a9fe34344bd6", + "reference": "c9b8c6088acd19d769d4cc0ffa60a9fe34344bd6", "shasum": "" }, "require": { "doctrine/instantiator": "^1.0.2", "php": "^5.3|^7.0", - "phpdocumentor/reflection-docblock": "^2.0|^3.0.2", + "phpdocumentor/reflection-docblock": "^2.0|^3.0.2|^4.0", "sebastian/comparator": "^1.1|^2.0", "sebastian/recursion-context": "^1.0|^2.0|^3.0" }, @@ -1880,7 +1881,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.6.x-dev" + "dev-master": "1.7.x-dev" } }, "autoload": { @@ -1913,7 +1914,7 @@ "spy", "stub" ], - "time": "2017-03-02T20:05:34+00:00" + "time": "2017-09-04T11:05:03+00:00" }, { "name": "phpunit/php-code-coverage", @@ -2166,16 +2167,16 @@ }, { "name": "phpunit/phpunit", - "version": "5.7.21", + "version": "5.7.23", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "3b91adfb64264ddec5a2dee9851f354aa66327db" + "reference": "78532d5269d984660080d8e0f4c99c5c2ea65ffe" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/3b91adfb64264ddec5a2dee9851f354aa66327db", - "reference": "3b91adfb64264ddec5a2dee9851f354aa66327db", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/78532d5269d984660080d8e0f4c99c5c2ea65ffe", + "reference": "78532d5269d984660080d8e0f4c99c5c2ea65ffe", "shasum": "" }, "require": { @@ -2244,7 +2245,7 @@ "testing", "xunit" ], - "time": "2017-06-21T08:11:54+00:00" + "time": "2017-10-15T06:13:55+00:00" }, { "name": "phpunit/phpunit-mock-objects", @@ -3011,16 +3012,16 @@ }, { "name": "symfony/config", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/config.git", - "reference": "0b8541d18507d10204a08384640ff6df3c739ebe" + "reference": "1dbeaa8e2db4b29159265867efff075ad961558c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/config/zipball/0b8541d18507d10204a08384640ff6df3c739ebe", - "reference": "0b8541d18507d10204a08384640ff6df3c739ebe", + "url": "https://api.github.com/repos/symfony/config/zipball/1dbeaa8e2db4b29159265867efff075ad961558c", + "reference": "1dbeaa8e2db4b29159265867efff075ad961558c", "shasum": "" }, "require": { @@ -3063,20 +3064,20 @@ ], "description": "Symfony Config Component", "homepage": "https://symfony.com", - "time": "2017-04-12T14:07:15+00:00" + "time": "2017-10-04T18:56:36+00:00" }, { "name": "symfony/console", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/console.git", - "reference": "46e65f8d98c9ab629bbfcc16a4ff023f61c37fb2" + "reference": "f81549d2c5fdee8d711c9ab3c7e7362353ea5853" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/46e65f8d98c9ab629bbfcc16a4ff023f61c37fb2", - "reference": "46e65f8d98c9ab629bbfcc16a4ff023f61c37fb2", + "url": "https://api.github.com/repos/symfony/console/zipball/f81549d2c5fdee8d711c9ab3c7e7362353ea5853", + "reference": "f81549d2c5fdee8d711c9ab3c7e7362353ea5853", "shasum": "" }, "require": { @@ -3124,7 +3125,7 @@ ], "description": "Symfony Console Component", "homepage": "https://symfony.com", - "time": "2017-07-03T08:04:30+00:00" + "time": "2017-10-01T21:00:16+00:00" }, { "name": "symfony/debug", @@ -3185,16 +3186,16 @@ }, { "name": "symfony/event-dispatcher", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/event-dispatcher.git", - "reference": "1377400fd641d7d1935981546aaef780ecd5bf6d" + "reference": "7fe089232554357efb8d4af65ce209fc6e5a2186" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/1377400fd641d7d1935981546aaef780ecd5bf6d", - "reference": "1377400fd641d7d1935981546aaef780ecd5bf6d", + "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/7fe089232554357efb8d4af65ce209fc6e5a2186", + "reference": "7fe089232554357efb8d4af65ce209fc6e5a2186", "shasum": "" }, "require": { @@ -3241,7 +3242,7 @@ ], "description": "Symfony EventDispatcher Component", "homepage": "https://symfony.com", - "time": "2017-06-02T07:47:27+00:00" + "time": "2017-10-01T21:00:16+00:00" }, { "name": "symfony/filesystem", @@ -3294,16 +3295,16 @@ }, { "name": "symfony/finder", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/finder.git", - "reference": "4f4e84811004e065a3bb5ceeb1d9aa592630f9ad" + "reference": "a945724b201f74d543e356f6059c930bb8d10c92" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/finder/zipball/4f4e84811004e065a3bb5ceeb1d9aa592630f9ad", - "reference": "4f4e84811004e065a3bb5ceeb1d9aa592630f9ad", + "url": "https://api.github.com/repos/symfony/finder/zipball/a945724b201f74d543e356f6059c930bb8d10c92", + "reference": "a945724b201f74d543e356f6059c930bb8d10c92", "shasum": "" }, "require": { @@ -3339,20 +3340,20 @@ ], "description": "Symfony Finder Component", "homepage": "https://symfony.com", - "time": "2017-06-01T20:52:29+00:00" + "time": "2017-10-01T21:00:16+00:00" }, { "name": "symfony/polyfill-mbstring", - "version": "v1.4.0", + "version": "v1.6.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "f29dca382a6485c3cbe6379f0c61230167681937" + "reference": "2ec8b39c38cb16674bbf3fea2b6ce5bf117e1296" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/f29dca382a6485c3cbe6379f0c61230167681937", - "reference": "f29dca382a6485c3cbe6379f0c61230167681937", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/2ec8b39c38cb16674bbf3fea2b6ce5bf117e1296", + "reference": "2ec8b39c38cb16674bbf3fea2b6ce5bf117e1296", "shasum": "" }, "require": { @@ -3364,7 +3365,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.4-dev" + "dev-master": "1.6-dev" } }, "autoload": { @@ -3398,20 +3399,20 @@ "portable", "shim" ], - "time": "2017-06-09T14:24:12+00:00" + "time": "2017-10-11T12:05:26+00:00" }, { "name": "symfony/process", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/process.git", - "reference": "57e52a0a6a80ea0aec4fc1b785a7920a95cb88a8" + "reference": "26c9fb02bf06bd6b90f661a5bd17e510810d0176" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/process/zipball/57e52a0a6a80ea0aec4fc1b785a7920a95cb88a8", - "reference": "57e52a0a6a80ea0aec4fc1b785a7920a95cb88a8", + "url": "https://api.github.com/repos/symfony/process/zipball/26c9fb02bf06bd6b90f661a5bd17e510810d0176", + "reference": "26c9fb02bf06bd6b90f661a5bd17e510810d0176", "shasum": "" }, "require": { @@ -3447,20 +3448,20 @@ ], "description": "Symfony Process Component", "homepage": "https://symfony.com", - "time": "2017-07-03T08:04:30+00:00" + "time": "2017-10-01T21:00:16+00:00" }, { "name": "symfony/stopwatch", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/stopwatch.git", - "reference": "e02577b841394a78306d7b547701bb7bb705bad5" + "reference": "28ee62ea4736431ca817cdaebcb005663e9cd1cb" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/stopwatch/zipball/e02577b841394a78306d7b547701bb7bb705bad5", - "reference": "e02577b841394a78306d7b547701bb7bb705bad5", + "url": "https://api.github.com/repos/symfony/stopwatch/zipball/28ee62ea4736431ca817cdaebcb005663e9cd1cb", + "reference": "28ee62ea4736431ca817cdaebcb005663e9cd1cb", "shasum": "" }, "require": { @@ -3496,7 +3497,7 @@ ], "description": "Symfony Stopwatch Component", "homepage": "https://symfony.com", - "time": "2017-04-12T14:07:15+00:00" + "time": "2017-10-01T21:00:16+00:00" }, { "name": "symfony/translation", @@ -3564,16 +3565,16 @@ }, { "name": "symfony/validator", - "version": "v2.8.24", + "version": "v2.8.28", "source": { "type": "git", "url": "https://github.com/symfony/validator.git", - "reference": "6c019627f2a69b9ab2ac41fd53102148a55af564" + "reference": "1531ddfd96efd1b2c231cbf45f22e652a8f67925" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/validator/zipball/6c019627f2a69b9ab2ac41fd53102148a55af564", - "reference": "6c019627f2a69b9ab2ac41fd53102148a55af564", + "url": "https://api.github.com/repos/symfony/validator/zipball/1531ddfd96efd1b2c231cbf45f22e652a8f67925", + "reference": "1531ddfd96efd1b2c231cbf45f22e652a8f67925", "shasum": "" }, "require": { @@ -3633,24 +3634,24 @@ ], "description": "Symfony Validator Component", "homepage": "https://symfony.com", - "time": "2017-07-03T08:04:30+00:00" + "time": "2017-10-01T21:00:16+00:00" }, { "name": "symfony/yaml", - "version": "v3.3.4", + "version": "v3.3.10", "source": { "type": "git", "url": "https://github.com/symfony/yaml.git", - "reference": "1f93a8d19b8241617f5074a123e282575b821df8" + "reference": "8c7bf1e7d5d6b05a690b715729cb4cd0c0a99c46" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/1f93a8d19b8241617f5074a123e282575b821df8", - "reference": "1f93a8d19b8241617f5074a123e282575b821df8", + "url": "https://api.github.com/repos/symfony/yaml/zipball/8c7bf1e7d5d6b05a690b715729cb4cd0c0a99c46", + "reference": "8c7bf1e7d5d6b05a690b715729cb4cd0c0a99c46", "shasum": "" }, "require": { - "php": ">=5.5.9" + "php": "^5.5.9|>=7.0.8" }, "require-dev": { "symfony/console": "~2.8|~3.0" @@ -3688,20 +3689,20 @@ ], "description": "Symfony Yaml Component", "homepage": "https://symfony.com", - "time": "2017-06-15T12:58:50+00:00" + "time": "2017-10-05T14:43:42+00:00" }, { "name": "twig/twig", - "version": "v1.34.4", + "version": "v1.35.0", "source": { "type": "git", "url": "https://github.com/twigphp/Twig.git", - "reference": "f878bab48edb66ad9c6ed626bf817f60c6c096ee" + "reference": "daa657073e55b0a78cce8fdd22682fddecc6385f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/twigphp/Twig/zipball/f878bab48edb66ad9c6ed626bf817f60c6c096ee", - "reference": "f878bab48edb66ad9c6ed626bf817f60c6c096ee", + "url": "https://api.github.com/repos/twigphp/Twig/zipball/daa657073e55b0a78cce8fdd22682fddecc6385f", + "reference": "daa657073e55b0a78cce8fdd22682fddecc6385f", "shasum": "" }, "require": { @@ -3715,7 +3716,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.34-dev" + "dev-master": "1.35-dev" } }, "autoload": { @@ -3753,7 +3754,7 @@ "keywords": [ "templating" ], - "time": "2017-07-04T13:19:31+00:00" + "time": "2017-09-27T18:06:46+00:00" }, { "name": "zendframework/zend-cache", @@ -4452,14 +4453,7 @@ "time": "2013-12-19T11:40:00+00:00" } ], - "aliases": [ - { - "alias": "2.0.1", - "alias_normalized": "2.0.1.0", - "version": "3.0.0.0", - "package": "robrichards/xmlseclibs" - } - ], + "aliases": [], "minimum-stability": "stable", "stability-flags": [], "prefer-stable": false, diff --git a/docs/classes/FuelSdk.ET_Asset.html b/docs/classes/FuelSdk.ET_Asset.html new file mode 100644 index 0000000..ab12be5 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Asset.html @@ -0,0 +1,879 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Asset

+

An asset is an instance of any kind of content in the CMS.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ __construct()
+ upload()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $folderProperty
+ $folderMediaType
+ $lastPageNumber
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderProperty

+ 
$folderProperty : string
+

+ + +

Type

+ string + — Folder property e.g. "Category", "CategoryID", etc.
+
+ +
+ +
+
+ +
+

$folderMediaType

+ 
$folderMediaType : string
+

+ + +

Type

+ string + — Folder Media Type e.g. "dataextension", "triggered_send", etc.
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : null
+

+ + + + +

Returns

+ null + +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : null
+

+ + + + +

Returns

+ null + +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

The constructor will assign endpoint, urlProps, urlPropsRequired fields of parent ET_BaseObjectRest

+ + + + + +
+
+ +
+ +
+
+ +
+

upload()

+ + 
upload() : object
+

+ + + + +

Returns

+ object + —

The stdClass object with property httpcode and body from the REST service after upload is finished

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_BaseObject.html b/docs/classes/FuelSdk.ET_BaseObject.html new file mode 100644 index 0000000..6b9ae3b --- /dev/null +++ b/docs/classes/FuelSdk.ET_BaseObject.html @@ -0,0 +1,562 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_BaseObject

+

This class represents the base object for SOAP operation.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ No public methods found +
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_BaseObjectRest.html b/docs/classes/FuelSdk.ET_BaseObjectRest.html new file mode 100644 index 0000000..a54e433 --- /dev/null +++ b/docs/classes/FuelSdk.ET_BaseObjectRest.html @@ -0,0 +1,562 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_BaseObjectRest

+

This class represents the base object for REST operation.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ No public methods found +
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ + +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_BounceEvent.html b/docs/classes/FuelSdk.ET_BounceEvent.html new file mode 100644 index 0000000..6d851fe --- /dev/null +++ b/docs/classes/FuelSdk.ET_BounceEvent.html @@ -0,0 +1,733 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_BounceEvent

+

Contains information pertaining to the specific event of an email message bounce.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $getSinceLastBatch
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$getSinceLastBatch

+ 
$getSinceLastBatch : boolean
+

+ + +

Type

+ boolean + — Gets or sets a boolean value indicating whether to get since last batch. true if get since last batch; otherwise, false.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_CUDSupport.html b/docs/classes/FuelSdk.ET_CUDSupport.html new file mode 100644 index 0000000..79f4d1f --- /dev/null +++ b/docs/classes/FuelSdk.ET_CUDSupport.html @@ -0,0 +1,771 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_CUDSupport

+

This class represents the create, update, delete operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ post()
+ patch()
+ delete()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_CUDSupportRest.html b/docs/classes/FuelSdk.ET_CUDSupportRest.html new file mode 100644 index 0000000..fe9cc81 --- /dev/null +++ b/docs/classes/FuelSdk.ET_CUDSupportRest.html @@ -0,0 +1,816 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_CUDSupportRest

+

This class represents the create, update, delete operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ post()
+ patch()
+ delete()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $lastPageNumber
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+ $folderProperty
+ $folderMediaType
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ +
+
+ +
+

$folderProperty

+ 
$folderProperty : string
+

+ + +

Type

+ string + — Folder property e.g. "Category", "CategoryID", etc.
+
+ +
+ +
+
+ +
+

$folderMediaType

+ 
$folderMediaType : string
+

+ + +

Type

+ string + — Folder Media Type e.g. "dataextension", "triggered_send", etc.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_PatchRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PatchRest + —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_DeleteRest
+

+ + + + +

Returns

+ \FuelSdk\ET_DeleteRest + —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_CUDWithUpsertSupport.html b/docs/classes/FuelSdk.ET_CUDWithUpsertSupport.html new file mode 100644 index 0000000..6607b84 --- /dev/null +++ b/docs/classes/FuelSdk.ET_CUDWithUpsertSupport.html @@ -0,0 +1,809 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_CUDWithUpsertSupport

+

This class represents the put operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ put()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

put()

+ + 
put() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Campaign.html b/docs/classes/FuelSdk.ET_Campaign.html new file mode 100644 index 0000000..8852166 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Campaign.html @@ -0,0 +1,855 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Campaign

+

Represents a program in an account

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ __construct()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $folderProperty
+ $folderMediaType
+ $lastPageNumber
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderProperty

+ 
$folderProperty : string
+

+ + +

Type

+ string + — Folder property e.g. "Category", "CategoryID", etc.
+
+ +
+ +
+
+ +
+

$folderMediaType

+ 
$folderMediaType : string
+

+ + +

Type

+ string + — Folder Media Type e.g. "dataextension", "triggered_send", etc.
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_PatchRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PatchRest + —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_DeleteRest
+

+ + + + +

Returns

+ \FuelSdk\ET_DeleteRest + —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and will assign endpoint, urlProps, urlPropsRequired fields of parent ET_BaseObjectRest

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Campaign_Asset.html b/docs/classes/FuelSdk.ET_Campaign_Asset.html new file mode 100644 index 0000000..63d5b90 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Campaign_Asset.html @@ -0,0 +1,855 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Campaign_Asset

+

Represents an asset associated with a campaign.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ __construct()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $folderProperty
+ $folderMediaType
+ $lastPageNumber
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderProperty

+ 
$folderProperty : string
+

+ + +

Type

+ string + — Folder property e.g. "Category", "CategoryID", etc.
+
+ +
+ +
+
+ +
+

$folderMediaType

+ 
$folderMediaType : string
+

+ + +

Type

+ string + — Folder Media Type e.g. "dataextension", "triggered_send", etc.
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_PatchRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PatchRest + —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_DeleteRest
+

+ + + + +

Returns

+ \FuelSdk\ET_DeleteRest + —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and will assign endpoint, urlProps, urlPropsRequired fields of parent ET_BaseObjectRest

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_ClickEvent.html b/docs/classes/FuelSdk.ET_ClickEvent.html new file mode 100644 index 0000000..04a396b --- /dev/null +++ b/docs/classes/FuelSdk.ET_ClickEvent.html @@ -0,0 +1,733 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_ClickEvent

+

Represents ClickEvent Class.

+

Contains information regarding a click on a link contained in a message.

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $getSinceLastBatch
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$getSinceLastBatch

+ 
$getSinceLastBatch : boolean
+

+ + +

Type

+ boolean + — Gets or sets a boolean value indicating whether to get since last batch. true if get since last batch; otherwise, false.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Client.html b/docs/classes/FuelSdk.ET_Client.html new file mode 100644 index 0000000..a60c5b9 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Client.html @@ -0,0 +1,1866 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Client

+

Defines a Client interface class which manages the authentication process.

+

This is the main client class which performs authentication, obtains auth token, if expired refresh auth token. +Settings/Configuration can be passed to this class during construction or set it in config.php file. +Configuration passed as parameter overrides the values from the configuration file.

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ refreshToken()
+ __getLastResponseHTTPCode()
+ CreateWSDL()
+ GetLastModifiedDate()
+ __doRequest()
+ addOAuth()
+ getAuthToken()
+ setAuthToken()
+ getAuthTokenExpiration()
+ getInternalAuthToken()
+ setInternalAuthToken()
+ setRefreshToken()
+ getRefreshToken()
+ AddSubscriberToList()
+ AddSubscribersToLists()
+ CreateDataExtensions()
+ SendTriggeredSends()
+ SendEmailToList()
+ SendEmailToDataExtension()
+ CreateAndStartListImport()
+ CreateAndStartDataExtensionImport()
+ CreateProfileAttributes()
+ CreateContentAreas()
+
+
+ $packageName
+ $packageFolders
+ $parentFolders
+ $proxyHost
+ $proxyPort
+ $proxyUserName
+ $proxyPassword
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ $wsdlLoc
+ $debugSOAP
+ $lastHTTPCode
+ $clientId
+ $clientSecret
+ $appsignature
+ $endpoint
+ $tenantTokens
+ $tenantKey
+ $xmlLoc
+ $baseUrl
+ $baseAuthUrl
+
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$packageName

+ 
$packageName : string
+

+ + +

Type

+ string + — Folder/Package Name
+
+ +
+ +
+
+ +
+

$packageFolders

+ 
$packageFolders : array
+

+ + +

Type

+ array + — Array of Folder object properties.
+
+ +
+ +
+
+ +
+

$parentFolders

+ 
$parentFolders : \FuelSdk\ET_Folder
+

+ + +

Type

+ \FuelSdk\ET_Folder + — Parent folder object.
+
+ +
+ +
+
+ +
+

$proxyHost

+ 
$proxyHost : string
+

+ + +

Type

+ string + — Proxy host.
+
+ +
+ +
+
+ +
+

$proxyPort

+ 
$proxyPort : string
+

+ + +

Type

+ string + — Proxy port.
+
+ +
+ +
+
+ +
+

$proxyUserName

+ 
$proxyUserName : string
+

+ + +

Type

+ string + — Proxy username.
+
+ +
+ +
+
+ +
+

$proxyPassword

+ 
$proxyPassword : string
+

+ + +

Type

+ string + — Proxy password.
+
+ +
+ +
+
+ +
+

$wsdlLoc

+ 
$wsdlLoc :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$debugSOAP

+ 
$debugSOAP :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$lastHTTPCode

+ 
$lastHTTPCode :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$clientId

+ 
$clientId :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$clientSecret

+ 
$clientSecret :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$appsignature

+ 
$appsignature :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$tenantTokens

+ 
$tenantTokens :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$tenantKey

+ 
$tenantKey :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$xmlLoc

+ 
$xmlLoc :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$baseUrl

+ 
$baseUrl :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$baseAuthUrl

+ 
$baseAuthUrl :
+

+ + +

Type

+ +
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(boolean  $getWSDL = false, boolean  $debug = false, array  $params = null)
+

Initializes a new instance of the ET_Client class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
boolean$getWSDL

Flag to indicate whether to load WSDL from source. +If true, WSDL is load from the source and saved in to path set in xmlLoc variable. +If false, WSDL stored in the path set in xmlLoc is loaded.

boolean$debug

Flag to indicate whether debug information needs to be logged. +Logging is enabled when the value is set to true and disabled when set to false.

array$params

Array of settings as string.
+Following are the possible settings.
+defaultwsdl - WSDL location/path
+clientid - Client Identifier optained from App Center
+clientsecred - Client secret associated with clientid
+appsignature - Application signature optained from App Center
+baseUrl - ExactTarget SOAP API Url
+baseAuthUrl - ExactTarget authentication rest api resource url
+If your application behind a proxy server, use the following setting
+proxyhost - proxy server host name or ip address
+proxyport - proxy server prot number
+proxyusername - proxy server user name
+proxypassword - proxy server password

+ + + +
+
+ +
+ +
+
+ +
+

refreshToken()

+ + 
refreshToken(boolean  $forceRefresh = false) : void
+

Gets the refresh token using the authentication URL.

+ + +

Parameters

+ + + + + + +
boolean$forceRefresh

Flag to indicate a force refresh of authentication toekn.

+ + + +
+
+ +
+ +
+
+ +
+

__getLastResponseHTTPCode()

+ + 
__getLastResponseHTTPCode() : \FuelSdk\lastHTTPCode
+

Returns the HTTP code return by the last SOAP/Rest call

+ + + + +

Returns

+ \FuelSdk\lastHTTPCode + +
+
+ +
+ +
+
+ +
+

CreateWSDL()

+ + 
CreateWSDL(  $wsdlLoc) : void
+

Create the WSDL file at specified location.

+ + +

Parameters

+ + + + + + +
$wsdlLoc
+ + + +
+
+ +
+ +
+
+ +
+

GetLastModifiedDate()

+ + 
GetLastModifiedDate(\FuelSdk\[type]  $remotepath) : string
+

Returns last modified date of the URL

+ + +

Parameters

+ + + + + + +
\FuelSdk\[type]$remotepath
+ + +

Returns

+ string + —

Last modified date

+ +
+
+ +
+ +
+
+ +
+

__doRequest()

+ + 
__doRequest(string  $request, string  $location, string  $saction, string  $version, integer  $one_way) : string
+

Perfoms an soap request.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
string$request

Soap request xml

string$location

Url as string

string$saction

Soap action name

string$version

Future use

integer$one_way

Future use

+ + +

Returns

+ string + —

Soap web service request result

+ +
+
+ +
+ +
+
+ +
+

addOAuth()

+ + 
addOAuth(string  $doc, string  $token) : void
+

Add OAuth token to the header of the soap request

+ + +

Parameters

+ + + + + + + + + + + +
string$doc

Soap request as xml string

string$token

OAuth token

+ + + +
+
+ +
+ +
+
+ +
+

getAuthToken()

+ + 
getAuthToken(  $tenantKey = null) : string
+

Get the authentication token.

+ + +

Parameters

+ + + + + + +
$tenantKey
+ + +

Returns

+ string + +
+
+ +
+ +
+
+ +
+

setAuthToken()

+ + 
setAuthToken(string  $tenantKey, string  $authToken, string  $authTokenExpiration)
+

Set the authentication token in the tenantTokens array.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$tenantKey

Tenant key for which auth toke to be set

string$authToken

Authentication token to be set

string$authTokenExpiration

Authentication token expiration value

+ + + +
+
+ +
+ +
+
+ +
+

getAuthTokenExpiration()

+ + 
getAuthTokenExpiration(string  $tenantKey) : string
+

Get the Auth Token Expiration.

+ + +

Parameters

+ + + + + + +
string$tenantKey

Tenant key for which authenication token is returned

+ + +

Returns

+ string + —

Authenticaiton token for the tenant key

+ +
+
+ +
+ +
+
+ +
+

getInternalAuthToken()

+ + 
getInternalAuthToken(string  $tenantKey) : string
+

Get the internal authentication token.

+ + +

Parameters

+ + + + + + +
string$tenantKey
+ + +

Returns

+ string + —

Internal authenication token

+ +
+
+ +
+ +
+
+ +
+

setInternalAuthToken()

+ + 
setInternalAuthToken(string  $tenantKey, string  $internalAuthToken)
+

Set the internal auth tokan.

+ + +

Parameters

+ + + + + + + + + + + +
string$tenantKey
string$internalAuthToken
+ + + +
+
+ +
+ +
+
+ +
+

setRefreshToken()

+ + 
setRefreshToken(string  $tenantKey, string  $refreshToken)
+

Set the refresh authentication token.

+ + +

Parameters

+ + + + + + + + + + + +
string$tenantKey

Tenant key to which refresh token is set

string$refreshToken

Refresh authenication token

+ + + +
+
+ +
+ +
+
+ +
+

getRefreshToken()

+ + 
getRefreshToken(string  $tenantKey) : string
+

Get the refresh token for the tenant.

+ + +

Parameters

+ + + + + + +
string$tenantKey
+ + +

Returns

+ string + —

Refresh token for the tenant

+ +
+
+ +
+ +
+
+ +
+

AddSubscriberToList()

+ + 
AddSubscriberToList(string  $emailAddress, array  $listIDs, string  $subscriberKey = null) : mixed
+

Add subscriber to list.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$emailAddress

Email address of the subscriber

array$listIDs

Array of list id to which the subscriber is added

string$subscriberKey

Newly added subscriber key

+ + +

Returns

+ mixed + —

post or patch response object. If the subscriber already existing patch response is returned otherwise post response returned.

+ +
+
+ +
+ +
+
+ +
+

AddSubscribersToLists()

+ + 
AddSubscribersToLists(  $subs,   $listIDs)
+

+ + +

Parameters

+ + + + + + + + + + + +
$subs
$listIDs
+ + + +
+
+ +
+ +
+
+ +
+

CreateDataExtensions()

+ + 
CreateDataExtensions(array  $dataExtensionDefinitions) : mixed
+

Create a new data extension based on the definition passed

+ + +

Parameters

+ + + + + + +
array$dataExtensionDefinitions

Data extension definition properties as an array

+ + +

Returns

+ mixed + —

post response object

+ +
+
+ +
+ +
+
+ +
+

SendTriggeredSends()

+ + 
SendTriggeredSends(array  $arrayOfTriggeredRecords) : mixed
+

Starts an send operation for the TriggerredSend records

+ + +

Parameters

+ + + + + + +
array$arrayOfTriggeredRecords

Array of TriggeredSend records

+ + +

Returns

+ mixed + —

Send reponse object

+ +
+
+ +
+ +
+
+ +
+

SendEmailToList()

+ + 
SendEmailToList(string  $emailID, string  $listID, string  $sendClassficationCustomerKey) : mixed
+

Create an email send definition, send the email based on the definition and delete the definition.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$emailID

Email identifier for which the email is sent

string$listID

Send definition list identifier

string$sendClassficationCustomerKey

Send classification customer key

+ + +

Returns

+ mixed + —

Final delete action result

+ +
+
+ +
+ +
+
+ +
+

SendEmailToDataExtension()

+ + 
SendEmailToDataExtension(string  $emailID, string  $sendableDataExtensionCustomerKey, string  $sendClassficationCustomerKey) : mixed
+

Create an email send definition, send the email based on the definition and delete the definition.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$emailID

Email identifier for which the email is sent

string$sendableDataExtensionCustomerKey

Sendable data extension customer key

string$sendClassficationCustomerKey

Send classification customer key

+ + +

Returns

+ mixed + —

Final delete action result

+ +
+
+ +
+ +
+
+ +
+

CreateAndStartListImport()

+ + 
CreateAndStartListImport(string  $listId, string  $fileName) : mixed
+

Create an import definition and start the import process

+ + +

Parameters

+ + + + + + + + + + + +
string$listId

List identifier. Used as the destination object identifier.

string$fileName

Name of the file to be imported

+ + +

Returns

+ mixed + —

Returns the import process result

+ +
+
+ +
+ +
+
+ +
+

CreateAndStartDataExtensionImport()

+ + 
CreateAndStartDataExtensionImport(string  $dataExtensionCustomerKey, string  $fileName, boolean  $overwrite) : mixed
+

Create an import definition and start the import process

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$dataExtensionCustomerKey

Data extension customer key. Used as the destination object identifier.

string$fileName

Name of the file to be imported

boolean$overwrite

Flag to indicate to overwrite the uploaded file

+ + +

Returns

+ mixed + —

Returns the import process result

+ +
+
+ +
+ +
+
+ +
+

CreateProfileAttributes()

+ + 
CreateProfileAttributes(array  $allAttributes) : mixed
+

Create a profile attribute

+ + +

Parameters

+ + + + + + +
array$allAttributes

Profile attribute properties as an array.

+ + +

Returns

+ mixed + —

Post operation result

+ +
+
+ +
+ +
+
+ +
+

CreateContentAreas()

+ + 
CreateContentAreas(array  $arrayOfContentAreas) : void
+

Create one or more content areas

+ + +

Parameters

+ + + + + + +
array$arrayOfContentAreas

Content areas properties as an array

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Configure.html b/docs/classes/FuelSdk.ET_Configure.html new file mode 100644 index 0000000..4a69b8e --- /dev/null +++ b/docs/classes/FuelSdk.ET_Configure.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Configure

+

This class represents configurations required for SOAP operation.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, string  $action, array  $props)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

string$action

Action names e.g. "create", "delete", "update", etc

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Constructor.html b/docs/classes/FuelSdk.ET_Constructor.html new file mode 100644 index 0000000..d80cd81 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Constructor.html @@ -0,0 +1,588 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Constructor

+

This class represents the contructor for all web service (SOAP/REST) operation and holds HTTP status code, response, result, etc.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(string  $requestresponse, integer  $httpcode, boolean  $restcall = false)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$requestresponse

The response from the request

integer$httpcode

The HTTP status code e.g. 200, 404. etc

boolean$restcall

Whether to make REST or SOAP call, default is false i.e. SOAP calls

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_ContentArea.html b/docs/classes/FuelSdk.ET_ContentArea.html new file mode 100644 index 0000000..7a7b06f --- /dev/null +++ b/docs/classes/FuelSdk.ET_ContentArea.html @@ -0,0 +1,832 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_ContentArea

+

ET_ContentArea - Represents a ContentArea class.

+

A ContentArea represents a defined section of reusable content. One or many ContentAreas can be defined for an Email object. +A ContentArea is always acted upon in the context of an Email object.

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $folderId
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderId

+ 
$folderId : integer
+

+ + +

Type

+ integer + — Gets or sets the folder identifier.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and will assign obj, folderProperty, folderMediaType property

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Continue.html b/docs/classes/FuelSdk.ET_Continue.html new file mode 100644 index 0000000..eafdc38 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Continue.html @@ -0,0 +1,597 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Continue

+

This class represents ContinueRequest for SOAP operation.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(  $authStub, string  $request_id)
+

Initializes a new instance of the class.

+

@param ET_Client $authStub The ET client object which performs the auth token, refresh token using clientID clientSecret

+ +

Parameters

+ + + + + + + + + + + +
$authStub
string$request_id

The request ID from the SOAP response

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_DataExtension.html b/docs/classes/FuelSdk.ET_DataExtension.html new file mode 100644 index 0000000..2f0f8ee --- /dev/null +++ b/docs/classes/FuelSdk.ET_DataExtension.html @@ -0,0 +1,827 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_DataExtension

+

ETDataExtension - Represents a data extension within an account.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $columns
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$columns

+ 
$columns : array<mixed,\FuelSdk\ET_DataExtension_Column>
+

+ + +

Type

+ array<mixed,\FuelSdk\ET_DataExtension_Column> + — Gets or sets array of DE columns.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

Post this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

Patch this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_DataExtension_Column.html b/docs/classes/FuelSdk.ET_DataExtension_Column.html new file mode 100644 index 0000000..cf88cc2 --- /dev/null +++ b/docs/classes/FuelSdk.ET_DataExtension_Column.html @@ -0,0 +1,706 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_DataExtension_Column

+

ETDataExtensionColumn - Represents Data Extension Field.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

Get this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_DataExtension_Row.html b/docs/classes/FuelSdk.ET_DataExtension_Row.html new file mode 100644 index 0000000..d0dbe9d --- /dev/null +++ b/docs/classes/FuelSdk.ET_DataExtension_Row.html @@ -0,0 +1,935 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_DataExtension_Row

+

ETDataExtensionRow - Represents Data Extension Row.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ put()
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $Name
+ $CustomerKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ getName()
+ getCustomerKey()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$Name

+ 
$Name : string
+

+ + +

Type

+ string + — Gets or sets the name of the data extension.
+
+ +
+ +
+
+ +
+

$CustomerKey

+ 
$CustomerKey : string
+

+ + +

Type

+ string + — Gets or sets the data extension customer key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

put()

+ + 
put() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

Post this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

Patch this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

Delete this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

Get this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ +
+

getName()

+ + 
getName()
+

+ + + + + +
+
+ +
+ +
+
+ +
+

getCustomerKey()

+ + 
getCustomerKey()
+

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_DataExtractActivity.html b/docs/classes/FuelSdk.ET_DataExtractActivity.html new file mode 100644 index 0000000..e9f09c2 --- /dev/null +++ b/docs/classes/FuelSdk.ET_DataExtractActivity.html @@ -0,0 +1,904 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_DataExtractActivity

+

This class represents the get operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+ start()
+ extractDataExtension()
+ extractTrackingData()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $lastTaskID
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ populateExtractType()
+
+
+ $extractmap
+
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$lastTaskID

+ 
$lastTaskID : string|null
+

+ + +

Type

+ string|null + — contains last task ID if available
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ +
+
+ +
+

$extractmap

+ 
$extractmap :
+

+ + +

Type

+ +
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ +
+

start()

+ + 
start() : \FuelSdk\ET_PerformExtract
+

This method start this import process.

+ + + + +

Returns

+ \FuelSdk\ET_PerformExtract + —

Object of type ET_PerformExtract which contains http status, request ID, etc from the Extract SOAP service

+ +
+
+ +
+ +
+
+ +
+

extractDataExtension()

+ + 
extractDataExtension(string  $deCustomerKey, string  $outputFileName = "PHP_data_extract_DE.csv") : \FuelSdk\ET_PerformExtract
+

This method start this import process.

+ + +

Parameters

+ + + + + + + + + + + +
string$deCustomerKey

data extension customer key

string$outputFileName

name of the ouput file

+ + +

Returns

+ \FuelSdk\ET_PerformExtract + —

Object of type ET_PerformExtract which contains http status, request ID, etc from the Extract SOAP service

+ +
+
+ +
+ +
+
+ +
+

extractTrackingData()

+ + 
extractTrackingData(string  $startDate, string  $endDate, string  $outputFileName = "PHP_data_extract_tracking.csv") : \FuelSdk\ET_PerformExtract
+

This method start this import process.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$startDate

start date time in YYYY-mm-dd hh:MM AM format

string$endDate

end date time in YYYY-mm-dd hh:MM AM format

string$outputFileName

name of the ouput file

+ + +

Returns

+ \FuelSdk\ET_PerformExtract + —

Object of type ET_PerformExtract which contains http status, request ID, etc from the Extract SOAP service

+ +
+
+ +
+ +
+
+ +
+

populateExtractType()

+ + 
populateExtractType()
+

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Delete.html b/docs/classes/FuelSdk.ET_Delete.html new file mode 100644 index 0000000..211f748 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Delete.html @@ -0,0 +1,602 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Delete

+

This class represents the DELETE operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, array  $props)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_DeleteRest.html b/docs/classes/FuelSdk.ET_DeleteRest.html new file mode 100644 index 0000000..4b0ed4d --- /dev/null +++ b/docs/classes/FuelSdk.ET_DeleteRest.html @@ -0,0 +1,602 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_DeleteRest

+

This class represents the DELETE operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $url,   $qs = "")
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$url

The endpoint URL

$qs
+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Email.html b/docs/classes/FuelSdk.ET_Email.html new file mode 100644 index 0000000..ea8f6ef --- /dev/null +++ b/docs/classes/FuelSdk.ET_Email.html @@ -0,0 +1,831 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Email

+

ET_Email - Represents an email in a Marketing Cloud account.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $folderId
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderId

+ 
$folderId : integer
+

+ + +

Type

+ integer + — Gets or sets the folder identifier.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and will assign obj, folderProperty, folderMediaType property

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Email_SendDefinition.html b/docs/classes/FuelSdk.ET_Email_SendDefinition.html new file mode 100644 index 0000000..f359f94 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Email_SendDefinition.html @@ -0,0 +1,916 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Email_SendDefinition

+

This class contains the message information, sender profile, delivery profile, and audience information.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+ send()
+ status()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $folderId
+ $lastTaskID
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderId

+ 
$folderId : integer
+

+ + +

Type

+ integer + — Gets or sets the folder identifier.
+
+ +
+ +
+
+ +
+

$lastTaskID

+ 
$lastTaskID : string|null
+

+ + +

Type

+ string|null + — contains last task ID if available
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ +
+

send()

+ + 
send() : \FuelSdk\ET_Perform
+

Send this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Perform + —

Object of type ET_Perform which contains http status code, response, etc from the START SOAP service

+ +
+
+ +
+ +
+
+ +
+

status()

+ + 
status() : \FuelSdk\ET_Get
+

Status of this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_ExtractDescription.html b/docs/classes/FuelSdk.ET_ExtractDescription.html new file mode 100644 index 0000000..273f638 --- /dev/null +++ b/docs/classes/FuelSdk.ET_ExtractDescription.html @@ -0,0 +1,708 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_ExtractDescription

+

Contains information about the opening of a message send by a subscriber.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Folder.html b/docs/classes/FuelSdk.ET_Folder.html new file mode 100644 index 0000000..6e2d17d --- /dev/null +++ b/docs/classes/FuelSdk.ET_Folder.html @@ -0,0 +1,806 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Folder

+

This class represents a folder in a Marketing Cloud account.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Get.html b/docs/classes/FuelSdk.ET_Get.html new file mode 100644 index 0000000..aaedf8b --- /dev/null +++ b/docs/classes/FuelSdk.ET_Get.html @@ -0,0 +1,612 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Get

+

This class represents the GET operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, array  $props, array  $filter, boolean  $getSinceLastBatch = false)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

array$filter

Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")

boolean$getSinceLastBatch

Gets or sets a boolean value indicating whether to get since last batch. true if get since last batch; otherwise, false.

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_GetRest.html b/docs/classes/FuelSdk.ET_GetRest.html new file mode 100644 index 0000000..523c6e6 --- /dev/null +++ b/docs/classes/FuelSdk.ET_GetRest.html @@ -0,0 +1,602 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_GetRest

+

This class represents the GET operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $url, null|string  $qs = "")
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$url

The endpoint URL

null|string$qs

access token passed in header instead of url

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_GetSupport.html b/docs/classes/FuelSdk.ET_GetSupport.html new file mode 100644 index 0000000..2e54fb4 --- /dev/null +++ b/docs/classes/FuelSdk.ET_GetSupport.html @@ -0,0 +1,673 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_GetSupport

+

This class represents the get operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_GetSupportRest.html b/docs/classes/FuelSdk.ET_GetSupportRest.html new file mode 100644 index 0000000..ed0107d --- /dev/null +++ b/docs/classes/FuelSdk.ET_GetSupportRest.html @@ -0,0 +1,668 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_GetSupportRest

+

This class represents the get operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+ $lastPageNumber
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Import.html b/docs/classes/FuelSdk.ET_Import.html new file mode 100644 index 0000000..88eca75 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Import.html @@ -0,0 +1,889 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Import

+

This class defines a reusable pattern of import options.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+ start()
+ status()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $lastTaskID
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$lastTaskID

+ 
$lastTaskID : string|null
+

+ + +

Type

+ string|null + — contains last import task ID if available
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

This method is used to create/post the instance

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ +
+

start()

+ + 
start() : \FuelSdk\ET_Perform
+

This method start this import process.

+ + + + +

Returns

+ \FuelSdk\ET_Perform + —

Object of type ET_Perform which contains http status code, response, etc from the Perform SOAP service

+ +
+
+ +
+ +
+
+ +
+

status()

+ + 
status() : \FuelSdk\ET_Get
+

This method is used to get Property Definition for a subscriber

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Info.html b/docs/classes/FuelSdk.ET_Info.html new file mode 100644 index 0000000..88314a7 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Info.html @@ -0,0 +1,602 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Info

+

This class Provides info about a object like Campaign, Asset, DataExtension, etc.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, boolean  $extended = false)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

boolean$extended

If true extended properties will be stored in the results, else regular properties will be stored. By default false.

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_List.html b/docs/classes/FuelSdk.ET_List.html new file mode 100644 index 0000000..893aee3 --- /dev/null +++ b/docs/classes/FuelSdk.ET_List.html @@ -0,0 +1,865 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_List

+

This class represents a marketing list of subscribers.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ put()
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $folderId
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderId

+ 
$folderId : integer
+

+ + +

Type

+ integer + — Gets or sets the folder identifier.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

put()

+ + 
put() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the property obj, folderProperty and folderMediaType to appropriate values.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_List_Subscriber.html b/docs/classes/FuelSdk.ET_List_Subscriber.html new file mode 100644 index 0000000..b3cc40d --- /dev/null +++ b/docs/classes/FuelSdk.ET_List_Subscriber.html @@ -0,0 +1,708 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_List_Subscriber

+

The class retrieves subscribers for a list or lists for a subscriber.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Message_Guide.html b/docs/classes/FuelSdk.ET_Message_Guide.html new file mode 100644 index 0000000..b7a83ca --- /dev/null +++ b/docs/classes/FuelSdk.ET_Message_Guide.html @@ -0,0 +1,943 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Message_Guide

+

The class can get, convert, render, send messages.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ __construct()
+ convert()
+ sendProcess()
+ render()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $folderProperty
+ $folderMediaType
+ $lastPageNumber
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderProperty

+ 
$folderProperty : string
+

+ + +

Type

+ string + — Folder property e.g. "Category", "CategoryID", etc.
+
+ +
+ +
+
+ +
+

$folderMediaType

+ 
$folderMediaType : string
+

+ + +

Type

+ string + — Folder Media Type e.g. "dataextension", "triggered_send", etc.
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_PatchRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PatchRest + —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_DeleteRest
+

+ + + + +

Returns

+ \FuelSdk\ET_DeleteRest + —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

The constructor will assign endpoint, urlProps, urlPropsRequired fields of parent ET_BaseObjectRest

+ + + + + +
+
+ +
+ +
+
+ +
+

convert()

+ + 
convert() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

sendProcess()

+ + 
sendProcess() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP (not REST) service

+ +
+
+ +
+ +
+
+ +
+

render()

+ + 
render() : \FuelSdk\ET_GetRest|\FuelSdk\ET_PosttRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest|\FuelSdk\ET_PosttRest + —

Object of type ET_GetRest or ET_PostRest if props field is an array and holds id as a key

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_OEM_Client.html b/docs/classes/FuelSdk.ET_OEM_Client.html new file mode 100644 index 0000000..9c732d1 --- /dev/null +++ b/docs/classes/FuelSdk.ET_OEM_Client.html @@ -0,0 +1,2019 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_OEM_Client

+

The class can create and retrieve specific tenant.

+

This is the main client class which performs authentication, obtains auth token, if expired refresh auth token. +Settings/Configuration can be passed to this class during construction or set it in config.php file. +Configuration passed as parameter overrides the values from the configuration file.

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ refreshToken()
+ __getLastResponseHTTPCode()
+ CreateWSDL()
+ GetLastModifiedDate()
+ __doRequest()
+ addOAuth()
+ getAuthToken()
+ setAuthToken()
+ getAuthTokenExpiration()
+ getInternalAuthToken()
+ setInternalAuthToken()
+ setRefreshToken()
+ getRefreshToken()
+ AddSubscriberToList()
+ AddSubscribersToLists()
+ CreateDataExtensions()
+ SendTriggeredSends()
+ SendEmailToList()
+ SendEmailToDataExtension()
+ CreateAndStartListImport()
+ CreateAndStartDataExtensionImport()
+ CreateProfileAttributes()
+ CreateContentAreas()
+ CreateTenant()
+ GetTenants()
+
+
+ $packageName
+ $packageFolders
+ $parentFolders
+ $proxyHost
+ $proxyPort
+ $proxyUserName
+ $proxyPassword
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ $wsdlLoc
+ $debugSOAP
+ $lastHTTPCode
+ $clientId
+ $clientSecret
+ $appsignature
+ $endpoint
+ $tenantTokens
+ $tenantKey
+ $xmlLoc
+ $baseUrl
+ $baseAuthUrl
+
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$packageName

+ 
$packageName : string
+

+ + +

Type

+ string + — Folder/Package Name
+
+ +
+ +
+
+ +
+

$packageFolders

+ 
$packageFolders : array
+

+ + +

Type

+ array + — Array of Folder object properties.
+
+ +
+ +
+
+ +
+

$parentFolders

+ 
$parentFolders : \FuelSdk\ET_Folder
+

+ + +

Type

+ \FuelSdk\ET_Folder + — Parent folder object.
+
+ +
+ +
+
+ +
+

$proxyHost

+ 
$proxyHost : string
+

+ + +

Type

+ string + — Proxy host.
+
+ +
+ +
+
+ +
+

$proxyPort

+ 
$proxyPort : string
+

+ + +

Type

+ string + — Proxy port.
+
+ +
+ +
+
+ +
+

$proxyUserName

+ 
$proxyUserName : string
+

+ + +

Type

+ string + — Proxy username.
+
+ +
+ +
+
+ +
+

$proxyPassword

+ 
$proxyPassword : string
+

+ + +

Type

+ string + — Proxy password.
+
+ +
+ +
+
+ +
+

$wsdlLoc

+ 
$wsdlLoc :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$debugSOAP

+ 
$debugSOAP :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$lastHTTPCode

+ 
$lastHTTPCode :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$clientId

+ 
$clientId :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$clientSecret

+ 
$clientSecret :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$appsignature

+ 
$appsignature :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$tenantTokens

+ 
$tenantTokens :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$tenantKey

+ 
$tenantKey :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$xmlLoc

+ 
$xmlLoc :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$baseUrl

+ 
$baseUrl :
+

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$baseAuthUrl

+ 
$baseAuthUrl :
+

+ + +

Type

+ +
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(boolean  $getWSDL = false, boolean  $debug = false, array  $params = null)
+

Initializes a new instance of the ET_Client class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
boolean$getWSDL

Flag to indicate whether to load WSDL from source. +If true, WSDL is load from the source and saved in to path set in xmlLoc variable. +If false, WSDL stored in the path set in xmlLoc is loaded.

boolean$debug

Flag to indicate whether debug information needs to be logged. +Logging is enabled when the value is set to true and disabled when set to false.

array$params

Array of settings as string.
+Following are the possible settings.
+defaultwsdl - WSDL location/path
+clientid - Client Identifier optained from App Center
+clientsecred - Client secret associated with clientid
+appsignature - Application signature optained from App Center
+baseUrl - ExactTarget SOAP API Url
+baseAuthUrl - ExactTarget authentication rest api resource url
+If your application behind a proxy server, use the following setting
+proxyhost - proxy server host name or ip address
+proxyport - proxy server prot number
+proxyusername - proxy server user name
+proxypassword - proxy server password

+ + + +
+
+ +
+ +
+
+ +
+

refreshToken()

+ + 
refreshToken(boolean  $forceRefresh = false) : void
+

Gets the refresh token using the authentication URL.

+ + +

Parameters

+ + + + + + +
boolean$forceRefresh

Flag to indicate a force refresh of authentication toekn.

+ + + +
+
+ +
+ +
+
+ +
+

__getLastResponseHTTPCode()

+ + 
__getLastResponseHTTPCode() : \FuelSdk\lastHTTPCode
+

Returns the HTTP code return by the last SOAP/Rest call

+ + + + +

Returns

+ \FuelSdk\lastHTTPCode + +
+
+ +
+ +
+
+ +
+

CreateWSDL()

+ + 
CreateWSDL(  $wsdlLoc) : void
+

Create the WSDL file at specified location.

+ + +

Parameters

+ + + + + + +
$wsdlLoc
+ + + +
+
+ +
+ +
+
+ +
+

GetLastModifiedDate()

+ + 
GetLastModifiedDate(\FuelSdk\[type]  $remotepath) : string
+

Returns last modified date of the URL

+ + +

Parameters

+ + + + + + +
\FuelSdk\[type]$remotepath
+ + +

Returns

+ string + —

Last modified date

+ +
+
+ +
+ +
+
+ +
+

__doRequest()

+ + 
__doRequest(string  $request, string  $location, string  $saction, string  $version, integer  $one_way) : string
+

Perfoms an soap request.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
string$request

Soap request xml

string$location

Url as string

string$saction

Soap action name

string$version

Future use

integer$one_way

Future use

+ + +

Returns

+ string + —

Soap web service request result

+ +
+
+ +
+ +
+
+ +
+

addOAuth()

+ + 
addOAuth(string  $doc, string  $token) : void
+

Add OAuth token to the header of the soap request

+ + +

Parameters

+ + + + + + + + + + + +
string$doc

Soap request as xml string

string$token

OAuth token

+ + + +
+
+ +
+ +
+
+ +
+

getAuthToken()

+ + 
getAuthToken(  $tenantKey = null) : string
+

Get the authentication token.

+ + +

Parameters

+ + + + + + +
$tenantKey
+ + +

Returns

+ string + +
+
+ +
+ +
+
+ +
+

setAuthToken()

+ + 
setAuthToken(string  $tenantKey, string  $authToken, string  $authTokenExpiration)
+

Set the authentication token in the tenantTokens array.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$tenantKey

Tenant key for which auth toke to be set

string$authToken

Authentication token to be set

string$authTokenExpiration

Authentication token expiration value

+ + + +
+
+ +
+ +
+
+ +
+

getAuthTokenExpiration()

+ + 
getAuthTokenExpiration(string  $tenantKey) : string
+

Get the Auth Token Expiration.

+ + +

Parameters

+ + + + + + +
string$tenantKey

Tenant key for which authenication token is returned

+ + +

Returns

+ string + —

Authenticaiton token for the tenant key

+ +
+
+ +
+ +
+
+ +
+

getInternalAuthToken()

+ + 
getInternalAuthToken(string  $tenantKey) : string
+

Get the internal authentication token.

+ + +

Parameters

+ + + + + + +
string$tenantKey
+ + +

Returns

+ string + —

Internal authenication token

+ +
+
+ +
+ +
+
+ +
+

setInternalAuthToken()

+ + 
setInternalAuthToken(string  $tenantKey, string  $internalAuthToken)
+

Set the internal auth tokan.

+ + +

Parameters

+ + + + + + + + + + + +
string$tenantKey
string$internalAuthToken
+ + + +
+
+ +
+ +
+
+ +
+

setRefreshToken()

+ + 
setRefreshToken(string  $tenantKey, string  $refreshToken)
+

Set the refresh authentication token.

+ + +

Parameters

+ + + + + + + + + + + +
string$tenantKey

Tenant key to which refresh token is set

string$refreshToken

Refresh authenication token

+ + + +
+
+ +
+ +
+
+ +
+

getRefreshToken()

+ + 
getRefreshToken(string  $tenantKey) : string
+

Get the refresh token for the tenant.

+ + +

Parameters

+ + + + + + +
string$tenantKey
+ + +

Returns

+ string + —

Refresh token for the tenant

+ +
+
+ +
+ +
+
+ +
+

AddSubscriberToList()

+ + 
AddSubscriberToList(string  $emailAddress, array  $listIDs, string  $subscriberKey = null) : mixed
+

Add subscriber to list.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$emailAddress

Email address of the subscriber

array$listIDs

Array of list id to which the subscriber is added

string$subscriberKey

Newly added subscriber key

+ + +

Returns

+ mixed + —

post or patch response object. If the subscriber already existing patch response is returned otherwise post response returned.

+ +
+
+ +
+ +
+
+ +
+

AddSubscribersToLists()

+ + 
AddSubscribersToLists(  $subs,   $listIDs)
+

+ + +

Parameters

+ + + + + + + + + + + +
$subs
$listIDs
+ + + +
+
+ +
+ +
+
+ +
+

CreateDataExtensions()

+ + 
CreateDataExtensions(array  $dataExtensionDefinitions) : mixed
+

Create a new data extension based on the definition passed

+ + +

Parameters

+ + + + + + +
array$dataExtensionDefinitions

Data extension definition properties as an array

+ + +

Returns

+ mixed + —

post response object

+ +
+
+ +
+ +
+
+ +
+

SendTriggeredSends()

+ + 
SendTriggeredSends(array  $arrayOfTriggeredRecords) : mixed
+

Starts an send operation for the TriggerredSend records

+ + +

Parameters

+ + + + + + +
array$arrayOfTriggeredRecords

Array of TriggeredSend records

+ + +

Returns

+ mixed + —

Send reponse object

+ +
+
+ +
+ +
+
+ +
+

SendEmailToList()

+ + 
SendEmailToList(string  $emailID, string  $listID, string  $sendClassficationCustomerKey) : mixed
+

Create an email send definition, send the email based on the definition and delete the definition.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$emailID

Email identifier for which the email is sent

string$listID

Send definition list identifier

string$sendClassficationCustomerKey

Send classification customer key

+ + +

Returns

+ mixed + —

Final delete action result

+ +
+
+ +
+ +
+
+ +
+

SendEmailToDataExtension()

+ + 
SendEmailToDataExtension(string  $emailID, string  $sendableDataExtensionCustomerKey, string  $sendClassficationCustomerKey) : mixed
+

Create an email send definition, send the email based on the definition and delete the definition.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$emailID

Email identifier for which the email is sent

string$sendableDataExtensionCustomerKey

Sendable data extension customer key

string$sendClassficationCustomerKey

Send classification customer key

+ + +

Returns

+ mixed + —

Final delete action result

+ +
+
+ +
+ +
+
+ +
+

CreateAndStartListImport()

+ + 
CreateAndStartListImport(string  $listId, string  $fileName) : mixed
+

Create an import definition and start the import process

+ + +

Parameters

+ + + + + + + + + + + +
string$listId

List identifier. Used as the destination object identifier.

string$fileName

Name of the file to be imported

+ + +

Returns

+ mixed + —

Returns the import process result

+ +
+
+ +
+ +
+
+ +
+

CreateAndStartDataExtensionImport()

+ + 
CreateAndStartDataExtensionImport(string  $dataExtensionCustomerKey, string  $fileName, boolean  $overwrite) : mixed
+

Create an import definition and start the import process

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$dataExtensionCustomerKey

Data extension customer key. Used as the destination object identifier.

string$fileName

Name of the file to be imported

boolean$overwrite

Flag to indicate to overwrite the uploaded file

+ + +

Returns

+ mixed + —

Returns the import process result

+ +
+
+ +
+ +
+
+ +
+

CreateProfileAttributes()

+ + 
CreateProfileAttributes(array  $allAttributes) : mixed
+

Create a profile attribute

+ + +

Parameters

+ + + + + + +
array$allAttributes

Profile attribute properties as an array.

+ + +

Returns

+ mixed + —

Post operation result

+ +
+
+ +
+ +
+
+ +
+

CreateContentAreas()

+ + 
CreateContentAreas(array  $arrayOfContentAreas) : void
+

Create one or more content areas

+ + +

Parameters

+ + + + + + +
array$arrayOfContentAreas

Content areas properties as an array

+ + + +
+
+ +
+ +
+
+ +
+

CreateTenant()

+ + 
CreateTenant(array  $tenantInfo)
+

+ + +

Parameters

+ + + + + + +
array$tenantInfo

Dictionary type array which may hold e.g. array('key' => '')

+ + + +
+
+ +
+ +
+
+ +
+

GetTenants()

+ + 
GetTenants() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_OpenEvent.html b/docs/classes/FuelSdk.ET_OpenEvent.html new file mode 100644 index 0000000..3ee8cbc --- /dev/null +++ b/docs/classes/FuelSdk.ET_OpenEvent.html @@ -0,0 +1,733 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_OpenEvent

+

Contains information about the opening of a message send by a subscriber.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $getSinceLastBatch
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$getSinceLastBatch

+ 
$getSinceLastBatch : boolean
+

+ + +

Type

+ boolean + — Gets or sets a boolean value indicating whether this object get since last batch. true if get since last batch; otherwise, false.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Organization.html b/docs/classes/FuelSdk.ET_Organization.html new file mode 100644 index 0000000..9584ae4 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Organization.html @@ -0,0 +1,806 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Organization

+

This class represents an Account.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Patch.html b/docs/classes/FuelSdk.ET_Patch.html new file mode 100644 index 0000000..046ded7 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Patch.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Patch

+

This class represents the PATCH operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, array  $props, boolean  $upsert = false)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

boolean$upsert

If true SaveAction is UpdateAdd, otherwise not. By default false.

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_PatchRest.html b/docs/classes/FuelSdk.ET_PatchRest.html new file mode 100644 index 0000000..7e3f1cb --- /dev/null +++ b/docs/classes/FuelSdk.ET_PatchRest.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_PatchRest

+

This class represents the PATCH operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $url, array  $props,   $qs = "")
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$url

The endpoint URL

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

$qs
+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Perform.html b/docs/classes/FuelSdk.ET_Perform.html new file mode 100644 index 0000000..e94465c --- /dev/null +++ b/docs/classes/FuelSdk.ET_Perform.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Perform

+

This class represents the PERFORM operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, string  $action, array  $props)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

string$action

Action names e.g. "create", "delete", "update", etc

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_PerformExtract.html b/docs/classes/FuelSdk.ET_PerformExtract.html new file mode 100644 index 0000000..a3b9780 --- /dev/null +++ b/docs/classes/FuelSdk.ET_PerformExtract.html @@ -0,0 +1,597 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_PerformExtract

+

This class represents the PERFORM operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, array  $props)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

array$props

Dictionary type array of properties which may hold e.g. array('ID' => '', 'Parameters' => '')

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Post.html b/docs/classes/FuelSdk.ET_Post.html new file mode 100644 index 0000000..b9ab3eb --- /dev/null +++ b/docs/classes/FuelSdk.ET_Post.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Post

+

This class represents the POST operation for SOAP service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $objType, array  $props, boolean  $upsert = false)
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$objType

Object name, e.g. "ImportDefinition", "DataExtension", etc

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

boolean$upsert

If true SaveAction is UpdateAdd, otherwise not. By default false.

+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_PostRest.html b/docs/classes/FuelSdk.ET_PostRest.html new file mode 100644 index 0000000..9f3dbbc --- /dev/null +++ b/docs/classes/FuelSdk.ET_PostRest.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_PostRest

+

This class represents the POST operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $url, array  $props,   $qs = "")
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$url

The endpoint URL

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

$qs
+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_ProfileAttribute.html b/docs/classes/FuelSdk.ET_ProfileAttribute.html new file mode 100644 index 0000000..0af4e5e --- /dev/null +++ b/docs/classes/FuelSdk.ET_ProfileAttribute.html @@ -0,0 +1,730 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_ProfileAttribute

+

This class defines any additional attribute for a subscriber.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ post()
+ get()
+ patch()
+ delete()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Configure
+

This method is used to create Property Definition for a subscriber

+ + + + +

Returns

+ \FuelSdk\ET_Configure + —

Object of type ET_Configure which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Info
+

This method is used to get Property Definition for a subscriber

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

Object of type ET_Info which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Configure
+

This method is used to update Property Definition for a subscriber

+ + + + +

Returns

+ \FuelSdk\ET_Configure + —

Object of type ET_Configure which contains http status code, response, etc from the UPDATE SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Configure
+

This method is used to delete Property Definition for a subscriber

+ + + + +

Returns

+ \FuelSdk\ET_Configure + —

Object of type ET_Configure which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_PutRest.html b/docs/classes/FuelSdk.ET_PutRest.html new file mode 100644 index 0000000..1d0f35c --- /dev/null +++ b/docs/classes/FuelSdk.ET_PutRest.html @@ -0,0 +1,607 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_PutRest

+

This class represents the PUT operation for REST service.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+
+
+ $status
+ $code
+ $message
+ $results
+ $request_id
+ $moreResults
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$status

+ 
$status : boolean
+

+ + +

Type

+ boolean + — holds the status of the web service operation: true=success, false=failure
+
+ +
+ +
+
+ +
+

$code

+ 
$code : integer
+

+ + +

Type

+ integer + — holds the HTTP status code e.g. 200, 404, etc
+
+ +
+ +
+
+ +
+

$message

+ 
$message : string
+

+ + +

Type

+ string + — holds error message for SOAP call, else holds raw response if json_decode fails
+
+ +
+ +
+
+ +
+

$results

+ 
$results : \FuelSdk\stdClass
+

+ + +

Type

+ \FuelSdk\stdClass + — Object contains the complete result of the web service operation
+
+ +
+ +
+
+ +
+

$request_id

+ 
$request_id : string
+

+ + +

Type

+ string + — the request identifier
+
+ +
+ +
+
+ +
+

$moreResults

+ 
$moreResults : boolean
+

+ + +

Type

+ boolean + — whether more results are available or not
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\FuelSdk\ET_Client  $authStub, string  $url, array  $props,   $qs = "")
+

Initializes a new instance of the class.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

string$url

The endpoint URL

array$props

Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

$qs
+ + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_ResultMessage.html b/docs/classes/FuelSdk.ET_ResultMessage.html new file mode 100644 index 0000000..581b768 --- /dev/null +++ b/docs/classes/FuelSdk.ET_ResultMessage.html @@ -0,0 +1,708 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_ResultMessage

+

Contains information regarding a specific unsubscription action taken by a subscriber.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_SMSKeyword.html b/docs/classes/FuelSdk.ET_SMSKeyword.html new file mode 100644 index 0000000..c9a4741 --- /dev/null +++ b/docs/classes/FuelSdk.ET_SMSKeyword.html @@ -0,0 +1,856 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_SMSKeyword

+

Represents a program in an account

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ __construct()
+
+
+ $authStub
+ $props
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $folderProperty
+ $folderMediaType
+ $lastPageNumber
+ $endpoint
+ $urlProps
+ $urlPropsRequired
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$folderProperty

+ 
$folderProperty : string
+

+ + +

Type

+ string + — Folder property e.g. "Category", "CategoryID", etc.
+
+ +
+ +
+
+ +
+

$folderMediaType

+ 
$folderMediaType : string
+

+ + +

Type

+ string + — Folder Media Type e.g. "dataextension", "triggered_send", etc.
+
+ +
+ +
+
+ +
+

$lastPageNumber

+ 
$lastPageNumber : integer
+

+ + +

Type

+ integer + — The last page number
+
+ +
+ +
+
+ +
+

$endpoint

+ 
$endpoint : string
+

+ + +

Type

+ string + — URL of the API endpoint
+
+ +
+ +
+
+ +
+

$urlProps

+ 
$urlProps : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having properties or fields name found in the endpoint URL
+
+ +
+ +
+
+ +
+

$urlPropsRequired

+ 
$urlPropsRequired : array<mixed,string>
+

+ + +

Type

+ array<mixed,string> + — array of string having only required fields
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_PostRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PostRest + —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_PatchRest
+

+ + + + +

Returns

+ \FuelSdk\ET_PatchRest + —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_DeleteRest
+

+ + + + +

Returns

+ \FuelSdk\ET_DeleteRest + —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_GetRest
+

+ + + + +

Returns

+ \FuelSdk\ET_GetRest + —

returns more response from the GET REST service of type ET_GetRest Object

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and will assign endpoint, urlProps, urlPropsRequired fields of parent ET_BaseObjectRest

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Send.html b/docs/classes/FuelSdk.ET_Send.html new file mode 100644 index 0000000..90afb35 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Send.html @@ -0,0 +1,806 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Send

+

Used to send email and retrieve aggregate data based on a JobID.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_SentEvent.html b/docs/classes/FuelSdk.ET_SentEvent.html new file mode 100644 index 0000000..b19b71c --- /dev/null +++ b/docs/classes/FuelSdk.ET_SentEvent.html @@ -0,0 +1,733 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_SentEvent

+

Contains tracking data related to a send, including information on individual subscribers.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $getSinceLastBatch
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$getSinceLastBatch

+ 
$getSinceLastBatch : boolean
+

+ + +

Type

+ boolean + — Gets or sets a boolean value indicating whether this object get since last batch. true if get since last batch; otherwise, false.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Subscriber.html b/docs/classes/FuelSdk.ET_Subscriber.html new file mode 100644 index 0000000..b329042 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Subscriber.html @@ -0,0 +1,840 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Subscriber

+

A person subscribed to receive email or SMS communication.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ put()
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

put()

+ + 
put() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_TriggeredSend.html b/docs/classes/FuelSdk.ET_TriggeredSend.html new file mode 100644 index 0000000..baa9ef2 --- /dev/null +++ b/docs/classes/FuelSdk.ET_TriggeredSend.html @@ -0,0 +1,886 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_TriggeredSend

+

Defines a triggered send in the account.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+ Send()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $subscribers
+ $folderId
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$subscribers

+ 
$subscribers : array
+

+ + +

Type

+ array + — Gets or sets the subscribers. e.g. array("EmailAddress" => "", "SubscriberKey" => "")
+
+ +
+ +
+
+ +
+

$folderId

+ 
$folderId : integer
+

+ + +

Type

+ integer + — Gets or sets the folder identifier.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ +
+

Send()

+ + 
Send() : \FuelSdk\ET_Post
+

Send this instance.

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_TriggeredSendSummary.html b/docs/classes/FuelSdk.ET_TriggeredSendSummary.html new file mode 100644 index 0000000..0dff0df --- /dev/null +++ b/docs/classes/FuelSdk.ET_TriggeredSendSummary.html @@ -0,0 +1,708 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_TriggeredSendSummary

+

Defines a triggered send in the account.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_UnsubEvent.html b/docs/classes/FuelSdk.ET_UnsubEvent.html new file mode 100644 index 0000000..36b9fdd --- /dev/null +++ b/docs/classes/FuelSdk.ET_UnsubEvent.html @@ -0,0 +1,733 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_UnsubEvent

+

Contains information regarding a specific unsubscription action taken by a subscriber.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+ $getSinceLastBatch
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$getSinceLastBatch

+ 
$getSinceLastBatch : boolean
+

+ + +

Type

+ boolean + — Gets or sets a boolean value indicating whether this object get since last batch. true if get since last batch; otherwise, false.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and set the since last batch to true.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_User.html b/docs/classes/FuelSdk.ET_User.html new file mode 100644 index 0000000..d4a7bb2 --- /dev/null +++ b/docs/classes/FuelSdk.ET_User.html @@ -0,0 +1,806 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_User

+

This class represents an Account User.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ post()
+ patch()
+ delete()
+ get()
+ getMoreResults()
+ info()
+ __construct()
+
+
+ $authStub
+ $props
+ $filter
+ $organizationId
+ $organizationKey
+
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $obj
+ $lastRequestID
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$authStub

+ 
$authStub : \FuelSdk\ET_Client
+

+ + +

Type

+ \FuelSdk\ET_Client + — The ET client object which performs the auth token, refresh token using clientID clientSecret
+
+ +
+ +
+
+ +
+

$props

+ 
$props : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')
+
+ +
+ +
+
+ +
+

$filter

+ 
$filter : array
+

+ + +

Type

+ array + — Dictionary type array which may hold e.g. array("Property"=>"", "SimpleOperator"=>"","Value"=>"")
+
+ +
+ +
+
+ +
+

$organizationId

+ 
$organizationId : string
+

+ + +

Type

+ string + — Organization Identifier.
+
+ +
+ +
+
+ +
+

$organizationKey

+ 
$organizationKey : string
+

+ + +

Type

+ string + — Organization Key.
+
+ +
+ +
+
+ +
+

$obj

+ 
$obj : string
+

+ + +

Type

+ string + — Object name, e.g. "ImportDefinition", "DataExtension", etc
+
+ +
+ +
+
+ +
+

$lastRequestID

+ 
$lastRequestID : string
+

+ + +

Type

+ string + — last Request identifier.
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

post()

+ + 
post() : \FuelSdk\ET_Post
+

+ + + + +

Returns

+ \FuelSdk\ET_Post + —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP service

+ +
+
+ +
+ +
+
+ +
+

patch()

+ + 
patch() : \FuelSdk\ET_Patch
+

+ + + + +

Returns

+ \FuelSdk\ET_Patch + —

Object of type ET_Patch which contains http status code, response, etc from the PATCH SOAP service

+ +
+
+ +
+ +
+
+ +
+

delete()

+ + 
delete() : \FuelSdk\ET_Delete
+

+ + + + +

Returns

+ \FuelSdk\ET_Delete + —

Object of type ET_Delete which contains http status code, response, etc from the DELETE SOAP service

+ +
+
+ +
+ +
+
+ +
+

get()

+ + 
get() : \FuelSdk\ET_Get
+

+ + + + +

Returns

+ \FuelSdk\ET_Get + —

Object of type ET_Get which contains http status code, response, etc from the GET SOAP service

+ +
+
+ +
+ +
+
+ +
+

getMoreResults()

+ + 
getMoreResults() : \FuelSdk\ET_Continue
+

+ + + + +

Returns

+ \FuelSdk\ET_Continue + —

returns more response from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

info()

+ + 
info() : \FuelSdk\ET_Info
+

+ + + + +

Returns

+ \FuelSdk\ET_Info + —

returns information from the SOAP service

+ +
+
+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Initializes a new instance of the class and sets the obj property of parent.

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/classes/FuelSdk.ET_Util.html b/docs/classes/FuelSdk.ET_Util.html new file mode 100644 index 0000000..aa35077 --- /dev/null +++ b/docs/classes/FuelSdk.ET_Util.html @@ -0,0 +1,722 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ +
+
+
+ + FuelSdk +
+
+
+ + + +
+
+
+
+ + +
    +
+
+
+
+
+ +
+
+
+
+
+
+ + + +

\FuelSdkET_Util

+

This utility class performs all the REST operation over CURL.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ restGet()
+ restPost()
+ restPatch()
+ restPut()
+ restDelete()
+ isAssoc()
+ getSDKVersion()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + + +
+

Methods

+ +
+ +
+
+ +
+

restGet()

+ + 
restGet(string  $url, \FuelSdk\ET_Client  $authStub,   $isAuthConnection = "") : string
+

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$url

The resource URL for the REST API

\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

$isAuthConnection
+ + +

Returns

+ string + —

The response payload from the REST service

+ +
+
+ +
+ +
+
+ +
+

restPost()

+ + 
restPost(string  $url, string  $content, \FuelSdk\ET_Client  $authStub,   $isAuthConnection = "") : string
+

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
string$url

The resource URL for the REST API

string$content

A string of JSON which will be passed to the REST API

\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

$isAuthConnection
+ + +

Returns

+ string + —

The response payload from the REST service

+ +
+
+ +
+ +
+
+ +
+

restPatch()

+ + 
restPatch(string  $url, string  $content, \FuelSdk\ET_Client  $authStub,   $isAuthConnection = "") : string
+

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
string$url

The resource URL for the REST API

string$content

A string of JSON which will be passed to the REST API

\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

$isAuthConnection
+ + +

Returns

+ string + —

The response payload from the REST service

+ +
+
+ +
+ +
+
+ +
+

restPut()

+ + 
restPut(string  $url, string  $content, \FuelSdk\ET_Client  $authStub,   $isAuthConnection = "") : string
+

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
string$url

The resource URL for the REST API

string$content

A string of JSON which will be passed to the REST API

\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

$isAuthConnection
+ + +

Returns

+ string + —

The response payload from the REST service

+ +
+
+ +
+ +
+
+ +
+

restDelete()

+ + 
restDelete(string  $url, \FuelSdk\ET_Client  $authStub,   $isAuthConnection = "") : string
+

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
string$url

The resource URL for the REST API

\FuelSdk\ET_Client$authStub

The ET client object which performs the auth token, refresh token using clientID clientSecret

$isAuthConnection
+ + +

Returns

+ string + —

The response payload from the REST service

+ +
+
+ +
+ +
+
+ +
+

isAssoc()

+ + 
isAssoc(array  $array) : boolean
+

+ + +

Parameters

+ + + + + + +
array$array

The array

+ + +

Returns

+ boolean + —

Returns true if the parameter array is dictionary type array, false otherwise.

+ +
+
+ +
+ +
+
+ +
+

getSDKVersion()

+ + 
getSDKVersion() : string
+

This method will not change until a major release.

+ + + + +

Returns

+ string + +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/files/ET_Asset.html b/docs/files/ET_Asset.html index 7113769..fafd432 100644 --- a/docs/files/ET_Asset.html +++ b/docs/files/ET_Asset.html @@ -87,6 +87,14 @@