#139: add key param to retrieveSOAP, allowing to print it next to the…

… "Downloaded" msg

lib/metadataTypes/ContentArea.js

@@ -36,7 +36,7 @@ class ContentArea extends MetadataType {
             };
         }
         // !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
     /**
      * manages post retrieve steps

lib/metadataTypes/DataExtension.js

@@ -1022,7 +1022,7 @@ class DataExtension extends MetadataType {
      * @returns {Promise.<TYPE.DataExtensionMap>} keyField => metadata map
      */
     static async _retrieveAll(additionalFields, options) {
-        const { metadata } = await super.retrieveSOAP(null, options, additionalFields);
+        const { metadata } = await super.retrieveSOAP(null, options, null, additionalFields);
         for (const key in metadata) {
             // some system data extensions do not have CategoryID which throws errors in other places. These do not need to be parsed
             if (metadata[key].CategoryID) {

lib/metadataTypes/DataExtensionField.js

@@ -18,7 +18,7 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<{metadata: TYPE.DataExtensionFieldMap, type: string}>} Promise of items
      */
     static async retrieve(retrieveDir, additionalFields) {
-        return super.retrieveSOAP(retrieveDir, null, additionalFields);
+        return super.retrieveSOAP(retrieveDir, null, null, additionalFields);
     }
     /**
      * Retrieves all records for caching
@@ -28,7 +28,7 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<{metadata: TYPE.DataExtensionFieldMap, type: string}>} Promise of items
      */
     static async retrieveForCache(requestParams, additionalFields) {
-        return super.retrieveSOAP(null, requestParams, additionalFields);
+        return super.retrieveSOAP(null, requestParams, null, additionalFields);
     }
     /**
      * helper for {@link DataExtension._retrieveFieldsForSingleDe} that sorts the fields into an array

lib/metadataTypes/DataExtensionTemplate.js

@@ -30,7 +30,7 @@ class DataExtensionTemplate extends MetadataType {
                 },
             };
         }
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 }
 

lib/metadataTypes/Email.js

@@ -32,7 +32,7 @@ class Email extends MetadataType {
             };
         }
         // !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
     /**
      * Helper for writing Metadata to disk, used for Retrieve and deploy

lib/metadataTypes/EmailSend.js

@@ -52,7 +52,7 @@ class EmailSend extends MetadataType {
                 },
             };
         }
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 
     /**

lib/metadataTypes/List.js

@@ -43,7 +43,7 @@ class List extends MetadataType {
                 },
             };
         }
-        const results = await super.retrieveSOAP(retrieveDir, requestParams);
+        const results = await super.retrieveSOAP(retrieveDir, requestParams, key);
         return await this._retrieveParentAllSubs(results);
     }
     /**

lib/metadataTypes/MetadataType.js

@@ -793,10 +793,11 @@ class MetadataType {
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {TYPE.SoapRequestParams} [requestParams] required for the specific request (filter for example)
+     * @param {string|number} [singleRetrieve] key of single item to filter by
      * @param {string[]} [additionalFields] Returns specified fields even if their retrieve definition is not set to true
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of item map
      */
-    static async retrieveSOAP(retrieveDir, requestParams, additionalFields) {
+    static async retrieveSOAP(retrieveDir, requestParams, singleRetrieve, additionalFields) {
         requestParams = requestParams || {};
         const fields = this.getFieldNamesToRetrieve(additionalFields, !retrieveDir);
         const soapType = this.definition.soapType || this.definition.type;
@@ -812,7 +813,8 @@ class MetadataType {
         if (retrieveDir) {
             const savedMetadata = await this.saveResults(metadata, retrieveDir, null);
             Util.logger.info(
-                `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})`
+                `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})` +
+                    Util.getKeysString(singleRetrieve)
             );
             if (
                 this.buObject &&

lib/metadataTypes/SendClassification.js

@@ -30,7 +30,7 @@ class SendClassification extends MetadataType {
                 },
             };
         }
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 }
 

lib/metadataTypes/TriggeredSend.js

@@ -50,7 +50,7 @@ class TriggeredSend extends MetadataType {
             };
         }
 
-        return super.retrieveSOAP(retrieveDir, requestParams);
+        return super.retrieveSOAP(retrieveDir, requestParams, key);
     }
 
     /**
@@ -342,7 +342,7 @@ class TriggeredSend extends MetadataType {
             };
             try {
                 test = (
-                    await super.retrieveSOAP(null, requestParams, [
+                    await super.retrieveSOAP(null, requestParams, key, [
                         'CustomerKey',
                         'TriggeredSendStatus',
                     ])