@clikgate/node 2.0.1 → 2.1.0
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.
- package/CHANGELOG.md +25 -0
- package/README.md +116 -7
- package/SECURITY.md +2 -1
- package/dist/cjs/client.d.ts +38 -10
- package/dist/cjs/client.js +50 -16
- package/dist/cjs/currency.d.ts +7 -0
- package/dist/cjs/currency.js +75 -0
- package/dist/cjs/enums.js +1 -1
- package/dist/cjs/event-types.d.ts +108 -0
- package/dist/cjs/event-types.js +109 -0
- package/dist/cjs/express.d.ts +11 -2
- package/dist/cjs/express.js +3 -2
- package/dist/cjs/fastify.d.ts +4 -1
- package/dist/cjs/fastify.js +3 -2
- package/dist/cjs/generated/index.d.ts +1759 -86
- package/dist/cjs/generated/index.js +1 -1
- package/dist/cjs/identity.js +1 -1
- package/dist/cjs/index.d.ts +9 -1
- package/dist/cjs/index.js +15 -1
- package/dist/cjs/installation.d.ts +47 -0
- package/dist/cjs/installation.js +83 -0
- package/dist/cjs/lookups.d.ts +128 -0
- package/dist/cjs/lookups.js +149 -0
- package/dist/cjs/models.d.ts +342 -0
- package/dist/cjs/models.js +2 -0
- package/dist/cjs/next.d.ts +22 -0
- package/dist/cjs/next.js +20 -0
- package/dist/cjs/pager.d.ts +5 -0
- package/dist/cjs/pager.js +40 -0
- package/dist/cjs/referrals.d.ts +169 -0
- package/dist/cjs/referrals.js +208 -0
- package/dist/cjs/resources.d.ts +34 -5
- package/dist/cjs/resources.js +43 -42
- package/dist/cjs/types.d.ts +57 -10
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/webhooks.d.ts +3 -2
- package/dist/cjs/webhooks.js +43 -2
- package/dist/esm/client.d.ts +38 -10
- package/dist/esm/client.js +50 -16
- package/dist/esm/currency.d.ts +7 -0
- package/dist/esm/currency.js +67 -0
- package/dist/esm/enums.js +1 -1
- package/dist/esm/event-types.d.ts +108 -0
- package/dist/esm/event-types.js +106 -0
- package/dist/esm/express.d.ts +11 -2
- package/dist/esm/express.js +3 -2
- package/dist/esm/fastify.d.ts +4 -1
- package/dist/esm/fastify.js +3 -2
- package/dist/esm/generated/index.d.ts +1759 -86
- package/dist/esm/generated/index.js +1 -1
- package/dist/esm/identity.js +1 -1
- package/dist/esm/index.d.ts +9 -1
- package/dist/esm/index.js +4 -0
- package/dist/esm/installation.d.ts +47 -0
- package/dist/esm/installation.js +77 -0
- package/dist/esm/lookups.d.ts +128 -0
- package/dist/esm/lookups.js +142 -0
- package/dist/esm/models.d.ts +342 -0
- package/dist/esm/models.js +1 -0
- package/dist/esm/next.d.ts +22 -0
- package/dist/esm/next.js +19 -0
- package/dist/esm/pager.d.ts +5 -0
- package/dist/esm/pager.js +36 -0
- package/dist/esm/referrals.d.ts +169 -0
- package/dist/esm/referrals.js +204 -0
- package/dist/esm/resources.d.ts +34 -5
- package/dist/esm/resources.js +43 -42
- package/dist/esm/types.d.ts +57 -10
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/esm/webhooks.d.ts +3 -2
- package/dist/esm/webhooks.js +42 -2
- package/package.json +2 -2
|
@@ -13,6 +13,41 @@ export interface BinaryResponse {
|
|
|
13
13
|
contentType: string;
|
|
14
14
|
data: Uint8Array;
|
|
15
15
|
}
|
|
16
|
+
export interface AbTestLeader {
|
|
17
|
+
'id': string;
|
|
18
|
+
'name': string | null;
|
|
19
|
+
}
|
|
20
|
+
export interface AbTestLikelyWinnerEventData {
|
|
21
|
+
/**
|
|
22
|
+
* Always null for this event type.
|
|
23
|
+
*/
|
|
24
|
+
'previous_attributes': any | null;
|
|
25
|
+
'object': AbTestLikelyWinnerObject;
|
|
26
|
+
}
|
|
27
|
+
export interface AbTestLikelyWinnerObject {
|
|
28
|
+
'object': 'ab_test';
|
|
29
|
+
'id': string;
|
|
30
|
+
'name': string;
|
|
31
|
+
'link': AbTestLinkRef;
|
|
32
|
+
/**
|
|
33
|
+
* The version that is likely better.
|
|
34
|
+
*/
|
|
35
|
+
'leader': AbTestLeader | null;
|
|
36
|
+
'clicks': number;
|
|
37
|
+
'goals': number;
|
|
38
|
+
'detected_at': string;
|
|
39
|
+
/**
|
|
40
|
+
* true for live-environment data, false for test mode.
|
|
41
|
+
*/
|
|
42
|
+
'livemode': boolean;
|
|
43
|
+
}
|
|
44
|
+
export interface AbTestLinkRef {
|
|
45
|
+
'id': string;
|
|
46
|
+
/**
|
|
47
|
+
* The link's title, else its slug.
|
|
48
|
+
*/
|
|
49
|
+
'title': string;
|
|
50
|
+
}
|
|
16
51
|
export interface AcceptSuggestionResponse {
|
|
17
52
|
'object'?: 'goal_suggestion_accepted';
|
|
18
53
|
'applied': 'new_goal' | 'alias';
|
|
@@ -49,7 +84,7 @@ export interface ActivityGroup {
|
|
|
49
84
|
'totals': ActivityMetrics;
|
|
50
85
|
'previous': ActivityMetrics;
|
|
51
86
|
'change_pct': {
|
|
52
|
-
[key: string]:
|
|
87
|
+
[key: string]: ChangePctValue;
|
|
53
88
|
};
|
|
54
89
|
'series': Array<ActivityPoint>;
|
|
55
90
|
}
|
|
@@ -85,7 +120,7 @@ export interface ActivityPoint {
|
|
|
85
120
|
'start': string;
|
|
86
121
|
'end': string;
|
|
87
122
|
'change_pct': {
|
|
88
|
-
[key: string]:
|
|
123
|
+
[key: string]: ChangePctValue;
|
|
89
124
|
};
|
|
90
125
|
}
|
|
91
126
|
export interface AdAccountInfoResponse {
|
|
@@ -845,6 +880,13 @@ export interface AlertConditionSchema {
|
|
|
845
880
|
'baseline'?: AlertBaseline | null;
|
|
846
881
|
'currency'?: string | null;
|
|
847
882
|
}
|
|
883
|
+
export interface AlertEventData {
|
|
884
|
+
/**
|
|
885
|
+
* Always null for this event type.
|
|
886
|
+
*/
|
|
887
|
+
'previous_attributes': any | null;
|
|
888
|
+
'object': AlertInfoResponse;
|
|
889
|
+
}
|
|
848
890
|
export interface AlertInfoResponse {
|
|
849
891
|
'id': string;
|
|
850
892
|
'object'?: 'alert';
|
|
@@ -1103,7 +1145,7 @@ export interface AnalyticsRowResponse {
|
|
|
1103
1145
|
'app_open_label'?: 'estimated' | null;
|
|
1104
1146
|
'in_app_browser_share'?: number | null;
|
|
1105
1147
|
'change_pct'?: {
|
|
1106
|
-
[key: string]:
|
|
1148
|
+
[key: string]: ChangePctValue;
|
|
1107
1149
|
} | null;
|
|
1108
1150
|
'existing_app_users'?: number | null;
|
|
1109
1151
|
'people_without_app'?: number | null;
|
|
@@ -1203,7 +1245,7 @@ export interface AppActivityResponse {
|
|
|
1203
1245
|
'totals': ActivityMetrics;
|
|
1204
1246
|
'previous': ActivityMetrics;
|
|
1205
1247
|
'change_pct': {
|
|
1206
|
-
[key: string]:
|
|
1248
|
+
[key: string]: ChangePctValue;
|
|
1207
1249
|
};
|
|
1208
1250
|
'series': Array<ActivityPoint>;
|
|
1209
1251
|
'groups': Array<ActivityGroup>;
|
|
@@ -1235,6 +1277,13 @@ export interface AppBannerDisplaySchema {
|
|
|
1235
1277
|
'priority'?: number;
|
|
1236
1278
|
'measure_right_screen'?: boolean;
|
|
1237
1279
|
}
|
|
1280
|
+
export interface AppBannerEventData {
|
|
1281
|
+
/**
|
|
1282
|
+
* Always null for this event type.
|
|
1283
|
+
*/
|
|
1284
|
+
'previous_attributes': any | null;
|
|
1285
|
+
'object': AppBannerInfoResponse;
|
|
1286
|
+
}
|
|
1238
1287
|
export interface AppBannerInfoResponse {
|
|
1239
1288
|
'id': string;
|
|
1240
1289
|
'object'?: 'app_banner';
|
|
@@ -1447,6 +1496,22 @@ export interface AppPersonLabelSchema {
|
|
|
1447
1496
|
'label': string;
|
|
1448
1497
|
}
|
|
1449
1498
|
export type AppPlatform = 'ios' | 'android';
|
|
1499
|
+
export interface AppReengagedEventData {
|
|
1500
|
+
/**
|
|
1501
|
+
* Always null for this event type.
|
|
1502
|
+
*/
|
|
1503
|
+
'previous_attributes': any | null;
|
|
1504
|
+
'object': InstallInfoResponse;
|
|
1505
|
+
/**
|
|
1506
|
+
* The click that opened the app.
|
|
1507
|
+
*/
|
|
1508
|
+
'click_id': string;
|
|
1509
|
+
'link': InstallLinkResponse;
|
|
1510
|
+
/**
|
|
1511
|
+
* The install's previous app open (ISO 8601), if any.
|
|
1512
|
+
*/
|
|
1513
|
+
'previous_open_at': string | null;
|
|
1514
|
+
}
|
|
1450
1515
|
export interface AppleApiKeyInfo {
|
|
1451
1516
|
'client_id': string | null;
|
|
1452
1517
|
'team_id': string | null;
|
|
@@ -1857,6 +1922,17 @@ export interface CampaignPerformanceRow {
|
|
|
1857
1922
|
'uninstall_rate_d7'?: number | null;
|
|
1858
1923
|
'real_installs'?: number | null;
|
|
1859
1924
|
}
|
|
1925
|
+
export interface CampaignStatusEventData {
|
|
1926
|
+
/**
|
|
1927
|
+
* Always null for this event type.
|
|
1928
|
+
*/
|
|
1929
|
+
'previous_attributes': any | null;
|
|
1930
|
+
'object': CampaignInfoResponse;
|
|
1931
|
+
/**
|
|
1932
|
+
* How many links changed status.
|
|
1933
|
+
*/
|
|
1934
|
+
'affected_links': number;
|
|
1935
|
+
}
|
|
1860
1936
|
/**
|
|
1861
1937
|
* POST /v1/challenges/{id}/cancel: a reason is required once the challenge is live.
|
|
1862
1938
|
*/
|
|
@@ -1893,10 +1969,69 @@ export interface CertaintyResponse {
|
|
|
1893
1969
|
'estimated_low'?: number | null;
|
|
1894
1970
|
'estimated_high'?: number | null;
|
|
1895
1971
|
}
|
|
1972
|
+
export interface ChallengeCancelledEventData {
|
|
1973
|
+
/**
|
|
1974
|
+
* Always null for this event type.
|
|
1975
|
+
*/
|
|
1976
|
+
'previous_attributes': any | null;
|
|
1977
|
+
'object': ChallengeInfoResponse;
|
|
1978
|
+
'previous_status': string;
|
|
1979
|
+
'reason': string | null;
|
|
1980
|
+
}
|
|
1896
1981
|
export interface ChallengeCompareResponse {
|
|
1897
1982
|
'object'?: 'list';
|
|
1898
1983
|
'data': Array<ChallengeResultsResponse>;
|
|
1899
1984
|
}
|
|
1985
|
+
export interface ChallengeEndedEventData {
|
|
1986
|
+
/**
|
|
1987
|
+
* Always null for this event type.
|
|
1988
|
+
*/
|
|
1989
|
+
'previous_attributes': any | null;
|
|
1990
|
+
'object': ChallengeInfoResponse;
|
|
1991
|
+
/**
|
|
1992
|
+
* The trophy winners (empty without a trophy).
|
|
1993
|
+
*/
|
|
1994
|
+
'winners': Array<LeaderboardWinnerObject>;
|
|
1995
|
+
}
|
|
1996
|
+
export interface ChallengeEventData {
|
|
1997
|
+
/**
|
|
1998
|
+
* Always null for this event type.
|
|
1999
|
+
*/
|
|
2000
|
+
'previous_attributes': any | null;
|
|
2001
|
+
'object': ChallengeInfoResponse;
|
|
2002
|
+
}
|
|
2003
|
+
/**
|
|
2004
|
+
* The challenge's results as frozen when it became final.
|
|
2005
|
+
*/
|
|
2006
|
+
export interface ChallengeFinalResults {
|
|
2007
|
+
'challenge_id': string;
|
|
2008
|
+
'name': string;
|
|
2009
|
+
'status': string;
|
|
2010
|
+
'starts_at': string | null;
|
|
2011
|
+
'ends_at': string | null;
|
|
2012
|
+
'timezone': string;
|
|
2013
|
+
'final': boolean;
|
|
2014
|
+
'computed_at': string;
|
|
2015
|
+
'participants': number;
|
|
2016
|
+
'active_participants': number;
|
|
2017
|
+
'new_referees': number;
|
|
2018
|
+
'goals_completed': number | null;
|
|
2019
|
+
'total_value': Money | null;
|
|
2020
|
+
'winners': Array<LeaderboardWinnerObject>;
|
|
2021
|
+
'prize_cost': ChallengePrizeCostInfo | null;
|
|
2022
|
+
'cost_per_new_referee': Money | null;
|
|
2023
|
+
'cost_per_goal': Money | null;
|
|
2024
|
+
'post_final_changes': Array<LeaderboardPostFinalChange>;
|
|
2025
|
+
}
|
|
2026
|
+
export interface ChallengeFinalizedEventData {
|
|
2027
|
+
/**
|
|
2028
|
+
* Always null for this event type.
|
|
2029
|
+
*/
|
|
2030
|
+
'previous_attributes': any | null;
|
|
2031
|
+
'object': ChallengeInfoResponse;
|
|
2032
|
+
'winners': Array<LeaderboardWinnerObject>;
|
|
2033
|
+
'results': ChallengeFinalResults;
|
|
2034
|
+
}
|
|
1900
2035
|
export interface ChallengeInfoResponse {
|
|
1901
2036
|
'id': string;
|
|
1902
2037
|
'object'?: 'challenge';
|
|
@@ -1986,6 +2121,10 @@ export interface ChallengeParticipantResponse {
|
|
|
1986
2121
|
*/
|
|
1987
2122
|
'livemode': boolean;
|
|
1988
2123
|
}
|
|
2124
|
+
export interface ChallengePrizeCostInfo {
|
|
2125
|
+
'amount': string;
|
|
2126
|
+
'currency': string;
|
|
2127
|
+
}
|
|
1989
2128
|
export interface ChallengeResultsResponse {
|
|
1990
2129
|
'object'?: 'challenge_results';
|
|
1991
2130
|
'challenge_id': string;
|
|
@@ -2037,6 +2176,7 @@ export interface ChallengeTemplateResponse {
|
|
|
2037
2176
|
*/
|
|
2038
2177
|
'livemode': boolean;
|
|
2039
2178
|
}
|
|
2179
|
+
export type ChangePctValue = number;
|
|
2040
2180
|
/**
|
|
2041
2181
|
* The channel's new customers and spend split by campaign (the ad campaign first, else the Clikgate campaign).
|
|
2042
2182
|
*/
|
|
@@ -2107,6 +2247,39 @@ export interface ClickCampaignResponse {
|
|
|
2107
2247
|
'id': string;
|
|
2108
2248
|
'external_reference': string | null;
|
|
2109
2249
|
}
|
|
2250
|
+
export interface ClickCreatedEventData {
|
|
2251
|
+
/**
|
|
2252
|
+
* Always null for this event type.
|
|
2253
|
+
*/
|
|
2254
|
+
'previous_attributes': any | null;
|
|
2255
|
+
'object': ClickCreatedObject;
|
|
2256
|
+
}
|
|
2257
|
+
/**
|
|
2258
|
+
* A counted (non-bot) click. Never holds IP addresses or visitor hashes.
|
|
2259
|
+
*/
|
|
2260
|
+
export interface ClickCreatedObject {
|
|
2261
|
+
'object': 'click';
|
|
2262
|
+
'id': string;
|
|
2263
|
+
'link': ClickEventRef | null;
|
|
2264
|
+
'campaign': ClickEventRef | null;
|
|
2265
|
+
'post_tag_id': string | null;
|
|
2266
|
+
'variant_id': string | null;
|
|
2267
|
+
'channel': string | null;
|
|
2268
|
+
'country': string | null;
|
|
2269
|
+
'device_type': string | null;
|
|
2270
|
+
'is_qr': boolean;
|
|
2271
|
+
/**
|
|
2272
|
+
* When the click happened (ISO 8601).
|
|
2273
|
+
*/
|
|
2274
|
+
'occurred_at': string;
|
|
2275
|
+
/**
|
|
2276
|
+
* true for live-environment data, false for test mode.
|
|
2277
|
+
*/
|
|
2278
|
+
'livemode': boolean;
|
|
2279
|
+
}
|
|
2280
|
+
export interface ClickEventRef {
|
|
2281
|
+
'id': string;
|
|
2282
|
+
}
|
|
2110
2283
|
export interface ClickIdEngineRow {
|
|
2111
2284
|
'browser_engine': string;
|
|
2112
2285
|
'goals': number;
|
|
@@ -2275,13 +2448,21 @@ export interface CodeInfoResponse {
|
|
|
2275
2448
|
*/
|
|
2276
2449
|
'livemode': boolean;
|
|
2277
2450
|
}
|
|
2451
|
+
export interface CodeRedeemedEventData {
|
|
2452
|
+
/**
|
|
2453
|
+
* Always null for this event type.
|
|
2454
|
+
*/
|
|
2455
|
+
'previous_attributes': any | null;
|
|
2456
|
+
'object': OfflineTouchInfoResponse;
|
|
2457
|
+
}
|
|
2278
2458
|
export interface CodeRedemptionResponse {
|
|
2279
2459
|
'object'?: 'code_redemption';
|
|
2280
2460
|
'offline_touch_id': string;
|
|
2281
2461
|
'code': RedemptionCodeInfo;
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2462
|
+
/**
|
|
2463
|
+
* The referral this redemption created or found (referral codes whose subject maps to an install); null otherwise.
|
|
2464
|
+
*/
|
|
2465
|
+
'referral': ReferralInfoResponse | null;
|
|
2285
2466
|
'linked': boolean;
|
|
2286
2467
|
'referral_error'?: ReferralErrorInfo | null;
|
|
2287
2468
|
/**
|
|
@@ -2332,7 +2513,7 @@ export interface CohortMeasures {
|
|
|
2332
2513
|
/**
|
|
2333
2514
|
* Cumulative confirmed revenue by day 0-30 since install (the line chart); null after days_reached
|
|
2334
2515
|
*/
|
|
2335
|
-
'curve': Array<
|
|
2516
|
+
'curve': Array<CurveInner>;
|
|
2336
2517
|
'fx_estimated'?: boolean;
|
|
2337
2518
|
}
|
|
2338
2519
|
export interface CohortRevenueResponse {
|
|
@@ -2388,7 +2569,7 @@ export interface CohortRow {
|
|
|
2388
2569
|
/**
|
|
2389
2570
|
* Cumulative confirmed revenue by day 0-30 since install (the line chart); null after days_reached
|
|
2390
2571
|
*/
|
|
2391
|
-
'curve': Array<
|
|
2572
|
+
'curve': Array<CurveInner>;
|
|
2392
2573
|
'fx_estimated'?: boolean;
|
|
2393
2574
|
/**
|
|
2394
2575
|
* The cohort's first install day (Monday for weeks)
|
|
@@ -2595,6 +2776,17 @@ export interface ConversionDestinationInfoResponse {
|
|
|
2595
2776
|
*/
|
|
2596
2777
|
'livemode': boolean;
|
|
2597
2778
|
}
|
|
2779
|
+
export interface ConversionEventData {
|
|
2780
|
+
/**
|
|
2781
|
+
* Always null for this event type.
|
|
2782
|
+
*/
|
|
2783
|
+
'previous_attributes': any | null;
|
|
2784
|
+
'object': ConversionInfoResponse;
|
|
2785
|
+
/**
|
|
2786
|
+
* true when the event arrived before its click was recorded (a click served by the backup redirect during an outage) and was matched once the click appeared. Absent otherwise.
|
|
2787
|
+
*/
|
|
2788
|
+
'recorded_late'?: boolean | null;
|
|
2789
|
+
}
|
|
2598
2790
|
export interface ConversionInfoResponse {
|
|
2599
2791
|
'clicked_on'?: ClickedOn | null;
|
|
2600
2792
|
'clicked_on_basis'?: ClickedOnBasis | null;
|
|
@@ -2650,6 +2842,14 @@ export interface ConversionLinkResponse {
|
|
|
2650
2842
|
[key: string]: any;
|
|
2651
2843
|
};
|
|
2652
2844
|
}
|
|
2845
|
+
export interface ConversionReversedEventData {
|
|
2846
|
+
/**
|
|
2847
|
+
* Always null for this event type.
|
|
2848
|
+
*/
|
|
2849
|
+
'previous_attributes': any | null;
|
|
2850
|
+
'object': ConversionInfoResponse;
|
|
2851
|
+
'reversal': ReversalInfoResponse;
|
|
2852
|
+
}
|
|
2653
2853
|
export interface ConversionRuleInfo {
|
|
2654
2854
|
'id': string;
|
|
2655
2855
|
'name': string;
|
|
@@ -2792,6 +2992,29 @@ export interface CreateExportSchema {
|
|
|
2792
2992
|
'to'?: string | null;
|
|
2793
2993
|
'recipients'?: ExportRecipientsSchema | null;
|
|
2794
2994
|
}
|
|
2995
|
+
export interface CreditNoteEventData {
|
|
2996
|
+
/**
|
|
2997
|
+
* Always null for this event type.
|
|
2998
|
+
*/
|
|
2999
|
+
'previous_attributes': any | null;
|
|
3000
|
+
'object': CreditNoteEventObject;
|
|
3001
|
+
}
|
|
3002
|
+
export interface CreditNoteEventObject {
|
|
3003
|
+
'object': 'credit_note';
|
|
3004
|
+
'id': string;
|
|
3005
|
+
'number': string;
|
|
3006
|
+
'invoice_id': string;
|
|
3007
|
+
'invoice_number': string | null;
|
|
3008
|
+
'currency': string;
|
|
3009
|
+
'amount_minor': number;
|
|
3010
|
+
'vat_minor': number;
|
|
3011
|
+
'issued_at': string;
|
|
3012
|
+
/**
|
|
3013
|
+
* true for live-environment data, false for test mode.
|
|
3014
|
+
*/
|
|
3015
|
+
'livemode': boolean;
|
|
3016
|
+
}
|
|
3017
|
+
export type CurveInner = number;
|
|
2795
3018
|
/**
|
|
2796
3019
|
* Average cumulative value per customer `day` days after their first day (day 0 = the first day).
|
|
2797
3020
|
*/
|
|
@@ -2811,7 +3034,7 @@ export interface CustomerCostBlended {
|
|
|
2811
3034
|
'customers_with_first_value': number;
|
|
2812
3035
|
'previous': CustomerCostPeriod | null;
|
|
2813
3036
|
'change_pct': number | null;
|
|
2814
|
-
'trend': Array<
|
|
3037
|
+
'trend': Array<TrendInner>;
|
|
2815
3038
|
'value': CustomerCostValue | null;
|
|
2816
3039
|
'value_reason': ValueReason | null;
|
|
2817
3040
|
'payback': CustomerCostPayback;
|
|
@@ -3060,6 +3283,10 @@ export interface DashboardScheduleResponse {
|
|
|
3060
3283
|
'livemode': boolean;
|
|
3061
3284
|
}
|
|
3062
3285
|
export type DashboardTheme = 'light' | 'dark' | 'auto';
|
|
3286
|
+
/**
|
|
3287
|
+
* `data.object` and the event's extra keys; `type` says which schema applies (see `WebhookEvent`).
|
|
3288
|
+
*/
|
|
3289
|
+
export type Data = AbTestLikelyWinnerEventData | AlertEventData | AppBannerEventData | AppReengagedEventData | CampaignStatusEventData | ChallengeCancelledEventData | ChallengeEndedEventData | ChallengeEventData | ChallengeFinalizedEventData | ClickCreatedEventData | CodeRedeemedEventData | ConversionEventData | ConversionReversedEventData | CreditNoteEventData | DomainGroupChangedEventData | DomainSettingsUpdatedEventData | DomainStatusChangedEventData | FeatureChangeEventData | FeatureDataPurgeEventData | FraudInstallFlaggedEventData | FunnelStuckEventData | GoalCompletedEventData | GoalReversedEventData | IdentityDuplicateDetectedEventData | InstallAttributionUpdatedEventData | InstallEventData | InvoiceEventData | JobEventData | LeaderboardPeriodEventData | LeaderboardRankChangedEventData | LeaderboardTargetEventData | LinkCreatedEventData | LinkDestinationChangedEventData | LinkStatsHourlyEventData | LinkStatusEventData | LinkUpdatedEventData | OrganizationDeletedEventData | PartnerApprovedEventData | PartnerEarningApprovedEventData | PartnerPayoutPaidEventData | PartnerRewardEventData | PaymentEventData | PaymentRefundedEventData | PersonDeviceChangedEventData | PrivacyRequestEventData | PushCredentialsInvalidEventData | ReceiptEventData | ReferralEventData | ReferralStepCompletedEventData | ReferrerEventData | ReferrerQualityChangedEventData | SaleEventData | SaleRefundedEventData | SkanPostbackEventData | SubscriptionChangedEventData | SubscriptionEventData | SubscriptionUpdatedEventData | TrialEventData | UsageThresholdEventData | WebhookEndpointEventData | WebhookTestEventData | WhatsappConversationAttributedEventData;
|
|
3063
3290
|
export interface DataFeedInfoResponse {
|
|
3064
3291
|
'object'?: 'data_feed';
|
|
3065
3292
|
'id': string;
|
|
@@ -3273,6 +3500,46 @@ export interface DeviceChangeResponse {
|
|
|
3273
3500
|
'gap_days': number | null;
|
|
3274
3501
|
'created_at': string;
|
|
3275
3502
|
}
|
|
3503
|
+
export interface DeviceChangeSide {
|
|
3504
|
+
'platform': string;
|
|
3505
|
+
'device_model': string | null;
|
|
3506
|
+
}
|
|
3507
|
+
/**
|
|
3508
|
+
* A customer moving to another phone, or adding one. Coarse device models only.
|
|
3509
|
+
*/
|
|
3510
|
+
export interface DeviceChangeWebhookObject {
|
|
3511
|
+
'object': 'device_change';
|
|
3512
|
+
/**
|
|
3513
|
+
* `{device_change_id}:{kind}`.
|
|
3514
|
+
*/
|
|
3515
|
+
'id': string;
|
|
3516
|
+
'device_change_id': string;
|
|
3517
|
+
'person_id': string;
|
|
3518
|
+
'customer_id': string | null;
|
|
3519
|
+
'app_id': string;
|
|
3520
|
+
/**
|
|
3521
|
+
* `switch` or `second_device`.
|
|
3522
|
+
*/
|
|
3523
|
+
'kind': string;
|
|
3524
|
+
'from': DeviceChangeSide;
|
|
3525
|
+
'to': DeviceChangeSide;
|
|
3526
|
+
/**
|
|
3527
|
+
* When the earlier phone was last seen (ISO 8601).
|
|
3528
|
+
*/
|
|
3529
|
+
'from_last_seen_at': string | null;
|
|
3530
|
+
/**
|
|
3531
|
+
* When the new phone first opened the app (ISO 8601).
|
|
3532
|
+
*/
|
|
3533
|
+
'to_first_open_at': string;
|
|
3534
|
+
/**
|
|
3535
|
+
* Days between the two, for a switch; null for a second device.
|
|
3536
|
+
*/
|
|
3537
|
+
'gap_days': number | null;
|
|
3538
|
+
/**
|
|
3539
|
+
* true for live-environment data, false for test mode.
|
|
3540
|
+
*/
|
|
3541
|
+
'livemode': boolean;
|
|
3542
|
+
}
|
|
3276
3543
|
export interface DeviceChangesListResponse {
|
|
3277
3544
|
'object'?: 'list';
|
|
3278
3545
|
'data': Array<DeviceChangeResponse>;
|
|
@@ -3350,6 +3617,13 @@ export interface DomainChecksResponse {
|
|
|
3350
3617
|
'authoritative'?: boolean;
|
|
3351
3618
|
'checked_at'?: string | null;
|
|
3352
3619
|
}
|
|
3620
|
+
export interface DomainGroupChangedEventData {
|
|
3621
|
+
'previous_attributes': DomainGroupPrevious;
|
|
3622
|
+
'object': DomainInfoResponse;
|
|
3623
|
+
'from_group_id': string;
|
|
3624
|
+
'to_group_id': string;
|
|
3625
|
+
'links_moved': number;
|
|
3626
|
+
}
|
|
3353
3627
|
/**
|
|
3354
3628
|
* Slugs used both by the domain's links and by the group: aliasing would make them ambiguous.
|
|
3355
3629
|
*/
|
|
@@ -3388,6 +3662,9 @@ export interface DomainGroupMemberResponse {
|
|
|
3388
3662
|
'mode': string;
|
|
3389
3663
|
'is_primary': boolean;
|
|
3390
3664
|
}
|
|
3665
|
+
export interface DomainGroupPrevious {
|
|
3666
|
+
'group_id': string;
|
|
3667
|
+
}
|
|
3391
3668
|
export interface DomainInfoResponse {
|
|
3392
3669
|
'id': string;
|
|
3393
3670
|
'object'?: 'domain';
|
|
@@ -3429,6 +3706,25 @@ export interface DomainInfoResponse {
|
|
|
3429
3706
|
* `short` (SMS, WhatsApp, creator links) or `branded` (email, ads); informational plus defaults.
|
|
3430
3707
|
*/
|
|
3431
3708
|
export type DomainRole = 'short' | 'branded';
|
|
3709
|
+
/**
|
|
3710
|
+
* The settings that changed, with their earlier values (only the changed keys are present).
|
|
3711
|
+
*/
|
|
3712
|
+
export interface DomainSettingsPrevious {
|
|
3713
|
+
'role'?: string | null;
|
|
3714
|
+
'root_redirect_url'?: string | null;
|
|
3715
|
+
'not_found_url'?: string | null;
|
|
3716
|
+
'unavailable_url'?: string | null;
|
|
3717
|
+
/**
|
|
3718
|
+
* The earlier branding: `logo_url`, `primary_color`, `display_name` when set.
|
|
3719
|
+
*/
|
|
3720
|
+
'branding'?: {
|
|
3721
|
+
[key: string]: any;
|
|
3722
|
+
} | null;
|
|
3723
|
+
}
|
|
3724
|
+
export interface DomainSettingsUpdatedEventData {
|
|
3725
|
+
'previous_attributes': DomainSettingsPrevious;
|
|
3726
|
+
'object': DomainInfoResponse;
|
|
3727
|
+
}
|
|
3432
3728
|
/**
|
|
3433
3729
|
* Step-by-step DNS instructions.
|
|
3434
3730
|
*/
|
|
@@ -3470,6 +3766,18 @@ export interface DomainSetupSendListResponse {
|
|
|
3470
3766
|
'object'?: 'list';
|
|
3471
3767
|
'data': Array<DomainSetupSendInfoResponse>;
|
|
3472
3768
|
}
|
|
3769
|
+
export interface DomainStatusChangedEventData {
|
|
3770
|
+
/**
|
|
3771
|
+
* Always null for this event type.
|
|
3772
|
+
*/
|
|
3773
|
+
'previous_attributes': any | null;
|
|
3774
|
+
'object': DomainInfoResponse;
|
|
3775
|
+
'previous_status': string;
|
|
3776
|
+
/**
|
|
3777
|
+
* Which check failed and what DNS returned.
|
|
3778
|
+
*/
|
|
3779
|
+
'checks': DomainChecksResponse | null;
|
|
3780
|
+
}
|
|
3473
3781
|
/**
|
|
3474
3782
|
* A ZIP of every active placement's QR code with an `index.csv` (number, name, URL, file).
|
|
3475
3783
|
*/
|
|
@@ -3654,9 +3962,7 @@ export interface EventInfoResponse {
|
|
|
3654
3962
|
'created_at': string;
|
|
3655
3963
|
'organization_id': string;
|
|
3656
3964
|
'livemode'?: boolean;
|
|
3657
|
-
'data':
|
|
3658
|
-
[key: string]: any;
|
|
3659
|
-
};
|
|
3965
|
+
'data': Data;
|
|
3660
3966
|
}
|
|
3661
3967
|
export interface EventMappingSchema {
|
|
3662
3968
|
'clikgate_event': string;
|
|
@@ -3747,8 +4053,8 @@ export interface ExploreRow {
|
|
|
3747
4053
|
/**
|
|
3748
4054
|
* One value per breakdown (ids; masked where private)
|
|
3749
4055
|
*/
|
|
3750
|
-
'keys': Array<
|
|
3751
|
-
'labels': Array<
|
|
4056
|
+
'keys': Array<KeysInner>;
|
|
4057
|
+
'labels': Array<KeysInner>;
|
|
3752
4058
|
/**
|
|
3753
4059
|
* Column id -> number (`null`: '—')
|
|
3754
4060
|
*/
|
|
@@ -3762,7 +4068,7 @@ export interface ExploreRow {
|
|
|
3762
4068
|
[key: string]: any;
|
|
3763
4069
|
} | null;
|
|
3764
4070
|
'change_pct'?: {
|
|
3765
|
-
[key: string]:
|
|
4071
|
+
[key: string]: ChangePctValue;
|
|
3766
4072
|
} | null;
|
|
3767
4073
|
}
|
|
3768
4074
|
export interface ExploreSortSchema {
|
|
@@ -3776,8 +4082,8 @@ export interface ExploreSubtotal {
|
|
|
3776
4082
|
/**
|
|
3777
4083
|
* One value per breakdown (ids; masked where private)
|
|
3778
4084
|
*/
|
|
3779
|
-
'keys': Array<
|
|
3780
|
-
'labels': Array<
|
|
4085
|
+
'keys': Array<KeysInner>;
|
|
4086
|
+
'labels': Array<KeysInner>;
|
|
3781
4087
|
/**
|
|
3782
4088
|
* Column id -> number (`null`: '—')
|
|
3783
4089
|
*/
|
|
@@ -3791,7 +4097,7 @@ export interface ExploreSubtotal {
|
|
|
3791
4097
|
[key: string]: any;
|
|
3792
4098
|
} | null;
|
|
3793
4099
|
'change_pct'?: {
|
|
3794
|
-
[key: string]:
|
|
4100
|
+
[key: string]: ChangePctValue;
|
|
3795
4101
|
} | null;
|
|
3796
4102
|
'level': number;
|
|
3797
4103
|
}
|
|
@@ -3803,7 +4109,7 @@ export interface ExploreTotals {
|
|
|
3803
4109
|
[key: string]: any;
|
|
3804
4110
|
} | null;
|
|
3805
4111
|
'change_pct'?: {
|
|
3806
|
-
[key: string]:
|
|
4112
|
+
[key: string]: ChangePctValue;
|
|
3807
4113
|
} | null;
|
|
3808
4114
|
}
|
|
3809
4115
|
export interface ExportClickFiltersSchema {
|
|
@@ -3905,11 +4211,87 @@ export interface ExportScheduleInfoResponse {
|
|
|
3905
4211
|
*/
|
|
3906
4212
|
'livemode': boolean;
|
|
3907
4213
|
}
|
|
4214
|
+
export interface FeatureChangeEventData {
|
|
4215
|
+
/**
|
|
4216
|
+
* Always null for this event type.
|
|
4217
|
+
*/
|
|
4218
|
+
'previous_attributes': any | null;
|
|
4219
|
+
'object': FeatureChangeEventObject;
|
|
4220
|
+
}
|
|
4221
|
+
export interface FeatureChangeEventObject {
|
|
4222
|
+
'object': 'feature_change';
|
|
4223
|
+
/**
|
|
4224
|
+
* The feature's key.
|
|
4225
|
+
*/
|
|
4226
|
+
'key': string;
|
|
4227
|
+
'enabled': boolean;
|
|
4228
|
+
/**
|
|
4229
|
+
* Who changed it: `plan` when a plan change switched it, else the actor's ID.
|
|
4230
|
+
*/
|
|
4231
|
+
'changed_by': string;
|
|
4232
|
+
/**
|
|
4233
|
+
* What happens to the feature's data when it is switched off (`keep`: kept read-only); null when it was switched on.
|
|
4234
|
+
*/
|
|
4235
|
+
'data_action': string | null;
|
|
4236
|
+
/**
|
|
4237
|
+
* true for live-environment data, false for test mode.
|
|
4238
|
+
*/
|
|
4239
|
+
'livemode': boolean;
|
|
4240
|
+
}
|
|
4241
|
+
export interface FeatureDataPurgeEventData {
|
|
4242
|
+
/**
|
|
4243
|
+
* Always null for this event type.
|
|
4244
|
+
*/
|
|
4245
|
+
'previous_attributes': any | null;
|
|
4246
|
+
'object': FeatureDataPurgeEventObject;
|
|
4247
|
+
}
|
|
4248
|
+
export interface FeatureDataPurgeEventObject {
|
|
4249
|
+
'object': 'feature_data_purge';
|
|
4250
|
+
'id': string;
|
|
4251
|
+
/**
|
|
4252
|
+
* The feature whose data was deleted.
|
|
4253
|
+
*/
|
|
4254
|
+
'key': string;
|
|
4255
|
+
/**
|
|
4256
|
+
* Rows deleted, by data category.
|
|
4257
|
+
*/
|
|
4258
|
+
'counts': {
|
|
4259
|
+
[key: string]: number;
|
|
4260
|
+
};
|
|
4261
|
+
/**
|
|
4262
|
+
* true for live-environment data, false for test mode.
|
|
4263
|
+
*/
|
|
4264
|
+
'livemode': boolean;
|
|
4265
|
+
}
|
|
3908
4266
|
export type FeedStatus = 'active' | 'revoked';
|
|
3909
4267
|
export interface FinalizeDelay {
|
|
3910
4268
|
'mode'?: 'auto' | 'fixed';
|
|
3911
4269
|
'hours'?: number | null;
|
|
3912
4270
|
}
|
|
4271
|
+
/**
|
|
4272
|
+
* Installs flagged since the previous batch, for one environment.
|
|
4273
|
+
*/
|
|
4274
|
+
export interface FlaggedInstallBatch {
|
|
4275
|
+
'object': 'fraud_flag_batch';
|
|
4276
|
+
'count': number;
|
|
4277
|
+
'installs': Array<FlaggedInstallItem>;
|
|
4278
|
+
/**
|
|
4279
|
+
* true for live-environment data, false for test mode.
|
|
4280
|
+
*/
|
|
4281
|
+
'livemode': boolean;
|
|
4282
|
+
}
|
|
4283
|
+
export interface FlaggedInstallItem {
|
|
4284
|
+
'install_id': string;
|
|
4285
|
+
'app_id': string;
|
|
4286
|
+
'network': string;
|
|
4287
|
+
'campaign_id': string | null;
|
|
4288
|
+
'score': number;
|
|
4289
|
+
'decision': string;
|
|
4290
|
+
/**
|
|
4291
|
+
* The rules that flagged the install.
|
|
4292
|
+
*/
|
|
4293
|
+
'reasons': Array<KeysInner>;
|
|
4294
|
+
}
|
|
3913
4295
|
export type FraudAction = 'flag' | 'exclude' | 'hold';
|
|
3914
4296
|
export interface FraudCarrierAdjustments {
|
|
3915
4297
|
'networks': Array<FraudCarrierNetwork>;
|
|
@@ -3948,6 +4330,13 @@ export interface FraudCheckResultResponse {
|
|
|
3948
4330
|
}
|
|
3949
4331
|
export type FraudDecision = 'clean' | 'flagged' | 'excluded' | 'held';
|
|
3950
4332
|
export type FraudGroupBy = 'network' | 'campaign' | 'sub_publisher' | 'app' | 'day';
|
|
4333
|
+
export interface FraudInstallFlaggedEventData {
|
|
4334
|
+
/**
|
|
4335
|
+
* Always null for this event type.
|
|
4336
|
+
*/
|
|
4337
|
+
'previous_attributes': any | null;
|
|
4338
|
+
'object': FlaggedInstallBatch;
|
|
4339
|
+
}
|
|
3951
4340
|
export interface FraudInstallInfoResponse {
|
|
3952
4341
|
'object'?: 'fraud_install';
|
|
3953
4342
|
'id': string;
|
|
@@ -4188,35 +4577,97 @@ export interface FunnelStepStats {
|
|
|
4188
4577
|
'median_seconds_from_previous': number | null;
|
|
4189
4578
|
}
|
|
4190
4579
|
export type FunnelStepType = 'click' | 'install' | 'goal';
|
|
4191
|
-
|
|
4192
|
-
|
|
4193
|
-
|
|
4194
|
-
|
|
4195
|
-
|
|
4580
|
+
/**
|
|
4581
|
+
* People stuck at a funnel step. Customer IDs are never in the event.
|
|
4582
|
+
*/
|
|
4583
|
+
export interface FunnelStuckBatchObject {
|
|
4584
|
+
'object': 'funnel_stuck_batch';
|
|
4196
4585
|
'id': string;
|
|
4197
|
-
'
|
|
4198
|
-
'
|
|
4199
|
-
'
|
|
4200
|
-
'
|
|
4201
|
-
'ga4_event_name': string;
|
|
4202
|
-
'install_id': string | null;
|
|
4203
|
-
'conversion_id': string | null;
|
|
4204
|
-
'status': string;
|
|
4205
|
-
'attempts': number;
|
|
4206
|
-
'response_code': number | null;
|
|
4207
|
-
'error': string | null;
|
|
4208
|
-
'created_at': string;
|
|
4209
|
-
'sent_at': string | null;
|
|
4586
|
+
'funnel': FunnelStuckFunnel;
|
|
4587
|
+
'step': StuckStep;
|
|
4588
|
+
'previous_step': StuckStep;
|
|
4589
|
+
'min_days': number;
|
|
4210
4590
|
/**
|
|
4211
|
-
*
|
|
4591
|
+
* The day of the run (YYYY-MM-DD).
|
|
4212
4592
|
*/
|
|
4213
|
-
'
|
|
4214
|
-
|
|
4215
|
-
|
|
4216
|
-
'
|
|
4217
|
-
'
|
|
4218
|
-
'
|
|
4219
|
-
'
|
|
4593
|
+
'run_on': string;
|
|
4594
|
+
'total_rows': number;
|
|
4595
|
+
'truncated': boolean;
|
|
4596
|
+
'page': number;
|
|
4597
|
+
'pages': number;
|
|
4598
|
+
'page_size': number;
|
|
4599
|
+
'rows': Array<FunnelStuckRow>;
|
|
4600
|
+
/**
|
|
4601
|
+
* Where to fetch page 2 over the API; null with one page.
|
|
4602
|
+
*/
|
|
4603
|
+
'next_page': string | null;
|
|
4604
|
+
/**
|
|
4605
|
+
* true for live-environment data, false for test mode.
|
|
4606
|
+
*/
|
|
4607
|
+
'livemode': boolean;
|
|
4608
|
+
}
|
|
4609
|
+
export interface FunnelStuckEventData {
|
|
4610
|
+
/**
|
|
4611
|
+
* Always null for this event type.
|
|
4612
|
+
*/
|
|
4613
|
+
'previous_attributes': any | null;
|
|
4614
|
+
'object': FunnelStuckBatchObject;
|
|
4615
|
+
}
|
|
4616
|
+
export interface FunnelStuckFunnel {
|
|
4617
|
+
'id': string;
|
|
4618
|
+
'name': string;
|
|
4619
|
+
}
|
|
4620
|
+
export interface FunnelStuckPerson {
|
|
4621
|
+
'id': string;
|
|
4622
|
+
/**
|
|
4623
|
+
* Present only when labels may be sent in webhooks.
|
|
4624
|
+
*/
|
|
4625
|
+
'label'?: string | null;
|
|
4626
|
+
}
|
|
4627
|
+
export interface FunnelStuckRow {
|
|
4628
|
+
'person': FunnelStuckPerson | null;
|
|
4629
|
+
'click_id': string;
|
|
4630
|
+
'last_step': StuckStep;
|
|
4631
|
+
'last_step_at': string;
|
|
4632
|
+
'stuck_days': number;
|
|
4633
|
+
'acquired_via': string | null;
|
|
4634
|
+
'campaign_id': string | null;
|
|
4635
|
+
'link_id': string | null;
|
|
4636
|
+
'partner_id': string | null;
|
|
4637
|
+
'country': string | null;
|
|
4638
|
+
'platform': string | null;
|
|
4639
|
+
'first_time': boolean;
|
|
4640
|
+
'flagged': boolean;
|
|
4641
|
+
}
|
|
4642
|
+
export interface Ga4EventMappingSchema {
|
|
4643
|
+
'clikgate_event': string;
|
|
4644
|
+
'ga4_event': string;
|
|
4645
|
+
}
|
|
4646
|
+
export interface Ga4SendInfoResponse {
|
|
4647
|
+
'id': string;
|
|
4648
|
+
'object'?: 'ga4_send';
|
|
4649
|
+
'destination_id': string;
|
|
4650
|
+
'source_event_id': string;
|
|
4651
|
+
'source_type': string;
|
|
4652
|
+
'ga4_event_name': string;
|
|
4653
|
+
'install_id': string | null;
|
|
4654
|
+
'conversion_id': string | null;
|
|
4655
|
+
'status': string;
|
|
4656
|
+
'attempts': number;
|
|
4657
|
+
'response_code': number | null;
|
|
4658
|
+
'error': string | null;
|
|
4659
|
+
'created_at': string;
|
|
4660
|
+
'sent_at': string | null;
|
|
4661
|
+
/**
|
|
4662
|
+
* true for live-environment data, false for test mode.
|
|
4663
|
+
*/
|
|
4664
|
+
'livemode': boolean;
|
|
4665
|
+
}
|
|
4666
|
+
export interface Ga4TestResponse {
|
|
4667
|
+
'object'?: 'ga4_test';
|
|
4668
|
+
'ok': boolean;
|
|
4669
|
+
'status_code': number | null;
|
|
4670
|
+
'validation_messages': Array<{
|
|
4220
4671
|
[key: string]: ValidationMessagesInnerValue;
|
|
4221
4672
|
}>;
|
|
4222
4673
|
/**
|
|
@@ -4338,6 +4789,53 @@ export interface GoalColumn {
|
|
|
4338
4789
|
'group_id'?: string | null;
|
|
4339
4790
|
'group_name'?: string | null;
|
|
4340
4791
|
}
|
|
4792
|
+
export interface GoalCompletedEventData {
|
|
4793
|
+
/**
|
|
4794
|
+
* Always null for this event type.
|
|
4795
|
+
*/
|
|
4796
|
+
'previous_attributes': any | null;
|
|
4797
|
+
'object': GoalCompletedWebhookObject;
|
|
4798
|
+
/**
|
|
4799
|
+
* true when the event arrived before its click was recorded (a click served by the backup redirect during an outage) and was matched once the click appeared. Absent otherwise.
|
|
4800
|
+
*/
|
|
4801
|
+
'recorded_late'?: boolean | null;
|
|
4802
|
+
}
|
|
4803
|
+
export interface GoalCompletedWebhookObject {
|
|
4804
|
+
'object': 'goal_event';
|
|
4805
|
+
'id': string;
|
|
4806
|
+
'goal': string | null;
|
|
4807
|
+
'value': string | null;
|
|
4808
|
+
'value_minor': number | null;
|
|
4809
|
+
'currency': string | null;
|
|
4810
|
+
'first_for_click': boolean | null;
|
|
4811
|
+
'is_first_customer': boolean | null;
|
|
4812
|
+
'link': GoalWebhookRef | null;
|
|
4813
|
+
'campaign': GoalWebhookRef | null;
|
|
4814
|
+
'clicked_at': string | null;
|
|
4815
|
+
'occurred_at': string;
|
|
4816
|
+
'status': string;
|
|
4817
|
+
/**
|
|
4818
|
+
* The alias the event arrived as; null when sent as the goal's key.
|
|
4819
|
+
*/
|
|
4820
|
+
'received_as': string | null;
|
|
4821
|
+
'goal_group': GoalWebhookGroup | null;
|
|
4822
|
+
/**
|
|
4823
|
+
* Your reference for the event. Absent in private mode (only its hash is kept).
|
|
4824
|
+
*/
|
|
4825
|
+
'reference'?: string | null;
|
|
4826
|
+
/**
|
|
4827
|
+
* The event's person; `label` only with "Include labels in webhooks".
|
|
4828
|
+
*/
|
|
4829
|
+
'person': PersonRef | null;
|
|
4830
|
+
/**
|
|
4831
|
+
* true for an event counted from the last 30 days when the goal was set up (sent only when you chose to also send webhooks). Absent otherwise.
|
|
4832
|
+
*/
|
|
4833
|
+
'backfilled'?: boolean | null;
|
|
4834
|
+
/**
|
|
4835
|
+
* true for live-environment data, false for test mode.
|
|
4836
|
+
*/
|
|
4837
|
+
'livemode': boolean;
|
|
4838
|
+
}
|
|
4341
4839
|
export interface GoalDebugResponse {
|
|
4342
4840
|
'object'?: 'goal_debug';
|
|
4343
4841
|
'private_mode': boolean;
|
|
@@ -4481,6 +4979,37 @@ export interface GoalEventSchema {
|
|
|
4481
4979
|
*/
|
|
4482
4980
|
'platform'?: 'ios' | 'android' | 'macos' | 'windows' | 'linux' | 'other' | null;
|
|
4483
4981
|
}
|
|
4982
|
+
/**
|
|
4983
|
+
* A goal event as goal webhooks show it. `value` is in normal units, as a decimal string.
|
|
4984
|
+
*/
|
|
4985
|
+
export interface GoalEventWebhookObject {
|
|
4986
|
+
'object': 'goal_event';
|
|
4987
|
+
'id': string;
|
|
4988
|
+
'goal': string | null;
|
|
4989
|
+
'value': string | null;
|
|
4990
|
+
'value_minor': number | null;
|
|
4991
|
+
'currency': string | null;
|
|
4992
|
+
'first_for_click': boolean | null;
|
|
4993
|
+
'is_first_customer': boolean | null;
|
|
4994
|
+
'link': GoalWebhookRef | null;
|
|
4995
|
+
'campaign': GoalWebhookRef | null;
|
|
4996
|
+
'clicked_at': string | null;
|
|
4997
|
+
'occurred_at': string;
|
|
4998
|
+
'status': string;
|
|
4999
|
+
/**
|
|
5000
|
+
* The alias the event arrived as; null when sent as the goal's key.
|
|
5001
|
+
*/
|
|
5002
|
+
'received_as': string | null;
|
|
5003
|
+
'goal_group': GoalWebhookGroup | null;
|
|
5004
|
+
/**
|
|
5005
|
+
* Your reference for the event. Absent in private mode (only its hash is kept).
|
|
5006
|
+
*/
|
|
5007
|
+
'reference'?: string | null;
|
|
5008
|
+
/**
|
|
5009
|
+
* true for live-environment data, false for test mode.
|
|
5010
|
+
*/
|
|
5011
|
+
'livemode': boolean;
|
|
5012
|
+
}
|
|
4484
5013
|
export interface GoalEventsBatchSchema {
|
|
4485
5014
|
'events': Array<{
|
|
4486
5015
|
[key: string]: any;
|
|
@@ -4724,6 +5253,27 @@ export interface GoalRejectionInfoResponse {
|
|
|
4724
5253
|
*/
|
|
4725
5254
|
'livemode': boolean;
|
|
4726
5255
|
}
|
|
5256
|
+
export interface GoalReversalWebhookInfo {
|
|
5257
|
+
'id': string;
|
|
5258
|
+
/**
|
|
5259
|
+
* The amount reversed, in normal units; null when no amount was given.
|
|
5260
|
+
*/
|
|
5261
|
+
'value': string | null;
|
|
5262
|
+
'value_minor': number | null;
|
|
5263
|
+
'reason': string | null;
|
|
5264
|
+
/**
|
|
5265
|
+
* What is left of the event's value, in normal units.
|
|
5266
|
+
*/
|
|
5267
|
+
'remaining_value': string | null;
|
|
5268
|
+
}
|
|
5269
|
+
export interface GoalReversedEventData {
|
|
5270
|
+
/**
|
|
5271
|
+
* Always null for this event type.
|
|
5272
|
+
*/
|
|
5273
|
+
'previous_attributes': any | null;
|
|
5274
|
+
'object': GoalEventWebhookObject;
|
|
5275
|
+
'reversal': GoalReversalWebhookInfo;
|
|
5276
|
+
}
|
|
4727
5277
|
/**
|
|
4728
5278
|
* Goals settings (`GET` / `PATCH /v1/goals/settings`): read with goals_payments:view, changed with manage.
|
|
4729
5279
|
*/
|
|
@@ -4782,6 +5332,13 @@ export interface GoalSuggestionInfo {
|
|
|
4782
5332
|
*/
|
|
4783
5333
|
'livemode': boolean;
|
|
4784
5334
|
}
|
|
5335
|
+
export interface GoalWebhookGroup {
|
|
5336
|
+
'id': string;
|
|
5337
|
+
'name': string;
|
|
5338
|
+
}
|
|
5339
|
+
export interface GoalWebhookRef {
|
|
5340
|
+
'id': string;
|
|
5341
|
+
}
|
|
4785
5342
|
/**
|
|
4786
5343
|
* What the business adds to its Google Ads account for Data Manager uploads (`mode = service_account`).
|
|
4787
5344
|
*/
|
|
@@ -4898,6 +5455,36 @@ export interface IdentityDedupeRules {
|
|
|
4898
5455
|
'require_verified'?: boolean;
|
|
4899
5456
|
'action'?: 'reject' | 'flag';
|
|
4900
5457
|
}
|
|
5458
|
+
export interface IdentityDuplicateDetectedEventData {
|
|
5459
|
+
/**
|
|
5460
|
+
* Always null for this event type.
|
|
5461
|
+
*/
|
|
5462
|
+
'previous_attributes': any | null;
|
|
5463
|
+
'object': IdentityDuplicateObject;
|
|
5464
|
+
}
|
|
5465
|
+
/**
|
|
5466
|
+
* The identity match. Never carries a hash.
|
|
5467
|
+
*/
|
|
5468
|
+
export interface IdentityDuplicateObject {
|
|
5469
|
+
'id': string;
|
|
5470
|
+
'object'?: 'identity_match';
|
|
5471
|
+
'app_scope': string;
|
|
5472
|
+
'signal_type': string;
|
|
5473
|
+
'subject_a': SubjectInfo;
|
|
5474
|
+
'subject_b': SubjectInfo;
|
|
5475
|
+
'context': string;
|
|
5476
|
+
'status': string;
|
|
5477
|
+
'first_detected_at': string;
|
|
5478
|
+
'updated_at': string;
|
|
5479
|
+
/**
|
|
5480
|
+
* The same as `id`.
|
|
5481
|
+
*/
|
|
5482
|
+
'match_id': string;
|
|
5483
|
+
/**
|
|
5484
|
+
* true for live-environment data, false for test mode.
|
|
5485
|
+
*/
|
|
5486
|
+
'livemode': boolean;
|
|
5487
|
+
}
|
|
4901
5488
|
export interface IdentityMatchInfoResponse {
|
|
4902
5489
|
'id': string;
|
|
4903
5490
|
'object'?: 'identity_match';
|
|
@@ -5102,6 +5689,19 @@ export interface IngestReceiptResponse {
|
|
|
5102
5689
|
*/
|
|
5103
5690
|
'livemode': boolean;
|
|
5104
5691
|
}
|
|
5692
|
+
export interface InstallAttributionUpdatedEventData {
|
|
5693
|
+
/**
|
|
5694
|
+
* Always null for this event type.
|
|
5695
|
+
*/
|
|
5696
|
+
'previous_attributes': any | null;
|
|
5697
|
+
'object': InstallInfoResponse;
|
|
5698
|
+
/**
|
|
5699
|
+
* Apple Ads attribution as Apple's AdServices API returned it, when the update came from Apple Ads. Absent otherwise.
|
|
5700
|
+
*/
|
|
5701
|
+
'apple_search_ads'?: {
|
|
5702
|
+
[key: string]: any;
|
|
5703
|
+
} | null;
|
|
5704
|
+
}
|
|
5105
5705
|
/**
|
|
5106
5706
|
* The "See details" drawer: one slice of Organic vs non-organic, broken down.
|
|
5107
5707
|
*/
|
|
@@ -5128,6 +5728,13 @@ export interface InstallDetailsRow {
|
|
|
5128
5728
|
'active_users': number;
|
|
5129
5729
|
'share': number | null;
|
|
5130
5730
|
}
|
|
5731
|
+
export interface InstallEventData {
|
|
5732
|
+
/**
|
|
5733
|
+
* Always null for this event type.
|
|
5734
|
+
*/
|
|
5735
|
+
'previous_attributes': any | null;
|
|
5736
|
+
'object': InstallInfoResponse;
|
|
5737
|
+
}
|
|
5131
5738
|
/**
|
|
5132
5739
|
* The install object in API responses and install.* webhooks. Never holds push tokens.
|
|
5133
5740
|
*/
|
|
@@ -5222,7 +5829,46 @@ export interface InviteLinkResponse {
|
|
|
5222
5829
|
*/
|
|
5223
5830
|
'livemode': boolean;
|
|
5224
5831
|
}
|
|
5832
|
+
export interface InvoiceEventData {
|
|
5833
|
+
/**
|
|
5834
|
+
* Always null for this event type.
|
|
5835
|
+
*/
|
|
5836
|
+
'previous_attributes': any | null;
|
|
5837
|
+
'object': InvoiceEventObject;
|
|
5838
|
+
}
|
|
5839
|
+
export interface InvoiceEventObject {
|
|
5840
|
+
'object': 'invoice';
|
|
5841
|
+
'id': string;
|
|
5842
|
+
'number': string | null;
|
|
5843
|
+
'kind': string;
|
|
5844
|
+
'status': string;
|
|
5845
|
+
'currency': string;
|
|
5846
|
+
'subtotal_minor': number;
|
|
5847
|
+
'vat_minor': number;
|
|
5848
|
+
'total_minor': number;
|
|
5849
|
+
'amount_paid_minor': number;
|
|
5850
|
+
'wht_minor': number;
|
|
5851
|
+
'credited_minor': number;
|
|
5852
|
+
'balance_due_minor': number;
|
|
5853
|
+
'issued_at': string | null;
|
|
5854
|
+
'due_at': string | null;
|
|
5855
|
+
'paid_at': string | null;
|
|
5856
|
+
'voided_at': string | null;
|
|
5857
|
+
'upgrade_request_id': string | null;
|
|
5858
|
+
'subscription_id': string | null;
|
|
5859
|
+
/**
|
|
5860
|
+
* true for live-environment data, false for test mode.
|
|
5861
|
+
*/
|
|
5862
|
+
'livemode': boolean;
|
|
5863
|
+
}
|
|
5225
5864
|
export type IosInterstitial = 'auto' | 'always' | 'never';
|
|
5865
|
+
export interface JobEventData {
|
|
5866
|
+
/**
|
|
5867
|
+
* Always null for this event type.
|
|
5868
|
+
*/
|
|
5869
|
+
'previous_attributes': any | null;
|
|
5870
|
+
'object': JobInfoResponse;
|
|
5871
|
+
}
|
|
5226
5872
|
export interface JobInfoResponse {
|
|
5227
5873
|
'id': string;
|
|
5228
5874
|
'object'?: 'job';
|
|
@@ -5231,13 +5877,95 @@ export interface JobInfoResponse {
|
|
|
5231
5877
|
'total': number;
|
|
5232
5878
|
'succeeded': number;
|
|
5233
5879
|
'failed': number;
|
|
5234
|
-
'results': Array<
|
|
5235
|
-
[key: string]: any;
|
|
5236
|
-
}>;
|
|
5880
|
+
'results': Array<JobResultItem>;
|
|
5237
5881
|
'created_at': string;
|
|
5238
5882
|
'finished_at': string | null;
|
|
5239
5883
|
'livemode'?: boolean;
|
|
5240
5884
|
}
|
|
5885
|
+
/**
|
|
5886
|
+
* Why an item (or the whole job) failed.
|
|
5887
|
+
*/
|
|
5888
|
+
export interface JobResultError {
|
|
5889
|
+
/**
|
|
5890
|
+
* `invalid_request` or `server`.
|
|
5891
|
+
*/
|
|
5892
|
+
'type': string;
|
|
5893
|
+
'code': string;
|
|
5894
|
+
/**
|
|
5895
|
+
* What went wrong, in words. Absent when it doesn't apply.
|
|
5896
|
+
*/
|
|
5897
|
+
'message'?: string;
|
|
5898
|
+
/**
|
|
5899
|
+
* The field of the item that was refused. Absent when it doesn't apply.
|
|
5900
|
+
*/
|
|
5901
|
+
'param'?: string | null;
|
|
5902
|
+
/**
|
|
5903
|
+
* QR placement downloads: the placement left out. Absent when it doesn't apply.
|
|
5904
|
+
*/
|
|
5905
|
+
'number'?: number;
|
|
5906
|
+
/**
|
|
5907
|
+
* QR placement downloads: why it was left out. Absent when it doesn't apply.
|
|
5908
|
+
*/
|
|
5909
|
+
'reasons'?: Array<string>;
|
|
5910
|
+
}
|
|
5911
|
+
/**
|
|
5912
|
+
* One result of a job. Bulk link jobs and referrer imports send one item per input item (`index`, `ok`, then
|
|
5913
|
+
* `link_id` or `referrer_id` and `created`, or `error`). Exports and downloads send the file (`url`, `expires_at`,
|
|
5914
|
+
* `rows` or `files`, `run_id` for reports) or an `error`. A test data reset sends one item per table (`table`,
|
|
5915
|
+
* `deleted`). Only the keys that apply are present.
|
|
5916
|
+
*/
|
|
5917
|
+
export interface JobResultItem {
|
|
5918
|
+
/**
|
|
5919
|
+
* The input item's position (0 is the first). Absent when it doesn't apply.
|
|
5920
|
+
*/
|
|
5921
|
+
'index'?: number;
|
|
5922
|
+
/**
|
|
5923
|
+
* Whether the input item succeeded. Absent when it doesn't apply.
|
|
5924
|
+
*/
|
|
5925
|
+
'ok'?: boolean;
|
|
5926
|
+
/**
|
|
5927
|
+
* Bulk link jobs: the link created or changed. Absent when it doesn't apply.
|
|
5928
|
+
*/
|
|
5929
|
+
'link_id'?: string;
|
|
5930
|
+
/**
|
|
5931
|
+
* Referrer imports: the referrer. Absent when it doesn't apply.
|
|
5932
|
+
*/
|
|
5933
|
+
'referrer_id'?: string;
|
|
5934
|
+
/**
|
|
5935
|
+
* Referrer imports: true when the referrer is new, false when updated. Absent when it doesn't apply.
|
|
5936
|
+
*/
|
|
5937
|
+
'created'?: boolean;
|
|
5938
|
+
/**
|
|
5939
|
+
* Exports and downloads: a signed link to the file. Absent when it doesn't apply.
|
|
5940
|
+
*/
|
|
5941
|
+
'url'?: string;
|
|
5942
|
+
/**
|
|
5943
|
+
* When `url` stops working (Unix seconds). Absent when it doesn't apply.
|
|
5944
|
+
*/
|
|
5945
|
+
'expires_at'?: number;
|
|
5946
|
+
/**
|
|
5947
|
+
* Exports: the rows in the file. Absent when it doesn't apply.
|
|
5948
|
+
*/
|
|
5949
|
+
'rows'?: number;
|
|
5950
|
+
/**
|
|
5951
|
+
* QR placement downloads: the images in the ZIP. Absent when it doesn't apply.
|
|
5952
|
+
*/
|
|
5953
|
+
'files'?: number;
|
|
5954
|
+
/**
|
|
5955
|
+
* Report exports: the report run exported. Absent when it doesn't apply.
|
|
5956
|
+
*/
|
|
5957
|
+
'run_id'?: string;
|
|
5958
|
+
/**
|
|
5959
|
+
* Test data resets: the kind of data deleted. Absent when it doesn't apply.
|
|
5960
|
+
*/
|
|
5961
|
+
'table'?: string;
|
|
5962
|
+
/**
|
|
5963
|
+
* Test data resets: how many rows were deleted. Absent when it doesn't apply.
|
|
5964
|
+
*/
|
|
5965
|
+
'deleted'?: number;
|
|
5966
|
+
'error'?: JobResultError;
|
|
5967
|
+
}
|
|
5968
|
+
export type KeysInner = string;
|
|
5241
5969
|
export interface KnownCustomerRemoveResponse {
|
|
5242
5970
|
'removed': boolean;
|
|
5243
5971
|
}
|
|
@@ -5364,6 +6092,40 @@ export interface LeaderboardInfoResponse {
|
|
|
5364
6092
|
'livemode': boolean;
|
|
5365
6093
|
}
|
|
5366
6094
|
export type LeaderboardMetric = 'qualified' | 'installs' | 'signups' | 'step' | 'points' | 'goal';
|
|
6095
|
+
/**
|
|
6096
|
+
* What the period is scored on. `goal_key`, `measure` and `currency` are present only on goal metrics.
|
|
6097
|
+
*/
|
|
6098
|
+
export interface LeaderboardMetricInfo {
|
|
6099
|
+
'type': string;
|
|
6100
|
+
'step_goal': string | null;
|
|
6101
|
+
'weights': {
|
|
6102
|
+
[key: string]: number;
|
|
6103
|
+
} | null;
|
|
6104
|
+
'applies_to_metric': boolean;
|
|
6105
|
+
'goal_key'?: string | null;
|
|
6106
|
+
'measure'?: string | null;
|
|
6107
|
+
'currency'?: string | null;
|
|
6108
|
+
}
|
|
6109
|
+
/**
|
|
6110
|
+
* One ranked referrer (eligible referrers only; opted-out ones are flagged).
|
|
6111
|
+
*/
|
|
6112
|
+
export interface LeaderboardPeriodEntry {
|
|
6113
|
+
'rank': number;
|
|
6114
|
+
'referrer_id': string;
|
|
6115
|
+
'display': string;
|
|
6116
|
+
'score': number;
|
|
6117
|
+
'pending': number;
|
|
6118
|
+
'adjustments': number;
|
|
6119
|
+
'tie_break_at': string | null;
|
|
6120
|
+
'opted_out': boolean;
|
|
6121
|
+
}
|
|
6122
|
+
export interface LeaderboardPeriodEventData {
|
|
6123
|
+
/**
|
|
6124
|
+
* Always null for this event type.
|
|
6125
|
+
*/
|
|
6126
|
+
'previous_attributes': any | null;
|
|
6127
|
+
'object': LeaderboardPeriodObject;
|
|
6128
|
+
}
|
|
5367
6129
|
export interface LeaderboardPeriodInfoResponse {
|
|
5368
6130
|
'id': string;
|
|
5369
6131
|
'object'?: 'leaderboard_period';
|
|
@@ -5386,6 +6148,97 @@ export interface LeaderboardPeriodInfoResponse {
|
|
|
5386
6148
|
*/
|
|
5387
6149
|
'livemode': boolean;
|
|
5388
6150
|
}
|
|
6151
|
+
/**
|
|
6152
|
+
* A leaderboard period with its top entries.
|
|
6153
|
+
*/
|
|
6154
|
+
export interface LeaderboardPeriodObject {
|
|
6155
|
+
'id': string;
|
|
6156
|
+
'object': 'leaderboard_period';
|
|
6157
|
+
'leaderboard_id': string;
|
|
6158
|
+
'leaderboard': LeaderboardRef;
|
|
6159
|
+
'key': string;
|
|
6160
|
+
'status': string;
|
|
6161
|
+
'starts_at': string | null;
|
|
6162
|
+
'ends_at': string | null;
|
|
6163
|
+
'finalize_at': string | null;
|
|
6164
|
+
'finalized_at': string | null;
|
|
6165
|
+
'finalized_by': string | null;
|
|
6166
|
+
'metric': LeaderboardMetricInfo;
|
|
6167
|
+
'post_final_changes': Array<LeaderboardPostFinalChange>;
|
|
6168
|
+
'challenge_id': string | null;
|
|
6169
|
+
/**
|
|
6170
|
+
* The top of the ranking.
|
|
6171
|
+
*/
|
|
6172
|
+
'entries': Array<LeaderboardPeriodEntry>;
|
|
6173
|
+
/**
|
|
6174
|
+
* The trophy winners; absent when the period has no trophy.
|
|
6175
|
+
*/
|
|
6176
|
+
'winners'?: Array<LeaderboardWinnerObject> | null;
|
|
6177
|
+
/**
|
|
6178
|
+
* true for live-environment data, false for test mode.
|
|
6179
|
+
*/
|
|
6180
|
+
'livemode': boolean;
|
|
6181
|
+
}
|
|
6182
|
+
/**
|
|
6183
|
+
* The period a ranking or trophy belongs to.
|
|
6184
|
+
*/
|
|
6185
|
+
export interface LeaderboardPeriodRef {
|
|
6186
|
+
'key': string;
|
|
6187
|
+
'status': string;
|
|
6188
|
+
'starts_at': string | null;
|
|
6189
|
+
'ends_at': string | null;
|
|
6190
|
+
}
|
|
6191
|
+
/**
|
|
6192
|
+
* A reversal after the period became final, listed but never applied. Referral changes carry `state_change_id`,
|
|
6193
|
+
* `referral_id`, `referrer_id` and `from_status`; goal reversals carry `conversion_id`, `goal`, `referrer_ids` and
|
|
6194
|
+
* `currency`.
|
|
6195
|
+
*/
|
|
6196
|
+
export interface LeaderboardPostFinalChange {
|
|
6197
|
+
'state_change_id'?: string | null;
|
|
6198
|
+
'referral_id'?: string | null;
|
|
6199
|
+
'referrer_id'?: string | null;
|
|
6200
|
+
'conversion_id'?: string | null;
|
|
6201
|
+
'goal'?: string | null;
|
|
6202
|
+
'referrer_ids'?: Array<string> | null;
|
|
6203
|
+
'from_status'?: string | null;
|
|
6204
|
+
'to_status': string;
|
|
6205
|
+
'points': number;
|
|
6206
|
+
'currency'?: string | null;
|
|
6207
|
+
'at': string | null;
|
|
6208
|
+
}
|
|
6209
|
+
/**
|
|
6210
|
+
* A referrer entered or left the top of a leaderboard, or moved within it.
|
|
6211
|
+
*/
|
|
6212
|
+
export interface LeaderboardRankChangeObject {
|
|
6213
|
+
'object': 'leaderboard_rank_change';
|
|
6214
|
+
'leaderboard_id': string;
|
|
6215
|
+
'period': LeaderboardPeriodRef;
|
|
6216
|
+
'referrer_id': string;
|
|
6217
|
+
'previous_rank': number | null;
|
|
6218
|
+
'rank': number | null;
|
|
6219
|
+
/**
|
|
6220
|
+
* `entered`, `left`, `moved_up` or `moved_down`.
|
|
6221
|
+
*/
|
|
6222
|
+
'change': string;
|
|
6223
|
+
'top_n': number;
|
|
6224
|
+
'score': number;
|
|
6225
|
+
/**
|
|
6226
|
+
* true for live-environment data, false for test mode.
|
|
6227
|
+
*/
|
|
6228
|
+
'livemode': boolean;
|
|
6229
|
+
}
|
|
6230
|
+
export interface LeaderboardRankChangedEventData {
|
|
6231
|
+
/**
|
|
6232
|
+
* Always null for this event type.
|
|
6233
|
+
*/
|
|
6234
|
+
'previous_attributes': any | null;
|
|
6235
|
+
'object': LeaderboardRankChangeObject;
|
|
6236
|
+
}
|
|
6237
|
+
export interface LeaderboardRef {
|
|
6238
|
+
'id': string;
|
|
6239
|
+
'name': string;
|
|
6240
|
+
'program_id': string;
|
|
6241
|
+
}
|
|
5389
6242
|
export interface LeaderboardReferrerResponse {
|
|
5390
6243
|
'object'?: 'leaderboard_referrer';
|
|
5391
6244
|
'leaderboard_id': string;
|
|
@@ -5438,6 +6291,25 @@ export interface LeaderboardResponse {
|
|
|
5438
6291
|
*/
|
|
5439
6292
|
'livemode': boolean;
|
|
5440
6293
|
}
|
|
6294
|
+
export interface LeaderboardTargetEventData {
|
|
6295
|
+
/**
|
|
6296
|
+
* Always null for this event type.
|
|
6297
|
+
*/
|
|
6298
|
+
'previous_attributes': any | null;
|
|
6299
|
+
'object': LeaderboardWinnerObject;
|
|
6300
|
+
}
|
|
6301
|
+
/**
|
|
6302
|
+
* The trophy target. Value boards also give the minor-unit threshold (`score_minor`) and `currency`.
|
|
6303
|
+
*/
|
|
6304
|
+
export interface LeaderboardTargetInfo {
|
|
6305
|
+
'score': Score;
|
|
6306
|
+
'label': string;
|
|
6307
|
+
'prize_text': string | null;
|
|
6308
|
+
'mode': string;
|
|
6309
|
+
'n': number | null;
|
|
6310
|
+
'score_minor'?: number | null;
|
|
6311
|
+
'currency'?: string | null;
|
|
6312
|
+
}
|
|
5441
6313
|
/**
|
|
5442
6314
|
* GET /v1/leaderboards/{id}/trophy. Never any pace or "days to go".
|
|
5443
6315
|
*/
|
|
@@ -5462,6 +6334,29 @@ export interface LeaderboardTrophyResponse {
|
|
|
5462
6334
|
*/
|
|
5463
6335
|
'livemode': boolean;
|
|
5464
6336
|
}
|
|
6337
|
+
/**
|
|
6338
|
+
* A referrer who reached a leaderboard's or challenge's trophy target.
|
|
6339
|
+
*/
|
|
6340
|
+
export interface LeaderboardWinnerObject {
|
|
6341
|
+
'id': string;
|
|
6342
|
+
'object': 'leaderboard_target_winner';
|
|
6343
|
+
'leaderboard_id': string;
|
|
6344
|
+
'challenge_id': string | null;
|
|
6345
|
+
'period': LeaderboardPeriodRef;
|
|
6346
|
+
'segment': string;
|
|
6347
|
+
'referrer_id': string;
|
|
6348
|
+
'display': string | null;
|
|
6349
|
+
'status': string;
|
|
6350
|
+
'position': number | null;
|
|
6351
|
+
'reached_at': string | null;
|
|
6352
|
+
'score_at_reach': number;
|
|
6353
|
+
'revoked_at': string | null;
|
|
6354
|
+
'target': LeaderboardTargetInfo;
|
|
6355
|
+
/**
|
|
6356
|
+
* true for live-environment data, false for test mode.
|
|
6357
|
+
*/
|
|
6358
|
+
'livemode': boolean;
|
|
6359
|
+
}
|
|
5465
6360
|
/**
|
|
5466
6361
|
* A destination change waiting for a second person (returned with 202).
|
|
5467
6362
|
*/
|
|
@@ -5485,6 +6380,13 @@ export interface LinkChangeRequestInfoResponse {
|
|
|
5485
6380
|
*/
|
|
5486
6381
|
'livemode': boolean;
|
|
5487
6382
|
}
|
|
6383
|
+
export interface LinkCreatedEventData {
|
|
6384
|
+
/**
|
|
6385
|
+
* Always null for this event type.
|
|
6386
|
+
*/
|
|
6387
|
+
'previous_attributes': any | null;
|
|
6388
|
+
'object': LinkInfoResponse;
|
|
6389
|
+
}
|
|
5488
6390
|
export interface LinkDefaults {
|
|
5489
6391
|
'deep_link_path'?: string | null;
|
|
5490
6392
|
'deep_link_data'?: {
|
|
@@ -5495,6 +6397,46 @@ export interface LinkDefaults {
|
|
|
5495
6397
|
'og_image_url'?: string | null;
|
|
5496
6398
|
'fallback_url'?: string | null;
|
|
5497
6399
|
}
|
|
6400
|
+
/**
|
|
6401
|
+
* Who changed the destination.
|
|
6402
|
+
*/
|
|
6403
|
+
export interface LinkDestinationActor {
|
|
6404
|
+
/**
|
|
6405
|
+
* The kind of actor: user, key, staff, system...
|
|
6406
|
+
*/
|
|
6407
|
+
'type': string;
|
|
6408
|
+
'id': string;
|
|
6409
|
+
/**
|
|
6410
|
+
* The API key's prefix when an API key made the change.
|
|
6411
|
+
*/
|
|
6412
|
+
'api_key_prefix': string | null;
|
|
6413
|
+
/**
|
|
6414
|
+
* Who asked for the change, when it was approved as a change request.
|
|
6415
|
+
*/
|
|
6416
|
+
'requested_by'?: string | null;
|
|
6417
|
+
/**
|
|
6418
|
+
* The approved change request, when the change needed a second person.
|
|
6419
|
+
*/
|
|
6420
|
+
'change_request_id'?: string | null;
|
|
6421
|
+
}
|
|
6422
|
+
export interface LinkDestinationChangedEventData {
|
|
6423
|
+
/**
|
|
6424
|
+
* Always null for this event type.
|
|
6425
|
+
*/
|
|
6426
|
+
'previous_attributes': any | null;
|
|
6427
|
+
'object': LinkInfoResponse;
|
|
6428
|
+
/**
|
|
6429
|
+
* The destination before the change.
|
|
6430
|
+
*/
|
|
6431
|
+
'from': string;
|
|
6432
|
+
/**
|
|
6433
|
+
* The new destination.
|
|
6434
|
+
*/
|
|
6435
|
+
'to': string;
|
|
6436
|
+
'actor': LinkDestinationActor;
|
|
6437
|
+
'actor_type': string;
|
|
6438
|
+
'api_key_prefix': string | null;
|
|
6439
|
+
}
|
|
5498
6440
|
/**
|
|
5499
6441
|
* Password page views, wrong attempts and successful opens; blocked taps by country (counters, not clicks).
|
|
5500
6442
|
*/
|
|
@@ -5622,14 +6564,33 @@ export interface LinkReviewRequestResponse {
|
|
|
5622
6564
|
*/
|
|
5623
6565
|
'livemode': boolean;
|
|
5624
6566
|
}
|
|
6567
|
+
/**
|
|
6568
|
+
* What a visitor must match for the rule to apply; only the conditions the rule uses are present.
|
|
6569
|
+
*/
|
|
6570
|
+
export interface LinkRuleConditions {
|
|
6571
|
+
/**
|
|
6572
|
+
* Operating systems (lowercase). Absent when not a condition.
|
|
6573
|
+
*/
|
|
6574
|
+
'os'?: Array<string>;
|
|
6575
|
+
/**
|
|
6576
|
+
* Device types (lowercase). Absent when not a condition.
|
|
6577
|
+
*/
|
|
6578
|
+
'device_type'?: Array<string>;
|
|
6579
|
+
/**
|
|
6580
|
+
* ISO 3166-1 alpha-2 country codes. Absent when not a condition.
|
|
6581
|
+
*/
|
|
6582
|
+
'country'?: Array<string>;
|
|
6583
|
+
/**
|
|
6584
|
+
* Language tags such as `en` or `fr-ca`. Absent when not a condition.
|
|
6585
|
+
*/
|
|
6586
|
+
'language'?: Array<string>;
|
|
6587
|
+
}
|
|
5625
6588
|
export interface LinkRuleInfoResponse {
|
|
5626
6589
|
'id': string;
|
|
5627
6590
|
'object'?: 'link_rule';
|
|
5628
6591
|
'link_id': string;
|
|
5629
6592
|
'priority': number;
|
|
5630
|
-
'conditions':
|
|
5631
|
-
[key: string]: any;
|
|
5632
|
-
};
|
|
6593
|
+
'conditions': LinkRuleConditions;
|
|
5633
6594
|
'destination_url': string | null;
|
|
5634
6595
|
'app_id': string | null;
|
|
5635
6596
|
'created_at': string;
|
|
@@ -5711,6 +6672,44 @@ export interface LinkSafetyWarning {
|
|
|
5711
6672
|
'param': string;
|
|
5712
6673
|
'message': string;
|
|
5713
6674
|
}
|
|
6675
|
+
export interface LinkStatsHourlyEventData {
|
|
6676
|
+
/**
|
|
6677
|
+
* Always null for this event type.
|
|
6678
|
+
*/
|
|
6679
|
+
'previous_attributes': any | null;
|
|
6680
|
+
'object': LinkStatsHourlyObject;
|
|
6681
|
+
}
|
|
6682
|
+
export interface LinkStatsHourlyLink {
|
|
6683
|
+
'id': string;
|
|
6684
|
+
'external_reference': string | null;
|
|
6685
|
+
/**
|
|
6686
|
+
* Human clicks in the hour (bots excluded).
|
|
6687
|
+
*/
|
|
6688
|
+
'clicks': number;
|
|
6689
|
+
'unique_visitors': number;
|
|
6690
|
+
'bot_clicks': number;
|
|
6691
|
+
'conversions': number;
|
|
6692
|
+
}
|
|
6693
|
+
/**
|
|
6694
|
+
* One hour of link statistics: links with clicks or conversions in the hour, at most 500 per event.
|
|
6695
|
+
*/
|
|
6696
|
+
export interface LinkStatsHourlyObject {
|
|
6697
|
+
/**
|
|
6698
|
+
* The start of the hour (UTC, ISO 8601).
|
|
6699
|
+
*/
|
|
6700
|
+
'hour': string;
|
|
6701
|
+
'links': Array<LinkStatsHourlyLink>;
|
|
6702
|
+
}
|
|
6703
|
+
export interface LinkStatusEventData {
|
|
6704
|
+
'previous_attributes': LinkStatusPrevious;
|
|
6705
|
+
'object': LinkInfoResponse;
|
|
6706
|
+
}
|
|
6707
|
+
/**
|
|
6708
|
+
* The link's status before the change.
|
|
6709
|
+
*/
|
|
6710
|
+
export interface LinkStatusPrevious {
|
|
6711
|
+
'status': string;
|
|
6712
|
+
}
|
|
5714
6713
|
/**
|
|
5715
6714
|
* `GET /v1/link-subdomains/availability?name=`.
|
|
5716
6715
|
*/
|
|
@@ -5734,8 +6733,17 @@ export interface LinkSubdomainAvailabilityResponse {
|
|
|
5734
6733
|
* link's unknown clicks over the last 7 days likely came from WhatsApp shares.
|
|
5735
6734
|
*/
|
|
5736
6735
|
export type LinkSuggestion = 'make_whatsapp_link';
|
|
6736
|
+
export interface LinkUpdatedEventData {
|
|
6737
|
+
/**
|
|
6738
|
+
* The fields that changed, with their earlier values.
|
|
6739
|
+
*/
|
|
6740
|
+
'previous_attributes': {
|
|
6741
|
+
[key: string]: any;
|
|
6742
|
+
} | null;
|
|
6743
|
+
'object': LinkInfoResponse;
|
|
6744
|
+
}
|
|
5737
6745
|
/**
|
|
5738
|
-
* The link on one active domain of its group
|
|
6746
|
+
* The link on one active domain of its group.
|
|
5739
6747
|
*/
|
|
5740
6748
|
export interface LinkUrlResponse {
|
|
5741
6749
|
'domain': string;
|
|
@@ -6528,7 +7536,7 @@ export interface NewCustomerReferral {
|
|
|
6528
7536
|
}
|
|
6529
7537
|
export type NotApplicableReason = 'app_only' | 'created_after_activity';
|
|
6530
7538
|
/**
|
|
6531
|
-
* What a note is about: the whole organisation, or one campaign, link, app or goal. `panel
|
|
7539
|
+
* What a note is about: the whole organisation, or one campaign, link, app or goal. `panel`: a
|
|
6532
7540
|
* note written on one dashboard panel, shown on that panel only.
|
|
6533
7541
|
*/
|
|
6534
7542
|
export type NoteScope = 'organization' | 'campaign' | 'link' | 'app' | 'goal' | 'panel';
|
|
@@ -6696,6 +7704,30 @@ export interface OrganizationCountriesSchema {
|
|
|
6696
7704
|
'default_allowed_countries'?: Array<string> | null;
|
|
6697
7705
|
'default_block_message'?: string | null;
|
|
6698
7706
|
}
|
|
7707
|
+
export interface OrganizationDeletedEventData {
|
|
7708
|
+
/**
|
|
7709
|
+
* Always null for this event type.
|
|
7710
|
+
*/
|
|
7711
|
+
'previous_attributes': any | null;
|
|
7712
|
+
'object': OrganizationDeletedEventObject;
|
|
7713
|
+
}
|
|
7714
|
+
export interface OrganizationDeletedEventObject {
|
|
7715
|
+
'id': string;
|
|
7716
|
+
'object': 'organization';
|
|
7717
|
+
'deletion_requested_at': string;
|
|
7718
|
+
/**
|
|
7719
|
+
* When the organisation's data is deleted for good.
|
|
7720
|
+
*/
|
|
7721
|
+
'purge_after': string | null;
|
|
7722
|
+
/**
|
|
7723
|
+
* Until when its links show a goodbye page.
|
|
7724
|
+
*/
|
|
7725
|
+
'goodbye_until': string | null;
|
|
7726
|
+
/**
|
|
7727
|
+
* true for live-environment data, false for test mode.
|
|
7728
|
+
*/
|
|
7729
|
+
'livemode': boolean;
|
|
7730
|
+
}
|
|
6699
7731
|
export interface OtherMatchCounts {
|
|
6700
7732
|
'app_link'?: number;
|
|
6701
7733
|
'organic'?: number;
|
|
@@ -6824,6 +7856,32 @@ export interface PartnerAnalyticsResponse {
|
|
|
6824
7856
|
*/
|
|
6825
7857
|
'livemode': boolean;
|
|
6826
7858
|
}
|
|
7859
|
+
export interface PartnerApprovedEventData {
|
|
7860
|
+
/**
|
|
7861
|
+
* Always null for this event type.
|
|
7862
|
+
*/
|
|
7863
|
+
'previous_attributes': any | null;
|
|
7864
|
+
'object': PartnerApprovedObject;
|
|
7865
|
+
}
|
|
7866
|
+
/**
|
|
7867
|
+
* A partner who joined a partner programme.
|
|
7868
|
+
*/
|
|
7869
|
+
export interface PartnerApprovedObject {
|
|
7870
|
+
'object': 'partner';
|
|
7871
|
+
'id': string;
|
|
7872
|
+
'program_id': string;
|
|
7873
|
+
'display_name': string | null;
|
|
7874
|
+
'handle': string | null;
|
|
7875
|
+
'external_ref': string | null;
|
|
7876
|
+
'group_id': string;
|
|
7877
|
+
'status': string;
|
|
7878
|
+
'joined_at': string | null;
|
|
7879
|
+
'email': string | null;
|
|
7880
|
+
/**
|
|
7881
|
+
* true for live-environment data, false for test mode.
|
|
7882
|
+
*/
|
|
7883
|
+
'livemode': boolean;
|
|
7884
|
+
}
|
|
6827
7885
|
/**
|
|
6828
7886
|
* A customer partners brought (business only: the business's own customer reference, never to partners).
|
|
6829
7887
|
*/
|
|
@@ -6841,6 +7899,41 @@ export interface PartnerCustomerRow {
|
|
|
6841
7899
|
'earning_window_day': number | null;
|
|
6842
7900
|
'earning_window_days': number | null;
|
|
6843
7901
|
}
|
|
7902
|
+
export interface PartnerEarningApprovedEventData {
|
|
7903
|
+
/**
|
|
7904
|
+
* Always null for this event type.
|
|
7905
|
+
*/
|
|
7906
|
+
'previous_attributes': any | null;
|
|
7907
|
+
'object': PartnerEarningObject;
|
|
7908
|
+
}
|
|
7909
|
+
/**
|
|
7910
|
+
* An approved money earning (store credit and gifts send the partner reward events instead).
|
|
7911
|
+
*/
|
|
7912
|
+
export interface PartnerEarningObject {
|
|
7913
|
+
'object': 'partner_earning';
|
|
7914
|
+
'id': string;
|
|
7915
|
+
'program_id': string;
|
|
7916
|
+
'partner_id': string;
|
|
7917
|
+
/**
|
|
7918
|
+
* Your own reference for the partner, else the partner's ID.
|
|
7919
|
+
*/
|
|
7920
|
+
'partner_reference': string;
|
|
7921
|
+
'partner_display_name': string | null;
|
|
7922
|
+
'kind': string;
|
|
7923
|
+
'amount_minor': number;
|
|
7924
|
+
'currency': string;
|
|
7925
|
+
'goal_key': string | null;
|
|
7926
|
+
'goal_event_id': string | null;
|
|
7927
|
+
'link_id': string | null;
|
|
7928
|
+
'post_tag_id': string | null;
|
|
7929
|
+
'counted_at': string | null;
|
|
7930
|
+
'approved_at': string;
|
|
7931
|
+
'status': string;
|
|
7932
|
+
/**
|
|
7933
|
+
* true for live-environment data, false for test mode.
|
|
7934
|
+
*/
|
|
7935
|
+
'livemode': boolean;
|
|
7936
|
+
}
|
|
6844
7937
|
export interface PartnerEventRow {
|
|
6845
7938
|
'id': string;
|
|
6846
7939
|
'occurred_at': string;
|
|
@@ -6920,6 +8013,31 @@ export interface PartnerMetrics {
|
|
|
6920
8013
|
[key: string]: number;
|
|
6921
8014
|
};
|
|
6922
8015
|
}
|
|
8016
|
+
/**
|
|
8017
|
+
* A payout marked paid in Clikgate (Clikgate never moves money).
|
|
8018
|
+
*/
|
|
8019
|
+
export interface PartnerPayoutObject {
|
|
8020
|
+
'object': 'partner_payout';
|
|
8021
|
+
'id': string;
|
|
8022
|
+
'program_id': string;
|
|
8023
|
+
'period_label': string;
|
|
8024
|
+
'currency': string;
|
|
8025
|
+
'total_minor': number;
|
|
8026
|
+
'partner_count': number;
|
|
8027
|
+
'status': string;
|
|
8028
|
+
'paid_at': string | null;
|
|
8029
|
+
/**
|
|
8030
|
+
* true for live-environment data, false for test mode.
|
|
8031
|
+
*/
|
|
8032
|
+
'livemode': boolean;
|
|
8033
|
+
}
|
|
8034
|
+
export interface PartnerPayoutPaidEventData {
|
|
8035
|
+
/**
|
|
8036
|
+
* Always null for this event type.
|
|
8037
|
+
*/
|
|
8038
|
+
'previous_attributes': any | null;
|
|
8039
|
+
'object': PartnerPayoutObject;
|
|
8040
|
+
}
|
|
6923
8041
|
export interface PartnerProgramInfoResponse {
|
|
6924
8042
|
'id': string;
|
|
6925
8043
|
'object'?: 'partner_program';
|
|
@@ -6963,6 +8081,58 @@ export interface PartnerProgramInfoResponse {
|
|
|
6963
8081
|
*/
|
|
6964
8082
|
'livemode': boolean;
|
|
6965
8083
|
}
|
|
8084
|
+
export interface PartnerRewardEventData {
|
|
8085
|
+
/**
|
|
8086
|
+
* Always null for this event type.
|
|
8087
|
+
*/
|
|
8088
|
+
'previous_attributes': any | null;
|
|
8089
|
+
'object': PartnerRewardObject;
|
|
8090
|
+
}
|
|
8091
|
+
/**
|
|
8092
|
+
* Store credit or a gift a partner earned. Clikgate never applies it: apply it in your own system, then mark it
|
|
8093
|
+
* applied. Never the partner's name or email.
|
|
8094
|
+
*/
|
|
8095
|
+
export interface PartnerRewardObject {
|
|
8096
|
+
'object': 'partner_reward';
|
|
8097
|
+
'earning_id': string;
|
|
8098
|
+
'program_id': string;
|
|
8099
|
+
'partner_id': string;
|
|
8100
|
+
/**
|
|
8101
|
+
* Your own reference for the partner, else the partner's ID.
|
|
8102
|
+
*/
|
|
8103
|
+
'partner_reference': string;
|
|
8104
|
+
/**
|
|
8105
|
+
* `credit` or `gift`.
|
|
8106
|
+
*/
|
|
8107
|
+
'reward_type': string;
|
|
8108
|
+
/**
|
|
8109
|
+
* The credit amount; null for gifts.
|
|
8110
|
+
*/
|
|
8111
|
+
'amount_minor': number | null;
|
|
8112
|
+
'currency': string;
|
|
8113
|
+
/**
|
|
8114
|
+
* The gift; null for credit.
|
|
8115
|
+
*/
|
|
8116
|
+
'gift_name': string | null;
|
|
8117
|
+
/**
|
|
8118
|
+
* The gift's value when one was set; null for credit.
|
|
8119
|
+
*/
|
|
8120
|
+
'gift_value_minor': number | null;
|
|
8121
|
+
'status': string;
|
|
8122
|
+
'reason_code': string | null;
|
|
8123
|
+
'goal_key': string | null;
|
|
8124
|
+
'goal_event_id': string | null;
|
|
8125
|
+
'counted_at': string | null;
|
|
8126
|
+
'reward_batch_id': string | null;
|
|
8127
|
+
/**
|
|
8128
|
+
* `{event type}:{earning id}`: the same reward event is never sent twice.
|
|
8129
|
+
*/
|
|
8130
|
+
'idempotency_key': string;
|
|
8131
|
+
/**
|
|
8132
|
+
* true for live-environment data, false for test mode.
|
|
8133
|
+
*/
|
|
8134
|
+
'livemode': boolean;
|
|
8135
|
+
}
|
|
6966
8136
|
/**
|
|
6967
8137
|
* `invited` (CSV / API import, activated at first sign-in), `applied` (waiting for "approve each new partner").
|
|
6968
8138
|
*/
|
|
@@ -7013,6 +8183,24 @@ export interface PaymentConfirmationInfoResponse {
|
|
|
7013
8183
|
*/
|
|
7014
8184
|
'livemode': boolean;
|
|
7015
8185
|
}
|
|
8186
|
+
export interface PaymentEventData {
|
|
8187
|
+
/**
|
|
8188
|
+
* Always null for this event type.
|
|
8189
|
+
*/
|
|
8190
|
+
'previous_attributes': any | null;
|
|
8191
|
+
'object': PaymentReportInfoResponse;
|
|
8192
|
+
}
|
|
8193
|
+
export interface PaymentRefundedEventData {
|
|
8194
|
+
/**
|
|
8195
|
+
* Always null for this event type.
|
|
8196
|
+
*/
|
|
8197
|
+
'previous_attributes': any | null;
|
|
8198
|
+
'object': PaymentReportInfoResponse;
|
|
8199
|
+
/**
|
|
8200
|
+
* The amount refunded by this event, in minor units.
|
|
8201
|
+
*/
|
|
8202
|
+
'refund_amount_minor': number;
|
|
8203
|
+
}
|
|
7016
8204
|
export interface PaymentReportInfoResponse {
|
|
7017
8205
|
'object'?: 'payment_report';
|
|
7018
8206
|
'id': string;
|
|
@@ -7198,6 +8386,13 @@ export interface PersonAppSummary {
|
|
|
7198
8386
|
'uninstalled_at': string | null;
|
|
7199
8387
|
'reinstall': boolean;
|
|
7200
8388
|
}
|
|
8389
|
+
export interface PersonDeviceChangedEventData {
|
|
8390
|
+
/**
|
|
8391
|
+
* Always null for this event type.
|
|
8392
|
+
*/
|
|
8393
|
+
'previous_attributes': any | null;
|
|
8394
|
+
'object': DeviceChangeWebhookObject;
|
|
8395
|
+
}
|
|
7201
8396
|
export interface PersonInfoResponse {
|
|
7202
8397
|
'object'?: 'person';
|
|
7203
8398
|
'id': string;
|
|
@@ -7512,6 +8707,34 @@ export interface PreviousIdentitySecretInfo {
|
|
|
7512
8707
|
'stops_at': string;
|
|
7513
8708
|
'status': 'working' | 'stopped';
|
|
7514
8709
|
}
|
|
8710
|
+
/**
|
|
8711
|
+
* The result of a completed export request.
|
|
8712
|
+
*/
|
|
8713
|
+
export interface PrivacyExportResult {
|
|
8714
|
+
/**
|
|
8715
|
+
* A signed link to the JSON file with the subject's data.
|
|
8716
|
+
*/
|
|
8717
|
+
'download_url': string;
|
|
8718
|
+
/**
|
|
8719
|
+
* When the link stops working (Unix seconds).
|
|
8720
|
+
*/
|
|
8721
|
+
'expires_at': number;
|
|
8722
|
+
/**
|
|
8723
|
+
* Installs included.
|
|
8724
|
+
*/
|
|
8725
|
+
'installs': number;
|
|
8726
|
+
/**
|
|
8727
|
+
* Goal events included.
|
|
8728
|
+
*/
|
|
8729
|
+
'goal_name_events': number;
|
|
8730
|
+
}
|
|
8731
|
+
export interface PrivacyRequestEventData {
|
|
8732
|
+
/**
|
|
8733
|
+
* Always null for this event type.
|
|
8734
|
+
*/
|
|
8735
|
+
'previous_attributes': any | null;
|
|
8736
|
+
'object': PrivacyRequestInfoResponse;
|
|
8737
|
+
}
|
|
7515
8738
|
export interface PrivacyRequestInfoResponse {
|
|
7516
8739
|
'id': string;
|
|
7517
8740
|
'object'?: 'privacy_request';
|
|
@@ -7519,9 +8742,7 @@ export interface PrivacyRequestInfoResponse {
|
|
|
7519
8742
|
'type': string;
|
|
7520
8743
|
'subject_type': string;
|
|
7521
8744
|
'status': string;
|
|
7522
|
-
'result':
|
|
7523
|
-
[key: string]: any;
|
|
7524
|
-
} | null;
|
|
8745
|
+
'result': Result | null;
|
|
7525
8746
|
'error': string | null;
|
|
7526
8747
|
'created_at': string;
|
|
7527
8748
|
'completed_at': string | null;
|
|
@@ -7659,6 +8880,21 @@ export interface PushCredentialListResponse {
|
|
|
7659
8880
|
'object'?: 'list';
|
|
7660
8881
|
'data': Array<PushCredentialInfoResponse>;
|
|
7661
8882
|
}
|
|
8883
|
+
export interface PushCredentialsInvalidEventData {
|
|
8884
|
+
/**
|
|
8885
|
+
* Always null for this event type.
|
|
8886
|
+
*/
|
|
8887
|
+
'previous_attributes': any | null;
|
|
8888
|
+
'object': PushCredentialInfoResponse;
|
|
8889
|
+
/**
|
|
8890
|
+
* Why the push provider refused the credentials.
|
|
8891
|
+
*/
|
|
8892
|
+
'provider_reason': string;
|
|
8893
|
+
/**
|
|
8894
|
+
* The provider's HTTP status, when it answered.
|
|
8895
|
+
*/
|
|
8896
|
+
'http_status': number | null;
|
|
8897
|
+
}
|
|
7662
8898
|
export type PushProvider = 'apns' | 'fcm';
|
|
7663
8899
|
export interface PushTestResultResponse {
|
|
7664
8900
|
'object'?: 'push_test_result';
|
|
@@ -7921,6 +9157,33 @@ export interface ReadOnlyCredentialSchema {
|
|
|
7921
9157
|
'client_secret'?: string | null;
|
|
7922
9158
|
'prefix'?: string | null;
|
|
7923
9159
|
}
|
|
9160
|
+
export interface ReceiptEventData {
|
|
9161
|
+
/**
|
|
9162
|
+
* Always null for this event type.
|
|
9163
|
+
*/
|
|
9164
|
+
'previous_attributes': any | null;
|
|
9165
|
+
'object': ReceiptEventObject;
|
|
9166
|
+
}
|
|
9167
|
+
export interface ReceiptEventObject {
|
|
9168
|
+
'object': 'receipt';
|
|
9169
|
+
'id': string;
|
|
9170
|
+
'number': string;
|
|
9171
|
+
'payment_id': string;
|
|
9172
|
+
'invoice_id': string | null;
|
|
9173
|
+
'invoice_number': string | null;
|
|
9174
|
+
'currency': string;
|
|
9175
|
+
'amount_minor': number;
|
|
9176
|
+
'wht_minor': number;
|
|
9177
|
+
'issued_at': string;
|
|
9178
|
+
/**
|
|
9179
|
+
* `issued` or `void`.
|
|
9180
|
+
*/
|
|
9181
|
+
'status': string;
|
|
9182
|
+
/**
|
|
9183
|
+
* true for live-environment data, false for test mode.
|
|
9184
|
+
*/
|
|
9185
|
+
'livemode': boolean;
|
|
9186
|
+
}
|
|
7924
9187
|
/**
|
|
7925
9188
|
* Recent events of one type, newest first, in exactly the delivered envelope (same personal-data gating).
|
|
7926
9189
|
*/
|
|
@@ -7961,6 +9224,13 @@ export interface ReferralErrorInfo {
|
|
|
7961
9224
|
'code': string;
|
|
7962
9225
|
'message': string;
|
|
7963
9226
|
}
|
|
9227
|
+
export interface ReferralEventData {
|
|
9228
|
+
/**
|
|
9229
|
+
* Always null for this event type.
|
|
9230
|
+
*/
|
|
9231
|
+
'previous_attributes': any | null;
|
|
9232
|
+
'object': ReferralInfoResponse;
|
|
9233
|
+
}
|
|
7964
9234
|
/**
|
|
7965
9235
|
* A referral as the API and `referral.*` webhooks show it.
|
|
7966
9236
|
*/
|
|
@@ -7973,9 +9243,7 @@ export interface ReferralInfoResponse {
|
|
|
7973
9243
|
'source': string;
|
|
7974
9244
|
'match_type': string | null;
|
|
7975
9245
|
'current_step': number;
|
|
7976
|
-
'steps_completed': Array<
|
|
7977
|
-
[key: string]: any;
|
|
7978
|
-
}>;
|
|
9246
|
+
'steps_completed': Array<ReferralStepCompletedInfo>;
|
|
7979
9247
|
'step_deadline_at': string | null;
|
|
7980
9248
|
'hold_until': string | null;
|
|
7981
9249
|
'qualified_at': string | null;
|
|
@@ -7986,22 +9254,15 @@ export interface ReferralInfoResponse {
|
|
|
7986
9254
|
'reason_message'?: string | null;
|
|
7987
9255
|
'fraud_flags': Array<string>;
|
|
7988
9256
|
'referee_uninstalled_after_qualification': boolean;
|
|
7989
|
-
'program':
|
|
7990
|
-
|
|
7991
|
-
|
|
7992
|
-
'
|
|
7993
|
-
[key: string]: any;
|
|
7994
|
-
};
|
|
7995
|
-
'referee': {
|
|
7996
|
-
[key: string]: any;
|
|
7997
|
-
};
|
|
7998
|
-
'link': {
|
|
7999
|
-
[key: string]: any;
|
|
8000
|
-
} | null;
|
|
9257
|
+
'program': ReferralProgramRef;
|
|
9258
|
+
'referrer': ReferralReferrerRef;
|
|
9259
|
+
'referee': ReferralRefereeInfo;
|
|
9260
|
+
'link': ReferralLinkRef | null;
|
|
8001
9261
|
'click_id': string | null;
|
|
8002
|
-
|
|
8003
|
-
|
|
8004
|
-
|
|
9262
|
+
/**
|
|
9263
|
+
* The program's reward as it was when the referral qualified. Absent when there was none.
|
|
9264
|
+
*/
|
|
9265
|
+
'reward_snapshot'?: RewardInfoResponse | null;
|
|
8005
9266
|
'history'?: Array<ReferralStateChangeResponse> | null;
|
|
8006
9267
|
'created_at': string;
|
|
8007
9268
|
'updated_at': string;
|
|
@@ -8010,6 +9271,9 @@ export interface ReferralInfoResponse {
|
|
|
8010
9271
|
*/
|
|
8011
9272
|
'livemode': boolean;
|
|
8012
9273
|
}
|
|
9274
|
+
export interface ReferralLinkRef {
|
|
9275
|
+
'id': string;
|
|
9276
|
+
}
|
|
8013
9277
|
/**
|
|
8014
9278
|
* When a referral programme reward exists for the same goal: the partner earning replaces it, or both count.
|
|
8015
9279
|
*/
|
|
@@ -8041,9 +9305,10 @@ export interface ReferralProgramInfoResponse {
|
|
|
8041
9305
|
'fraud': {
|
|
8042
9306
|
[key: string]: any;
|
|
8043
9307
|
};
|
|
8044
|
-
|
|
8045
|
-
|
|
8046
|
-
|
|
9308
|
+
/**
|
|
9309
|
+
* Reward information for your records. Absent when the program has none.
|
|
9310
|
+
*/
|
|
9311
|
+
'reward'?: RewardInfoResponse | null;
|
|
8047
9312
|
'created_at': string;
|
|
8048
9313
|
'updated_at': string;
|
|
8049
9314
|
/**
|
|
@@ -8051,6 +9316,20 @@ export interface ReferralProgramInfoResponse {
|
|
|
8051
9316
|
*/
|
|
8052
9317
|
'livemode': boolean;
|
|
8053
9318
|
}
|
|
9319
|
+
export interface ReferralProgramRef {
|
|
9320
|
+
'id': string;
|
|
9321
|
+
'name': string;
|
|
9322
|
+
}
|
|
9323
|
+
export interface ReferralRefereeInfo {
|
|
9324
|
+
'install_id': string;
|
|
9325
|
+
'installation_id': string;
|
|
9326
|
+
'customer_user_id': string | null;
|
|
9327
|
+
}
|
|
9328
|
+
export interface ReferralReferrerRef {
|
|
9329
|
+
'id': string;
|
|
9330
|
+
'customer_user_id': string;
|
|
9331
|
+
'code': string;
|
|
9332
|
+
}
|
|
8054
9333
|
export interface ReferralStateChangeResponse {
|
|
8055
9334
|
'from_status': string | null;
|
|
8056
9335
|
'to_status': string;
|
|
@@ -8058,6 +9337,50 @@ export interface ReferralStateChangeResponse {
|
|
|
8058
9337
|
'actor': string;
|
|
8059
9338
|
'created_at': string;
|
|
8060
9339
|
}
|
|
9340
|
+
export interface ReferralStepCompletedEventData {
|
|
9341
|
+
/**
|
|
9342
|
+
* Always null for this event type.
|
|
9343
|
+
*/
|
|
9344
|
+
'previous_attributes': any | null;
|
|
9345
|
+
'object': ReferralInfoResponse;
|
|
9346
|
+
/**
|
|
9347
|
+
* The qualification step just completed (0 is the first).
|
|
9348
|
+
*/
|
|
9349
|
+
'step_index': number;
|
|
9350
|
+
/**
|
|
9351
|
+
* The step's goal key. Absent for identify steps.
|
|
9352
|
+
*/
|
|
9353
|
+
'goal'?: string;
|
|
9354
|
+
/**
|
|
9355
|
+
* true when the step is identifying the customer. Absent for goal steps.
|
|
9356
|
+
*/
|
|
9357
|
+
'identify'?: boolean;
|
|
9358
|
+
}
|
|
9359
|
+
/**
|
|
9360
|
+
* A qualification step the referee completed, in the order they were completed.
|
|
9361
|
+
*/
|
|
9362
|
+
export interface ReferralStepCompletedInfo {
|
|
9363
|
+
/**
|
|
9364
|
+
* The step's position in the program's qualification steps (0 is the first).
|
|
9365
|
+
*/
|
|
9366
|
+
'index': number;
|
|
9367
|
+
/**
|
|
9368
|
+
* The step's goal key. Absent for identify steps.
|
|
9369
|
+
*/
|
|
9370
|
+
'goal'?: string;
|
|
9371
|
+
/**
|
|
9372
|
+
* true for an identify step. Absent for goal steps.
|
|
9373
|
+
*/
|
|
9374
|
+
'identify'?: boolean;
|
|
9375
|
+
/**
|
|
9376
|
+
* When the step was completed (ISO 8601, UTC).
|
|
9377
|
+
*/
|
|
9378
|
+
'completed_at': string;
|
|
9379
|
+
/**
|
|
9380
|
+
* What completed it: `goal:<goal event id>` or `identify:<customer ID>`.
|
|
9381
|
+
*/
|
|
9382
|
+
'source_id'?: string | null;
|
|
9383
|
+
}
|
|
8061
9384
|
/**
|
|
8062
9385
|
* GET /v1/analytics/referrals/summary: one row per program.
|
|
8063
9386
|
*/
|
|
@@ -8079,6 +9402,13 @@ export interface ReferralSummaryResponse {
|
|
|
8079
9402
|
* an offline code, or a QR scan of the referral link.
|
|
8080
9403
|
*/
|
|
8081
9404
|
export type ReferralTrigger = 'link' | 'code_entry' | 'byo_code' | 'offline_code' | 'qr';
|
|
9405
|
+
export interface ReferrerEventData {
|
|
9406
|
+
/**
|
|
9407
|
+
* Always null for this event type.
|
|
9408
|
+
*/
|
|
9409
|
+
'previous_attributes': any | null;
|
|
9410
|
+
'object': ReferrerInfoResponse;
|
|
9411
|
+
}
|
|
8082
9412
|
export interface ReferrerInfoResponse {
|
|
8083
9413
|
'id': string;
|
|
8084
9414
|
'object'?: 'referrer';
|
|
@@ -8093,9 +9423,7 @@ export interface ReferrerInfoResponse {
|
|
|
8093
9423
|
'status': string;
|
|
8094
9424
|
'blocked_reason': string | null;
|
|
8095
9425
|
'blocked_at': string | null;
|
|
8096
|
-
'stats':
|
|
8097
|
-
[key: string]: any;
|
|
8098
|
-
};
|
|
9426
|
+
'stats': ReferrerStats;
|
|
8099
9427
|
'attributes'?: {
|
|
8100
9428
|
[key: string]: any;
|
|
8101
9429
|
};
|
|
@@ -8110,6 +9438,45 @@ export interface ReferrerInfoResponse {
|
|
|
8110
9438
|
*/
|
|
8111
9439
|
'livemode': boolean;
|
|
8112
9440
|
}
|
|
9441
|
+
export interface ReferrerQualityChangedEventData {
|
|
9442
|
+
/**
|
|
9443
|
+
* Always null for this event type.
|
|
9444
|
+
*/
|
|
9445
|
+
'previous_attributes': any | null;
|
|
9446
|
+
'object': ReferrerInfoResponse;
|
|
9447
|
+
/**
|
|
9448
|
+
* The band before this change (`good`, `watch` or `poor`); null for a referrer's first band.
|
|
9449
|
+
*/
|
|
9450
|
+
'previous_quality_band': string | null;
|
|
9451
|
+
}
|
|
9452
|
+
/**
|
|
9453
|
+
* The referrer's counters, refreshed regularly (not live).
|
|
9454
|
+
*/
|
|
9455
|
+
export interface ReferrerStats {
|
|
9456
|
+
/**
|
|
9457
|
+
* Referrals of any status.
|
|
9458
|
+
*/
|
|
9459
|
+
'installs': number;
|
|
9460
|
+
/**
|
|
9461
|
+
* Referrals past their first qualification step (rejected ones excluded).
|
|
9462
|
+
*/
|
|
9463
|
+
'signups': number;
|
|
9464
|
+
/**
|
|
9465
|
+
* Open referrals.
|
|
9466
|
+
*/
|
|
9467
|
+
'in_progress': number;
|
|
9468
|
+
'qualified': number;
|
|
9469
|
+
'disqualified': number;
|
|
9470
|
+
'rejected': number;
|
|
9471
|
+
/**
|
|
9472
|
+
* Human clicks on the referrer's link (code URLs count as the link).
|
|
9473
|
+
*/
|
|
9474
|
+
'clicks': number;
|
|
9475
|
+
/**
|
|
9476
|
+
* Share of referees (0 to 1) who uninstalled within 7 days; null when none is old enough yet. Absent until the counters are first refreshed.
|
|
9477
|
+
*/
|
|
9478
|
+
'referee_uninstall_rate_7d'?: number | null;
|
|
9479
|
+
}
|
|
8113
9480
|
/**
|
|
8114
9481
|
* "{n} calls were refused this week because the goal isn't set up: {top names}" (the last 7 days,
|
|
8115
9482
|
* Lagos time). Shown as soon as any call is refused, whether or not a goal has been counted.
|
|
@@ -8368,6 +9735,12 @@ export interface ResolveReportSchema {
|
|
|
8368
9735
|
'note'?: string | null;
|
|
8369
9736
|
}
|
|
8370
9737
|
export type ResponseReportConversionV1ConversionsPost = ConversionInfoResponse | GoalEventInfoResponse;
|
|
9738
|
+
/**
|
|
9739
|
+
* Set once the request has completed: the export's link, or the erasure's counts.
|
|
9740
|
+
*/
|
|
9741
|
+
export type Result = PrivacyExportResult | {
|
|
9742
|
+
[key: string]: number;
|
|
9743
|
+
};
|
|
8371
9744
|
export interface ResultPoint {
|
|
8372
9745
|
'day': string;
|
|
8373
9746
|
'variant_id': string;
|
|
@@ -8378,15 +9751,15 @@ export interface RetentionCohort {
|
|
|
8378
9751
|
'cohort': string;
|
|
8379
9752
|
'cohort_size': number;
|
|
8380
9753
|
'flagged_installs': number;
|
|
8381
|
-
'retained': Array<
|
|
8382
|
-
'retention': Array<
|
|
9754
|
+
'retained': Array<CurveInner>;
|
|
9755
|
+
'retention': Array<ChangePctValue>;
|
|
8383
9756
|
}
|
|
8384
9757
|
export type RetentionGrain = 'day' | 'week';
|
|
8385
9758
|
export interface RetentionGroup {
|
|
8386
9759
|
'key': string | null;
|
|
8387
9760
|
'cohort_size': number;
|
|
8388
9761
|
'flagged_installs': number;
|
|
8389
|
-
'retention': Array<
|
|
9762
|
+
'retention': Array<ChangePctValue>;
|
|
8390
9763
|
'cohorts': Array<RetentionCohort>;
|
|
8391
9764
|
}
|
|
8392
9765
|
export type RetentionGroupBy = 'none' | 'acquired_via' | 'campaign' | 'creator' | 'partner' | 'platform' | 'country';
|
|
@@ -8414,7 +9787,20 @@ export interface RetentionResponse {
|
|
|
8414
9787
|
export interface RetentionTotals {
|
|
8415
9788
|
'cohort_size': number;
|
|
8416
9789
|
'flagged_installs': number;
|
|
8417
|
-
'retention': Array<
|
|
9790
|
+
'retention': Array<ChangePctValue>;
|
|
9791
|
+
}
|
|
9792
|
+
export interface ReversalInfoResponse {
|
|
9793
|
+
'id': string;
|
|
9794
|
+
'object'?: 'conversion_reversal';
|
|
9795
|
+
'conversion_id': string;
|
|
9796
|
+
'amount_minor': number;
|
|
9797
|
+
'reason': string | null;
|
|
9798
|
+
'external_id': string | null;
|
|
9799
|
+
'created_at': string;
|
|
9800
|
+
/**
|
|
9801
|
+
* true for live-environment data, false for test mode.
|
|
9802
|
+
*/
|
|
9803
|
+
'livemode': boolean;
|
|
8418
9804
|
}
|
|
8419
9805
|
export interface ReverseConversionSchema {
|
|
8420
9806
|
'amount_minor'?: number | null;
|
|
@@ -8487,11 +9873,40 @@ export interface RewardInfo {
|
|
|
8487
9873
|
'referee'?: RewardSide | null;
|
|
8488
9874
|
'note'?: string | null;
|
|
8489
9875
|
}
|
|
9876
|
+
/**
|
|
9877
|
+
* Reward information, for your records only: Clikgate never pays rewards. Keys without a value are left out
|
|
9878
|
+
* (a side can be an empty object).
|
|
9879
|
+
*/
|
|
9880
|
+
export interface RewardInfoResponse {
|
|
9881
|
+
'referrer'?: RewardSideResponse;
|
|
9882
|
+
'referee'?: RewardSideResponse;
|
|
9883
|
+
/**
|
|
9884
|
+
* A note shown with the reward. Absent when not set.
|
|
9885
|
+
*/
|
|
9886
|
+
'note'?: string;
|
|
9887
|
+
}
|
|
8490
9888
|
export interface RewardSide {
|
|
8491
9889
|
'amount_minor'?: number | null;
|
|
8492
9890
|
'currency'?: string | null;
|
|
8493
9891
|
'description'?: string | null;
|
|
8494
9892
|
}
|
|
9893
|
+
/**
|
|
9894
|
+
* One side's reward. Keys without a value are left out.
|
|
9895
|
+
*/
|
|
9896
|
+
export interface RewardSideResponse {
|
|
9897
|
+
/**
|
|
9898
|
+
* The amount in minor units. Absent when not set.
|
|
9899
|
+
*/
|
|
9900
|
+
'amount_minor'?: number;
|
|
9901
|
+
/**
|
|
9902
|
+
* ISO 4217 code, present with `amount_minor`. Absent when not set.
|
|
9903
|
+
*/
|
|
9904
|
+
'currency'?: string;
|
|
9905
|
+
/**
|
|
9906
|
+
* The reward in words. Absent when not set.
|
|
9907
|
+
*/
|
|
9908
|
+
'description'?: string;
|
|
9909
|
+
}
|
|
8495
9910
|
/**
|
|
8496
9911
|
* What a rule (and its earnings) gives. `money` is paid in a payout; `credit` (an amount in the
|
|
8497
9912
|
* programme currency) and `gift` (a description) are applied by the business in its own system and end `applied`.
|
|
@@ -8601,6 +10016,13 @@ export interface SaleDetailResponse {
|
|
|
8601
10016
|
*/
|
|
8602
10017
|
'livemode': boolean;
|
|
8603
10018
|
}
|
|
10019
|
+
export interface SaleEventData {
|
|
10020
|
+
/**
|
|
10021
|
+
* Always null for this event type.
|
|
10022
|
+
*/
|
|
10023
|
+
'previous_attributes': any | null;
|
|
10024
|
+
'object': SaleInfoResponse;
|
|
10025
|
+
}
|
|
8604
10026
|
export interface SaleInfoResponse {
|
|
8605
10027
|
'id': string;
|
|
8606
10028
|
'object'?: 'sale';
|
|
@@ -8633,6 +10055,17 @@ export interface SaleInstallInfo {
|
|
|
8633
10055
|
'app_version': string | null;
|
|
8634
10056
|
'country': string | null;
|
|
8635
10057
|
}
|
|
10058
|
+
export interface SaleRefundedEventData {
|
|
10059
|
+
/**
|
|
10060
|
+
* Always null for this event type.
|
|
10061
|
+
*/
|
|
10062
|
+
'previous_attributes': any | null;
|
|
10063
|
+
'object': SaleInfoResponse;
|
|
10064
|
+
/**
|
|
10065
|
+
* The amount refunded by this event, in minor units.
|
|
10066
|
+
*/
|
|
10067
|
+
'refund_amount_minor': number;
|
|
10068
|
+
}
|
|
8636
10069
|
export interface SaleTimelineStep {
|
|
8637
10070
|
'kind': 'click' | 'install' | 'goal' | 'purchase' | 'refund';
|
|
8638
10071
|
'at': string;
|
|
@@ -9151,6 +10584,41 @@ export interface SignalInput {
|
|
|
9151
10584
|
'hash': string;
|
|
9152
10585
|
'verified'?: boolean;
|
|
9153
10586
|
}
|
|
10587
|
+
export interface SkanPostbackEventData {
|
|
10588
|
+
/**
|
|
10589
|
+
* Always null for this event type.
|
|
10590
|
+
*/
|
|
10591
|
+
'previous_attributes': any | null;
|
|
10592
|
+
'object': SkanPostbackInfoResponse;
|
|
10593
|
+
}
|
|
10594
|
+
export interface SkanPostbackInfoResponse {
|
|
10595
|
+
'id': string;
|
|
10596
|
+
'object'?: 'skan_postback';
|
|
10597
|
+
'app_id': string | null;
|
|
10598
|
+
'kind': string;
|
|
10599
|
+
'version': string | null;
|
|
10600
|
+
'ad_network_id': string | null;
|
|
10601
|
+
'source_identifier': string | null;
|
|
10602
|
+
'source_app_id': string | null;
|
|
10603
|
+
'source_domain': string | null;
|
|
10604
|
+
'fine_conversion_value': number | null;
|
|
10605
|
+
'coarse_conversion_value': string | null;
|
|
10606
|
+
'postback_sequence_index': number | null;
|
|
10607
|
+
'did_win': boolean | null;
|
|
10608
|
+
'redownload': boolean | null;
|
|
10609
|
+
'signature_verified': boolean;
|
|
10610
|
+
'source'?: string;
|
|
10611
|
+
'signature_ok'?: boolean | null;
|
|
10612
|
+
'schema_id': string | null;
|
|
10613
|
+
'decoded': {
|
|
10614
|
+
[key: string]: any;
|
|
10615
|
+
} | null;
|
|
10616
|
+
'received_at': string;
|
|
10617
|
+
/**
|
|
10618
|
+
* true for live-environment data, false for test mode.
|
|
10619
|
+
*/
|
|
10620
|
+
'livemode': boolean;
|
|
10621
|
+
}
|
|
9154
10622
|
export interface SkanReportResponse {
|
|
9155
10623
|
'object'?: 'skan_report';
|
|
9156
10624
|
'app_id': string;
|
|
@@ -9487,6 +10955,90 @@ export interface SubjectRef {
|
|
|
9487
10955
|
'id': string;
|
|
9488
10956
|
}
|
|
9489
10957
|
export type SubjectType = 'customer_user_id' | 'installation_id' | 'external_customer_id';
|
|
10958
|
+
export interface SubscriptionAddOnEventItem {
|
|
10959
|
+
'key': string;
|
|
10960
|
+
'name': string;
|
|
10961
|
+
'status': string;
|
|
10962
|
+
'quantity': number;
|
|
10963
|
+
/**
|
|
10964
|
+
* The add-on's price for the billing period; null on custom billing.
|
|
10965
|
+
*/
|
|
10966
|
+
'amount_minor': number | null;
|
|
10967
|
+
'ends_at': string | null;
|
|
10968
|
+
'remove_at_renewal': boolean;
|
|
10969
|
+
}
|
|
10970
|
+
export interface SubscriptionChangedEventData {
|
|
10971
|
+
'object': SubscriptionEventObject;
|
|
10972
|
+
'previous_attributes': SubscriptionChangedPreviousAttributes;
|
|
10973
|
+
}
|
|
10974
|
+
export interface SubscriptionChangedPreviousAttributes {
|
|
10975
|
+
/**
|
|
10976
|
+
* The plan of the subscription this one replaced.
|
|
10977
|
+
*/
|
|
10978
|
+
'plan_key': string;
|
|
10979
|
+
/**
|
|
10980
|
+
* That subscription's status.
|
|
10981
|
+
*/
|
|
10982
|
+
'status': string;
|
|
10983
|
+
}
|
|
10984
|
+
export interface SubscriptionEventData {
|
|
10985
|
+
/**
|
|
10986
|
+
* Always null for this event type.
|
|
10987
|
+
*/
|
|
10988
|
+
'previous_attributes': any | null;
|
|
10989
|
+
'object': SubscriptionEventObject;
|
|
10990
|
+
}
|
|
10991
|
+
export interface SubscriptionEventObject {
|
|
10992
|
+
'object': 'subscription';
|
|
10993
|
+
'id': string;
|
|
10994
|
+
'plan_key': string;
|
|
10995
|
+
'plan_name': string | null;
|
|
10996
|
+
'plan_version_id': string;
|
|
10997
|
+
'status': string;
|
|
10998
|
+
'billing_period': string;
|
|
10999
|
+
'currency': string;
|
|
11000
|
+
'amount_minor': number;
|
|
11001
|
+
'current_period_start': string;
|
|
11002
|
+
'current_period_end': string;
|
|
11003
|
+
'grace_until': string | null;
|
|
11004
|
+
'cancel_at': string | null;
|
|
11005
|
+
/**
|
|
11006
|
+
* true for live-environment data, false for test mode.
|
|
11007
|
+
*/
|
|
11008
|
+
'livemode': boolean;
|
|
11009
|
+
}
|
|
11010
|
+
export interface SubscriptionUpdatedEventData {
|
|
11011
|
+
/**
|
|
11012
|
+
* Always null for this event type.
|
|
11013
|
+
*/
|
|
11014
|
+
'previous_attributes': any | null;
|
|
11015
|
+
'object': SubscriptionWithAddOnsEventObject;
|
|
11016
|
+
/**
|
|
11017
|
+
* `add_on.activated`, `add_on.remove_at_renewal` or `add_on.quantity_changed`.
|
|
11018
|
+
*/
|
|
11019
|
+
'change': string;
|
|
11020
|
+
'add_on_key': string;
|
|
11021
|
+
}
|
|
11022
|
+
export interface SubscriptionWithAddOnsEventObject {
|
|
11023
|
+
'object': 'subscription';
|
|
11024
|
+
'id': string;
|
|
11025
|
+
'plan_key': string;
|
|
11026
|
+
'plan_name': string | null;
|
|
11027
|
+
'plan_version_id': string;
|
|
11028
|
+
'status': string;
|
|
11029
|
+
'billing_period': string;
|
|
11030
|
+
'currency': string;
|
|
11031
|
+
'amount_minor': number;
|
|
11032
|
+
'current_period_start': string;
|
|
11033
|
+
'current_period_end': string;
|
|
11034
|
+
'grace_until': string | null;
|
|
11035
|
+
'cancel_at': string | null;
|
|
11036
|
+
'add_ons': Array<SubscriptionAddOnEventItem>;
|
|
11037
|
+
/**
|
|
11038
|
+
* true for live-environment data, false for test mode.
|
|
11039
|
+
*/
|
|
11040
|
+
'livemode': boolean;
|
|
11041
|
+
}
|
|
9490
11042
|
/**
|
|
9491
11043
|
* One proposed group: its name, the ungrouped goals it would take, and the existing group of that name if any.
|
|
9492
11044
|
*/
|
|
@@ -9749,6 +11301,48 @@ export interface TravelledResponse {
|
|
|
9749
11301
|
'shared_as': SharedAs;
|
|
9750
11302
|
'clicks': number;
|
|
9751
11303
|
}
|
|
11304
|
+
export type TrendInner = CustomerCostPeriod;
|
|
11305
|
+
export interface TrialEventData {
|
|
11306
|
+
/**
|
|
11307
|
+
* Always null for this event type.
|
|
11308
|
+
*/
|
|
11309
|
+
'previous_attributes': any | null;
|
|
11310
|
+
'object': TrialSubscriptionEventObject;
|
|
11311
|
+
}
|
|
11312
|
+
export interface TrialEventInfo {
|
|
11313
|
+
'id': string;
|
|
11314
|
+
'plan_key': string;
|
|
11315
|
+
'status': string;
|
|
11316
|
+
'started_at': string;
|
|
11317
|
+
'ends_at': string;
|
|
11318
|
+
}
|
|
11319
|
+
/**
|
|
11320
|
+
* The trial's subscription (its keys are absent when the trial has none) and the trial's dates.
|
|
11321
|
+
*/
|
|
11322
|
+
export interface TrialSubscriptionEventObject {
|
|
11323
|
+
'object': 'subscription';
|
|
11324
|
+
'id'?: string | null;
|
|
11325
|
+
'plan_key'?: string | null;
|
|
11326
|
+
'plan_name'?: string | null;
|
|
11327
|
+
'plan_version_id'?: string | null;
|
|
11328
|
+
'status'?: string | null;
|
|
11329
|
+
'billing_period'?: string | null;
|
|
11330
|
+
'currency'?: string | null;
|
|
11331
|
+
'amount_minor'?: number | null;
|
|
11332
|
+
'current_period_start'?: string | null;
|
|
11333
|
+
'current_period_end'?: string | null;
|
|
11334
|
+
'grace_until'?: string | null;
|
|
11335
|
+
'cancel_at'?: string | null;
|
|
11336
|
+
'trial': TrialEventInfo;
|
|
11337
|
+
/**
|
|
11338
|
+
* The trial's new end (`subscription.trial_extended` only).
|
|
11339
|
+
*/
|
|
11340
|
+
'new_end'?: string | null;
|
|
11341
|
+
/**
|
|
11342
|
+
* true for live-environment data, false for test mode.
|
|
11343
|
+
*/
|
|
11344
|
+
'livemode': boolean;
|
|
11345
|
+
}
|
|
9752
11346
|
export interface TrophyBand {
|
|
9753
11347
|
'key': string;
|
|
9754
11348
|
'label': string;
|
|
@@ -10534,13 +12128,40 @@ export interface UsageInfoResponse {
|
|
|
10534
12128
|
'livemode'?: boolean;
|
|
10535
12129
|
'plan': string;
|
|
10536
12130
|
'limits': {
|
|
10537
|
-
[key: string]:
|
|
12131
|
+
[key: string]: CurveInner;
|
|
10538
12132
|
};
|
|
10539
12133
|
'data': Array<UsageDayResponse>;
|
|
10540
12134
|
'totals': {
|
|
10541
12135
|
[key: string]: number;
|
|
10542
12136
|
};
|
|
10543
12137
|
}
|
|
12138
|
+
export interface UsageThresholdEventData {
|
|
12139
|
+
/**
|
|
12140
|
+
* Always null for this event type.
|
|
12141
|
+
*/
|
|
12142
|
+
'previous_attributes': any | null;
|
|
12143
|
+
'object': UsageThresholdEventObject;
|
|
12144
|
+
}
|
|
12145
|
+
export interface UsageThresholdEventObject {
|
|
12146
|
+
'object': 'usage_threshold';
|
|
12147
|
+
'meter': string;
|
|
12148
|
+
/**
|
|
12149
|
+
* 80 or 100.
|
|
12150
|
+
*/
|
|
12151
|
+
'percent': number;
|
|
12152
|
+
'allowance': number | null;
|
|
12153
|
+
'used': number;
|
|
12154
|
+
'period_start': string;
|
|
12155
|
+
'plan_key': string;
|
|
12156
|
+
/**
|
|
12157
|
+
* Whether usage above the allowance is billed as extra usage.
|
|
12158
|
+
*/
|
|
12159
|
+
'overage_priced': boolean;
|
|
12160
|
+
/**
|
|
12161
|
+
* true for live-environment data, false for test mode.
|
|
12162
|
+
*/
|
|
12163
|
+
'livemode': boolean;
|
|
12164
|
+
}
|
|
10544
12165
|
export type ValidationMessagesInnerValue = number | string;
|
|
10545
12166
|
/**
|
|
10546
12167
|
* Normal units, never minor units (₦2,000,000 is 2000000; decimals allowed up to the currency's ISO 4217 exponent): a JSON number or a numeric string, ≥ 0, at most 15 significant digits.
|
|
@@ -10631,6 +12252,13 @@ export interface WebhookDeliveryListResponse {
|
|
|
10631
12252
|
'object'?: 'list';
|
|
10632
12253
|
'data': Array<WebhookDeliveryInfoResponse>;
|
|
10633
12254
|
}
|
|
12255
|
+
export interface WebhookEndpointEventData {
|
|
12256
|
+
/**
|
|
12257
|
+
* Always null for this event type.
|
|
12258
|
+
*/
|
|
12259
|
+
'previous_attributes': any | null;
|
|
12260
|
+
'object': WebhookEndpointInfoResponse;
|
|
12261
|
+
}
|
|
10634
12262
|
export interface WebhookEndpointInfoResponse {
|
|
10635
12263
|
'id': string;
|
|
10636
12264
|
'object'?: 'webhook_endpoint';
|
|
@@ -10654,6 +12282,16 @@ export interface WebhookEndpointInfoResponse {
|
|
|
10654
12282
|
*/
|
|
10655
12283
|
'livemode': boolean;
|
|
10656
12284
|
}
|
|
12285
|
+
export interface WebhookTestEventData {
|
|
12286
|
+
/**
|
|
12287
|
+
* Always null for this event type.
|
|
12288
|
+
*/
|
|
12289
|
+
'previous_attributes': any | null;
|
|
12290
|
+
'object': WebhookTestEventObject;
|
|
12291
|
+
}
|
|
12292
|
+
export interface WebhookTestEventObject {
|
|
12293
|
+
'message': 'test';
|
|
12294
|
+
}
|
|
10657
12295
|
/**
|
|
10658
12296
|
* This month's installs from banner taps (organisation timezone), shown as "no ad spend".
|
|
10659
12297
|
*/
|
|
@@ -10757,6 +12395,13 @@ export interface WhatsappContactSchema {
|
|
|
10757
12395
|
'phone_e164'?: string | null;
|
|
10758
12396
|
'contact_hash'?: string | null;
|
|
10759
12397
|
}
|
|
12398
|
+
export interface WhatsappConversationAttributedEventData {
|
|
12399
|
+
/**
|
|
12400
|
+
* Always null for this event type.
|
|
12401
|
+
*/
|
|
12402
|
+
'previous_attributes': any | null;
|
|
12403
|
+
'object': WhatsappConversationWebhookObject;
|
|
12404
|
+
}
|
|
10760
12405
|
export interface WhatsappConversationInfoResponse {
|
|
10761
12406
|
'id': string;
|
|
10762
12407
|
'object'?: 'whatsapp_conversation';
|
|
@@ -10781,6 +12426,34 @@ export interface WhatsappConversationInfoResponse {
|
|
|
10781
12426
|
*/
|
|
10782
12427
|
'livemode': boolean;
|
|
10783
12428
|
}
|
|
12429
|
+
/**
|
|
12430
|
+
* The conversation, with the full keyed contact hash so it can be sent back with conversions.
|
|
12431
|
+
*/
|
|
12432
|
+
export interface WhatsappConversationWebhookObject {
|
|
12433
|
+
'id': string;
|
|
12434
|
+
'object'?: 'whatsapp_conversation';
|
|
12435
|
+
'channel_id': string;
|
|
12436
|
+
'contact_hash_prefix': string;
|
|
12437
|
+
'ref': string | null;
|
|
12438
|
+
'click_id': string | null;
|
|
12439
|
+
'link_id': string | null;
|
|
12440
|
+
'campaign_id': string | null;
|
|
12441
|
+
'attributed': boolean;
|
|
12442
|
+
'attribution_method': string;
|
|
12443
|
+
'first_message_at': string;
|
|
12444
|
+
'last_message_at': string | null;
|
|
12445
|
+
'created_at': string;
|
|
12446
|
+
'ad_platform'?: string | null;
|
|
12447
|
+
'ad_id'?: string | null;
|
|
12448
|
+
'ad_adset_id'?: string | null;
|
|
12449
|
+
'ad_campaign_id'?: string | null;
|
|
12450
|
+
'ad_referral_at'?: string | null;
|
|
12451
|
+
'contact_hash': string;
|
|
12452
|
+
/**
|
|
12453
|
+
* true for live-environment data, false for test mode.
|
|
12454
|
+
*/
|
|
12455
|
+
'livemode': boolean;
|
|
12456
|
+
}
|
|
10784
12457
|
export interface WinnerSignalResponse {
|
|
10785
12458
|
'status': string;
|
|
10786
12459
|
'message': string;
|