@segment/action-destinations 3.337.2-staging.1 → 3.337.2-staging.2

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 (480) hide show
  1. package/README.md +1 -1
  2. package/dist/destinations/acoustic-s3tc/receiveEvents/eventprocessing.js +6 -2
  3. package/dist/destinations/acoustic-s3tc/receiveEvents/eventprocessing.js.map +1 -1
  4. package/dist/destinations/acoustic-s3tc/receiveEvents/preCheck.js +7 -1
  5. package/dist/destinations/acoustic-s3tc/receiveEvents/preCheck.js.map +1 -1
  6. package/dist/destinations/aggregations-io/generated-types.d.ts +4 -0
  7. package/dist/destinations/aggregations-io/generated-types.js +3 -0
  8. package/dist/destinations/aggregations-io/generated-types.js.map +1 -0
  9. package/dist/destinations/aggregations-io/index.d.ts +4 -0
  10. package/dist/destinations/aggregations-io/index.js +58 -0
  11. package/dist/destinations/aggregations-io/index.js.map +1 -0
  12. package/dist/destinations/aggregations-io/send/generated-types.d.ts +7 -0
  13. package/dist/destinations/aggregations-io/send/generated-types.js +3 -0
  14. package/dist/destinations/aggregations-io/send/generated-types.js.map +1 -0
  15. package/dist/destinations/aggregations-io/send/index.d.ts +5 -0
  16. package/dist/destinations/aggregations-io/send/index.js +44 -0
  17. package/dist/destinations/aggregations-io/send/index.js.map +1 -0
  18. package/dist/destinations/aggregations-io/types.d.ts +8 -0
  19. package/dist/destinations/aggregations-io/types.js +8 -0
  20. package/dist/destinations/aggregations-io/types.js.map +1 -0
  21. package/dist/destinations/airship/registerAndAssociate/generated-types.d.ts +3 -0
  22. package/dist/destinations/airship/registerAndAssociate/index.js +35 -7
  23. package/dist/destinations/airship/registerAndAssociate/index.js.map +1 -1
  24. package/dist/destinations/airship/utilities.d.ts +3 -1
  25. package/dist/destinations/airship/utilities.js +84 -41
  26. package/dist/destinations/airship/utilities.js.map +1 -1
  27. package/dist/destinations/algolia-insights/conversionEvents/generated-types.d.ts +2 -2
  28. package/dist/destinations/algolia-insights/conversionEvents/index.js +7 -3
  29. package/dist/destinations/algolia-insights/conversionEvents/index.js.map +1 -1
  30. package/dist/destinations/algolia-insights/index.js +7 -0
  31. package/dist/destinations/algolia-insights/index.js.map +1 -1
  32. package/dist/destinations/algolia-insights/productAddedEvents/generated-types.d.ts +2 -2
  33. package/dist/destinations/algolia-insights/productAddedEvents/index.js +7 -3
  34. package/dist/destinations/algolia-insights/productAddedEvents/index.js.map +1 -1
  35. package/dist/destinations/algolia-insights/productClickedEvents/generated-types.d.ts +2 -2
  36. package/dist/destinations/algolia-insights/productClickedEvents/index.js +7 -3
  37. package/dist/destinations/algolia-insights/productClickedEvents/index.js.map +1 -1
  38. package/dist/destinations/algolia-insights/productListFilteredEvents/generated-types.d.ts +2 -2
  39. package/dist/destinations/algolia-insights/productListFilteredEvents/index.js +7 -3
  40. package/dist/destinations/algolia-insights/productListFilteredEvents/index.js.map +1 -1
  41. package/dist/destinations/algolia-insights/productViewedEvents/generated-types.d.ts +2 -2
  42. package/dist/destinations/algolia-insights/productViewedEvents/index.js +7 -3
  43. package/dist/destinations/algolia-insights/productViewedEvents/index.js.map +1 -1
  44. package/dist/destinations/amazon-ads/generated-types.d.ts +3 -0
  45. package/dist/destinations/amazon-ads/generated-types.js +3 -0
  46. package/dist/destinations/amazon-ads/generated-types.js.map +1 -0
  47. package/dist/destinations/amazon-ads/index.d.ts +4 -0
  48. package/dist/destinations/amazon-ads/index.js +87 -0
  49. package/dist/destinations/amazon-ads/index.js.map +1 -0
  50. package/dist/destinations/amazon-ads/syncAudiences/generated-types.d.ts +2 -0
  51. package/dist/destinations/amazon-ads/syncAudiences/generated-types.js +3 -0
  52. package/dist/destinations/amazon-ads/syncAudiences/generated-types.js.map +1 -0
  53. package/dist/destinations/amazon-ads/syncAudiences/index.d.ts +5 -0
  54. package/dist/destinations/amazon-ads/syncAudiences/index.js +15 -0
  55. package/dist/destinations/amazon-ads/syncAudiences/index.js.map +1 -0
  56. package/dist/destinations/amazon-ads/types.d.ts +22 -0
  57. package/dist/destinations/amazon-ads/types.js +11 -0
  58. package/dist/destinations/amazon-ads/types.js.map +1 -0
  59. package/dist/destinations/avo/generated-types.d.ts +5 -0
  60. package/dist/destinations/avo/generated-types.js +3 -0
  61. package/dist/destinations/avo/generated-types.js.map +1 -0
  62. package/dist/destinations/avo/index.d.ts +4 -0
  63. package/dist/destinations/avo/index.js +54 -0
  64. package/dist/destinations/avo/index.js.map +1 -0
  65. package/dist/destinations/avo/sendSchemaToInspector/AvoSchemaParser.d.ts +9 -0
  66. package/dist/destinations/avo/sendSchemaToInspector/AvoSchemaParser.js +97 -0
  67. package/dist/destinations/avo/sendSchemaToInspector/AvoSchemaParser.js.map +1 -0
  68. package/dist/destinations/avo/sendSchemaToInspector/avo-types.d.ts +26 -0
  69. package/dist/destinations/avo/sendSchemaToInspector/avo-types.js +10 -0
  70. package/dist/destinations/avo/sendSchemaToInspector/avo-types.js.map +1 -0
  71. package/dist/destinations/avo/sendSchemaToInspector/avo.d.ts +3 -0
  72. package/dist/destinations/avo/sendSchemaToInspector/avo.js +44 -0
  73. package/dist/destinations/avo/sendSchemaToInspector/avo.js.map +1 -0
  74. package/dist/destinations/avo/sendSchemaToInspector/generated-types.d.ts +11 -0
  75. package/dist/destinations/avo/sendSchemaToInspector/generated-types.js +3 -0
  76. package/dist/destinations/avo/sendSchemaToInspector/generated-types.js.map +1 -0
  77. package/dist/destinations/avo/sendSchemaToInspector/index.d.ts +5 -0
  78. package/dist/destinations/avo/sendSchemaToInspector/index.js +95 -0
  79. package/dist/destinations/avo/sendSchemaToInspector/index.js.map +1 -0
  80. package/dist/destinations/braze/index.js +12 -0
  81. package/dist/destinations/braze/index.js.map +1 -1
  82. package/dist/destinations/braze/trackEvent/generated-types.d.ts +1 -0
  83. package/dist/destinations/braze/trackEvent/index.js +8 -0
  84. package/dist/destinations/braze/trackEvent/index.js.map +1 -1
  85. package/dist/destinations/braze/trackPurchase/generated-types.d.ts +1 -0
  86. package/dist/destinations/braze/trackPurchase/index.js +8 -0
  87. package/dist/destinations/braze/trackPurchase/index.js.map +1 -1
  88. package/dist/destinations/braze/updateUserProfile/__snapshots__/snapshot.test.d.ts +1 -0
  89. package/dist/destinations/braze/updateUserProfile/__snapshots__/snapshot.test.js +184 -0
  90. package/dist/destinations/braze/updateUserProfile/__snapshots__/snapshot.test.js.map +1 -0
  91. package/dist/destinations/braze/utils.js +15 -11
  92. package/dist/destinations/braze/utils.js.map +1 -1
  93. package/dist/destinations/courier/generated-types.d.ts +4 -0
  94. package/dist/destinations/courier/generated-types.js +3 -0
  95. package/dist/destinations/courier/generated-types.js.map +1 -0
  96. package/dist/destinations/courier/index.d.ts +4 -0
  97. package/dist/destinations/courier/index.js +44 -0
  98. package/dist/destinations/courier/index.js.map +1 -0
  99. package/dist/destinations/courier/postToCourier/generated-types.d.ts +5 -0
  100. package/dist/destinations/courier/postToCourier/generated-types.js +3 -0
  101. package/dist/destinations/courier/postToCourier/generated-types.js.map +1 -0
  102. package/dist/destinations/courier/postToCourier/index.d.ts +5 -0
  103. package/dist/destinations/courier/postToCourier/index.js +35 -0
  104. package/dist/destinations/courier/postToCourier/index.js.map +1 -0
  105. package/dist/destinations/criteo-audiences/addUserToAudience/index.js +5 -5
  106. package/dist/destinations/criteo-audiences/addUserToAudience/index.js.map +1 -1
  107. package/dist/destinations/criteo-audiences/criteo-audiences.js +13 -2
  108. package/dist/destinations/criteo-audiences/criteo-audiences.js.map +1 -1
  109. package/dist/destinations/criteo-audiences/removeUserFromAudience/index.js +5 -5
  110. package/dist/destinations/criteo-audiences/removeUserFromAudience/index.js.map +1 -1
  111. package/dist/destinations/devrev/createRevUser/index.js +9 -6
  112. package/dist/destinations/devrev/createRevUser/index.js.map +1 -1
  113. package/dist/destinations/devrev/utils/types.d.ts +9 -0
  114. package/dist/destinations/display-video-360/index.js +6 -1
  115. package/dist/destinations/display-video-360/index.js.map +1 -1
  116. package/dist/destinations/display-video-360/properties.js +4 -4
  117. package/dist/destinations/display-video-360/properties.js.map +1 -1
  118. package/dist/destinations/display-video-360/proto/protofile.d.ts +1 -0
  119. package/dist/destinations/display-video-360/proto/protofile.js +1 -0
  120. package/dist/destinations/display-video-360/proto/protofile.js.map +1 -1
  121. package/dist/destinations/display-video-360/shared.d.ts +2 -0
  122. package/dist/destinations/display-video-360/shared.js +8 -1
  123. package/dist/destinations/display-video-360/shared.js.map +1 -1
  124. package/dist/destinations/engage/sendgrid/previewApiLookup/api-lookups.d.ts +2 -5
  125. package/dist/destinations/engage/sendgrid/previewApiLookup/api-lookups.js +18 -98
  126. package/dist/destinations/engage/sendgrid/previewApiLookup/api-lookups.js.map +1 -1
  127. package/dist/destinations/engage/sendgrid/sendEmail/SendEmailPerformer.js +9 -3
  128. package/dist/destinations/engage/sendgrid/sendEmail/SendEmailPerformer.js.map +1 -1
  129. package/dist/destinations/engage/twilio/sendSms/SmsMessageSender.js +0 -3
  130. package/dist/destinations/engage/twilio/sendSms/SmsMessageSender.js.map +1 -1
  131. package/dist/destinations/engage/twilio/utils/TwilioMessageSender.js +8 -2
  132. package/dist/destinations/engage/twilio/utils/TwilioMessageSender.js.map +1 -1
  133. package/dist/destinations/engage/utils/EngageStats.js +0 -4
  134. package/dist/destinations/engage/utils/EngageStats.js.map +1 -1
  135. package/dist/destinations/equals/generated-types.d.ts +3 -0
  136. package/dist/destinations/equals/generated-types.js +3 -0
  137. package/dist/destinations/equals/generated-types.js.map +1 -0
  138. package/dist/destinations/equals/index.d.ts +4 -0
  139. package/dist/destinations/equals/index.js +38 -0
  140. package/dist/destinations/equals/index.js.map +1 -0
  141. package/dist/destinations/equals/send/generated-types.d.ts +5 -0
  142. package/dist/destinations/equals/send/generated-types.js +3 -0
  143. package/dist/destinations/equals/send/generated-types.js.map +1 -0
  144. package/dist/destinations/equals/send/index.d.ts +5 -0
  145. package/dist/destinations/equals/send/index.js +38 -0
  146. package/dist/destinations/equals/send/index.js.map +1 -0
  147. package/dist/destinations/facebook-conversions-api/constants.d.ts +1 -1
  148. package/dist/destinations/facebook-conversions-api/constants.js +1 -1
  149. package/dist/destinations/facebook-conversions-api/fb-capi-app-data.js +1 -1
  150. package/dist/destinations/google-enhanced-conversions/functions.d.ts +1 -1
  151. package/dist/destinations/google-enhanced-conversions/functions.js +1 -1
  152. package/dist/destinations/hubspot/sendCustomBehavioralEvent/index.js +0 -1
  153. package/dist/destinations/hubspot/sendCustomBehavioralEvent/index.js.map +1 -1
  154. package/dist/destinations/hubspot/utils.d.ts +3 -3
  155. package/dist/destinations/index.js +9 -0
  156. package/dist/destinations/index.js.map +1 -1
  157. package/dist/destinations/kameleoon/index.js +1 -1
  158. package/dist/destinations/kameleoon/index.js.map +1 -1
  159. package/dist/destinations/kevel/generated-types.d.ts +4 -0
  160. package/dist/destinations/kevel/generated-types.js +3 -0
  161. package/dist/destinations/kevel/generated-types.js.map +1 -0
  162. package/dist/destinations/kevel/index.d.ts +4 -0
  163. package/dist/destinations/kevel/index.js +45 -0
  164. package/dist/destinations/kevel/index.js.map +1 -0
  165. package/dist/destinations/kevel/syncAudience/generated-types.d.ts +8 -0
  166. package/dist/destinations/kevel/syncAudience/generated-types.js +3 -0
  167. package/dist/destinations/kevel/syncAudience/generated-types.js.map +1 -0
  168. package/dist/destinations/kevel/syncAudience/index.d.ts +5 -0
  169. package/dist/destinations/kevel/syncAudience/index.js +64 -0
  170. package/dist/destinations/kevel/syncAudience/index.js.map +1 -0
  171. package/dist/destinations/kevel/syncTraits/generated-types.d.ts +6 -0
  172. package/dist/destinations/kevel/syncTraits/generated-types.js +3 -0
  173. package/dist/destinations/kevel/syncTraits/generated-types.js.map +1 -0
  174. package/dist/destinations/kevel/syncTraits/index.d.ts +5 -0
  175. package/dist/destinations/kevel/syncTraits/index.js +39 -0
  176. package/dist/destinations/kevel/syncTraits/index.js.map +1 -0
  177. package/dist/destinations/klaviyo/properties.js +1 -1
  178. package/dist/destinations/klaviyo/properties.js.map +1 -1
  179. package/dist/destinations/klaviyo/removeProfileToList/generated-types.d.ts +4 -0
  180. package/dist/destinations/klaviyo/removeProfileToList/generated-types.js +3 -0
  181. package/dist/destinations/klaviyo/removeProfileToList/generated-types.js.map +1 -0
  182. package/dist/destinations/klaviyo/removeProfileToList/index.d.ts +5 -0
  183. package/dist/destinations/klaviyo/removeProfileToList/index.js +43 -0
  184. package/dist/destinations/klaviyo/removeProfileToList/index.js.map +1 -0
  185. package/dist/destinations/linkedin-conversions/api/api.test.js +43 -25
  186. package/dist/destinations/linkedin-conversions/api/api.test.js.map +1 -1
  187. package/dist/destinations/linkedin-conversions/api/index.d.ts +3 -2
  188. package/dist/destinations/linkedin-conversions/api/index.js +41 -15
  189. package/dist/destinations/linkedin-conversions/api/index.js.map +1 -1
  190. package/dist/destinations/linkedin-conversions/constants.d.ts +1 -1
  191. package/dist/destinations/linkedin-conversions/constants.js +1 -1
  192. package/dist/destinations/linkedin-conversions/streamConversion/generated-types.d.ts +1 -1
  193. package/dist/destinations/linkedin-conversions/streamConversion/index.js +27 -6
  194. package/dist/destinations/linkedin-conversions/streamConversion/index.js.map +1 -1
  195. package/dist/destinations/linkedin-conversions/types.d.ts +15 -7
  196. package/dist/destinations/linkedin-conversions/types.js.map +1 -1
  197. package/dist/destinations/marketo-static-lists/addToList/index.js +2 -2
  198. package/dist/destinations/marketo-static-lists/addToList/index.js.map +1 -1
  199. package/dist/destinations/marketo-static-lists/functions.js +7 -7
  200. package/dist/destinations/marketo-static-lists/functions.js.map +1 -1
  201. package/dist/destinations/marketo-static-lists/removeFromList/index.js +2 -2
  202. package/dist/destinations/marketo-static-lists/removeFromList/index.js.map +1 -1
  203. package/dist/destinations/mixpanel/incrementProperties/__test__/index.test.d.ts +1 -0
  204. package/dist/destinations/mixpanel/incrementProperties/__test__/index.test.js +129 -0
  205. package/dist/destinations/mixpanel/incrementProperties/__test__/index.test.js.map +1 -0
  206. package/dist/destinations/mixpanel/incrementProperties/__test__/snapshot.test.d.ts +1 -0
  207. package/dist/destinations/mixpanel/incrementProperties/__test__/snapshot.test.js +69 -0
  208. package/dist/destinations/mixpanel/incrementProperties/__test__/snapshot.test.js.map +1 -0
  209. package/dist/destinations/mixpanel/incrementProperties/generated-types.d.ts +8 -0
  210. package/dist/destinations/mixpanel/incrementProperties/generated-types.js +3 -0
  211. package/dist/destinations/mixpanel/incrementProperties/generated-types.js.map +1 -0
  212. package/dist/destinations/mixpanel/incrementProperties/index.d.ts +5 -0
  213. package/dist/destinations/mixpanel/incrementProperties/index.js +84 -0
  214. package/dist/destinations/mixpanel/incrementProperties/index.js.map +1 -0
  215. package/dist/destinations/mixpanel/index.js +3 -1
  216. package/dist/destinations/mixpanel/index.js.map +1 -1
  217. package/dist/destinations/mixpanel/mixpanel-types.d.ts +4 -0
  218. package/dist/destinations/moengage/trackEvent/generated-types.d.ts +1 -0
  219. package/dist/destinations/moengage/trackEvent/index.js +10 -2
  220. package/dist/destinations/moengage/trackEvent/index.js.map +1 -1
  221. package/dist/destinations/movable-ink/categoryView/generated-types.d.ts +22 -0
  222. package/dist/destinations/movable-ink/categoryView/generated-types.js +3 -0
  223. package/dist/destinations/movable-ink/categoryView/generated-types.js.map +1 -0
  224. package/dist/destinations/movable-ink/categoryView/index.d.ts +5 -0
  225. package/dist/destinations/movable-ink/categoryView/index.js +43 -0
  226. package/dist/destinations/movable-ink/categoryView/index.js.map +1 -0
  227. package/dist/destinations/movable-ink/conversion/generated-types.d.ts +20 -0
  228. package/dist/destinations/movable-ink/conversion/generated-types.js +3 -0
  229. package/dist/destinations/movable-ink/conversion/generated-types.js.map +1 -0
  230. package/dist/destinations/movable-ink/conversion/index.d.ts +5 -0
  231. package/dist/destinations/movable-ink/conversion/index.js +45 -0
  232. package/dist/destinations/movable-ink/conversion/index.js.map +1 -0
  233. package/dist/destinations/movable-ink/fields.d.ts +21 -0
  234. package/dist/destinations/movable-ink/fields.js +236 -0
  235. package/dist/destinations/movable-ink/fields.js.map +1 -0
  236. package/dist/destinations/movable-ink/identify/generated-types.d.ts +7 -0
  237. package/dist/destinations/movable-ink/identify/generated-types.js +3 -0
  238. package/dist/destinations/movable-ink/identify/generated-types.js.map +1 -0
  239. package/dist/destinations/movable-ink/identify/index.d.ts +5 -0
  240. package/dist/destinations/movable-ink/identify/index.js +32 -0
  241. package/dist/destinations/movable-ink/identify/index.js.map +1 -0
  242. package/dist/destinations/movable-ink/productAdded/generated-types.d.ts +22 -0
  243. package/dist/destinations/movable-ink/productAdded/generated-types.js +3 -0
  244. package/dist/destinations/movable-ink/productAdded/generated-types.js.map +1 -0
  245. package/dist/destinations/movable-ink/productAdded/index.d.ts +5 -0
  246. package/dist/destinations/movable-ink/productAdded/index.js +43 -0
  247. package/dist/destinations/movable-ink/productAdded/index.js.map +1 -0
  248. package/dist/destinations/movable-ink/productViewed/generated-types.d.ts +21 -0
  249. package/dist/destinations/movable-ink/productViewed/generated-types.js +3 -0
  250. package/dist/destinations/movable-ink/productViewed/generated-types.js.map +1 -0
  251. package/dist/destinations/movable-ink/productViewed/index.d.ts +5 -0
  252. package/dist/destinations/movable-ink/productViewed/index.js +43 -0
  253. package/dist/destinations/movable-ink/productViewed/index.js.map +1 -0
  254. package/dist/destinations/movable-ink/search/generated-types.d.ts +12 -0
  255. package/dist/destinations/movable-ink/search/generated-types.js +3 -0
  256. package/dist/destinations/movable-ink/search/generated-types.js.map +1 -0
  257. package/dist/destinations/movable-ink/search/index.d.ts +5 -0
  258. package/dist/destinations/movable-ink/search/index.js +43 -0
  259. package/dist/destinations/movable-ink/search/index.js.map +1 -0
  260. package/dist/destinations/movable-ink/sendCustomEvent/generated-types.d.ts +25 -0
  261. package/dist/destinations/movable-ink/sendCustomEvent/generated-types.js +3 -0
  262. package/dist/destinations/movable-ink/sendCustomEvent/generated-types.js.map +1 -0
  263. package/dist/destinations/movable-ink/sendCustomEvent/index.d.ts +5 -0
  264. package/dist/destinations/movable-ink/sendCustomEvent/index.js +48 -0
  265. package/dist/destinations/movable-ink/sendCustomEvent/index.js.map +1 -0
  266. package/dist/destinations/responsys/generated-types.d.ts +15 -0
  267. package/dist/destinations/responsys/index.js +141 -6
  268. package/dist/destinations/responsys/index.js.map +1 -1
  269. package/dist/destinations/responsys/sendAudience/generated-types.d.ts +14 -0
  270. package/dist/destinations/responsys/sendAudience/generated-types.js +3 -0
  271. package/dist/destinations/responsys/sendAudience/generated-types.js.map +1 -0
  272. package/dist/destinations/responsys/sendAudience/index.d.ts +5 -0
  273. package/dist/destinations/responsys/sendAudience/index.js +88 -0
  274. package/dist/destinations/responsys/sendAudience/index.js.map +1 -0
  275. package/dist/destinations/responsys/sendCustomTraits/generated-types.d.ts +9 -0
  276. package/dist/destinations/responsys/sendCustomTraits/generated-types.js +3 -0
  277. package/dist/destinations/responsys/sendCustomTraits/generated-types.js.map +1 -0
  278. package/dist/destinations/responsys/sendCustomTraits/index.d.ts +5 -0
  279. package/dist/destinations/responsys/sendCustomTraits/index.js +52 -0
  280. package/dist/destinations/responsys/sendCustomTraits/index.js.map +1 -0
  281. package/dist/destinations/responsys/shared_properties.d.ts +3 -0
  282. package/dist/destinations/responsys/shared_properties.js +19 -0
  283. package/dist/destinations/responsys/shared_properties.js.map +1 -0
  284. package/dist/destinations/responsys/types.d.ts +23 -22
  285. package/dist/destinations/responsys/upsertListMember/generated-types.d.ts +13 -0
  286. package/dist/destinations/responsys/upsertListMember/generated-types.js +3 -0
  287. package/dist/destinations/responsys/upsertListMember/generated-types.js.map +1 -0
  288. package/dist/destinations/responsys/upsertListMember/index.d.ts +5 -0
  289. package/dist/destinations/responsys/upsertListMember/index.js +80 -0
  290. package/dist/destinations/responsys/upsertListMember/index.js.map +1 -0
  291. package/dist/destinations/responsys/utils.d.ts +18 -0
  292. package/dist/destinations/responsys/utils.js +161 -0
  293. package/dist/destinations/responsys/utils.js.map +1 -0
  294. package/dist/destinations/schematic/generated-types.d.ts +3 -0
  295. package/dist/destinations/schematic/generated-types.js +3 -0
  296. package/dist/destinations/schematic/generated-types.js.map +1 -0
  297. package/dist/destinations/schematic/identifyUser/generated-types.d.ts +18 -0
  298. package/dist/destinations/schematic/identifyUser/generated-types.js +3 -0
  299. package/dist/destinations/schematic/identifyUser/generated-types.js.map +1 -0
  300. package/dist/destinations/schematic/identifyUser/index.d.ts +5 -0
  301. package/dist/destinations/schematic/identifyUser/index.js +114 -0
  302. package/dist/destinations/schematic/identifyUser/index.js.map +1 -0
  303. package/dist/destinations/schematic/index.d.ts +4 -0
  304. package/dist/destinations/schematic/index.js +58 -0
  305. package/dist/destinations/schematic/index.js.map +1 -0
  306. package/dist/destinations/schematic/trackEvent/generated-types.d.ts +13 -0
  307. package/dist/destinations/schematic/trackEvent/generated-types.js +3 -0
  308. package/dist/destinations/schematic/trackEvent/generated-types.js.map +1 -0
  309. package/dist/destinations/schematic/trackEvent/index.d.ts +5 -0
  310. package/dist/destinations/schematic/trackEvent/index.js +89 -0
  311. package/dist/destinations/schematic/trackEvent/index.js.map +1 -0
  312. package/dist/destinations/segment/generated-types.d.ts +0 -1
  313. package/dist/destinations/segment/index.js +3 -13
  314. package/dist/destinations/segment/index.js.map +1 -1
  315. package/dist/destinations/segment/properties.d.ts +1 -1
  316. package/dist/destinations/segment/properties.js +3 -3
  317. package/dist/destinations/segment/properties.js.map +1 -1
  318. package/dist/destinations/segment/sendGroup/index.js +40 -15
  319. package/dist/destinations/segment/sendGroup/index.js.map +1 -1
  320. package/dist/destinations/segment/sendIdentify/index.js +40 -15
  321. package/dist/destinations/segment/sendIdentify/index.js.map +1 -1
  322. package/dist/destinations/segment/sendPage/index.js +48 -15
  323. package/dist/destinations/segment/sendPage/index.js.map +1 -1
  324. package/dist/destinations/segment/sendScreen/index.js +41 -15
  325. package/dist/destinations/segment/sendScreen/index.js.map +1 -1
  326. package/dist/destinations/segment/sendTrack/index.js +44 -15
  327. package/dist/destinations/segment/sendTrack/index.js.map +1 -1
  328. package/dist/destinations/snap-conversions-api/_tests_/capiV2tests.d.ts +1 -0
  329. package/dist/destinations/snap-conversions-api/_tests_/capiV2tests.js +381 -0
  330. package/dist/destinations/snap-conversions-api/_tests_/capiV2tests.js.map +1 -0
  331. package/dist/destinations/snap-conversions-api/_tests_/capiV3tests.d.ts +1 -0
  332. package/dist/destinations/snap-conversions-api/_tests_/capiV3tests.js +499 -0
  333. package/dist/destinations/snap-conversions-api/_tests_/capiV3tests.js.map +1 -0
  334. package/dist/destinations/snap-conversions-api/_tests_/index.test.js +4 -352
  335. package/dist/destinations/snap-conversions-api/_tests_/index.test.js.map +1 -1
  336. package/dist/destinations/snap-conversions-api/index.js.map +1 -1
  337. package/dist/destinations/snap-conversions-api/reportConversionEvent/index.js +24 -20
  338. package/dist/destinations/snap-conversions-api/reportConversionEvent/index.js.map +1 -1
  339. package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v2.d.ts +4 -0
  340. package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v2.js +97 -0
  341. package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v2.js.map +1 -0
  342. package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.d.ts +8 -0
  343. package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.js +126 -0
  344. package/dist/destinations/snap-conversions-api/reportConversionEvent/snap-capi-v3.js.map +1 -0
  345. package/dist/destinations/snap-conversions-api/reportConversionEvent/utils.d.ts +13 -0
  346. package/dist/destinations/snap-conversions-api/reportConversionEvent/utils.js +40 -0
  347. package/dist/destinations/snap-conversions-api/reportConversionEvent/utils.js.map +1 -0
  348. package/dist/destinations/snap-conversions-api/snap-capi-properties.d.ts +0 -5
  349. package/dist/destinations/snap-conversions-api/snap-capi-properties.js +1 -86
  350. package/dist/destinations/snap-conversions-api/snap-capi-properties.js.map +1 -1
  351. package/dist/destinations/stackadapt/forwardEvent/generated-types.d.ts +33 -0
  352. package/dist/destinations/stackadapt/forwardEvent/generated-types.js +3 -0
  353. package/dist/destinations/stackadapt/forwardEvent/generated-types.js.map +1 -0
  354. package/dist/destinations/stackadapt/forwardEvent/index.d.ts +5 -0
  355. package/dist/destinations/stackadapt/forwardEvent/index.js +273 -0
  356. package/dist/destinations/stackadapt/forwardEvent/index.js.map +1 -0
  357. package/dist/destinations/stackadapt/generated-types.d.ts +3 -0
  358. package/dist/destinations/stackadapt/generated-types.js +3 -0
  359. package/dist/destinations/stackadapt/generated-types.js.map +1 -0
  360. package/dist/destinations/stackadapt/index.d.ts +4 -0
  361. package/dist/destinations/stackadapt/index.js +38 -0
  362. package/dist/destinations/stackadapt/index.js.map +1 -0
  363. package/dist/destinations/surveysparrow/createContact/generated-types.d.ts +10 -0
  364. package/dist/destinations/surveysparrow/createContact/generated-types.js +3 -0
  365. package/dist/destinations/surveysparrow/createContact/generated-types.js.map +1 -0
  366. package/dist/destinations/surveysparrow/createContact/index.d.ts +5 -0
  367. package/dist/destinations/surveysparrow/createContact/index.js +105 -0
  368. package/dist/destinations/surveysparrow/createContact/index.js.map +1 -0
  369. package/dist/destinations/surveysparrow/generated-types.d.ts +3 -0
  370. package/dist/destinations/surveysparrow/generated-types.js +3 -0
  371. package/dist/destinations/surveysparrow/generated-types.js.map +1 -0
  372. package/dist/destinations/surveysparrow/index.d.ts +4 -0
  373. package/dist/destinations/surveysparrow/index.js +40 -0
  374. package/dist/destinations/surveysparrow/index.js.map +1 -0
  375. package/dist/destinations/surveysparrow/triggerSurvey/generated-types.d.ts +10 -0
  376. package/dist/destinations/surveysparrow/triggerSurvey/generated-types.js +3 -0
  377. package/dist/destinations/surveysparrow/triggerSurvey/generated-types.js.map +1 -0
  378. package/dist/destinations/surveysparrow/triggerSurvey/index.d.ts +8 -0
  379. package/dist/destinations/surveysparrow/triggerSurvey/index.js +165 -0
  380. package/dist/destinations/surveysparrow/triggerSurvey/index.js.map +1 -0
  381. package/dist/destinations/tiktok-conversions/index.js +3 -92
  382. package/dist/destinations/tiktok-conversions/index.js.map +1 -1
  383. package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.d.ts +3 -3
  384. package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.js +24 -33
  385. package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.js.map +1 -1
  386. package/dist/destinations/tiktok-conversions/reportWebEvent/generated-types.d.ts +4 -12
  387. package/dist/destinations/tiktok-conversions/reportWebEvent/index.js +40 -113
  388. package/dist/destinations/tiktok-conversions/reportWebEvent/index.js.map +1 -1
  389. package/dist/destinations/tiktok-conversions-sandbox/common_fields.d.ts +2 -0
  390. package/dist/destinations/tiktok-conversions-sandbox/common_fields.js +244 -0
  391. package/dist/destinations/tiktok-conversions-sandbox/common_fields.js.map +1 -0
  392. package/dist/destinations/tiktok-conversions-sandbox/formatter.d.ts +3 -0
  393. package/dist/destinations/tiktok-conversions-sandbox/formatter.js +43 -0
  394. package/dist/destinations/tiktok-conversions-sandbox/formatter.js.map +1 -0
  395. package/dist/destinations/tiktok-conversions-sandbox/generated-types.d.ts +4 -0
  396. package/dist/destinations/tiktok-conversions-sandbox/generated-types.js +3 -0
  397. package/dist/destinations/tiktok-conversions-sandbox/generated-types.js.map +1 -0
  398. package/dist/destinations/tiktok-conversions-sandbox/index.d.ts +4 -0
  399. package/dist/destinations/tiktok-conversions-sandbox/index.js +247 -0
  400. package/dist/destinations/tiktok-conversions-sandbox/index.js.map +1 -0
  401. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.d.ts +33 -0
  402. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.js +3 -0
  403. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.js.map +1 -0
  404. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.d.ts +5 -0
  405. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.js +16 -0
  406. package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.js.map +1 -0
  407. package/dist/destinations/tiktok-conversions-sandbox/utils.d.ts +4 -0
  408. package/dist/destinations/tiktok-conversions-sandbox/utils.js +65 -0
  409. package/dist/destinations/tiktok-conversions-sandbox/utils.js.map +1 -0
  410. package/dist/destinations/tiktok-offline-conversions/common_fields.js +179 -20
  411. package/dist/destinations/tiktok-offline-conversions/common_fields.js.map +1 -1
  412. package/dist/destinations/tiktok-offline-conversions/formatter.d.ts +1 -0
  413. package/dist/destinations/tiktok-offline-conversions/formatter.js +11 -1
  414. package/dist/destinations/tiktok-offline-conversions/formatter.js.map +1 -1
  415. package/dist/destinations/tiktok-offline-conversions/index.js +156 -153
  416. package/dist/destinations/tiktok-offline-conversions/index.js.map +1 -1
  417. package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/generated-types.d.ts +3 -3
  418. package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/index.js +4 -305
  419. package/dist/destinations/tiktok-offline-conversions/reportOfflineEvent/index.js.map +1 -1
  420. package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/generated-types.d.ts +25 -2
  421. package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.js +4 -29
  422. package/dist/destinations/tiktok-offline-conversions/trackNonPaymentOfflineConversion/index.js.map +1 -1
  423. package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/generated-types.d.ts +18 -5
  424. package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.js +5 -126
  425. package/dist/destinations/tiktok-offline-conversions/trackPaymentOfflineConversion/index.js.map +1 -1
  426. package/dist/destinations/tiktok-offline-conversions/utils.d.ts +8 -0
  427. package/dist/destinations/tiktok-offline-conversions/utils.js +67 -0
  428. package/dist/destinations/tiktok-offline-conversions/utils.js.map +1 -0
  429. package/dist/destinations/tiktok-offline-conversions-sandbox/common_fields.d.ts +2 -0
  430. package/dist/destinations/tiktok-offline-conversions-sandbox/common_fields.js +244 -0
  431. package/dist/destinations/tiktok-offline-conversions-sandbox/common_fields.js.map +1 -0
  432. package/dist/destinations/tiktok-offline-conversions-sandbox/formatter.d.ts +3 -0
  433. package/dist/destinations/tiktok-offline-conversions-sandbox/formatter.js +43 -0
  434. package/dist/destinations/tiktok-offline-conversions-sandbox/formatter.js.map +1 -0
  435. package/dist/destinations/tiktok-offline-conversions-sandbox/generated-types.d.ts +4 -0
  436. package/dist/destinations/tiktok-offline-conversions-sandbox/generated-types.js +3 -0
  437. package/dist/destinations/tiktok-offline-conversions-sandbox/generated-types.js.map +1 -0
  438. package/dist/destinations/tiktok-offline-conversions-sandbox/index.d.ts +4 -0
  439. package/dist/destinations/tiktok-offline-conversions-sandbox/index.js +251 -0
  440. package/dist/destinations/tiktok-offline-conversions-sandbox/index.js.map +1 -0
  441. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/generated-types.d.ts +33 -0
  442. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/generated-types.js +3 -0
  443. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/generated-types.js.map +1 -0
  444. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/index.d.ts +5 -0
  445. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/index.js +16 -0
  446. package/dist/destinations/tiktok-offline-conversions-sandbox/reportOfflineEvent/index.js.map +1 -0
  447. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/generated-types.d.ts +33 -0
  448. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/generated-types.js +3 -0
  449. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/generated-types.js.map +1 -0
  450. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/index.d.ts +5 -0
  451. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/index.js +16 -0
  452. package/dist/destinations/tiktok-offline-conversions-sandbox/trackNonPaymentOfflineConversion/index.js.map +1 -0
  453. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/generated-types.d.ts +33 -0
  454. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/generated-types.js +3 -0
  455. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/generated-types.js.map +1 -0
  456. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/index.d.ts +5 -0
  457. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/index.js +16 -0
  458. package/dist/destinations/tiktok-offline-conversions-sandbox/trackPaymentOfflineConversion/index.js.map +1 -0
  459. package/dist/destinations/tiktok-offline-conversions-sandbox/utils.d.ts +8 -0
  460. package/dist/destinations/tiktok-offline-conversions-sandbox/utils.js +68 -0
  461. package/dist/destinations/tiktok-offline-conversions-sandbox/utils.js.map +1 -0
  462. package/dist/destinations/trackey/group.types.d.ts +11 -0
  463. package/dist/destinations/trackey/group.types.js +3 -0
  464. package/dist/destinations/trackey/group.types.js.map +1 -0
  465. package/dist/destinations/trackey/identify.types.d.ts +11 -0
  466. package/dist/destinations/trackey/identify.types.js +3 -0
  467. package/dist/destinations/trackey/identify.types.js.map +1 -0
  468. package/dist/destinations/trackey/track.types.d.ts +12 -0
  469. package/dist/destinations/trackey/track.types.js +3 -0
  470. package/dist/destinations/trackey/track.types.js.map +1 -0
  471. package/dist/destinations/webhook-audiences/index.js +1 -3
  472. package/dist/destinations/webhook-audiences/index.js.map +1 -1
  473. package/dist/destinations/yahoo-audiences/index.js +9 -1
  474. package/dist/destinations/yahoo-audiences/index.js.map +1 -1
  475. package/dist/destinations/yahoo-audiences/updateSegment/generated-types.d.ts +6 -2
  476. package/dist/destinations/yahoo-audiences/updateSegment/index.js +36 -11
  477. package/dist/destinations/yahoo-audiences/updateSegment/index.js.map +1 -1
  478. package/dist/destinations/yahoo-audiences/utils-rt.js +3 -3
  479. package/dist/destinations/yahoo-audiences/utils-rt.js.map +1 -1
  480. package/package.json +3 -3
@@ -1,316 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- const actions_core_1 = require("@segment/actions-core");
4
- const formatter_1 = require("./formatter");
3
+ const common_fields_1 = require("../common_fields");
4
+ const utils_1 = require("../utils");
5
5
  const action = {
6
6
  title: 'Track Payment Offline Conversion',
7
7
  description: 'Send details of an in-store purchase or console purchase to the Tiktok Offline Events API',
8
8
  fields: {
9
- event: {
10
- label: 'Event Name',
11
- type: 'string',
12
- required: true,
13
- 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.'
14
- },
15
- event_id: {
16
- label: 'Event ID',
17
- type: 'string',
18
- description: 'Any hashed ID that can identify a unique user/session.',
19
- default: {
20
- '@path': '$.messageId'
21
- }
22
- },
23
- timestamp: {
24
- label: 'Event Timestamp',
25
- type: 'string',
26
- description: 'Timestamp that the event took place, in ISO 8601 format.',
27
- default: {
28
- '@path': '$.timestamp'
29
- }
30
- },
31
- phone_numbers: {
32
- label: 'Phone Numbers',
33
- 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 is required if no value is provided in the Emails field.',
34
- type: 'string',
35
- multiple: true,
36
- default: {
37
- '@if': {
38
- exists: { '@path': '$.properties.phone' },
39
- then: { '@path': '$.properties.phone' },
40
- else: { '@path': '$.traits.phone' }
41
- }
42
- }
43
- },
44
- emails: {
45
- label: 'Emails',
46
- description: 'A single email address or an array of email addresses. Segment will hash this value before sending to TikTok. At least one email is required if no value is provided in the Phone Numbers field.',
47
- type: 'string',
48
- multiple: true,
49
- default: {
50
- '@if': {
51
- exists: { '@path': '$.properties.email' },
52
- then: { '@path': '$.properties.email' },
53
- else: { '@path': '$.traits.email' }
54
- }
55
- }
56
- },
57
- external_ids: {
58
- label: 'External ID',
59
- description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
60
- type: 'string',
61
- multiple: true,
62
- default: {
63
- '@if': {
64
- exists: { '@path': '$.userId' },
65
- then: { '@path': '$.userId' },
66
- else: { '@path': '$.anonymousId' }
67
- }
68
- }
69
- },
70
- ttclid: {
71
- label: 'TikTok Click ID',
72
- 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.',
73
- type: 'string',
74
- default: {
75
- '@if': {
76
- exists: { '@path': '$.properties.ttclid' },
77
- then: { '@path': '$.properties.ttclid' },
78
- else: { '@path': '$.traits.ttclid' }
79
- }
80
- }
81
- },
82
- ttp: {
83
- label: 'TikTok Cookie ID',
84
- 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`).',
85
- type: 'string',
86
- default: {
87
- '@if': {
88
- exists: { '@path': '$.properties.ttp' },
89
- then: { '@path': '$.properties.ttp' },
90
- else: { '@path': '$.integrations.TikTok Pixel.ttp' }
91
- }
92
- }
93
- },
94
- lead_id: {
95
- label: 'TikTok Lead ID',
96
- 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',
97
- type: 'string',
98
- default: {
99
- '@if': {
100
- exists: { '@path': '$.properties.lead_id' },
101
- then: { '@path': '$.properties.lead_id' },
102
- else: { '@path': '$.traits.lead_id' }
103
- }
104
- }
105
- },
106
- locale: {
107
- label: 'Locale',
108
- 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).',
109
- type: 'string',
110
- default: {
111
- '@path': '$.context.locale'
112
- }
113
- },
114
- url: {
115
- label: 'Page URL',
116
- type: 'string',
117
- description: 'The page URL where the conversion event took place.',
118
- default: {
119
- '@path': '$.context.page.url'
120
- }
121
- },
122
- referrer: {
123
- label: 'Page Referrer',
124
- type: 'string',
125
- description: 'The page referrer.',
126
- default: {
127
- '@path': '$.context.page.referrer'
128
- }
129
- },
130
- ip: {
131
- label: 'IP Address',
132
- type: 'string',
133
- description: 'IP address of the browser.',
134
- default: {
135
- '@path': '$.context.ip'
136
- }
137
- },
138
- user_agent: {
139
- label: 'User Agent',
140
- type: 'string',
141
- description: 'User agent from the user’s device.',
142
- default: {
143
- '@path': '$.context.userAgent'
144
- }
145
- },
146
- contents: {
147
- label: 'Contents',
148
- type: 'object',
149
- multiple: true,
150
- description: 'Related items in a web event.',
151
- properties: {
152
- price: {
153
- label: 'Price',
154
- description: 'Price of the item.',
155
- type: 'number'
156
- },
157
- quantity: {
158
- label: 'Quantity',
159
- description: 'Number of items.',
160
- type: 'number'
161
- },
162
- content_category: {
163
- label: 'Content Category',
164
- description: 'Category of the product item.',
165
- type: 'string'
166
- },
167
- content_id: {
168
- label: 'Content ID',
169
- description: 'ID of the product item.',
170
- type: 'string'
171
- },
172
- content_name: {
173
- label: 'Content Name',
174
- description: 'Name of the product item.',
175
- type: 'string'
176
- },
177
- brand: {
178
- label: 'Brand',
179
- description: 'Brand name of the product item.',
180
- type: 'string'
181
- }
182
- }
183
- },
184
- content_type: {
185
- label: 'Content Type',
186
- description: 'Type of the product item. When the `content_id` in the `contents` parameter is specified as `sku_id`, set this field to `product`. When the `content_id` in the `contents` parameter is specified as `item_group_id`, set this field to `product_group`.',
187
- type: 'string',
188
- choices: ['product', 'product_group'],
189
- default: 'product'
190
- },
191
- currency: {
192
- label: 'Currency',
193
- type: 'string',
194
- description: 'Currency for the value specified as ISO 4217 code.',
195
- default: {
196
- '@path': '$.properties.currency'
197
- }
198
- },
199
- value: {
200
- label: 'Value',
201
- type: 'number',
202
- description: 'Value of the order or items sold.',
203
- default: {
204
- '@if': {
205
- exists: { '@path': '$.properties.value' },
206
- then: { '@path': '$.properties.value' },
207
- else: { '@path': '$.properties.revenue' }
208
- }
209
- }
210
- },
211
- description: {
212
- label: 'Description',
213
- type: 'string',
214
- description: 'A string description of the web event.'
215
- },
216
- query: {
217
- label: 'Query',
218
- type: 'string',
219
- description: 'The text string that was searched for.',
220
- default: {
221
- '@path': '$.properties.query'
222
- }
223
- },
224
- order_id: {
225
- label: 'Order ID',
226
- type: 'string',
227
- description: 'Order ID of the transaction.',
228
- default: {
229
- '@path': '$.properties.order_id'
230
- }
231
- },
232
- shop_id: {
233
- label: 'Shop ID',
234
- type: 'string',
235
- description: 'Shop ID of the transaction.',
236
- default: {
237
- '@path': '$.properties.shop_id'
238
- }
239
- },
240
- limited_data_use: {
241
- label: 'Limited Data Use',
242
- type: 'boolean',
243
- 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).',
244
- default: {
245
- '@path': '$.properties.limited_data_use'
246
- }
247
- },
248
- test_event_code: {
249
- label: 'Test Event Code',
250
- type: 'string',
251
- 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.'
252
- }
9
+ ...common_fields_1.commonFields
253
10
  },
254
11
  perform: (request, { payload, settings }) => {
255
- const phone_numbers = formatter_1.formatPhones(payload.phone_numbers);
256
- const emails = formatter_1.formatEmails(payload.emails);
257
- const userIds = formatter_1.formatUserIds(payload.external_ids);
258
- if (phone_numbers.length < 1 && emails.length < 1 && userIds.length < 1)
259
- throw new actions_core_1.PayloadValidationError('TikTok Offline Conversions API requires an email address and/or phone number');
260
- let payloadUrl, urlTtclid;
261
- if (payload.url) {
262
- try {
263
- payloadUrl = new URL(payload.url);
264
- }
265
- catch (error) {
266
- }
267
- }
268
- if (payloadUrl)
269
- urlTtclid = payloadUrl.searchParams.get('ttclid');
270
- return request('https://business-api.tiktok.com/open_api/v1.3/event/track/', {
271
- method: 'post',
272
- json: {
273
- event_source: 'offline',
274
- event_source_id: settings.eventSetID,
275
- partner_name: 'Segment',
276
- data: [
277
- {
278
- event: payload.event,
279
- event_time: payload.timestamp
280
- ? Math.floor(new Date(payload.timestamp).getTime() / 1000)
281
- : Math.floor(new Date().getTime() / 1000),
282
- event_id: payload.event_id ? `${payload.event_id}` : undefined,
283
- user: {
284
- ttclid: payload.ttclid ? payload.ttclid : urlTtclid ? urlTtclid : undefined,
285
- external_id: userIds,
286
- phone_number: phone_numbers,
287
- email: emails,
288
- lead_id: payload.lead_id ? payload.lead_id : undefined,
289
- ttp: payload.ttp ? payload.ttp : undefined,
290
- ip: payload.ip ? payload.ip : undefined,
291
- user_agent: payload.user_agent ? payload.user_agent : undefined,
292
- locale: payload.locale ? payload.locale : undefined
293
- },
294
- properties: {
295
- contents: payload.contents ? payload.contents : [],
296
- content_type: payload.content_type ? payload.content_type : undefined,
297
- currency: payload.currency ? payload.currency : undefined,
298
- value: payload.value ? payload.value : undefined,
299
- query: payload.query ? payload.query : undefined,
300
- description: payload.description ? payload.description : undefined,
301
- order_id: payload.order_id ? payload.order_id : undefined,
302
- shop_id: payload.shop_id ? payload.shop_id : undefined
303
- },
304
- page: {
305
- url: payload.url ? payload.url : undefined,
306
- referrer: payload.referrer ? payload.referrer : undefined
307
- },
308
- limited_data_use: payload.limited_data_use ? payload.limited_data_use : false,
309
- test_event_code: payload.test_event_code ? payload.test_event_code : undefined
310
- }
311
- ]
312
- }
313
- });
12
+ return utils_1.performOfflineEvent(request, settings, payload);
314
13
  }
315
14
  };
316
15
  exports.default = action;
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-offline-conversions/reportOfflineEvent/index.ts"],"names":[],"mappings":";;AAAA,wDAAgF;AAGhF,2CAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kCAAkC;IACzC,WAAW,EAAE,2FAA2F;IACxG,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,uNAAuN;SAC1N;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wDAAwD;YACrE,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,0DAA0D;YACvE,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QAED,aAAa,EAAE;YACb,KAAK,EAAE,eAAe;YACtB,WAAW,EACT,qNAAqN;YACvN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,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,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EACT,kMAAkM;YACpM,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,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,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,yHAAyH;YAC3H,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;iBACnC;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,iBAAiB;YACxB,WAAW,EACT,+NAA+N;YACjO,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE;iBACrC;aACF;SACF;QACD,GAAG,EAAE;YACH,KAAK,EAAE,kBAAkB;YACzB,WAAW,EACT,+bAA+b;YACjc,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;oBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,iCAAiC,EAAE;iBACrD;aACF;SACF;QACD,OAAO,EAAE;YACP,KAAK,EAAE,gBAAgB;YACvB,WAAW,EACT,0LAA0L;YAC5L,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;oBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;iBACtC;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EACT,4IAA4I;YAC9I,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,kBAAkB;aAC5B;SACF;QACD,GAAG,EAAE;YACH,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qDAAqD;YAClE,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oBAAoB;YACjC,OAAO,EAAE;gBACP,OAAO,EAAE,yBAAyB;aACnC;SACF;QACD,EAAE,EAAE;YACF,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,4BAA4B;YACzC,OAAO,EAAE;gBACP,OAAO,EAAE,cAAc;aACxB;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE;gBACP,OAAO,EAAE,qBAAqB;aAC/B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,+BAA+B;YAC5C,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,WAAW,EAAE,oBAAoB;oBACjC,IAAI,EAAE,QAAQ;iBACf;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,WAAW,EAAE,kBAAkB;oBAC/B,IAAI,EAAE,QAAQ;iBACf;gBACD,gBAAgB,EAAE;oBAChB,KAAK,EAAE,kBAAkB;oBACzB,WAAW,EAAE,+BAA+B;oBAC5C,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,YAAY;oBACnB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,2BAA2B;oBACxC,IAAI,EAAE,QAAQ;iBACf;gBACD,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,WAAW,EAAE,iCAAiC;oBAC9C,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EACT,0PAA0P;YAC5P,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;YACrC,OAAO,EAAE,SAAS;SACnB;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mCAAmC;YAChD,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;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;SACtD;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8BAA8B;YAC3C,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,OAAO,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,OAAO,EAAE;gBACP,OAAO,EAAE,sBAAsB;aAChC;SACF;QACD,gBAAgB,EAAE;YAChB,KAAK,EAAE,kBAAkB;YACzB,IAAI,EAAE,SAAS;YACf,WAAW,EACT,uZAAuZ;YACzZ,OAAO,EAAE;gBACP,OAAO,EAAE,+BAA+B;aACzC;SACF;QACD,eAAe,EAAE;YACf,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,qRAAqR;SACxR;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,MAAM,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,yBAAa,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAEnD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YACrE,MAAM,IAAI,qCAAsB,CAAC,8EAA8E,CAAC,CAAA;QAElH,IAAI,UAAU,EAAE,SAAS,CAAA;QACzB,IAAI,OAAO,CAAC,GAAG,EAAE;YACf,IAAI;gBACF,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;aAClC;YAAC,OAAO,KAAK,EAAE;aAEf;SACF;QAED,IAAI,UAAU;YAAE,SAAS,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAEjE,OAAO,OAAO,CAAC,4DAA4D,EAAE;YAC3E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,YAAY,EAAE,SAAS;gBACvB,eAAe,EAAE,QAAQ,CAAC,UAAU;gBACpC,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE;oBACJ;wBACE,KAAK,EAAE,OAAO,CAAC,KAAK;wBACpB,UAAU,EAAE,OAAO,CAAC,SAAS;4BAC3B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;4BAC1D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;wBAC3C,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;wBAC9D,IAAI,EAAE;4BACJ,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;4BAC3E,WAAW,EAAE,OAAO;4BACpB,YAAY,EAAE,aAAa;4BAC3B,KAAK,EAAE,MAAM;4BACb,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;4BACtD,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;4BAC1C,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;4BACvC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;4BAC/D,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;yBACpD;wBACD,UAAU,EAAE;4BACV,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;4BAClD,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;4BACrE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;4BACzD,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;4BAChD,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;4BAChD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;4BAClE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;4BACzD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;yBACvD;wBACD,IAAI,EAAE;4BACJ,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;4BAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;yBAC1D;wBACD,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK;wBAC7E,eAAe,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;qBAC/E;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
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"}
@@ -1,10 +1,33 @@
1
1
  export interface Payload {
2
2
  event: string;
3
3
  event_id?: string;
4
- timestamp: string;
4
+ timestamp?: string;
5
5
  phone_numbers?: string[];
6
6
  email_addresses?: string[];
7
7
  order_id?: string;
8
8
  shop_id?: string;
9
- event_channel?: 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;
18
+ contents?: {
19
+ price?: number;
20
+ quantity?: number;
21
+ content_category?: string;
22
+ content_id?: string;
23
+ content_name?: string;
24
+ brand?: string;
25
+ }[];
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;
10
33
  }
@@ -1,40 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- const actions_core_1 = require("@segment/actions-core");
4
3
  const common_fields_1 = require("../common_fields");
5
- const formatter_1 = require("../formatter");
4
+ const utils_1 = require("../utils");
6
5
  const action = {
7
- title: 'Track Non Payment Offline Conversion',
8
- description: 'Send a non payment related event to the TikTok Offline Conversions API',
6
+ title: '[Deprecated] Track Non Payment Offline Conversion',
7
+ 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",
9
8
  fields: {
10
9
  ...common_fields_1.commonFields
11
10
  },
12
11
  perform: (request, { payload, settings }) => {
13
- const phone_numbers = formatter_1.formatPhones(payload.phone_numbers);
14
- const emails = formatter_1.formatEmails(payload.email_addresses);
15
- if (phone_numbers.length < 1 && emails.length < 1)
16
- throw new actions_core_1.PayloadValidationError('TikTok Offline Conversions API requires an email address and/or phone number');
17
- return request('https://business-api.tiktok.com/open_api/v1.3/offline/track/', {
18
- method: 'post',
19
- json: {
20
- event_set_id: settings.eventSetID,
21
- event: payload.event,
22
- event_id: payload.event_id ? `${payload.event_id}` : undefined,
23
- timestamp: payload.timestamp,
24
- context: {
25
- user: {
26
- phone_numbers,
27
- emails
28
- }
29
- },
30
- properties: {
31
- order_id: payload.order_id,
32
- shop_id: payload.shop_id,
33
- event_channel: payload.event_channel
34
- },
35
- partner_name: 'Segment'
36
- }
37
- });
12
+ return utils_1.performOfflineEvent(request, settings, payload);
38
13
  }
39
14
  };
40
15
  exports.default = action;
@@ -1 +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"}
1
+ {"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"}
@@ -6,15 +6,28 @@ export interface Payload {
6
6
  email_addresses?: string[];
7
7
  order_id?: string;
8
8
  shop_id?: string;
9
- event_channel?: 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;
10
18
  contents?: {
11
19
  price?: number;
12
20
  quantity?: number;
13
- content_type?: string;
21
+ content_category?: string;
14
22
  content_id?: string;
15
23
  content_name?: string;
16
- content_category?: string;
24
+ brand?: string;
17
25
  }[];
18
- currency: string;
19
- value: number;
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;
20
33
  }
@@ -1,136 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- const actions_core_1 = require("@segment/actions-core");
4
3
  const common_fields_1 = require("../common_fields");
5
- const formatter_1 = require("../formatter");
4
+ const utils_1 = require("../utils");
6
5
  const action = {
7
- title: 'Track Payment Offline Conversion',
8
- description: 'Send details of an in-store purchase or console purchase to the Tiktok Offline Events API',
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",
9
8
  fields: {
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
- }
9
+ ...common_fields_1.commonFields
104
10
  },
105
11
  perform: (request, { payload, settings }) => {
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
- });
12
+ return utils_1.performOfflineEvent(request, settings, payload);
134
13
  }
135
14
  };
136
15
  exports.default = action;
@@ -1 +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"}
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"}
@@ -0,0 +1,8 @@
1
+ import { RequestClient } from '@segment/actions-core';
2
+ import { Settings } from './generated-types';
3
+ import { Payload as ReportOfflineEventPayload } from './reportOfflineEvent/generated-types';
4
+ import { Payload as TrackNonPaymentOfflineConversionPayload } from './trackNonPaymentOfflineConversion/generated-types';
5
+ import { Payload as TrackPaymentOfflineConversionPayload } from './trackPaymentOfflineConversion/generated-types';
6
+ declare type OfflineEventPayload = ReportOfflineEventPayload | TrackNonPaymentOfflineConversionPayload | TrackPaymentOfflineConversionPayload;
7
+ export declare function performOfflineEvent(request: RequestClient, settings: Settings, payload: OfflineEventPayload): Promise<import("@segment/actions-core").ModifiedResponse<unknown>>;
8
+ export {};