@hermeticacomms/sdk-node 0.0.0-stage → 0.4.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 +363 -0
- package/dist/contracts/auth.js +130 -0
- package/dist/contracts/billing.d.ts +143 -0
- package/dist/contracts/billing.js +32 -0
- package/dist/contracts/campaigns.d.ts +915 -0
- package/dist/contracts/campaigns.js +276 -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 +628 -0
- package/dist/contracts/consent.js +194 -0
- package/dist/contracts/content-blocks.d.ts +165 -0
- package/dist/contracts/content-blocks.js +62 -0
- package/dist/contracts/content-library.d.ts +347 -0
- package/dist/contracts/content-library.js +52 -0
- package/dist/contracts/content.d.ts +955 -0
- package/dist/contracts/content.js +194 -0
- package/dist/contracts/delivery.d.ts +602 -0
- package/dist/contracts/delivery.js +220 -0
- package/dist/contracts/events.d.ts +514 -0
- package/dist/contracts/events.js +180 -0
- package/dist/contracts/experiments.d.ts +378 -0
- package/dist/contracts/experiments.js +140 -0
- package/dist/contracts/identity.d.ts +761 -0
- package/dist/contracts/identity.js +226 -0
- package/dist/contracts/index.d.ts +15 -0
- package/dist/contracts/index.js +15 -0
- package/dist/contracts/integrations.d.ts +445 -0
- package/dist/contracts/integrations.js +139 -0
- package/dist/contracts/leads.d.ts +733 -0
- package/dist/contracts/leads.js +125 -0
- package/dist/contracts/metrics.d.ts +465 -0
- package/dist/contracts/metrics.js +96 -0
- package/dist/contracts/outbound.d.ts +15535 -0
- package/dist/contracts/outbound.js +432 -0
- package/dist/contracts/pickers.d.ts +12 -0
- package/dist/contracts/pickers.js +20 -0
- package/dist/contracts/platform-admin.d.ts +244 -0
- package/dist/contracts/platform-admin.js +98 -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 +3187 -0
- package/dist/contracts/segments.js +421 -0
- package/dist/contracts/workflow-nodes.d.ts +2130 -0
- package/dist/contracts/workflow-nodes.js +346 -0
- package/dist/contracts/workflows.d.ts +46811 -0
- package/dist/contracts/workflows.js +350 -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 +11631 -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 +1338 -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 +1608 -0
- package/dist/x10.js +66 -0
- package/dist/z10.d.ts +256 -0
- package/dist/z10.js +46 -0
- package/package.json +40 -4
|
@@ -0,0 +1,530 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
export declare const PushPlatform: z.ZodEnum<{
|
|
3
|
+
android: "android";
|
|
4
|
+
ios: "ios";
|
|
5
|
+
web: "web";
|
|
6
|
+
}>;
|
|
7
|
+
export type PushPlatform = z.infer<typeof PushPlatform>;
|
|
8
|
+
export declare const PushVendor: z.ZodEnum<{
|
|
9
|
+
apns: "apns";
|
|
10
|
+
expo: "expo";
|
|
11
|
+
fcm: "fcm";
|
|
12
|
+
web_push: "web_push";
|
|
13
|
+
}>;
|
|
14
|
+
export type PushVendor = z.infer<typeof PushVendor>;
|
|
15
|
+
export declare const PushEnvironment: z.ZodEnum<{
|
|
16
|
+
production: "production";
|
|
17
|
+
sandbox: "sandbox";
|
|
18
|
+
}>;
|
|
19
|
+
export type PushEnvironment = z.infer<typeof PushEnvironment>;
|
|
20
|
+
export declare const PushEnablement: z.ZodEnum<{
|
|
21
|
+
AUTHORIZED: "AUTHORIZED";
|
|
22
|
+
DENIED: "DENIED";
|
|
23
|
+
NOT_DETERMINED: "NOT_DETERMINED";
|
|
24
|
+
PROVISIONAL: "PROVISIONAL";
|
|
25
|
+
UNAUTHORIZED: "UNAUTHORIZED";
|
|
26
|
+
}>;
|
|
27
|
+
export type PushEnablement = z.infer<typeof PushEnablement>;
|
|
28
|
+
export declare const PushBackground: z.ZodEnum<{
|
|
29
|
+
AVAILABLE: "AVAILABLE";
|
|
30
|
+
DENIED: "DENIED";
|
|
31
|
+
RESTRICTED: "RESTRICTED";
|
|
32
|
+
}>;
|
|
33
|
+
export type PushBackground = z.infer<typeof PushBackground>;
|
|
34
|
+
export declare const PushDeviceMetadata: z.ZodObject<{
|
|
35
|
+
device_id: z.ZodOptional<z.ZodString>;
|
|
36
|
+
klaviyo_sdk: z.ZodOptional<z.ZodString>;
|
|
37
|
+
sdk_version: z.ZodOptional<z.ZodString>;
|
|
38
|
+
device_model: z.ZodOptional<z.ZodString>;
|
|
39
|
+
os_name: z.ZodOptional<z.ZodString>;
|
|
40
|
+
os_version: z.ZodOptional<z.ZodString>;
|
|
41
|
+
app_name: z.ZodOptional<z.ZodString>;
|
|
42
|
+
app_version: z.ZodOptional<z.ZodString>;
|
|
43
|
+
app_build: z.ZodOptional<z.ZodString>;
|
|
44
|
+
app_id: z.ZodOptional<z.ZodString>;
|
|
45
|
+
environment: z.ZodOptional<z.ZodPreprocess<z.ZodEnum<{
|
|
46
|
+
production: "production";
|
|
47
|
+
sandbox: "sandbox";
|
|
48
|
+
}>, unknown>>;
|
|
49
|
+
}, z.core.$loose>;
|
|
50
|
+
export type PushDeviceMetadata = z.infer<typeof PushDeviceMetadata>;
|
|
51
|
+
/** Who the device belongs to; at least one key is needed. Several may be sent: they all resolve to one profile. */
|
|
52
|
+
export declare const PushProfileRef: z.ZodObject<{
|
|
53
|
+
data: z.ZodObject<{
|
|
54
|
+
type: z.ZodOptional<z.ZodLiteral<"profile">>;
|
|
55
|
+
attributes: z.ZodObject<{
|
|
56
|
+
email: z.ZodOptional<z.ZodString>;
|
|
57
|
+
phone_number: z.ZodOptional<z.ZodString>;
|
|
58
|
+
external_id: z.ZodOptional<z.ZodString>;
|
|
59
|
+
anonymous_id: z.ZodOptional<z.ZodString>;
|
|
60
|
+
}, z.core.$strip>;
|
|
61
|
+
}, z.core.$strip>;
|
|
62
|
+
}, z.core.$strip>;
|
|
63
|
+
/** POST /client/push-tokens (Klaviyo's JSON:API shape). Web push: vendor web_push, token = the JSON-serialised PushSubscription. */
|
|
64
|
+
export declare const ClientPushTokenBody: z.ZodObject<{
|
|
65
|
+
data: z.ZodObject<{
|
|
66
|
+
type: z.ZodOptional<z.ZodLiteral<"push-token">>;
|
|
67
|
+
attributes: z.ZodObject<{
|
|
68
|
+
token: z.ZodString;
|
|
69
|
+
platform: z.ZodPreprocess<z.ZodEnum<{
|
|
70
|
+
android: "android";
|
|
71
|
+
ios: "ios";
|
|
72
|
+
web: "web";
|
|
73
|
+
}>, unknown>;
|
|
74
|
+
vendor: z.ZodPreprocess<z.ZodEnum<{
|
|
75
|
+
apns: "apns";
|
|
76
|
+
expo: "expo";
|
|
77
|
+
fcm: "fcm";
|
|
78
|
+
web_push: "web_push";
|
|
79
|
+
}>, unknown>;
|
|
80
|
+
enablement_status: z.ZodDefault<z.ZodPreprocess<z.ZodEnum<{
|
|
81
|
+
AUTHORIZED: "AUTHORIZED";
|
|
82
|
+
DENIED: "DENIED";
|
|
83
|
+
NOT_DETERMINED: "NOT_DETERMINED";
|
|
84
|
+
PROVISIONAL: "PROVISIONAL";
|
|
85
|
+
UNAUTHORIZED: "UNAUTHORIZED";
|
|
86
|
+
}>, unknown>>;
|
|
87
|
+
background: z.ZodDefault<z.ZodPreprocess<z.ZodEnum<{
|
|
88
|
+
AVAILABLE: "AVAILABLE";
|
|
89
|
+
DENIED: "DENIED";
|
|
90
|
+
RESTRICTED: "RESTRICTED";
|
|
91
|
+
}>, unknown>>;
|
|
92
|
+
device_metadata: z.ZodDefault<z.ZodObject<{
|
|
93
|
+
device_id: z.ZodOptional<z.ZodString>;
|
|
94
|
+
klaviyo_sdk: z.ZodOptional<z.ZodString>;
|
|
95
|
+
sdk_version: z.ZodOptional<z.ZodString>;
|
|
96
|
+
device_model: z.ZodOptional<z.ZodString>;
|
|
97
|
+
os_name: z.ZodOptional<z.ZodString>;
|
|
98
|
+
os_version: z.ZodOptional<z.ZodString>;
|
|
99
|
+
app_name: z.ZodOptional<z.ZodString>;
|
|
100
|
+
app_version: z.ZodOptional<z.ZodString>;
|
|
101
|
+
app_build: z.ZodOptional<z.ZodString>;
|
|
102
|
+
app_id: z.ZodOptional<z.ZodString>;
|
|
103
|
+
environment: z.ZodOptional<z.ZodPreprocess<z.ZodEnum<{
|
|
104
|
+
production: "production";
|
|
105
|
+
sandbox: "sandbox";
|
|
106
|
+
}>, unknown>>;
|
|
107
|
+
}, z.core.$loose>>;
|
|
108
|
+
profile: z.ZodObject<{
|
|
109
|
+
data: z.ZodObject<{
|
|
110
|
+
type: z.ZodOptional<z.ZodLiteral<"profile">>;
|
|
111
|
+
attributes: z.ZodObject<{
|
|
112
|
+
email: z.ZodOptional<z.ZodString>;
|
|
113
|
+
phone_number: z.ZodOptional<z.ZodString>;
|
|
114
|
+
external_id: z.ZodOptional<z.ZodString>;
|
|
115
|
+
anonymous_id: z.ZodOptional<z.ZodString>;
|
|
116
|
+
}, z.core.$strip>;
|
|
117
|
+
}, z.core.$strip>;
|
|
118
|
+
}, z.core.$strip>;
|
|
119
|
+
}, z.core.$strip>;
|
|
120
|
+
}, z.core.$strip>;
|
|
121
|
+
}, z.core.$strip>;
|
|
122
|
+
export type ClientPushTokenBody = z.infer<typeof ClientPushTokenBody>;
|
|
123
|
+
/** POST /client/push-token-unregister: same envelope, only token + vendor + profile matter. */
|
|
124
|
+
export declare const ClientPushUnregisterBody: z.ZodObject<{
|
|
125
|
+
data: z.ZodObject<{
|
|
126
|
+
type: z.ZodOptional<z.ZodEnum<{
|
|
127
|
+
"push-token": "push-token";
|
|
128
|
+
"push-token-unregister": "push-token-unregister";
|
|
129
|
+
}>>;
|
|
130
|
+
attributes: z.ZodObject<{
|
|
131
|
+
token: z.ZodString;
|
|
132
|
+
platform: z.ZodOptional<z.ZodPreprocess<z.ZodEnum<{
|
|
133
|
+
android: "android";
|
|
134
|
+
ios: "ios";
|
|
135
|
+
web: "web";
|
|
136
|
+
}>, unknown>>;
|
|
137
|
+
vendor: z.ZodPreprocess<z.ZodEnum<{
|
|
138
|
+
apns: "apns";
|
|
139
|
+
expo: "expo";
|
|
140
|
+
fcm: "fcm";
|
|
141
|
+
web_push: "web_push";
|
|
142
|
+
}>, unknown>;
|
|
143
|
+
profile: z.ZodOptional<z.ZodObject<{
|
|
144
|
+
data: z.ZodObject<{
|
|
145
|
+
type: z.ZodOptional<z.ZodLiteral<"profile">>;
|
|
146
|
+
attributes: z.ZodObject<{
|
|
147
|
+
email: z.ZodOptional<z.ZodString>;
|
|
148
|
+
phone_number: z.ZodOptional<z.ZodString>;
|
|
149
|
+
external_id: z.ZodOptional<z.ZodString>;
|
|
150
|
+
anonymous_id: z.ZodOptional<z.ZodString>;
|
|
151
|
+
}, z.core.$strip>;
|
|
152
|
+
}, z.core.$strip>;
|
|
153
|
+
}, z.core.$strip>>;
|
|
154
|
+
}, z.core.$strip>;
|
|
155
|
+
}, z.core.$strip>;
|
|
156
|
+
}, z.core.$strip>;
|
|
157
|
+
export type ClientPushUnregisterBody = z.infer<typeof ClientPushUnregisterBody>;
|
|
158
|
+
export declare const ClientPushConfigQuery: z.ZodObject<{
|
|
159
|
+
company_id: z.ZodOptional<z.ZodString>;
|
|
160
|
+
k: z.ZodOptional<z.ZodString>;
|
|
161
|
+
}, z.core.$strip>;
|
|
162
|
+
export declare const PushConfigDto: z.ZodObject<{
|
|
163
|
+
vapidPublicKey: z.ZodNullable<z.ZodString>;
|
|
164
|
+
}, z.core.$strip>;
|
|
165
|
+
export declare const PushTokenDto: z.ZodObject<{
|
|
166
|
+
id: z.ZodUUID;
|
|
167
|
+
profileId: z.ZodUUID;
|
|
168
|
+
token: z.ZodString;
|
|
169
|
+
platform: z.ZodEnum<{
|
|
170
|
+
android: "android";
|
|
171
|
+
ios: "ios";
|
|
172
|
+
web: "web";
|
|
173
|
+
}>;
|
|
174
|
+
vendor: z.ZodEnum<{
|
|
175
|
+
apns: "apns";
|
|
176
|
+
expo: "expo";
|
|
177
|
+
fcm: "fcm";
|
|
178
|
+
web_push: "web_push";
|
|
179
|
+
}>;
|
|
180
|
+
appId: z.ZodNullable<z.ZodString>;
|
|
181
|
+
environment: z.ZodEnum<{
|
|
182
|
+
production: "production";
|
|
183
|
+
sandbox: "sandbox";
|
|
184
|
+
}>;
|
|
185
|
+
enablementStatus: z.ZodEnum<{
|
|
186
|
+
AUTHORIZED: "AUTHORIZED";
|
|
187
|
+
DENIED: "DENIED";
|
|
188
|
+
NOT_DETERMINED: "NOT_DETERMINED";
|
|
189
|
+
PROVISIONAL: "PROVISIONAL";
|
|
190
|
+
UNAUTHORIZED: "UNAUTHORIZED";
|
|
191
|
+
}>;
|
|
192
|
+
background: z.ZodEnum<{
|
|
193
|
+
AVAILABLE: "AVAILABLE";
|
|
194
|
+
DENIED: "DENIED";
|
|
195
|
+
RESTRICTED: "RESTRICTED";
|
|
196
|
+
}>;
|
|
197
|
+
deviceMetadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
198
|
+
lastSeenAt: z.ZodISODateTime;
|
|
199
|
+
invalidatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
200
|
+
invalidReason: z.ZodNullable<z.ZodString>;
|
|
201
|
+
createdAt: z.ZodISODateTime;
|
|
202
|
+
}, z.core.$strip>;
|
|
203
|
+
export type PushTokenDto = z.infer<typeof PushTokenDto>;
|
|
204
|
+
export declare const PushTokenPage: z.ZodObject<{
|
|
205
|
+
items: z.ZodArray<z.ZodObject<{
|
|
206
|
+
id: z.ZodUUID;
|
|
207
|
+
profileId: z.ZodUUID;
|
|
208
|
+
token: z.ZodString;
|
|
209
|
+
platform: z.ZodEnum<{
|
|
210
|
+
android: "android";
|
|
211
|
+
ios: "ios";
|
|
212
|
+
web: "web";
|
|
213
|
+
}>;
|
|
214
|
+
vendor: z.ZodEnum<{
|
|
215
|
+
apns: "apns";
|
|
216
|
+
expo: "expo";
|
|
217
|
+
fcm: "fcm";
|
|
218
|
+
web_push: "web_push";
|
|
219
|
+
}>;
|
|
220
|
+
appId: z.ZodNullable<z.ZodString>;
|
|
221
|
+
environment: z.ZodEnum<{
|
|
222
|
+
production: "production";
|
|
223
|
+
sandbox: "sandbox";
|
|
224
|
+
}>;
|
|
225
|
+
enablementStatus: z.ZodEnum<{
|
|
226
|
+
AUTHORIZED: "AUTHORIZED";
|
|
227
|
+
DENIED: "DENIED";
|
|
228
|
+
NOT_DETERMINED: "NOT_DETERMINED";
|
|
229
|
+
PROVISIONAL: "PROVISIONAL";
|
|
230
|
+
UNAUTHORIZED: "UNAUTHORIZED";
|
|
231
|
+
}>;
|
|
232
|
+
background: z.ZodEnum<{
|
|
233
|
+
AVAILABLE: "AVAILABLE";
|
|
234
|
+
DENIED: "DENIED";
|
|
235
|
+
RESTRICTED: "RESTRICTED";
|
|
236
|
+
}>;
|
|
237
|
+
deviceMetadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
238
|
+
lastSeenAt: z.ZodISODateTime;
|
|
239
|
+
invalidatedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
240
|
+
invalidReason: z.ZodNullable<z.ZodString>;
|
|
241
|
+
createdAt: z.ZodISODateTime;
|
|
242
|
+
}, z.core.$strip>>;
|
|
243
|
+
nextCursor: z.ZodNullable<z.ZodUUID>;
|
|
244
|
+
}, z.core.$strip>;
|
|
245
|
+
export declare const PushTokenListQuery: z.ZodObject<{
|
|
246
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
247
|
+
cursor: z.ZodOptional<z.ZodUUID>;
|
|
248
|
+
profileId: z.ZodOptional<z.ZodUUID>;
|
|
249
|
+
vendor: z.ZodOptional<z.ZodEnum<{
|
|
250
|
+
apns: "apns";
|
|
251
|
+
expo: "expo";
|
|
252
|
+
fcm: "fcm";
|
|
253
|
+
web_push: "web_push";
|
|
254
|
+
}>>;
|
|
255
|
+
valid: z.ZodOptional<z.ZodEnum<{
|
|
256
|
+
false: "false";
|
|
257
|
+
true: "true";
|
|
258
|
+
}>>;
|
|
259
|
+
}, z.core.$strip>;
|
|
260
|
+
/** Admin registration: the profile is named by id. */
|
|
261
|
+
export declare const PushTokenCreateBody: z.ZodObject<{
|
|
262
|
+
profileId: z.ZodUUID;
|
|
263
|
+
token: z.ZodString;
|
|
264
|
+
platform: z.ZodEnum<{
|
|
265
|
+
android: "android";
|
|
266
|
+
ios: "ios";
|
|
267
|
+
web: "web";
|
|
268
|
+
}>;
|
|
269
|
+
vendor: z.ZodEnum<{
|
|
270
|
+
apns: "apns";
|
|
271
|
+
expo: "expo";
|
|
272
|
+
fcm: "fcm";
|
|
273
|
+
web_push: "web_push";
|
|
274
|
+
}>;
|
|
275
|
+
appId: z.ZodOptional<z.ZodString>;
|
|
276
|
+
environment: z.ZodDefault<z.ZodEnum<{
|
|
277
|
+
production: "production";
|
|
278
|
+
sandbox: "sandbox";
|
|
279
|
+
}>>;
|
|
280
|
+
enablementStatus: z.ZodDefault<z.ZodEnum<{
|
|
281
|
+
AUTHORIZED: "AUTHORIZED";
|
|
282
|
+
DENIED: "DENIED";
|
|
283
|
+
NOT_DETERMINED: "NOT_DETERMINED";
|
|
284
|
+
PROVISIONAL: "PROVISIONAL";
|
|
285
|
+
UNAUTHORIZED: "UNAUTHORIZED";
|
|
286
|
+
}>>;
|
|
287
|
+
background: z.ZodDefault<z.ZodEnum<{
|
|
288
|
+
AVAILABLE: "AVAILABLE";
|
|
289
|
+
DENIED: "DENIED";
|
|
290
|
+
RESTRICTED: "RESTRICTED";
|
|
291
|
+
}>>;
|
|
292
|
+
deviceMetadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
293
|
+
}, z.core.$strip>;
|
|
294
|
+
/** Overrides for one platform; anything unset falls back to the message. */
|
|
295
|
+
export declare const PushPlatformOverride: z.ZodObject<{
|
|
296
|
+
title: z.ZodOptional<z.ZodString>;
|
|
297
|
+
body: z.ZodOptional<z.ZodString>;
|
|
298
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
299
|
+
url: z.ZodOptional<z.ZodString>;
|
|
300
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
301
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
302
|
+
}, z.core.$strip>;
|
|
303
|
+
/** What a push carries beyond title (the template subject) and body (the template text). Strings are Liquid. */
|
|
304
|
+
export declare const PushExtras: z.ZodObject<{
|
|
305
|
+
imageUrl: z.ZodOptional<z.ZodString>;
|
|
306
|
+
url: z.ZodOptional<z.ZodString>;
|
|
307
|
+
data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
308
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
309
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
310
|
+
ttlSeconds: z.ZodOptional<z.ZodNumber>;
|
|
311
|
+
priority: z.ZodOptional<z.ZodEnum<{
|
|
312
|
+
high: "high";
|
|
313
|
+
normal: "normal";
|
|
314
|
+
}>>;
|
|
315
|
+
collapseKey: z.ZodOptional<z.ZodString>;
|
|
316
|
+
ios: z.ZodOptional<z.ZodObject<{
|
|
317
|
+
title: z.ZodOptional<z.ZodString>;
|
|
318
|
+
body: z.ZodOptional<z.ZodString>;
|
|
319
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
320
|
+
url: z.ZodOptional<z.ZodString>;
|
|
321
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
322
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
323
|
+
}, z.core.$strip>>;
|
|
324
|
+
android: z.ZodOptional<z.ZodObject<{
|
|
325
|
+
title: z.ZodOptional<z.ZodString>;
|
|
326
|
+
body: z.ZodOptional<z.ZodString>;
|
|
327
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
328
|
+
url: z.ZodOptional<z.ZodString>;
|
|
329
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
330
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
331
|
+
}, z.core.$strip>>;
|
|
332
|
+
web: z.ZodOptional<z.ZodObject<{
|
|
333
|
+
title: z.ZodOptional<z.ZodString>;
|
|
334
|
+
body: z.ZodOptional<z.ZodString>;
|
|
335
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
336
|
+
url: z.ZodOptional<z.ZodString>;
|
|
337
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
338
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
339
|
+
}, z.core.$strip>>;
|
|
340
|
+
}, z.core.$strip>;
|
|
341
|
+
export type PushExtras = z.infer<typeof PushExtras>;
|
|
342
|
+
export declare const PushStatsQuery: z.ZodObject<{
|
|
343
|
+
from: z.ZodOptional<z.ZodCoercedDate<unknown>>;
|
|
344
|
+
to: z.ZodOptional<z.ZodCoercedDate<unknown>>;
|
|
345
|
+
}, z.core.$strip>;
|
|
346
|
+
export declare const PushStatsDto: z.ZodObject<{
|
|
347
|
+
sent: z.ZodNumber;
|
|
348
|
+
delivered: z.ZodNumber;
|
|
349
|
+
failed: z.ZodNumber;
|
|
350
|
+
blocked: z.ZodNumber;
|
|
351
|
+
opened: z.ZodNumber;
|
|
352
|
+
invalidTokens: z.ZodNumber;
|
|
353
|
+
blockReasons: z.ZodArray<z.ZodObject<{
|
|
354
|
+
reason: z.ZodString;
|
|
355
|
+
count: z.ZodNumber;
|
|
356
|
+
}, z.core.$strip>>;
|
|
357
|
+
sdkDelivered: z.ZodOptional<z.ZodNumber>;
|
|
358
|
+
converted: z.ZodOptional<z.ZodNumber>;
|
|
359
|
+
}, z.core.$strip>;
|
|
360
|
+
export type PushStatsDto = z.infer<typeof PushStatsDto>;
|
|
361
|
+
export declare const VapidKeysDto: z.ZodObject<{
|
|
362
|
+
publicKey: z.ZodString;
|
|
363
|
+
privateKey: z.ZodString;
|
|
364
|
+
}, z.core.$strip>;
|
|
365
|
+
/** A push campaign's content: title and body are the template's subject and text; the rest rides on the message. */
|
|
366
|
+
export declare const CampaignPushBody: z.ZodObject<{
|
|
367
|
+
title: z.ZodString;
|
|
368
|
+
body: z.ZodString;
|
|
369
|
+
extras: z.ZodDefault<z.ZodObject<{
|
|
370
|
+
imageUrl: z.ZodOptional<z.ZodString>;
|
|
371
|
+
url: z.ZodOptional<z.ZodString>;
|
|
372
|
+
data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
373
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
374
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
375
|
+
ttlSeconds: z.ZodOptional<z.ZodNumber>;
|
|
376
|
+
priority: z.ZodOptional<z.ZodEnum<{
|
|
377
|
+
high: "high";
|
|
378
|
+
normal: "normal";
|
|
379
|
+
}>>;
|
|
380
|
+
collapseKey: z.ZodOptional<z.ZodString>;
|
|
381
|
+
ios: z.ZodOptional<z.ZodObject<{
|
|
382
|
+
title: z.ZodOptional<z.ZodString>;
|
|
383
|
+
body: z.ZodOptional<z.ZodString>;
|
|
384
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
385
|
+
url: z.ZodOptional<z.ZodString>;
|
|
386
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
387
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
388
|
+
}, z.core.$strip>>;
|
|
389
|
+
android: z.ZodOptional<z.ZodObject<{
|
|
390
|
+
title: z.ZodOptional<z.ZodString>;
|
|
391
|
+
body: z.ZodOptional<z.ZodString>;
|
|
392
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
393
|
+
url: z.ZodOptional<z.ZodString>;
|
|
394
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
395
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
396
|
+
}, z.core.$strip>>;
|
|
397
|
+
web: z.ZodOptional<z.ZodObject<{
|
|
398
|
+
title: z.ZodOptional<z.ZodString>;
|
|
399
|
+
body: z.ZodOptional<z.ZodString>;
|
|
400
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
401
|
+
url: z.ZodOptional<z.ZodString>;
|
|
402
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
403
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
404
|
+
}, z.core.$strip>>;
|
|
405
|
+
}, z.core.$strip>>;
|
|
406
|
+
}, z.core.$strip>;
|
|
407
|
+
export declare const CampaignPushDto: z.ZodObject<{
|
|
408
|
+
templateId: z.ZodNullable<z.ZodUUID>;
|
|
409
|
+
title: z.ZodString;
|
|
410
|
+
body: z.ZodString;
|
|
411
|
+
extras: z.ZodObject<{
|
|
412
|
+
imageUrl: z.ZodOptional<z.ZodString>;
|
|
413
|
+
url: z.ZodOptional<z.ZodString>;
|
|
414
|
+
data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
415
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
416
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
417
|
+
ttlSeconds: z.ZodOptional<z.ZodNumber>;
|
|
418
|
+
priority: z.ZodOptional<z.ZodEnum<{
|
|
419
|
+
high: "high";
|
|
420
|
+
normal: "normal";
|
|
421
|
+
}>>;
|
|
422
|
+
collapseKey: z.ZodOptional<z.ZodString>;
|
|
423
|
+
ios: z.ZodOptional<z.ZodObject<{
|
|
424
|
+
title: z.ZodOptional<z.ZodString>;
|
|
425
|
+
body: z.ZodOptional<z.ZodString>;
|
|
426
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
427
|
+
url: z.ZodOptional<z.ZodString>;
|
|
428
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
429
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
430
|
+
}, z.core.$strip>>;
|
|
431
|
+
android: z.ZodOptional<z.ZodObject<{
|
|
432
|
+
title: z.ZodOptional<z.ZodString>;
|
|
433
|
+
body: z.ZodOptional<z.ZodString>;
|
|
434
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
435
|
+
url: z.ZodOptional<z.ZodString>;
|
|
436
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
437
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
438
|
+
}, z.core.$strip>>;
|
|
439
|
+
web: z.ZodOptional<z.ZodObject<{
|
|
440
|
+
title: z.ZodOptional<z.ZodString>;
|
|
441
|
+
body: z.ZodOptional<z.ZodString>;
|
|
442
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
443
|
+
url: z.ZodOptional<z.ZodString>;
|
|
444
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
445
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
446
|
+
}, z.core.$strip>>;
|
|
447
|
+
}, z.core.$strip>;
|
|
448
|
+
}, z.core.$strip>;
|
|
449
|
+
/** Who a push test goes to: a profile's registered devices, or one pasted token. */
|
|
450
|
+
export declare const PushTestTarget: z.ZodObject<{
|
|
451
|
+
profileId: z.ZodOptional<z.ZodUUID>;
|
|
452
|
+
pushToken: z.ZodOptional<z.ZodObject<{
|
|
453
|
+
token: z.ZodString;
|
|
454
|
+
vendor: z.ZodEnum<{
|
|
455
|
+
apns: "apns";
|
|
456
|
+
expo: "expo";
|
|
457
|
+
fcm: "fcm";
|
|
458
|
+
web_push: "web_push";
|
|
459
|
+
}>;
|
|
460
|
+
platform: z.ZodEnum<{
|
|
461
|
+
android: "android";
|
|
462
|
+
ios: "ios";
|
|
463
|
+
web: "web";
|
|
464
|
+
}>;
|
|
465
|
+
appId: z.ZodOptional<z.ZodString>;
|
|
466
|
+
}, z.core.$strip>>;
|
|
467
|
+
}, z.core.$strip>;
|
|
468
|
+
/** Flow step / template test: the saved push template plus the step's extras, through one connection. */
|
|
469
|
+
export declare const PushTestSendBody: z.ZodObject<{
|
|
470
|
+
profileId: z.ZodOptional<z.ZodUUID>;
|
|
471
|
+
pushToken: z.ZodOptional<z.ZodObject<{
|
|
472
|
+
token: z.ZodString;
|
|
473
|
+
vendor: z.ZodEnum<{
|
|
474
|
+
apns: "apns";
|
|
475
|
+
expo: "expo";
|
|
476
|
+
fcm: "fcm";
|
|
477
|
+
web_push: "web_push";
|
|
478
|
+
}>;
|
|
479
|
+
platform: z.ZodEnum<{
|
|
480
|
+
android: "android";
|
|
481
|
+
ios: "ios";
|
|
482
|
+
web: "web";
|
|
483
|
+
}>;
|
|
484
|
+
appId: z.ZodOptional<z.ZodString>;
|
|
485
|
+
}, z.core.$strip>>;
|
|
486
|
+
templateId: z.ZodUUID;
|
|
487
|
+
push: z.ZodOptional<z.ZodObject<{
|
|
488
|
+
imageUrl: z.ZodOptional<z.ZodString>;
|
|
489
|
+
url: z.ZodOptional<z.ZodString>;
|
|
490
|
+
data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
491
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
492
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
493
|
+
ttlSeconds: z.ZodOptional<z.ZodNumber>;
|
|
494
|
+
priority: z.ZodOptional<z.ZodEnum<{
|
|
495
|
+
high: "high";
|
|
496
|
+
normal: "normal";
|
|
497
|
+
}>>;
|
|
498
|
+
collapseKey: z.ZodOptional<z.ZodString>;
|
|
499
|
+
ios: z.ZodOptional<z.ZodObject<{
|
|
500
|
+
title: z.ZodOptional<z.ZodString>;
|
|
501
|
+
body: z.ZodOptional<z.ZodString>;
|
|
502
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
503
|
+
url: z.ZodOptional<z.ZodString>;
|
|
504
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
505
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
506
|
+
}, z.core.$strip>>;
|
|
507
|
+
android: z.ZodOptional<z.ZodObject<{
|
|
508
|
+
title: z.ZodOptional<z.ZodString>;
|
|
509
|
+
body: z.ZodOptional<z.ZodString>;
|
|
510
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
511
|
+
url: z.ZodOptional<z.ZodString>;
|
|
512
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
513
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
514
|
+
}, z.core.$strip>>;
|
|
515
|
+
web: z.ZodOptional<z.ZodObject<{
|
|
516
|
+
title: z.ZodOptional<z.ZodString>;
|
|
517
|
+
body: z.ZodOptional<z.ZodString>;
|
|
518
|
+
imageUrl: z.ZodOptional<z.ZodURL>;
|
|
519
|
+
url: z.ZodOptional<z.ZodString>;
|
|
520
|
+
sound: z.ZodOptional<z.ZodString>;
|
|
521
|
+
badge: z.ZodOptional<z.ZodNumber>;
|
|
522
|
+
}, z.core.$strip>>;
|
|
523
|
+
}, z.core.$strip>>;
|
|
524
|
+
connectionId: z.ZodOptional<z.ZodUUID>;
|
|
525
|
+
purpose: z.ZodDefault<z.ZodEnum<{
|
|
526
|
+
marketing: "marketing";
|
|
527
|
+
operational: "operational";
|
|
528
|
+
transactional: "transactional";
|
|
529
|
+
}>>;
|
|
530
|
+
}, z.core.$strip>;
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { DateTimeIn, Id, PageQuery, Timestamp, pageResult } from './common.js';
|
|
3
|
+
export const PushPlatform = z.enum(['ios', 'android', 'web']);
|
|
4
|
+
export const PushVendor = z.enum(['apns', 'fcm', 'expo', 'web_push']);
|
|
5
|
+
export const PushEnvironment = z.enum(['sandbox', 'production']);
|
|
6
|
+
export const PushEnablement = z.enum(['AUTHORIZED', 'DENIED', 'UNAUTHORIZED', 'PROVISIONAL', 'NOT_DETERMINED']);
|
|
7
|
+
export const PushBackground = z.enum(['AVAILABLE', 'DENIED', 'RESTRICTED']);
|
|
8
|
+
/** Klaviyo SDKs send these in either case ("APNS", "ios"); we store lower-case vendor/platform and upper-case statuses. */
|
|
9
|
+
const lower = (e) => z.preprocess((v) => (typeof v === 'string' ? v.toLowerCase() : v), e);
|
|
10
|
+
const upper = (e) => z.preprocess((v) => (typeof v === 'string' ? v.toUpperCase() : v), e);
|
|
11
|
+
const str = (n = 200) => z.string().max(n).optional();
|
|
12
|
+
/** Klaviyo's SDKs (and ours) send device environment as debug/release; the API also takes sandbox/production. */
|
|
13
|
+
const DEVICE_ENV = { debug: 'sandbox', release: 'production' };
|
|
14
|
+
const deviceEnv = z.preprocess((v) => (typeof v === 'string' ? DEVICE_ENV[v.toLowerCase()] ?? v.toLowerCase() : v), PushEnvironment);
|
|
15
|
+
export const PushDeviceMetadata = z.looseObject({
|
|
16
|
+
device_id: str(), klaviyo_sdk: str(), sdk_version: str(), device_model: str(), os_name: str(), os_version: str(),
|
|
17
|
+
app_name: str(), app_version: str(), app_build: str(), app_id: str(), environment: deviceEnv.optional(),
|
|
18
|
+
});
|
|
19
|
+
/** Who the device belongs to; at least one key is needed. Several may be sent: they all resolve to one profile. */
|
|
20
|
+
export const PushProfileRef = z.object({
|
|
21
|
+
data: z.object({
|
|
22
|
+
type: z.literal('profile').optional(),
|
|
23
|
+
attributes: z.object({
|
|
24
|
+
email: z.string().max(320).optional(), phone_number: z.string().max(40).optional(), external_id: z.string().max(200).optional(), anonymous_id: z.string().max(200).optional(),
|
|
25
|
+
}),
|
|
26
|
+
}),
|
|
27
|
+
});
|
|
28
|
+
/** POST /client/push-tokens (Klaviyo's JSON:API shape). Web push: vendor web_push, token = the JSON-serialised PushSubscription. */
|
|
29
|
+
export const ClientPushTokenBody = z.object({
|
|
30
|
+
data: z.object({
|
|
31
|
+
type: z.literal('push-token').optional(),
|
|
32
|
+
attributes: z.object({
|
|
33
|
+
token: z.string().min(1).max(4096),
|
|
34
|
+
platform: lower(PushPlatform),
|
|
35
|
+
vendor: lower(PushVendor),
|
|
36
|
+
enablement_status: upper(PushEnablement).default('AUTHORIZED'),
|
|
37
|
+
background: upper(PushBackground).default('AVAILABLE'),
|
|
38
|
+
device_metadata: PushDeviceMetadata.default({}),
|
|
39
|
+
profile: PushProfileRef,
|
|
40
|
+
}),
|
|
41
|
+
}),
|
|
42
|
+
});
|
|
43
|
+
/** POST /client/push-token-unregister: same envelope, only token + vendor + profile matter. */
|
|
44
|
+
export const ClientPushUnregisterBody = z.object({
|
|
45
|
+
data: z.object({
|
|
46
|
+
type: z.enum(['push-token-unregister', 'push-token']).optional(), // older SDK builds sent push-token
|
|
47
|
+
attributes: z.object({ token: z.string().min(1).max(4096), platform: lower(PushPlatform).optional(), vendor: lower(PushVendor), profile: PushProfileRef.optional() }),
|
|
48
|
+
}),
|
|
49
|
+
});
|
|
50
|
+
export const ClientPushConfigQuery = z.object({ company_id: z.string().max(200).optional(), k: z.string().max(200).optional() });
|
|
51
|
+
export const PushConfigDto = z.object({ vapidPublicKey: z.string().nullable() });
|
|
52
|
+
export const PushTokenDto = z.object({
|
|
53
|
+
id: Id, profileId: Id, token: z.string(), platform: PushPlatform, vendor: PushVendor, appId: z.string().nullable(), environment: PushEnvironment,
|
|
54
|
+
enablementStatus: PushEnablement, background: PushBackground, deviceMetadata: z.record(z.string(), z.unknown()),
|
|
55
|
+
lastSeenAt: Timestamp, invalidatedAt: Timestamp.nullable(), invalidReason: z.string().nullable(), createdAt: Timestamp,
|
|
56
|
+
});
|
|
57
|
+
export const PushTokenPage = pageResult(PushTokenDto);
|
|
58
|
+
export const PushTokenListQuery = PageQuery.extend({ profileId: Id.optional(), vendor: PushVendor.optional(), valid: z.enum(['true', 'false']).optional() });
|
|
59
|
+
/** Admin registration: the profile is named by id. */
|
|
60
|
+
export const PushTokenCreateBody = z.object({
|
|
61
|
+
profileId: Id, token: z.string().min(1).max(4096), platform: PushPlatform, vendor: PushVendor, appId: z.string().max(200).optional(),
|
|
62
|
+
environment: PushEnvironment.default('production'), enablementStatus: PushEnablement.default('AUTHORIZED'), background: PushBackground.default('AVAILABLE'),
|
|
63
|
+
deviceMetadata: z.record(z.string(), z.unknown()).default({}),
|
|
64
|
+
});
|
|
65
|
+
const Str = z.string().max(500);
|
|
66
|
+
/** Overrides for one platform; anything unset falls back to the message. */
|
|
67
|
+
export const PushPlatformOverride = z.object({ title: Str.optional(), body: z.string().max(2000).optional(), imageUrl: z.url().optional(), url: z.string().max(2000).optional(), sound: z.string().max(100).optional(), badge: z.number().int().min(0).max(99999).optional() });
|
|
68
|
+
/** What a push carries beyond title (the template subject) and body (the template text). Strings are Liquid. */
|
|
69
|
+
export const PushExtras = z.object({
|
|
70
|
+
imageUrl: z.string().max(2000).optional(),
|
|
71
|
+
/** Deep link (myapp://...) or https URL opened when the notification is tapped. */
|
|
72
|
+
url: z.string().max(2000).optional(),
|
|
73
|
+
data: z.record(z.string().max(64), z.string().max(1000)).refine((m) => Object.keys(m).length <= 20, { message: 'At most 20 data keys' }).optional(),
|
|
74
|
+
badge: z.number().int().min(0).max(99999).optional(),
|
|
75
|
+
sound: z.string().max(100).optional(),
|
|
76
|
+
ttlSeconds: z.number().int().min(0).max(28 * 86400).optional(),
|
|
77
|
+
priority: z.enum(['high', 'normal']).optional(),
|
|
78
|
+
collapseKey: z.string().max(64).optional(),
|
|
79
|
+
ios: PushPlatformOverride.optional(),
|
|
80
|
+
android: PushPlatformOverride.optional(),
|
|
81
|
+
web: PushPlatformOverride.optional(),
|
|
82
|
+
});
|
|
83
|
+
export const PushStatsQuery = z.object({ from: DateTimeIn().optional(), to: DateTimeIn().optional() });
|
|
84
|
+
export const PushStatsDto = z.object({
|
|
85
|
+
sent: z.number().int(), delivered: z.number().int(), failed: z.number().int(), blocked: z.number().int(), opened: z.number().int(),
|
|
86
|
+
invalidTokens: z.number().int(), blockReasons: z.array(z.object({ reason: z.string(), count: z.number().int() })),
|
|
87
|
+
/** Reported by the mobile SDK (`$received_push` / `$converted_push`), counted once per message. */
|
|
88
|
+
sdkDelivered: z.number().int().optional(), converted: z.number().int().optional(),
|
|
89
|
+
});
|
|
90
|
+
export const VapidKeysDto = z.object({ publicKey: z.string(), privateKey: z.string() });
|
|
91
|
+
/** A push campaign's content: title and body are the template's subject and text; the rest rides on the message. */
|
|
92
|
+
export const CampaignPushBody = z.object({ title: z.string().max(200), body: z.string().min(1).max(4000), extras: PushExtras.default({}) });
|
|
93
|
+
export const CampaignPushDto = z.object({ templateId: Id.nullable(), title: z.string(), body: z.string(), extras: PushExtras });
|
|
94
|
+
/** Who a push test goes to: a profile's registered devices, or one pasted token. */
|
|
95
|
+
export const PushTestTarget = z.object({
|
|
96
|
+
profileId: Id.optional(),
|
|
97
|
+
pushToken: z.object({ token: z.string().min(1).max(4096), vendor: PushVendor, platform: PushPlatform, appId: z.string().max(200).optional() }).optional(),
|
|
98
|
+
});
|
|
99
|
+
/** Flow step / template test: the saved push template plus the step's extras, through one connection. */
|
|
100
|
+
export const PushTestSendBody = PushTestTarget.extend({
|
|
101
|
+
templateId: Id, push: PushExtras.optional(), connectionId: Id.optional(), purpose: z.enum(['marketing', 'transactional', 'operational']).default('marketing'),
|
|
102
|
+
}).refine((b) => b.profileId || b.pushToken, 'Choose a test profile or paste a device token');
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/** A tappable chip under an RCS message or card. Text is liquid. Limits follow RCS Business Messaging (25-character chips). */
|
|
3
|
+
export declare const RcsSuggestion: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
4
|
+
type: z.ZodLiteral<"reply">;
|
|
5
|
+
text: z.ZodString;
|
|
6
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
7
|
+
type: z.ZodLiteral<"url">;
|
|
8
|
+
text: z.ZodString;
|
|
9
|
+
url: z.ZodURL;
|
|
10
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
11
|
+
type: z.ZodLiteral<"dial">;
|
|
12
|
+
text: z.ZodString;
|
|
13
|
+
phone: z.ZodString;
|
|
14
|
+
}, z.core.$strip>], "type">;
|
|
15
|
+
export type RcsSuggestion = z.infer<typeof RcsSuggestion>;
|
|
16
|
+
/**
|
|
17
|
+
* Rich content for an SMS template, used when the route's provider speaks RCS (Twilio RCS, Sinch). The template's text is always the
|
|
18
|
+
* SMS fallback, so a phone without RCS (or a failed RCS attempt) still gets the plain message. Title and description are liquid.
|
|
19
|
+
*/
|
|
20
|
+
export declare const RcsContent: z.ZodObject<{
|
|
21
|
+
card: z.ZodOptional<z.ZodObject<{
|
|
22
|
+
title: z.ZodString;
|
|
23
|
+
description: z.ZodOptional<z.ZodString>;
|
|
24
|
+
mediaUrl: z.ZodOptional<z.ZodURL>;
|
|
25
|
+
}, z.core.$strip>>;
|
|
26
|
+
suggestions: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
27
|
+
type: z.ZodLiteral<"reply">;
|
|
28
|
+
text: z.ZodString;
|
|
29
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
30
|
+
type: z.ZodLiteral<"url">;
|
|
31
|
+
text: z.ZodString;
|
|
32
|
+
url: z.ZodURL;
|
|
33
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
34
|
+
type: z.ZodLiteral<"dial">;
|
|
35
|
+
text: z.ZodString;
|
|
36
|
+
phone: z.ZodString;
|
|
37
|
+
}, z.core.$strip>], "type">>>;
|
|
38
|
+
}, z.core.$strip>;
|
|
39
|
+
export type RcsContent = z.infer<typeof RcsContent>;
|