Merge pull request #797 from Accenture/task/779-rename-emailSendDefin…

…ition-to-emailSend #779: rename email emailSendDefinition to emailSend
Accenture · Mar 10, 2023 · 9316f31 · 9316f31
2 parents 2ac8311 + 391a491
commit 9316f31
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 42 deletions.
diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md
@@ -52,7 +52,7 @@ as this is a configuration in the EID</p>
 <dt><a href="#Email">Email</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
 <dd><p>Email MetadataType</p>
 </dd>
-<dt><a href="#EmailSendDefinition">EmailSendDefinition</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
+<dt><a href="#EmailSend">EmailSend</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
 <dd><p>MessageSendActivity MetadataType</p>
 </dd>
 <dt><a href="#Event">Event</a> ⇐ <code><a href="#MetadataType">MetadataType</a></code></dt>
@@ -2222,29 +2222,29 @@ parses retrieved Metadata before saving
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single query activity definition |
 
-<a name="EmailSendDefinition"></a>
+<a name="EmailSend"></a>
 
-## EmailSendDefinition ⇐ [<code>MetadataType</code>](#MetadataType)
+## EmailSend ⇐ [<code>MetadataType</code>](#MetadataType)
 MessageSendActivity MetadataType
 
 **Kind**: global class  
 **Extends**: [<code>MetadataType</code>](#MetadataType)  
 
-* [EmailSendDefinition](#EmailSendDefinition) ⇐ [<code>MetadataType</code>](#MetadataType)
-    * [.retrieve(retrieveDir, [_], [__], [key])](#EmailSendDefinition.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
-    * [.update(metadataItem)](#EmailSendDefinition.update) ⇒ <code>Promise</code>
-    * [.create(metadataItem)](#EmailSendDefinition.create) ⇒ <code>Promise</code>
-    * [.deleteByKey(customerKey)](#EmailSendDefinition.deleteByKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
-    * [.preDeployTasks(metadata)](#EmailSendDefinition.preDeployTasks) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItem&gt;</code>
-    * [.postRetrieveTasks(metadata)](#EmailSendDefinition.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
-    * [.parseMetadata(metadata)](#EmailSendDefinition.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
+* [EmailSend](#EmailSend) ⇐ [<code>MetadataType</code>](#MetadataType)
+    * [.retrieve(retrieveDir, [_], [__], [key])](#EmailSend.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
+    * [.update(metadataItem)](#EmailSend.update) ⇒ <code>Promise</code>
+    * [.create(metadataItem)](#EmailSend.create) ⇒ <code>Promise</code>
+    * [.deleteByKey(customerKey)](#EmailSend.deleteByKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
+    * [.preDeployTasks(metadata)](#EmailSend.preDeployTasks) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItem&gt;</code>
+    * [.postRetrieveTasks(metadata)](#EmailSend.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
+    * [.parseMetadata(metadata)](#EmailSend.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
 
-<a name="EmailSendDefinition.retrieve"></a>
+<a name="EmailSend.retrieve"></a>
 
-### EmailSendDefinition.retrieve(retrieveDir, [_], [__], [key]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
+### EmailSend.retrieve(retrieveDir, [_], [__], [key]) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
 Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code> - Promise of metadata  
 
 | Param | Type | Description |
@@ -2254,72 +2254,72 @@ Retrieves SOAP based metadata of metadata type into local filesystem. executes c
 | [__] | <code>void</code> | unused parameter |
 | [key] | <code>string</code> | customer key of single item to retrieve |
 
-<a name="EmailSendDefinition.update"></a>
+<a name="EmailSend.update"></a>
 
-### EmailSendDefinition.update(metadataItem) ⇒ <code>Promise</code>
+### EmailSend.update(metadataItem) ⇒ <code>Promise</code>
 Updates a single item
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>Promise</code> - Promise  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadataItem | <code>TYPE.MetadataTypeItem</code> | a single item |
 
-<a name="EmailSendDefinition.create"></a>
+<a name="EmailSend.create"></a>
 
-### EmailSendDefinition.create(metadataItem) ⇒ <code>Promise</code>
+### EmailSend.create(metadataItem) ⇒ <code>Promise</code>
 Creates a single item
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>Promise</code> - Promise  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadataItem | <code>TYPE.MetadataTypeItem</code> | a single item |
 
-<a name="EmailSendDefinition.deleteByKey"></a>
+<a name="EmailSend.deleteByKey"></a>
 
-### EmailSendDefinition.deleteByKey(customerKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
+### EmailSend.deleteByKey(customerKey) ⇒ <code>Promise.&lt;boolean&gt;</code>
 Delete a metadata item from the specified business unit
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>Promise.&lt;boolean&gt;</code> - deletion success status  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | customerKey | <code>string</code> | Identifier of data extension |
 
-<a name="EmailSendDefinition.preDeployTasks"></a>
+<a name="EmailSend.preDeployTasks"></a>
 
-### EmailSendDefinition.preDeployTasks(metadata) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItem&gt;</code>
+### EmailSend.preDeployTasks(metadata) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItem&gt;</code>
 prepares a single item for deployment
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>Promise.&lt;TYPE.MetadataTypeItem&gt;</code> - Promise  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |
 
-<a name="EmailSendDefinition.postRetrieveTasks"></a>
+<a name="EmailSend.postRetrieveTasks"></a>
 
-### EmailSendDefinition.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
+### EmailSend.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
 manages post retrieve steps
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>TYPE.MetadataTypeItem</code> - Array with one metadata object and one query string  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | metadata | <code>TYPE.MetadataTypeItem</code> | a single query |
 
-<a name="EmailSendDefinition.parseMetadata"></a>
+<a name="EmailSend.parseMetadata"></a>
 
-### EmailSendDefinition.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
+### EmailSend.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
 parses retrieved Metadata before saving
 
-**Kind**: static method of [<code>EmailSendDefinition</code>](#EmailSendDefinition)  
+**Kind**: static method of [<code>EmailSend</code>](#EmailSend)  
 **Returns**: <code>TYPE.MetadataTypeItem</code> - Array with one metadata object and one sql string  
 
 | Param | Type | Description |

diff --git a/lib/MetadataTypeDefinitions.js b/lib/MetadataTypeDefinitions.js
@@ -17,7 +17,7 @@ const MetadataTypeDefinitions = {
     dataExtractType: require('./metadataTypes/definitions/DataExtractType.definition'),
     discovery: require('./metadataTypes/definitions/Discovery.definition'),
     email: require('./metadataTypes/definitions/Email.definition'),
-    emailSendDefinition: require('./metadataTypes/definitions/EmailSendDefinition.definition'),
+    emailSend: require('./metadataTypes/definitions/EmailSend.definition'),
     event: require('./metadataTypes/definitions/Event.definition'),
     fileLocation: require('./metadataTypes/definitions/FileLocation.definition'),
     fileTransfer: require('./metadataTypes/definitions/FileTransfer.definition'),

diff --git a/lib/MetadataTypeInfo.js b/lib/MetadataTypeInfo.js
@@ -17,7 +17,7 @@ const MetadataTypeInfo = {
     dataExtractType: require('./metadataTypes/DataExtractType'),
     discovery: require('./metadataTypes/Discovery'),
     email: require('./metadataTypes/Email'),
-    emailSendDefinition: require('./metadataTypes/EmailSendDefinition'),
+    emailSend: require('./metadataTypes/EmailSend'),
     event: require('./metadataTypes/Event'),
     fileLocation: require('./metadataTypes/FileLocation'),
     fileTransfer: require('./metadataTypes/FileTransfer'),

diff --git a/lib/index.js b/lib/index.js
@@ -222,6 +222,7 @@ class Mcdev {
             // clean up old folders after types were renamed
             // TODO: Remove this with version 5.0.0
             const renamedTypes = {
+                emailSend: 'emailSendDefinition',
                 event: 'eventDefinition',
                 fileLocation: 'ftpLocation',
                 triggeredSend: 'triggeredSendDefinition',

diff --git a/lib/metadataTypes/EmailSendDefinition.js → lib/metadataTypes/EmailSend.js b/lib/metadataTypes/EmailSendDefinition.js → lib/metadataTypes/EmailSend.js
@@ -10,7 +10,7 @@ const cache = require('../util/cache');
  *
  * @augments MetadataType
  */
-class EmailSendDefinition extends MetadataType {
+class EmailSend extends MetadataType {
     /**
      * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
      *
@@ -292,6 +292,6 @@ class EmailSendDefinition extends MetadataType {
 }
 
 // Assign definition to static attributes
-EmailSendDefinition.definition = require('../MetadataTypeDefinitions').emailSendDefinition;
+EmailSend.definition = require('../MetadataTypeDefinitions').emailSend;
 
-module.exports = EmailSendDefinition;
+module.exports = EmailSend;
diff --git a/lib/metadataTypes/definitions/Automation.definition.js b/lib/metadataTypes/definitions/Automation.definition.js
@@ -2,7 +2,7 @@ module.exports = {
     activityTypeMapping: {
         dataExtract: 73,
         dataFactoryUtility: 425,
-        emailSendDefinition: 42,
+        emailSend: 42,
         fileTransfer: 53,
         filter: 303,
         fireEvent: 749,
@@ -25,7 +25,7 @@ module.exports = {
     bodyIteratorField: 'items',
     dependencies: [
         'dataExtract',
-        'emailSendDefinition',
+        'emailSend',
         'fileTransfer',
         'folder-automations',
         'importFile',

diff --git a/...nitions/EmailSendDefinition.definition.js → ...Types/definitions/EmailSend.definition.js b/...nitions/EmailSendDefinition.definition.js → ...Types/definitions/EmailSend.definition.js
@@ -13,7 +13,8 @@ module.exports = {
     lastmodDateField: 'ModifiedDate',
     lastmodNameField: null,
     restPagination: null,
-    type: 'emailSendDefinition',
+    type: 'emailSend',
+    soapType: 'emailSendDefinition',
     typeDescription: 'Mainly used in Automations as "Send Email Activity".',
     typeRetrieveByDefault: true,
     typeName: 'E-Mail Send Definition',

diff --git a/test/mockRoot/.mcdevrc.json b/test/mockRoot/.mcdevrc.json
@@ -61,7 +61,7 @@
             "automation",
             "dataExtension",
             "dataExtract",
-            "emailSendDefinition",
+            "emailSend",
             "fileTransfer",
             "fileLocation",
             "importFile",

diff --git a/types/mcdev.d.js b/types/mcdev.d.js
@@ -12,7 +12,7 @@ const SDK = require('sfmc-sdk');
  */
 /**
  * @typedef {Object.<string, string>} TemplateMap
- * @typedef {'accountUser'|'asset'|'asset-archive'|'asset-asset'|'asset-audio'|'asset-block'|'asset-code'|'asset-document'|'asset-image'|'asset-message'|'asset-other'|'asset-rawimage'|'asset-template'|'asset-textfile'|'asset-video'|'attributeGroup'|'automation'|'campaign'|'contentArea'|'dataExtension'|'dataExtensionField'|'dataExtensionTemplate'|'dataExtract'|'dataExtractType'|'discovery'|'email'|'emailSendDefinition'|'eventDefinition'|'fileTransfer'|'filter'|'folder'|'ftpLocation'|'importFile'|'interaction'|'list'|'mobileCode'|'mobileKeyword'|'query'|'role'|'script'|'setDefinition'|'triggeredSendDefinition'} SupportedMetadataTypes
+ * @typedef {'accountUser'|'asset'|'asset-archive'|'asset-asset'|'asset-audio'|'asset-block'|'asset-code'|'asset-document'|'asset-image'|'asset-message'|'asset-other'|'asset-rawimage'|'asset-template'|'asset-textfile'|'asset-video'|'attributeGroup'|'automation'|'campaign'|'contentArea'|'dataExtension'|'dataExtensionField'|'dataExtensionTemplate'|'dataExtract'|'dataExtractType'|'discovery'|'email'|'emailSend'|'event'|'fileTransfer'|'filter'|'folder'|'fileLocation'|'importFile'|'interaction'|'list'|'mobileCode'|'mobileKeyword'|'query'|'role'|'script'|'setDefinition'|'triggeredSend'} SupportedMetadataTypes
  * @typedef {Object.<SupportedMetadataTypes, string[]>} TypeKeyCombo object-key=metadata type, value=array of external keys
  */