@segment/action-destinations 3.239.0 → 3.239.4

package/dist/destinations/tiktok-offline-conversions/index.js

@@ -6,6 +6,49 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const actions_core_1 = require("@segment/actions-core");
 const trackPaymentOfflineConversion_1 = __importDefault(require("./trackPaymentOfflineConversion"));
 const trackNonPaymentOfflineConversion_1 = __importDefault(require("./trackNonPaymentOfflineConversion"));
+const reportOfflineEvent_1 = __importDefault(require("./reportOfflineEvent"));
+const productProperties = {
+    price: {
+        '@path': '$.price'
+    },
+    quantity: {
+        '@path': '$.quantity'
+    },
+    content_category: {
+        '@path': '$.category'
+    },
+    content_id: {
+        '@path': '$.product_id'
+    },
+    content_name: {
+        '@path': '$.name'
+    },
+    brand: {
+        '@path': '$.brand'
+    }
+};
+const singleProductContents = {
+    ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+const multiProductContents = {
+    ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties.products',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
 const destination = {
     name: 'TikTok Offline Conversions',
     slug: 'actions-tiktok-offline-conversions',
@@ -15,14 +58,14 @@ const destination = {
         fields: {
             accessToken: {
                 label: 'Access Token',
-                description: 'Your TikTok Access Token. Please see TikTok’s [Events API documentation](https://ads.tiktok.com/marketing_api/docs?rid=mcxl4tclmfa&id=1758051319816193) for information on how to generate an access token via the TikTok Ads Manager or API.',
+                description: 'Your TikTok Access Token. Please see TikTok’s [Events API 2.0 documentation](https://business-api.tiktok.com/portal/docs?id=1771101130925058) for information on how to generate an access token via the TikTok Ads Manager or API.',
                 type: 'string',
                 required: true
             },
             eventSetID: {
                 label: 'Event Set ID',
                 type: 'string',
-                description: 'Your TikTok Offline Event Set ID. Please see TikTok’s [Events API documentation](https://ads.tiktok.com/marketing_api/docs?rid=mcxl4tclmfa&id=1758051319816193) for information on how to find this value.',
+                description: 'Your TikTok Offline Event Set ID. Please see TikTok’s [Events API 2.0 documentation](https://business-api.tiktok.com/portal/docs?id=1771101027431425) for information on how to find this value.',
                 required: true
             }
         },
@@ -49,48 +92,159 @@ const destination = {
     presets: [
         {
             name: 'Complete Payment',
-            subscribe: 'type = "track" and event = "Order Completed"',
-            partnerAction: 'trackPaymentOfflineConversion',
+            subscribe: 'event = "Payment Completed"',
+            partnerAction: 'reportWebEvent',
             mapping: {
-                ...actions_core_1.defaultValues(trackPaymentOfflineConversion_1.default.fields),
+                ...multiProductContents,
                 event: 'CompletePayment'
             },
             type: 'automatic'
         },
         {
             name: 'Contact',
-            subscribe: 'type = "track" and event = "User Contacted Call Center"',
-            partnerAction: 'trackNonPaymentOfflineConversion',
+            subscribe: 'event = "Callback Started"',
+            partnerAction: 'reportWebEvent',
             mapping: {
-                ...actions_core_1.defaultValues(trackNonPaymentOfflineConversion_1.default.fields),
+                ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
                 event: 'Contact'
             },
             type: 'automatic'
         },
         {
             name: 'Subscribe',
-            subscribe: 'type = "track" and event = "User Subscribed In Store"',
-            partnerAction: 'trackNonPaymentOfflineConversion',
+            subscribe: 'event = "Subscription Created"',
+            partnerAction: 'reportWebEvent',
             mapping: {
-                ...actions_core_1.defaultValues(trackNonPaymentOfflineConversion_1.default.fields),
+                ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
                 event: 'Subscribe'
             },
             type: 'automatic'
         },
         {
             name: 'Submit Form',
-            subscribe: 'type = "track" and event = "Form Submitted"',
-            partnerAction: 'trackNonPaymentOfflineConversion',
+            subscribe: 'event = "Form Submitted"',
+            partnerAction: 'reportWebEvent',
             mapping: {
-                ...actions_core_1.defaultValues(trackNonPaymentOfflineConversion_1.default.fields),
+                ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
                 event: 'SubmitForm'
             },
             type: 'automatic'
+        },
+        {
+            name: 'Page View',
+            subscribe: 'type="page"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'PageView'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'View Content',
+            subscribe: 'event = "Product Viewed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'ViewContent'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Click Button',
+            subscribe: 'event = "Product Clicked"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'ClickButton'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Search',
+            subscribe: 'event = "Products Searched"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'Search'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Add to Wishlist',
+            subscribe: 'event = "Product Added to Wishlist"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToWishlist'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Add to Cart',
+            subscribe: 'event = "Product Added"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToCart'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Initiate Checkout',
+            subscribe: 'event = "Checkout Started"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'InitiateCheckout'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Add Payment Info',
+            subscribe: 'event = "Payment Info Entered"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'AddPaymentInfo'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Place an Order',
+            subscribe: 'event = "Order Completed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'PlaceAnOrder'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Download',
+            subscribe: 'event = "Download Link Clicked"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
+                event: 'Download'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Complete Registration',
+            subscribe: 'event = "Signed Up"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportOfflineEvent_1.default.fields),
+                event: 'CompleteRegistration'
+            },
+            type: 'automatic'
         }
     ],
     actions: {
         trackPaymentOfflineConversion: trackPaymentOfflineConversion_1.default,
-        trackNonPaymentOfflineConversion: trackNonPaymentOfflineConversion_1.default
+        trackNonPaymentOfflineConversion: trackNonPaymentOfflineConversion_1.default,
+        reportOfflineEvent: reportOfflineEvent_1.default
     }
 };
 exports.default = destination;

package/dist/destinations/tiktok-offline-conversions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-offline-conversions/index.ts"],"names":[],"mappings":";;;;;AAAA,wDAA4E;AAE5E,oGAA2E;AAC3E,0GAAiF;AAEjF,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,oCAAoC;IAC1C,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,KAAK,EAAE,cAAc;gBACrB,WAAW,EACT,+OAA+O;gBACjP,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,cAAc;gBACrB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,4MAA4M;gBAC9M,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC5C,OAAO,OAAO,CAAC,8DAA8D,EAAE;gBAC7E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,YAAY,EAAE,QAAQ,CAAC,UAAU;oBACjC,KAAK,EAAE,YAAY;oBACnB,SAAS,EAAE,EAAE;oBACb,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC,CAAA;QACJ,CAAC;KACF;IACD,aAAa,CAAC,EAAE,QAAQ,EAAE;QACxB,OAAO;YACL,OAAO,EAAE;gBACP,cAAc,EAAE,QAAQ,CAAC,WAAW;gBACpC,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;IACH,CAAC;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,8CAA8C;YACzD,aAAa,EAAE,+BAA+B;YAC9C,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,uCAA6B,CAAC,MAAM,CAAC;gBACtD,KAAK,EAAE,iBAAiB;aACzB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,yDAAyD;YACpE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,0CAAgC,CAAC,MAAM,CAAC;gBACzD,KAAK,EAAE,SAAS;aACjB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,uDAAuD;YAClE,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,0CAAgC,CAAC,MAAM,CAAC;gBACzD,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,6CAA6C;YACxD,aAAa,EAAE,kCAAkC;YACjD,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,0CAAgC,CAAC,MAAM,CAAC;gBACzD,KAAK,EAAE,YAAY;aACpB;YACD,IAAI,EAAE,WAAW;SAClB;KACF;IACD,OAAO,EAAE;QACP,6BAA6B,EAA7B,uCAA6B;QAC7B,gCAAgC,EAAhC,0CAAgC;KACjC;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-offline-conversions/index.ts"],"names":[],"mappings":";;;;;AAAA,wDAA4E;AAE5E,oGAA2E;AAC3E,0GAAiF;AACjF,8EAAqD;AAErD,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY;KACtB;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,QAAQ;KAClB;IACD,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;CACF,CAAA;AAED,MAAM,qBAAqB,GAAG;IAC5B,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;IAC3C,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,cAAc;YACd;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,oBAAoB,GAAG;IAC3B,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;IAC3C,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,WAAW,GAAoC;IACnD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,oCAAoC;IAC1C,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,KAAK,EAAE,cAAc;gBACrB,WAAW,EACT,qOAAqO;gBACvO,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,cAAc;gBACrB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,kMAAkM;gBACpM,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC5C,OAAO,OAAO,CAAC,8DAA8D,EAAE;gBAC7E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,YAAY,EAAE,QAAQ,CAAC,UAAU;oBACjC,KAAK,EAAE,YAAY;oBACnB,SAAS,EAAE,EAAE;oBACb,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC,CAAA;QACJ,CAAC;KACF;IACD,aAAa,CAAC,EAAE,QAAQ,EAAE;QACxB,OAAO;YACL,OAAO,EAAE;gBACP,cAAc,EAAE,QAAQ,CAAC,WAAW;gBACpC,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;IACH,CAAC;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,6BAA6B;YACxC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,iBAAiB;aACzB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;gBAC3C,KAAK,EAAE,SAAS;aACjB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;gBAC3C,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,0BAA0B;YACrC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;gBAC3C,KAAK,EAAE,YAAY;aACpB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,aAAa;YACxB,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,UAAU;aAClB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,0BAA0B;YACrC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,6BAA6B;YACxC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,QAAQ;aAChB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,SAAS,EAAE,qCAAqC;YAChD,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,eAAe;aACvB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,yBAAyB;YACpC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,kBAAkB;aAC1B;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,gBAAgB;aACxB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,cAAc;aACtB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,iCAAiC;YAC5C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;gBAC3C,KAAK,EAAE,UAAU;aAClB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,uBAAuB;YAC7B,SAAS,EAAE,qBAAqB;YAChC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,4BAAkB,CAAC,MAAM,CAAC;gBAC3C,KAAK,EAAE,sBAAsB;aAC9B;YACD,IAAI,EAAE,WAAW;SAClB;KACF;IACD,OAAO,EAAE;QACP,6BAA6B,EAA7B,uCAA6B;QAC7B,gCAAgC,EAAhC,0CAAgC;QAChC,kBAAkB,EAAlB,4BAAkB;KACnB;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/generated-types.d.ts

@@ -0,0 +1,33 @@
+export interface Payload {
+    event: string;
+    event_id?: string;
+    timestamp?: string;
+    phone_numbers?: string[];
+    email_addresses?: string[];
+    order_id?: string;
+    shop_id?: string;
+    external_ids?: string[];
+    ttclid?: string;
+    ttp?: string;
+    lead_id?: string;
+    locale?: string;
+    url?: string;
+    referrer?: string;
+    ip?: string;
+    user_agent?: string;
+    contents?: {
+        price?: number;
+        quantity?: number;
+        content_category?: string;
+        content_id?: string;
+        content_name?: string;
+        brand?: string;
+    }[];
+    content_type?: string;
+    currency?: string;
+    value?: number;
+    description?: string;
+    query?: string;
+    limited_data_use?: boolean;
+    test_event_code?: string;
+}

package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/generated-types.js.map

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

package/dist/destinations/{amazon-ads/syncAudiences → tiktok-offline-conversions/reportOfflineEvent}/index.d.ts

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

package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_fields_1 = require("../common_fields");
+const utils_1 = require("../utils");
+const action = {
+    title: 'Track Payment Offline Conversion',
+    description: 'Send details of an in-store purchase or console purchase to the Tiktok Offline Events API',
+    fields: {
+        ...common_fields_1.commonFields
+    },
+    perform: (request, { payload, settings }) => {
+        return utils_1.performOfflineEvent(request, settings, payload);
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/reportOfflineEvent/index.ts"],"names":[],"mappings":";;AAGA,oDAA+C;AAC/C,oCAA8C;AAE9C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kCAAkC;IACzC,WAAW,EAAE,2FAA2F;IACxG,MAAM,EAAE;QACN,GAAG,4BAAY;KAChB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,OAAO,2BAAmB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACxD,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/generated-types.d.ts

@@ -1,10 +1,33 @@
 export interface Payload {
     event: string;
     event_id?: string;
-    timestamp: string;
+    timestamp?: string;
     phone_numbers?: string[];
     email_addresses?: string[];
     order_id?: string;
     shop_id?: string;
-    event_channel?: string;
+    external_ids?: string[];
+    ttclid?: string;
+    ttp?: string;
+    lead_id?: string;
+    locale?: string;
+    url?: string;
+    referrer?: string;
+    ip?: string;
+    user_agent?: string;
+    contents?: {
+        price?: number;
+        quantity?: number;
+        content_category?: string;
+        content_id?: string;
+        content_name?: string;
+        brand?: string;
+    }[];
+    content_type?: string;
+    currency?: string;
+    value?: number;
+    description?: string;
+    query?: string;
+    limited_data_use?: boolean;
+    test_event_code?: string;
 }

package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.js

@@ -1,40 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const actions_core_1 = require("@segment/actions-core");
 const common_fields_1 = require("../common_fields");
-const formatter_1 = require("../formatter");
+const utils_1 = require("../utils");
 const action = {
-    title: 'Track Non Payment Offline Conversion',
-    description: 'Send a non payment related event to the TikTok Offline Conversions API',
+    title: '[Deprecated] Track Non Payment Offline Conversion',
+    description: "[Deprecated] Send a non payment related event to the TikTok Offline Conversions API. This Action has been Deprecated. Please use the 'Track Payment Offline Conversion' Action instead",
     fields: {
         ...common_fields_1.commonFields
     },
     perform: (request, { payload, settings }) => {
-        const phone_numbers = formatter_1.formatPhones(payload.phone_numbers);
-        const emails = formatter_1.formatEmails(payload.email_addresses);
-        if (phone_numbers.length < 1 && emails.length < 1)
-            throw new actions_core_1.PayloadValidationError('TikTok Offline Conversions API requires an email address and/or phone number');
-        return request('https://business-api.tiktok.com/open_api/v1.3/offline/track/', {
-            method: 'post',
-            json: {
-                event_set_id: settings.eventSetID,
-                event: payload.event,
-                event_id: payload.event_id ? `${payload.event_id}` : undefined,
-                timestamp: payload.timestamp,
-                context: {
-                    user: {
-                        phone_numbers,
-                        emails
-                    }
-                },
-                properties: {
-                    order_id: payload.order_id,
-                    shop_id: payload.shop_id,
-                    event_channel: payload.event_channel
-                },
-                partner_name: 'Segment'
-            }
-        });
+        return utils_1.performOfflineEvent(request, settings, payload);
     }
 };
 exports.default = action;

package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.ts"],"names":[],"mappings":";;AAAA,wDAAgF;AAGhF,oDAA+C;AAC/C,4CAAyD;AAEzD,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,sCAAsC;IAC7C,WAAW,EAAE,wEAAwE;IACrF,MAAM,EAAE;QACN,GAAG,4BAAY;KAChB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,MAAM,aAAa,GAAG,wBAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACzD,MAAM,MAAM,GAAG,wBAAY,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QAEpD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAC/C,MAAM,IAAI,qCAAsB,CAAC,8EAA8E,CAAC,CAAA;QAElH,OAAO,OAAO,CAAC,8DAA8D,EAAE;YAC7E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,YAAY,EAAE,QAAQ,CAAC,UAAU;gBACjC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;gBAC9D,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE;wBACJ,aAAa;wBACb,MAAM;qBACP;iBACF;gBACD,UAAU,EAAE;oBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,aAAa,EAAE,OAAO,CAAC,aAAa;iBACrC;gBACD,YAAY,EAAE,SAAS;aACxB;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.ts"],"names":[],"mappings":";;AAGA,oDAA+C;AAC/C,oCAA8C;AAE9C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,mDAAmD;IAC1D,WAAW,EACT,wLAAwL;IAC1L,MAAM,EAAE;QACN,GAAG,4BAAY;KAChB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,OAAO,2BAAmB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACxD,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/generated-types.d.ts

@@ -6,15 +6,28 @@ export interface Payload {
     email_addresses?: string[];
     order_id?: string;
     shop_id?: string;
-    event_channel?: string;
+    external_ids?: string[];
+    ttclid?: string;
+    ttp?: string;
+    lead_id?: string;
+    locale?: string;
+    url?: string;
+    referrer?: string;
+    ip?: string;
+    user_agent?: string;
     contents?: {
         price?: number;
         quantity?: number;
-        content_type?: string;
+        content_category?: string;
         content_id?: string;
         content_name?: string;
-        content_category?: string;
+        brand?: string;
     }[];
-    currency: string;
-    value: number;
+    content_type?: string;
+    currency?: string;
+    value?: number;
+    description?: string;
+    query?: string;
+    limited_data_use?: boolean;
+    test_event_code?: string;
 }

package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.js

@@ -1,136 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const actions_core_1 = require("@segment/actions-core");
 const common_fields_1 = require("../common_fields");
-const formatter_1 = require("../formatter");
+const utils_1 = require("../utils");
 const action = {
-    title: 'Track Payment Offline Conversion',
-    description: 'Send details of an in-store purchase or console purchase to the Tiktok Offline Events API',
+    title: '[Deprecated] Track Payment Offline Conversion',
+    description: "[Deprecated] Send details of an in-store purchase or console purchase to the Tiktok Offline Events API. This Action has been Deprecated. Please use the 'Track Payment Offline Conversion' Action instead",
     fields: {
-        ...common_fields_1.commonFields,
-        timestamp: {
-            label: 'Event Timestamp',
-            type: 'string',
-            description: 'Timestamp that the event took place, in ISO 8601 format. e.g. 2019-06-12T19:11:01.152Z',
-            default: {
-                '@path': '$.timestamp'
-            }
-        },
-        contents: {
-            label: 'Contents',
-            type: 'object',
-            multiple: true,
-            description: 'Array of product or content items for the offline event.',
-            properties: {
-                price: {
-                    label: 'Price',
-                    description: 'Price of the product or content item. Price is a required field for all content items.',
-                    type: 'number'
-                },
-                quantity: {
-                    label: 'Quantity',
-                    description: 'Quantity of this product ot item in the offline event. Quantity is a required field for all content items.',
-                    type: 'number'
-                },
-                content_type: {
-                    label: 'Content Type',
-                    description: 'Product type',
-                    type: 'string'
-                },
-                content_id: {
-                    label: 'Content ID',
-                    description: 'Product or content item identifier. Content ID is a required field for all product or content items.',
-                    type: 'string'
-                },
-                content_name: {
-                    label: 'Content Name',
-                    description: 'Name of the product or content item.',
-                    type: 'string'
-                },
-                content_category: {
-                    label: 'Content Category',
-                    description: 'Category of the product or content item.',
-                    type: 'string'
-                }
-            },
-            default: {
-                '@arrayPath': [
-                    '$.properties.products',
-                    {
-                        price: {
-                            '@path': 'price'
-                        },
-                        quantity: {
-                            '@path': 'quantity'
-                        },
-                        content_type: {
-                            '@path': 'type'
-                        },
-                        content_id: {
-                            '@path': 'product_id'
-                        },
-                        content_name: {
-                            '@path': 'name'
-                        },
-                        content_category: {
-                            '@path': 'category'
-                        }
-                    }
-                ]
-            }
-        },
-        currency: {
-            label: 'Currency',
-            type: 'string',
-            required: true,
-            description: 'ISO 4217 code. Required for revenue reporting. Example: "USD".List of currencies currently supported: AED, ARS, AUD, BDT, BHD, BIF, BOB, BRL, CAD, CHF, CLP, CNY, COP, CRC, CZK, DKK, DZD, EGP, EUR, GBP, GTQ, HKD, HNL, HUF, IDR, ILS, INR, ISK, JPY, KES, KHR, KRW, KWD, KZT, MAD, MOP, MXN, MYR, NGN, NIO, NOK, NZD, OMR, PEN, PHP, PHP, PKR, PLN, PYG, QAR, RON, RUB, SAR, SEK, SGD, THB, TRY, TWD, UAH, USD, VES, VND, ZAR.',
-            default: {
-                '@path': '$.properties.currency'
-            }
-        },
-        value: {
-            label: 'Value',
-            type: 'number',
-            required: true,
-            description: 'Revenue of total products or content items. Required for revenue reporting. Must be a number. e.g. 101.99 and not "101.99 USD"',
-            default: {
-                '@if': {
-                    exists: { '@path': '$.properties.value' },
-                    then: { '@path': '$.properties.value' },
-                    else: { '@path': '$.properties.revenue' }
-                }
-            }
-        }
+        ...common_fields_1.commonFields
     },
     perform: (request, { payload, settings }) => {
-        const phone_numbers = formatter_1.formatPhones(payload.phone_numbers);
-        const emails = formatter_1.formatEmails(payload.email_addresses);
-        if (phone_numbers.length < 1 && emails.length < 1)
-            throw new actions_core_1.PayloadValidationError('TikTok Offline Conversions API requires an email address and/or phone number');
-        return request('https://business-api.tiktok.com/open_api/v1.3/offline/track/', {
-            method: 'post',
-            json: {
-                event_set_id: settings.eventSetID,
-                event: payload.event,
-                event_id: payload.event_id ? `${payload.event_id}` : undefined,
-                timestamp: payload.timestamp,
-                context: {
-                    user: {
-                        phone_numbers,
-                        emails
-                    }
-                },
-                properties: {
-                    order_id: payload.order_id,
-                    shop_id: payload.shop_id,
-                    contents: payload.contents,
-                    currency: payload.currency,
-                    value: payload.value,
-                    event_channel: payload.event_channel
-                },
-                partner_name: 'Segment'
-            }
-        });
+        return utils_1.performOfflineEvent(request, settings, payload);
     }
 };
 exports.default = action;

package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.ts"],"names":[],"mappings":";;AAAA,wDAAgF;AAGhF,oDAA+C;AAC/C,4CAAyD;AAEzD,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kCAAkC;IACzC,WAAW,EAAE,2FAA2F;IACxG,MAAM,EAAE;QACN,GAAG,4BAAY;QACf,SAAS,EAAE;YACT,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wFAAwF;YACrG,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0DAA0D;YACvE,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,WAAW,EAAE,wFAAwF;oBACrG,IAAI,EAAE,QAAQ;iBACf;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,WAAW,EACT,4GAA4G;oBAC9G,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,cAAc;oBAC3B,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,YAAY;oBACnB,WAAW,EACT,sGAAsG;oBACxG,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,sCAAsC;oBACnD,IAAI,EAAE,QAAQ;iBACf;gBACD,gBAAgB,EAAE;oBAChB,KAAK,EAAE,kBAAkB;oBACzB,WAAW,EAAE,0CAA0C;oBACvD,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,uBAAuB;oBACvB;wBACE,KAAK,EAAE;4BACL,OAAO,EAAE,OAAO;yBACjB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,UAAU;yBACpB;wBACD,YAAY,EAAE;4BACZ,OAAO,EAAE,MAAM;yBAChB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,YAAY;yBACtB;wBACD,YAAY,EAAE;4BACZ,OAAO,EAAE,MAAM;yBAChB;wBACD,gBAAgB,EAAE;4BAChB,OAAO,EAAE,UAAU;yBACpB;qBACF;iBACF;aACF;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,kaAAka;YACpa,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,gIAAgI;YAClI,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,sBAAsB,EAAE;iBAC1C;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,MAAM,aAAa,GAAG,wBAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACzD,MAAM,MAAM,GAAG,wBAAY,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QAEpD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAC/C,MAAM,IAAI,qCAAsB,CAAC,8EAA8E,CAAC,CAAA;QAElH,OAAO,OAAO,CAAC,8DAA8D,EAAE;YAC7E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,YAAY,EAAE,QAAQ,CAAC,UAAU;gBACjC,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;gBAC9D,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE;wBACJ,aAAa;wBACb,MAAM;qBACP;iBACF;gBACD,UAAU,EAAE;oBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,aAAa,EAAE,OAAO,CAAC,aAAa;iBACrC;gBACD,YAAY,EAAE,SAAS;aACxB;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.ts"],"names":[],"mappings":";;AAGA,oDAA+C;AAC/C,oCAA8C;AAE9C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,+CAA+C;IACtD,WAAW,EACT,2MAA2M;IAC7M,MAAM,EAAE;QACN,GAAG,4BAAY;KAChB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,OAAO,2BAAmB,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACxD,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/tiktok-offline-conversions/utils.d.ts

@@ -0,0 +1,8 @@
+import { RequestClient } from '@segment/actions-core';
+import { Settings } from './generated-types';
+import { Payload as ReportOfflineEventPayload } from './reportOfflineEvent/generated-types';
+import { Payload as TrackNonPaymentOfflineConversionPayload } from './trackNonPaymentOfflineConversion/generated-types';
+import { Payload as TrackPaymentOfflineConversionPayload } from './trackPaymentOfflineConversion/generated-types';
+declare type OfflineEventPayload = ReportOfflineEventPayload | TrackNonPaymentOfflineConversionPayload | TrackPaymentOfflineConversionPayload;
+export declare function performOfflineEvent(request: RequestClient, settings: Settings, payload: OfflineEventPayload): Promise<import("@segment/actions-core").ModifiedResponse<unknown>>;
+export {};