@hermeticacomms/sdk-node 0.0.0-stage → 0.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/LICENSE +9 -0
- package/README.md +12 -2
- package/dist/contracts/analytics.d.ts +405 -0
- package/dist/contracts/analytics.js +77 -0
- package/dist/contracts/auth.d.ts +359 -0
- package/dist/contracts/auth.js +121 -0
- package/dist/contracts/billing.d.ts +141 -0
- package/dist/contracts/billing.js +31 -0
- package/dist/contracts/campaigns.d.ts +918 -0
- package/dist/contracts/campaigns.js +269 -0
- package/dist/contracts/common.d.ts +57 -0
- package/dist/contracts/common.js +35 -0
- package/dist/contracts/connectors.d.ts +179 -0
- package/dist/contracts/connectors.js +46 -0
- package/dist/contracts/consent.d.ts +604 -0
- package/dist/contracts/consent.js +180 -0
- package/dist/contracts/content-blocks.d.ts +164 -0
- package/dist/contracts/content-blocks.js +60 -0
- package/dist/contracts/content-library.d.ts +339 -0
- package/dist/contracts/content-library.js +50 -0
- package/dist/contracts/content.d.ts +949 -0
- package/dist/contracts/content.js +192 -0
- package/dist/contracts/delivery.d.ts +599 -0
- package/dist/contracts/delivery.js +214 -0
- package/dist/contracts/events.d.ts +513 -0
- package/dist/contracts/events.js +178 -0
- package/dist/contracts/experiments.d.ts +376 -0
- package/dist/contracts/experiments.js +136 -0
- package/dist/contracts/identity.d.ts +756 -0
- package/dist/contracts/identity.js +225 -0
- package/dist/contracts/index.d.ts +15 -0
- package/dist/contracts/index.js +15 -0
- package/dist/contracts/integrations.d.ts +381 -0
- package/dist/contracts/integrations.js +112 -0
- package/dist/contracts/leads.d.ts +733 -0
- package/dist/contracts/leads.js +125 -0
- package/dist/contracts/metrics.d.ts +460 -0
- package/dist/contracts/metrics.js +90 -0
- package/dist/contracts/outbound.d.ts +15510 -0
- package/dist/contracts/outbound.js +423 -0
- package/dist/contracts/pickers.d.ts +12 -0
- package/dist/contracts/pickers.js +20 -0
- package/dist/contracts/platform-admin.d.ts +230 -0
- package/dist/contracts/platform-admin.js +91 -0
- package/dist/contracts/postcards.d.ts +79 -0
- package/dist/contracts/postcards.js +29 -0
- package/dist/contracts/push.d.ts +530 -0
- package/dist/contracts/push.js +102 -0
- package/dist/contracts/rcs.d.ts +39 -0
- package/dist/contracts/rcs.js +19 -0
- package/dist/contracts/segments.d.ts +3182 -0
- package/dist/contracts/segments.js +416 -0
- package/dist/contracts/workflow-nodes.d.ts +2118 -0
- package/dist/contracts/workflow-nodes.js +341 -0
- package/dist/contracts/workflows.d.ts +46413 -0
- package/dist/contracts/workflows.js +341 -0
- package/dist/contracts/x10-platform.d.ts +2603 -0
- package/dist/contracts/x10-platform.js +129 -0
- package/dist/http.d.ts +30 -0
- package/dist/http.js +65 -0
- package/dist/index.d.ts +11507 -0
- package/dist/index.js +63 -0
- package/dist/platform.d.ts +163 -0
- package/dist/platform.js +40 -0
- package/dist/resources.d.ts +1318 -0
- package/dist/resources.js +56 -0
- package/dist/signature.d.ts +5 -0
- package/dist/signature.js +19 -0
- package/dist/x10.d.ts +1607 -0
- package/dist/x10.js +66 -0
- package/dist/z10.d.ts +251 -0
- package/dist/z10.js +46 -0
- package/package.json +40 -4
|
@@ -0,0 +1,513 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
export declare const STANDARD_EVENTS: readonly ['page_view', 'page_exit', 'form_view', 'form_submit', 'product_view', 'search', 'add_to_cart', 'remove_from_cart', 'checkout_started', 'purchase', 'identify'];
|
|
3
|
+
export declare const EventSource: z.ZodEnum<{
|
|
4
|
+
browser: "browser";
|
|
5
|
+
integration: "integration";
|
|
6
|
+
server: "server";
|
|
7
|
+
system: "system";
|
|
8
|
+
}>;
|
|
9
|
+
export type EventSource = z.infer<typeof EventSource>;
|
|
10
|
+
/** The only `$` names a client may send: reported by the mobile/web SDKs (push opens, geofences). Everything else with `$` is reserved for the system. */
|
|
11
|
+
export declare const CLIENT_RESERVED_EVENTS: readonly ['$opened_push', '$geofence_enter', '$geofence_exit', '$geofence_dwell'];
|
|
12
|
+
export declare const EventContext: z.ZodObject<{
|
|
13
|
+
page: z.ZodOptional<z.ZodObject<{
|
|
14
|
+
url: z.ZodOptional<z.ZodString>;
|
|
15
|
+
referrer: z.ZodOptional<z.ZodString>;
|
|
16
|
+
title: z.ZodOptional<z.ZodString>;
|
|
17
|
+
}, z.core.$strip>>;
|
|
18
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
19
|
+
ip: z.ZodOptional<z.ZodString>;
|
|
20
|
+
utm: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
export declare const EventProfile: z.ZodObject<{
|
|
23
|
+
email: z.ZodOptional<z.ZodString>;
|
|
24
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
25
|
+
externalId: z.ZodOptional<z.ZodString>;
|
|
26
|
+
}, z.core.$strip>;
|
|
27
|
+
/** The event's person: identifiers plus profile data written inline (names, location, custom properties). */
|
|
28
|
+
export declare const EventProfileData: z.ZodObject<{
|
|
29
|
+
email: z.ZodOptional<z.ZodString>;
|
|
30
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
31
|
+
externalId: z.ZodOptional<z.ZodString>;
|
|
32
|
+
firstName: z.ZodOptional<z.ZodString>;
|
|
33
|
+
lastName: z.ZodOptional<z.ZodString>;
|
|
34
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
35
|
+
location: z.ZodOptional<z.ZodObject<{
|
|
36
|
+
city: z.ZodOptional<z.ZodString>;
|
|
37
|
+
region: z.ZodOptional<z.ZodString>;
|
|
38
|
+
country: z.ZodOptional<z.ZodString>;
|
|
39
|
+
zip: z.ZodOptional<z.ZodString>;
|
|
40
|
+
address1: z.ZodOptional<z.ZodString>;
|
|
41
|
+
latitude: z.ZodOptional<z.ZodNumber>;
|
|
42
|
+
longitude: z.ZodOptional<z.ZodNumber>;
|
|
43
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
44
|
+
}, z.core.$strip>>;
|
|
45
|
+
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
46
|
+
}, z.core.$strip>;
|
|
47
|
+
export declare const IngestEvent: z.ZodObject<{
|
|
48
|
+
name: z.ZodString;
|
|
49
|
+
app: z.ZodOptional<z.ZodString>;
|
|
50
|
+
occurredAt: z.ZodOptional<z.ZodISODateTime>;
|
|
51
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
52
|
+
value: z.ZodOptional<z.ZodNumber>;
|
|
53
|
+
amount: z.ZodOptional<z.ZodNumber>;
|
|
54
|
+
currency: z.ZodOptional<z.ZodString>;
|
|
55
|
+
dedupeKey: z.ZodOptional<z.ZodString>;
|
|
56
|
+
profile: z.ZodOptional<z.ZodObject<{
|
|
57
|
+
email: z.ZodOptional<z.ZodString>;
|
|
58
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
59
|
+
externalId: z.ZodOptional<z.ZodString>;
|
|
60
|
+
firstName: z.ZodOptional<z.ZodString>;
|
|
61
|
+
lastName: z.ZodOptional<z.ZodString>;
|
|
62
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
63
|
+
location: z.ZodOptional<z.ZodObject<{
|
|
64
|
+
city: z.ZodOptional<z.ZodString>;
|
|
65
|
+
region: z.ZodOptional<z.ZodString>;
|
|
66
|
+
country: z.ZodOptional<z.ZodString>;
|
|
67
|
+
zip: z.ZodOptional<z.ZodString>;
|
|
68
|
+
address1: z.ZodOptional<z.ZodString>;
|
|
69
|
+
latitude: z.ZodOptional<z.ZodNumber>;
|
|
70
|
+
longitude: z.ZodOptional<z.ZodNumber>;
|
|
71
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
72
|
+
}, z.core.$strip>>;
|
|
73
|
+
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
74
|
+
}, z.core.$strip>>;
|
|
75
|
+
correlationKey: z.ZodOptional<z.ZodString>;
|
|
76
|
+
correlationValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
77
|
+
anonymousId: z.ZodOptional<z.ZodString>;
|
|
78
|
+
context: z.ZodOptional<z.ZodObject<{
|
|
79
|
+
page: z.ZodOptional<z.ZodObject<{
|
|
80
|
+
url: z.ZodOptional<z.ZodString>;
|
|
81
|
+
referrer: z.ZodOptional<z.ZodString>;
|
|
82
|
+
title: z.ZodOptional<z.ZodString>;
|
|
83
|
+
}, z.core.$strip>>;
|
|
84
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
85
|
+
ip: z.ZodOptional<z.ZodString>;
|
|
86
|
+
utm: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
87
|
+
}, z.core.$strip>>;
|
|
88
|
+
}, z.core.$strip>;
|
|
89
|
+
export type IngestEvent = z.infer<typeof IngestEvent>;
|
|
90
|
+
export declare const IngestEventChecked: z.ZodObject<{
|
|
91
|
+
name: z.ZodString;
|
|
92
|
+
app: z.ZodOptional<z.ZodString>;
|
|
93
|
+
occurredAt: z.ZodOptional<z.ZodISODateTime>;
|
|
94
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
95
|
+
value: z.ZodOptional<z.ZodNumber>;
|
|
96
|
+
amount: z.ZodOptional<z.ZodNumber>;
|
|
97
|
+
currency: z.ZodOptional<z.ZodString>;
|
|
98
|
+
dedupeKey: z.ZodOptional<z.ZodString>;
|
|
99
|
+
profile: z.ZodOptional<z.ZodObject<{
|
|
100
|
+
email: z.ZodOptional<z.ZodString>;
|
|
101
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
102
|
+
externalId: z.ZodOptional<z.ZodString>;
|
|
103
|
+
firstName: z.ZodOptional<z.ZodString>;
|
|
104
|
+
lastName: z.ZodOptional<z.ZodString>;
|
|
105
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
106
|
+
location: z.ZodOptional<z.ZodObject<{
|
|
107
|
+
city: z.ZodOptional<z.ZodString>;
|
|
108
|
+
region: z.ZodOptional<z.ZodString>;
|
|
109
|
+
country: z.ZodOptional<z.ZodString>;
|
|
110
|
+
zip: z.ZodOptional<z.ZodString>;
|
|
111
|
+
address1: z.ZodOptional<z.ZodString>;
|
|
112
|
+
latitude: z.ZodOptional<z.ZodNumber>;
|
|
113
|
+
longitude: z.ZodOptional<z.ZodNumber>;
|
|
114
|
+
timezone: z.ZodOptional<z.ZodString>;
|
|
115
|
+
}, z.core.$strip>>;
|
|
116
|
+
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
117
|
+
}, z.core.$strip>>;
|
|
118
|
+
correlationKey: z.ZodOptional<z.ZodString>;
|
|
119
|
+
correlationValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
120
|
+
anonymousId: z.ZodOptional<z.ZodString>;
|
|
121
|
+
context: z.ZodOptional<z.ZodObject<{
|
|
122
|
+
page: z.ZodOptional<z.ZodObject<{
|
|
123
|
+
url: z.ZodOptional<z.ZodString>;
|
|
124
|
+
referrer: z.ZodOptional<z.ZodString>;
|
|
125
|
+
title: z.ZodOptional<z.ZodString>;
|
|
126
|
+
}, z.core.$strip>>;
|
|
127
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
128
|
+
ip: z.ZodOptional<z.ZodString>;
|
|
129
|
+
utm: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
130
|
+
}, z.core.$strip>>;
|
|
131
|
+
}, z.core.$strip>;
|
|
132
|
+
/** Batch bodies keep items opaque so one bad event is rejected individually, not the whole request. */
|
|
133
|
+
export declare const BatchConsent: z.ZodObject<{
|
|
134
|
+
analytics: z.ZodOptional<z.ZodBoolean>;
|
|
135
|
+
marketing: z.ZodOptional<z.ZodBoolean>;
|
|
136
|
+
}, z.core.$strip>;
|
|
137
|
+
export type BatchConsent = z.infer<typeof BatchConsent>;
|
|
138
|
+
export declare const IngestBatchBody: z.ZodObject<{
|
|
139
|
+
events: z.ZodArray<z.ZodUnknown>;
|
|
140
|
+
consent: z.ZodOptional<z.ZodObject<{
|
|
141
|
+
analytics: z.ZodOptional<z.ZodBoolean>;
|
|
142
|
+
marketing: z.ZodOptional<z.ZodBoolean>;
|
|
143
|
+
}, z.core.$strip>>;
|
|
144
|
+
}, z.core.$strip>;
|
|
145
|
+
export declare const IngestResult: z.ZodObject<{
|
|
146
|
+
accepted: z.ZodNumber;
|
|
147
|
+
duplicates: z.ZodNumber;
|
|
148
|
+
rejected: z.ZodArray<z.ZodObject<{
|
|
149
|
+
index: z.ZodNumber;
|
|
150
|
+
reason: z.ZodString;
|
|
151
|
+
}, z.core.$strip>>;
|
|
152
|
+
}, z.core.$strip>;
|
|
153
|
+
export declare const IdentifyBody: z.ZodObject<{
|
|
154
|
+
anonymousId: z.ZodString;
|
|
155
|
+
identifiers: z.ZodObject<{
|
|
156
|
+
email: z.ZodOptional<z.ZodString>;
|
|
157
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
158
|
+
externalId: z.ZodOptional<z.ZodString>;
|
|
159
|
+
}, z.core.$strip>;
|
|
160
|
+
traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
161
|
+
consent: z.ZodOptional<z.ZodObject<{
|
|
162
|
+
analytics: z.ZodOptional<z.ZodBoolean>;
|
|
163
|
+
marketing: z.ZodOptional<z.ZodBoolean>;
|
|
164
|
+
}, z.core.$strip>>;
|
|
165
|
+
signature: z.ZodOptional<z.ZodString>;
|
|
166
|
+
}, z.core.$strip>;
|
|
167
|
+
export declare const IdentifyResult: z.ZodObject<{
|
|
168
|
+
profileId: z.ZodUUID;
|
|
169
|
+
created: z.ZodBoolean;
|
|
170
|
+
}, z.core.$strip>;
|
|
171
|
+
export declare const EventRecord: z.ZodObject<{
|
|
172
|
+
id: z.ZodUUID;
|
|
173
|
+
name: z.ZodString;
|
|
174
|
+
profileId: z.ZodNullable<z.ZodUUID>;
|
|
175
|
+
anonymousId: z.ZodNullable<z.ZodString>;
|
|
176
|
+
occurredAt: z.ZodISODateTime;
|
|
177
|
+
source: z.ZodEnum<{
|
|
178
|
+
browser: "browser";
|
|
179
|
+
integration: "integration";
|
|
180
|
+
server: "server";
|
|
181
|
+
system: "system";
|
|
182
|
+
}>;
|
|
183
|
+
properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
184
|
+
value: z.ZodNullable<z.ZodNumber>;
|
|
185
|
+
currency: z.ZodNullable<z.ZodString>;
|
|
186
|
+
metric: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
187
|
+
name: z.ZodString;
|
|
188
|
+
category: z.ZodString;
|
|
189
|
+
goal: z.ZodBoolean;
|
|
190
|
+
}, z.core.$strip>>>;
|
|
191
|
+
profile: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
192
|
+
id: z.ZodUUID;
|
|
193
|
+
email: z.ZodNullable<z.ZodString>;
|
|
194
|
+
firstName: z.ZodNullable<z.ZodString>;
|
|
195
|
+
lastName: z.ZodNullable<z.ZodString>;
|
|
196
|
+
}, z.core.$strip>>>;
|
|
197
|
+
}, z.core.$strip>;
|
|
198
|
+
export declare const ProfileEventsQuery: z.ZodObject<{
|
|
199
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
200
|
+
cursor: z.ZodOptional<z.ZodUUID>;
|
|
201
|
+
name: z.ZodOptional<z.ZodString>;
|
|
202
|
+
goal: z.ZodOptional<z.ZodPipe<z.ZodEnum<{
|
|
203
|
+
false: "false";
|
|
204
|
+
true: "true";
|
|
205
|
+
}>, z.ZodTransform<boolean, "false" | "true">>>;
|
|
206
|
+
}, z.core.$strip>;
|
|
207
|
+
export declare const EventPage: z.ZodObject<{
|
|
208
|
+
items: z.ZodArray<z.ZodObject<{
|
|
209
|
+
id: z.ZodUUID;
|
|
210
|
+
name: z.ZodString;
|
|
211
|
+
profileId: z.ZodNullable<z.ZodUUID>;
|
|
212
|
+
anonymousId: z.ZodNullable<z.ZodString>;
|
|
213
|
+
occurredAt: z.ZodISODateTime;
|
|
214
|
+
source: z.ZodEnum<{
|
|
215
|
+
browser: "browser";
|
|
216
|
+
integration: "integration";
|
|
217
|
+
server: "server";
|
|
218
|
+
system: "system";
|
|
219
|
+
}>;
|
|
220
|
+
properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
221
|
+
value: z.ZodNullable<z.ZodNumber>;
|
|
222
|
+
currency: z.ZodNullable<z.ZodString>;
|
|
223
|
+
metric: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
224
|
+
name: z.ZodString;
|
|
225
|
+
category: z.ZodString;
|
|
226
|
+
goal: z.ZodBoolean;
|
|
227
|
+
}, z.core.$strip>>>;
|
|
228
|
+
profile: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
229
|
+
id: z.ZodUUID;
|
|
230
|
+
email: z.ZodNullable<z.ZodString>;
|
|
231
|
+
firstName: z.ZodNullable<z.ZodString>;
|
|
232
|
+
lastName: z.ZodNullable<z.ZodString>;
|
|
233
|
+
}, z.core.$strip>>>;
|
|
234
|
+
}, z.core.$strip>>;
|
|
235
|
+
nextCursor: z.ZodNullable<z.ZodUUID>;
|
|
236
|
+
}, z.core.$strip>;
|
|
237
|
+
export declare const EventDefinitionRecord: z.ZodObject<{
|
|
238
|
+
id: z.ZodUUID;
|
|
239
|
+
name: z.ZodString;
|
|
240
|
+
category: z.ZodEnum<{
|
|
241
|
+
custom: "custom";
|
|
242
|
+
standard: "standard";
|
|
243
|
+
}>;
|
|
244
|
+
schema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
245
|
+
enforce: z.ZodBoolean;
|
|
246
|
+
goal: z.ZodBoolean;
|
|
247
|
+
firstSeenAt: z.ZodISODateTime;
|
|
248
|
+
lastSeenAt: z.ZodISODateTime;
|
|
249
|
+
}, z.core.$strip>;
|
|
250
|
+
export declare const EventDefinitionList: z.ZodObject<{
|
|
251
|
+
items: z.ZodArray<z.ZodObject<{
|
|
252
|
+
id: z.ZodUUID;
|
|
253
|
+
name: z.ZodString;
|
|
254
|
+
category: z.ZodEnum<{
|
|
255
|
+
custom: "custom";
|
|
256
|
+
standard: "standard";
|
|
257
|
+
}>;
|
|
258
|
+
schema: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
259
|
+
enforce: z.ZodBoolean;
|
|
260
|
+
goal: z.ZodBoolean;
|
|
261
|
+
firstSeenAt: z.ZodISODateTime;
|
|
262
|
+
lastSeenAt: z.ZodISODateTime;
|
|
263
|
+
}, z.core.$strip>>;
|
|
264
|
+
}, z.core.$strip>;
|
|
265
|
+
export declare const EventPropertyType: z.ZodEnum<{
|
|
266
|
+
array: "array";
|
|
267
|
+
boolean: "boolean";
|
|
268
|
+
number: "number";
|
|
269
|
+
object: "object";
|
|
270
|
+
string: "string";
|
|
271
|
+
}>;
|
|
272
|
+
export declare const EventDefinitionName: z.ZodObject<{
|
|
273
|
+
name: z.ZodString;
|
|
274
|
+
}, z.core.$strip>;
|
|
275
|
+
export declare const EventPropertyParams: z.ZodObject<{
|
|
276
|
+
name: z.ZodString;
|
|
277
|
+
prop: z.ZodString;
|
|
278
|
+
}, z.core.$strip>;
|
|
279
|
+
export declare const CreateEventDefinition: z.ZodObject<{
|
|
280
|
+
name: z.ZodString;
|
|
281
|
+
schema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<{
|
|
282
|
+
array: "array";
|
|
283
|
+
boolean: "boolean";
|
|
284
|
+
number: "number";
|
|
285
|
+
object: "object";
|
|
286
|
+
string: "string";
|
|
287
|
+
}>>>;
|
|
288
|
+
}, z.core.$strip>;
|
|
289
|
+
export declare const SetEventProperty: z.ZodObject<{
|
|
290
|
+
type: z.ZodEnum<{
|
|
291
|
+
array: "array";
|
|
292
|
+
boolean: "boolean";
|
|
293
|
+
number: "number";
|
|
294
|
+
object: "object";
|
|
295
|
+
string: "string";
|
|
296
|
+
}>;
|
|
297
|
+
}, z.core.$strip>;
|
|
298
|
+
export declare const UpdateEventDefinition: z.ZodObject<{
|
|
299
|
+
schema: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodEnum<{
|
|
300
|
+
array: "array";
|
|
301
|
+
boolean: "boolean";
|
|
302
|
+
number: "number";
|
|
303
|
+
object: "object";
|
|
304
|
+
string: "string";
|
|
305
|
+
}>>>>;
|
|
306
|
+
enforce: z.ZodOptional<z.ZodBoolean>;
|
|
307
|
+
goal: z.ZodOptional<z.ZodBoolean>;
|
|
308
|
+
}, z.core.$strip>;
|
|
309
|
+
/** Segment/RudderStack-compatible single-call payload (`/ingest/v1/segment`). */
|
|
310
|
+
export declare const SegmentCall: z.ZodObject<{
|
|
311
|
+
type: z.ZodEnum<{
|
|
312
|
+
identify: "identify";
|
|
313
|
+
page: "page";
|
|
314
|
+
screen: "screen";
|
|
315
|
+
track: "track";
|
|
316
|
+
}>;
|
|
317
|
+
event: z.ZodOptional<z.ZodString>;
|
|
318
|
+
name: z.ZodOptional<z.ZodString>;
|
|
319
|
+
userId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
320
|
+
anonymousId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
321
|
+
messageId: z.ZodOptional<z.ZodString>;
|
|
322
|
+
timestamp: z.ZodOptional<z.ZodString>;
|
|
323
|
+
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
324
|
+
traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
325
|
+
context: z.ZodOptional<z.ZodObject<{
|
|
326
|
+
traits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
327
|
+
userAgent: z.ZodOptional<z.ZodString>;
|
|
328
|
+
ip: z.ZodOptional<z.ZodString>;
|
|
329
|
+
page: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
330
|
+
}, z.core.$loose>>;
|
|
331
|
+
consent: z.ZodOptional<z.ZodObject<{
|
|
332
|
+
analytics: z.ZodOptional<z.ZodBoolean>;
|
|
333
|
+
marketing: z.ZodOptional<z.ZodBoolean>;
|
|
334
|
+
}, z.core.$strip>>;
|
|
335
|
+
}, z.core.$strip>;
|
|
336
|
+
export type SegmentCall = z.infer<typeof SegmentCall>;
|
|
337
|
+
export declare const CreateSiteConfig: z.ZodObject<{
|
|
338
|
+
siteKeyId: z.ZodString;
|
|
339
|
+
consentMode: z.ZodDefault<z.ZodEnum<{
|
|
340
|
+
open: "open";
|
|
341
|
+
require_consent: "require_consent";
|
|
342
|
+
}>>;
|
|
343
|
+
botFilter: z.ZodDefault<z.ZodBoolean>;
|
|
344
|
+
domains: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
345
|
+
trustBrowserRevenue: z.ZodDefault<z.ZodBoolean>;
|
|
346
|
+
retentionDays: z.ZodOptional<z.ZodNumber>;
|
|
347
|
+
}, z.core.$strip>;
|
|
348
|
+
export type CreateSiteConfig = z.input<typeof CreateSiteConfig>;
|
|
349
|
+
export declare const SdkConsentMode: z.ZodEnum<{
|
|
350
|
+
none: "none";
|
|
351
|
+
"opt-out": "opt-out";
|
|
352
|
+
"require-consent": "require-consent";
|
|
353
|
+
}>;
|
|
354
|
+
/**
|
|
355
|
+
* Per-site browser SDK settings, served to the snippet by GET /ingest/v1/config (`remoteConfig: true`). Options passed in code still
|
|
356
|
+
* win. Defaults are the SDK's own defaults; consent mode, region rules and identify rules are also enforced at ingest.
|
|
357
|
+
*/
|
|
358
|
+
export declare const SiteSdkSettings: z.ZodObject<{
|
|
359
|
+
consentMode: z.ZodDefault<z.ZodEnum<{
|
|
360
|
+
none: "none";
|
|
361
|
+
"opt-out": "opt-out";
|
|
362
|
+
"require-consent": "require-consent";
|
|
363
|
+
}>>;
|
|
364
|
+
regions: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
365
|
+
countries: z.ZodArray<z.ZodString>;
|
|
366
|
+
consentMode: z.ZodEnum<{
|
|
367
|
+
none: "none";
|
|
368
|
+
"opt-out": "opt-out";
|
|
369
|
+
"require-consent": "require-consent";
|
|
370
|
+
}>;
|
|
371
|
+
}, z.core.$strip>>>;
|
|
372
|
+
bufferUntilConsent: z.ZodDefault<z.ZodBoolean>;
|
|
373
|
+
autoPageViews: z.ZodDefault<z.ZodBoolean>;
|
|
374
|
+
pageViewRoutes: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
375
|
+
stripQuery: z.ZodDefault<z.ZodBoolean>;
|
|
376
|
+
allowParams: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
377
|
+
identify: z.ZodDefault<z.ZodObject<{
|
|
378
|
+
email: z.ZodDefault<z.ZodBoolean>;
|
|
379
|
+
phone: z.ZodDefault<z.ZodBoolean>;
|
|
380
|
+
externalId: z.ZodDefault<z.ZodBoolean>;
|
|
381
|
+
}, z.core.$strip>>;
|
|
382
|
+
requireSignedIdentify: z.ZodDefault<z.ZodBoolean>;
|
|
383
|
+
batchSize: z.ZodDefault<z.ZodNumber>;
|
|
384
|
+
flushMs: z.ZodDefault<z.ZodNumber>;
|
|
385
|
+
maxQueue: z.ZodDefault<z.ZodNumber>;
|
|
386
|
+
autocapture: z.ZodDefault<z.ZodBoolean>;
|
|
387
|
+
trackVideo: z.ZodDefault<z.ZodBoolean>;
|
|
388
|
+
}, z.core.$strip>;
|
|
389
|
+
export type SiteSdkSettings = z.infer<typeof SiteSdkSettings>;
|
|
390
|
+
/** GET/PUT /v1/sites/:id/settings: the SDK settings plus the server-side ingest switches of the site. */
|
|
391
|
+
export declare const SiteSettingsDto: z.ZodObject<{
|
|
392
|
+
consentMode: z.ZodDefault<z.ZodEnum<{
|
|
393
|
+
none: "none";
|
|
394
|
+
"opt-out": "opt-out";
|
|
395
|
+
"require-consent": "require-consent";
|
|
396
|
+
}>>;
|
|
397
|
+
regions: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
398
|
+
countries: z.ZodArray<z.ZodString>;
|
|
399
|
+
consentMode: z.ZodEnum<{
|
|
400
|
+
none: "none";
|
|
401
|
+
"opt-out": "opt-out";
|
|
402
|
+
"require-consent": "require-consent";
|
|
403
|
+
}>;
|
|
404
|
+
}, z.core.$strip>>>;
|
|
405
|
+
bufferUntilConsent: z.ZodDefault<z.ZodBoolean>;
|
|
406
|
+
autoPageViews: z.ZodDefault<z.ZodBoolean>;
|
|
407
|
+
pageViewRoutes: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
408
|
+
stripQuery: z.ZodDefault<z.ZodBoolean>;
|
|
409
|
+
allowParams: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
410
|
+
identify: z.ZodDefault<z.ZodObject<{
|
|
411
|
+
email: z.ZodDefault<z.ZodBoolean>;
|
|
412
|
+
phone: z.ZodDefault<z.ZodBoolean>;
|
|
413
|
+
externalId: z.ZodDefault<z.ZodBoolean>;
|
|
414
|
+
}, z.core.$strip>>;
|
|
415
|
+
requireSignedIdentify: z.ZodDefault<z.ZodBoolean>;
|
|
416
|
+
batchSize: z.ZodDefault<z.ZodNumber>;
|
|
417
|
+
flushMs: z.ZodDefault<z.ZodNumber>;
|
|
418
|
+
maxQueue: z.ZodDefault<z.ZodNumber>;
|
|
419
|
+
autocapture: z.ZodDefault<z.ZodBoolean>;
|
|
420
|
+
trackVideo: z.ZodDefault<z.ZodBoolean>;
|
|
421
|
+
botFilter: z.ZodBoolean;
|
|
422
|
+
trustBrowserRevenue: z.ZodBoolean;
|
|
423
|
+
identitySecretSet: z.ZodBoolean;
|
|
424
|
+
}, z.core.$strip>;
|
|
425
|
+
export declare const SiteSettingsBody: z.ZodObject<{
|
|
426
|
+
consentMode: z.ZodDefault<z.ZodEnum<{
|
|
427
|
+
none: "none";
|
|
428
|
+
"opt-out": "opt-out";
|
|
429
|
+
"require-consent": "require-consent";
|
|
430
|
+
}>>;
|
|
431
|
+
regions: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
432
|
+
countries: z.ZodArray<z.ZodString>;
|
|
433
|
+
consentMode: z.ZodEnum<{
|
|
434
|
+
none: "none";
|
|
435
|
+
"opt-out": "opt-out";
|
|
436
|
+
"require-consent": "require-consent";
|
|
437
|
+
}>;
|
|
438
|
+
}, z.core.$strip>>>;
|
|
439
|
+
bufferUntilConsent: z.ZodDefault<z.ZodBoolean>;
|
|
440
|
+
autoPageViews: z.ZodDefault<z.ZodBoolean>;
|
|
441
|
+
pageViewRoutes: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
442
|
+
stripQuery: z.ZodDefault<z.ZodBoolean>;
|
|
443
|
+
allowParams: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
444
|
+
identify: z.ZodDefault<z.ZodObject<{
|
|
445
|
+
email: z.ZodDefault<z.ZodBoolean>;
|
|
446
|
+
phone: z.ZodDefault<z.ZodBoolean>;
|
|
447
|
+
externalId: z.ZodDefault<z.ZodBoolean>;
|
|
448
|
+
}, z.core.$strip>>;
|
|
449
|
+
requireSignedIdentify: z.ZodDefault<z.ZodBoolean>;
|
|
450
|
+
batchSize: z.ZodDefault<z.ZodNumber>;
|
|
451
|
+
flushMs: z.ZodDefault<z.ZodNumber>;
|
|
452
|
+
maxQueue: z.ZodDefault<z.ZodNumber>;
|
|
453
|
+
autocapture: z.ZodDefault<z.ZodBoolean>;
|
|
454
|
+
trackVideo: z.ZodDefault<z.ZodBoolean>;
|
|
455
|
+
botFilter: z.ZodDefault<z.ZodBoolean>;
|
|
456
|
+
trustBrowserRevenue: z.ZodDefault<z.ZodBoolean>;
|
|
457
|
+
}, z.core.$strip>;
|
|
458
|
+
/** GET /ingest/v1/config: what the snippet applies; `consentMode` is already resolved for the visitor's region. */
|
|
459
|
+
export declare const SdkRemoteConfig: z.ZodObject<{
|
|
460
|
+
consentMode: z.ZodDefault<z.ZodEnum<{
|
|
461
|
+
none: "none";
|
|
462
|
+
"opt-out": "opt-out";
|
|
463
|
+
"require-consent": "require-consent";
|
|
464
|
+
}>>;
|
|
465
|
+
bufferUntilConsent: z.ZodDefault<z.ZodBoolean>;
|
|
466
|
+
autoPageViews: z.ZodDefault<z.ZodBoolean>;
|
|
467
|
+
pageViewRoutes: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
468
|
+
stripQuery: z.ZodDefault<z.ZodBoolean>;
|
|
469
|
+
allowParams: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
470
|
+
identify: z.ZodDefault<z.ZodObject<{
|
|
471
|
+
email: z.ZodDefault<z.ZodBoolean>;
|
|
472
|
+
phone: z.ZodDefault<z.ZodBoolean>;
|
|
473
|
+
externalId: z.ZodDefault<z.ZodBoolean>;
|
|
474
|
+
}, z.core.$strip>>;
|
|
475
|
+
requireSignedIdentify: z.ZodDefault<z.ZodBoolean>;
|
|
476
|
+
batchSize: z.ZodDefault<z.ZodNumber>;
|
|
477
|
+
flushMs: z.ZodDefault<z.ZodNumber>;
|
|
478
|
+
maxQueue: z.ZodDefault<z.ZodNumber>;
|
|
479
|
+
autocapture: z.ZodDefault<z.ZodBoolean>;
|
|
480
|
+
trackVideo: z.ZodDefault<z.ZodBoolean>;
|
|
481
|
+
}, z.core.$strip>;
|
|
482
|
+
/** The identity secret, shown once; signing identities with it is done on the site's server, never in the browser. */
|
|
483
|
+
export declare const SiteIdentitySecret: z.ZodObject<{
|
|
484
|
+
secret: z.ZodString;
|
|
485
|
+
createdAt: z.ZodString;
|
|
486
|
+
}, z.core.$strip>;
|
|
487
|
+
/** POST /ingest/v1/test: each event checked as the batch endpoint would, nothing stored. */
|
|
488
|
+
export declare const IngestTestResult: z.ZodObject<{
|
|
489
|
+
consent: z.ZodObject<{
|
|
490
|
+
ok: z.ZodBoolean;
|
|
491
|
+
reason: z.ZodOptional<z.ZodString>;
|
|
492
|
+
consentMode: z.ZodEnum<{
|
|
493
|
+
none: "none";
|
|
494
|
+
"opt-out": "opt-out";
|
|
495
|
+
"require-consent": "require-consent";
|
|
496
|
+
}>;
|
|
497
|
+
}, z.core.$strip>;
|
|
498
|
+
items: z.ZodArray<z.ZodObject<{
|
|
499
|
+
index: z.ZodNumber;
|
|
500
|
+
name: z.ZodNullable<z.ZodString>;
|
|
501
|
+
ok: z.ZodBoolean;
|
|
502
|
+
issues: z.ZodArray<z.ZodString>;
|
|
503
|
+
}, z.core.$strip>>;
|
|
504
|
+
}, z.core.$strip>;
|
|
505
|
+
/** Workspace-wide ingest settings: the server ingest switch and the custom field used as each person's primary key. */
|
|
506
|
+
export declare const EventSettingsDto: z.ZodObject<{
|
|
507
|
+
serverIngestEnabled: z.ZodBoolean;
|
|
508
|
+
primaryKeyAttribute: z.ZodNullable<z.ZodString>;
|
|
509
|
+
}, z.core.$strip>;
|
|
510
|
+
export declare const UpdateEventSettingsBody: z.ZodObject<{
|
|
511
|
+
serverIngestEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
512
|
+
primaryKeyAttribute: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
513
|
+
}, z.core.$strip>;
|