-
Notifications
You must be signed in to change notification settings - Fork 4
/
local.d.ts
145 lines (115 loc) · 3.52 KB
/
local.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
declare type ActionType = string;
interface IProduct {
itemCode?: string;
itemPrice?: number | string;
itemUrl?: string;
itemQuantity?: number | string;
itemTotalPrice?: number | string;
itemImage?: string;
itemName?: string;
[key: string]: any;
}
interface IdentifyAPI {
identify(email: string, name?: string, props?: any|any[]): void;
}
interface TrackingAPI {
setCookieNames(cookieNames: ICookieNames): void;
init(siteId: string, exitIntentFlag: boolean, staging?: boolean): void;
/**
* Send action track info
* @description Makes a POST to http://requestb.in/15t3ics1
*/
track(action: ActionType, props?: any|any[]): void;
/**
* Sends current page info
*/
trackPageView(url?: string): void;
trackExitIntent(secondsOnPage?: number, url?: string): void;
trackAddToOrder(itemCode: string, itemPrice: number, itemUrl: string, itemQuantity: number, itemTotal?: number, itemName?: string, itemImage?: string, props?: Object): void;
trackOrderCompleted(products: Array<Object>, totalPrice?: number): void;
}
interface PayloadAPI {
formatProductPayload(product: IProduct): IProduct;
getPayload(action: ActionType, props?: any): ITrackPayload | ITrackPageViewPayload | ITrackIdentifyPayload;
}
interface ITrackPayload {
ContactEmailAddress?: string;
CampaignId?: string;
MemberId?: string;
ContactId: string;
siteId: string;
actionType: string;
properties?: any;
Url?: string;
sessionId: string;
}
interface ITrackPageViewPayload extends ITrackPayload {
Url: string;
}
interface ITrackExitIntentPayload extends ITrackPayload {
Url: string;
SecondsOnPage: number;
}
interface ITrackIdentifyPayload extends ITrackPayload {
ContactName?: string;
}
interface ITrackerAgent {
sendTrack(payload: ITrackPayload): void;
sendIdentify(payload: ITrackIdentifyPayload): void;
}
/**
* Tracker specific storage API
*/
interface ITrackerStorage {
setCookieNames(cookieNames: ICookieProperties): void;
getUserId(): string;
setUserId(value: string, options?: any): void;
getCampaignId(): string;
setCampaignId(value: string): void;
getMemberId(): string;
setMemberId(value: string): void;
getEmail(): string;
setEmail(value: string): void;
getSessionId(): string;
setSessionId(value: string, options?: any): void;
getExitIntentFlag(): boolean;
setExitIntentFlag(value: boolean): void;
getCurrentPageUrl(): string;
}
/**
* Plain Key/Value storage APi
*/
interface IStorage {
getItem(key: any): any;
setItem(key: any, value: any, options?: any): void;
removeItem(key: string): void;
}
interface ICookieProperties {
userIdName: string;
sessionIdName: string;
emailName: string;
exitIntentFlagName: string;
campaignIdName: string;
memberIdName: string;
}
interface ICookieNames extends ICookieProperties {
getUserIdName(): string;
setUserIdName(userIdName: string): void;
getSessionIdName(): string;
setSessionIdName(sessionIdName: string): void;
getExitIntentFlagName(): string;
setExitIntentFlagName(exitIntentFlagName: string): void;
getCampaignIdName(): string;
setCampaignIdName(campaignIdName: string): void;
getMemberIdName(): string;
setMemberIdName(memberIdName: string): void;
}
interface Window { XDomainRequest: any; XMLHttpRequest: any;
}
/**
* Declare globals
*/
declare var _ENV_: string;
declare var API_URL: string;
declare var window: Window;
declare var XDomainRequest: any;