mcdev 6.0.2 → 7.0.0

package/lib/metadataTypes/DataExtensionField.js

@@ -1,21 +1,37 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+/**
+ * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldMap} DataExtensionFieldMap
+ * @typedef {import('../../types/mcdev.d.js').DataExtensionFieldItem} DataExtensionFieldItem
+ */
 /**
  * DataExtensionField MetadataType
  *
  * @augments MetadataType
  */
 class DataExtensionField extends MetadataType {
+    static fixShared_fields;
     /**
      * Retrieves all records and saves it to disk
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {string[]} [additionalFields] Returns specified fields even if their retrieve definition is not set to true
-     * @returns {Promise.<{metadata: TYPE.DataExtensionFieldMap, type: string}>} Promise of items
+     * @returns {Promise.<{metadata: DataExtensionFieldMap, type: string}>} Promise of items
      */
     static async retrieve(retrieveDir, additionalFields) {
         return super.retrieveSOAP(retrieveDir, null, null, additionalFields);
@@ -23,18 +39,18 @@ class DataExtensionField extends MetadataType {
     /**
      * Retrieves all records for caching
      *
-     * @param {TYPE.SoapRequestParams} [requestParams] required for the specific request (filter for example)
+     * @param {SoapRequestParams} [requestParams] required for the specific request (filter for example)
      * @param {string[]} [additionalFields] Returns specified fields even if their retrieve definition is not set to true
-     * @returns {Promise.<{metadata: TYPE.DataExtensionFieldMap, type: string}>} Promise of items
+     * @returns {Promise.<{metadata: DataExtensionFieldMap, type: string}>} Promise of items
      */
-    static async retrieveForCache(requestParams, additionalFields) {
+    static async retrieveForCacheDE(requestParams, additionalFields) {
         return super.retrieveSOAP(null, requestParams, null, additionalFields);
     }
     /**
      * helper for DataExtension.retrieveFieldsForSingleDe that sorts the fields into an array
      *
-     * @param {TYPE.DataExtensionFieldMap} fieldsObj customerKey-based list of fields for one dataExtension
-     * @returns {TYPE.DataExtensionFieldItem[]} sorted array of field objects
+     * @param {DataExtensionFieldMap} fieldsObj customerKey-based list of fields for one dataExtension
+     * @returns {DataExtensionFieldItem[]} sorted array of field objects
      */
     static convertToSortedArray(fieldsObj) {
         return (
@@ -48,45 +64,30 @@ class DataExtensionField extends MetadataType {
     /**
      * sorting method to ensure `Ordinal` is respected
      *
-     * @param {TYPE.DataExtensionFieldItem} a -
-     * @param {TYPE.DataExtensionFieldItem} b -
-     * @returns {boolean} sorting based on Ordinal
+     * @param {DataExtensionFieldItem} a -
+     * @param {DataExtensionFieldItem} b -
+     * @returns {number} sorting based on Ordinal
      */
     static sortDeFields(a, b) {
         return a.Ordinal - b.Ordinal;
     }
     /**
-     * manages post retrieve steps
+     * manages post retrieve steps; only used by DataExtension class
      *
-     * @param {TYPE.DataExtensionFieldItem} metadata a single item
-     * @param {boolean} forDataExtension when used by DataExtension class we remove more fields
-     * @returns {TYPE.DataExtensionFieldItem} metadata
+     * @param {DataExtensionFieldItem} metadata a single item
+     * @returns {DataExtensionFieldItem} metadata
      */
-    static postRetrieveTasks(metadata, forDataExtension) {
-        return this._parseMetadata(metadata, forDataExtension);
-    }
+    static postRetrieveTasksDE(metadata) {
+        // remove fields according to definition
+        this.keepRetrieveFields(metadata);
 
-    /**
-     * parses retrieved Metadata before saving
-     *
-     * @private
-     * @param {TYPE.DataExtensionFieldItem} metadata a single record
-     * @param {boolean} forDataExtension when used by DataExtension class we remove more fields
-     * @returns {TYPE.DataExtensionFieldItem} parsed metadata definition
-     */
-    static _parseMetadata(metadata, forDataExtension) {
-        if (forDataExtension) {
-            // remove fields according to definition
-            this.keepRetrieveFields(metadata);
-
-            // remove fields that we do not need after association to a DE
-            delete metadata.CustomerKey;
-            delete metadata.DataExtension;
-            delete metadata.Ordinal;
-            if (metadata.FieldType !== 'Decimal') {
-                // remove scale - it's only used for "Decimal" to define the digits behind the decimal
-                delete metadata.Scale;
-            }
+        // remove fields that we do not need after association to a DE
+        delete metadata.CustomerKey;
+        delete metadata.DataExtension;
+        delete metadata.Ordinal;
+        if (metadata.FieldType !== 'Decimal') {
+            // remove scale - it's only used for "Decimal" to define the digits behind the decimal
+            delete metadata.Scale;
         }
         return metadata;
     }
@@ -94,9 +95,9 @@ class DataExtensionField extends MetadataType {
      * Mofifies passed deployColumns for update by mapping ObjectID to their target column's values.
      * Removes FieldType field if its the same in deploy and target column, because it results in an error even if its of the same type
      *
-     * @param {TYPE.DataExtensionFieldItem[]} deployColumns Columns of data extension that will be deployed
+     * @param {DataExtensionFieldItem[]} deployColumns Columns of data extension that will be deployed
      * @param {string} deKey external/customer key of Data Extension
-     * @returns {Promise.<Object.<string, TYPE.DataExtensionFieldItem>>} existing fields by their original name to allow re-adding FieldType after update
+     * @returns {Promise.<Object.<string, DataExtensionFieldItem>>} existing fields by their original name to allow re-adding FieldType after update
      */
     static async prepareDeployColumnsOnUpdate(deployColumns, deKey) {
         // create list of DE keys that had changes to their fields to be able to use it as a filter in the --fixShared logic
@@ -117,7 +118,7 @@ class DataExtensionField extends MetadataType {
         }
 
         // retrieve existing fields to enable updating them
-        const response = await this.retrieveForCache(
+        const response = await this.retrieveForCacheDE(
             {
                 filter: {
                     leftOperand: 'DataExtension.CustomerKey',
@@ -131,7 +132,7 @@ class DataExtensionField extends MetadataType {
         const fieldsObj = response.metadata;
 
         // ensure fields can be updated properly by their adding ObjectId based on Name-matching
-        /** @type {Object.<string, TYPE.DataExtensionFieldItem>} */
+        /** @type {Object.<string, DataExtensionFieldItem>} */
         const existingFieldByName = {};
 
         for (const key of Object.keys(fieldsObj)) {
@@ -189,7 +190,7 @@ class DataExtensionField extends MetadataType {
                     }
                 }
                 // share fields with fixShared logic
-                this.fixShared_fields[deKey][item.Name] = JSON.parse(JSON.stringify(item));
+                this.fixShared_fields[deKey][item.Name] = structuredClone(item);
                 this.fixShared_fields[deKey][item.Name].FieldType = itemOld.FieldType;
 
                 if (!changeFound) {
@@ -226,7 +227,7 @@ class DataExtensionField extends MetadataType {
                 // Field doesn't exist in target, therefore Remove ObjectID if present
                 delete item.ObjectID;
 
-                this.fixShared_fields[deKey][item.Name] = JSON.parse(JSON.stringify(item));
+                this.fixShared_fields[deKey][item.Name] = structuredClone(item);
             }
             if (Util.isTrue(item.IsPrimaryKey) && Util.isFalse(item.IsRequired)) {
                 // applicable: with or without data
@@ -268,7 +269,7 @@ class DataExtensionField extends MetadataType {
      * @param {string} customerKey Identifier of data extension
      * @returns {Promise.<boolean>} deletion success status
      */
-    static deleteByKey(customerKey) {
+    static async deleteByKey(customerKey) {
         return this.deleteByKeySOAP(customerKey);
     }
 
@@ -277,7 +278,7 @@ class DataExtensionField extends MetadataType {
      *
      * @param {string} customerKey Identifier of metadata
      * @param {string} [fieldId] for programmatic deletes only one can pass in the ID directly
-     * @returns {boolean} deletion success flag
+     * @returns {Promise.<boolean>} deletion success flag
      */
     static async deleteByKeySOAP(customerKey, fieldId) {
         const [deKey, fieldKey] = customerKey.split('.');
@@ -286,7 +287,7 @@ class DataExtensionField extends MetadataType {
         let fieldObjectID = fieldId;
         // get the object id
         if (!fieldObjectID) {
-            const response = await this.retrieveForCache(
+            const response = await this.retrieveForCacheDE(
                 {
                     filter: {
                         leftOperand: 'CustomerKey',
@@ -313,11 +314,9 @@ class DataExtensionField extends MetadataType {
             },
         };
         try {
-            this.client.soap.delete(
-                'DataExtension', // yes, not DataExtensionField
-                keyObj,
-                null
-            );
+            // ! we really do need to delete from DataExtension not DataExtensionField here!
+            // @ts-expect-error wrong jsdoc for 2nd parameter in SFMC-SDK
+            this.client.soap.delete('DataExtension', keyObj, null);
 
             if (!fieldId) {
                 Util.logger.info(` - deleted ${this.definition.type}: ${customerKey}`);
@@ -339,7 +338,7 @@ class DataExtensionField extends MetadataType {
      * clean up after deleting a metadata item
      *
      * @param {string} customerKey Identifier of metadata item
-     * @returns {void}
+     * @returns {Promise.<void>} -
      */
     static async postDeleteTasks(customerKey) {
         // TODO actually clean up local dataextension json

package/lib/metadataTypes/DataExtensionTemplate.js

@@ -1,8 +1,20 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
 /**
  * DataExtensionTemplate MetadataType
  *
@@ -13,13 +25,13 @@ class DataExtensionTemplate extends MetadataType {
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] unused parameter
-     * @param {void} [__] unused parameter
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
      * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static retrieve(retrieveDir, _, __, key) {
-        /** @type {TYPE.SoapRequestParams} */
+        /** @type {SoapRequestParams} */
         let requestParams = null;
         if (key) {
             requestParams = {

package/lib/metadataTypes/DataExtract.js

@@ -1,11 +1,23 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
 import File from '../util/file.js';
 import cache from '../util/cache.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
 /**
  * DataExtract MetadataType
  *
@@ -17,10 +29,10 @@ class DataExtract extends MetadataType {
      * Endpoint /automation/v1/dataextracts/ returns all Data Extracts
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] unused parameter
-     * @param {void} [__] unused parameter
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
      * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static async retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/dataextracts/', null, key);
@@ -28,7 +40,7 @@ class DataExtract extends MetadataType {
     /**
      * Retrieves Metadata of  Data Extract Activity for caching
      *
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static async retrieveForCache() {
         return super.retrieveREST(null, '/automation/v1/dataextracts/');
@@ -39,8 +51,8 @@ class DataExtract extends MetadataType {
      *
      * @param {string} templateDir Directory where retrieved metadata directory will be saved
      * @param {string} name name of the metadata file
-     * @param {TYPE.TemplateMap} templateVariables variables to be replaced in the metadata
-     * @returns {Promise.<TYPE.MetadataTypeItemObj>} Promise of metadata
+     * @param {TemplateMap} templateVariables variables to be replaced in the metadata
+     * @returns {Promise.<MetadataTypeItemObj>} Promise of metadata
      */
     static async retrieveAsTemplate(templateDir, name, templateVariables) {
         const res = await this.client.rest.get(
@@ -61,7 +73,7 @@ class DataExtract extends MetadataType {
             const originalKey = extended[this.definition.keyField];
             const val = JSON.parse(
                 Util.replaceByObject(
-                    JSON.stringify(this.parseMetadata(extended)),
+                    JSON.stringify(this.postRetrieveTasks(extended)),
                     templateVariables
                 )
             );
@@ -86,20 +98,10 @@ class DataExtract extends MetadataType {
         }
     }
 
-    /**
-     * manages post retrieve steps
-     *
-     * @param {TYPE.MetadataTypeItem} fileTransfer a single fileTransfer
-     * @returns {TYPE.MetadataTypeItem} metadata
-     */
-    static postRetrieveTasks(fileTransfer) {
-        return this.parseMetadata(fileTransfer);
-    }
-
     /**
      * Creates a single Data Extract
      *
-     * @param {TYPE.MetadataTypeItem} dataExtract a single Data Extract
+     * @param {MetadataTypeItem} dataExtract a single Data Extract
      * @returns {Promise} Promise
      */
     static create(dataExtract) {
@@ -109,7 +111,7 @@ class DataExtract extends MetadataType {
     /**
      * Updates a single Data Extract
      *
-     * @param {TYPE.MetadataTypeItem} dataExtract a single Data Extract
+     * @param {MetadataTypeItem} dataExtract a single Data Extract
      * @returns {Promise} Promise
      */
     static update(dataExtract) {
@@ -122,8 +124,8 @@ class DataExtract extends MetadataType {
     /**
      * prepares a dataExtract for deployment
      *
-     * @param {TYPE.MetadataTypeItem} metadata a single dataExtract activity definition
-     * @returns {TYPE.MetadataTypeItem} metadata object
+     * @param {MetadataTypeItem} metadata a single dataExtract activity definition
+     * @returns {MetadataTypeItem} metadata object
      */
     static preDeployTasks(metadata) {
         metadata.dataExtractTypeId = cache.searchForField(
@@ -136,12 +138,12 @@ class DataExtract extends MetadataType {
         return metadata;
     }
     /**
-     * parses retrieved Metadata before saving
+     * manages post retrieve steps
      *
-     * @param {TYPE.MetadataTypeItem} metadata a single dataExtract activity definition
-     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one sql string
+     * @param {MetadataTypeItem} metadata a single item
+     * @returns {MetadataTypeItem} metadata
      */
-    static parseMetadata(metadata) {
+    static postRetrieveTasks(metadata) {
         try {
             metadata.r__dataExtractType_name = cache.searchForField(
                 'dataExtractType',
@@ -155,7 +157,40 @@ class DataExtract extends MetadataType {
                 ` - ${this.definition.type} ${metadata[this.definition.keyField]}: ${ex.message}`
             );
         }
-        return JSON.parse(JSON.stringify(metadata));
+        return structuredClone(metadata);
+    }
+    /**
+     * helper to allow us to select single metadata entries via REST
+     *
+     * @private
+     * @param {string} key customer key
+     * @returns {Promise.<string>} objectId or enpty string
+     */
+    static async _getObjectIdForSingleRetrieve(key) {
+        const name = key.startsWith('name:') ? key.slice(5) : null;
+        const filter = name ? '?$filter=name%20eq%20' + encodeURIComponent(name) : '';
+        const results = await this.client.rest.get('/automation/v1/dataextracts/' + filter);
+        const items = results?.items || [];
+        const found = items.find((item) =>
+            name ? item[this.definition.nameField] === name : item[this.definition.keyField] === key
+        );
+        return found?.dataExtractDefinitionId || null;
+    }
+
+    /**
+     * Delete a metadata item from the specified business unit
+     *
+     * @param {string} customerKey Identifier of data extension
+     * @returns {Promise.<boolean>} deletion success flag
+     */
+    static async deleteByKey(customerKey) {
+        // delete only works with the query's object id
+        const objectId = customerKey ? await this._getObjectIdForSingleRetrieve(customerKey) : null;
+        if (!objectId) {
+            Util.logger.error(` - dataExtract not found`);
+            return false;
+        }
+        return super.deleteByKeyREST('/automation/v1/dataextracts/' + objectId, customerKey);
     }
 }
 

package/lib/metadataTypes/DataExtractType.js

@@ -1,8 +1,20 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
 /**
  * DataExtractType MetadataType
  * Only for Caching No retrieve/upsert is required
@@ -15,10 +27,10 @@ class DataExtractType extends MetadataType {
      * Retrieves Metadata of  Data Extract Type.
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] unused parameter
-     * @param {void} [__] unused parameter
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
      * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static retrieve(retrieveDir, _, __, key) {
         return super.retrieveREST(retrieveDir, '/automation/v1/dataextracttypes/', null, key);
@@ -26,7 +38,7 @@ class DataExtractType extends MetadataType {
     /**
      * Retrieves Metadata of  Data Extract Type for caching.
      *
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static retrieveForCache() {
         return super.retrieveREST(null, '/automation/v1/dataextracttypes/');

package/lib/metadataTypes/DeliveryProfile.js

@@ -0,0 +1,47 @@
+'use strict';
+
+import MetadataType from './MetadataType.js';
+
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
+/**
+ * DeliveryProfile MetadataType
+ *
+ * @augments MetadataType
+ */
+class DeliveryProfile extends MetadataType {
+    /**
+     * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
+     *
+     * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+     * @param {void | string[]} [_] not used
+     * @param {void | string[]} [__] unused parameter
+     * @param {string} [key] customer key of single item to retrieve
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
+     */
+    static retrieve(retrieveDir, _, __, key) {
+        return super.retrieveREST(
+            retrieveDir,
+            '/legacy/v1/beta/messaging/deliverypolicy/',
+            null,
+            key
+        );
+    }
+}
+
+// Assign definition to static attributes
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+DeliveryProfile.definition = MetadataTypeDefinitions.deliveryProfile;
+
+export default DeliveryProfile;

package/lib/metadataTypes/Discovery.js

@@ -1,9 +1,20 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
 /**
  * ImportFile MetadataType
  *
@@ -15,10 +26,10 @@ class Discovery extends MetadataType {
      * documentation: https://developer.salesforce.com/docs/atlas.en-us.noversion.mc-apis.meta/mc-apis/routes.htm
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] not used
-     * @param {void} [__] unused parameter
+     * @param {void | string[]} [_] not used
+     * @param {void | string[]} [__] unused parameter
      * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
+     * @returns {Promise.<MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
         if (key) {

package/lib/metadataTypes/Email.js

@@ -1,9 +1,21 @@
 'use strict';
 
-import TYPE from '../../types/mcdev.d.js';
 import MetadataType from './MetadataType.js';
 import { Util } from '../util/util.js';
 
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
 /**
  * Email MetadataType
  *
@@ -14,13 +26,13 @@ class Email extends MetadataType {
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
-     * @param {void} [_] unused parameter
-     * @param {void} [__] unused parameter
+     * @param {void | string[]} [_] unused parameter
+     * @param {void | string[]} [__] unused parameter
      * @param {string} [key] customer key of single item to retrieve
-     * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
+     * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
      */
     static retrieve(retrieveDir, _, __, key) {
-        /** @type {TYPE.SoapRequestParams} */
+        /** @type {SoapRequestParams} */
         let requestParams = null;
         if (key) {
             requestParams = {
@@ -37,11 +49,11 @@ class Email extends MetadataType {
     /**
      * Helper for writing Metadata to disk, used for Retrieve and deploy
      *
-     * @param {TYPE.MetadataTypeMap} results metadata results from deploy
+     * @param {MetadataTypeMap} results metadata results from deploy
      * @param {string} retrieveDir directory where metadata should be stored after deploy/retrieve
      * @param {string} [overrideType] for use when there is a subtype (such as folder-queries)
-     * @param {TYPE.TemplateMap} [templateVariables] variables to be replaced in the metadata
-     * @returns {Promise.<TYPE.MetadataTypeMap>} Promise of saved metadata
+     * @param {TemplateMap} [templateVariables] variables to be replaced in the metadata
+     * @returns {Promise.<MetadataTypeMap>} Promise of saved metadata
      */
     static async saveResults(results, retrieveDir, overrideType, templateVariables) {
         if (Object.keys(results).length) {
@@ -55,19 +67,10 @@ class Email extends MetadataType {
     /**
      * manages post retrieve steps
      *
-     * @param {TYPE.MetadataTypeItem} metadata a single query
-     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one query string
+     * @param {MetadataTypeItem} metadata a single query
+     * @returns {MetadataTypeItem} Array with one metadata object and one query string
      */
     static postRetrieveTasks(metadata) {
-        return this.parseMetadata(metadata);
-    }
-    /**
-     * parses retrieved Metadata before saving
-     *
-     * @param {TYPE.MetadataTypeItem} metadata a single query activity definition
-     * @returns {TYPE.MetadataTypeItem} Array with one metadata object and one sql string
-     */
-    static parseMetadata(metadata) {
         // folder
         super.setFolderPath(metadata);