From 88045e96e94873dcc4db78030e8c671d22472aa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Berkefeld?= Date: Mon, 13 Feb 2023 11:05:08 +0100 Subject: [PATCH] #732: remove unused parameter --- docs/dist/documentation.md | 23 ++++++++++++++++---- lib/metadataTypes/DataExtension.js | 2 +- lib/metadataTypes/DataExtensionField.js | 2 +- lib/metadataTypes/EmailSendDefinition.js | 2 +- lib/metadataTypes/List.js | 2 +- lib/metadataTypes/TriggeredSendDefinition.js | 2 +- 6 files changed, 24 insertions(+), 9 deletions(-) diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md index e5eaceaa5..4d08ce4b8 100644 --- a/docs/dist/documentation.md +++ b/docs/dist/documentation.md @@ -1816,7 +1816,7 @@ DataExtensionField MetadataType * [.postRetrieveTasks(metadata, forDataExtension)](#DataExtensionField.postRetrieveTasks) ⇒ TYPE.DataExtensionFieldItem * [.prepareDeployColumnsOnUpdate(deployColumns, deKey)](#DataExtensionField.prepareDeployColumnsOnUpdate) ⇒ Object.<string, TYPE.DataExtensionFieldItem> * [.deleteByKey(customerKey)](#DataExtensionField.deleteByKey) ⇒ Promise.<boolean> - * [.deleteByKeySOAP(customerKey, [handleOutside])](#DataExtensionField.deleteByKeySOAP) ⇒ boolean + * [.deleteByKeySOAP(customerKey, _, [handleOutside])](#DataExtensionField.deleteByKeySOAP) ⇒ boolean * [.postDeleteTasks(customerKey)](#DataExtensionField.postDeleteTasks) ⇒ void @@ -1911,7 +1911,7 @@ Delete a metadata item from the specified business unit -### DataExtensionField.deleteByKeySOAP(customerKey, [handleOutside]) ⇒ boolean +### DataExtensionField.deleteByKeySOAP(customerKey, _, [handleOutside]) ⇒ boolean Delete a data extension from the specified business unit **Kind**: static method of [DataExtensionField](#DataExtensionField) @@ -1920,6 +1920,7 @@ Delete a data extension from the specified business unit | Param | Type | Description | | --- | --- | --- | | customerKey | string | Identifier of metadata | +| _ | void | unused | | [handleOutside] | boolean | if the API reponse is irregular this allows you to handle it outside of this generic method | @@ -3176,7 +3177,7 @@ Provides default functionality that can be overwritten by child metadata type cl * [.document([metadata], [isDeploy])](#MetadataType.document) ⇒ void * [.deleteByKey(customerKey)](#MetadataType.deleteByKey) ⇒ boolean * [.postDeleteTasks(customerKey)](#MetadataType.postDeleteTasks) ⇒ void - * [.deleteByKeySOAP(customerKey, [handleOutside])](#MetadataType.deleteByKeySOAP) ⇒ boolean + * [.deleteByKeySOAP(customerKey, [overrideType], [handleOutside])](#MetadataType.deleteByKeySOAP) ⇒ boolean * [.deleteByKeyREST(url, key, [handleOutside])](#MetadataType.deleteByKeyREST) ⇒ boolean * [.readBUMetadataForType(readDir, [listBadKeys], [buMetadata])](#MetadataType.readBUMetadataForType) ⇒ object * [.getFilesToCommit(keyArr)](#MetadataType.getFilesToCommit) ⇒ Promise.<Array.<string>> @@ -3836,7 +3837,7 @@ clean up after deleting a metadata item -### MetadataType.deleteByKeySOAP(customerKey, [handleOutside]) ⇒ boolean +### MetadataType.deleteByKeySOAP(customerKey, [overrideType], [handleOutside]) ⇒ boolean Delete a data extension from the specified business unit **Kind**: static method of [MetadataType](#MetadataType) @@ -3845,6 +3846,7 @@ Delete a data extension from the specified business unit | Param | Type | Description | | --- | --- | --- | | customerKey | string | Identifier of metadata | +| [overrideType] | string | can be used if the API type differs from the otherwise used type identifier | | [handleOutside] | boolean | if the API reponse is irregular this allows you to handle it outside of this generic method | @@ -4021,6 +4023,7 @@ Query MetadataType * [.parseMetadata(metadata)](#Query.parseMetadata) ⇒ TYPE.CodeExtractItem * [.getFilesToCommit(keyArr)](#Query.getFilesToCommit) ⇒ Array.<string> * [.checkForErrors(ex)](#Query.checkForErrors) ⇒ Array.<string> \| void + * [.deleteByKey(customerKey)](#Query.deleteByKey) ⇒ boolean @@ -4196,6 +4199,18 @@ Standardizes a check for multiple messages but adds query specific filters to er | --- | --- | --- | | ex | object | response payload from REST API | + + +### Query.deleteByKey(customerKey) ⇒ boolean +Delete a metadata item from the specified business unit + +**Kind**: static method of [Query](#Query) +**Returns**: boolean - deletion success status + +| Param | Type | Description | +| --- | --- | --- | +| customerKey | string | Identifier of data extension | + ## Role ⇐ [MetadataType](#MetadataType) diff --git a/lib/metadataTypes/DataExtension.js b/lib/metadataTypes/DataExtension.js index d4779228e..7a669f0d9 100644 --- a/lib/metadataTypes/DataExtension.js +++ b/lib/metadataTypes/DataExtension.js @@ -838,7 +838,7 @@ class DataExtension extends MetadataType { * @returns {Promise.} 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 index 0ed2758ab..d259e9e11 100644 --- a/lib/metadataTypes/DataExtensionField.js +++ b/lib/metadataTypes/DataExtensionField.js @@ -258,7 +258,7 @@ class DataExtensionField extends MetadataType { * @returns {Promise.} 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 index 1ea510952..623b5743b 100644 --- a/lib/metadataTypes/EmailSendDefinition.js +++ b/lib/metadataTypes/EmailSendDefinition.js @@ -82,7 +82,7 @@ class EmailSendDefinition extends MetadataType { * @returns {Promise.} 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 index eda7145c4..71ce0bac7 100644 --- a/lib/metadataTypes/List.js +++ b/lib/metadataTypes/List.js @@ -163,7 +163,7 @@ class List extends MetadataType { * @returns {Promise.} 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 index 13e4194a4..684c913e7 100644 --- a/lib/metadataTypes/TriggeredSendDefinition.js +++ b/lib/metadataTypes/TriggeredSendDefinition.js @@ -83,7 +83,7 @@ class TriggeredSendDefinition extends MetadataType { * @returns {Promise.} deletion success status */ static deleteByKey(customerKey) { - return super.deleteByKeySOAP(customerKey, false); + return super.deleteByKeySOAP(customerKey); } /**