@segment/action-destinations 3.239.5 → 3.240.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/dist/destinations/aggregations-io/index.js +17 -7
  2. package/dist/destinations/aggregations-io/index.js.map +1 -1
  3. package/dist/destinations/aggregations-io/types.d.ts +8 -0
  4. package/dist/destinations/aggregations-io/types.js +8 -0
  5. package/dist/destinations/aggregations-io/types.js.map +1 -0
  6. package/dist/destinations/amazon-ads/generated-types.d.ts +3 -0
  7. package/dist/destinations/amazon-ads/generated-types.js.map +1 -0
  8. package/dist/destinations/amazon-ads/index.d.ts +4 -0
  9. package/dist/destinations/amazon-ads/index.js +87 -0
  10. package/dist/destinations/amazon-ads/index.js.map +1 -0
  11. package/dist/destinations/amazon-ads/syncAudiences/generated-types.d.ts +2 -0
  12. package/dist/destinations/amazon-ads/syncAudiences/generated-types.js +3 -0
  13. package/dist/destinations/amazon-ads/syncAudiences/generated-types.js.map +1 -0
  14. package/dist/destinations/amazon-ads/syncAudiences/index.d.ts +5 -0
  15. package/dist/destinations/amazon-ads/syncAudiences/index.js +15 -0
  16. package/dist/destinations/amazon-ads/syncAudiences/index.js.map +1 -0
  17. package/dist/destinations/amazon-ads/types.d.ts +22 -0
  18. package/dist/destinations/amazon-ads/types.js +11 -0
  19. package/dist/destinations/amazon-ads/types.js.map +1 -0
  20. package/dist/destinations/braze/trackEvent/generated-types.d.ts +1 -0
  21. package/dist/destinations/braze/trackEvent/index.js +8 -0
  22. package/dist/destinations/braze/trackEvent/index.js.map +1 -1
  23. package/dist/destinations/braze/trackPurchase/generated-types.d.ts +1 -0
  24. package/dist/destinations/braze/trackPurchase/index.js +8 -0
  25. package/dist/destinations/braze/trackPurchase/index.js.map +1 -1
  26. package/dist/destinations/braze/utils.js +15 -11
  27. package/dist/destinations/braze/utils.js.map +1 -1
  28. package/dist/destinations/courier/generated-types.d.ts +4 -0
  29. package/dist/destinations/courier/generated-types.js +3 -0
  30. package/dist/destinations/courier/generated-types.js.map +1 -0
  31. package/dist/destinations/courier/index.d.ts +4 -0
  32. package/dist/destinations/courier/index.js +44 -0
  33. package/dist/destinations/courier/index.js.map +1 -0
  34. package/dist/destinations/courier/postToCourier/generated-types.d.ts +5 -0
  35. package/dist/destinations/courier/postToCourier/generated-types.js +3 -0
  36. package/dist/destinations/courier/postToCourier/generated-types.js.map +1 -0
  37. package/dist/destinations/courier/postToCourier/index.js +35 -0
  38. package/dist/destinations/courier/postToCourier/index.js.map +1 -0
  39. package/dist/destinations/criteo-audiences/criteo-audiences.js +11 -6
  40. package/dist/destinations/criteo-audiences/criteo-audiences.js.map +1 -1
  41. package/dist/destinations/display-video-360/index.js +1 -1
  42. package/dist/destinations/display-video-360/index.js.map +1 -1
  43. package/dist/destinations/engage/sendgrid/sendEmail/SendEmailPerformer.js +7 -1
  44. package/dist/destinations/engage/sendgrid/sendEmail/SendEmailPerformer.js.map +1 -1
  45. package/dist/destinations/engage/twilio/utils/TwilioMessageSender.js +8 -2
  46. package/dist/destinations/engage/twilio/utils/TwilioMessageSender.js.map +1 -1
  47. package/dist/destinations/facebook-conversions-api/constants.d.ts +1 -1
  48. package/dist/destinations/facebook-conversions-api/constants.js +1 -1
  49. package/dist/destinations/hubspot/sendCustomBehavioralEvent/index.js +26 -0
  50. package/dist/destinations/hubspot/sendCustomBehavioralEvent/index.js.map +1 -1
  51. package/dist/destinations/hubspot/utils.d.ts +10 -0
  52. package/dist/destinations/index.js +6 -0
  53. package/dist/destinations/index.js.map +1 -1
  54. package/dist/destinations/kameleoon/index.js +1 -1
  55. package/dist/destinations/kameleoon/index.js.map +1 -1
  56. package/dist/destinations/linkedin-conversions/api/api.test.js +43 -25
  57. package/dist/destinations/linkedin-conversions/api/api.test.js.map +1 -1
  58. package/dist/destinations/linkedin-conversions/api/index.d.ts +3 -2
  59. package/dist/destinations/linkedin-conversions/api/index.js +31 -15
  60. package/dist/destinations/linkedin-conversions/api/index.js.map +1 -1
  61. package/dist/destinations/linkedin-conversions/streamConversion/generated-types.d.ts +1 -1
  62. package/dist/destinations/linkedin-conversions/streamConversion/index.js +2 -1
  63. package/dist/destinations/linkedin-conversions/streamConversion/index.js.map +1 -1
  64. package/dist/destinations/linkedin-conversions/types.d.ts +6 -7
  65. package/dist/destinations/schematic/generated-types.d.ts +3 -0
  66. package/dist/destinations/schematic/generated-types.js +3 -0
  67. package/dist/destinations/schematic/generated-types.js.map +1 -0
  68. package/dist/destinations/schematic/identifyUser/generated-types.d.ts +18 -0
  69. package/dist/destinations/schematic/identifyUser/generated-types.js +3 -0
  70. package/dist/destinations/schematic/identifyUser/generated-types.js.map +1 -0
  71. package/dist/destinations/schematic/identifyUser/index.d.ts +5 -0
  72. package/dist/destinations/schematic/identifyUser/index.js +114 -0
  73. package/dist/destinations/schematic/identifyUser/index.js.map +1 -0
  74. package/dist/destinations/schematic/index.d.ts +4 -0
  75. package/dist/destinations/schematic/index.js +58 -0
  76. package/dist/destinations/schematic/index.js.map +1 -0
  77. package/dist/destinations/schematic/trackEvent/generated-types.d.ts +13 -0
  78. package/dist/destinations/schematic/trackEvent/generated-types.js +3 -0
  79. package/dist/destinations/schematic/trackEvent/generated-types.js.map +1 -0
  80. package/dist/destinations/schematic/trackEvent/index.d.ts +5 -0
  81. package/dist/destinations/schematic/trackEvent/index.js +89 -0
  82. package/dist/destinations/schematic/trackEvent/index.js.map +1 -0
  83. package/dist/destinations/surveysparrow/createContact/generated-types.d.ts +10 -0
  84. package/dist/destinations/surveysparrow/createContact/generated-types.js +3 -0
  85. package/dist/destinations/surveysparrow/createContact/generated-types.js.map +1 -0
  86. package/dist/destinations/surveysparrow/createContact/index.d.ts +5 -0
  87. package/dist/destinations/surveysparrow/createContact/index.js +105 -0
  88. package/dist/destinations/surveysparrow/createContact/index.js.map +1 -0
  89. package/dist/destinations/surveysparrow/generated-types.d.ts +3 -0
  90. package/dist/destinations/surveysparrow/generated-types.js +3 -0
  91. package/dist/destinations/surveysparrow/generated-types.js.map +1 -0
  92. package/dist/destinations/surveysparrow/index.d.ts +4 -0
  93. package/dist/destinations/surveysparrow/index.js +40 -0
  94. package/dist/destinations/surveysparrow/index.js.map +1 -0
  95. package/dist/destinations/surveysparrow/triggerSurvey/generated-types.d.ts +10 -0
  96. package/dist/destinations/surveysparrow/triggerSurvey/generated-types.js +3 -0
  97. package/dist/destinations/surveysparrow/triggerSurvey/generated-types.js.map +1 -0
  98. package/dist/destinations/surveysparrow/triggerSurvey/index.d.ts +8 -0
  99. package/dist/destinations/surveysparrow/triggerSurvey/index.js +165 -0
  100. package/dist/destinations/surveysparrow/triggerSurvey/index.js.map +1 -0
  101. package/dist/destinations/tiktok-conversions-sandbox/common_fields.d.ts +2 -0
  102. package/dist/destinations/tiktok-conversions-sandbox/common_fields.js +244 -0
  103. package/dist/destinations/tiktok-conversions-sandbox/common_fields.js.map +1 -0
  104. package/dist/destinations/tiktok-conversions-sandbox/formatter.d.ts +3 -0
  105. package/dist/destinations/tiktok-conversions-sandbox/formatter.js +43 -0
  106. package/dist/destinations/tiktok-conversions-sandbox/formatter.js.map +1 -0
  107. package/dist/destinations/tiktok-conversions-sandbox/generated-types.d.ts +4 -0
  108. package/dist/destinations/tiktok-conversions-sandbox/generated-types.js +3 -0
  109. package/dist/destinations/tiktok-conversions-sandbox/generated-types.js.map +1 -0
  110. package/dist/destinations/tiktok-conversions-sandbox/index.d.ts +4 -0
  111. package/dist/destinations/tiktok-conversions-sandbox/index.js +247 -0
  112. package/dist/destinations/tiktok-conversions-sandbox/index.js.map +1 -0
  113. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.d.ts +33 -0
  114. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.js +3 -0
  115. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.js.map +1 -0
  116. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.d.ts +5 -0
  117. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.js +16 -0
  118. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.js.map +1 -0
  119. package/dist/destinations/tiktok-conversions-sandbox/utils.d.ts +4 -0
  120. package/dist/destinations/tiktok-conversions-sandbox/utils.js +65 -0
  121. package/dist/destinations/tiktok-conversions-sandbox/utils.js.map +1 -0
  122. package/dist/destinations/tiktok-offline-conversions/common_fields.js +20 -179
  123. package/dist/destinations/tiktok-offline-conversions/common_fields.js.map +1 -1
  124. package/dist/destinations/tiktok-offline-conversions/formatter.d.ts +0 -1
  125. package/dist/destinations/tiktok-offline-conversions/formatter.js +1 -11
  126. package/dist/destinations/tiktok-offline-conversions/formatter.js.map +1 -1
  127. package/dist/destinations/tiktok-offline-conversions/index.js +15 -169
  128. package/dist/destinations/tiktok-offline-conversions/index.js.map +1 -1
  129. package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/generated-types.d.ts +2 -25
  130. package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.js +29 -4
  131. package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.js.map +1 -1
  132. package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/generated-types.d.ts +5 -18
  133. package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.js +126 -5
  134. package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.js.map +1 -1
  135. package/dist/destinations/tiktok-offline-conversions-sandbox/common_fields.d.ts +2 -0
  136. package/dist/destinations/tiktok-offline-conversions-sandbox/common_fields.js +244 -0
  137. package/dist/destinations/tiktok-offline-conversions-sandbox/common_fields.js.map +1 -0
  138. package/dist/destinations/tiktok-offline-conversions-sandbox/formatter.d.ts +3 -0
  139. package/dist/destinations/tiktok-offline-conversions-sandbox/formatter.js +43 -0
  140. package/dist/destinations/tiktok-offline-conversions-sandbox/formatter.js.map +1 -0
  141. package/dist/destinations/tiktok-offline-conversions-sandbox/generated-types.d.ts +4 -0
  142. package/dist/destinations/tiktok-offline-conversions-sandbox/generated-types.js +3 -0
  143. package/dist/destinations/tiktok-offline-conversions-sandbox/generated-types.js.map +1 -0
  144. package/dist/destinations/tiktok-offline-conversions-sandbox/index.d.ts +4 -0
  145. package/dist/destinations/tiktok-offline-conversions-sandbox/index.js +251 -0
  146. package/dist/destinations/tiktok-offline-conversions-sandbox/index.js.map +1 -0
  147. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/generated-types.js +3 -0
  148. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/generated-types.js.map +1 -0
  149. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/index.d.ts +5 -0
  150. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/index.js.map +1 -0
  151. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/generated-types.d.ts +33 -0
  152. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/generated-types.js +3 -0
  153. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/generated-types.js.map +1 -0
  154. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/index.d.ts +5 -0
  155. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/index.js +16 -0
  156. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/index.js.map +1 -0
  157. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/generated-types.d.ts +33 -0
  158. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/generated-types.js +3 -0
  159. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/generated-types.js.map +1 -0
  160. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/index.d.ts +5 -0
  161. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/index.js +16 -0
  162. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/index.js.map +1 -0
  163. package/dist/destinations/{tiktok-offline-conversions → tiktok-offline-conversions-sandbox}/utils.js +10 -9
  164. package/dist/destinations/tiktok-offline-conversions-sandbox/utils.js.map +1 -0
  165. package/package.json +4 -4
  166. package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/generated-types.js.map +0 -1
  167. package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/index.js.map +0 -1
  168. package/dist/destinations/tiktok-offline-conversions/utils.js.map +0 -1
  169. /package/dist/destinations/{tiktok-offline-conversions/reportOfflineEvent → amazon-ads}/generated-types.js +0 -0
  170. /package/dist/destinations/{tiktok-offline-conversions/reportOfflineEvent → courier/postToCourier}/index.d.ts +0 -0
  171. /package/dist/destinations/{tiktok-offline-conversions → tiktok-offline-conversions-sandbox}/reportOfflineEvent/generated-types.d.ts +0 -0
  172. /package/dist/destinations/{tiktok-offline-conversions → tiktok-offline-conversions-sandbox}/reportOfflineEvent/index.js +0 -0
  173. /package/dist/destinations/{tiktok-offline-conversions → tiktok-offline-conversions-sandbox}/utils.d.ts +0 -0
@@ -6,28 +6,15 @@ export interface Payload {
6
6
  email_addresses?: string[];
7
7
  order_id?: string;
8
8
  shop_id?: string;
9
- external_ids?: string[];
10
- ttclid?: string;
11
- ttp?: string;
12
- lead_id?: string;
13
- locale?: string;
14
- url?: string;
15
- referrer?: string;
16
- ip?: string;
17
- user_agent?: string;
9
+ event_channel?: string;
18
10
  contents?: {
19
11
  price?: number;
20
12
  quantity?: number;
21
- content_category?: string;
13
+ content_type?: string;
22
14
  content_id?: string;
23
15
  content_name?: string;
24
- brand?: string;
16
+ content_category?: string;
25
17
  }[];
26
- content_type?: string;
27
- currency?: string;
28
- value?: number;
29
- description?: string;
30
- query?: string;
31
- limited_data_use?: boolean;
32
- test_event_code?: string;
18
+ currency: string;
19
+ value: number;
33
20
  }
@@ -1,15 +1,136 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const actions_core_1 = require("@segment/actions-core");
3
4
  const common_fields_1 = require("../common_fields");
4
- const utils_1 = require("../utils");
5
+ const formatter_1 = require("../formatter");
5
6
  const action = {
6
- title: '[Deprecated] Track Payment Offline Conversion',
7
- 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",
7
+ title: 'Track Payment Offline Conversion',
8
+ description: 'Send details of an in-store purchase or console purchase to the Tiktok Offline Events API',
8
9
  fields: {
9
- ...common_fields_1.commonFields
10
+ ...common_fields_1.commonFields,
11
+ timestamp: {
12
+ label: 'Event Timestamp',
13
+ type: 'string',
14
+ description: 'Timestamp that the event took place, in ISO 8601 format. e.g. 2019-06-12T19:11:01.152Z',
15
+ default: {
16
+ '@path': '$.timestamp'
17
+ }
18
+ },
19
+ contents: {
20
+ label: 'Contents',
21
+ type: 'object',
22
+ multiple: true,
23
+ description: 'Array of product or content items for the offline event.',
24
+ properties: {
25
+ price: {
26
+ label: 'Price',
27
+ description: 'Price of the product or content item. Price is a required field for all content items.',
28
+ type: 'number'
29
+ },
30
+ quantity: {
31
+ label: 'Quantity',
32
+ description: 'Quantity of this product ot item in the offline event. Quantity is a required field for all content items.',
33
+ type: 'number'
34
+ },
35
+ content_type: {
36
+ label: 'Content Type',
37
+ description: 'Product type',
38
+ type: 'string'
39
+ },
40
+ content_id: {
41
+ label: 'Content ID',
42
+ description: 'Product or content item identifier. Content ID is a required field for all product or content items.',
43
+ type: 'string'
44
+ },
45
+ content_name: {
46
+ label: 'Content Name',
47
+ description: 'Name of the product or content item.',
48
+ type: 'string'
49
+ },
50
+ content_category: {
51
+ label: 'Content Category',
52
+ description: 'Category of the product or content item.',
53
+ type: 'string'
54
+ }
55
+ },
56
+ default: {
57
+ '@arrayPath': [
58
+ '$.properties.products',
59
+ {
60
+ price: {
61
+ '@path': 'price'
62
+ },
63
+ quantity: {
64
+ '@path': 'quantity'
65
+ },
66
+ content_type: {
67
+ '@path': 'type'
68
+ },
69
+ content_id: {
70
+ '@path': 'product_id'
71
+ },
72
+ content_name: {
73
+ '@path': 'name'
74
+ },
75
+ content_category: {
76
+ '@path': 'category'
77
+ }
78
+ }
79
+ ]
80
+ }
81
+ },
82
+ currency: {
83
+ label: 'Currency',
84
+ type: 'string',
85
+ required: true,
86
+ 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.',
87
+ default: {
88
+ '@path': '$.properties.currency'
89
+ }
90
+ },
91
+ value: {
92
+ label: 'Value',
93
+ type: 'number',
94
+ required: true,
95
+ 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"',
96
+ default: {
97
+ '@if': {
98
+ exists: { '@path': '$.properties.value' },
99
+ then: { '@path': '$.properties.value' },
100
+ else: { '@path': '$.properties.revenue' }
101
+ }
102
+ }
103
+ }
10
104
  },
11
105
  perform: (request, { payload, settings }) => {
12
- return utils_1.performOfflineEvent(request, settings, payload);
106
+ const phone_numbers = formatter_1.formatPhones(payload.phone_numbers);
107
+ const emails = formatter_1.formatEmails(payload.email_addresses);
108
+ if (phone_numbers.length < 1 && emails.length < 1)
109
+ throw new actions_core_1.PayloadValidationError('TikTok Offline Conversions API requires an email address and/or phone number');
110
+ return request('https://business-api.tiktok.com/open_api/v1.3/offline/track/', {
111
+ method: 'post',
112
+ json: {
113
+ event_set_id: settings.eventSetID,
114
+ event: payload.event,
115
+ event_id: payload.event_id ? `${payload.event_id}` : undefined,
116
+ timestamp: payload.timestamp,
117
+ context: {
118
+ user: {
119
+ phone_numbers,
120
+ emails
121
+ }
122
+ },
123
+ properties: {
124
+ order_id: payload.order_id,
125
+ shop_id: payload.shop_id,
126
+ contents: payload.contents,
127
+ currency: payload.currency,
128
+ value: payload.value,
129
+ event_channel: payload.event_channel
130
+ },
131
+ partner_name: 'Segment'
132
+ }
133
+ });
13
134
  }
14
135
  };
15
136
  exports.default = action;
@@ -1 +1 @@
1
- {"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"}
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"}
@@ -0,0 +1,2 @@
1
+ import { InputField } from '@segment/actions-core';
2
+ export declare const commonFields: Record<string, InputField>;
@@ -0,0 +1,244 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.commonFields = void 0;
4
+ exports.commonFields = {
5
+ event: {
6
+ label: 'Event Name',
7
+ type: 'string',
8
+ required: true,
9
+ description: 'Conversion event name. Please refer to the "Offline Standard Events" section on in TikTok’s [Events API 2.0 documentation](https://business-api.tiktok.com/portal/docs?id=1771101186666498) for accepted event names.'
10
+ },
11
+ event_id: {
12
+ label: 'Event ID',
13
+ type: 'string',
14
+ description: 'Any hashed ID that can identify a unique user/session.',
15
+ default: {
16
+ '@path': '$.messageId'
17
+ }
18
+ },
19
+ timestamp: {
20
+ label: 'Event Timestamp',
21
+ type: 'string',
22
+ description: 'Timestamp that the event took place, in ISO 8601 format.',
23
+ default: {
24
+ '@path': '$.timestamp'
25
+ }
26
+ },
27
+ phone_numbers: {
28
+ label: 'Phone Number',
29
+ description: 'A single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. At least one phone number value is required if both Email and External ID fields are empty.',
30
+ type: 'string',
31
+ multiple: true,
32
+ default: {
33
+ '@if': {
34
+ exists: { '@path': '$.properties.phone' },
35
+ then: { '@path': '$.properties.phone' },
36
+ else: { '@path': '$.context.traits.phone' }
37
+ }
38
+ }
39
+ },
40
+ email_addresses: {
41
+ label: 'Email',
42
+ description: 'A single email address or an array of email addresses. Segment will hash this value before sending to TikTok. At least one email value is required if both Phone Number and External ID fields are empty.',
43
+ type: 'string',
44
+ multiple: true,
45
+ default: {
46
+ '@if': {
47
+ exists: { '@path': '$.properties.email' },
48
+ then: { '@path': '$.properties.email' },
49
+ else: { '@path': '$.context.traits.email' }
50
+ }
51
+ }
52
+ },
53
+ order_id: {
54
+ label: 'Order ID',
55
+ type: 'string',
56
+ description: 'Order ID of the transaction.',
57
+ default: {
58
+ '@path': '$.properties.order_id'
59
+ }
60
+ },
61
+ shop_id: {
62
+ label: 'Shop ID',
63
+ type: 'string',
64
+ description: 'Shop ID of the transaction.',
65
+ default: {
66
+ '@path': '$.properties.shop_id'
67
+ }
68
+ },
69
+ external_ids: {
70
+ label: 'External ID',
71
+ description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok. TikTok Offline Conversions Destination supports both string and string[] types for sending external ID(s). At least one external ID value is required if both Email and Phone Number fields are empty.',
72
+ type: 'string',
73
+ multiple: true,
74
+ default: {
75
+ '@if': {
76
+ exists: { '@path': '$.userId' },
77
+ then: { '@path': '$.userId' },
78
+ else: { '@path': '$.anonymousId' }
79
+ }
80
+ }
81
+ },
82
+ ttclid: {
83
+ label: 'TikTok Click ID',
84
+ description: 'The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See [Set up ttclid](https://ads.tiktok.com/marketing_api/docs?rid=4eezrhr6lg4&id=1681728034437121) for details.',
85
+ type: 'string',
86
+ default: {
87
+ '@if': {
88
+ exists: { '@path': '$.properties.ttclid' },
89
+ then: { '@path': '$.properties.ttclid' },
90
+ else: { '@path': '$.integrations.TikTok Offline Conversions.ttclid' }
91
+ }
92
+ }
93
+ },
94
+ ttp: {
95
+ label: 'TikTok Cookie ID',
96
+ description: 'TikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the `_ttp` cookie. The value of `_ttp` is used to match website visitor events with TikTok ads. You can extract the value of `_ttp` and attach the value here. To learn more about the `ttp` parameter, refer to [Events API 2.0 - Send TikTok Cookie](https://ads.tiktok.com/marketing_api/docs?id=%201771100936446977) (`_ttp`).',
97
+ type: 'string',
98
+ default: {
99
+ '@if': {
100
+ exists: { '@path': '$.properties.ttp' },
101
+ then: { '@path': '$.properties.ttp' },
102
+ else: { '@path': '$.integrations.TikTok Offline Conversions.ttp' }
103
+ }
104
+ }
105
+ },
106
+ lead_id: {
107
+ label: 'TikTok Lead ID',
108
+ description: 'ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability',
109
+ type: 'string',
110
+ default: { '@path': '$.properties.lead_id' }
111
+ },
112
+ locale: {
113
+ label: 'Locale',
114
+ description: 'The BCP 47 language identifier. For reference, refer to the [IETF BCP 47 standardized code](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).',
115
+ type: 'string',
116
+ default: {
117
+ '@path': '$.context.locale'
118
+ }
119
+ },
120
+ url: {
121
+ label: 'Page URL',
122
+ type: 'string',
123
+ description: 'The page URL where the conversion event took place.',
124
+ default: {
125
+ '@path': '$.context.page.url'
126
+ }
127
+ },
128
+ referrer: {
129
+ label: 'Page Referrer',
130
+ type: 'string',
131
+ description: 'The page referrer.',
132
+ default: {
133
+ '@path': '$.context.page.referrer'
134
+ }
135
+ },
136
+ ip: {
137
+ label: 'IP Address',
138
+ type: 'string',
139
+ description: 'IP address of the browser.',
140
+ default: {
141
+ '@path': '$.context.ip'
142
+ }
143
+ },
144
+ user_agent: {
145
+ label: 'User Agent',
146
+ type: 'string',
147
+ description: 'User agent from the user’s device.',
148
+ default: {
149
+ '@path': '$.context.userAgent'
150
+ }
151
+ },
152
+ contents: {
153
+ label: 'Contents',
154
+ type: 'object',
155
+ multiple: true,
156
+ description: 'Related item details for the event.',
157
+ properties: {
158
+ price: {
159
+ label: 'Price',
160
+ description: 'Price of the item.',
161
+ type: 'number'
162
+ },
163
+ quantity: {
164
+ label: 'Quantity',
165
+ description: 'Number of items.',
166
+ type: 'number'
167
+ },
168
+ content_category: {
169
+ label: 'Content Category',
170
+ description: 'Category of the product item.',
171
+ type: 'string'
172
+ },
173
+ content_id: {
174
+ label: 'Content ID',
175
+ description: 'ID of the product item.',
176
+ type: 'string'
177
+ },
178
+ content_name: {
179
+ label: 'Content Name',
180
+ description: 'Name of the product item.',
181
+ type: 'string'
182
+ },
183
+ brand: {
184
+ label: 'Brand',
185
+ description: 'Brand name of the product item.',
186
+ type: 'string'
187
+ }
188
+ }
189
+ },
190
+ content_type: {
191
+ label: 'Content Type',
192
+ description: 'Type of the product item. When the `content_id` in the `Contents` field is specified as a `sku_id`, set this field to `product`. When the `content_id` in the `Contents` field is specified as an `item_group_id`, set this field to `product_group`.',
193
+ type: 'string',
194
+ choices: ['product', 'product_group'],
195
+ default: 'product'
196
+ },
197
+ currency: {
198
+ label: 'Currency',
199
+ type: 'string',
200
+ description: 'Currency for the value specified as ISO 4217 code.',
201
+ default: {
202
+ '@path': '$.properties.currency'
203
+ }
204
+ },
205
+ value: {
206
+ label: 'Value',
207
+ type: 'number',
208
+ description: 'Value of the order or items sold.',
209
+ default: {
210
+ '@if': {
211
+ exists: { '@path': '$.properties.value' },
212
+ then: { '@path': '$.properties.value' },
213
+ else: { '@path': '$.properties.revenue' }
214
+ }
215
+ }
216
+ },
217
+ description: {
218
+ label: 'Description',
219
+ type: 'string',
220
+ description: 'A string description of the web event.'
221
+ },
222
+ query: {
223
+ label: 'Query',
224
+ type: 'string',
225
+ description: 'The text string that was searched for.',
226
+ default: {
227
+ '@path': '$.properties.query'
228
+ }
229
+ },
230
+ limited_data_use: {
231
+ label: 'Limited Data Use',
232
+ type: 'boolean',
233
+ description: 'Use this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to [Events API 2.0 - Limited Data Use](https://ads.tiktok.com/marketing_api/docs?id=1771101204435970).',
234
+ default: {
235
+ '@path': '$.properties.limited_data_use'
236
+ }
237
+ },
238
+ test_event_code: {
239
+ label: 'Test Event Code',
240
+ type: 'string',
241
+ description: 'Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the "Test Event" tab. You\'ll want to remove your Test Event Code when sending real traffic through this integration.'
242
+ }
243
+ };
244
+ //# sourceMappingURL=common_fields.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"common_fields.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-offline-conversions-sandbox/common_fields.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAA+B;IACtD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,uNAAuN;KAC1N;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wDAAwD;QACrE,OAAO,EAAE;YACP,OAAO,EAAE,aAAa;SACvB;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,0DAA0D;QACvE,OAAO,EAAE;YACP,OAAO,EAAE,aAAa;SACvB;KACF;IACD,aAAa,EAAE;QACb,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,8NAA8N;QAChO,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC5C;SACF;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,OAAO;QACd,WAAW,EACT,2MAA2M;QAC7M,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC5C;SACF;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE;YACP,OAAO,EAAE,uBAAuB;SACjC;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE;YACP,OAAO,EAAE,sBAAsB;SAChC;KACF;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,gUAAgU;QAClU,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;aACnC;SACF;KACF;IACD,MAAM,EAAE;QACN,KAAK,EAAE,iBAAiB;QACxB,WAAW,EACT,+NAA+N;QACjO,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;gBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;gBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,kDAAkD,EAAE;aACtE;SACF;KACF;IACD,GAAG,EAAE;QACH,KAAK,EAAE,kBAAkB;QACzB,WAAW,EACT,+bAA+b;QACjc,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,+CAA+C,EAAE;aACnE;SACF;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,gBAAgB;QACvB,WAAW,EACT,0LAA0L;QAC5L,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;KAC7C;IACD,MAAM,EAAE;QACN,KAAK,EAAE,QAAQ;QACf,WAAW,EACT,4IAA4I;QAC9I,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,kBAAkB;SAC5B;KACF;IACD,GAAG,EAAE;QACH,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,qDAAqD;QAClE,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oBAAoB;QACjC,OAAO,EAAE;YACP,OAAO,EAAE,yBAAyB;SACnC;KACF;IACD,EAAE,EAAE;QACF,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE;YACP,OAAO,EAAE,cAAc;SACxB;KACF;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE;YACP,OAAO,EAAE,qBAAqB;SAC/B;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,qCAAqC;QAClD,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,oBAAoB;gBACjC,IAAI,EAAE,QAAQ;aACf;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,QAAQ;aACf;YACD,gBAAgB,EAAE;gBAChB,KAAK,EAAE,kBAAkB;gBACzB,WAAW,EAAE,+BAA+B;gBAC5C,IAAI,EAAE,QAAQ;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,QAAQ;aACf;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,QAAQ;aACf;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,iCAAiC;gBAC9C,IAAI,EAAE,QAAQ;aACf;SACF;KACF;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,uPAAuP;QACzP,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;QACrC,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE;YACP,OAAO,EAAE,uBAAuB;SACjC;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;aAC1C;SACF;KACF;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;KACtD;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;QACrD,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,gBAAgB,EAAE;QAChB,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,SAAS;QACf,WAAW,EACT,uZAAuZ;QACzZ,OAAO,EAAE;YACP,OAAO,EAAE,+BAA+B;SACzC;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,qRAAqR;KACxR;CACF,CAAA"}
@@ -0,0 +1,3 @@
1
+ export declare const formatEmails: (email_addresses: string[] | undefined) => string[];
2
+ export declare const formatPhones: (phone_numbers: string[] | undefined) => string[];
3
+ export declare function formatUserIds(userIds: string[] | undefined): string[];
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.formatUserIds = exports.formatPhones = exports.formatEmails = void 0;
4
+ const crypto_1 = require("crypto");
5
+ const formatEmails = (email_addresses) => {
6
+ const result = [];
7
+ if (email_addresses) {
8
+ email_addresses.forEach((email) => {
9
+ result.push(hashAndEncode(email.toLowerCase()));
10
+ });
11
+ }
12
+ return result;
13
+ };
14
+ exports.formatEmails = formatEmails;
15
+ const formatPhones = (phone_numbers) => {
16
+ const result = [];
17
+ if (!phone_numbers)
18
+ return result;
19
+ phone_numbers.forEach((phone) => {
20
+ const validatedPhone = phone.match(/[0-9]{0,14}/g);
21
+ if (validatedPhone === null) {
22
+ throw new Error(`${phone} is not a valid E.164 phone number.`);
23
+ }
24
+ const formattedPhone = `+${phone.replace(/[^0-9]/g, '')}`;
25
+ result.push(hashAndEncode(formattedPhone.substring(0, 15)));
26
+ });
27
+ return result;
28
+ };
29
+ exports.formatPhones = formatPhones;
30
+ function formatUserIds(userIds) {
31
+ const result = [];
32
+ if (userIds) {
33
+ userIds.forEach((userId) => {
34
+ result.push(hashAndEncode(userId.toLowerCase()));
35
+ });
36
+ }
37
+ return result;
38
+ }
39
+ exports.formatUserIds = formatUserIds;
40
+ function hashAndEncode(property) {
41
+ return crypto_1.createHash('sha256').update(property).digest('hex');
42
+ }
43
+ //# sourceMappingURL=formatter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-offline-conversions-sandbox/formatter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAK5B,MAAM,YAAY,GAAG,CAAC,eAAqC,EAAY,EAAE;IAC9E,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,eAAe,EAAE;QACnB,eAAe,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AARY,QAAA,YAAY,gBAQxB;AAOM,MAAM,YAAY,GAAG,CAAC,aAAmC,EAAY,EAAE;IAC5E,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,CAAC,aAAa;QAAE,OAAO,MAAM,CAAA;IAEjC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;QACtC,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QAClD,IAAI,cAAc,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;SAC/D;QAED,MAAM,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IAC7D,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAhBY,QAAA,YAAY,gBAgBxB;AAOD,SAAgB,aAAa,CAAC,OAA6B;IACzD,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACjC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AARD,sCAQC;AAED,SAAS,aAAa,CAAC,QAAgB;IACrC,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC5D,CAAC"}
@@ -0,0 +1,4 @@
1
+ export interface Settings {
2
+ accessToken: string;
3
+ eventSetID: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=generated-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-offline-conversions-sandbox/generated-types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import { DestinationDefinition } from '@segment/actions-core';
2
+ import type { Settings } from './generated-types';
3
+ declare const destination: DestinationDefinition<Settings>;
4
+ export default destination;