mcdev 4.1.11 → 4.2.0

package/test/resources/9999999/messaging/v1/push/definitions/get-response.json

@@ -0,0 +1,15 @@
+{
+    "requestId": "4a89b42d-9e71-4ddd-9b4e-a3b00edbfdfb",
+    "definitions": [
+        {
+            "name": "testExisting_tpush",
+            "definitionKey": "testExisting_tpush",
+            "status": "Active",
+            "createdDate": "2022-12-07T02:56:00",
+            "modifiedDate": "2022-12-07T02:56:00"
+        }
+    ],
+    "count": 1,
+    "page": 1,
+    "pageSize": 50
+}

package/test/resources/9999999/messaging/v1/push/definitions/post-response.json

@@ -0,0 +1,13 @@
+{
+    "requestId": "ee81df03-ab61-454d-a54a-025675cf2b41",
+    "name": "testNew_tpush",
+    "definitionKey": "testNew_tpush",
+    "definitionId": "2106d3f9-0c76-ed11-b849-48df37d1de8b",
+    "description": "created on deploy; note that applicationId can only be manually set up in Setup - Mobile Push",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "status": "Active",
+    "createdDate": "2022-12-07T02:56:00",
+    "modifiedDate": "2022-12-07T03:26:00",
+    "content": { "customerKey": "mobileMessage_test" },
+    "options": { "sound": "temp.wmv", "badge": "1" }
+}

package/test/resources/9999999/messaging/v1/push/definitions/testExisting_tpush/get-response.json

@@ -0,0 +1,13 @@
+{
+    "requestId": "64dac58f-f6d0-4bea-9489-eb058c491a87",
+    "name": "testExisting_tpush",
+    "definitionKey": "testExisting_tpush",
+    "definitionId": "2106d3f9-0c76-ed11-b849-48df37d1de8b",
+    "description": "bla bla. note that applicationId can only be manually set up in Setup - Mobile Push",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "status": "Active",
+    "createdDate": "2022-12-07T02:56:00",
+    "modifiedDate": "2022-12-07T02:56:00",
+    "content": { "customerKey": "mobileMessage_test" },
+    "options": { "sound": "temp.wmv", "badge": "1" }
+}

package/test/resources/9999999/messaging/v1/push/definitions/testExisting_tpush/patch-response.json

@@ -0,0 +1,13 @@
+{
+    "requestId": "6d796b32-dff3-4564-ae36-f51edb0e5ec6",
+    "name": "testExisting_tpush",
+    "definitionKey": "testExisting_tpush",
+    "definitionId": "2106d3f9-0c76-ed11-b849-48df37d1de8b",
+    "description": "updated via deploy; note that applicationId can only be manually set up in Setup - Mobile Push",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "status": "Active",
+    "createdDate": "2022-12-07T02:56:00",
+    "modifiedDate": "2022-12-07T03:26:00",
+    "content": { "customerKey": "mobileMessage_test" },
+    "options": { "sound": "temp.wmv", "badge": "1" }
+}

package/test/resources/9999999/messaging/v1/sms/definitions/get-response.json

@@ -0,0 +1,15 @@
+{
+    "requestId": "60c26a29-e1b0-4952-a566-476a937e4a5d",
+    "definitions": [
+        {
+            "name": "testExisting_tsms",
+            "definitionKey": "testExisting_tsms",
+            "status": "Active",
+            "createdDate": "2022-11-23T02:50:00",
+            "modifiedDate": "2022-11-25T08:01:00"
+        }
+    ],
+    "count": 1,
+    "page": 1,
+    "pageSize": 50
+}

package/test/resources/9999999/messaging/v1/sms/definitions/post-response.json

@@ -0,0 +1,17 @@
+{
+    "requestId": "582bec09-6d04-4222-bbba-cea616495596",
+    "name": "testNew_tsms",
+    "definitionKey": "testNew_tsms",
+    "description": "created on deploy",
+    "status": "Active",
+    "createdDate": "2022-11-07T02:24:00",
+    "modifiedDate": "2022-11-07T02:25:00",
+    "content": { "message": "\n%%[\n    SET @key = 'new secret'\n]%%\n" },
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/messaging/v1/sms/definitions/testExisting_tsms/get-response.json

@@ -0,0 +1,18 @@
+{
+    "requestId": "ae8511d0-9bf0-42d0-af4f-bd9c1218c812",
+    "name": "testExisting_tsms",
+    "definitionKey": "testExisting_tsms",
+    "definitionId": "0a650d90-755e-ed11-b852-48df37d1df5b",
+    "description": "bla bla",
+    "status": "Active",
+    "createdDate": "2022-11-07T02:24:00",
+    "modifiedDate": "2022-11-07T02:25:00",
+    "content": { "message": "%%[ SET @key = 'secret' ]%%" },
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/messaging/v1/sms/definitions/testExisting_tsms/patch-response.json

@@ -0,0 +1,18 @@
+{
+    "requestId": "ae8511d0-9bf0-42d0-af4f-bd9c1218c812",
+    "name": "testExisting_tsms",
+    "definitionKey": "testExisting_tsms",
+    "definitionId": "0a650d90-755e-ed11-b852-48df37d1df5b",
+    "description": "bla bla",
+    "status": "Active",
+    "createdDate": "2022-11-07T02:24:00",
+    "modifiedDate": "2022-11-07T02:25:00",
+    "content": { "message": "%%[ SET @key = 'secret' ]%%" },
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/query/build-expected.json

@@ -1,8 +1,8 @@
 {
     "name": "testExistingQuery",
     "key": "testExistingQuery",
-    "description": "",
-    "targetKey": "childBU_dataextension_test",
+    "description": "foobar",
+    "targetKey": "childBU_dataextension_testTarget",
     "targetUpdateTypeName": "Overwrite",
     "r__folder_Path": "Query"
 }

package/test/resources/9999999/query/build-expected.sql

@@ -0,0 +1,6 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers
+WHERE
+    country IN ('testTarget')

package/test/resources/9999999/query/get-expected.json

@@ -1,7 +1,7 @@
 {
     "name": "testExistingQuery",
     "key": "testExistingQuery",
-    "description": "",
+    "description": "bla bla",
     "targetKey": "childBU_dataextension_test",
     "createdDate": "2022-04-26T15:21:16.453",
     "modifiedDate": "2022-04-26T16:02:44.01",

package/test/resources/9999999/query/get-expected.sql

@@ -0,0 +1,6 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers
+WHERE
+    country IN ('test')

package/test/resources/9999999/query/patch-expected.json

@@ -1,7 +1,7 @@
 {
     "name": "testExistingQuery",
     "key": "testExistingQuery",
-    "description": "updated",
+    "description": "updated on deploy",
     "targetKey": "childBU_dataextension_test",
     "createdDate": "2022-04-26T15:21:16.453",
     "modifiedDate": "2022-04-26T16:04:15.88",

package/test/resources/9999999/query/patch-expected.sql

@@ -0,0 +1,6 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers
+WHERE
+    country IN ('test')

package/test/resources/9999999/query/post-expected.json

@@ -1,7 +1,7 @@
 {
-    "name": "testQuery",
-    "key": "testQuery",
-    "description": "",
+    "name": "testNewQuery",
+    "key": "testNewQuery",
+    "description": "created on deploy",
     "targetKey": "childBU_dataextension_test",
     "createdDate": "2022-04-26T15:21:16.453",
     "modifiedDate": "2022-04-26T16:04:15.88",

package/test/resources/9999999/query/post-expected.sql

@@ -0,0 +1,4 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers 

package/test/resources/9999999/query/template-expected.json

@@ -1,7 +1,7 @@
 {
     "name": "testExistingQuery",
     "key": "testExistingQuery",
-    "description": "",
+    "description": "{{{description}}}",
     "targetKey": "childBU_dataextension{{{suffix}}}",
     "targetUpdateTypeName": "Overwrite",
     "r__folder_Path": "Query"

package/test/resources/9999999/query/template-expected.sql

@@ -0,0 +1,6 @@
+SELECT
+    SubscriberKey as testField
+FROM
+    _Subscribers
+WHERE
+    country IN ({{{countryCodeIn}}})

package/test/resources/9999999/transactionalEmail/build-expected.json

@@ -0,0 +1,22 @@
+{
+    "name": "testExisting_temail",
+    "definitionKey": "testExisting_temail",
+    "description": "foobar",
+    "classification": "Default Transactional",
+    "status": "Active",
+    "content": {
+        "customerKey": "testExisting_asset_message"
+    },
+    "subscriptions": {
+        "dataExtension": "childBU_dataextension_testTarget",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "r__list_PathName": "my subscribers/All Subscribers"
+    },
+    "options": {
+        "trackLinks": true
+    },
+    "journey": {
+        "interactionKey": "testExisting_interaction"
+    }
+}

package/test/resources/9999999/transactionalEmail/get-expected.json

@@ -0,0 +1,24 @@
+{
+    "name": "testExisting_temail",
+    "definitionKey": "testExisting_temail",
+    "description": "bla bla",
+    "classification": "Default Transactional",
+    "status": "Active",
+    "createdDate": "2020-09-10T03:29:00",
+    "modifiedDate": "2020-09-10T03:29:00",
+    "content": {
+        "customerKey": "testExisting_asset_message"
+    },
+    "subscriptions": {
+        "dataExtension": "childBU_dataextension_test",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "r__list_PathName": "my subscribers/All Subscribers"
+    },
+    "options": {
+        "trackLinks": true
+    },
+    "journey": {
+        "interactionKey": "testExisting_interaction"
+    }
+}

package/test/resources/9999999/transactionalEmail/patch-expected.json

@@ -0,0 +1,24 @@
+{
+    "name": "testExisting_temail",
+    "definitionKey": "testExisting_temail",
+    "description": "updated via deploy",
+    "classification": "Default Transactional",
+    "status": "Active",
+    "createdDate": "2020-09-10T03:29:00",
+    "modifiedDate": "2020-09-10T03:29:00",
+    "content": {
+        "customerKey": "testExisting_asset_message"
+    },
+    "subscriptions": {
+        "dataExtension": "childBU_dataextension_test",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "r__list_PathName": "my subscribers/All Subscribers"
+    },
+    "options": {
+        "trackLinks": true
+    },
+    "journey": {
+        "interactionKey": "testExisting_interaction"
+    }
+}

package/test/resources/9999999/transactionalEmail/post-expected.json

@@ -0,0 +1,24 @@
+{
+    "name": "testNew_temail",
+    "definitionKey": "testNew_temail",
+    "description": "created on deploy",
+    "classification": "Default Transactional",
+    "status": "Active",
+    "createdDate": "2022-12-06T06:08:00",
+    "modifiedDate": "2022-12-06T06:08:00",
+    "content": {
+        "customerKey": "testExisting_asset_message"
+    },
+    "subscriptions": {
+        "dataExtension": "childBU_dataextension_test",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "r__list_PathName": "my subscribers/All Subscribers"
+    },
+    "options": {
+        "trackLinks": true
+    },
+    "journey": {
+        "interactionKey": "1f936b41-cf1b-4207-aa33-715b3bf9eab7"
+    }
+}

package/test/resources/9999999/transactionalEmail/template-expected.json

@@ -0,0 +1,22 @@
+{
+    "name": "testExisting_temail",
+    "definitionKey": "testExisting_temail",
+    "description": "{{{description}}}",
+    "classification": "Default Transactional",
+    "status": "Active",
+    "content": {
+        "customerKey": "testExisting_asset_message"
+    },
+    "subscriptions": {
+        "dataExtension": "childBU_dataextension{{{suffix}}}",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "r__list_PathName": "my subscribers/All Subscribers"
+    },
+    "options": {
+        "trackLinks": true
+    },
+    "journey": {
+        "interactionKey": "testExisting_interaction"
+    }
+}

package/test/resources/9999999/transactionalPush/build-expected.json

@@ -0,0 +1,8 @@
+{
+    "name": "testExisting_tpush",
+    "definitionKey": "testExisting_tpush",
+    "description": "foobar. note that applicationId can only be manually set up in Setup - Mobile Push",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "content": { "customerKey": "mobileMessage_testTarget" },
+    "options": { "sound": "temp.wmv", "badge": "1" }
+}

package/test/resources/9999999/transactionalPush/get-expected.json

@@ -0,0 +1,11 @@
+{
+    "name": "testExisting_tpush",
+    "definitionKey": "testExisting_tpush",
+    "description": "bla bla. note that applicationId can only be manually set up in Setup - Mobile Push",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "status": "Active",
+    "createdDate": "2022-12-07T02:56:00",
+    "modifiedDate": "2022-12-07T02:56:00",
+    "content": { "customerKey": "mobileMessage_test" },
+    "options": { "sound": "temp.wmv", "badge": "1" }
+}

package/test/resources/9999999/transactionalPush/patch-expected.json

@@ -0,0 +1,16 @@
+{
+    "definitionKey": "testExisting_tpush",
+    "name": "testExisting_tpush",
+    "status": "Active",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "description": "updated via deploy; note that applicationId can only be manually set up in Setup - Mobile Push",
+    "createdDate": "2022-12-07T02:56:00",
+    "modifiedDate": "2022-12-07T03:26:00",
+    "content": {
+        "customerKey": "mobileMessage_test"
+    },
+    "options": {
+        "sound": "temp.wmv",
+        "badge": "1"
+    }
+}

package/test/resources/9999999/transactionalPush/post-expected.json

@@ -0,0 +1,16 @@
+{
+    "definitionKey": "testNew_tpush",
+    "name": "testNew_tpush",
+    "status": "Active",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "description": "created on deploy; note that applicationId can only be manually set up in Setup - Mobile Push",
+    "createdDate": "2022-12-07T02:56:00",
+    "modifiedDate": "2022-12-07T03:26:00",
+    "content": {
+        "customerKey": "mobileMessage_test"
+    },
+    "options": {
+        "sound": "temp.wmv",
+        "badge": "1"
+    }
+}

package/test/resources/9999999/transactionalPush/template-expected.json

@@ -0,0 +1,8 @@
+{
+    "name": "testExisting_tpush",
+    "definitionKey": "testExisting_tpush",
+    "description": "{{{description}}}. note that applicationId can only be manually set up in Setup - Mobile Push",
+    "applicationId": "ffbab4c9-fbf6-4b87-9c9a-10c6ce86e81d",
+    "content": { "customerKey": "mobileMessage{{{suffix}}}" },
+    "options": { "sound": "temp.wmv", "badge": "1" }
+}

package/test/resources/9999999/transactionalSMS/build-expected.amp

@@ -0,0 +1,4 @@
+
+%%[
+    SET @key = 'target secret'
+]%%

package/test/resources/9999999/transactionalSMS/build-expected.json

@@ -0,0 +1,13 @@
+{
+    "name": "testExisting_tsms",
+    "definitionKey": "testExisting_tsms",
+    "description": "foobar",
+    "status": "Active",
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/transactionalSMS/get-expected.amp

@@ -0,0 +1,4 @@
+
+%%[
+    SET @key = 'secret'
+]%%

package/test/resources/9999999/transactionalSMS/get-expected.json

@@ -0,0 +1,15 @@
+{
+    "name": "testExisting_tsms",
+    "definitionKey": "testExisting_tsms",
+    "description": "bla bla",
+    "status": "Active",
+    "createdDate": "2022-11-07T02:24:00",
+    "modifiedDate": "2022-11-07T02:25:00",
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/transactionalSMS/patch-expected.amp

@@ -0,0 +1,4 @@
+
+%%[
+    SET @key = 'secret'
+]%%

package/test/resources/9999999/transactionalSMS/patch-expected.json

@@ -0,0 +1,15 @@
+{
+    "name": "testExisting_tsms",
+    "definitionKey": "testExisting_tsms",
+    "description": "bla bla",
+    "status": "Active",
+    "createdDate": "2022-11-07T02:24:00",
+    "modifiedDate": "2022-11-07T02:25:00",
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/transactionalSMS/post-expected.amp

@@ -0,0 +1,4 @@
+
+%%[
+    SET @key = 'new secret'
+]%%

package/test/resources/9999999/transactionalSMS/post-expected.json

@@ -0,0 +1,15 @@
+{
+    "name": "testNew_tsms",
+    "definitionKey": "testNew_tsms",
+    "description": "created on deploy",
+    "status": "Active",
+    "createdDate": "2022-11-07T02:24:00",
+    "modifiedDate": "2022-11-07T02:25:00",
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/resources/9999999/transactionalSMS/template-expected.amp

@@ -0,0 +1,4 @@
+
+%%[
+    SET @key = '{{{secret}}}'
+]%%

package/test/resources/9999999/transactionalSMS/template-expected.json

@@ -0,0 +1,13 @@
+{
+    "name": "testExisting_tsms",
+    "definitionKey": "testExisting_tsms",
+    "description": "{{{description}}}",
+    "status": "Active",
+    "subscriptions": {
+        "shortCode": "4912312345678",
+        "countryCode": "",
+        "autoAddSubscriber": true,
+        "updateSubscriber": true,
+        "keyword": "testExisting_keyword"
+    }
+}

package/test/transactionalEmail.test.js

@@ -0,0 +1,120 @@
+const chai = require('chai');
+const chaiFiles = require('chai-files');
+const assert = chai.assert;
+chai.use(chaiFiles);
+const cache = require('../lib/util/cache');
+const testUtils = require('./utils');
+const handler = require('../lib/index');
+
+describe('transactionalEmail', () => {
+    beforeEach(() => {
+        testUtils.mockSetup();
+    });
+    afterEach(() => {
+        testUtils.mockReset();
+    });
+
+    describe('Retrieve ================', () => {
+        it('Should retrieve a transactionalEmail', async () => {
+            // WHEN
+            await handler.retrieve('testInstance/testBU', ['transactionalEmail']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.transactionalEmail ? Object.keys(result.transactionalEmail).length : 0,
+                1,
+                'only one transactionalEmail expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_temail', 'transactionalEmail'),
+                await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'get'),
+                'returned JSON was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                12,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Deploy ================', () => {
+        beforeEach(() => {
+            testUtils.mockSetup(true);
+        });
+        it('Should create & upsert a transactionalEmail', async () => {
+            // WHEN
+            await handler.deploy('testInstance/testBU', ['transactionalEmail']);
+            // THEN
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.transactionalEmail ? Object.keys(result.transactionalEmail).length : 0,
+                2,
+                'two transactionalEmails expected'
+            );
+            // confirm created item
+            assert.deepEqual(
+                await testUtils.getActualJson('testNew_temail', 'transactionalEmail'),
+                await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'post'),
+                'returned JSON was not equal expected for insert transactionalEmail'
+            );
+            // confirm updated item
+            assert.deepEqual(
+                await testUtils.getActualJson('testExisting_temail', 'transactionalEmail'),
+                await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'patch'),
+                'returned JSON was not equal expected for update transactionalEmail'
+            );
+            // check number of API calls
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                13,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+    describe('Templating ================', () => {
+        // it.skip('Should create a transactionalEmail template via retrieveAsTemplate and build it');
+        it('Should create a transactionalEmail template via buildTemplate and build it', async () => {
+            // download first before we test buildTemplate
+            await handler.retrieve('testInstance/testBU', ['transactionalEmail']);
+            // buildTemplate
+            const result = await handler.buildTemplate(
+                'testInstance/testBU',
+                'transactionalEmail',
+                ['testExisting_temail'],
+                'testSourceMarket'
+            );
+            assert.equal(
+                result.transactionalEmail ? Object.keys(result.transactionalEmail).length : 0,
+                1,
+                'only one transactionalEmail expected'
+            );
+            assert.deepEqual(
+                await testUtils.getActualTemplateJson('testExisting_temail', 'transactionalEmail'),
+                await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'template'),
+                'returned template JSON was not equal expected'
+            );
+            // buildDefinition
+            await handler.buildDefinition(
+                'testInstance/testBU',
+                'transactionalEmail',
+                'testExisting_temail',
+                'testTargetMarket'
+            );
+            assert.deepEqual(
+                await testUtils.getActualDeployJson('testExisting_temail', 'transactionalEmail'),
+                await testUtils.getExpectedJson('9999999', 'transactionalEmail', 'build'),
+                'returned deployment JSON was not equal expected'
+            );
+            assert.equal(
+                Object.values(testUtils.getAPIHistory()).flat().length,
+                12,
+                'Unexpected number of requests made'
+            );
+            return;
+        });
+    });
+});