#732: remove unused parameter

Accenture · Feb 13, 2023 · 88045e9 · 88045e9
1 parent 809e7f4
commit 88045e9
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 9 deletions.
diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md
@@ -1816,7 +1816,7 @@ DataExtensionField MetadataType
     * [.postRetrieveTasks(metadata, forDataExtension)](#DataExtensionField.postRetrieveTasks) ⇒ <code>TYPE.DataExtensionFieldItem</code>
     * [.prepareDeployColumnsOnUpdate(deployColumns, deKey)](#DataExtensionField.prepareDeployColumnsOnUpdate) ⇒ <code>Object.&lt;string, TYPE.DataExtensionFieldItem&gt;</code>
     * [.deleteByKey(customerKey)](#DataExtensionField.deleteByKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
-    * [.deleteByKeySOAP(customerKey, [handleOutside])](#DataExtensionField.deleteByKeySOAP) ⇒ <code>boolean</code>
+    * [.deleteByKeySOAP(customerKey, _, [handleOutside])](#DataExtensionField.deleteByKeySOAP) ⇒ <code>boolean</code>
     * [.postDeleteTasks(customerKey)](#DataExtensionField.postDeleteTasks) ⇒ <code>void</code>
 
 <a name="DataExtensionField.retrieve"></a>
@@ -1911,7 +1911,7 @@ Delete a metadata item from the specified business unit
 
 <a name="DataExtensionField.deleteByKeySOAP"></a>
 
-### DataExtensionField.deleteByKeySOAP(customerKey, [handleOutside]) ⇒ <code>boolean</code>
+### DataExtensionField.deleteByKeySOAP(customerKey, _, [handleOutside]) ⇒ <code>boolean</code>
 Delete a data extension from the specified business unit
 
 **Kind**: static method of [<code>DataExtensionField</code>](#DataExtensionField)  
@@ -1920,6 +1920,7 @@ Delete a data extension from the specified business unit
 | Param | Type | Description |
 | --- | --- | --- |
 | customerKey | <code>string</code> | Identifier of metadata |
+| _ | <code>void</code> | unused |
 | [handleOutside] | <code>boolean</code> | if the API reponse is irregular this allows you to handle it outside of this generic method |
 
 <a name="DataExtensionField.postDeleteTasks"></a>
@@ -3176,7 +3177,7 @@ Provides default functionality that can be overwritten by child metadata type cl
     * [.document([metadata], [isDeploy])](#MetadataType.document) ⇒ <code>void</code>
     * [.deleteByKey(customerKey)](#MetadataType.deleteByKey) ⇒ <code>boolean</code>
     * [.postDeleteTasks(customerKey)](#MetadataType.postDeleteTasks) ⇒ <code>void</code>
-    * [.deleteByKeySOAP(customerKey, [handleOutside])](#MetadataType.deleteByKeySOAP) ⇒ <code>boolean</code>
+    * [.deleteByKeySOAP(customerKey, [overrideType], [handleOutside])](#MetadataType.deleteByKeySOAP) ⇒ <code>boolean</code>
     * [.deleteByKeyREST(url, key, [handleOutside])](#MetadataType.deleteByKeyREST) ⇒ <code>boolean</code>
     * [.readBUMetadataForType(readDir, [listBadKeys], [buMetadata])](#MetadataType.readBUMetadataForType) ⇒ <code>object</code>
     * [.getFilesToCommit(keyArr)](#MetadataType.getFilesToCommit) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code>
@@ -3836,7 +3837,7 @@ clean up after deleting a metadata item
 
 <a name="MetadataType.deleteByKeySOAP"></a>
 
-### MetadataType.deleteByKeySOAP(customerKey, [handleOutside]) ⇒ <code>boolean</code>
+### MetadataType.deleteByKeySOAP(customerKey, [overrideType], [handleOutside]) ⇒ <code>boolean</code>
 Delete a data extension from the specified business unit
 
 **Kind**: static method of [<code>MetadataType</code>](#MetadataType)  
@@ -3845,6 +3846,7 @@ Delete a data extension from the specified business unit
 | Param | Type | Description |
 | --- | --- | --- |
 | customerKey | <code>string</code> | Identifier of metadata |
+| [overrideType] | <code>string</code> | can be used if the API type differs from the otherwise used type identifier |
 | [handleOutside] | <code>boolean</code> | if the API reponse is irregular this allows you to handle it outside of this generic method |
 
 <a name="MetadataType.deleteByKeyREST"></a>
@@ -4021,6 +4023,7 @@ Query MetadataType
     * [.parseMetadata(metadata)](#Query.parseMetadata) ⇒ <code>TYPE.CodeExtractItem</code>
     * [.getFilesToCommit(keyArr)](#Query.getFilesToCommit) ⇒ <code>Array.&lt;string&gt;</code>
     * [.checkForErrors(ex)](#Query.checkForErrors) ⇒ <code>Array.&lt;string&gt;</code> \| <code>void</code>
+    * [.deleteByKey(customerKey)](#Query.deleteByKey) ⇒ <code>boolean</code>
 
 <a name="Query.retrieve"></a>
 
@@ -4196,6 +4199,18 @@ Standardizes a check for multiple messages but adds query specific filters to er
 | --- | --- | --- |
 | ex | <code>object</code> | response payload from REST API |
 
+<a name="Query.deleteByKey"></a>
+
+### Query.deleteByKey(customerKey) ⇒ <code>boolean</code>
+Delete a metadata item from the specified business unit
+
+**Kind**: static method of [<code>Query</code>](#Query)  
+**Returns**: <code>boolean</code> - deletion success status  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| customerKey | <code>string</code> | Identifier of data extension |
+
 <a name="Role"></a>
 
 ## Role ⇐ [<code>MetadataType</code>](#MetadataType)

diff --git a/lib/metadataTypes/DataExtension.js b/lib/metadataTypes/DataExtension.js
@@ -838,7 +838,7 @@ class DataExtension extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return super.deleteByKeySOAP(customerKey, false);
+        return super.deleteByKeySOAP(customerKey);
     }
 
     /**

diff --git a/lib/metadataTypes/DataExtensionField.js b/lib/metadataTypes/DataExtensionField.js
@@ -258,7 +258,7 @@ class DataExtensionField extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return this.deleteByKeySOAP(customerKey, false);
+        return this.deleteByKeySOAP(customerKey);
     }
 
     /**

diff --git a/lib/metadataTypes/EmailSendDefinition.js b/lib/metadataTypes/EmailSendDefinition.js
@@ -82,7 +82,7 @@ class EmailSendDefinition extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return super.deleteByKeySOAP(customerKey, false);
+        return super.deleteByKeySOAP(customerKey);
     }
 
     /**

diff --git a/lib/metadataTypes/List.js b/lib/metadataTypes/List.js
@@ -163,7 +163,7 @@ class List extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return super.deleteByKeySOAP(customerKey, false);
+        return super.deleteByKeySOAP(customerKey);
     }
 
     /**

diff --git a/lib/metadataTypes/TriggeredSendDefinition.js b/lib/metadataTypes/TriggeredSendDefinition.js
@@ -83,7 +83,7 @@ class TriggeredSendDefinition extends MetadataType {
      * @returns {Promise.<boolean>} deletion success status
      */
     static deleteByKey(customerKey) {
-        return super.deleteByKeySOAP(customerKey, false);
+        return super.deleteByKeySOAP(customerKey);
     }
 
     /**