analytics-js/index.d.ts at master · findify/analytics-js · GitHub

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
declare module "findify-analytics" {
  type User = {
    uid: string,
    sid: string,
  };
  type Config = {
    key: string,
  };

  type LineItemData = {
    item_id: string,
    unit_price: number,
    quantity: number,
  };

  type ClickSuggestionEventRequest = {
    rid: string,
    suggestion: string,
  };
  type ClickItemEventRequest = {
    item_id: string,
    rid?: string,
  };
  type RedirectEventRequest = {
    rid: string,
    suggestion: string,
  };
  type PurchaseEventRequest = {
    order_id: string,
    currency: string,
    revenue: number,
    affiliation?: string,
    line_items: LineItemData[],
  };
  type UpdateCartEventRequest = {
    line_items: LineItemData[],
  };
  type AddToCartEventRequest = {
    item_id: string,
    rid?: string,
    quantity?: number,
  };
  type ViewPageEventRequest = {
    url: string,
    ref: string,
    width: number,
    height: number,
    item_id?: string,
  };

  type Client = {
    getUser(): User,
    sendEvent(type: 'click-suggestion', request: ClickSuggestionEventRequest),
    sendEvent(type: 'click-item', request: ClickItemEventRequest),
    sendEvent(type: 'redirect', request: RedirectEventRequest),
    sendEvent(type: 'purchase', request: PurchaseEventRequest),
    sendEvent(type: 'add-to-cart', request: AddToCartEventRequest),
    sendEevnt(type: 'update-cart', request: UpdateCartEventRequest),
    sendEvent(type: 'view-page', request?: ViewPageEventRequest),
  };

  function(config: Config): Client;
}