#778: refactoring: remove unused overrideType param from retrieveREST

Accenture · Mar 10, 2023 · 0592ebf · 0592ebf
1 parent 8f371c1
commit 0592ebf
Show file tree

Hide file tree

Showing 17 changed files with 16 additions and 33 deletions.
diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md
@@ -3180,7 +3180,7 @@ Provides default functionality that can be overwritten by child metadata type cl
     * [._handleSOAPErrors(ex, msg, [metadataEntry], [handleOutside])](#MetadataType._handleSOAPErrors)
     * [.getSOAPErrorMsg(ex)](#MetadataType.getSOAPErrorMsg) ⇒ <code>string</code>
     * [.retrieveSOAP(retrieveDir, [requestParams], [additionalFields])](#MetadataType.retrieveSOAP) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
-    * [.retrieveREST(retrieveDir, uri, [overrideType], [templateVariables], [singleRetrieve])](#MetadataType.retrieveREST) ⇒ <code>Promise.&lt;{metadata: (TYPE.MetadataTypeMap\|TYPE.MetadataTypeItem), type: string}&gt;</code>
+    * [.retrieveREST(retrieveDir, uri, [templateVariables], [singleRetrieve])](#MetadataType.retrieveREST) ⇒ <code>Promise.&lt;{metadata: (TYPE.MetadataTypeMap\|TYPE.MetadataTypeItem), type: string}&gt;</code>
     * [.parseResponseBody(body, [singleRetrieve])](#MetadataType.parseResponseBody) ⇒ <code>TYPE.MetadataTypeMap</code>
     * [.deleteFieldByDefinition(metadataEntry, fieldPath, definitionProperty, origin)](#MetadataType.deleteFieldByDefinition) ⇒ <code>void</code>
     * [.removeNotCreateableFields(metadataEntry)](#MetadataType.removeNotCreateableFields) ⇒ <code>void</code>
@@ -3571,7 +3571,7 @@ Retrieves SOAP via generic fuel-soap wrapper based metadata of metadata type int
 
 <a name="MetadataType.retrieveREST"></a>
 
-### MetadataType.retrieveREST(retrieveDir, uri, [overrideType], [templateVariables], [singleRetrieve]) ⇒ <code>Promise.&lt;{metadata: (TYPE.MetadataTypeMap\|TYPE.MetadataTypeItem), type: string}&gt;</code>
+### MetadataType.retrieveREST(retrieveDir, uri, [templateVariables], [singleRetrieve]) ⇒ <code>Promise.&lt;{metadata: (TYPE.MetadataTypeMap\|TYPE.MetadataTypeItem), type: string}&gt;</code>
 Retrieves Metadata for Rest Types
 
 **Kind**: static method of [<code>MetadataType</code>](#MetadataType)  
@@ -3581,7 +3581,6 @@ Retrieves Metadata for Rest Types
 | --- | --- | --- |
 | retrieveDir | <code>string</code> | Directory where retrieved metadata directory will be saved |
 | uri | <code>string</code> | rest endpoint for GET |
-| [overrideType] | <code>string</code> | force a metadata type (mainly used for Folders) |
 | [templateVariables] | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |
 | [singleRetrieve] | <code>string</code> \| <code>number</code> | key of single item to filter by |
 

diff --git a/lib/metadataTypes/AttributeGroup.js b/lib/metadataTypes/AttributeGroup.js
@@ -23,7 +23,6 @@ class AttributeGroup extends MetadataType {
             retrieveDir,
             '/hub/v1/contacts/schema/attributeGroups',
             null,
-            null,
             key
         );
     }

diff --git a/lib/metadataTypes/Campaign.js b/lib/metadataTypes/Campaign.js
@@ -21,7 +21,7 @@ class Campaign extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
-        const res = await super.retrieveREST(retrieveDir, '/hub/v1/campaigns', null, null, key);
+        const res = await super.retrieveREST(retrieveDir, '/hub/v1/campaigns', null, key);
         // get assignments
 
         const campaignAssets = await Promise.all(

diff --git a/lib/metadataTypes/DataExtract.js b/lib/metadataTypes/DataExtract.js
@@ -23,7 +23,7 @@ class DataExtract extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracts/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracts/', null, key);
     }
     /**
      * Retrieves Metadata of  Data Extract Activity for caching

diff --git a/lib/metadataTypes/DataExtractType.js b/lib/metadataTypes/DataExtractType.js
@@ -21,7 +21,7 @@ class DataExtractType extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise of metadata
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracttypes/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/dataextracttypes/', null, key);
     }
     /**
      * Retrieves Metadata of  Data Extract Type for caching.

diff --git a/lib/metadataTypes/Event.js b/lib/metadataTypes/Event.js
@@ -31,7 +31,6 @@ class Event extends MetadataType {
                 key ? '/key:' + encodeURIComponent(key) : ''
             }?extras=all`,
             null,
-            null,
             key
         );
     }

diff --git a/lib/metadataTypes/FileLocation.js b/lib/metadataTypes/FileLocation.js
@@ -20,7 +20,7 @@ class FtpLocation extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/ftplocations/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/ftplocations/', null, key);
     }
 
     /**

diff --git a/lib/metadataTypes/FileTransfer.js b/lib/metadataTypes/FileTransfer.js
@@ -23,7 +23,7 @@ class FileTransfer extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/filetransfers/', null, key);
     }
     /**
      * Retrieves Metadata of  FileTransfer Activity for caching

diff --git a/lib/metadataTypes/Filter.js b/lib/metadataTypes/Filter.js
@@ -22,7 +22,7 @@ class Filter extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static async retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/filters/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/filters/', null, key);
     }
 }
 

diff --git a/lib/metadataTypes/ImportFile.js b/lib/metadataTypes/ImportFile.js
@@ -24,7 +24,7 @@ class ImportFile extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(retrieveDir, '/automation/v1/imports/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/imports/', null, key);
     }
 
     /**

diff --git a/lib/metadataTypes/Interaction.js b/lib/metadataTypes/Interaction.js
@@ -72,7 +72,6 @@ class Interaction extends MetadataType {
                     retrieveDir,
                     `${uri}${singleKey}?extras=${extras}`,
                     null,
-                    null,
                     key
                 );
             } else {

diff --git a/lib/metadataTypes/MetadataType.js b/lib/metadataTypes/MetadataType.js
@@ -800,12 +800,11 @@ class MetadataType {
      *
      * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
      * @param {string} uri rest endpoint for GET
-     * @param {string} [overrideType] force a metadata type (mainly used for Folders)
      * @param {TYPE.TemplateMap} [templateVariables] variables to be replaced in the metadata
      * @param {string|number} [singleRetrieve] key of single item to filter by
      * @returns {Promise.<{metadata: (TYPE.MetadataTypeMap | TYPE.MetadataTypeItem), type: string}>} Promise of item map (single item for templated result)
      */
-    static async retrieveREST(retrieveDir, uri, overrideType, templateVariables, singleRetrieve) {
+    static async retrieveREST(retrieveDir, uri, templateVariables, singleRetrieve) {
         const response =
             this.definition.restPagination && !singleRetrieve
                 ? await this.client.rest.getBulk(uri, this.definition.restPageSize || 500)
@@ -826,19 +825,18 @@ class MetadataType {
             const savedMetadata = await this.saveResults(
                 results,
                 retrieveDir,
-                overrideType,
+                null,
                 templateVariables
             );
             Util.logger.info(
-                `Downloaded: ${overrideType || this.definition.type} (${
-                    Object.keys(savedMetadata).length
-                })` + Util.getKeysString(singleRetrieve)
+                `Downloaded: ${this.definition.type} (${Object.keys(savedMetadata).length})` +
+                    Util.getKeysString(singleRetrieve)
             );
         }
 
         return {
             metadata: templateVariables ? Object.values(results)[0] : results,
-            type: overrideType || this.definition.type,
+            type: this.definition.type,
         };
     }
 

diff --git a/lib/metadataTypes/MobileCode.js b/lib/metadataTypes/MobileCode.js
@@ -24,7 +24,6 @@ class MobileCode extends MetadataType {
             retrieveDir,
             '/legacy/v1/beta/mobile/code/' + (key ? `?$where=keyword%20eq%20%27${key}%27%20` : ''),
             null,
-            null,
             key
         );
     }

diff --git a/lib/metadataTypes/MobileKeyword.js b/lib/metadataTypes/MobileKeyword.js
@@ -28,7 +28,6 @@ class MobileKeyword extends MetadataType {
             '/legacy/v1/beta/mobile/keyword/?view=simple' +
                 (key ? `&$where=keyword%20eq%20%27${key}%27%20` : ''),
             null,
-            null,
             key
         );
     }

diff --git a/lib/metadataTypes/Query.js b/lib/metadataTypes/Query.js
@@ -47,7 +47,6 @@ class Query extends MetadataType {
             retrieveDir,
             '/automation/v1/queries/' + (objectId || ''),
             null,
-            null,
             key
         );
     }
@@ -99,7 +98,6 @@ class Query extends MetadataType {
         return super.retrieveREST(
             templateDir,
             '/automation/v1/queries/?$filter=Name%20eq%20' + encodeURIComponent(name),
-            null,
             templateVariables
         );
     }

diff --git a/lib/metadataTypes/Script.js b/lib/metadataTypes/Script.js
@@ -23,7 +23,7 @@ class Script extends MetadataType {
      */
     static async retrieve(retrieveDir, _, __, key) {
         await File.initPrettier('ssjs');
-        return super.retrieveREST(retrieveDir, '/automation/v1/scripts/', null, null, key);
+        return super.retrieveREST(retrieveDir, '/automation/v1/scripts/', null, key);
     }
     /**
      * Retrieves script metadata for caching
@@ -47,7 +47,6 @@ class Script extends MetadataType {
         return super.retrieveREST(
             templateDir,
             '/automation/v1/scripts/?$filter=name%20eq%20' + encodeURIComponent(name),
-            null,
             templateVariables
         );
     }

diff --git a/lib/metadataTypes/SetDefinition.js b/lib/metadataTypes/SetDefinition.js
@@ -19,13 +19,7 @@ class SetDefinition extends MetadataType {
      * @returns {Promise.<TYPE.MetadataTypeMapObj>} Promise
      */
     static retrieve(retrieveDir, _, __, key) {
-        return super.retrieveREST(
-            retrieveDir,
-            '/hub/v1/contacts/schema/setDefinitions',
-            null,
-            null,
-            key
-        );
+        return super.retrieveREST(retrieveDir, '/hub/v1/contacts/schema/setDefinitions', null, key);
     }
     /**
      * Retrieves Metadata of schema set definitions for caching.
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,6 @@ class AttributeGroup extends MetadataType { @@
                 retrieveDir,
                 '/hub/v1/contacts/schema/attributeGroups',
                 null,
-                null,
                 key
             );
         }
@@ Expand Down @@