mcdev 4.3.4 → 5.0.1

package/lib/metadataTypes/definitions/Asset.definition.js

@@ -5,6 +5,7 @@ module.exports = {
     folderType: 'asset',
     hasExtended: false,
     idField: 'id',
+    keyIsFixed: false,
     keyField: 'customerKey',
     nameField: 'name',
     createdDateField: 'createdDate',

package/lib/metadataTypes/definitions/AttributeGroup.definition.js

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: [], // future may have dependency on Data Extensions
     hasExtended: false,
     idField: 'definitionID',
+    keyIsFixed: null,
     keyField: 'definitionKey',
     nameField: 'definitionName.value',
     restPagination: false,

package/lib/metadataTypes/definitions/Automation.definition.js

@@ -2,7 +2,7 @@ module.exports = {
     activityTypeMapping: {
         dataExtract: 73,
         dataFactoryUtility: 425,
-        emailSendDefinition: 42,
+        emailSend: 42,
         fileTransfer: 53,
         filter: 303,
         fireEvent: 749,
@@ -25,7 +25,7 @@ module.exports = {
     bodyIteratorField: 'items',
     dependencies: [
         'dataExtract',
-        'emailSendDefinition',
+        'emailSend',
         'fileTransfer',
         'folder-automations',
         'importFile',
@@ -38,6 +38,7 @@ module.exports = {
         description: ['Event Definition Automation'],
     },
     idField: 'id',
+    keyIsFixed: false,
     keyField: 'key',
     nameField: 'name',
     folderIdField: 'categoryId',

package/lib/metadataTypes/definitions/Campaign.definition.js

@@ -1,23 +1,65 @@
 module.exports = {
-    bodyIteratorField: 'items',
+    bodyIteratorField: 'entry',
     dependencies: [],
     hasExtended: false,
     idField: 'id',
+    keepId: true,
+    keyIsFixed: null,
     keyField: 'name',
     nameField: 'name',
+    createdDateField: 'createdDate',
+    createdNameField: null,
+    lastmodDateField: 'lastUpdated',
+    lastmodNameField: null,
     restPagination: true,
+    restPageSize: 50,
     type: 'campaign',
     typeDescription: 'Way of tagging/categorizing emails, journeys and alike.',
     typeRetrieveByDefault: false,
     typeName: 'Campaign Tag',
     fields: {
+        id: {
+            // alphanumeric string
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        campaignId: {
+            // numeric
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            templating: false,
+        },
+        type: {
+            // always set to "Campaign"
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            templating: false,
+        },
         createdDate: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
             templating: false,
         },
-        modifiedDate: {
+        createdBy: {
+            // returns https://mc....rest.marketingcloudapis.com/legacy/v1/beta/organization/user/Nzc1MTU2ODo0OjA
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            templating: false,
+        },
+        ownerId: {
+            // returns https://mc....rest.marketingcloudapis.com/legacy/v1/beta/organization/user/Nzc1MTU2ODo0OjA
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            templating: false,
+        },
+        lastUpdated: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
@@ -35,19 +77,52 @@ module.exports = {
             retrieving: true,
             templating: false,
         },
+        externalKey: {
+            // can be empty - should use "name" instead as key
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
         campaignCode: {
+            // always empty string; real value is in field "externalKey"
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            templating: false,
+        },
+        'display.name': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        'display.value': {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
             templating: false,
         },
-        color: {
+        isFavorite: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
             templating: false,
         },
-        favorite: {
+        campaignOwnerName: {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: true,
+            templating: false,
+        },
+        campaignOwner: {
+            // value like "MDo0OjE"
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            templating: false,
+        },
+        campaignStatus: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,

package/lib/metadataTypes/definitions/ContentArea.definition.js

@@ -4,6 +4,7 @@ module.exports = {
     hasExtended: false,
     idField: 'ID',
     keepId: true,
+    keyIsFixed: null,
     keyField: 'CustomerKey',
     nameField: 'Name',
     folderIdField: 'CategoryID',

package/lib/metadataTypes/definitions/DataExtension.definition.js

@@ -87,6 +87,7 @@ module.exports = {
     },
     hasExtended: false,
     idField: 'ObjectID',
+    keyIsFixed: false,
     keyField: 'CustomerKey',
     nameField: 'Name',
     folderIdField: 'CategoryID',
@@ -192,7 +193,7 @@ module.exports = {
         },
         ObjectID: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
             template: false,
         },

package/lib/metadataTypes/definitions/DataExtensionField.definition.js

@@ -4,6 +4,7 @@ module.exports = {
     filter: {},
     hasExtended: false,
     idField: 'ObjectID',
+    keyIsFixed: true, // renamed via name_new on dataExtension update
     keyField: 'CustomerKey',
     nameField: 'Name',
     restPagination: false,

package/lib/metadataTypes/definitions/DataExtensionTemplate.definition.js

@@ -4,6 +4,7 @@ module.exports = {
     filter: {},
     hasExtended: false,
     idField: 'ObjectID',
+    keyIsFixed: null,
     keyField: 'CustomerKey',
     nameField: 'Name',
     restPagination: false,

package/lib/metadataTypes/definitions/DataExtract.definition.js

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: ['dataExtension', 'dataExtractType'],
     hasExtended: true,
     idField: 'dataExtractDefinitionId',
+    keyIsFixed: false,
     keyField: 'key',
     createdDateField: 'createdDate',
     createdNameField: 'createdBy',

package/lib/metadataTypes/definitions/DataExtractType.definition.js

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: [],
     hasExtended: false,
     idField: 'extractId',
+    keyIsFixed: null,
     keyField: 'name',
     nameField: 'name',
     restPagination: false,

package/lib/metadataTypes/definitions/Discovery.definition.js

@@ -26,6 +26,7 @@ module.exports = {
     },
     hasExtended: false,
     idField: '',
+    keyIsFixed: null,
     keyField: 'key',
     nameField: 'name',
     restPagination: false,

package/lib/metadataTypes/definitions/Email.definition.js

@@ -4,6 +4,7 @@ module.exports = {
     hasExtended: false,
     idField: 'ID',
     keepId: true,
+    keyIsFixed: null,
     keyField: 'CustomerKey',
     nameField: 'Name',
     folderIdField: 'CategoryID',

package/lib/metadataTypes/definitions/{EmailSendDefinition.definition.js → EmailSend.definition.js}

@@ -5,6 +5,7 @@ module.exports = {
     hasExtended: false,
     idField: 'ObjectID',
     keepId: true,
+    keyIsFixed: false,
     keyField: 'CustomerKey',
     nameField: 'Name',
     folderIdField: 'CategoryID',
@@ -13,7 +14,8 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
-    type: 'emailSendDefinition',
+    type: 'emailSend',
+    soapType: 'emailSendDefinition',
     typeDescription: 'Mainly used in Automations as "Send Email Activity".',
     typeRetrieveByDefault: true,
     typeName: 'E-Mail Send Definition',
@@ -326,7 +328,7 @@ module.exports = {
         },
         ObjectID: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: false,
             templating: false,
         },

package/lib/metadataTypes/definitions/{EventDefinition.definition.js → Event.definition.js}

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: ['dataExtension'],
     hasExtended: false,
     idField: 'id',
+    keyIsFixed: false,
     keyField: 'eventDefinitionKey',
     nameField: 'name',
     createdDateField: 'createdDate',
@@ -10,7 +11,7 @@ module.exports = {
     lastmodDateField: 'modifiedDate',
     lastmodNameField: 'modifiedBy',
     restPagination: true,
-    type: 'eventDefinition',
+    type: 'event',
     typeDescription: 'Used in Journeys (Interactions) to define Entry Events.',
     typeRetrieveByDefault: true,
     typeName: 'Journey: Entry Event Definition',

package/lib/metadataTypes/definitions/{FtpLocation.definition.js → FileLocation.definition.js}

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: [],
     hasExtended: false,
     idField: 'id',
+    keyIsFixed: null,
     keyField: 'name',
     nameField: 'name',
     createdDateField: null,
@@ -10,11 +11,11 @@ module.exports = {
     lastmodDateField: null,
     lastmodNameField: null,
     restPagination: false,
-    type: 'ftpLocation',
+    type: 'fileLocation',
     typeDescription:
-        'A File Location which can be used for export or import of files to/from Marketing Cloud.',
+        'Used for export or import of files to/from Marketing Cloud. Previously this was labeled ftpLocation.',
     typeRetrieveByDefault: true,
-    typeName: 'FTP Location',
+    typeName: 'File Location',
     fields: {
         id: {
             isCreateable: false,

package/lib/metadataTypes/definitions/FileTransfer.definition.js

@@ -1,8 +1,9 @@
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['ftpLocation'],
+    dependencies: ['fileLocation'],
     hasExtended: true,
     idField: 'id',
+    keyIsFixed: false,
     keyField: 'customerKey',
     nameField: 'name',
     createdDateField: 'createdDate',
@@ -118,6 +119,6 @@ module.exports = {
             retrieving: true,
             template: true,
         },
-        r__ftpLocation_name: { skipValidation: true },
+        r__fileLocation_name: { skipValidation: true },
     },
 };

package/lib/metadataTypes/definitions/Filter.definition.js

@@ -3,6 +3,7 @@ module.exports = {
     dependencies: [],
     hasExtended: false,
     idField: 'id',
+    keyIsFixed: null,
     keyField: 'customerKey',
     nameField: 'name',
     createdDateField: 'createdDate',

package/lib/metadataTypes/definitions/Folder.definition.js

@@ -72,10 +72,12 @@ module.exports = {
     hasExtended: false,
     idField: 'ID',
     keepId: true,
+    keyIsFixed: true,
     keyField: 'CustomerKey',
     nameField: 'Name',
     restPagination: false,
     type: 'folder',
+    soapType: 'DataFolder',
     typeDescription: 'Used to structure all kinds of other metadata.',
     typeRetrieveByDefault: false,
     typeName: 'Folder',

package/lib/metadataTypes/definitions/ImportFile.definition.js

@@ -1,6 +1,6 @@
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['ftpLocation', 'dataExtension', 'list'],
+    dependencies: ['fileLocation', 'dataExtension', 'list'],
     destinationObjectTypeMapping: {
         unknown: 783,
         DataExtension: 310,
@@ -10,13 +10,14 @@ module.exports = {
     },
     hasExtended: false,
     idField: 'importDefinitionId',
+    keyIsFixed: false,
     keyField: 'customerKey',
     nameField: 'name',
     createdDateField: 'createdDate',
     createdNameField: null,
     lastmodDateField: 'modifiedDate',
     lastmodNameField: null,
-    restPagination: false,
+    restPagination: true,
     subscriberImportTypeMapping: {
         DataExtension: 255,
         Email: 0,
@@ -224,7 +225,7 @@ module.exports = {
         r__dataExtension_CustomerKey: { skipValidation: true },
         c__destinationType: { skipValidation: true },
         r__list_PathName: { skipValidation: true },
-        r__ftpLocation_name: { skipValidation: true },
+        r__fileLocation_name: { skipValidation: true },
         c__subscriberImportType: { skipValidation: true },
     },
 };

package/lib/metadataTypes/definitions/{Interaction.definition.js → Journey.definition.js}

@@ -4,10 +4,19 @@
 // update: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/putUpdateInteraction.html
 module.exports = {
     bodyIteratorField: 'items',
-    dependencies: ['folder-journey', 'triggeredSendDefinition', 'eventDefinition'], // ! interaction and transactionalEmail both link to each other. caching transactionalEmail here "manually" instead of via dependencies array, assuming that it is quicker than the other way round
+    dependencies: [
+        'folder-journey',
+        'triggeredSend', // for EMAILV2-activity
+        'event', // for Multistep and Quicksend journeys
+        'mobileMessage', // for SMSSYNC-activity
+        'mobileCode', // for SMSSYNC-activity
+        'mobileKeyword', // for SMSSYNC-activity
+        'asset-asset', // for SMSSYNC-activity (sub-subtype jsonmessage)
+    ], // ! interaction and transactionalEmail both link to each other. caching transactionalEmail here "manually" instead of via dependencies array, assuming that it is quicker than the other way round
     folderIdField: 'categoryId',
     hasExtended: false,
     idField: 'id',
+    keyIsFixed: true,
     keyField: 'key',
     nameField: 'name',
     createdDateField: 'createdDate',
@@ -16,7 +25,7 @@ module.exports = {
     lastmodNameField: null,
     restPagination: true,
     restPageSize: 500,
-    type: 'interaction',
+    type: 'journey',
     typeDescription: 'Journey (internally called "Interaction").',
     typeRetrieveByDefault: true,
     typeName: 'Journey',

package/lib/metadataTypes/definitions/List.definition.js

@@ -4,6 +4,7 @@ module.exports = {
     folderType: 'list',
     hasExtended: false,
     idField: 'ObjectID',
+    keyIsFixed: null,
     keyField: 'CustomerKey',
     nameField: 'ListName',
     restPagination: null,

package/lib/metadataTypes/definitions/MobileCode.definition.js

@@ -3,13 +3,15 @@ module.exports = {
     dependencies: [],
     hasExtended: false,
     idField: 'id',
+    keyIsFixed: null,
     keyField: 'code',
     nameField: 'code',
     createdDateField: 'createdDate',
     createdNameField: null,
     lastmodDateField: 'lastUpdated',
     lastmodNameField: null,
-    restPagination: false, // page size is 50, which should be sufficient in most cases
+    restPagination: true,
+    restPageSize: 50,
     type: 'mobileCode',
     typeDescription: 'Used to send SMS Messages',
     typeRetrieveByDefault: true,

package/lib/metadataTypes/definitions/MobileKeyword.definition.js

@@ -2,28 +2,31 @@ module.exports = {
     bodyIteratorField: 'entry',
     dependencies: ['mobileCode'],
     hasExtended: false,
-    idField: 'decodedId',
+    idField: 'id',
+    keyIsFixed: false,
     keyField: 'keyword',
     nameField: 'keyword',
     createdDateField: 'createdDate',
     createdNameField: 'createdBy.name',
     lastmodDateField: 'lastUpdated',
     lastmodNameField: null,
-    restPagination: false, // page size is 50, which should be sufficient in most cases
+    restPagination: true,
+    restPageSize: 50,
     type: 'mobileKeyword',
     typeDescription: 'Used for managing subscriptions for Mobile numbers in Mobile Connect',
     typeRetrieveByDefault: true,
     typeName: 'Mobile Keyword',
     fields: {
         id: {
+            // irregular format: NXV4ZFMwTEFwRVczd3RaLUF5X3p5dzo4Njow
             isCreateable: false,
-            isUpdateable: false,
-            retrieving: false,
+            isUpdateable: true,
+            retrieving: true,
             template: false,
         },
         keyword: {
             isCreateable: true,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
             template: true,
         },
@@ -69,6 +72,12 @@ module.exports = {
             retrieving: true,
             template: false,
         },
+        'createdBy.lastUpdated': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
         dipSwitches: {
             isCreateable: false,
             isUpdateable: false,
@@ -77,21 +86,22 @@ module.exports = {
         },
         isInherited: {
             isCreateable: false,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: true,
-            template: false,
+            template: true,
         },
         decodedId: {
+            // GUID format (4b5dece6-c042-45a4-b7c2-d67e032ff3cb). unsure what this is used for
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         restriction: {
-            isCreateable: false,
-            isUpdateable: false,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: false,
+            template: true,
         },
         keywordType: {
             isCreateable: true,
@@ -117,21 +127,21 @@ module.exports = {
             retrieving: true,
             template: false,
         },
-        'code.code': {
+        messages: {
             isCreateable: false,
             isUpdateable: false,
             retrieving: true,
-            template: true,
+            template: false,
         },
-        messages: {
+        'code.code': {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: false,
-            template: false,
+            retrieving: true,
+            template: true,
         },
         'code.id': {
             isCreateable: true,
-            isUpdateable: false,
+            isUpdateable: true,
             retrieving: false,
             template: false,
         },