@segment/action-destinations 3.424.0 → 3.426.0

package/dist/destinations/ms-bing-capi/fields.js

@@ -0,0 +1,336 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customData = exports.hotelData = exports.items = exports.data = exports.userData = void 0;
+const utils_1 = require("./sendEvent/utils");
+exports.userData = {
+    label: 'User Data',
+    description: 'A list of user identifiers associated with the event.',
+    type: 'object',
+    required: true,
+    properties: {
+        clientUserAgent: {
+            label: 'Client User Agent',
+            description: 'User agent string of the client device.',
+            type: 'string'
+        },
+        anonymousId: {
+            label: 'Anonymous ID',
+            description: 'Guest user anonymous ID.',
+            type: 'string'
+        },
+        externalId: {
+            label: 'External ID',
+            description: 'Authenticated user id (anonymized) if user is logged in. Also used for ID sync',
+            type: 'string'
+        },
+        em: {
+            label: 'Email',
+            description: 'Email address of the user. Accepts a clear text or hashed email address. Segment will ensure the email address is hashed before sending to Bing Ads.',
+            type: 'string'
+        },
+        ph: {
+            label: 'Phone',
+            description: 'Phone number of the user. Accepts a clear text or hashed phone number. Segment will ensure the phone number is hashed before sending to Bing Ads.',
+            type: 'string'
+        },
+        clientIpAddress: {
+            label: 'Client IP Address',
+            description: 'IP address of the client device.',
+            type: 'string'
+        },
+        msclkid: {
+            label: 'MSCLKID',
+            description: 'Microsoft Last Click ID.',
+            type: 'string'
+        }
+    },
+    default: {
+        clientUserAgent: { '@path': '$.context.userAgent' },
+        anonymousId: { '@path': '$.anonymousId' },
+        externalId: { '@path': '$.userId' },
+        em: {
+            '@if': {
+                exists: { '@path': '$.context.traits.email' },
+                then: { '@path': '$.context.traits.email' },
+                else: { '@path': '$.properties.email' }
+            }
+        },
+        ph: {
+            '@if': {
+                exists: { '@path': '$.context.traits.phone' },
+                then: { '@path': '$.context.traits.phone' },
+                else: { '@path': '$.properties.phone' }
+            }
+        },
+        clientIpAddress: { '@path': '$.context.ip' },
+        msclkid: {
+            '@if': {
+                exists: { '@path': '$.properties.msclkid' },
+                then: { '@path': '$.properties.msclkid' },
+                else: { '@path': '$.integrations.Ms Bing Capi.msclkid' }
+            }
+        }
+    }
+};
+exports.data = {
+    label: 'Data',
+    description: 'TODO - description for this field',
+    type: 'object',
+    required: true,
+    properties: {
+        eventType: {
+            label: 'Event Type',
+            description: 'The type of event being sent to the Bing API.',
+            type: 'string',
+            required: true,
+            choices: [
+                { label: 'Page Load', value: 'pageLoad' },
+                { label: 'Custom', value: 'custom' }
+            ]
+        },
+        eventId: {
+            label: 'Event ID',
+            description: 'EventID for deduplication. Defaults to the Segment messageId.',
+            type: 'string'
+        },
+        eventName: {
+            label: 'Event Name',
+            description: 'Event action for custom conversion goals, if used.',
+            type: 'string'
+        },
+        eventTime: {
+            label: 'Event Time',
+            description: 'The time the event occurred.',
+            type: 'string',
+            required: true
+        },
+        eventSourceUrl: {
+            label: 'Event Source URL',
+            description: 'URL of the page, used for example: “destination URL” goals. Required for pageLoad events.',
+            type: 'string',
+            required: {
+                conditions: [{ fieldKey: 'eventDetails.eventType', operator: 'is', value: 'pageLoad' }]
+            }
+        },
+        pageLoadId: {
+            label: 'Page Load ID',
+            description: 'Page load id that links to 0+ custom events from the same page. Format as a v4 UUID. ',
+            type: 'string'
+        },
+        referrerUrl: {
+            label: 'Referrer URL',
+            description: 'Referrer of the page, used for example: "referral" remarketing lists.',
+            type: 'string'
+        },
+        pageTitle: {
+            label: 'Page Title',
+            description: 'Title of the page.',
+            type: 'string'
+        },
+        keywords: {
+            label: 'Keywords',
+            description: 'Page keywords - SEO meta keyworls.',
+            type: 'string'
+        },
+        userData: {
+            label: 'User Data',
+            type: 'object'
+        },
+        customData: {
+            label: 'Custom Data',
+            type: 'object'
+        }
+    },
+    default: {
+        eventType: { '@path': '$.properties.event_type' },
+        eventId: { '@path': '$.messageId' },
+        eventName: { '@path': '$.event' },
+        eventSourceUrl: { '@path': '$.context.page.url' },
+        pageLoadId: { '@path': '$.properties.page_load_id' },
+        referrerUrl: { '@path': '$.context.page.referrer' },
+        pageTitle: { '@path': '$.context.page.title' },
+        keywords: { '@path': '$.properties.keywords' }
+    }
+};
+exports.items = {
+    label: 'Items',
+    description: 'The list of items associated with the event. Must contain at least one item.',
+    type: 'object',
+    multiple: true,
+    required: false,
+    properties: {
+        id: {
+            label: 'Item ID',
+            description: 'The unique identifier for the item.',
+            type: 'string'
+        },
+        name: {
+            label: 'Item Name',
+            description: 'The name of the item.',
+            type: 'string'
+        },
+        price: {
+            label: 'Item Price',
+            description: 'The price of the item, after discounts.',
+            type: 'integer'
+        },
+        quantity: {
+            label: 'Item Quantity',
+            description: 'The quantity of the item.',
+            type: 'integer'
+        }
+    },
+    default: {
+        '@arrayPath': [
+            '$.properties.products',
+            {
+                id: { '@path': '$.id' },
+                name: { '@path': '$.name' },
+                quantity: { '@path': '$.quantity' },
+                item_price: { '@path': '$.price' }
+            }
+        ]
+    }
+};
+exports.hotelData = {
+    label: 'Hotel Data',
+    description: 'Data specific to hotel events.',
+    type: 'object',
+    properties: {
+        totalPrice: {
+            label: 'Total Price',
+            description: 'Total price of the booking, including taxes and fees.',
+            type: 'integer'
+        },
+        basePrice: {
+            label: 'Base Price',
+            description: 'Price of the booking, not including taxes or fees.',
+            type: 'integer'
+        },
+        checkInDate: {
+            label: 'Check-In Date',
+            description: 'The date of check-in for the hotel booking in the format YYYY-MM-DD',
+            type: 'string',
+            format: 'date-time'
+        },
+        checkOutDate: {
+            label: 'Check-Out Date',
+            description: 'The date of check-out for the hotel booking in the format YYYY-MM-DD',
+            type: 'string',
+            format: 'date-time'
+        },
+        lengthOfStay: {
+            label: 'Length of Stay',
+            description: 'The number of nights the booking is for. Not required if you specify hct_checkout_date.',
+            type: 'integer'
+        },
+        partnerHotelId: {
+            label: 'Partner Hotel ID',
+            description: 'The ID of the hotel as provided by the partner.',
+            type: 'string'
+        },
+        bookingHref: {
+            label: 'Booking Href',
+            description: 'Encrypted or obfuscated booking refrence number',
+            type: 'string'
+        }
+    },
+    default: {
+        totalPrice: { '@path': '$.properties.hotel_total_price' },
+        basePrice: { '@path': '$.properties.hotel_base_price' },
+        checkInDate: { '@path': '$.properties.hotel_check_in_date' },
+        checkOutDate: { '@path': '$.properties.hotel_check_out_date' },
+        lengthOfStay: { '@path': '$.properties.hotel_length_of_stay' },
+        partnerHotelId: { '@path': '$.properties.hotel_partner_id' },
+        bookingHref: { '@path': '$.properties.hotel_booking_href' }
+    }
+};
+exports.customData = {
+    label: 'Custom Data',
+    description: 'Custom data to be sent to the Bing API. This can include additional properties that are not covered by the standard fields.',
+    type: 'object',
+    properties: {
+        eventCategory: {
+            label: 'Event Category',
+            description: 'The category for custom conversion goals, if used.',
+            type: 'string'
+        },
+        eventLabel: {
+            label: 'Event Label',
+            description: 'The label for custom conversion goals.',
+            type: 'string'
+        },
+        eventValue: {
+            label: 'Event Value',
+            description: 'The event value for custom conversion goals.',
+            type: 'number'
+        },
+        searchTerm: {
+            label: 'Search Term',
+            description: 'The query used by the user for a search results page.',
+            type: 'string'
+        },
+        transactionId: {
+            label: 'Transaction ID',
+            description: 'The unique identifier for the transaction. Required for purchase events.',
+            type: 'string'
+        },
+        value: {
+            label: 'Value',
+            description: 'Revenue value (float) to report variable revenue for goals, if used',
+            type: 'number'
+        },
+        currency: {
+            label: 'Currency',
+            description: 'The currency of the event value, in ISO 4217 format.',
+            type: 'string',
+            choices: (0, utils_1.getCurrencyChoices)()
+        },
+        itemIds: {
+            label: 'Item IDs',
+            description: 'A comma separated list of product IDs, or an array of IDs.',
+            type: 'string',
+            multiple: true
+        },
+        pageType: {
+            label: 'Page Type',
+            description: 'The type of page where the event occurred.',
+            type: 'string',
+            choices: [
+                { label: 'Home', value: 'home' },
+                { label: 'Product', value: 'product' },
+                { label: 'Category', value: 'category' },
+                { label: 'Search Results', value: 'searchresults' },
+                { label: 'Cart', value: 'cart' },
+                { label: 'Purchase', value: 'purchase' },
+                { label: 'Other', value: 'other' }
+            ]
+        },
+        ecommTotalValue: {
+            label: 'Ecomm Total Value',
+            description: 'Total value of the cart of purchase.',
+            type: 'number'
+        },
+        ecommCategory: {
+            label: 'Ecomm Category',
+            description: 'Category ID',
+            type: 'string'
+        },
+        items: exports.items,
+        hotelData: exports.hotelData
+    },
+    default: {
+        eventCategory: { '@path': '$.properties.event_category' },
+        eventLabel: { '@path': '$.properties.event_label' },
+        eventValue: { '@path': '$.properties.value' },
+        searchTerm: { '@path': '$.properties.query' },
+        transactionId: { '@path': '$.properties.order_id' },
+        value: { '@path': '$.properties.value' },
+        currency: { '@path': '$.properties.currency' },
+        itemIds: { '@path': '$.properties.item_ids' },
+        pageType: { '@path': '$.properties.page_type' },
+        ecommTotalValue: { '@path': '$.properties.ecomm_total_value' },
+        ecommCategory: { '@path': '$.properties.ecomm_category' }
+    }
+};
+//# sourceMappingURL=fields.js.map

package/dist/destinations/ms-bing-capi/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-capi/fields.ts"],"names":[],"mappings":";;;AACA,6CAAsD;AAEzC,QAAA,QAAQ,GAAe;IAClC,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,uDAAuD;IACpE,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE;QACV,eAAe,EAAE;YACf,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,0BAA0B;YACvC,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,gFAAgF;YAC7F,IAAI,EAAE,QAAQ;SACf;QACD,EAAE,EAAE;YACF,KAAK,EAAE,OAAO;YACd,WAAW,EACT,sJAAsJ;YACxJ,IAAI,EAAE,QAAQ;SACf;QACD,EAAE,EAAE;YACF,KAAK,EAAE,OAAO;YACd,WAAW,EACT,mJAAmJ;YACrJ,IAAI,EAAE,QAAQ;SACf;QACD,eAAe,EAAE;YACf,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,kCAAkC;YAC/C,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,0BAA0B;YACvC,IAAI,EAAE,QAAQ;SACf;KACF;IACD,OAAO,EAAE;QACP,eAAe,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;QACnD,WAAW,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;QACzC,UAAU,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;QACnC,EAAE,EAAE;YACF,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC7C,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;aACxC;SACF;QACD,EAAE,EAAE;YACF,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC7C,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;aACxC;SACF;QACD,eAAe,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE;QAC5C,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,qCAAqC,EAAE;aACzD;SACF;KACF;CACF,CAAA;AAEY,QAAA,IAAI,GAAe;IAC9B,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,mCAAmC;IAChD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE;QACV,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,+CAA+C;YAC5D,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE;gBACzC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;aACrC;SACF;QACD,OAAO,EAAE;YACP,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,+DAA+D;YAC5E,IAAI,EAAE,QAAQ;SACf;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,QAAQ;SACf;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,8BAA8B;YAC3C,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;QACD,cAAc,EAAE;YACd,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE,2FAA2F;YACxG,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE;gBACR,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,wBAAwB,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;aACxF;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,uFAAuF;YACpG,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,uEAAuE;YACpF,IAAI,EAAE,QAAQ;SACf;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,QAAQ;SACf;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,oCAAoC;YACjD,IAAI,EAAE,QAAQ;SACf;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;SACf;KACF;IACD,OAAO,EAAE;QACP,SAAS,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;QACjD,OAAO,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE;QACnC,SAAS,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;QACjC,cAAc,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;QACjD,UAAU,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;QACpD,WAAW,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;QACnD,SAAS,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;QAC9C,QAAQ,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;KAC/C;CACF,CAAA;AAEY,QAAA,KAAK,GAAe;IAC/B,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,8EAA8E;IAC3F,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,KAAK;IACf,UAAU,EAAE;QACV,EAAE,EAAE;YACF,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;SACf;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,uBAAuB;YACpC,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,SAAS;SAChB;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,2BAA2B;YACxC,IAAI,EAAE,SAAS;SAChB;KACF;IACD,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;gBACvB,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;gBAC3B,QAAQ,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE;gBACnC,UAAU,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;aACnC;SACF;KACF;CACF,CAAA;AAEY,QAAA,SAAS,GAAe;IACnC,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,gCAAgC;IAC7C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,uDAAuD;YACpE,IAAI,EAAE,SAAS;SAChB;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,SAAS;SAChB;QACD,WAAW,EAAE;YACX,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,qEAAqE;YAClF,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACpB;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,sEAAsE;YACnF,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACpB;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,yFAAyF;YACtG,IAAI,EAAE,SAAS;SAChB;QACD,cAAc,EAAE;YACd,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE,iDAAiD;YAC9D,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,iDAAiD;YAC9D,IAAI,EAAE,QAAQ;SACf;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE,EAAE,OAAO,EAAE,gCAAgC,EAAE;QACzD,SAAS,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE;QACvD,WAAW,EAAE,EAAE,OAAO,EAAE,kCAAkC,EAAE;QAC5D,YAAY,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE;QAC9D,YAAY,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE;QAC9D,cAAc,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE;QAC5D,WAAW,EAAE,EAAE,OAAO,EAAE,iCAAiC,EAAE;KAC5D;CACF,CAAA;AAEY,QAAA,UAAU,GAAe;IACpC,KAAK,EAAE,aAAa;IACpB,WAAW,EACT,6HAA6H;IAC/H,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,aAAa,EAAE;YACb,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,wCAAwC;YACrD,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,QAAQ;SACf;QACD,UAAU,EAAE;YACV,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,uDAAuD;YACpE,IAAI,EAAE,QAAQ;SACf;QACD,aAAa,EAAE;YACb,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,0EAA0E;YACvF,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,qEAAqE;YAClF,IAAI,EAAE,QAAQ;SACf;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,sDAAsD;YACnE,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,IAAA,0BAAkB,GAAE;SAC9B;QACD,OAAO,EAAE;YACP,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,4DAA4D;YACzE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE;gBACtC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE;gBACxC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,eAAe,EAAE;gBACnD,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE;gBACxC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;aACnC;SACF;QACD,eAAe,EAAE;YACf,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,sCAAsC;YACnD,IAAI,EAAE,QAAQ;SACf;QACD,aAAa,EAAE;YACb,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,aAAa;YAC1B,IAAI,EAAE,QAAQ;SACf;QACD,KAAK,EAAE,aAAK;QACZ,SAAS,EAAE,iBAAS;KACrB;IACD,OAAO,EAAE;QACP,aAAa,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE;QACzD,UAAU,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE;QACnD,UAAU,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;QAC7C,UAAU,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;QAC7C,aAAa,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;QACnD,KAAK,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;QACxC,QAAQ,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;QAC9C,OAAO,EAAE,EAAE,OAAO,EAAE,uBAAuB,EAAE;QAC7C,QAAQ,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;QAC/C,eAAe,EAAE,EAAE,OAAO,EAAE,gCAAgC,EAAE;QAC9D,aAAa,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE;KAC1D;CACF,CAAA"}

package/dist/destinations/ms-bing-capi/generated-types.d.ts

@@ -1,2 +1,4 @@
 export interface Settings {
+    UetTag: string;
+    ApiToken: string;
 }

package/dist/destinations/ms-bing-capi/index.js

@@ -4,12 +4,47 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const sendEvent_1 = __importDefault(require("./sendEvent"));
+const pageLoad_1 = __importDefault(require("./pageLoad"));
 const destination = {
-    name: 'Ms Bing Capi',
+    name: 'Microsoft Bing Conversion API',
     slug: 'actions-ms-bing-capi',
     mode: 'cloud',
+    authentication: {
+        scheme: 'basic',
+        fields: {
+            UetTag: {
+                label: 'Bing UetTag',
+                description: 'Your Bing UetTag.',
+                type: 'string',
+                required: true
+            },
+            ApiToken: {
+                label: 'Bing ApiToken',
+                description: 'Your Bing API Token.',
+                type: 'string',
+                required: true
+            }
+        },
+        testAuthentication: (_, { settings }) => {
+            if (settings.UetTag.length && settings.ApiToken.length) {
+                return true;
+            }
+            else {
+                throw new Error('Invalid AccountID. Please check your AccountID');
+            }
+        }
+    },
+    extendRequest: ({ settings }) => {
+        return {
+            headers: {
+                Authorization: `Bearer ${settings.ApiToken}`,
+                'Content-Type': 'application/json'
+            }
+        };
+    },
     actions: {
-        sendEvent: sendEvent_1.default
+        sendEvent: sendEvent_1.default,
+        pageLoad: pageLoad_1.default
     }
 };
 exports.default = destination;

package/dist/destinations/ms-bing-capi/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-capi/index.ts"],"names":[],"mappings":";;;;;AAGA,4DAAmC;AAEnC,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,OAAO;IAkBb,OAAO,EAAE;QACP,SAAS,EAAT,mBAAS;KACV;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-capi/index.ts"],"names":[],"mappings":";;;;;AAEA,4DAAmC;AACnC,0DAAiC;AAEjC,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,+BAA+B;IACrC,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,OAAO;IACb,cAAc,EAAE;QACd,MAAM,EAAE,OAAO;QACf,MAAM,EAAE;YACN,MAAM,EAAE;gBACN,KAAK,EAAE,aAAa;gBACpB,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,sBAAsB;gBACnC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACtC,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACvD,OAAO,IAAI,CAAA;YACb,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;KACF;IACD,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC9B,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,QAAQ,CAAC,QAAQ,EAAE;gBAC5C,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;IACH,CAAC;IACD,OAAO,EAAE;QACP,SAAS,EAAT,mBAAS;QACT,QAAQ,EAAR,kBAAQ;KACT;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/ms-bing-capi/pageLoad/generated-types.d.ts

@@ -0,0 +1,56 @@
+export interface Payload {
+    data: {
+        eventType?: string;
+        eventId?: string;
+        eventName?: string;
+        eventTime?: string;
+        eventSourceUrl?: string;
+        pageLoadId?: string;
+        referrerUrl?: string;
+        pageTitle?: string;
+        keywords?: string;
+        userData?: {
+            [k: string]: unknown;
+        };
+        customData?: {
+            [k: string]: unknown;
+        };
+    };
+    userData: {
+        clientUserAgent?: string;
+        anonymousId?: string;
+        externalId?: string;
+        em?: string;
+        ph?: string;
+        clientIpAddress?: string;
+        msclkid?: string;
+    };
+    customData?: {
+        eventCategory?: string;
+        eventLabel?: string;
+        eventValue?: number;
+        searchTerm?: string;
+        transactionId?: string;
+        value?: number;
+        currency?: string;
+        itemIds?: string[];
+        pageType?: string;
+        ecommTotalValue?: number;
+        ecommCategory?: string;
+        items?: {
+            id?: string;
+            name?: string;
+            price?: number;
+            quantity?: number;
+        }[];
+        hotelData?: {
+            totalPrice?: number;
+            basePrice?: number;
+            checkInDate?: string;
+            checkOutDate?: string;
+            lengthOfStay?: number;
+            partnerHotelId?: string;
+            bookingHref?: string;
+        };
+    };
+}

package/dist/destinations/ms-bing-capi/pageLoad/generated-types.js

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

package/dist/destinations/ms-bing-capi/pageLoad/generated-types.js.map

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

package/dist/destinations/ms-bing-capi/pageLoad/index.d.ts

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

package/dist/destinations/ms-bing-capi/pageLoad/index.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fields_1 = require("../fields");
+const constants_1 = require("../constants");
+const hashing_utils_1 = require("../../../lib/hashing-utils");
+const uuid_1 = require("@lukeed/uuid");
+const action = {
+    title: 'Page Load',
+    description: 'Send a page load event to Microsoft Bing CAPI.',
+    defaultSubscription: 'type = "page"',
+    fields: {
+        data: fields_1.data,
+        userData: fields_1.userData,
+        customData: fields_1.customData
+    },
+    perform: (request, { payload, settings }) => {
+        if (payload.data.userData == undefined) {
+            payload.data.userData = {
+                anonymousId: (0, uuid_1.v4)()
+            };
+        }
+        if (payload.userData?.em) {
+            payload.userData.em = (0, hashing_utils_1.processHashing)(payload.userData.em, 'sha256', 'hex', (value) => value.trim().toLowerCase());
+        }
+        if (payload.userData?.ph) {
+            payload.userData.ph = (0, hashing_utils_1.processHashing)(payload.userData.ph, 'sha256', 'hex', (value) => value.trim().replace(/\D/g, ''));
+        }
+        if (payload.customData) {
+            payload.data.customData = payload.customData;
+        }
+        if (payload.userData) {
+            payload.data.userData = payload.userData;
+        }
+        const url = `${constants_1.API_URL}${settings.UetTag}/events`;
+        return request(url, {
+            method: 'post',
+            json: {
+                data: [payload.data]
+            }
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/ms-bing-capi/pageLoad/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/ms-bing-capi/pageLoad/index.ts"],"names":[],"mappings":";;AAGA,sCAAuE;AACvE,4CAAsC;AACtC,8DAA2D;AAC3D,uCAA2C;AAE3C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,gDAAgD;IAC7D,mBAAmB,EAAE,eAAe;IACpC,MAAM,EAAE;QACN,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE,iBAAQ;QAClB,UAAU,EAAE,mBAAU;KACvB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG;gBACtB,WAAW,EAAE,IAAA,SAAM,GAAE;aACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAA,8BAAc,EAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;QACnH,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAA,8BAAc,EAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACnF,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAChC,CAAA;QACH,CAAC;QAGD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAC9C,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAC1C,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,mBAAO,GAAG,QAAQ,CAAC,MAAM,SAAS,CAAA;QAEjD,OAAO,OAAO,CAAC,GAAG,EAAE;YAClB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;aACrB;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/ms-bing-capi/sendEvent/generated-types.d.ts

@@ -1,2 +1,56 @@
 export interface Payload {
+    data: {
+        eventType?: string;
+        eventId?: string;
+        eventName?: string;
+        eventTime?: string;
+        eventSourceUrl?: string;
+        pageLoadId?: string;
+        referrerUrl?: string;
+        pageTitle?: string;
+        keywords?: string;
+        userData?: {
+            [k: string]: unknown;
+        };
+        customData?: {
+            [k: string]: unknown;
+        };
+    };
+    userData: {
+        clientUserAgent?: string;
+        anonymousId?: string;
+        externalId?: string;
+        em?: string;
+        ph?: string;
+        clientIpAddress?: string;
+        msclkid?: string;
+    };
+    customData?: {
+        eventCategory?: string;
+        eventLabel?: string;
+        eventValue?: number;
+        searchTerm?: string;
+        transactionId?: string;
+        value?: number;
+        currency?: string;
+        itemIds?: string[];
+        pageType?: string;
+        ecommTotalValue?: number;
+        ecommCategory?: string;
+        items?: {
+            id?: string;
+            name?: string;
+            price?: number;
+            quantity?: number;
+        }[];
+        hotelData?: {
+            totalPrice?: number;
+            basePrice?: number;
+            checkInDate?: string;
+            checkOutDate?: string;
+            lengthOfStay?: number;
+            partnerHotelId?: string;
+            bookingHref?: string;
+        };
+    };
 }

package/dist/destinations/ms-bing-capi/sendEvent/index.js

@@ -1,10 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const fields_1 = require("../fields");
+const constants_1 = require("../constants");
+const hashing_utils_1 = require("../../../lib/hashing-utils");
+const uuid_1 = require("@lukeed/uuid");
 const action = {
     title: 'Send Event',
-    description: '',
-    fields: {},
-    perform: () => {
+    description: 'Send a track event to Microsoft Bing CAPI.',
+    defaultSubscription: 'type = "track"',
+    fields: {
+        data: fields_1.data,
+        userData: fields_1.userData,
+        customData: fields_1.customData
+    },
+    perform: (request, { payload, settings }) => {
+        if (payload.userData == undefined) {
+            payload.userData = {
+                anonymousId: (0, uuid_1.v4)()
+            };
+        }
+        if (payload.userData?.em) {
+            payload.userData.em = (0, hashing_utils_1.processHashing)(payload.userData.em, 'sha256', 'hex', (value) => value.trim().toLowerCase());
+        }
+        if (payload.userData?.ph) {
+            payload.userData.ph = (0, hashing_utils_1.processHashing)(payload.userData.ph, 'sha256', 'hex', (value) => value.trim().replace(/\D/g, ''));
+        }
+        if (payload.customData) {
+            payload.data.customData = payload.customData;
+        }
+        if (payload.userData) {
+            payload.data.userData = payload.userData;
+        }
+        return request(`${constants_1.API_URL}${settings.UetTag}/events`, {
+            method: 'post',
+            json: {
+                data: [payload.data]
+            }
+        });
     }
 };
 exports.default = action;

package/dist/destinations/ms-bing-capi/sendEvent/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/ms-bing-capi/sendEvent/index.ts"],"names":[],"mappings":";;AAIA,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,EAAE;IACf,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/ms-bing-capi/sendEvent/index.ts"],"names":[],"mappings":";;AAGA,sCAAsD;AACtD,4CAAsC;AACtC,8DAA2D;AAC3D,uCAA2C;AAE3C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,4CAA4C;IACzD,mBAAmB,EAAE,gBAAgB;IACrC,MAAM,EAAE;QACN,IAAI,EAAE,aAAI;QACV,QAAQ,EAAE,iBAAQ;QAClB,UAAU,EAAE,mBAAU;KACvB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,IAAI,OAAO,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC;YAClC,OAAO,CAAC,QAAQ,GAAG;gBACjB,WAAW,EAAE,IAAA,SAAM,GAAE;aACtB,CAAA;QACH,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAA,8BAAc,EAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;QACnH,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAA,8BAAc,EAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CACnF,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAChC,CAAA;QACH,CAAC;QAGD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAC9C,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAC1C,CAAC;QAED,OAAO,OAAO,CAAC,GAAG,mBAAO,GAAG,QAAQ,CAAC,MAAM,SAAS,EAAE;YACpD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;aACrB;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/ms-bing-capi/sendEvent/types.d.ts

@@ -0,0 +1,13 @@
+export interface EventJSON {
+    data: Array<EventObject>;
+}
+export interface EventObject {
+    eventType: string;
+    eventId?: string;
+    eventName: string;
+    customData?: CustomData;
+}
+export interface EventResponse {
+}
+export interface CustomData {
+}

package/dist/destinations/ms-bing-capi/sendEvent/types.js

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

package/dist/destinations/ms-bing-capi/sendEvent/types.js.map

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