@adtrackify/at-tracking-event-types 3.3.6 → 3.3.8

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 (235) hide show
  1. package/dist/cjs/index.d.ts +1 -1
  2. package/dist/cjs/index.js +17 -17
  3. package/dist/cjs/types/api/account.d.ts +76 -76
  4. package/dist/cjs/types/api/account.js +36 -36
  5. package/dist/cjs/types/api/contact-acquisition.d.ts +223 -223
  6. package/dist/cjs/types/api/contact-acquisition.js +21 -21
  7. package/dist/cjs/types/api/dashboards/index.d.ts +1 -1
  8. package/dist/cjs/types/api/dashboards/index.js +17 -17
  9. package/dist/cjs/types/api/dashboards/widget.d.ts +115 -115
  10. package/dist/cjs/types/api/dashboards/widget.js +36 -36
  11. package/dist/cjs/types/api/destination-tracked-events.d.ts +11 -11
  12. package/dist/cjs/types/api/destination-tracked-events.js +3 -3
  13. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +30 -30
  14. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  15. package/dist/cjs/types/api/destinations/destinations.d.ts +112 -112
  16. package/dist/cjs/types/api/destinations/destinations.js +50 -50
  17. package/dist/cjs/types/api/destinations/index.d.ts +5 -5
  18. package/dist/cjs/types/api/destinations/index.js +21 -21
  19. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  20. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.js +2 -2
  21. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +117 -117
  22. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +9 -9
  23. package/dist/cjs/types/api/destinations/third-party-integration-configs.d.ts +61 -61
  24. package/dist/cjs/types/api/destinations/third-party-integration-configs.js +11 -11
  25. package/dist/cjs/types/api/event-last-seen.d.ts +6 -6
  26. package/dist/cjs/types/api/event-last-seen.js +2 -2
  27. package/dist/cjs/types/api/event-status.d.ts +18 -18
  28. package/dist/cjs/types/api/event-status.js +9 -9
  29. package/dist/cjs/types/api/index.d.ts +21 -21
  30. package/dist/cjs/types/api/index.js +37 -37
  31. package/dist/cjs/types/api/log-events.d.ts +22 -22
  32. package/dist/cjs/types/api/log-events.js +2 -2
  33. package/dist/cjs/types/api/measures/definitions/channel-measure-definitions.d.ts +2 -2
  34. package/dist/cjs/types/api/measures/definitions/channel-measure-definitions.js +1224 -1224
  35. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.d.ts +2 -2
  36. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js +446 -446
  37. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.d.ts +2 -2
  38. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.js +639 -639
  39. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.d.ts +2 -2
  40. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.js +339 -339
  41. package/dist/cjs/types/api/measures/definitions/index.d.ts +11 -11
  42. package/dist/cjs/types/api/measures/definitions/index.js +27 -27
  43. package/dist/cjs/types/api/measures/definitions/measure-applicable-contexts.d.ts +9 -9
  44. package/dist/cjs/types/api/measures/definitions/measure-applicable-contexts.js +22 -22
  45. package/dist/cjs/types/api/measures/definitions/measure-categories.d.ts +18 -18
  46. package/dist/cjs/types/api/measures/definitions/measure-categories.js +22 -22
  47. package/dist/cjs/types/api/measures/definitions/measure-definitions.d.ts +40 -40
  48. package/dist/cjs/types/api/measures/definitions/measure-definitions.js +29 -29
  49. package/dist/cjs/types/api/measures/definitions/measure-value-type.d.ts +8 -8
  50. package/dist/cjs/types/api/measures/definitions/measure-value-type.js +12 -12
  51. package/dist/cjs/types/api/measures/definitions/shopify/shopify-measure-definitions.d.ts +2 -2
  52. package/dist/cjs/types/api/measures/definitions/shopify/shopify-measure-definitions.js +715 -715
  53. package/dist/cjs/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.d.ts +2 -2
  54. package/dist/cjs/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.js +296 -296
  55. package/dist/cjs/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.d.ts +2 -2
  56. package/dist/cjs/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.js +297 -297
  57. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.d.ts +2 -2
  58. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.js +519 -519
  59. package/dist/cjs/types/api/measures/index.d.ts +2 -2
  60. package/dist/cjs/types/api/measures/index.js +18 -18
  61. package/dist/cjs/types/api/measures/measures.d.ts +322 -322
  62. package/dist/cjs/types/api/measures/measures.js +326 -326
  63. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  64. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  65. package/dist/cjs/types/api/query.d.ts +147 -147
  66. package/dist/cjs/types/api/query.js +90 -90
  67. package/dist/cjs/types/api/shopify-app-install.d.ts +40 -40
  68. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  69. package/dist/cjs/types/api/subscription.d.ts +180 -173
  70. package/dist/cjs/types/api/subscription.js +47 -47
  71. package/dist/cjs/types/api/subscription.js.map +1 -1
  72. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  73. package/dist/cjs/types/api/tracking-events.js +2 -2
  74. package/dist/cjs/types/api/user-account.d.ts +22 -22
  75. package/dist/cjs/types/api/user-account.js +15 -15
  76. package/dist/cjs/types/api/user.d.ts +13 -13
  77. package/dist/cjs/types/api/user.js +2 -2
  78. package/dist/cjs/types/common/address.d.ts +15 -15
  79. package/dist/cjs/types/common/address.js +2 -2
  80. package/dist/cjs/types/common/currency.d.ts +1 -1
  81. package/dist/cjs/types/common/currency.js +63 -63
  82. package/dist/cjs/types/common/index.d.ts +2 -2
  83. package/dist/cjs/types/common/index.js +18 -18
  84. package/dist/cjs/types/event/base/event-name-enum.d.ts +79 -79
  85. package/dist/cjs/types/event/base/event-name-enum.js +85 -85
  86. package/dist/cjs/types/event/base/event.d.ts +20 -20
  87. package/dist/cjs/types/event/base/event.js +10 -10
  88. package/dist/cjs/types/event/base/index.d.ts +2 -2
  89. package/dist/cjs/types/event/base/index.js +18 -18
  90. package/dist/cjs/types/event/context/event-context-identity.d.ts +21 -21
  91. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  92. package/dist/cjs/types/event/context/event-context.d.ts +196 -196
  93. package/dist/cjs/types/event/context/event-context.js +2 -2
  94. package/dist/cjs/types/event/context/index.d.ts +2 -2
  95. package/dist/cjs/types/event/context/index.js +18 -18
  96. package/dist/cjs/types/event/index.d.ts +5 -5
  97. package/dist/cjs/types/event/index.js +21 -21
  98. package/dist/cjs/types/event/log-event.d.ts +35 -35
  99. package/dist/cjs/types/event/log-event.js +22 -22
  100. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  101. package/dist/cjs/types/event/metric-event.js +2 -2
  102. package/dist/cjs/types/event/tracking-event.d.ts +66 -66
  103. package/dist/cjs/types/event/tracking-event.js +2 -2
  104. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  105. package/dist/cjs/types/event-bus-event.js +2 -2
  106. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  107. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  108. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  109. package/dist/cjs/types/fingerprint/index.js +18 -18
  110. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  111. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  112. package/dist/cjs/types/index.d.ts +7 -7
  113. package/dist/cjs/types/index.js +23 -23
  114. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  115. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  116. package/dist/cjs/types/tracking-event-ingest-message.d.ts +12 -12
  117. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  118. package/dist/esm/index.d.ts +1 -1
  119. package/dist/esm/index.js +1 -1
  120. package/dist/esm/types/api/account.d.ts +76 -76
  121. package/dist/esm/types/api/account.js +33 -33
  122. package/dist/esm/types/api/contact-acquisition.d.ts +223 -223
  123. package/dist/esm/types/api/contact-acquisition.js +18 -18
  124. package/dist/esm/types/api/dashboards/index.d.ts +1 -1
  125. package/dist/esm/types/api/dashboards/index.js +1 -1
  126. package/dist/esm/types/api/dashboards/widget.d.ts +115 -115
  127. package/dist/esm/types/api/dashboards/widget.js +33 -33
  128. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  129. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  130. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  131. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  132. package/dist/esm/types/api/destinations/destinations.d.ts +112 -112
  133. package/dist/esm/types/api/destinations/destinations.js +47 -47
  134. package/dist/esm/types/api/destinations/index.d.ts +5 -5
  135. package/dist/esm/types/api/destinations/index.js +5 -5
  136. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  137. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  138. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +117 -117
  139. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  140. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +61 -61
  141. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  142. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  143. package/dist/esm/types/api/event-last-seen.js +1 -1
  144. package/dist/esm/types/api/event-status.d.ts +18 -18
  145. package/dist/esm/types/api/event-status.js +6 -6
  146. package/dist/esm/types/api/index.d.ts +21 -21
  147. package/dist/esm/types/api/index.js +21 -21
  148. package/dist/esm/types/api/log-events.d.ts +22 -22
  149. package/dist/esm/types/api/log-events.js +1 -1
  150. package/dist/esm/types/api/measures/definitions/channel-measure-definitions.d.ts +2 -2
  151. package/dist/esm/types/api/measures/definitions/channel-measure-definitions.js +1221 -1221
  152. package/dist/esm/types/api/measures/definitions/core-measure-definitions.d.ts +2 -2
  153. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js +443 -443
  154. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.d.ts +2 -2
  155. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.js +636 -636
  156. package/dist/esm/types/api/measures/definitions/google-measure-definitions.d.ts +2 -2
  157. package/dist/esm/types/api/measures/definitions/google-measure-definitions.js +336 -336
  158. package/dist/esm/types/api/measures/definitions/index.d.ts +11 -11
  159. package/dist/esm/types/api/measures/definitions/index.js +11 -11
  160. package/dist/esm/types/api/measures/definitions/measure-applicable-contexts.d.ts +9 -9
  161. package/dist/esm/types/api/measures/definitions/measure-applicable-contexts.js +19 -19
  162. package/dist/esm/types/api/measures/definitions/measure-categories.d.ts +18 -18
  163. package/dist/esm/types/api/measures/definitions/measure-categories.js +19 -19
  164. package/dist/esm/types/api/measures/definitions/measure-definitions.d.ts +40 -40
  165. package/dist/esm/types/api/measures/definitions/measure-definitions.js +26 -26
  166. package/dist/esm/types/api/measures/definitions/measure-value-type.d.ts +8 -8
  167. package/dist/esm/types/api/measures/definitions/measure-value-type.js +9 -9
  168. package/dist/esm/types/api/measures/definitions/shopify/shopify-measure-definitions.d.ts +2 -2
  169. package/dist/esm/types/api/measures/definitions/shopify/shopify-measure-definitions.js +712 -712
  170. package/dist/esm/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.d.ts +2 -2
  171. package/dist/esm/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.js +293 -293
  172. package/dist/esm/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.d.ts +2 -2
  173. package/dist/esm/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.js +294 -294
  174. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.d.ts +2 -2
  175. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.js +516 -516
  176. package/dist/esm/types/api/measures/index.d.ts +2 -2
  177. package/dist/esm/types/api/measures/index.js +2 -2
  178. package/dist/esm/types/api/measures/measures.d.ts +322 -322
  179. package/dist/esm/types/api/measures/measures.js +323 -323
  180. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  181. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  182. package/dist/esm/types/api/query.d.ts +147 -147
  183. package/dist/esm/types/api/query.js +87 -87
  184. package/dist/esm/types/api/shopify-app-install.d.ts +40 -40
  185. package/dist/esm/types/api/shopify-app-install.js +11 -11
  186. package/dist/esm/types/api/subscription.d.ts +180 -173
  187. package/dist/esm/types/api/subscription.js +44 -44
  188. package/dist/esm/types/api/subscription.js.map +1 -1
  189. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  190. package/dist/esm/types/api/tracking-events.js +1 -1
  191. package/dist/esm/types/api/user-account.d.ts +22 -22
  192. package/dist/esm/types/api/user-account.js +12 -12
  193. package/dist/esm/types/api/user.d.ts +13 -13
  194. package/dist/esm/types/api/user.js +1 -1
  195. package/dist/esm/types/common/address.d.ts +15 -15
  196. package/dist/esm/types/common/address.js +1 -1
  197. package/dist/esm/types/common/currency.d.ts +1 -1
  198. package/dist/esm/types/common/currency.js +60 -60
  199. package/dist/esm/types/common/index.d.ts +2 -2
  200. package/dist/esm/types/common/index.js +2 -2
  201. package/dist/esm/types/event/base/event-name-enum.d.ts +79 -79
  202. package/dist/esm/types/event/base/event-name-enum.js +82 -82
  203. package/dist/esm/types/event/base/event.d.ts +20 -20
  204. package/dist/esm/types/event/base/event.js +7 -7
  205. package/dist/esm/types/event/base/index.d.ts +2 -2
  206. package/dist/esm/types/event/base/index.js +2 -2
  207. package/dist/esm/types/event/context/event-context-identity.d.ts +21 -21
  208. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  209. package/dist/esm/types/event/context/event-context.d.ts +196 -196
  210. package/dist/esm/types/event/context/event-context.js +1 -1
  211. package/dist/esm/types/event/context/index.d.ts +2 -2
  212. package/dist/esm/types/event/context/index.js +2 -2
  213. package/dist/esm/types/event/index.d.ts +5 -5
  214. package/dist/esm/types/event/index.js +5 -5
  215. package/dist/esm/types/event/log-event.d.ts +35 -35
  216. package/dist/esm/types/event/log-event.js +19 -19
  217. package/dist/esm/types/event/metric-event.d.ts +13 -13
  218. package/dist/esm/types/event/metric-event.js +1 -1
  219. package/dist/esm/types/event/tracking-event.d.ts +66 -66
  220. package/dist/esm/types/event/tracking-event.js +1 -1
  221. package/dist/esm/types/event-bus-event.d.ts +25 -25
  222. package/dist/esm/types/event-bus-event.js +1 -1
  223. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  224. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  225. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  226. package/dist/esm/types/fingerprint/index.js +2 -2
  227. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  228. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  229. package/dist/esm/types/index.d.ts +7 -7
  230. package/dist/esm/types/index.js +7 -7
  231. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  232. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  233. package/dist/esm/types/tracking-event-ingest-message.d.ts +12 -12
  234. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  235. package/package.json +1 -1
@@ -1,173 +1,180 @@
1
- export interface Subscription {
2
- id: string;
3
- accountId?: string;
4
- shopifyAppInstallId?: string;
5
- shopifyDomain?: string;
6
- stripeCustomerId?: string;
7
- stripeSubscriptionId?: string;
8
- stripeCompletedCheckoutSession?: any;
9
- shopifyChargeId?: string;
10
- shopifyRecurringAppCharge?: ShopifyRecurringAppCharge;
11
- subscriptionPlan?: SubscriptionPlan;
12
- planUsage?: PlanUsage;
13
- trialDays?: number;
14
- trialStartedOn?: string;
15
- trialEndsOn?: string;
16
- usageBillingRecords?: UsageBillingRecord[];
17
- status?: SUBSCRIPTION_STATUS;
18
- cancelledOn?: string;
19
- paymentStatus?: PAYMENT_STATUS;
20
- paymentGateway?: PAYMENT_GATEWAY;
21
- contactAcquisition?: ContactAcquisition;
22
- createdAt: string;
23
- updatedAt: string;
24
- }
25
- export interface SubscriptionPlan {
26
- id: string;
27
- planName: string;
28
- displayName: string;
29
- description: string;
30
- sku: string;
31
- price: number;
32
- discountedPrice?: number;
33
- displayPrice: string;
34
- discountedDisplayPrice?: string;
35
- billingFrequency: PLAN_BILLING_FREQUENCY;
36
- trialLengthDays?: number;
37
- trialRequiresCreditCard?: boolean;
38
- enableUsage: boolean;
39
- orderUsageLimit?: number;
40
- pricePerOrderAfterUsageLimit?: number;
41
- usageCappedAmount?: number;
42
- planDesc?: string[];
43
- unitPriceText?: string;
44
- isHighlighted?: boolean;
45
- isBanner?: boolean;
46
- bannerText?: string;
47
- bannerColor?: string;
48
- stripePriceId?: string;
49
- stripeProductId?: string;
50
- isActive: boolean;
51
- isPublic: boolean;
52
- isDiscountable: boolean;
53
- discountId?: string;
54
- discount?: Discount;
55
- createdAt?: string;
56
- updatedAt?: string;
57
- }
58
- export interface Discount {
59
- id: string;
60
- code: string;
61
- isActive: boolean;
62
- applicableBillingFrequency: PLAN_BILLING_FREQUENCY;
63
- billingIntervalDurationLimit?: number;
64
- discountType: DiscountType;
65
- discountValue: number;
66
- activeUntil?: string;
67
- createdAt?: string;
68
- updatedAt?: string;
69
- }
70
- export declare enum DiscountType {
71
- FIXED = "fixed",
72
- PERCENTAGE = "percentage"
73
- }
74
- export interface PlanUsage {
75
- usage75?: boolean;
76
- usage90?: boolean;
77
- currentMonthUsage?: number;
78
- usageExceeded?: boolean;
79
- lastMonthUsage?: number;
80
- lastThreeMonthsUsage?: number;
81
- lastMonthUsageRatio?: number;
82
- currentMonthUsageRatio?: number;
83
- lastThreeMonthUsageRatio?: number;
84
- lastThreeMonthsUsageExceeded?: boolean;
85
- last12MonthsGMV?: number;
86
- last12MonthsAOV?: number;
87
- currency?: string;
88
- }
89
- export declare enum PLAN_BILLING_FREQUENCY {
90
- MONTHLY = "monthly",
91
- YEARLY = "yearly"
92
- }
93
- export declare enum PAYMENT_STATUS {
94
- CURRENT = "current",
95
- PAST_DUE = "past_due",
96
- CANCELLED = "cancelled",
97
- FAILED = "failed"
98
- }
99
- export declare enum SUBSCRIPTION_STATUS {
100
- ACTIVE = "active",
101
- CANCELLED = "cancelled",
102
- DECLINED = "declined",
103
- EXPIRED = "expired",
104
- FROZEN = "frozen",
105
- PENDING = "pending",
106
- NOT_SUBMITTED = "na"
107
- }
108
- export declare enum PAYMENT_GATEWAY {
109
- STRIPE = "stripe",
110
- PAYPAL = "paypal",
111
- SHOPIFY = "shopify"
112
- }
113
- export declare type ShopifyRecurringAppChargeStatus = 'accepted' | 'active' | 'cancelled' | 'declined' | 'expired' | 'frozen' | 'pending';
114
- export interface ShopifyRecurringAppCharge {
115
- activated_on: string | null;
116
- billing_on: string | null;
117
- cancelled_on: string | null;
118
- capped_amount: number;
119
- confirmation_url: string;
120
- created_at: string;
121
- id: number;
122
- name: string;
123
- price: string;
124
- return_url: string;
125
- status: ShopifyRecurringAppChargeStatus;
126
- terms: string;
127
- test: boolean | null;
128
- trial_days: number;
129
- trial_ends_on: string;
130
- updated_at: string;
131
- }
132
- export interface UsageBillingRecord {
133
- billingPeriodStart: string;
134
- billingPeriodEnd: string;
135
- totalUsage: number;
136
- totalUsageBilledAmount: number;
137
- usageBills?: UsageBill[];
138
- createdAt: string;
139
- updatedAt: string;
140
- }
141
- export interface UsageBill {
142
- usageBillId?: string;
143
- usageType: USAGE_TYPE;
144
- usage: number;
145
- usagePricePerUnit: number;
146
- usageBilledAmount: number;
147
- status: USAGE_BILLING_STATUS;
148
- billedOn: string;
149
- }
150
- export interface ContactAcquisition {
151
- adminApproved?: boolean;
152
- isEnabled?: boolean;
153
- maxContacts?: number;
154
- maxMonthlyBudget?: number;
155
- totalUsage?: number;
156
- usage75?: number;
157
- usage90?: number;
158
- lastMonthUsage?: number;
159
- currentMonthUsage?: number;
160
- lastMonthUsageRatio?: number;
161
- currentMonthUsageRatio?: number;
162
- lastThreeMonthsAverageUsage?: number;
163
- lastThreeMonthsAverageUsageExceeded?: boolean;
164
- }
165
- export declare enum USAGE_TYPE {
166
- ORDERS = "orders",
167
- EVENTS = "events"
168
- }
169
- export declare enum USAGE_BILLING_STATUS {
170
- PENDING = "pending",
171
- PAID = "paid",
172
- FAILED = "failed"
173
- }
1
+ export interface Subscription {
2
+ id: string;
3
+ accountId?: string;
4
+ shopifyAppInstallId?: string;
5
+ shopifyDomain?: string;
6
+ stripeCustomerId?: string;
7
+ stripeSubscriptionId?: string;
8
+ stripeCompletedCheckoutSession?: any;
9
+ shopifyChargeId?: string;
10
+ shopifyRecurringAppCharge?: ShopifyRecurringAppCharge;
11
+ subscriptionPlan?: SubscriptionPlan;
12
+ planUsage?: PlanUsage;
13
+ trialDays?: number;
14
+ trialStartedOn?: string;
15
+ trialEndsOn?: string;
16
+ usageBillingRecords?: UsageBillingRecord[];
17
+ status?: SUBSCRIPTION_STATUS;
18
+ cancelledOn?: string;
19
+ paymentStatus?: PAYMENT_STATUS;
20
+ paymentGateway?: PAYMENT_GATEWAY;
21
+ contactAcquisition?: ContactAcquisition;
22
+ currency?: string;
23
+ last12MonthsAOV?: number;
24
+ last12MonthsAOVUsd?: number;
25
+ last12MonthsRevenue?: number;
26
+ last12MonthsRevenueUsd?: number;
27
+ lastYearRevenue?: number;
28
+ lastYearRevenueUsd?: number;
29
+ createdAt: string;
30
+ updatedAt: string;
31
+ }
32
+ export interface SubscriptionPlan {
33
+ id: string;
34
+ planName: string;
35
+ displayName: string;
36
+ description: string;
37
+ sku: string;
38
+ price: number;
39
+ discountedPrice?: number;
40
+ displayPrice: string;
41
+ discountedDisplayPrice?: string;
42
+ billingFrequency: PLAN_BILLING_FREQUENCY;
43
+ trialLengthDays?: number;
44
+ trialRequiresCreditCard?: boolean;
45
+ enableUsage: boolean;
46
+ orderUsageLimit?: number;
47
+ pricePerOrderAfterUsageLimit?: number;
48
+ usageCappedAmount?: number;
49
+ planDesc?: string[];
50
+ unitPriceText?: string;
51
+ isHighlighted?: boolean;
52
+ isBanner?: boolean;
53
+ bannerText?: string;
54
+ bannerColor?: string;
55
+ stripePriceId?: string;
56
+ stripeProductId?: string;
57
+ isActive: boolean;
58
+ isPublic: boolean;
59
+ isDiscountable: boolean;
60
+ discountId?: string;
61
+ discount?: Discount;
62
+ createdAt?: string;
63
+ updatedAt?: string;
64
+ }
65
+ export interface Discount {
66
+ id: string;
67
+ code: string;
68
+ isActive: boolean;
69
+ applicableBillingFrequency: PLAN_BILLING_FREQUENCY;
70
+ billingIntervalDurationLimit?: number;
71
+ discountType: DiscountType;
72
+ discountValue: number;
73
+ activeUntil?: string;
74
+ createdAt?: string;
75
+ updatedAt?: string;
76
+ }
77
+ export declare enum DiscountType {
78
+ FIXED = "fixed",
79
+ PERCENTAGE = "percentage"
80
+ }
81
+ export interface PlanUsage {
82
+ usage75?: boolean;
83
+ usage90?: boolean;
84
+ currentMonthUsage?: number;
85
+ usageExceeded?: boolean;
86
+ lastMonthUsage?: number;
87
+ lastThreeMonthsUsage?: number;
88
+ lastMonthUsageRatio?: number;
89
+ currentMonthUsageRatio?: number;
90
+ lastThreeMonthUsageRatio?: number;
91
+ lastThreeMonthsUsageExceeded?: boolean;
92
+ last12MonthsGMV?: number;
93
+ last12MonthsAOV?: number;
94
+ currency?: string;
95
+ }
96
+ export declare enum PLAN_BILLING_FREQUENCY {
97
+ MONTHLY = "monthly",
98
+ YEARLY = "yearly"
99
+ }
100
+ export declare enum PAYMENT_STATUS {
101
+ CURRENT = "current",
102
+ PAST_DUE = "past_due",
103
+ CANCELLED = "cancelled",
104
+ FAILED = "failed"
105
+ }
106
+ export declare enum SUBSCRIPTION_STATUS {
107
+ ACTIVE = "active",
108
+ CANCELLED = "cancelled",
109
+ DECLINED = "declined",
110
+ EXPIRED = "expired",
111
+ FROZEN = "frozen",
112
+ PENDING = "pending",
113
+ NOT_SUBMITTED = "na"
114
+ }
115
+ export declare enum PAYMENT_GATEWAY {
116
+ STRIPE = "stripe",
117
+ PAYPAL = "paypal",
118
+ SHOPIFY = "shopify"
119
+ }
120
+ export declare type ShopifyRecurringAppChargeStatus = 'accepted' | 'active' | 'cancelled' | 'declined' | 'expired' | 'frozen' | 'pending';
121
+ export interface ShopifyRecurringAppCharge {
122
+ activated_on: string | null;
123
+ billing_on: string | null;
124
+ cancelled_on: string | null;
125
+ capped_amount: number;
126
+ confirmation_url: string;
127
+ created_at: string;
128
+ id: number;
129
+ name: string;
130
+ price: string;
131
+ return_url: string;
132
+ status: ShopifyRecurringAppChargeStatus;
133
+ terms: string;
134
+ test: boolean | null;
135
+ trial_days: number;
136
+ trial_ends_on: string;
137
+ updated_at: string;
138
+ }
139
+ export interface UsageBillingRecord {
140
+ billingPeriodStart: string;
141
+ billingPeriodEnd: string;
142
+ totalUsage: number;
143
+ totalUsageBilledAmount: number;
144
+ usageBills?: UsageBill[];
145
+ createdAt: string;
146
+ updatedAt: string;
147
+ }
148
+ export interface UsageBill {
149
+ usageBillId?: string;
150
+ usageType: USAGE_TYPE;
151
+ usage: number;
152
+ usagePricePerUnit: number;
153
+ usageBilledAmount: number;
154
+ status: USAGE_BILLING_STATUS;
155
+ billedOn: string;
156
+ }
157
+ export interface ContactAcquisition {
158
+ adminApproved?: boolean;
159
+ isEnabled?: boolean;
160
+ maxContacts?: number;
161
+ maxMonthlyBudget?: number;
162
+ totalUsage?: number;
163
+ usage75?: number;
164
+ usage90?: number;
165
+ lastMonthUsage?: number;
166
+ currentMonthUsage?: number;
167
+ lastMonthUsageRatio?: number;
168
+ currentMonthUsageRatio?: number;
169
+ lastThreeMonthsAverageUsage?: number;
170
+ lastThreeMonthsAverageUsageExceeded?: boolean;
171
+ }
172
+ export declare enum USAGE_TYPE {
173
+ ORDERS = "orders",
174
+ EVENTS = "events"
175
+ }
176
+ export declare enum USAGE_BILLING_STATUS {
177
+ PENDING = "pending",
178
+ PAID = "paid",
179
+ FAILED = "failed"
180
+ }
@@ -1,45 +1,45 @@
1
- export var DiscountType;
2
- (function (DiscountType) {
3
- DiscountType["FIXED"] = "fixed";
4
- DiscountType["PERCENTAGE"] = "percentage";
5
- })(DiscountType || (DiscountType = {}));
6
- export var PLAN_BILLING_FREQUENCY;
7
- (function (PLAN_BILLING_FREQUENCY) {
8
- PLAN_BILLING_FREQUENCY["MONTHLY"] = "monthly";
9
- PLAN_BILLING_FREQUENCY["YEARLY"] = "yearly";
10
- })(PLAN_BILLING_FREQUENCY || (PLAN_BILLING_FREQUENCY = {}));
11
- export var PAYMENT_STATUS;
12
- (function (PAYMENT_STATUS) {
13
- PAYMENT_STATUS["CURRENT"] = "current";
14
- PAYMENT_STATUS["PAST_DUE"] = "past_due";
15
- PAYMENT_STATUS["CANCELLED"] = "cancelled";
16
- PAYMENT_STATUS["FAILED"] = "failed";
17
- })(PAYMENT_STATUS || (PAYMENT_STATUS = {}));
18
- export var SUBSCRIPTION_STATUS;
19
- (function (SUBSCRIPTION_STATUS) {
20
- SUBSCRIPTION_STATUS["ACTIVE"] = "active";
21
- SUBSCRIPTION_STATUS["CANCELLED"] = "cancelled";
22
- SUBSCRIPTION_STATUS["DECLINED"] = "declined";
23
- SUBSCRIPTION_STATUS["EXPIRED"] = "expired";
24
- SUBSCRIPTION_STATUS["FROZEN"] = "frozen";
25
- SUBSCRIPTION_STATUS["PENDING"] = "pending";
26
- SUBSCRIPTION_STATUS["NOT_SUBMITTED"] = "na";
27
- })(SUBSCRIPTION_STATUS || (SUBSCRIPTION_STATUS = {}));
28
- export var PAYMENT_GATEWAY;
29
- (function (PAYMENT_GATEWAY) {
30
- PAYMENT_GATEWAY["STRIPE"] = "stripe";
31
- PAYMENT_GATEWAY["PAYPAL"] = "paypal";
32
- PAYMENT_GATEWAY["SHOPIFY"] = "shopify";
33
- })(PAYMENT_GATEWAY || (PAYMENT_GATEWAY = {}));
34
- export var USAGE_TYPE;
35
- (function (USAGE_TYPE) {
36
- USAGE_TYPE["ORDERS"] = "orders";
37
- USAGE_TYPE["EVENTS"] = "events";
38
- })(USAGE_TYPE || (USAGE_TYPE = {}));
39
- export var USAGE_BILLING_STATUS;
40
- (function (USAGE_BILLING_STATUS) {
41
- USAGE_BILLING_STATUS["PENDING"] = "pending";
42
- USAGE_BILLING_STATUS["PAID"] = "paid";
43
- USAGE_BILLING_STATUS["FAILED"] = "failed";
44
- })(USAGE_BILLING_STATUS || (USAGE_BILLING_STATUS = {}));
1
+ export var DiscountType;
2
+ (function (DiscountType) {
3
+ DiscountType["FIXED"] = "fixed";
4
+ DiscountType["PERCENTAGE"] = "percentage";
5
+ })(DiscountType || (DiscountType = {}));
6
+ export var PLAN_BILLING_FREQUENCY;
7
+ (function (PLAN_BILLING_FREQUENCY) {
8
+ PLAN_BILLING_FREQUENCY["MONTHLY"] = "monthly";
9
+ PLAN_BILLING_FREQUENCY["YEARLY"] = "yearly";
10
+ })(PLAN_BILLING_FREQUENCY || (PLAN_BILLING_FREQUENCY = {}));
11
+ export var PAYMENT_STATUS;
12
+ (function (PAYMENT_STATUS) {
13
+ PAYMENT_STATUS["CURRENT"] = "current";
14
+ PAYMENT_STATUS["PAST_DUE"] = "past_due";
15
+ PAYMENT_STATUS["CANCELLED"] = "cancelled";
16
+ PAYMENT_STATUS["FAILED"] = "failed";
17
+ })(PAYMENT_STATUS || (PAYMENT_STATUS = {}));
18
+ export var SUBSCRIPTION_STATUS;
19
+ (function (SUBSCRIPTION_STATUS) {
20
+ SUBSCRIPTION_STATUS["ACTIVE"] = "active";
21
+ SUBSCRIPTION_STATUS["CANCELLED"] = "cancelled";
22
+ SUBSCRIPTION_STATUS["DECLINED"] = "declined";
23
+ SUBSCRIPTION_STATUS["EXPIRED"] = "expired";
24
+ SUBSCRIPTION_STATUS["FROZEN"] = "frozen";
25
+ SUBSCRIPTION_STATUS["PENDING"] = "pending";
26
+ SUBSCRIPTION_STATUS["NOT_SUBMITTED"] = "na";
27
+ })(SUBSCRIPTION_STATUS || (SUBSCRIPTION_STATUS = {}));
28
+ export var PAYMENT_GATEWAY;
29
+ (function (PAYMENT_GATEWAY) {
30
+ PAYMENT_GATEWAY["STRIPE"] = "stripe";
31
+ PAYMENT_GATEWAY["PAYPAL"] = "paypal";
32
+ PAYMENT_GATEWAY["SHOPIFY"] = "shopify";
33
+ })(PAYMENT_GATEWAY || (PAYMENT_GATEWAY = {}));
34
+ export var USAGE_TYPE;
35
+ (function (USAGE_TYPE) {
36
+ USAGE_TYPE["ORDERS"] = "orders";
37
+ USAGE_TYPE["EVENTS"] = "events";
38
+ })(USAGE_TYPE || (USAGE_TYPE = {}));
39
+ export var USAGE_BILLING_STATUS;
40
+ (function (USAGE_BILLING_STATUS) {
41
+ USAGE_BILLING_STATUS["PENDING"] = "pending";
42
+ USAGE_BILLING_STATUS["PAID"] = "paid";
43
+ USAGE_BILLING_STATUS["FAILED"] = "failed";
44
+ })(USAGE_BILLING_STATUS || (USAGE_BILLING_STATUS = {}));
45
45
  //# sourceMappingURL=subscription.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../../../src/types/api/subscription.ts"],"names":[],"mappings":"AAyEA,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,yCAAyB,CAAA;AAC3B,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAkBD,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,2CAAiB,CAAA;AACnB,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC;AAED,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAED,MAAM,CAAN,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,8CAAuB,CAAA;IACvB,4CAAqB,CAAA;IACrB,0CAAmB,CAAA;IACnB,wCAAiB,CAAA;IACjB,0CAAmB,CAAA;IACnB,2CAAoB,CAAA;AACtB,CAAC,EARW,mBAAmB,KAAnB,mBAAmB,QAQ9B;AAED,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B;AAkED,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;AACnB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,qCAAa,CAAA;IACb,yCAAiB,CAAA;AACnB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B"}
1
+ {"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../../../src/types/api/subscription.ts"],"names":[],"mappings":"AAgFA,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,yCAAyB,CAAA;AAC3B,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAmBD,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,2CAAiB,CAAA;AACnB,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC;AAED,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAED,MAAM,CAAN,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,wCAAiB,CAAA;IACjB,8CAAuB,CAAA;IACvB,4CAAqB,CAAA;IACrB,0CAAmB,CAAA;IACnB,wCAAiB,CAAA;IACjB,0CAAmB,CAAA;IACnB,2CAAoB,CAAA;AACtB,CAAC,EARW,mBAAmB,KAAnB,mBAAmB,QAQ9B;AAED,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B;AAkED,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;AACnB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,qCAAa,CAAA;IACb,yCAAiB,CAAA;AACnB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B"}
@@ -1,15 +1,15 @@
1
- import { TrackingEvent } from '../event/tracking-event.js';
2
- export interface TrackingEventRecord {
3
- eventId: string;
4
- eventName: string;
5
- trackingEvent?: TrackingEvent;
6
- trackingEventCompressed?: string;
7
- pixelId: string;
8
- pixelIdEventName: string;
9
- ipAddressUserAgent: string;
10
- hostname: string;
11
- identityId: string;
12
- sessionId: string;
13
- collectedAt: string;
14
- expiredAt: number;
15
- }
1
+ import { TrackingEvent } from '../event/tracking-event.js';
2
+ export interface TrackingEventRecord {
3
+ eventId: string;
4
+ eventName: string;
5
+ trackingEvent?: TrackingEvent;
6
+ trackingEventCompressed?: string;
7
+ pixelId: string;
8
+ pixelIdEventName: string;
9
+ ipAddressUserAgent: string;
10
+ hostname: string;
11
+ identityId: string;
12
+ sessionId: string;
13
+ collectedAt: string;
14
+ expiredAt: number;
15
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=tracking-events.js.map
@@ -1,22 +1,22 @@
1
- export declare enum USER_ROLES {
2
- OWNER = "owner",
3
- ADMIN = "admin",
4
- MEMBER = "member"
5
- }
6
- export declare enum USER_ACCOUNT_STATUS {
7
- PENDING = "pending",
8
- ACTIVE = "active",
9
- INACTIVE = "inactive"
10
- }
11
- export interface UserAccountRecord {
12
- accountId: string;
13
- accountName: string;
14
- userId: string;
15
- email: string;
16
- role: USER_ROLES;
17
- status: USER_ACCOUNT_STATUS;
18
- createdAt?: string;
19
- createdBy?: string;
20
- updatedAt?: string;
21
- updatedBy?: string;
22
- }
1
+ export declare enum USER_ROLES {
2
+ OWNER = "owner",
3
+ ADMIN = "admin",
4
+ MEMBER = "member"
5
+ }
6
+ export declare enum USER_ACCOUNT_STATUS {
7
+ PENDING = "pending",
8
+ ACTIVE = "active",
9
+ INACTIVE = "inactive"
10
+ }
11
+ export interface UserAccountRecord {
12
+ accountId: string;
13
+ accountName: string;
14
+ userId: string;
15
+ email: string;
16
+ role: USER_ROLES;
17
+ status: USER_ACCOUNT_STATUS;
18
+ createdAt?: string;
19
+ createdBy?: string;
20
+ updatedAt?: string;
21
+ updatedBy?: string;
22
+ }
@@ -1,13 +1,13 @@
1
- export var USER_ROLES;
2
- (function (USER_ROLES) {
3
- USER_ROLES["OWNER"] = "owner";
4
- USER_ROLES["ADMIN"] = "admin";
5
- USER_ROLES["MEMBER"] = "member";
6
- })(USER_ROLES || (USER_ROLES = {}));
7
- export var USER_ACCOUNT_STATUS;
8
- (function (USER_ACCOUNT_STATUS) {
9
- USER_ACCOUNT_STATUS["PENDING"] = "pending";
10
- USER_ACCOUNT_STATUS["ACTIVE"] = "active";
11
- USER_ACCOUNT_STATUS["INACTIVE"] = "inactive";
12
- })(USER_ACCOUNT_STATUS || (USER_ACCOUNT_STATUS = {}));
1
+ export var USER_ROLES;
2
+ (function (USER_ROLES) {
3
+ USER_ROLES["OWNER"] = "owner";
4
+ USER_ROLES["ADMIN"] = "admin";
5
+ USER_ROLES["MEMBER"] = "member";
6
+ })(USER_ROLES || (USER_ROLES = {}));
7
+ export var USER_ACCOUNT_STATUS;
8
+ (function (USER_ACCOUNT_STATUS) {
9
+ USER_ACCOUNT_STATUS["PENDING"] = "pending";
10
+ USER_ACCOUNT_STATUS["ACTIVE"] = "active";
11
+ USER_ACCOUNT_STATUS["INACTIVE"] = "inactive";
12
+ })(USER_ACCOUNT_STATUS || (USER_ACCOUNT_STATUS = {}));
13
13
  //# sourceMappingURL=user-account.js.map
@@ -1,13 +1,13 @@
1
- export interface User {
2
- id: string;
3
- sub: string;
4
- userId: string;
5
- Username: string;
6
- UserLastModifiedDate: string;
7
- Enabled: boolean;
8
- UserStatus: string;
9
- email: string;
10
- email_verified: string;
11
- name: string;
12
- family_name: string;
13
- }
1
+ export interface User {
2
+ id: string;
3
+ sub: string;
4
+ userId: string;
5
+ Username: string;
6
+ UserLastModifiedDate: string;
7
+ Enabled: boolean;
8
+ UserStatus: string;
9
+ email: string;
10
+ email_verified: string;
11
+ name: string;
12
+ family_name: string;
13
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=user.js.map
@@ -1,15 +1,15 @@
1
- export interface AddressInfo {
2
- email?: string;
3
- phone?: string;
4
- firstName?: string;
5
- lastName?: string;
6
- company?: string;
7
- address1?: string;
8
- address2?: string;
9
- city?: string;
10
- province?: string;
11
- provinceCode?: string;
12
- country?: string;
13
- countryCode?: string;
14
- zip?: string;
15
- }
1
+ export interface AddressInfo {
2
+ email?: string;
3
+ phone?: string;
4
+ firstName?: string;
5
+ lastName?: string;
6
+ company?: string;
7
+ address1?: string;
8
+ address2?: string;
9
+ city?: string;
10
+ province?: string;
11
+ provinceCode?: string;
12
+ country?: string;
13
+ countryCode?: string;
14
+ zip?: string;
15
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=address.js.map
@@ -1 +1 @@
1
- export declare const Currencies: string[];
1
+ export declare const Currencies: string[];