@adtrackify/at-tracking-event-types 3.5.24 → 3.5.25

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 (310) hide show
  1. package/README.md +12 -12
  2. package/dist/cjs/index.d.ts +1 -1
  3. package/dist/cjs/index.js +17 -17
  4. package/dist/cjs/types/api/account.d.ts +133 -133
  5. package/dist/cjs/types/api/account.js +84 -84
  6. package/dist/cjs/types/api/contact-acquisition/contact-acquisition.d.ts +106 -106
  7. package/dist/cjs/types/api/contact-acquisition/contact-acquisition.js +21 -21
  8. package/dist/cjs/types/api/contact-acquisition/email-verification.d.ts +30 -30
  9. package/dist/cjs/types/api/contact-acquisition/email-verification.js +11 -11
  10. package/dist/cjs/types/api/contact-acquisition/index.d.ts +6 -6
  11. package/dist/cjs/types/api/contact-acquisition/index.js +22 -22
  12. package/dist/cjs/types/api/contact-acquisition/purchased-contact.d.ts +35 -35
  13. package/dist/cjs/types/api/contact-acquisition/purchased-contact.js +8 -8
  14. package/dist/cjs/types/api/contact-acquisition/purchased-traits.d.ts +63 -63
  15. package/dist/cjs/types/api/contact-acquisition/purchased-traits.js +2 -2
  16. package/dist/cjs/types/api/contact-acquisition/third-party-contact.d.ts +44 -44
  17. package/dist/cjs/types/api/contact-acquisition/third-party-contact.js +2 -2
  18. package/dist/cjs/types/api/contact-acquisition/third-party-cookie-contact-acquisition.d.ts +6 -6
  19. package/dist/cjs/types/api/contact-acquisition/third-party-cookie-contact-acquisition.js +2 -2
  20. package/dist/cjs/types/api/dashboards/index.d.ts +1 -1
  21. package/dist/cjs/types/api/dashboards/index.js +17 -17
  22. package/dist/cjs/types/api/dashboards/widget.d.ts +126 -126
  23. package/dist/cjs/types/api/dashboards/widget.js +36 -36
  24. package/dist/cjs/types/api/destination-tracked-events.d.ts +11 -11
  25. package/dist/cjs/types/api/destination-tracked-events.js +3 -3
  26. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +30 -30
  27. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  28. package/dist/cjs/types/api/destinations/destinations.d.ts +125 -125
  29. package/dist/cjs/types/api/destinations/destinations.js +56 -56
  30. package/dist/cjs/types/api/destinations/emq-health.d.ts +14 -16
  31. package/dist/cjs/types/api/destinations/emq-health.js +2 -2
  32. package/dist/cjs/types/api/destinations/index.d.ts +6 -6
  33. package/dist/cjs/types/api/destinations/index.js +22 -22
  34. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  35. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.js +2 -2
  36. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +185 -185
  37. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +23 -23
  38. package/dist/cjs/types/api/destinations/third-party-integration-configs.d.ts +67 -67
  39. package/dist/cjs/types/api/destinations/third-party-integration-configs.js +11 -11
  40. package/dist/cjs/types/api/emq/emq-types.d.ts +189 -160
  41. package/dist/cjs/types/api/emq/emq-types.js +49 -49
  42. package/dist/cjs/types/api/emq/emq-types.js.map +1 -1
  43. package/dist/cjs/types/api/emq/index.d.ts +1 -1
  44. package/dist/cjs/types/api/emq/index.js +17 -17
  45. package/dist/cjs/types/api/event-last-seen.d.ts +6 -6
  46. package/dist/cjs/types/api/event-last-seen.js +2 -2
  47. package/dist/cjs/types/api/event-status.d.ts +18 -18
  48. package/dist/cjs/types/api/event-status.js +9 -9
  49. package/dist/cjs/types/api/events/alert-events.d.ts +175 -175
  50. package/dist/cjs/types/api/events/alert-events.js +53 -53
  51. package/dist/cjs/types/api/events/health-events.d.ts +132 -0
  52. package/dist/cjs/types/api/events/health-events.js +43 -0
  53. package/dist/cjs/types/api/events/health-events.js.map +1 -0
  54. package/dist/cjs/types/api/events/index.d.ts +1 -1
  55. package/dist/cjs/types/api/events/index.js +17 -17
  56. package/dist/cjs/types/api/feature.d.ts +229 -229
  57. package/dist/cjs/types/api/feature.js +199 -199
  58. package/dist/cjs/types/api/index.d.ts +25 -25
  59. package/dist/cjs/types/api/index.js +41 -41
  60. package/dist/cjs/types/api/log-events.d.ts +22 -22
  61. package/dist/cjs/types/api/log-events.js +2 -2
  62. package/dist/cjs/types/api/measures/definitions/channel-measure-definitions.d.ts +2 -2
  63. package/dist/cjs/types/api/measures/definitions/channel-measure-definitions.js +1677 -1677
  64. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.d.ts +2 -2
  65. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js +446 -446
  66. package/dist/cjs/types/api/measures/definitions/emq-measure-definitions.d.ts +2 -2
  67. package/dist/cjs/types/api/measures/definitions/emq-measure-definitions.js +204 -204
  68. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.d.ts +2 -2
  69. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.js +1451 -1451
  70. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.d.ts +2 -2
  71. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.js +325 -325
  72. package/dist/cjs/types/api/measures/definitions/index.d.ts +13 -13
  73. package/dist/cjs/types/api/measures/definitions/index.js +29 -29
  74. package/dist/cjs/types/api/measures/definitions/measure-applicable-contexts.d.ts +9 -9
  75. package/dist/cjs/types/api/measures/definitions/measure-applicable-contexts.js +22 -22
  76. package/dist/cjs/types/api/measures/definitions/measure-categories.d.ts +19 -19
  77. package/dist/cjs/types/api/measures/definitions/measure-categories.js +23 -23
  78. package/dist/cjs/types/api/measures/definitions/measure-definitions.d.ts +40 -40
  79. package/dist/cjs/types/api/measures/definitions/measure-definitions.js +31 -31
  80. package/dist/cjs/types/api/measures/definitions/measure-value-type.d.ts +8 -8
  81. package/dist/cjs/types/api/measures/definitions/measure-value-type.js +12 -12
  82. package/dist/cjs/types/api/measures/definitions/shopify/shopify-measure-definitions.d.ts +2 -2
  83. package/dist/cjs/types/api/measures/definitions/shopify/shopify-measure-definitions.js +864 -864
  84. package/dist/cjs/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.d.ts +2 -2
  85. package/dist/cjs/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.js +446 -446
  86. package/dist/cjs/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.d.ts +2 -2
  87. package/dist/cjs/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.js +447 -447
  88. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.d.ts +2 -2
  89. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.js +509 -509
  90. package/dist/cjs/types/api/measures/index.d.ts +2 -2
  91. package/dist/cjs/types/api/measures/index.js +18 -18
  92. package/dist/cjs/types/api/measures/measures.d.ts +469 -469
  93. package/dist/cjs/types/api/measures/measures.js +473 -473
  94. package/dist/cjs/types/api/notification-settings.d.ts +23 -0
  95. package/dist/cjs/types/api/notification-settings.js +107 -0
  96. package/dist/cjs/types/api/notification-settings.js.map +1 -0
  97. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  98. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  99. package/dist/cjs/types/api/promotion-code.d.ts +35 -35
  100. package/dist/cjs/types/api/promotion-code.js +9 -9
  101. package/dist/cjs/types/api/query.d.ts +153 -153
  102. package/dist/cjs/types/api/query.js +96 -96
  103. package/dist/cjs/types/api/shopify-app-install.d.ts +41 -41
  104. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  105. package/dist/cjs/types/api/subscription.d.ts +192 -192
  106. package/dist/cjs/types/api/subscription.js +48 -48
  107. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  108. package/dist/cjs/types/api/tracking-events.js +2 -2
  109. package/dist/cjs/types/api/user-account.d.ts +32 -39
  110. package/dist/cjs/types/api/user-account.js +16 -16
  111. package/dist/cjs/types/api/user.d.ts +13 -13
  112. package/dist/cjs/types/api/user.js +2 -2
  113. package/dist/cjs/types/common/address.d.ts +22 -22
  114. package/dist/cjs/types/common/address.js +8 -8
  115. package/dist/cjs/types/common/currency.d.ts +1 -1
  116. package/dist/cjs/types/common/currency.js +63 -63
  117. package/dist/cjs/types/common/index.d.ts +2 -2
  118. package/dist/cjs/types/common/index.js +18 -18
  119. package/dist/cjs/types/event/base/event-name-enum.d.ts +134 -123
  120. package/dist/cjs/types/event/base/event-name-enum.js +140 -129
  121. package/dist/cjs/types/event/base/event-name-enum.js.map +1 -1
  122. package/dist/cjs/types/event/base/event.d.ts +20 -20
  123. package/dist/cjs/types/event/base/event.js +10 -10
  124. package/dist/cjs/types/event/base/index.d.ts +2 -2
  125. package/dist/cjs/types/event/base/index.js +18 -18
  126. package/dist/cjs/types/event/context/event-context-identity.d.ts +32 -32
  127. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  128. package/dist/cjs/types/event/context/event-context.d.ts +201 -201
  129. package/dist/cjs/types/event/context/event-context.js +2 -2
  130. package/dist/cjs/types/event/context/index.d.ts +2 -2
  131. package/dist/cjs/types/event/context/index.js +18 -18
  132. package/dist/cjs/types/event/index.d.ts +6 -6
  133. package/dist/cjs/types/event/index.js +22 -22
  134. package/dist/cjs/types/event/log-event.d.ts +35 -35
  135. package/dist/cjs/types/event/log-event.js +22 -22
  136. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  137. package/dist/cjs/types/event/metric-event.js +2 -2
  138. package/dist/cjs/types/event/saas-event-properties.d.ts +47 -47
  139. package/dist/cjs/types/event/saas-event-properties.js +10 -10
  140. package/dist/cjs/types/event/tracking-event.d.ts +69 -69
  141. package/dist/cjs/types/event/tracking-event.js +2 -2
  142. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  143. package/dist/cjs/types/event-bus-event.js +2 -2
  144. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  145. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  146. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  147. package/dist/cjs/types/fingerprint/index.js +18 -18
  148. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  149. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  150. package/dist/cjs/types/index.d.ts +7 -7
  151. package/dist/cjs/types/index.js +23 -23
  152. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  153. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  154. package/dist/cjs/types/tracking-event-ingest-message.d.ts +12 -12
  155. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  156. package/dist/esm/index.d.ts +1 -1
  157. package/dist/esm/index.js +1 -1
  158. package/dist/esm/types/api/account.d.ts +133 -133
  159. package/dist/esm/types/api/account.js +81 -81
  160. package/dist/esm/types/api/contact-acquisition/contact-acquisition.d.ts +106 -106
  161. package/dist/esm/types/api/contact-acquisition/contact-acquisition.js +18 -18
  162. package/dist/esm/types/api/contact-acquisition/email-verification.d.ts +30 -30
  163. package/dist/esm/types/api/contact-acquisition/email-verification.js +8 -8
  164. package/dist/esm/types/api/contact-acquisition/index.d.ts +6 -6
  165. package/dist/esm/types/api/contact-acquisition/index.js +6 -6
  166. package/dist/esm/types/api/contact-acquisition/purchased-contact.d.ts +35 -35
  167. package/dist/esm/types/api/contact-acquisition/purchased-contact.js +5 -5
  168. package/dist/esm/types/api/contact-acquisition/purchased-traits.d.ts +63 -63
  169. package/dist/esm/types/api/contact-acquisition/purchased-traits.js +1 -1
  170. package/dist/esm/types/api/contact-acquisition/third-party-contact.d.ts +44 -44
  171. package/dist/esm/types/api/contact-acquisition/third-party-contact.js +1 -1
  172. package/dist/esm/types/api/contact-acquisition/third-party-cookie-contact-acquisition.d.ts +6 -6
  173. package/dist/esm/types/api/contact-acquisition/third-party-cookie-contact-acquisition.js +1 -1
  174. package/dist/esm/types/api/dashboards/index.d.ts +1 -1
  175. package/dist/esm/types/api/dashboards/index.js +1 -1
  176. package/dist/esm/types/api/dashboards/widget.d.ts +126 -126
  177. package/dist/esm/types/api/dashboards/widget.js +33 -33
  178. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  179. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  180. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  181. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  182. package/dist/esm/types/api/destinations/destinations.d.ts +125 -125
  183. package/dist/esm/types/api/destinations/destinations.js +53 -53
  184. package/dist/esm/types/api/destinations/emq-health.d.ts +14 -16
  185. package/dist/esm/types/api/destinations/emq-health.js +1 -1
  186. package/dist/esm/types/api/destinations/index.d.ts +6 -6
  187. package/dist/esm/types/api/destinations/index.js +6 -6
  188. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  189. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  190. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +185 -185
  191. package/dist/esm/types/api/destinations/third-party-destination-configs.js +20 -20
  192. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +67 -67
  193. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  194. package/dist/esm/types/api/emq/emq-types.d.ts +189 -160
  195. package/dist/esm/types/api/emq/emq-types.js +46 -46
  196. package/dist/esm/types/api/emq/emq-types.js.map +1 -1
  197. package/dist/esm/types/api/emq/index.d.ts +1 -1
  198. package/dist/esm/types/api/emq/index.js +1 -1
  199. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  200. package/dist/esm/types/api/event-last-seen.js +1 -1
  201. package/dist/esm/types/api/event-status.d.ts +18 -18
  202. package/dist/esm/types/api/event-status.js +6 -6
  203. package/dist/esm/types/api/events/alert-events.d.ts +175 -175
  204. package/dist/esm/types/api/events/alert-events.js +50 -50
  205. package/dist/esm/types/api/events/health-events.d.ts +132 -0
  206. package/dist/esm/types/api/events/health-events.js +40 -0
  207. package/dist/esm/types/api/events/health-events.js.map +1 -0
  208. package/dist/esm/types/api/events/index.d.ts +1 -1
  209. package/dist/esm/types/api/events/index.js +1 -1
  210. package/dist/esm/types/api/feature.d.ts +229 -229
  211. package/dist/esm/types/api/feature.js +196 -196
  212. package/dist/esm/types/api/index.d.ts +25 -25
  213. package/dist/esm/types/api/index.js +25 -25
  214. package/dist/esm/types/api/log-events.d.ts +22 -22
  215. package/dist/esm/types/api/log-events.js +1 -1
  216. package/dist/esm/types/api/measures/definitions/channel-measure-definitions.d.ts +2 -2
  217. package/dist/esm/types/api/measures/definitions/channel-measure-definitions.js +1674 -1674
  218. package/dist/esm/types/api/measures/definitions/core-measure-definitions.d.ts +2 -2
  219. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js +443 -443
  220. package/dist/esm/types/api/measures/definitions/emq-measure-definitions.d.ts +2 -2
  221. package/dist/esm/types/api/measures/definitions/emq-measure-definitions.js +201 -201
  222. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.d.ts +2 -2
  223. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.js +1448 -1448
  224. package/dist/esm/types/api/measures/definitions/google-measure-definitions.d.ts +2 -2
  225. package/dist/esm/types/api/measures/definitions/google-measure-definitions.js +322 -322
  226. package/dist/esm/types/api/measures/definitions/index.d.ts +13 -13
  227. package/dist/esm/types/api/measures/definitions/index.js +13 -13
  228. package/dist/esm/types/api/measures/definitions/measure-applicable-contexts.d.ts +9 -9
  229. package/dist/esm/types/api/measures/definitions/measure-applicable-contexts.js +19 -19
  230. package/dist/esm/types/api/measures/definitions/measure-categories.d.ts +19 -19
  231. package/dist/esm/types/api/measures/definitions/measure-categories.js +20 -20
  232. package/dist/esm/types/api/measures/definitions/measure-definitions.d.ts +40 -40
  233. package/dist/esm/types/api/measures/definitions/measure-definitions.js +28 -28
  234. package/dist/esm/types/api/measures/definitions/measure-value-type.d.ts +8 -8
  235. package/dist/esm/types/api/measures/definitions/measure-value-type.js +9 -9
  236. package/dist/esm/types/api/measures/definitions/shopify/shopify-measure-definitions.d.ts +2 -2
  237. package/dist/esm/types/api/measures/definitions/shopify/shopify-measure-definitions.js +861 -861
  238. package/dist/esm/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.d.ts +2 -2
  239. package/dist/esm/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.js +443 -443
  240. package/dist/esm/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.d.ts +2 -2
  241. package/dist/esm/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.js +444 -444
  242. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.d.ts +2 -2
  243. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.js +506 -506
  244. package/dist/esm/types/api/measures/index.d.ts +2 -2
  245. package/dist/esm/types/api/measures/index.js +2 -2
  246. package/dist/esm/types/api/measures/measures.d.ts +469 -469
  247. package/dist/esm/types/api/measures/measures.js +470 -470
  248. package/dist/esm/types/api/notification-settings.d.ts +23 -0
  249. package/dist/esm/types/api/notification-settings.js +103 -0
  250. package/dist/esm/types/api/notification-settings.js.map +1 -0
  251. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  252. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  253. package/dist/esm/types/api/promotion-code.d.ts +35 -35
  254. package/dist/esm/types/api/promotion-code.js +6 -6
  255. package/dist/esm/types/api/query.d.ts +153 -153
  256. package/dist/esm/types/api/query.js +93 -93
  257. package/dist/esm/types/api/shopify-app-install.d.ts +41 -41
  258. package/dist/esm/types/api/shopify-app-install.js +11 -11
  259. package/dist/esm/types/api/subscription.d.ts +192 -192
  260. package/dist/esm/types/api/subscription.js +45 -45
  261. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  262. package/dist/esm/types/api/tracking-events.js +1 -1
  263. package/dist/esm/types/api/user-account.d.ts +32 -39
  264. package/dist/esm/types/api/user-account.js +13 -13
  265. package/dist/esm/types/api/user.d.ts +13 -13
  266. package/dist/esm/types/api/user.js +1 -1
  267. package/dist/esm/types/common/address.d.ts +22 -22
  268. package/dist/esm/types/common/address.js +5 -5
  269. package/dist/esm/types/common/currency.d.ts +1 -1
  270. package/dist/esm/types/common/currency.js +60 -60
  271. package/dist/esm/types/common/index.d.ts +2 -2
  272. package/dist/esm/types/common/index.js +2 -2
  273. package/dist/esm/types/event/base/event-name-enum.d.ts +134 -123
  274. package/dist/esm/types/event/base/event-name-enum.js +137 -126
  275. package/dist/esm/types/event/base/event-name-enum.js.map +1 -1
  276. package/dist/esm/types/event/base/event.d.ts +20 -20
  277. package/dist/esm/types/event/base/event.js +7 -7
  278. package/dist/esm/types/event/base/index.d.ts +2 -2
  279. package/dist/esm/types/event/base/index.js +2 -2
  280. package/dist/esm/types/event/context/event-context-identity.d.ts +32 -32
  281. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  282. package/dist/esm/types/event/context/event-context.d.ts +201 -201
  283. package/dist/esm/types/event/context/event-context.js +1 -1
  284. package/dist/esm/types/event/context/index.d.ts +2 -2
  285. package/dist/esm/types/event/context/index.js +2 -2
  286. package/dist/esm/types/event/index.d.ts +6 -6
  287. package/dist/esm/types/event/index.js +6 -6
  288. package/dist/esm/types/event/log-event.d.ts +35 -35
  289. package/dist/esm/types/event/log-event.js +19 -19
  290. package/dist/esm/types/event/metric-event.d.ts +13 -13
  291. package/dist/esm/types/event/metric-event.js +1 -1
  292. package/dist/esm/types/event/saas-event-properties.d.ts +47 -47
  293. package/dist/esm/types/event/saas-event-properties.js +7 -7
  294. package/dist/esm/types/event/tracking-event.d.ts +69 -69
  295. package/dist/esm/types/event/tracking-event.js +1 -1
  296. package/dist/esm/types/event-bus-event.d.ts +25 -25
  297. package/dist/esm/types/event-bus-event.js +1 -1
  298. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  299. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  300. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  301. package/dist/esm/types/fingerprint/index.js +2 -2
  302. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  303. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  304. package/dist/esm/types/index.d.ts +7 -7
  305. package/dist/esm/types/index.js +7 -7
  306. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  307. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  308. package/dist/esm/types/tracking-event-ingest-message.d.ts +12 -12
  309. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  310. package/package.json +108 -108
@@ -0,0 +1,23 @@
1
+ import { TRACKING_EVENT_NAME } from '../event/base/event-name-enum.js';
2
+ import { USER_ROLES } from './user-account.js';
3
+ export declare enum NOTIFICATION_CATEGORY {
4
+ ACCOUNT_MANAGEMENT = "account_management",
5
+ SUBSCRIPTION = "subscription",
6
+ USAGE = "usage",
7
+ SYSTEM_HEALTH = "system_health"
8
+ }
9
+ export interface NotificationSetting {
10
+ key: string;
11
+ displayName: string;
12
+ description: string;
13
+ category: NOTIFICATION_CATEGORY;
14
+ allowedRoles: USER_ROLES[];
15
+ events: TRACKING_EVENT_NAME[];
16
+ }
17
+ export interface NotificationPreferences {
18
+ categories: Partial<Record<NOTIFICATION_CATEGORY, boolean>>;
19
+ settings?: Partial<Record<string, boolean>>;
20
+ updatedAt?: string;
21
+ }
22
+ export declare const NOTIFICATION_SETTINGS: NotificationSetting[];
23
+ export declare function getSettingsForEvent(eventName: TRACKING_EVENT_NAME): NotificationSetting[];
@@ -0,0 +1,107 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getSettingsForEvent = exports.NOTIFICATION_SETTINGS = exports.NOTIFICATION_CATEGORY = void 0;
4
+ const event_name_enum_js_1 = require("../event/base/event-name-enum.js");
5
+ const user_account_js_1 = require("./user-account.js");
6
+ var NOTIFICATION_CATEGORY;
7
+ (function (NOTIFICATION_CATEGORY) {
8
+ NOTIFICATION_CATEGORY["ACCOUNT_MANAGEMENT"] = "account_management";
9
+ NOTIFICATION_CATEGORY["SUBSCRIPTION"] = "subscription";
10
+ NOTIFICATION_CATEGORY["USAGE"] = "usage";
11
+ NOTIFICATION_CATEGORY["SYSTEM_HEALTH"] = "system_health";
12
+ })(NOTIFICATION_CATEGORY = exports.NOTIFICATION_CATEGORY || (exports.NOTIFICATION_CATEGORY = {}));
13
+ exports.NOTIFICATION_SETTINGS = [
14
+ {
15
+ key: 'team_member_invited',
16
+ displayName: 'Team member invited',
17
+ description: 'When a new user is invited to join the team',
18
+ category: NOTIFICATION_CATEGORY.ACCOUNT_MANAGEMENT,
19
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER],
20
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_INVITATION_NEW_USER],
21
+ },
22
+ {
23
+ key: 'team_member_added',
24
+ displayName: 'Team member added',
25
+ description: 'When an existing user is added to the account',
26
+ category: NOTIFICATION_CATEGORY.ACCOUNT_MANAGEMENT,
27
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER],
28
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_INVITATION_EXISTING_USER],
29
+ },
30
+ {
31
+ key: 'subscription_cancelled',
32
+ displayName: 'Subscription cancelled',
33
+ description: 'When your subscription is cancelled',
34
+ category: NOTIFICATION_CATEGORY.SUBSCRIPTION,
35
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN],
36
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_CANCELLED],
37
+ },
38
+ {
39
+ key: 'payment_failed',
40
+ displayName: 'Payment failed',
41
+ description: 'When a payment attempt fails',
42
+ category: NOTIFICATION_CATEGORY.SUBSCRIPTION,
43
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN],
44
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_PAYMENT_FAILED],
45
+ },
46
+ {
47
+ key: 'trial_ending_soon',
48
+ displayName: 'Trial ending soon',
49
+ description: 'When your trial period is ending',
50
+ category: NOTIFICATION_CATEGORY.SUBSCRIPTION,
51
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN],
52
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_TRIAL_ENDING_SOON],
53
+ },
54
+ {
55
+ key: 'approaching_usage_limit',
56
+ displayName: 'Approaching usage limit',
57
+ description: 'When usage reaches 90% of plan limit',
58
+ category: NOTIFICATION_CATEGORY.USAGE,
59
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER],
60
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_NEARING_USAGE_LIMIT],
61
+ },
62
+ {
63
+ key: 'usage_limit_exceeded',
64
+ displayName: 'Usage limit exceeded',
65
+ description: 'When usage exceeds plan limit',
66
+ category: NOTIFICATION_CATEGORY.USAGE,
67
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER],
68
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_OVER_USAGE_LIMIT],
69
+ },
70
+ {
71
+ key: 'destination_unhealthy',
72
+ displayName: 'Destination unhealthy',
73
+ description: 'When a destination connection fails after retries',
74
+ category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
75
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER, user_account_js_1.USER_ROLES.MEMBER],
76
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_DESTINATION_UNHEALTHY],
77
+ },
78
+ {
79
+ key: 'integration_unhealthy',
80
+ displayName: 'Integration unhealthy',
81
+ description: 'When an integration connection fails after retries',
82
+ category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
83
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER, user_account_js_1.USER_ROLES.MEMBER],
84
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_INTEGRATION_UNHEALTHY],
85
+ },
86
+ {
87
+ key: 'pixel_unhealthy',
88
+ displayName: 'Pixel unhealthy',
89
+ description: 'When the tracking pixel fails',
90
+ category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
91
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER, user_account_js_1.USER_ROLES.MEMBER],
92
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_PIXEL_UNHEALTHY],
93
+ },
94
+ {
95
+ key: 'theme_extension_unhealthy',
96
+ displayName: 'Theme app extension unhealthy',
97
+ description: 'When the theme app extension fails',
98
+ category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
99
+ allowedRoles: [user_account_js_1.USER_ROLES.OWNER, user_account_js_1.USER_ROLES.ADMIN, user_account_js_1.USER_ROLES.MANAGER, user_account_js_1.USER_ROLES.MEMBER],
100
+ events: [event_name_enum_js_1.TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_THEME_EXTENSION_UNHEALTHY],
101
+ },
102
+ ];
103
+ function getSettingsForEvent(eventName) {
104
+ return exports.NOTIFICATION_SETTINGS.filter((s) => s.events.includes(eventName));
105
+ }
106
+ exports.getSettingsForEvent = getSettingsForEvent;
107
+ //# sourceMappingURL=notification-settings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"notification-settings.js","sourceRoot":"","sources":["../../../../src/types/api/notification-settings.ts"],"names":[],"mappings":";;;AAAA,yEAAuE;AACvE,uDAA+C;AAK/C,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,kEAAyC,CAAA;IACzC,sDAA6B,CAAA;IAC7B,wCAAe,CAAA;IACf,wDAA+B,CAAA;AACjC,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAqCY,QAAA,qBAAqB,GAA0B;IAE1D;QACE,GAAG,EAAE,qBAAqB;QAC1B,WAAW,EAAE,qBAAqB;QAClC,WAAW,EAAE,6CAA6C;QAC1D,QAAQ,EAAE,qBAAqB,CAAC,kBAAkB;QAClD,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,wCAAmB,CAAC,oCAAoC,CAAC;KACnE;IACD;QACE,GAAG,EAAE,mBAAmB;QACxB,WAAW,EAAE,mBAAmB;QAChC,WAAW,EAAE,+CAA+C;QAC5D,QAAQ,EAAE,qBAAqB,CAAC,kBAAkB;QAClD,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,wCAAmB,CAAC,yCAAyC,CAAC;KACxE;IAED;QACE,GAAG,EAAE,wBAAwB;QAC7B,WAAW,EAAE,wBAAwB;QACrC,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE,qBAAqB,CAAC,YAAY;QAC5C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,CAAC;QAClD,MAAM,EAAE,CAAC,wCAAmB,CAAC,uCAAuC,CAAC;KACtE;IACD;QACE,GAAG,EAAE,gBAAgB;QACrB,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,8BAA8B;QAC3C,QAAQ,EAAE,qBAAqB,CAAC,YAAY;QAC5C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,CAAC;QAClD,MAAM,EAAE,CAAC,wCAAmB,CAAC,4CAA4C,CAAC;KAC3E;IACD;QACE,GAAG,EAAE,mBAAmB;QACxB,WAAW,EAAE,mBAAmB;QAChC,WAAW,EAAE,kCAAkC;QAC/C,QAAQ,EAAE,qBAAqB,CAAC,YAAY;QAC5C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,CAAC;QAClD,MAAM,EAAE,CAAC,wCAAmB,CAAC,+CAA+C,CAAC;KAC9E;IAED;QACE,GAAG,EAAE,yBAAyB;QAC9B,WAAW,EAAE,yBAAyB;QACtC,WAAW,EAAE,sCAAsC;QACnD,QAAQ,EAAE,qBAAqB,CAAC,KAAK;QACrC,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,wCAAmB,CAAC,iDAAiD,CAAC;KAChF;IACD;QACE,GAAG,EAAE,sBAAsB;QAC3B,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE,+BAA+B;QAC5C,QAAQ,EAAE,qBAAqB,CAAC,KAAK;QACrC,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,wCAAmB,CAAC,8CAA8C,CAAC;KAC7E;IAED;QACE,GAAG,EAAE,uBAAuB;QAC5B,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,mDAAmD;QAChE,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,EAAE,4BAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,wCAAmB,CAAC,sCAAsC,CAAC;KACrE;IACD;QACE,GAAG,EAAE,uBAAuB;QAC5B,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,oDAAoD;QACjE,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,EAAE,4BAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,wCAAmB,CAAC,sCAAsC,CAAC;KACrE;IAED;QACE,GAAG,EAAE,iBAAiB;QACtB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,+BAA+B;QAC5C,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,EAAE,4BAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,wCAAmB,CAAC,gCAAgC,CAAC;KAC/D;IACD;QACE,GAAG,EAAE,2BAA2B;QAChC,WAAW,EAAE,+BAA+B;QAC5C,WAAW,EAAE,oCAAoC;QACjD,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,KAAK,EAAE,4BAAU,CAAC,OAAO,EAAE,4BAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,wCAAmB,CAAC,0CAA0C,CAAC;KACzE;CACF,CAAC;AAOF,SAAgB,mBAAmB,CAAC,SAA8B;IAChE,OAAO,6BAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAC3E,CAAC;AAFD,kDAEC"}
@@ -1,19 +1,19 @@
1
- export interface PixelSetupHealth {
2
- accountId: string;
3
- healthAttributes: HealthAttributes;
4
- }
5
- export interface HealthAttributes {
6
- noOfDestinations: number;
7
- noOfEnabledDestinations: number;
8
- destinations: DestinationHealth[];
9
- destinationsHealthy: boolean;
10
- themeAppExtensionHealthy: boolean;
11
- conversionPixelHealthy: boolean;
12
- customPixelHealthy: boolean;
13
- }
14
- export interface DestinationHealth {
15
- id: string;
16
- displayName: string;
17
- healthy: boolean;
18
- enabled: boolean;
19
- }
1
+ export interface PixelSetupHealth {
2
+ accountId: string;
3
+ healthAttributes: HealthAttributes;
4
+ }
5
+ export interface HealthAttributes {
6
+ noOfDestinations: number;
7
+ noOfEnabledDestinations: number;
8
+ destinations: DestinationHealth[];
9
+ destinationsHealthy: boolean;
10
+ themeAppExtensionHealthy: boolean;
11
+ conversionPixelHealthy: boolean;
12
+ customPixelHealthy: boolean;
13
+ }
14
+ export interface DestinationHealth {
15
+ id: string;
16
+ displayName: string;
17
+ healthy: boolean;
18
+ enabled: boolean;
19
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=pixel-setup-health.js.map
@@ -1,35 +1,35 @@
1
- import { Subscription } from './subscription.js';
2
- export declare enum PROMOTION_CODE_DURATION {
3
- FOREVER = "forever",
4
- ONCE = "once",
5
- REPEATING = "repeating"
6
- }
7
- export interface PromotionCodeDetails {
8
- id: string;
9
- code: string;
10
- percentOff?: number;
11
- amountOff?: number;
12
- currency?: string;
13
- duration: PROMOTION_CODE_DURATION;
14
- durationInMonths?: number;
15
- maxRedemptions?: number;
16
- timesRedeemed?: number;
17
- expiresAt?: string;
18
- }
19
- export interface PromotionCodePreview {
20
- currentAmount: number;
21
- discountedAmount: number;
22
- discountAmount: number;
23
- currency: string;
24
- nextBillingDate?: string;
25
- }
26
- export interface ValidatePromotionCodeResponse {
27
- valid: boolean;
28
- promotionCode?: PromotionCodeDetails;
29
- preview?: PromotionCodePreview;
30
- message?: string;
31
- }
32
- export interface ApplyPromotionCodeResponse {
33
- message: string;
34
- subscription: Subscription;
35
- }
1
+ import { Subscription } from './subscription.js';
2
+ export declare enum PROMOTION_CODE_DURATION {
3
+ FOREVER = "forever",
4
+ ONCE = "once",
5
+ REPEATING = "repeating"
6
+ }
7
+ export interface PromotionCodeDetails {
8
+ id: string;
9
+ code: string;
10
+ percentOff?: number;
11
+ amountOff?: number;
12
+ currency?: string;
13
+ duration: PROMOTION_CODE_DURATION;
14
+ durationInMonths?: number;
15
+ maxRedemptions?: number;
16
+ timesRedeemed?: number;
17
+ expiresAt?: string;
18
+ }
19
+ export interface PromotionCodePreview {
20
+ currentAmount: number;
21
+ discountedAmount: number;
22
+ discountAmount: number;
23
+ currency: string;
24
+ nextBillingDate?: string;
25
+ }
26
+ export interface ValidatePromotionCodeResponse {
27
+ valid: boolean;
28
+ promotionCode?: PromotionCodeDetails;
29
+ preview?: PromotionCodePreview;
30
+ message?: string;
31
+ }
32
+ export interface ApplyPromotionCodeResponse {
33
+ message: string;
34
+ subscription: Subscription;
35
+ }
@@ -1,10 +1,10 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PROMOTION_CODE_DURATION = void 0;
4
- var PROMOTION_CODE_DURATION;
5
- (function (PROMOTION_CODE_DURATION) {
6
- PROMOTION_CODE_DURATION["FOREVER"] = "forever";
7
- PROMOTION_CODE_DURATION["ONCE"] = "once";
8
- PROMOTION_CODE_DURATION["REPEATING"] = "repeating";
9
- })(PROMOTION_CODE_DURATION = exports.PROMOTION_CODE_DURATION || (exports.PROMOTION_CODE_DURATION = {}));
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PROMOTION_CODE_DURATION = void 0;
4
+ var PROMOTION_CODE_DURATION;
5
+ (function (PROMOTION_CODE_DURATION) {
6
+ PROMOTION_CODE_DURATION["FOREVER"] = "forever";
7
+ PROMOTION_CODE_DURATION["ONCE"] = "once";
8
+ PROMOTION_CODE_DURATION["REPEATING"] = "repeating";
9
+ })(PROMOTION_CODE_DURATION = exports.PROMOTION_CODE_DURATION || (exports.PROMOTION_CODE_DURATION = {}));
10
10
  //# sourceMappingURL=promotion-code.js.map
@@ -1,153 +1,153 @@
1
- import { MEASURE } from './measures/measures.js';
2
- export interface DateRange {
3
- start: string;
4
- end: string;
5
- timezone?: string;
6
- utcStart?: string;
7
- utcEnd?: string;
8
- }
9
- export declare enum GRANULARITY {
10
- NONE = "none",
11
- SECOND = "second",
12
- MINUTE = "minute",
13
- HOUR = "hour",
14
- DAY = "day",
15
- WEEK = "week",
16
- MONTH = "month",
17
- QUARTER = "quarter",
18
- YEAR = "year"
19
- }
20
- export interface Query {
21
- pixelId: string;
22
- measures: MeasureConfig[];
23
- dateRange: DateRange;
24
- compareDateRange?: DateRange;
25
- granularity?: GRANULARITY;
26
- dimensions?: DIMENSION[];
27
- filters?: any[];
28
- timezone?: string;
29
- orderSettings?: OrderSettings;
30
- }
31
- export interface MeasureConfig {
32
- measure: MEASURE;
33
- pacing?: boolean;
34
- }
35
- export interface OrderSettings {
36
- countVoidedOrders?: boolean;
37
- countPendingOrders?: boolean;
38
- }
39
- export interface AppliedDimensions {
40
- dimensionName?: string;
41
- dimensionValue?: string;
42
- }
43
- export declare type MeasureDataRow = {
44
- [key: string]: any;
45
- dt?: string;
46
- start?: string;
47
- end?: string;
48
- };
49
- export interface QueryData {
50
- primary?: MeasureDataRow[];
51
- compare?: MeasureDataRow[];
52
- }
53
- export interface MeasureDetail {
54
- measure: MEASURE;
55
- isAverage: boolean;
56
- isPercentage: boolean;
57
- calculatedAverage: boolean;
58
- success: boolean;
59
- primaryAvg: number;
60
- compareAvg: number;
61
- primarySum: number;
62
- compareSum: number;
63
- percentDiff: number;
64
- hasPacing: boolean;
65
- }
66
- export interface QueryResult {
67
- granularity: GRANULARITY;
68
- dimensions: DIMENSION[];
69
- dateRange: DateRange;
70
- compareDateRange?: DateRange;
71
- measureDetails: MeasureDetail[] | null;
72
- data: QueryData | null;
73
- }
74
- export interface QueryResponse {
75
- results: QueryResult[];
76
- }
77
- export declare enum DIMENSION {
78
- DEVICE_MODEL = "device_model",
79
- DEVICE_VENDOR = "device_vendor",
80
- DEVICE_TYPE = "device_type",
81
- BROWSER = "browser",
82
- BROWSER_VERSION = "browser_version",
83
- BROWSER_OS = "browser_os",
84
- OS = "OS",
85
- LANDING_PATH = "landing_path",
86
- PAGE_PATH = "path",
87
- PAGE_TITLE = "title",
88
- QUERY_STRING = "query",
89
- GATEWAY = "gateway",
90
- CURRENCY = "currency",
91
- SHIPPING_CODE = "shipping_code",
92
- IS_MOBILE = "is_mobile",
93
- IS_WIRELESS = "is_wireless",
94
- CITY = "city",
95
- PROVINCE_CODE = "province_code",
96
- PROVINCE = "province",
97
- COUNTRY_CODE = "country_code",
98
- COUNTRY = "country",
99
- POSTAL_CODE = "postal_code",
100
- FINANCIAL_STATUS = "financial_status",
101
- FULFILLMENT_STATUS = "fulfillment_status",
102
- DISCOUNT_CODE = "discount_code",
103
- REFERRER = "referrer",
104
- REFERRER_MEDIUM = "referrer_medium",
105
- REFERRER_SOURCE = "referrer_source",
106
- REFERRER_TERM = "referrer_term",
107
- UTM_SOURCE = "utm_source",
108
- UTM_CAMPAIGN = "utm_campaign",
109
- UTM_MEDIUM = "utm_medium",
110
- UTM_TERM = "utm_term",
111
- UTM_CONTENT = "utm_content",
112
- UTM_SOURCE_MEDIUM = "utm_source_medium",
113
- UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
114
- UTM_ADSET = "utm_adset",
115
- UTM_AD = "utm_ad",
116
- CLICK_NETWORK = "click_network",
117
- ADBLOCK_DETECTED = "adblock_detected",
118
- TIMEZONE = "timezone",
119
- LOCALE = "locale",
120
- CAMPAIGN = "campaign",
121
- ADSET = "adset",
122
- AD = "ad",
123
- CUSTOMER_TYPE = "customer_type",
124
- AD_SOURCE = "ad_source",
125
- PRODUCT = "product",
126
- VARIANT = "variant",
127
- ORDER = "order",
128
- NEW_CUSTOMER_ORDER = "new_customer_order",
129
- EMQ_EVENT_NAME = "emq.event_name",
130
- EMQ_MATCH_KEY_IDENTIFIER = "emq.identifier",
131
- EMQ_DIAGNOSTIC_NAME = "emq.diagnostic_name",
132
- EMQ_SEVERITY = "emq.severity",
133
- EMQ_ISSUE_CATEGORY = "emq.issue_category",
134
- EMQ_DEDUP_KEY = "emq.dedup_key"
135
- }
136
- export declare enum FIELDS {
137
- SHOPIFY_ORDER_ID = "shopify.order_id",
138
- SHOPIFY_ORDER_NAME = "shopify.order_name",
139
- SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
140
- SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
141
- SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
142
- SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
143
- TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
144
- }
145
- export declare enum ATTRIBUTION_MODEL {
146
- FIRST_CLICK = "first_click",
147
- LAST_CLICK = "last_click",
148
- ANY_CLICK = "any_click"
149
- }
150
- export declare enum PAGES_REPORT_DIMENSION {
151
- LANDING_PAGE = "landing_page",
152
- EXIT_PAGE = "exit_page"
153
- }
1
+ import { MEASURE } from './measures/measures.js';
2
+ export interface DateRange {
3
+ start: string;
4
+ end: string;
5
+ timezone?: string;
6
+ utcStart?: string;
7
+ utcEnd?: string;
8
+ }
9
+ export declare enum GRANULARITY {
10
+ NONE = "none",
11
+ SECOND = "second",
12
+ MINUTE = "minute",
13
+ HOUR = "hour",
14
+ DAY = "day",
15
+ WEEK = "week",
16
+ MONTH = "month",
17
+ QUARTER = "quarter",
18
+ YEAR = "year"
19
+ }
20
+ export interface Query {
21
+ pixelId: string;
22
+ measures: MeasureConfig[];
23
+ dateRange: DateRange;
24
+ compareDateRange?: DateRange;
25
+ granularity?: GRANULARITY;
26
+ dimensions?: DIMENSION[];
27
+ filters?: any[];
28
+ timezone?: string;
29
+ orderSettings?: OrderSettings;
30
+ }
31
+ export interface MeasureConfig {
32
+ measure: MEASURE;
33
+ pacing?: boolean;
34
+ }
35
+ export interface OrderSettings {
36
+ countVoidedOrders?: boolean;
37
+ countPendingOrders?: boolean;
38
+ }
39
+ export interface AppliedDimensions {
40
+ dimensionName?: string;
41
+ dimensionValue?: string;
42
+ }
43
+ export declare type MeasureDataRow = {
44
+ [key: string]: any;
45
+ dt?: string;
46
+ start?: string;
47
+ end?: string;
48
+ };
49
+ export interface QueryData {
50
+ primary?: MeasureDataRow[];
51
+ compare?: MeasureDataRow[];
52
+ }
53
+ export interface MeasureDetail {
54
+ measure: MEASURE;
55
+ isAverage: boolean;
56
+ isPercentage: boolean;
57
+ calculatedAverage: boolean;
58
+ success: boolean;
59
+ primaryAvg: number;
60
+ compareAvg: number;
61
+ primarySum: number;
62
+ compareSum: number;
63
+ percentDiff: number;
64
+ hasPacing: boolean;
65
+ }
66
+ export interface QueryResult {
67
+ granularity: GRANULARITY;
68
+ dimensions: DIMENSION[];
69
+ dateRange: DateRange;
70
+ compareDateRange?: DateRange;
71
+ measureDetails: MeasureDetail[] | null;
72
+ data: QueryData | null;
73
+ }
74
+ export interface QueryResponse {
75
+ results: QueryResult[];
76
+ }
77
+ export declare enum DIMENSION {
78
+ DEVICE_MODEL = "device_model",
79
+ DEVICE_VENDOR = "device_vendor",
80
+ DEVICE_TYPE = "device_type",
81
+ BROWSER = "browser",
82
+ BROWSER_VERSION = "browser_version",
83
+ BROWSER_OS = "browser_os",
84
+ OS = "OS",
85
+ LANDING_PATH = "landing_path",
86
+ PAGE_PATH = "path",
87
+ PAGE_TITLE = "title",
88
+ QUERY_STRING = "query",
89
+ GATEWAY = "gateway",
90
+ CURRENCY = "currency",
91
+ SHIPPING_CODE = "shipping_code",
92
+ IS_MOBILE = "is_mobile",
93
+ IS_WIRELESS = "is_wireless",
94
+ CITY = "city",
95
+ PROVINCE_CODE = "province_code",
96
+ PROVINCE = "province",
97
+ COUNTRY_CODE = "country_code",
98
+ COUNTRY = "country",
99
+ POSTAL_CODE = "postal_code",
100
+ FINANCIAL_STATUS = "financial_status",
101
+ FULFILLMENT_STATUS = "fulfillment_status",
102
+ DISCOUNT_CODE = "discount_code",
103
+ REFERRER = "referrer",
104
+ REFERRER_MEDIUM = "referrer_medium",
105
+ REFERRER_SOURCE = "referrer_source",
106
+ REFERRER_TERM = "referrer_term",
107
+ UTM_SOURCE = "utm_source",
108
+ UTM_CAMPAIGN = "utm_campaign",
109
+ UTM_MEDIUM = "utm_medium",
110
+ UTM_TERM = "utm_term",
111
+ UTM_CONTENT = "utm_content",
112
+ UTM_SOURCE_MEDIUM = "utm_source_medium",
113
+ UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
114
+ UTM_ADSET = "utm_adset",
115
+ UTM_AD = "utm_ad",
116
+ CLICK_NETWORK = "click_network",
117
+ ADBLOCK_DETECTED = "adblock_detected",
118
+ TIMEZONE = "timezone",
119
+ LOCALE = "locale",
120
+ CAMPAIGN = "campaign",
121
+ ADSET = "adset",
122
+ AD = "ad",
123
+ CUSTOMER_TYPE = "customer_type",
124
+ AD_SOURCE = "ad_source",
125
+ PRODUCT = "product",
126
+ VARIANT = "variant",
127
+ ORDER = "order",
128
+ NEW_CUSTOMER_ORDER = "new_customer_order",
129
+ EMQ_EVENT_NAME = "emq.event_name",
130
+ EMQ_MATCH_KEY_IDENTIFIER = "emq.identifier",
131
+ EMQ_DIAGNOSTIC_NAME = "emq.diagnostic_name",
132
+ EMQ_SEVERITY = "emq.severity",
133
+ EMQ_ISSUE_CATEGORY = "emq.issue_category",
134
+ EMQ_DEDUP_KEY = "emq.dedup_key"
135
+ }
136
+ export declare enum FIELDS {
137
+ SHOPIFY_ORDER_ID = "shopify.order_id",
138
+ SHOPIFY_ORDER_NAME = "shopify.order_name",
139
+ SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
140
+ SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
141
+ SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
142
+ SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
143
+ TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
144
+ }
145
+ export declare enum ATTRIBUTION_MODEL {
146
+ FIRST_CLICK = "first_click",
147
+ LAST_CLICK = "last_click",
148
+ ANY_CLICK = "any_click"
149
+ }
150
+ export declare enum PAGES_REPORT_DIMENSION {
151
+ LANDING_PAGE = "landing_page",
152
+ EXIT_PAGE = "exit_page"
153
+ }