mcdev 5.0.2 → 5.2.0

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

@@ -1,238 +1,249 @@
 module.exports = {
     bodyIteratorField: 'attributeGroupDefinitions',
-    dependencies: [], // future may have dependency on Data Extensions
+    dependencies: ['attributeSet'], // future may have dependency on Data Extensions
     hasExtended: false,
     idField: 'definitionID',
     keyIsFixed: null,
     keyField: 'definitionKey',
     nameField: 'definitionName.value',
-    restPagination: false,
+    restPagination: false, // Hub API does not support pagination and returns everything instead
     type: 'attributeGroup',
     typeDescription: 'BETA: Groupings of Set Definitions (Data Extensions) in Data Designer.',
     typeRetrieveByDefault: false,
     typeName: 'Data Designer Attribute Groups',
     fields: {
         applicationID: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // used by system generated attribute groups only; contains UUID
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         applicationKey: {
-            isCreateable: null,
-            isUpdateable: null,
+            // used by system generated attribute groups only
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
-            template: null,
+            template: false,
         },
         attributeCount: {
-            isCreateable: null,
-            isUpdateable: null,
+            // auto-populated
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
-            template: null,
+            template: false,
         },
         attributeGroupIconKey: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         attributeGroupType: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         attributeSetIdentifiers: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'attributeSetIdentifiers[].connectingID.identifierType': {
             isCreateable: null,
             isUpdateable: null,
-            retrieving: false,
-            template: null,
+            retrieving: true,
+            template: false,
         },
         'attributeSetIdentifiers[].definitionID': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
-            template: null,
+            template: false,
         },
         'attributeSetIdentifiers[].definitionKey': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
-            template: null,
+            template: true,
         },
-        'attributeSetIdentifiers[].definitionName.Contact': {
+        'attributeSetIdentifiers[].definitionName.value': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
-            template: null,
+            template: false,
         },
         'attributeSetIdentifiers[].namespace': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: false,
-            template: null,
+            template: false,
         },
         canAddProperties: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         canAddRelationships: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         canChangeProperties: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         canModify: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         canRemove: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         connectingID: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: false,
-            template: null,
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
         },
         'connectingID.identifierType': {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: false,
-            template: null,
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
         },
         containsSchemaAttributes: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         definitionID: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: false,
         },
         definitionKey: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'definitionName.value': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         description: {
-            isCreateable: null,
-            isUpdateable: null,
+            // optional field. not returned by API if empty
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         displayOrder: {
-            isCreateable: null,
-            isUpdateable: null,
+            // auto-set to i+1
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
-            template: null,
+            template: false,
         },
         fullyQualifiedName: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // equal to defitionName.value; auto-populated by preDeployTasks
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         isHidden: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         isOwner: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         isPrimary: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // always false, purpose unknown
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         isSystemDefined: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: true,
-            template: null,
+            template: false,
         },
         localizedDescription: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // always an empty object
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         'localizedDescription.resourceSetKey': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.resourceValueKey': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.value': {
             isCreateable: null,
             isUpdateable: null,
             retrieving: true,
-            template: null,
+            template: true,
         },
         mID: {
-            isCreateable: null,
-            isUpdateable: null,
+            // auto-populated in preDeployTask
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         namespace: {
-            isCreateable: null,
-            isUpdateable: null,
+            // always an empty string
+            isCreateable: false,
+            isUpdateable: false,
             retrieving: false,
-            template: null,
+            template: false,
         },
         objectState: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // seems to always contain "Created"
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         requiredRelationships: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
     },
 };

package/lib/metadataTypes/definitions/{SetDefinition.definition.js → AttributeSet.definition.js}

@@ -1,17 +1,18 @@
 module.exports = {
     bodyIteratorField: 'setDefinition',
-    dependencies: [], // future may have dependency on Data Extensions
+    dependencies: ['folder-hidden', 'folder-dataextension', 'dataExtension'], // future may have dependency on Data Extensions
     hasExtended: false,
     idField: 'definitionID',
     keyIsFixed: null,
     keyField: 'definitionKey',
     nameField: 'name',
+    folderIdField: 'categoryID',
     createdDateField: 'createDate',
     createdNameField: 'createdBy',
     lastmodDateField: null,
     lastmodNameField: null,
-    restPagination: false,
-    type: 'setDefinition',
+    restPagination: false, // Hub API does not support pagination and returns everything instead
+    type: 'attributeSet',
     typeDescription: 'BETA: Data Extensions linked to Attribute Groups in Data Designer.',
     typeRetrieveByDefault: false,
     typeName: 'Data Designer Set Definitions',
@@ -65,10 +66,10 @@ module.exports = {
             template: null,
         },
         'connectingID.identifierType': {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         createDate: {
             isCreateable: null,
@@ -130,17 +131,25 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        definitionName: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
         'definitionName.value': {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // equal to 'name'; auto-populated by preDeployTasks
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         fullyQualifiedName: {
-            isCreateable: null,
-            isUpdateable: null,
-            retrieving: true,
-            template: null,
+            // equal to 'name'; auto-populated by preDeployTasks
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
         },
         isCustomObjectBacked: {
             isCreateable: null,
@@ -233,28 +242,28 @@ module.exports = {
             template: null,
         },
         localizedDescription: {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.resourceSetKey': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.resourceValueKey': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         'localizedDescription.value': {
-            isCreateable: null,
-            isUpdateable: null,
+            isCreateable: true,
+            isUpdateable: true,
             retrieving: true,
-            template: null,
+            template: true,
         },
         name: {
             isCreateable: null,
@@ -436,6 +445,18 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        'relationships[].relationshipAttributes[].c__leftFullyQualifiedName': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
+        'relationships[].relationshipAttributes[].c__rightFullyQualifiedName': {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
         'relationships[].relationshipID': {
             isCreateable: null,
             isUpdateable: null,
@@ -832,5 +853,11 @@ module.exports = {
             retrieving: true,
             template: null,
         },
+        r__folder_Path: {
+            isCreateable: null,
+            isUpdateable: null,
+            retrieving: true,
+            template: null,
+        },
     },
 };

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

@@ -42,11 +42,19 @@ module.exports = {
     keyField: 'key',
     nameField: 'name',
     folderIdField: 'categoryId',
-    createdDateField: 'createdDate',
-    createdNameField: 'createdByName',
-    lastmodDateField: 'lastSavedDate',
-    lastmodNameField: 'lastSavedByName',
-    restPagination: false,
+    createdDateField: 'createdDate', // only returned by upsert
+    createdNameField: 'createdByName', // only returned by upsert
+    lastmodDateField: 'lastSavedDate', // only returned by upsert
+    lastmodNameField: 'lastSavedByName', // only returned by upsert
+    restPagination: true,
+    maxKeyLength: 200, // confirmed max length
+    scheduleTypeMapping: {
+        MINUTELY: 1,
+        HOURLY: 2,
+        DAILY: 3,
+        WEEKLY: 4,
+        MONTHLY: 5,
+    },
     statusMapping: {
         AwaitingTrigger: 7,
         Building: 1,
@@ -329,37 +337,37 @@ module.exports = {
         legacyId: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         lastSavedDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsert
             template: false,
         },
         lastSavedByName: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsert
             template: false,
         },
         createdDate: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsert
             template: false,
         },
         createdByName: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false, // only returned by upsertt
             template: false,
         },
         updateInProgress: {
             isCreateable: false,
             isUpdateable: false,
-            retrieving: true,
+            retrieving: false,
             template: false,
         },
         name: {
@@ -368,6 +376,45 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        notifications: {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].email': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].message': {
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].channelType': {
+            // always 'Account'
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: false,
+            template: false,
+        },
+        'notifications[].type': {
+            // custom shorthand for channelType
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
+        'notifications[].notificationType': {
+            // Error, Complete
+            isCreateable: true,
+            isUpdateable: true,
+            retrieving: true,
+            template: true,
+        },
         startSource: {
             skipValidation: true,
         },
@@ -411,7 +458,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: false,
-            template: true,
+            template: false,
         },
         'schedule.scheduleStatus': {
             isCreateable: false,
@@ -425,11 +472,17 @@ module.exports = {
             retrieving: true,
             template: true,
         },
+        'schedule.statusId': {
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
+        },
         'schedule.timezoneId': {
             isCreateable: true,
             isUpdateable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'schedule.timezoneName': {
             isCreateable: true,
@@ -438,10 +491,10 @@ module.exports = {
             template: true,
         },
         'schedule.typeId': {
-            isCreateable: true,
-            isUpdateable: true,
-            retrieving: true,
-            template: true,
+            isCreateable: false,
+            isUpdateable: false,
+            retrieving: false,
+            template: false,
         },
         status: {
             isCreateable: true,
@@ -527,8 +580,8 @@ module.exports = {
         'steps[].annotation': {
             isCreateable: true,
             isUpdateable: true,
-            retrieving: true,
-            template: true,
+            retrieving: false,
+            template: false,
         },
         'steps[].id': {
             isCreateable: true,
@@ -564,7 +617,7 @@ module.exports = {
             isCreateable: true,
             isUpdateable: true,
             retrieving: false,
-            template: true,
+            template: false,
         },
         r__folder_Path: { skipValidation: true },
     },

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

@@ -96,6 +96,7 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: false,
+    maxKeyLength: 200, // confirmed max length
     type: 'dataExtension',
     typeDescription: 'Database table schemas.',
     typeRetrieveByDefault: true,