@adtrackify/at-tracking-event-types 1.0.20 → 1.0.22

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.
@@ -0,0 +1,15 @@
1
+ export interface Account {
2
+ id: string;
3
+ accountName: string;
4
+ companyName?: string;
5
+ accountStatus: ACCOUNT_STATUS;
6
+ primaryEmail: string;
7
+ publicApiKey?: string;
8
+ subscriptionId?: string;
9
+ ownerId?: string;
10
+ createdAt: string;
11
+ updatedAt: string;
12
+ }
13
+ export declare enum ACCOUNT_STATUS {
14
+ PENDING = "pending"
15
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ACCOUNT_STATUS = void 0;
4
+ var ACCOUNT_STATUS;
5
+ (function (ACCOUNT_STATUS) {
6
+ ACCOUNT_STATUS["PENDING"] = "pending";
7
+ })(ACCOUNT_STATUS = exports.ACCOUNT_STATUS || (exports.ACCOUNT_STATUS = {}));
8
+ //# sourceMappingURL=account.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"account.js","sourceRoot":"","sources":["../../../src/types/api/account.ts"],"names":[],"mappings":";;;AAaA,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,qCAAmB,CAAA;AACrB,CAAC,EAFW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAEzB"}
@@ -1,22 +1,38 @@
1
- export interface AdTrackifyDestination {
1
+ export interface Destination {
2
2
  id: string;
3
3
  accountId: string;
4
4
  pixelId: string;
5
5
  destination: string;
6
- displayName: string;
7
- configuration?: any;
6
+ displayName?: string;
8
7
  enabled: boolean;
8
+ configuration?: any;
9
+ createdAt: string;
10
+ updatedAt: string;
11
+ }
12
+ export interface DestinationCatalogItem {
13
+ id: string;
14
+ active: boolean;
15
+ destinationKey: string;
16
+ destinationType: string;
17
+ displayName?: string;
18
+ shortName?: string;
19
+ description?: string;
20
+ url: string;
21
+ fields?: any;
22
+ createdAt: string;
23
+ updatedAt: string;
9
24
  }
10
- export interface AdTrackifyFacebookDestination extends AdTrackifyDestination {
11
- configuration: {
12
- apiAccessToken: string;
13
- enableConversionAPI: boolean;
14
- pixelId: string;
15
- };
25
+ export interface DestinationCatalogFields {
26
+ component_type: string;
27
+ name: string;
28
+ description: string;
29
+ label: string;
30
+ type: string;
31
+ required: boolean;
32
+ order: number;
16
33
  }
17
- export declare enum ADTRACKIFY_DESTINATIONS {
18
- FACEBOOK = "facebook",
19
- GOOGLE_ANALYTICS_4 = "googleAnalytics4"
34
+ export interface AdTrackifyFacebookDestination extends Destination {
35
+ configuration: FacebookPixelConfiguration;
20
36
  }
21
37
  export interface FacebookPixelConfiguration {
22
38
  apiAccessToken?: string;
@@ -1,9 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ADTRACKIFY_DESTINATIONS = void 0;
4
- var ADTRACKIFY_DESTINATIONS;
5
- (function (ADTRACKIFY_DESTINATIONS) {
6
- ADTRACKIFY_DESTINATIONS["FACEBOOK"] = "facebook";
7
- ADTRACKIFY_DESTINATIONS["GOOGLE_ANALYTICS_4"] = "googleAnalytics4";
8
- })(ADTRACKIFY_DESTINATIONS = exports.ADTRACKIFY_DESTINATIONS || (exports.ADTRACKIFY_DESTINATIONS = {}));
9
3
  //# sourceMappingURL=destination.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"destination.js","sourceRoot":"","sources":["../../../src/types/api/destination.ts"],"names":[],"mappings":";;;AAmBA,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,gDAAqB,CAAA;IACrB,kEAAuC,CAAA;AACzC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC"}
1
+ {"version":3,"file":"destination.js","sourceRoot":"","sources":["../../../src/types/api/destination.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ export declare enum DESTINATIONS {
2
+ FACEBOOK = "facebook",
3
+ TIKTOK = "tiktok",
4
+ GOOGLE_ADS = "googleAds",
5
+ GOOGLE_ANALYTICS_4 = "googleAnalytics4"
6
+ }
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DESTINATIONS = void 0;
4
+ var DESTINATIONS;
5
+ (function (DESTINATIONS) {
6
+ DESTINATIONS["FACEBOOK"] = "facebook";
7
+ DESTINATIONS["TIKTOK"] = "tiktok";
8
+ DESTINATIONS["GOOGLE_ADS"] = "googleAds";
9
+ DESTINATIONS["GOOGLE_ANALYTICS_4"] = "googleAnalytics4";
10
+ })(DESTINATIONS = exports.DESTINATIONS || (exports.DESTINATIONS = {}));
11
+ //# sourceMappingURL=destinations.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"destinations.js","sourceRoot":"","sources":["../../../src/types/api/destinations.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,wCAAwB,CAAA;IACxB,uDAAuC,CAAA;AACzC,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB"}
@@ -1 +1,6 @@
1
+ export * from './account';
1
2
  export * from './destination';
3
+ export * from './destinations';
4
+ export * from './shopify-app-install';
5
+ export * from './subscription';
6
+ export * from './user';
@@ -14,5 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./account"), exports);
17
18
  __exportStar(require("./destination"), exports);
19
+ __exportStar(require("./destinations"), exports);
20
+ __exportStar(require("./shopify-app-install"), exports);
21
+ __exportStar(require("./subscription"), exports);
22
+ __exportStar(require("./user"), exports);
18
23
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,gDAA8B;AAC9B,iDAA+B;AAC/B,wDAAsC;AACtC,iDAA+B;AAC/B,yCAAuB"}
@@ -0,0 +1,46 @@
1
+ export interface ShopifyAppInstall {
2
+ shopifyAppInstallId: string;
3
+ shop: string;
4
+ accessToken?: string;
5
+ appStatus?: string;
6
+ appSubscriptionStatus?: ShopifyAppSubscriptionStatus;
7
+ code?: string;
8
+ hmac?: string;
9
+ host?: string;
10
+ installRequest?: ShopifyInstallRequest;
11
+ isAppEnabled?: boolean;
12
+ pixelId?: string;
13
+ shopInfo?: any;
14
+ state?: string;
15
+ timestamp?: number;
16
+ createdAt: string;
17
+ updatedAt: string;
18
+ }
19
+ export declare enum ShopifyAppInstallStatus {
20
+ STARTED = "started",
21
+ COMPLETED = "completed",
22
+ UNINSTALLED = "uninstalled",
23
+ FAILED = "failed",
24
+ NONE = "none"
25
+ }
26
+ export declare enum ShopifyAppSubscriptionStatus {
27
+ ACTIVE = "active",
28
+ CANCELLED = "cancelled",
29
+ DECLINED = "declined",
30
+ EXPIRED = "expired",
31
+ FROZEN = "frozen",
32
+ PENDING = "pending",
33
+ NOT_SUBMITTED = "na"
34
+ }
35
+ export interface ShopifyInstallRequest {
36
+ shop: string;
37
+ session: string;
38
+ hmac: string;
39
+ host: string;
40
+ nonce: string;
41
+ timestamp: string;
42
+ status: string;
43
+ }
44
+ export interface ShopifyStoreInfo {
45
+ [key: string]: any;
46
+ }
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ShopifyAppSubscriptionStatus = exports.ShopifyAppInstallStatus = void 0;
4
+ var ShopifyAppInstallStatus;
5
+ (function (ShopifyAppInstallStatus) {
6
+ ShopifyAppInstallStatus["STARTED"] = "started";
7
+ ShopifyAppInstallStatus["COMPLETED"] = "completed";
8
+ ShopifyAppInstallStatus["UNINSTALLED"] = "uninstalled";
9
+ ShopifyAppInstallStatus["FAILED"] = "failed";
10
+ ShopifyAppInstallStatus["NONE"] = "none";
11
+ })(ShopifyAppInstallStatus = exports.ShopifyAppInstallStatus || (exports.ShopifyAppInstallStatus = {}));
12
+ var ShopifyAppSubscriptionStatus;
13
+ (function (ShopifyAppSubscriptionStatus) {
14
+ ShopifyAppSubscriptionStatus["ACTIVE"] = "active";
15
+ ShopifyAppSubscriptionStatus["CANCELLED"] = "cancelled";
16
+ ShopifyAppSubscriptionStatus["DECLINED"] = "declined";
17
+ ShopifyAppSubscriptionStatus["EXPIRED"] = "expired";
18
+ ShopifyAppSubscriptionStatus["FROZEN"] = "frozen";
19
+ ShopifyAppSubscriptionStatus["PENDING"] = "pending";
20
+ ShopifyAppSubscriptionStatus["NOT_SUBMITTED"] = "na";
21
+ })(ShopifyAppSubscriptionStatus = exports.ShopifyAppSubscriptionStatus || (exports.ShopifyAppSubscriptionStatus = {}));
22
+ //# sourceMappingURL=shopify-app-install.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shopify-app-install.js","sourceRoot":"","sources":["../../../src/types/api/shopify-app-install.ts"],"names":[],"mappings":";;;AAmBA,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,kDAAuB,CAAA;IACvB,sDAA2B,CAAA;IAC3B,4CAAiB,CAAA;IACjB,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAMlC;AACD,IAAY,4BAQX;AARD,WAAY,4BAA4B;IACtC,iDAAiB,CAAA;IACjB,uDAAuB,CAAA;IACvB,qDAAqB,CAAA;IACrB,mDAAmB,CAAA;IACnB,iDAAiB,CAAA;IACjB,mDAAmB,CAAA;IACnB,oDAAoB,CAAA;AACtB,CAAC,EARW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAQvC"}
@@ -0,0 +1,17 @@
1
+ export interface Subscription {
2
+ id: string;
3
+ accountId?: string;
4
+ shopifyAppInstallId?: string;
5
+ shopifyDomain?: string;
6
+ stripeCustomerId?: string;
7
+ stripeSubscriptionId?: string;
8
+ subscriptionPlan: any;
9
+ paymentGateway: PAYMENT_GATEWAY;
10
+ createdAt: string;
11
+ updatedAt: string;
12
+ }
13
+ export declare enum PAYMENT_GATEWAY {
14
+ STRIPE = "stripe",
15
+ PAYPAL = "paypal",
16
+ SHOPIFY = "shopify"
17
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PAYMENT_GATEWAY = void 0;
4
+ var PAYMENT_GATEWAY;
5
+ (function (PAYMENT_GATEWAY) {
6
+ PAYMENT_GATEWAY["STRIPE"] = "stripe";
7
+ PAYMENT_GATEWAY["PAYPAL"] = "paypal";
8
+ PAYMENT_GATEWAY["SHOPIFY"] = "shopify";
9
+ })(PAYMENT_GATEWAY = exports.PAYMENT_GATEWAY || (exports.PAYMENT_GATEWAY = {}));
10
+ //# sourceMappingURL=subscription.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../../src/types/api/subscription.ts"],"names":[],"mappings":";;;AAcA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}
@@ -0,0 +1,11 @@
1
+ export interface User {
2
+ sub: string;
3
+ Username: string;
4
+ UserLastModifiedDate: string;
5
+ Enabled: boolean;
6
+ UserStatus: string;
7
+ email: string;
8
+ email_verified: string;
9
+ name: string;
10
+ family_name: string;
11
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=user.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/types/api/user.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adtrackify/at-tracking-event-types",
3
- "version": "1.0.20",
3
+ "version": "1.0.22",
4
4
  "description": "",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -72,4 +72,4 @@
72
72
  "author": "",
73
73
  "license": "ISC",
74
74
  "homepage": "https://bitbucket.org/eacap/at-tracking-event-types#readme"
75
- }
75
+ }
package/src/index.ts CHANGED
@@ -1 +1 @@
1
- export * from './types';
1
+ export * from './types';
@@ -0,0 +1,16 @@
1
+ export interface Account {
2
+ id: string,
3
+ accountName: string,
4
+ companyName?: string,
5
+ accountStatus: ACCOUNT_STATUS,
6
+ primaryEmail: string,
7
+ publicApiKey?: string,
8
+ subscriptionId?: string,
9
+ ownerId?: string,
10
+ createdAt: string,
11
+ updatedAt: string;
12
+ }
13
+
14
+ export enum ACCOUNT_STATUS {
15
+ PENDING = 'pending'
16
+ }
@@ -1,33 +1,47 @@
1
- export interface AdTrackifyDestination {
2
- id: string;
3
- accountId: string;
4
- pixelId: string;
1
+ export interface Destination {
2
+ id: string,
3
+ accountId: string,
4
+ pixelId: string,
5
5
  destination: string;
6
- displayName: string;
7
- configuration?: any;
6
+ displayName?: string,
8
7
  enabled: boolean;
8
+ configuration?: any,
9
+ createdAt: string,
10
+ updatedAt: string;
9
11
  }
10
12
 
11
-
12
- export interface AdTrackifyFacebookDestination extends AdTrackifyDestination {
13
- configuration: {
14
- apiAccessToken: string;
15
- enableConversionAPI: boolean;
16
- pixelId: string;
17
- };
13
+ export interface DestinationCatalogItem {
14
+ id: string,
15
+ active: boolean,
16
+ destinationKey: string,
17
+ destinationType: string,
18
+ displayName?: string,
19
+ shortName?: string;
20
+ description?: string,
21
+ url: string,
22
+ fields?: any,
23
+ createdAt: string,
24
+ updatedAt: string;
18
25
  }
19
26
 
20
- export enum ADTRACKIFY_DESTINATIONS {
21
- FACEBOOK = 'facebook',
22
- GOOGLE_ANALYTICS_4 = 'googleAnalytics4'
27
+ export interface DestinationCatalogFields {
28
+ component_type: string,
29
+ name: string,
30
+ description: string,
31
+ label: string,
32
+ type: string,
33
+ required: boolean,
34
+ order: number;
23
35
  }
24
36
 
37
+ export interface AdTrackifyFacebookDestination extends Destination {
38
+ configuration: FacebookPixelConfiguration;
39
+ }
25
40
  export interface FacebookPixelConfiguration {
26
41
  apiAccessToken?: string;
27
42
  enableConversionAPI: boolean;
28
43
  pixelId: string;
29
44
  }
30
-
31
45
  export interface GoogleAnalytics4Configuration {
32
46
  measurementId: string;
33
- }
47
+ }
@@ -0,0 +1,6 @@
1
+ export enum DESTINATIONS {
2
+ FACEBOOK = 'facebook',
3
+ TIKTOK = 'tiktok',
4
+ GOOGLE_ADS = 'googleAds',
5
+ GOOGLE_ANALYTICS_4 = 'googleAnalytics4'
6
+ }
@@ -1 +1,6 @@
1
- export * from './destination';
1
+ export * from './account';
2
+ export * from './destination';
3
+ export * from './destinations';
4
+ export * from './shopify-app-install';
5
+ export * from './subscription';
6
+ export * from './user';
@@ -0,0 +1,50 @@
1
+ export interface ShopifyAppInstall {
2
+ shopifyAppInstallId: string;
3
+ shop: string;
4
+ accessToken?: string;
5
+ appStatus?: string;
6
+ appSubscriptionStatus?: ShopifyAppSubscriptionStatus;
7
+ code?: string;
8
+ hmac?: string;
9
+ host?: string;
10
+ installRequest?: ShopifyInstallRequest;
11
+ isAppEnabled?: boolean;
12
+ pixelId?: string;
13
+ shopInfo?: any;
14
+ state?: string;
15
+ timestamp?: number;
16
+ createdAt: string;
17
+ updatedAt: string;
18
+ }
19
+
20
+ export enum ShopifyAppInstallStatus {
21
+ STARTED = 'started',
22
+ COMPLETED = 'completed',
23
+ UNINSTALLED = 'uninstalled',
24
+ FAILED = 'failed',
25
+ NONE = 'none'
26
+ }
27
+ export enum ShopifyAppSubscriptionStatus {
28
+ ACTIVE = 'active', // approved and billed to shop
29
+ CANCELLED = 'cancelled', // cancelled, uninstalled or cancellation
30
+ DECLINED = 'declined', // subscription declined by merchant
31
+ EXPIRED = 'expired', //wasn't approved within two days of being created
32
+ FROZEN = 'frozen', //on hold due to not payment
33
+ PENDING = 'pending', // pending approval
34
+ NOT_SUBMITTED = 'na' // billing has not yet been attempted
35
+ }
36
+
37
+ export interface ShopifyInstallRequest {
38
+ shop: string;
39
+ session: string;
40
+ hmac: string;
41
+ host: string;
42
+ nonce: string;
43
+ timestamp: string;
44
+ status: string;
45
+ }
46
+
47
+ export interface ShopifyStoreInfo {
48
+ // TBD based on shopify api
49
+ [ key: string ]: any;
50
+ }
@@ -0,0 +1,19 @@
1
+ export interface Subscription {
2
+ id: string,
3
+ accountId?: string,
4
+ shopifyAppInstallId?: string,
5
+ shopifyDomain?: string,
6
+ stripeCustomerId?: string,
7
+ stripeSubscriptionId?: string,
8
+ subscriptionPlan: any,
9
+ paymentGateway: PAYMENT_GATEWAY;
10
+ createdAt: string,
11
+ updatedAt: string,
12
+
13
+ }
14
+
15
+ export enum PAYMENT_GATEWAY {
16
+ STRIPE = 'stripe',
17
+ PAYPAL = 'paypal',
18
+ SHOPIFY = 'shopify'
19
+ }
@@ -0,0 +1,12 @@
1
+
2
+ export interface User {
3
+ sub: string,
4
+ Username: string,
5
+ UserLastModifiedDate: string,
6
+ Enabled: boolean,
7
+ UserStatus: string,
8
+ email: string,
9
+ email_verified: string,
10
+ name: string,
11
+ family_name: string,
12
+ }