@segment/action-destinations 3.284.0 → 3.285.0

package/dist/destinations/responsys/asyncMergeProfileListMembers/index.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rsp_properties_1 = require("../rsp-properties");
+const rsp_operations_1 = require("../rsp-operations");
+const action = {
+    title: 'Async Merge Profile List Members',
+    description: 'Asynchronous Merge Profile List Members API',
+    fields: {
+        profileListName: {
+            label: 'List Name',
+            description: "Name of the profile extension table's parent profile list.",
+            type: 'string',
+            required: true
+        },
+        userData: rsp_properties_1.userData,
+        mapTemplateName: {
+            label: 'Map Template Name',
+            description: 'The Map Template in Responsys that can be used to map Field Names of the Profile List to Column Names.',
+            type: 'string',
+            default: ''
+        },
+        defaultPermissionStatus: {
+            label: 'Default Permission Status',
+            description: 'This value must be specified as either OPTIN or OPTOUT and would be applied to all of the records contained in the API call. If this value is not explicitly specified, then it is set to OPTOUT.',
+            type: 'string',
+            choices: [
+                { label: 'Opt In', value: 'OPTIN' },
+                { label: 'Opt Out', value: 'OPTOUT' }
+            ],
+            default: 'OPTOUT'
+        },
+        htmlValue: {
+            label: 'Preferred Email Format',
+            description: "Value of incoming preferred email format data. For example, 'H' may represent a preference for HTML formatted email.",
+            type: 'string'
+        },
+        insertOnNoMatch: {
+            label: 'Insert On No Match',
+            description: 'Indicates what should be done for records where a match is not found.',
+            type: 'boolean',
+            default: true
+        },
+        matchColumnName1: {
+            label: 'First Column Match',
+            description: 'First match column for determining whether an insert or update should occur.',
+            type: 'string',
+            choices: [
+                { label: 'RIID_', value: 'RIID_' },
+                { label: 'CUSTOMER_ID_', value: 'CUSTOMER_ID_' },
+                { label: 'EMAIL_ADDRESS_', value: 'EMAIL_ADDRESS_' },
+                { label: 'MOBILE_NUMBER_', value: 'MOBILE_NUMBER_' },
+                { label: 'EMAIL_MD5_HASH_', value: 'EMAIL_MD5_HASH_' },
+                { label: 'EMAIL_SHA256_HASH_', value: 'EMAIL_SHA256_HASH_' }
+            ]
+        },
+        matchColumnName2: {
+            label: 'Second Column Match',
+            description: 'Second match column for determining whether an insert or update should occur.',
+            type: 'string',
+            choices: [
+                { label: 'RIID_', value: 'RIID_' },
+                { label: 'CUSTOMER_ID_', value: 'CUSTOMER_ID_' },
+                { label: 'EMAIL_ADDRESS_', value: 'EMAIL_ADDRESS_' },
+                { label: 'MOBILE_NUMBER_', value: 'MOBILE_NUMBER_' },
+                { label: 'EMAIL_MD5_HASH_', value: 'EMAIL_MD5_HASH_' },
+                { label: 'EMAIL_SHA256_HASH_', value: 'EMAIL_SHA256_HASH_' }
+            ]
+        },
+        matchOperator: {
+            label: 'Match Operator',
+            description: 'Operator to join match column names.',
+            type: 'string',
+            choices: [
+                { label: 'None', value: 'NONE' },
+                { label: 'And', value: 'AND' }
+            ]
+        },
+        optinValue: {
+            label: 'Optin Value',
+            description: "Value of incoming opt-in status data that represents an opt-in status. For example, 'I' may represent an opt-in status.",
+            type: 'string'
+        },
+        optoutValue: {
+            label: 'Optout Value',
+            description: "Value of incoming opt-out status data that represents an optout status. For example, '0' may represent an opt-out status.",
+            type: 'string'
+        },
+        rejectRecordIfChannelEmpty: {
+            label: 'Reject Record If Channel Empty',
+            description: "String containing comma-separated channel codes that if specified will result in record rejection when the channel address field is null. Channel codes are 'E' (Email), 'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has a null for Email or Mobile Number value should be rejected. This parameter can also be set to null or to an empty string, which will cause the validation to not be performed for any channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_. When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty string setting is effectively ignored for that channel.",
+            type: 'string'
+        },
+        textValue: {
+            label: 'Text Value',
+            description: "Value of incoming preferred email format data. For example, 'T' may represent a preference for Text formatted email.",
+            type: 'string'
+        },
+        updateOnMatch: {
+            label: 'Update On Match',
+            description: 'Controls how the existing record should be updated.',
+            type: 'string',
+            required: true,
+            choices: [
+                { label: 'Replace All', value: 'REPLACE_ALL' },
+                { label: 'No Update', value: 'NO_UPDATE' }
+            ]
+        },
+        enable_batching: rsp_properties_1.enable_batching,
+        batch_size: rsp_properties_1.batch_size
+    },
+    perform: async (request, { settings, payload, auth }) => {
+        if (payload && payload.profileListName) {
+            const { profileListName, defaultPermissionStatus, htmlValue, insertOnNoMatch, matchColumnName1, matchColumnName2, matchOperator, optinValue, optoutValue, rejectRecordIfChannelEmpty, textValue, updateOnMatch, userData, mapTemplateName } = payload;
+            const baseUrl = (settings.baseUrl?.startsWith('https://') ? settings.baseUrl : `https://${settings.baseUrl}`)?.replace(/\/$/, '');
+            const endpoint = `${baseUrl}/rest/asyncApi/v1.3/lists/${profileListName}/members`;
+            const recordData = rsp_operations_1.buildRecordData(userData, mapTemplateName ?? '');
+            const requestBody = {
+                recordData: recordData,
+                mergeRule: {
+                    defaultPermissionStatus,
+                    htmlValue,
+                    insertOnNoMatch,
+                    matchColumnName1,
+                    matchColumnName2,
+                    matchOperator,
+                    optinValue,
+                    optoutValue,
+                    rejectRecordIfChannelEmpty,
+                    textValue,
+                    updateOnMatch
+                }
+            };
+            const token = auth?.accessToken ?? '';
+            const response = request(endpoint, {
+                method: 'POST',
+                headers: {
+                    Authorization: token,
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(requestBody)
+            });
+            return response;
+        }
+    },
+    performBatch: async (request, { settings, payload }) => {
+        const { profileListName, defaultPermissionStatus, htmlValue, insertOnNoMatch, matchColumnName1, matchColumnName2, matchOperator, optinValue, optoutValue, rejectRecordIfChannelEmpty, textValue, updateOnMatch, mapTemplateName } = payload[0];
+        const payloadData = payload.map((obj) => obj.userData);
+        const recordData = rsp_operations_1.buildRecordData(payloadData, mapTemplateName ?? '');
+        const requestBody = {
+            recordData: recordData,
+            mergeRule: {
+                defaultPermissionStatus,
+                htmlValue,
+                insertOnNoMatch,
+                matchColumnName1,
+                matchColumnName2,
+                matchOperator,
+                optinValue,
+                optoutValue,
+                rejectRecordIfChannelEmpty,
+                textValue,
+                updateOnMatch
+            }
+        };
+        const baseUrl = (settings.baseUrl?.startsWith('https://') ? settings.baseUrl : `https://${settings.baseUrl}`)?.replace(/\/$/, '');
+        const endpoint = `${baseUrl}/rest/asyncApi/v1.3/lists/${profileListName}/members`;
+        return await request(endpoint, {
+            method: 'POST',
+            body: JSON.stringify(requestBody)
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/responsys/asyncMergeProfileListMembers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/responsys/asyncMergeProfileListMembers/index.ts"],"names":[],"mappings":";;AAGA,sDAAyE;AAGzE,sDAAmD;AAEnD,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kCAAkC;IACzC,WAAW,EAAE,6CAA6C;IAC1D,MAAM,EAAE;QACN,eAAe,EAAE;YACf,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,4DAA4D;YACzE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAE,yBAAQ;QAClB,eAAe,EAAE;YACf,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EACT,wGAAwG;YAC1G,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;SACZ;QACD,uBAAuB,EAAE;YACvB,KAAK,EAAE,2BAA2B;YAClC,WAAW,EACT,mMAAmM;YACrM,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;gBACnC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE;aACtC;YACD,OAAO,EAAE,QAAQ;SAClB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,wBAAwB;YAC/B,WAAW,EACT,sHAAsH;YACxH,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EAAE,uEAAuE;YACpF,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SACd;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EAAE,8EAA8E;YAC3F,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;gBAClC,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,cAAc,EAAE;gBAChD,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,gBAAgB,EAAE;gBACpD,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,gBAAgB,EAAE;gBACpD,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,iBAAiB,EAAE;gBACtD,EAAE,KAAK,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,EAAE;aAC7D;SACF;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,qBAAqB;YAC5B,WAAW,EAAE,+EAA+E;YAC5F,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;gBAClC,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,cAAc,EAAE;gBAChD,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,gBAAgB,EAAE;gBACpD,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,gBAAgB,EAAE;gBACpD,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,iBAAiB,EAAE;gBACtD,EAAE,KAAK,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,EAAE;aAC7D;SACF;QACD,aAAa,EAAE;YACb,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,sCAAsC;YACnD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;aAC/B;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,yHAAyH;YAC3H,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,KAAK,EAAE,cAAc;YACrB,WAAW,EACT,2HAA2H;YAC7H,IAAI,EAAE,QAAQ;SACf;QACD,0BAA0B,EAAE;YAC1B,KAAK,EAAE,gCAAgC;YACvC,WAAW,EACT,wqBAAwqB;YAC1qB,IAAI,EAAE,QAAQ;SACf;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EACT,sHAAsH;YACxH,IAAI,EAAE,QAAQ;SACf;QACD,aAAa,EAAE;YACb,KAAK,EAAE,iBAAiB;YACxB,WAAW,EAAE,qDAAqD;YAClE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE;gBAC9C,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;aAC3C;SACF;QACD,eAAe,EAAE,gCAAe;QAChC,UAAU,EAAE,2BAAU;KACvB;IAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QAKtD,IAAI,OAAO,IAAI,OAAO,CAAC,eAAe,EAAE;YAEtC,MAAM,EACJ,eAAe,EACf,uBAAuB,EACvB,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,WAAW,EACX,0BAA0B,EAC1B,SAAS,EACT,aAAa,EACb,QAAQ,EACR,eAAe,EAChB,GAAG,OAAO,CAAA;YAIX,MAAM,OAAO,GAAG,CACd,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,QAAQ,CAAC,OAAO,EAAE,CAC5F,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;YACrB,MAAM,QAAQ,GAAG,GAAG,OAAO,6BAA6B,eAAe,UAAU,CAAA;YAGjF,MAAM,UAAU,GAAG,gCAAe,CAAC,QAAQ,EAAE,eAAe,IAAI,EAAE,CAAC,CAAA;YAEnE,MAAM,WAAW,GAAgB;gBAC/B,UAAU,EAAE,UAAwB;gBACpC,SAAS,EAAE;oBACT,uBAAuB;oBACvB,SAAS;oBACT,eAAe;oBACf,gBAAgB;oBAChB,gBAAgB;oBAChB,aAAa;oBACb,UAAU;oBACV,WAAW;oBACX,0BAA0B;oBAC1B,SAAS;oBACT,aAAa;iBACd;aACF,CAAA;YAGD,MAAM,KAAK,GAAG,IAAI,EAAE,WAAW,IAAI,EAAE,CAAA;YAIrC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE;gBACjC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;aAClC,CAAC,CAAA;YACF,OAAO,QAAQ,CAAA;SAIhB;IACH,CAAC;IAED,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;QAGrD,MAAM,EACJ,eAAe,EACf,uBAAuB,EACvB,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,WAAW,EACX,0BAA0B,EAC1B,SAAS,EACT,aAAa,EACb,eAAe,EAChB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACd,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACtD,MAAM,UAAU,GAAG,gCAAe,CAAC,WAAW,EAAE,eAAe,IAAI,EAAE,CAAC,CAAA;QACtE,MAAM,WAAW,GAAgB;YAC/B,UAAU,EAAE,UAAwB;YACpC,SAAS,EAAE;gBACT,uBAAuB;gBACvB,SAAS;gBACT,eAAe;gBACf,gBAAgB;gBAChB,gBAAgB;gBAChB,aAAa;gBACb,UAAU;gBACV,WAAW;gBACX,0BAA0B;gBAC1B,SAAS;gBACT,aAAa;aACd;SACF,CAAA;QAKD,MAAM,OAAO,GAAG,CACd,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,QAAQ,CAAC,OAAO,EAAE,CAC5F,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACrB,MAAM,QAAQ,GAAG,GAAG,OAAO,6BAA6B,eAAe,UAAU,CAAA;QAEjF,OAAO,MAAM,OAAO,CAAC,QAAQ,EAAE;YAC7B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;SAClC,CAAC,CAAA;IA0FJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/responsys/rsp-operations.d.ts

@@ -0,0 +1,14 @@
+import { Payload } from './asyncMergePetRecords/generated-types';
+import { DynamicData, RecordData } from './types';
+export declare const buildRecordData: (userData: DynamicData, mapTemplateName: string) => {
+    records: unknown[][];
+    fieldNames: string[];
+    mapTemplateName: string;
+};
+export declare const buildRequestBodyPET: (payload: Payload, recordData: RecordData) => {
+    recordData: RecordData;
+    insertOnNoMatch: boolean | undefined;
+    updateOnMatch: string;
+    matchColumnName1: string;
+    matchColumnName2: string;
+};

package/dist/destinations/responsys/rsp-operations.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildRequestBodyPET = exports.buildRecordData = void 0;
+const buildRecordData = (userData, mapTemplateName) => {
+    if (Array.isArray(userData)) {
+        const keysFromFirstObject = Object.keys(userData[0]);
+        return {
+            records: userData.map((record) => Object.values(record)),
+            fieldNames: keysFromFirstObject,
+            mapTemplateName: mapTemplateName || ''
+        };
+    }
+    const keysFromFirstObject = Object.keys(userData);
+    return {
+        records: [Object.values(userData)],
+        fieldNames: keysFromFirstObject,
+        mapTemplateName: mapTemplateName || ''
+    };
+};
+exports.buildRecordData = buildRecordData;
+const buildRequestBodyPET = (payload, recordData) => {
+    const matchColumnName1 = payload.matchColumnName1 ? String(payload.matchColumnName1) : '';
+    const matchColumnName2 = payload.matchColumnName2 ? String(payload.matchColumnName2) : '';
+    return {
+        recordData: recordData,
+        insertOnNoMatch: payload.insertOnNoMatch,
+        updateOnMatch: payload.updateOnMatch,
+        matchColumnName1: matchColumnName1.replace(/_+$/, ''),
+        matchColumnName2: matchColumnName2.replace(/_+$/, '')
+    };
+};
+exports.buildRequestBodyPET = buildRequestBodyPET;
+//# sourceMappingURL=rsp-operations.js.map

package/dist/destinations/responsys/rsp-operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rsp-operations.js","sourceRoot":"","sources":["../../../src/destinations/responsys/rsp-operations.ts"],"names":[],"mappings":";;;AAGO,MAAM,eAAe,GAAG,CAAC,QAAqB,EAAE,eAAuB,EAAE,EAAE;IAEhF,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3B,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACpD,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACxD,UAAU,EAAE,mBAAmB;YAC/B,eAAe,EAAE,eAAe,IAAI,EAAE;SACvC,CAAA;KACF;IACD,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACjD,OAAO;QACL,OAAO,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClC,UAAU,EAAE,mBAAmB;QAC/B,eAAe,EAAE,eAAe,IAAI,EAAE;KACvC,CAAA;AACH,CAAC,CAAA;AAhBY,QAAA,eAAe,mBAgB3B;AAUM,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,UAAsB,EAAkB,EAAE;IAC9F,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IACzF,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IACzF,OAAO;QACL,UAAU,EAAE,UAAU;QACtB,eAAe,EAAE,OAAO,CAAC,eAAe;QACxC,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,gBAAgB,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;QACrD,gBAAgB,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;KACtD,CAAA;AACH,CAAC,CAAA;AAVY,QAAA,mBAAmB,uBAU/B"}

package/dist/destinations/responsys/rsp-properties.d.ts

@@ -0,0 +1,4 @@
+import { InputField } from '@segment/actions-core/destination-kit/types';
+export declare const userData: InputField;
+export declare const enable_batching: InputField;
+export declare const batch_size: InputField;

package/dist/destinations/responsys/rsp-properties.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.batch_size = exports.enable_batching = exports.userData = void 0;
+exports.userData = {
+    label: 'Recepient Data',
+    description: 'Record data that represents Field Names and corresponding values for the recipient.',
+    type: 'object',
+    defaultObjectUI: 'keyvalue:only',
+    required: true,
+    default: { '@path': '$.' }
+};
+exports.enable_batching = {
+    label: 'Use Responsys Async API',
+    description: 'Once enabled, Segment will collect events into batches of 200 before sending to Responsys.',
+    type: 'boolean',
+    default: true,
+    unsafe_hidden: true
+};
+exports.batch_size = {
+    label: 'Batch Size',
+    description: 'Maximum number of events to include in each batch. Actual batch sizes may be lower.',
+    type: 'number',
+    required: false,
+    unsafe_hidden: true,
+    default: 200
+};
+//# sourceMappingURL=rsp-properties.js.map

package/dist/destinations/responsys/rsp-properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rsp-properties.js","sourceRoot":"","sources":["../../../src/destinations/responsys/rsp-properties.ts"],"names":[],"mappings":";;;AAGa,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,qFAAqF;IAClG,IAAI,EAAE,QAAQ;IACd,eAAe,EAAE,eAAe;IAChC,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;CAC3B,CAAA;AAEY,QAAA,eAAe,GAAe;IACzC,KAAK,EAAE,yBAAyB;IAChC,WAAW,EAAE,4FAA4F;IACzG,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,IAAI;IACb,aAAa,EAAE,IAAI;CACpB,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,qFAAqF;IAClG,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,KAAK;IACf,aAAa,EAAE,IAAI;IACnB,OAAO,EAAE,GAAG;CACb,CAAA"}

package/dist/destinations/snap-conversions-api/_tests_/capiV2tests.d.ts

@@ -0,0 +1 @@
+export declare const capiV2tests: () => void;

package/dist/destinations/snap-conversions-api/_tests_/capiV2tests.js

@@ -0,0 +1,381 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capiV2tests = void 0;
+const nock_1 = __importDefault(require("nock"));
+const actions_core_1 = require("@segment/actions-core");
+const index_1 = __importDefault(require("../index"));
+const testDestination = actions_core_1.createTestIntegration(index_1.default);
+const timestamp = '2022-05-12T15:21:15.449Z';
+const settings = {
+    snap_app_id: 'test123',
+    pixel_id: 'test123',
+    app_id: 'test123'
+};
+const accessToken = 'test123';
+const refreshToken = 'test123';
+const testEvent = actions_core_1.createTestEvent({
+    timestamp: timestamp,
+    messageId: 'test-message-rv4t40s898k',
+    event: 'PURCHASE',
+    type: 'track',
+    properties: {
+        email: 'test123@gmail.com',
+        phone: '+44 844 412 4653',
+        event_tag: 'back-to-school',
+        number_items: 10,
+        revenue: '15',
+        currency: 'USD',
+        level: 3
+    }
+});
+const conversionEventUrl = 'https://tr.snapchat.com/v2/conversion';
+const features = {
+    ['actions-snap-api-migration-test-capiv3']: false,
+    ['actions-snap-api-migration-use-capiv3']: false
+};
+const capiV2tests = () => describe('CAPIv2 Implementation', () => {
+    it('should use products array over number_items, product_id and category fields', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {
+                email: 'test123@gmail.com',
+                phone: '+44 844 412 4653',
+                event_tag: 'back-to-school',
+                number_items: 10,
+                price: '15',
+                currency: 'USD',
+                level: 3,
+                products: [
+                    { product_id: '123', category: 'games', brand: 'Hasbro' },
+                    { product_id: '456', category: 'games', brand: 'Mattel' }
+                ]
+            },
+            context: {}
+        });
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"item_category\\":\\"games;games\\",\\"brands\\":[\\"Hasbro\\",\\"Mattel\\"],\\"item_ids\\":\\"123;456\\",\\"currency\\":\\"USD\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+    it('should handle a basic event', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent(testEvent);
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+    it('should fail web event without pixel_id', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(400, {});
+        const event = actions_core_1.createTestEvent(testEvent);
+        await expect(testDestination.testAction('reportConversionEvent', {
+            event,
+            settings: {
+                app_id: 'test123'
+            },
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        })).rejects.toThrowError('If event conversion type is "WEB" then Pixel ID must be defined');
+    });
+    it('should fail web event without snap_app_id', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(400, {});
+        const event = actions_core_1.createTestEvent(testEvent);
+        await expect(testDestination.testAction('reportConversionEvent', {
+            event,
+            settings: {
+                pixel_id: 'test123',
+                app_id: 'test123'
+            },
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'MOBILE_APP'
+            }
+        })).rejects.toThrowError('If event conversion type is "MOBILE_APP" then Snap App ID and App ID must be defined');
+    });
+    it('should handle an offline event conversion type', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent(testEvent);
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'SAVE',
+                event_conversion_type: 'OFFLINE'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"SAVE\\",\\"event_conversion_type\\":\\"OFFLINE\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+    it('should handle a mobile app event conversion type', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent(testEvent);
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings: {
+                snap_app_id: '123',
+                app_id: '123'
+            },
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'SAVE',
+                event_conversion_type: 'MOBILE_APP'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"SAVE\\",\\"event_conversion_type\\":\\"MOBILE_APP\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"snap_app_id\\":\\"123\\",\\"app_id\\":\\"123\\"}"`);
+    });
+    it('should fail invalid currency', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(400, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {
+                currency: 'Galleon'
+            }
+        });
+        await expect(testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        })).rejects.toThrowError('Galleon is not a valid currency code.');
+    });
+    it('should fail missing event conversion type', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(400, {});
+        const event = actions_core_1.createTestEvent(testEvent);
+        await expect(testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE'
+            }
+        })).rejects.toThrowError("The root value is missing the required field 'event_conversion_type'.");
+    });
+    it('should handle a custom event', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            event: 'CUSTOM_EVENT_5'
+        });
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings: {
+                snap_app_id: '123',
+                app_id: '123'
+            },
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: { '@path': '$.event' },
+                event_conversion_type: 'MOBILE_APP'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"CUSTOM_EVENT_5\\",\\"event_conversion_type\\":\\"MOBILE_APP\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"price\\":15,\\"currency\\":\\"USD\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"snap_app_id\\":\\"123\\",\\"app_id\\":\\"123\\"}"`);
+    });
+    it('should fail event missing all Snap identifiers', async () => {
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {},
+            context: {}
+        });
+        await expect(testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        })).rejects.toThrowError('Payload must contain values for Email or Phone Number or Mobile Ad Identifier or both IP Address and User Agent fields');
+    });
+    it('should handle event with email as only Snap identifier', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {
+                email: 'test123@gmail.com'
+            },
+            context: {}
+        });
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"hashed_email\\":\\"cc779c04191c2e736d89e45c11339c8382832bcaf70383f7df94e3d08ba7a6d9\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+    it('should handle event with phone as only Snap identifier', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {
+                phone: '+44 844 412 4653'
+            },
+            context: {}
+        });
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"hashed_phone_number\\":\\"dc008fda46e2e64002cf2f82a4906236282d431c4f75e5b60bfe79fc48546383\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+    it('should handle event with advertising_id as only Snap identifier', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {},
+            context: {
+                device: {
+                    advertisingId: '87a7def4-b6e9-4bf7-91b6-66372842007a'
+                }
+            }
+        });
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"hashed_mobile_ad_id\\":\\"5af103f270fdc673b5e121ea929d1e47b2cee679e2059226a23c4cba37f8c9a9\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+    it('should handle event with ip and user_agent as only Snap identifiers', async () => {
+        nock_1.default(conversionEventUrl).post('').reply(200, {});
+        const event = actions_core_1.createTestEvent({
+            ...testEvent,
+            properties: {}
+        });
+        const responses = await testDestination.testAction('reportConversionEvent', {
+            event,
+            settings,
+            useDefaultMappings: true,
+            auth: {
+                accessToken,
+                refreshToken
+            },
+            features,
+            mapping: {
+                event_type: 'PURCHASE',
+                event_conversion_type: 'WEB'
+            }
+        });
+        expect(responses).not.toBeNull();
+        expect(responses[0].status).toBe(200);
+        expect(responses[0].options.body).toMatchInlineSnapshot(`"{\\"integration\\":\\"segment\\",\\"event_type\\":\\"PURCHASE\\",\\"event_conversion_type\\":\\"WEB\\",\\"timestamp\\":1652368875449,\\"user_agent\\":\\"Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1\\",\\"hashed_ip_address\\":\\"838c4c2573848f58e74332341a7ca6bc5cd86a8aec7d644137d53b4d597f10f5\\",\\"page_url\\":\\"https://segment.com/academy/\\",\\"pixel_id\\":\\"test123\\"}"`);
+    });
+});
+exports.capiV2tests = capiV2tests;
+//# sourceMappingURL=capiV2tests.js.map