Feature/60: basic retrieve-support for deliveryProfile

lib/MetadataTypeDefinitions.js

@@ -11,6 +11,7 @@ import dataExtensionField from './metadataTypes/definitions/DataExtensionField.d
 import dataExtensionTemplate from './metadataTypes/definitions/DataExtensionTemplate.definition.js';
 import dataExtract from './metadataTypes/definitions/DataExtract.definition.js';
 import dataExtractType from './metadataTypes/definitions/DataExtractType.definition.js';
+import deliveryProfile from './metadataTypes/definitions/DeliveryProfile.definition.js';
 import discovery from './metadataTypes/definitions/Discovery.definition.js';
 import email from './metadataTypes/definitions/Email.definition.js';
 import emailSend from './metadataTypes/definitions/EmailSend.definition.js';
@@ -53,6 +54,7 @@ export default {
  dataExtensionTemplate,
  dataExtract,
  dataExtractType,
+ deliveryProfile,
  discovery,
  email,
  emailSend,

lib/MetadataTypeInfo.js

@@ -11,6 +11,7 @@ import dataExtensionField from './metadataTypes/DataExtensionField.js';
 import dataExtensionTemplate from './metadataTypes/DataExtensionTemplate.js';
 import dataExtract from './metadataTypes/DataExtract.js';
 import dataExtractType from './metadataTypes/DataExtractType.js';
+import deliveryProfile from './metadataTypes/DeliveryProfile.js';
 import discovery from './metadataTypes/Discovery.js';
 import email from './metadataTypes/Email.js';
 import emailSend from './metadataTypes/EmailSend.js';
@@ -52,6 +53,7 @@ export default {
  dataExtensionTemplate,
  dataExtract,
  dataExtractType,
+ deliveryProfile,
  discovery,
  email,
  emailSend,

lib/metadataTypes/DeliveryProfile.js

@@ -0,0 +1,47 @@
+'use strict';
+
+import MetadataType from './MetadataType.js';
+
+/**
+ * @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../../types/mcdev.d.js').TemplateMap} TemplateMap
+ */
+
+/**
+ * DeliveryProfile MetadataType
+ *
+ * @augments MetadataType
+ */
+class DeliveryProfile extends MetadataType {
+ /**
+ * Retrieves SOAP based metadata of metadata type into local filesystem. executes callback with retrieved metadata
+ *
+ * @param {string} retrieveDir Directory where retrieved metadata directory will be saved
+ * @param {void | string[]} [_] not used
+ * @param {void | string[]} [__] unused parameter
+ * @param {string} [key] customer key of single item to retrieve
+ * @returns {Promise.<MetadataTypeMapObj>} Promise of metadata
+ */
+ static retrieve(retrieveDir, _, __, key) {
+ return super.retrieveREST(
+ retrieveDir,
+ '/legacy/v1/beta/messaging/deliverypolicy/',
+ null,
+ key
+ );
+ }
+}
+
+// Assign definition to static attributes
+import MetadataTypeDefinitions from '../MetadataTypeDefinitions.js';
+DeliveryProfile.definition = MetadataTypeDefinitions.deliveryProfile;
+
+export default DeliveryProfile;

lib/metadataTypes/definitions/DeliveryProfile.definition.js

@@ -0,0 +1,57 @@
+export default {
+ bodyIteratorField: 'entry',
+ dependencies: [],
+ filter: {},
+ hasExtended: false,
+ idField: 'id',
+ keyField: 'key',
+ nameField: 'name',
+ createdDateField: 'createdDate',
+ createdNameField: null,
+ lastmodDateField: 'lastUpdated',
+ lastmodNameField: null,
+ restPagination: false,
+ type: 'deliveryProfile',
+ typeDescription:
+ 'Delivery profiles specify details such as IP address, domain, header inclusion, and footer; Via API we can only check for their existence but not see any details.',
+ typeRetrieveByDefault: false,
+ typeName: 'Delivery Profile',
+ fields: {
+ id: {
+ isCreateable: false,
+ isUpdateable: false,
+ retrieving: true,
+ template: false,
+ },
+ key: {
+ isCreateable: true,
+ isUpdateable: true,
+ retrieving: true,
+ template: true,
+ },
+ name: {
+ isCreateable: true,
+ isUpdateable: true,
+ retrieving: true,
+ template: true,
+ },
+ description: {
+ isCreateable: true,
+ isUpdateable: true,
+ retrieving: true,
+ template: true,
+ },
+ createdDate: {
+ isCreateable: false,
+ isUpdateable: false,
+ retrieving: true,
+ template: false,
+ },
+ lastUpdated: {
+ isCreateable: false,
+ isUpdateable: false,
+ retrieving: true,
+ template: false,
+ },
+ },
+};

test/resources/9999999/deliveryProfile/get-expected.json

@@ -0,0 +1,7 @@
+{
+ "key": "Default",
+ "createdDate": "2021-06-21T17:55:00Z",
+ "lastUpdated": "2021-06-21T17:55:00Z",
+ "name": "Default",
+ "description": "Account defaults"
+}

test/resources/9999999/legacy/v1/beta/messaging/deliverypolicy/get-response.json

@@ -0,0 +1,15 @@
+{
+ "startIndex": 0,
+ "itemsPerPage": 50,
+ "totalResults": 1,
+ "entry": [
+ {
+ "id": "ejQ1Y2Q5SzVFZXU0UHZRRFE4bFptQTo0ODow",
+ "key": "Default",
+ "createdDate": "2021-06-21T17:55:00Z",
+ "lastUpdated": "2021-06-21T17:55:00Z",
+ "name": "Default",
+ "description": "Account defaults"
+ }
+ ]
+}

test/type.deliveryProfile.test.js

@@ -0,0 +1,45 @@
+import * as chai from 'chai';
+const assert = chai.assert;
+
+import chaiFiles from 'chai-files';
+import cache from '../lib/util/cache.js';
+import * as testUtils from './utils.js';
+import handler from '../lib/index.js';
+chai.use(chaiFiles);
+
+describe('type: deliveryProfile', () => {
+ beforeEach(() => {
+ testUtils.mockSetup();
+ });
+
+ afterEach(() => {
+ testUtils.mockReset();
+ });
+
+ describe('Retrieve ================', () => {
+ it('Should retrieve a deliveryProfile', async () => {
+ // WHEN
+ await handler.retrieve('testInstance/testBU', ['deliveryProfile']);
+ // THEN
+ assert.equal(process.exitCode, 0, 'retrieve should not have thrown an error');
+ // get results from cache
+ const result = cache.getCache();
+ assert.equal(
+ result.deliveryProfile ? Object.keys(result.deliveryProfile).length : 0,
+ 1,
+ 'only one deliveryProfile expected'
+ );
+ assert.deepEqual(
+ await testUtils.getActualJson('Default', 'deliveryProfile'),
+ await testUtils.getExpectedJson('9999999', 'deliveryProfile', 'get'),
+ 'returned JSON was not equal expected'
+ );
+ assert.equal(
+ testUtils.getAPIHistoryLength(),
+ 1,
+ 'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+ );
+ return;
+ });
+ });
+});