@segment/action-destinations 3.342.1-staging.1 → 3.344.0

package/dist/destinations/surveysparrow/createContact/index.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const action = {
+    title: 'Create or Update Contact in SurveySparrow',
+    defaultSubscription: 'type=identify',
+    description: 'This Action will create a new Contact or update an existing Contact in SurveySparrow. One of Email or Mobile are mandatory when creating a Contact.',
+    fields: {
+        full_name: {
+            label: 'Name',
+            type: 'string',
+            description: 'Full name of the Contact',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.name' },
+                    then: { '@path': '$.properties.name' },
+                    else: { '@path': '$.context.traits.name' }
+                }
+            }
+        },
+        phone: {
+            label: 'Phone',
+            type: 'string',
+            description: 'Non Mobile Phone number for the Contact. This should include + followed by Country Code. For Example, +18004810410',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.phone' },
+                    then: { '@path': '$.properties.phone' },
+                    else: { '@path': '$.context.traits.phone' }
+                }
+            }
+        },
+        mobile: {
+            label: 'Mobile',
+            type: 'string',
+            description: 'Mobile number for the Contact. This should include + followed by Country Code. For Example, +18004810410',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.mobile' },
+                    then: { '@path': '$.properties.mobile' },
+                    else: { '@path': '$.context.traits.mobile' }
+                }
+            }
+        },
+        email: {
+            label: 'Email',
+            type: 'string',
+            format: 'email',
+            description: 'Email Address for the Contact',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.email' },
+                    then: { '@path': '$.properties.email' },
+                    else: { '@path': '$.context.traits.email' }
+                }
+            }
+        },
+        job_title: {
+            label: 'Job Title',
+            type: 'string',
+            description: 'Job Title for the Contact',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.job_title' },
+                    then: { '@path': '$.properties.job_title' },
+                    else: { '@path': '$.context.traits.job_title' }
+                }
+            }
+        },
+        custom_fields: {
+            label: 'Custom Contact Properties',
+            type: 'object',
+            defaultObjectUI: 'keyvalue',
+            description: 'Key:Value Custom Properties to be added to the Contact in SurveySparrow. [Contact Property](https://support.surveysparrow.com/hc/en-us/articles/7078996288925-How-to-add-custom-properties-to-your-contact) should be created in SurveySparrow in advance.',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.custom_fields' },
+                    then: { '@path': '$.properties.custom_fields' },
+                    else: { '@path': '$.context.traits.custom_fields' }
+                }
+            }
+        }
+    },
+    perform: (request, { payload }) => {
+        if (payload.email || payload.mobile) {
+            const transformedPayload = {
+                full_name: payload.full_name,
+                phone: payload.phone,
+                mobile: payload.mobile,
+                email: payload.email,
+                job_title: payload.job_title,
+                ...payload.custom_fields
+            };
+            return request('https://api.surveysparrow.com/v3/contacts', {
+                method: 'post',
+                json: transformedPayload
+            });
+        }
+        else {
+            throw new actions_core_1.PayloadValidationError('Either Email or Mobile are required');
+        }
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/surveysparrow/createContact/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/surveysparrow/createContact/index.ts"],"names":[],"mappings":";;AAAA,wDAAgF;AAIhF,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,2CAA2C;IAClD,mBAAmB,EAAE,eAAe;IACpC,WAAW,EACT,qJAAqJ;IACvJ,MAAM,EAAE;QACN,SAAS,EAAE;YACT,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,0BAA0B;YACvC,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;oBACtC,IAAI,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;iBAC3C;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,oHAAoH;YACtH,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;iBAC5C;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,0GAA0G;YAC5G,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;iBAC7C;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,+BAA+B;YAC5C,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;iBAC5C;aACF;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2BAA2B;YACxC,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;oBAC7C,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;oBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE;iBAChD;aACF;SACF;QACD,aAAa,EAAE;YACb,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,QAAQ;YACd,eAAe,EAAE,UAAU;YAC3B,WAAW,EACT,4PAA4P;YAC9P,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE;oBACjD,IAAI,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE;oBAC/C,IAAI,EAAE,EAAE,OAAO,EAAE,gCAAgC,EAAE;iBACpD;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE;YACnC,MAAM,kBAAkB,GAAG;gBACzB,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,GAAG,OAAO,CAAC,aAAa;aACzB,CAAA;YACD,OAAO,OAAO,CAAC,2CAA2C,EAAE;gBAC1D,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,kBAAkB;aACzB,CAAC,CAAA;SACH;aAAM;YACL,MAAM,IAAI,qCAAsB,CAAC,qCAAqC,CAAC,CAAA;SACxE;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/surveysparrow/generated-types.d.ts

@@ -0,0 +1,3 @@
+export interface Settings {
+    apiToken: string;
+}

package/dist/destinations/surveysparrow/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/surveysparrow/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/destinations/surveysparrow/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/surveysparrow/index.d.ts

@@ -0,0 +1,4 @@
+import type { DestinationDefinition } from '@segment/actions-core';
+import type { Settings } from './generated-types';
+declare const destination: DestinationDefinition<Settings>;
+export default destination;

package/dist/destinations/surveysparrow/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const createContact_1 = __importDefault(require("./createContact"));
+const triggerSurvey_1 = __importDefault(require("./triggerSurvey"));
+const destination = {
+    name: 'Surveysparrow',
+    slug: 'actions-surveysparrow',
+    mode: 'cloud',
+    description: 'Trigger Surveys and Create Contacts in SurveySparrow',
+    authentication: {
+        scheme: 'custom',
+        fields: {
+            apiToken: {
+                label: 'Access Token',
+                description: 'SurveySparrow Access Token can be found in Settings > Apps and Integrations > Create a Custom app',
+                type: 'password',
+                required: true
+            }
+        },
+        testAuthentication: (request) => {
+            return request(`https://api.surveysparrow.com/v3/users`, {
+                method: 'get'
+            });
+        }
+    },
+    extendRequest({ settings }) {
+        return {
+            headers: { Authorization: `Bearer ${settings.apiToken}` }
+        };
+    },
+    actions: {
+        createContact: createContact_1.default,
+        triggerSurvey: triggerSurvey_1.default
+    }
+};
+exports.default = destination;
+//# sourceMappingURL=index.js.map

package/dist/destinations/surveysparrow/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/surveysparrow/index.ts"],"names":[],"mappings":";;;;;AAGA,oEAA2C;AAE3C,oEAA2C;AAE3C,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,sDAAsD;IAEnE,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,QAAQ,EAAE;gBACR,KAAK,EAAE,cAAc;gBACrB,WAAW,EACT,mGAAmG;gBACrG,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE;YAC9B,OAAO,OAAO,CAAC,wCAAwC,EAAE;gBACvD,MAAM,EAAE,KAAK;aACd,CAAC,CAAA;QACJ,CAAC;KACF;IACD,aAAa,CAAC,EAAE,QAAQ,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,QAAQ,CAAC,QAAQ,EAAE,EAAE;SAC1D,CAAA;IACH,CAAC;IAED,OAAO,EAAE;QACP,aAAa,EAAb,uBAAa;QACb,aAAa,EAAb,uBAAa;KACd;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/surveysparrow/triggerSurvey/generated-types.d.ts

@@ -0,0 +1,10 @@
+export interface Payload {
+    id: number;
+    share_type: string;
+    survey_id: number;
+    mobile?: string;
+    email?: string;
+    variables?: {
+        [k: string]: unknown;
+    };
+}

package/dist/destinations/surveysparrow/triggerSurvey/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/surveysparrow/triggerSurvey/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../src/destinations/surveysparrow/triggerSurvey/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/surveysparrow/triggerSurvey/index.d.ts

@@ -0,0 +1,8 @@
+import type { ActionDefinition } from '@segment/actions-core';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+import { DynamicFieldResponse } from '@segment/actions-core';
+import { RequestClient } from '@segment/actions-core';
+export declare function getSurveys(request: RequestClient): Promise<DynamicFieldResponse>;
+declare const action: ActionDefinition<Settings, Payload>;
+export default action;

package/dist/destinations/surveysparrow/triggerSurvey/index.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSurveys = void 0;
+const actions_core_1 = require("@segment/actions-core");
+async function getSurveys(request) {
+    const choices = [];
+    try {
+        let has_next_page = false;
+        let page = 1;
+        do {
+            const response = await request(`https://api.surveysparrow.com/v3/surveys?page=${page}`, {
+                method: 'get'
+            });
+            const data = JSON.parse(response.content);
+            const surveys = data.data;
+            for (const survey of surveys) {
+                choices.push({
+                    label: `${survey.name}`,
+                    value: survey.id
+                });
+            }
+            page++;
+            has_next_page = data.has_next_page;
+        } while (has_next_page);
+    }
+    catch (err) {
+        return getError(err);
+    }
+    return {
+        choices
+    };
+}
+exports.getSurveys = getSurveys;
+async function getError(err) {
+    const errResponse = err?.response;
+    const errorBody = await errResponse.json();
+    return {
+        choices: [],
+        error: {
+            message: errorBody?.meta?.error?.errorMessage ?? 'Unknown Error',
+            code: errResponse?.status.toString() ?? '500'
+        }
+    };
+}
+const action = {
+    title: 'Trigger Survey in SurveySparrow',
+    defaultSubscription: 'type=track and event="Trigger Survey"',
+    description: 'This Action will trigger a SurveySparrow survey to a user via Email, SMS or WhatsApp. The [Survey](https://support.surveysparrow.com/hc/en-us/articles/7079412445213-How-to-create-surveys-using-SurveySparrow) and required Share [Channel](https://support.surveysparrow.com/hc/en-us/articles/7078359450269-How-to-share-surveys-across-different-channels) should be created in SurveySparrow.',
+    fields: {
+        id: {
+            label: 'Channel ID',
+            type: 'number',
+            required: true,
+            description: 'Channel ID is the unique identifier for the Share Channel in SurveySparrow. This can be copied from the URL.',
+            default: {
+                '@path': '$.properties.channel_id'
+            }
+        },
+        share_type: {
+            label: 'Share Type',
+            type: 'string',
+            required: true,
+            description: 'Type of Survey Share to be triggered',
+            choices: [
+                {
+                    label: 'Email',
+                    value: 'Email'
+                },
+                {
+                    label: 'SMS',
+                    value: 'SMS'
+                },
+                {
+                    label: 'WhatsApp',
+                    value: 'WhatsApp'
+                }
+            ],
+            default: {
+                '@path': '$.properties.share_type'
+            }
+        },
+        survey_id: {
+            label: 'Survey',
+            type: 'number',
+            required: true,
+            description: 'Select the SurveySparrow Survey you want to trigger',
+            dynamic: true,
+            default: {
+                '@path': '$.properties.survey_id'
+            }
+        },
+        mobile: {
+            label: 'Mobile',
+            type: 'string',
+            description: 'Mobile number to send Survey to for either SMS or WhatsApp. This should include + followed by Country Code. For Example, +18004810410. Mobile is required for SMS or WhatsApp Shares',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.mobile' },
+                    then: { '@path': '$.properties.mobile' },
+                    else: { '@path': '$.context.traits.mobile' }
+                }
+            }
+        },
+        email: {
+            label: 'Email',
+            type: 'string',
+            format: 'email',
+            description: 'Email address to send Survey to. This is required for an Email Share.',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.email' },
+                    then: { '@path': '$.properties.email' },
+                    else: { '@path': '$.context.traits.email' }
+                }
+            }
+        },
+        variables: {
+            label: 'Variables',
+            type: 'object',
+            defaultObjectUI: 'keyvalue',
+            description: 'Variables you want to pass to SurveySparrow.',
+            default: {
+                '@path': '$.properties.variables'
+            }
+        }
+    },
+    dynamicFields: {
+        survey_id: getSurveys
+    },
+    perform: (request, data) => {
+        switch (data.payload.share_type) {
+            case 'Email': {
+                if (!data.payload.email) {
+                    throw new actions_core_1.PayloadValidationError('Email is a Required Field Email Shares');
+                }
+                else
+                    break;
+            }
+            case 'SMS':
+            case 'WhatsApp': {
+                if (!data.payload.mobile) {
+                    throw new actions_core_1.PayloadValidationError(`Mobile is a Required Field for ${data.payload.share_type} Shares`);
+                }
+                else
+                    break;
+            }
+        }
+        const payload = {
+            survey_id: data.payload.survey_id,
+            contacts: [
+                {
+                    email: data.payload.email,
+                    mobile: data.payload.mobile
+                }
+            ],
+            variables: data.payload.variables
+        };
+        return request(`https://api.surveysparrow.com/v3/channels/${data.payload.id}`, {
+            method: 'put',
+            json: payload
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/surveysparrow/triggerSurvey/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/surveysparrow/triggerSurvey/index.ts"],"names":[],"mappings":";;;AAIA,wDAA6E;AAGtE,KAAK,UAAU,UAAU,CAAC,OAAsB;IACrD,MAAM,OAAO,GAAuB,EAAE,CAAA;IACtC,IAAI;QACF,IAAI,aAAa,GAAG,KAAK,CAAA;QACzB,IAAI,IAAI,GAAG,CAAC,CAAA;QACZ,GAAG;YACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,iDAAiD,IAAI,EAAE,EAAE;gBACtF,MAAM,EAAE,KAAK;aACd,CAAC,CAAA;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YACzC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAA;YACzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE;oBACvB,KAAK,EAAE,MAAM,CAAC,EAAE;iBACjB,CAAC,CAAA;aACH;YACD,IAAI,EAAE,CAAA;YACN,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;SACnC,QAAQ,aAAa,EAAC;KACxB;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;KACrB;IACD,OAAO;QACL,OAAO;KACR,CAAA;AACH,CAAC;AA1BD,gCA0BC;AAED,KAAK,UAAU,QAAQ,CAAC,GAAY;IAClC,MAAM,WAAW,GAAI,GAAiB,EAAE,QAAQ,CAAA;IAChD,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAC1C,OAAO;QACL,OAAO,EAAE,EAAE;QACX,KAAK,EAAE;YACL,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,IAAI,eAAe;YAChE,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,KAAK;SAC9C;KACF,CAAA;AACH,CAAC;AAED,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,iCAAiC;IACxC,mBAAmB,EAAE,uCAAuC;IAC5D,WAAW,EACT,oYAAoY;IACtY,MAAM,EAAE;QACN,EAAE,EAAE;YACF,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,8GAA8G;YAChH,OAAO,EAAE;gBACP,OAAO,EAAE,yBAAyB;aACnC;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE;gBACP;oBACE,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,OAAO;iBACf;gBACD;oBACE,KAAK,EAAE,KAAK;oBACZ,KAAK,EAAE,KAAK;iBACb;gBACD;oBACE,KAAK,EAAE,UAAU;oBACjB,KAAK,EAAE,UAAU;iBAClB;aACF;YACD,OAAO,EAAE;gBACP,OAAO,EAAE,yBAAyB;aACnC;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qDAAqD;YAClE,OAAO,EAAE,IAAI;YACb,OAAO,EAAE;gBACP,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,sLAAsL;YACxL,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;iBAC7C;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,WAAW,EAAE,uEAAuE;YACpF,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;iBAC5C;aACF;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,QAAQ;YACd,eAAe,EAAE,UAAU;YAC3B,WAAW,EAAE,8CAA8C;YAC3D,OAAO,EAAE;gBACP,OAAO,EAAE,wBAAwB;aAClC;SACF;KACF;IACD,aAAa,EAAE;QACb,SAAS,EAAE,UAAU;KACtB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;QACzB,QAAQ,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC/B,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBACvB,MAAM,IAAI,qCAAsB,CAAC,wCAAwC,CAAC,CAAA;iBAC3E;;oBAAM,MAAK;aACb;YACD,KAAK,KAAK,CAAC;YACX,KAAK,UAAU,CAAC,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;oBACxB,MAAM,IAAI,qCAAsB,CAAC,kCAAkC,IAAI,CAAC,OAAO,CAAC,UAAU,SAAS,CAAC,CAAA;iBACrG;;oBAAM,MAAK;aACb;SACF;QAED,MAAM,OAAO,GAAG;YACd,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;YACjC,QAAQ,EAAE;gBACR;oBACE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;oBACzB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;iBAC5B;aACF;YACD,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;SAClC,CAAA;QAED,OAAO,OAAO,CAAC,6CAA6C,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE;YAC7E,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,OAAO;SACd,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/taboola-actions/generated-types.d.ts

@@ -0,0 +1,9 @@
+export interface Settings {
+    client_id: string;
+    client_secret: string;
+}
+export interface AudienceSettings {
+    account_id: string;
+    ttl_in_hours?: number;
+    exclude_from_campaigns?: boolean;
+}

package/dist/destinations/taboola-actions/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/taboola-actions/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/destinations/taboola-actions/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/taboola-actions/index.d.ts

@@ -0,0 +1,4 @@
+import type { AudienceDestinationDefinition } from '@segment/actions-core';
+import type { Settings, AudienceSettings } from './generated-types';
+declare const destination: AudienceDestinationDefinition<Settings, AudienceSettings>;
+export default destination;

package/dist/destinations/taboola-actions/index.js

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const client_1 = require("./syncAudience/client");
+const syncAudience_1 = __importDefault(require("./syncAudience"));
+const destination = {
+    name: 'Taboola (Actions)',
+    slug: 'actions-taboola-actions',
+    mode: 'cloud',
+    authentication: {
+        scheme: 'oauth2',
+        fields: {
+            client_id: {
+                label: 'Client ID',
+                description: 'The client ID from your Taboola account.',
+                type: 'string',
+                required: true
+            },
+            client_secret: {
+                label: 'Client Secret',
+                description: "The client's secret from your Taboola account.",
+                type: 'string',
+                required: true
+            }
+        },
+        refreshAccessToken: async (request, { settings }) => {
+            return await client_1.TaboolaClient.refreshAccessToken(request, settings);
+        }
+    },
+    extendRequest({ auth }) {
+        return {
+            headers: {
+                authorization: `Bearer ${auth?.accessToken}`,
+                'Content-Type': 'application/json'
+            }
+        };
+    },
+    audienceFields: {
+        account_id: {
+            type: 'string',
+            label: 'Account ID',
+            required: true,
+            description: 'The alphabetic ID for the Taboola Account to sync to.'
+        },
+        ttl_in_hours: {
+            type: 'number',
+            label: 'TTL in Hours',
+            required: false,
+            description: 'The time for which a given user will belong to this audience in hours.',
+            default: 8760
+        },
+        exclude_from_campaigns: {
+            type: 'boolean',
+            label: 'Exclude from Campaigns',
+            required: false,
+            description: 'Whether to exclude the audience from campaigns.',
+            default: false
+        }
+    },
+    audienceConfig: {
+        mode: {
+            type: 'synced',
+            full_audience_sync: false
+        },
+        async createAudience(request, createAudienceInput) {
+            const audienceName = createAudienceInput.audienceName;
+            const ttlInHours = createAudienceInput.audienceSettings?.ttl_in_hours;
+            const excludeFromCampaigns = createAudienceInput.audienceSettings?.exclude_from_campaigns;
+            const accountId = createAudienceInput.audienceSettings?.account_id;
+            if (!audienceName) {
+                throw new actions_core_1.IntegrationError("Missing 'Audience Name' value", 'MISSING_REQUIRED_FIELD', 400);
+            }
+            if (!accountId) {
+                throw new actions_core_1.IntegrationError("Missing 'Account ID' value", 'MISSING_REQUIRED_FIELD', 400);
+            }
+            try {
+                const accessToken = (await client_1.TaboolaClient.refreshAccessToken(request, createAudienceInput.settings)).accessToken;
+                const response = await request(`https://backstage.taboola.com/backstage/api/1.0/${accountId}/audience_onboarding/create`, {
+                    method: 'post',
+                    json: {
+                        audience_name: audienceName,
+                        ttl_in_hours: ttlInHours,
+                        exclude_from_campaigns: excludeFromCampaigns
+                    },
+                    headers: {
+                        authorization: `Bearer ${accessToken}`,
+                        'Content-Type': 'application/json'
+                    }
+                });
+                const json = await response.json();
+                if (!json?.audience_id) {
+                    throw new actions_core_1.IntegrationError(`Failed to create Audience in Taboola - responseData.audience_id null or undefined`, 'AUDIENCE_CREATION_FAILED', 400);
+                }
+                return {
+                    externalId: String(json?.audience_id)
+                };
+            }
+            catch (error) {
+                const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                throw new actions_core_1.IntegrationError(`Failed to create Audience in Taboola ${errorMessage}`, 'AUDIENCE_CREATION_FAILED', 400);
+            }
+        },
+        async getAudience(_, getAudienceInput) {
+            const audience_id = getAudienceInput.externalId;
+            if (!audience_id) {
+                throw new actions_core_1.IntegrationError('Missing audience_id value', 'MISSING_REQUIRED_FIELD', 400);
+            }
+            return { externalId: audience_id };
+        }
+    },
+    actions: {
+        syncAudience: syncAudience_1.default
+    }
+};
+exports.default = destination;
+//# sourceMappingURL=index.js.map

package/dist/destinations/taboola-actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/taboola-actions/index.ts"],"names":[],"mappings":";;;;;AAEA,wDAAwD;AACxD,kDAAqD;AAErD,kEAAyC;AAEzC,MAAM,WAAW,GAA8D;IAC7E,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,yBAAyB;IAC/B,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,SAAS,EAAE;gBACT,KAAK,EAAE,WAAW;gBAClB,WAAW,EAAE,0CAA0C;gBACvD,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,aAAa,EAAE;gBACb,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,gDAAgD;gBAC7D,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAClD,OAAO,MAAM,sBAAa,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QAClE,CAAC;KACF;IACD,aAAa,CAAC,EAAE,IAAI,EAAE;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;gBAC5C,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;IACH,CAAC;IACD,cAAc,EAAE;QACd,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,YAAY;YACnB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,uDAAuD;SACrE;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,cAAc;YACrB,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,wEAAwE;YACrF,OAAO,EAAE,IAAI;SACd;QACD,sBAAsB,EAAE;YACtB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,wBAAwB;YAC/B,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,iDAAiD;YAC9D,OAAO,EAAE,KAAK;SACf;KACF;IACD,cAAc,EAAE;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,kBAAkB,EAAE,KAAK;SAC1B;QACD,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,mBAAmB;YAC/C,MAAM,YAAY,GAAG,mBAAmB,CAAC,YAAY,CAAA;YACrD,MAAM,UAAU,GAAG,mBAAmB,CAAC,gBAAgB,EAAE,YAAY,CAAA;YACrE,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,gBAAgB,EAAE,sBAAsB,CAAA;YACzF,MAAM,SAAS,GAAG,mBAAmB,CAAC,gBAAgB,EAAE,UAAU,CAAA;YAElE,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,+BAAgB,CAAC,+BAA+B,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;aAC3F;YAED,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,+BAAgB,CAAC,4BAA4B,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;aACxF;YAED,IAAI;gBACF,MAAM,WAAW,GAAG,CAAC,MAAM,sBAAa,CAAC,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAA;gBAE/G,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC5B,mDAAmD,SAAS,6BAA6B,EACzF;oBACE,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE;wBACJ,aAAa,EAAE,YAAY;wBAC3B,YAAY,EAAE,UAAU;wBACxB,sBAAsB,EAAE,oBAAoB;qBAC7C;oBACD,OAAO,EAAE;wBACP,aAAa,EAAE,UAAU,WAAW,EAAE;wBACtC,cAAc,EAAE,kBAAkB;qBACnC;iBACF,CACF,CAAA;gBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;gBAElC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE;oBACtB,MAAM,IAAI,+BAAgB,CACxB,mFAAmF,EACnF,0BAA0B,EAC1B,GAAG,CACJ,CAAA;iBACF;gBAED,OAAO;oBACL,UAAU,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC;iBACtC,CAAA;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAA;gBAC7E,MAAM,IAAI,+BAAgB,CACxB,wCAAwC,YAAY,EAAE,EACtD,0BAA0B,EAC1B,GAAG,CACJ,CAAA;aACF;QACH,CAAC;QACD,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,gBAAgB;YACnC,MAAM,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAA;YAC/C,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,+BAAgB,CAAC,2BAA2B,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAA;aACvF;YACD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAA;QACpC,CAAC;KACF;IACD,OAAO,EAAE;QACP,YAAY,EAAZ,sBAAY;KACb;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/taboola-actions/syncAudience/client.d.ts

@@ -0,0 +1,25 @@
+import type { ModifiedResponse } from '@segment/actions-core';
+import { RequestClient } from '@segment/actions-core';
+import { Payload } from './generated-types';
+import { AudienceSettings, Settings } from '../generated-types';
+interface ClusterItem {
+    user_id: string;
+    type: string;
+    is_hashed: boolean;
+}
+declare type Cluster = {
+    cluster: ClusterItem[];
+} | null;
+export declare class TaboolaClient {
+    request: RequestClient;
+    payloads: Payload[];
+    audienceSettings?: AudienceSettings;
+    constructor(request: RequestClient, payloads: Payload[], audienceSettings?: AudienceSettings);
+    static refreshAccessToken(request: RequestClient, settings: Settings): Promise<{
+        accessToken: string;
+    }>;
+    sendToTaboola(): Promise<ModifiedResponse<Response>[]>;
+    hashEmail(email: string): string;
+    createCluster(payload: Payload): Cluster;
+}
+export {};

package/dist/destinations/taboola-actions/syncAudience/client.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaboolaClient = void 0;
+const crypto_1 = require("crypto");
+const actions_core_1 = require("@segment/actions-core");
+class TaboolaClient {
+    constructor(request, payloads, audienceSettings) {
+        this.request = request;
+        this.payloads = payloads;
+        this.audienceSettings = audienceSettings;
+        if (!this.audienceSettings) {
+            throw new actions_core_1.IntegrationError('Bad Request: no audienceSettings found.', 'INVALID_REQUEST_DATA', 400);
+        }
+        if (!this.audienceSettings.account_id) {
+            throw new actions_core_1.IntegrationError('Bad Request: no audienceSettings.account_id found.', 'INVALID_REQUEST_DATA', 400);
+        }
+    }
+    static async refreshAccessToken(request, settings) {
+        const res = await request('https://backstage.taboola.com/backstage/oauth/token', {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            },
+            body: String(new URLSearchParams({
+                client_id: settings.client_id,
+                client_secret: settings.client_secret,
+                grant_type: 'client_credentials'
+            }))
+        });
+        return { accessToken: res.data.access_token };
+    }
+    async sendToTaboola() {
+        this.payloads.forEach((payload) => {
+            payload.action = payload.traits_or_props[payload.segment_computation_key] ? 'ADD' : 'REMOVE';
+        });
+        const actionMap = new Map();
+        this.payloads.forEach((payload) => {
+            if (!actionMap.has(payload.action)) {
+                actionMap.set(payload.action, new Map());
+            }
+            const audienceMap = actionMap.get(payload.action);
+            if (!audienceMap.has(payload.external_audience_id)) {
+                audienceMap.set(payload.external_audience_id, []);
+            }
+            audienceMap.get(payload.external_audience_id)?.push(payload);
+        });
+        const taboolaRequests = [];
+        actionMap.forEach((audienceMap, action) => {
+            audienceMap.forEach((payloads, external_audience_id) => {
+                const identities = payloads.map((payload) => this.createCluster(payload)).filter((cluster) => cluster !== null);
+                if (identities.length > 0) {
+                    taboolaRequests.push(this.request(`https://backstage.taboola.com/backstage/api/1.0/${this.audienceSettings?.account_id}/audience_onboarding`, {
+                        method: 'POST',
+                        json: {
+                            operation: action,
+                            audience_id: Number(external_audience_id),
+                            identities
+                        }
+                    }));
+                }
+            });
+        });
+        if (taboolaRequests.length === 0) {
+            throw new actions_core_1.IntegrationError('No valid payloads found to sync.', 'INVALID_REQUEST_DATA', 400);
+        }
+        return await Promise.all(taboolaRequests);
+    }
+    hashEmail(email) {
+        const sha256HashedRegex = /^[a-f0-9]{64}$/i;
+        const isSHA256Hash = sha256HashedRegex.test(email);
+        if (!isSHA256Hash) {
+            email = crypto_1.createHash('sha256').update(email).digest('hex');
+        }
+        return email;
+    }
+    createCluster(payload) {
+        if (!payload.user_email && !payload.device_id) {
+            return null;
+        }
+        let email = payload.user_email;
+        const cluster = [];
+        if (email) {
+            email = this.hashEmail(email);
+            cluster.push({
+                user_id: email,
+                type: 'EMAIL_ID',
+                is_hashed: true
+            });
+        }
+        if (payload.device_id) {
+            cluster.push({
+                user_id: payload.device_id,
+                type: 'DEVICE_ID',
+                is_hashed: false
+            });
+        }
+        return { cluster };
+    }
+}
+exports.TaboolaClient = TaboolaClient;
+//# sourceMappingURL=client.js.map