@segment/action-destinations 3.146.0 → 3.148.0

package/dist/destinations/pinterest-conversions/reportConversionEvent/index.js

@@ -1,11 +1,211 @@
 "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 constants_1 = require("../constants");
+const pinterest_capi_custom_data_1 = require("../pinterest-capi-custom-data");
+const pinterset_capi_user_data_1 = require("../pinterset-capi-user-data");
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const dayjs_1 = __importDefault(require("../../../lib/dayjs"));
 const action = {
     title: 'Report Conversion Event',
     description: 'TODO',
-    fields: {},
-    perform: () => {
+    fields: {
+        event_name: {
+            label: 'Event Name',
+            description: 'The conversion event type. For custom events, you must use the predefined event name "custom". Please refer to the possible event types in [Pinterest API docs](https://developers.pinterest.com/docs/api/v5/#operation/events/create).',
+            type: 'string',
+            required: true,
+            choices: [
+                { label: 'Add to Cart', value: 'add_to_cart' },
+                { label: 'Checkout', value: 'checkout' },
+                { label: 'Lead', value: 'lead' },
+                { label: 'Page Visit', value: 'page_visit' },
+                { label: 'Search', value: 'search' },
+                { label: 'Sign Up', value: 'sign_up' },
+                { label: 'View Category', value: 'view_category' },
+                { label: 'Watch Video', value: 'watch_video' }
+            ]
+        },
+        action_source: {
+            label: 'Action Source',
+            description: 'The source indicating where the conversion event occurred. This must be app_android, app_ios , web or offline.',
+            type: 'string',
+            required: true,
+            choices: [
+                { label: 'App Android', value: 'app_android' },
+                { label: 'App IOS', value: 'app_ios' },
+                { label: 'Web', value: 'web' },
+                { label: 'Offline', value: 'offline' }
+            ],
+            default: 'web'
+        },
+        event_time: {
+            label: 'Event Timestamp',
+            description: 'Device IDs can be used to add and remove only anonymous users to/from a cohort. However, users with an assigned User ID cannot use Device ID to sync to a cohort.',
+            type: 'string',
+            required: true,
+            default: {
+                '@path': '$.timestamp'
+            }
+        },
+        event_id: {
+            label: 'Event ID',
+            description: 'A unique id string that identifies this event and can be used for deduping between events ingested via both the conversion API and Pinterest tracking.',
+            type: 'string',
+            required: true,
+            default: {
+                '@path': '$.messageId'
+            }
+        },
+        event_source_url: {
+            label: 'Event Source URL',
+            description: 'URL of the web conversion event.',
+            type: 'string',
+            default: {
+                '@path': '$.context.page.url'
+            }
+        },
+        opt_out: {
+            label: 'Opt Out',
+            description: 'When action_source is web or offline, it defines whether the user has opted out of tracking for web conversion events. While when action_source is app_android or app_ios, it defines whether the user has enabled Limit Ad Tracking on their iOS device, or opted out of Ads Personalization on their Android device.',
+            type: 'boolean',
+            default: true
+        },
+        user_data: pinterset_capi_user_data_1.user_data_field,
+        custom_data: pinterest_capi_custom_data_1.custom_data_field,
+        app_id: {
+            label: 'App ID',
+            description: 'The app store app ID.',
+            type: 'string',
+            default: {
+                '@path': 'context.app.id'
+            }
+        },
+        app_name: {
+            label: 'App Name',
+            description: 'Name of the app. ',
+            type: 'string',
+            required: true,
+            default: {
+                '@path': '$.context.app.name'
+            }
+        },
+        app_version: {
+            label: 'App Version',
+            description: 'Version of the app.',
+            type: 'string',
+            default: {
+                '@path': '$.context.app.version'
+            }
+        },
+        device_brand: {
+            label: 'Device Brand',
+            description: 'Brand of the user device.',
+            type: 'string',
+            default: {
+                '@path': '$.context.device.brand'
+            }
+        },
+        device_carrier: {
+            label: 'Device Carrier',
+            description: 'User device’s mobile carrier. ',
+            type: 'string',
+            default: {
+                '@path': 'context.device.carrier'
+            }
+        },
+        device_model: {
+            label: 'Device Model',
+            description: 'Model of the user device.',
+            type: 'string',
+            default: {
+                '@path': '$.context.device.model'
+            }
+        },
+        device_type: {
+            label: 'Device Type',
+            description: 'Type of the user device.',
+            type: 'string',
+            default: {
+                '@path': '$.context.device.type'
+            }
+        },
+        os_version: {
+            label: 'OS Version',
+            description: 'Version of the device operating system.',
+            type: 'string',
+            default: {
+                '@path': '$.context.os.version'
+            }
+        },
+        wifi: {
+            label: 'Wifi',
+            description: 'Whether the event occurred when the user device was connected to wifi.',
+            type: 'boolean',
+            default: {
+                '@path': '$.context.network.wifi'
+            }
+        },
+        language: {
+            label: 'Language',
+            description: "Two-character ISO-639-1 language code indicating the user's language.",
+            type: 'string'
+        }
+    },
+    perform: async (request, { settings, payload }) => {
+        return processPayload(request, settings, payload);
     }
 };
+async function processPayload(request, settings, payload) {
+    if (isEmpty_1.default(payload.user_data?.email) &&
+        isEmpty_1.default(payload.user_data?.hashed_maids) &&
+        !(payload.user_data?.client_ip_address && payload.user_data?.client_user_agent)) {
+        throw new actions_core_1.IntegrationError(`User data must contain values for Email or Phone Number or Mobile Ad Identifier or both IP Address and User Agent fields`, 'Misconfigured required field', 400);
+    }
+    const data = createPinterestPayload(payload);
+    return request(`https://api.pinterest.com/${constants_1.API_VERSION}/ad_accounts/${settings.ad_account_id}/events`, {
+        method: 'POST',
+        json: {
+            data: data
+        }
+    });
+}
+function createPinterestPayload(payload) {
+    return [
+        {
+            event_name: payload.event_name,
+            action_source: payload.action_source,
+            event_time: dayjs_1.default.utc(payload.event_time).unix(),
+            event_id: payload.event_id,
+            event_source_url: payload.event_source_url,
+            partner_name: constants_1.PARTNER_NAME,
+            opt_out: payload.opt_out,
+            user_data: pinterset_capi_user_data_1.hash_user_data({ user_data: payload.user_data }),
+            custom_data: {
+                currency: payload?.custom_data?.currency,
+                value: payload?.custom_data?.value,
+                content_ids: payload.custom_data?.content_ids,
+                contents: payload.custom_data?.contents,
+                num_items: payload.custom_data?.num_items,
+                order_id: payload.custom_data?.order_id,
+                search_string: payload.custom_data?.search_string,
+                opt_out_type: payload.custom_data?.opt_out_type
+            },
+            app_id: payload.app_id,
+            app_name: payload.app_name,
+            app_version: payload.app_version,
+            device_brand: payload.device_brand,
+            device_carrier: payload.device_carrier,
+            device_model: payload.device_model,
+            device_type: payload.device_type,
+            os_version: payload.os_version,
+            wifi: payload.wifi,
+            language: payload.language
+        }
+    ];
+}
 exports.default = action;
 //# sourceMappingURL=index.js.map

package/dist/destinations/pinterest-conversions/reportConversionEvent/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/pinterest-conversions/reportConversionEvent/index.ts"],"names":[],"mappings":";;AAIA,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,yBAAyB;IAChC,WAAW,EAAE,MAAM;IACnB,MAAM,EAAE,EAAE;IACV,OAAO,EAAE,GAAG,EAAE;IAMd,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/pinterest-conversions/reportConversionEvent/index.ts"],"names":[],"mappings":";;;;;AACA,wDAAwD;AACxD,4CAAwD;AAExD,8EAAiE;AACjE,0EAA6E;AAE7E,6DAAoC;AACpC,+DAAsC;AAEtC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,yBAAyB;IAChC,WAAW,EAAE,MAAM;IACnB,MAAM,EAAE;QACN,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,WAAW,EACT,yOAAyO;YAC3O,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE;gBAC9C,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE;gBACxC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;gBAC5C,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;gBACpC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;gBACtC,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,EAAE;gBAClD,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE;aAC/C;SACF;QACD,aAAa,EAAE;YACb,KAAK,EAAE,eAAe;YACtB,WAAW,EACT,gHAAgH;YAClH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE;gBAC9C,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;gBACtC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;aACvC;YACD,OAAO,EAAE,KAAK;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,iBAAiB;YACxB,WAAW,EACT,mKAAmK;YACrK,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,WAAW,EACT,wJAAwJ;YAC1J,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE,kCAAkC;YAC/C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,OAAO,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,WAAW,EACT,wTAAwT;YAC1T,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SACd;QACD,SAAS,EAAE,0CAAe;QAC1B,WAAW,EAAE,8CAAiB;QAC9B,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,uBAAuB;YACpC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,gBAAgB;aAC1B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,mBAAmB;YAChC,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,qBAAqB;YAClC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,2BAA2B;YACxC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,cAAc,EAAE;YACd,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,gCAAgC;YAC7C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,2BAA2B;YACxC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,0BAA0B;YACvC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,sBAAsB;aAChC;SACF;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,MAAM;YACb,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,SAAS;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,uEAAuE;YACpF,IAAI,EAAE,QAAQ;SACf;KACF;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;QAChD,OAAO,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACnD,CAAC;CACF,CAAA;AACD,KAAK,UAAU,cAAc,CAAC,OAAsB,EAAE,QAAkB,EAAE,OAAgB;IACxF,IACE,iBAAO,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;QACjC,iBAAO,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC;QACxC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,IAAI,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,EAC/E;QACA,MAAM,IAAI,+BAAgB,CACxB,0HAA0H,EAC1H,8BAA8B,EAC9B,GAAG,CACJ,CAAA;KACF;IAED,MAAM,IAAI,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAC5C,OAAO,OAAO,CAAC,6BAA6B,uBAAW,gBAAgB,QAAQ,CAAC,aAAa,SAAS,EAAE;QACtG,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,IAAI;SACX;KACF,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAgB;IAC9C,OAAO;QACL;YACE,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,UAAU,EAAE,eAAK,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE;YAChD,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;YAC1C,YAAY,EAAE,wBAAY;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,SAAS,EAAE,yCAAc,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;YAC3D,WAAW,EAAE;gBACX,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ;gBACxC,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK;gBAClC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,WAAW;gBAC7C,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ;gBACvC,SAAS,EAAE,OAAO,CAAC,WAAW,EAAE,SAAS;gBACzC,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ;gBACvC,aAAa,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa;gBACjD,YAAY,EAAE,OAAO,CAAC,WAAW,EAAE,YAAY;aAChD;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B;KACF,CAAA;AACH,CAAC;AAED,kBAAe,MAAM,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.146.0",
+  "version": "3.148.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -39,8 +39,8 @@
   "dependencies": {
     "@amplitude/ua-parser-js": "^0.7.25",
     "@segment/a1-notation": "^2.1.4",
-    "@segment/actions-core": "^3.58.0",
-    "@segment/actions-shared": "^1.40.0",
+    "@segment/actions-core": "^3.59.0",
+    "@segment/actions-shared": "^1.41.0",
     "@types/node": "^18.11.15",
     "cheerio": "^1.0.0-rc.10",
     "dayjs": "^1.10.7",
@@ -68,5 +68,5 @@
       "lcov"
     ]
   },
-  "gitHead": "8f964e3906827bca76ee6cf1c767a7d6a66343da"
+  "gitHead": "73a5566c808e8bda19d79e4569fa8dbc051f8a8d"
 }