@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,628 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
export declare const ConsentStatus: z.ZodEnum<{
|
|
3
|
+
granted: "granted";
|
|
4
|
+
pending_confirmation: "pending_confirmation";
|
|
5
|
+
revoked: "revoked";
|
|
6
|
+
}>;
|
|
7
|
+
export declare const LegalBasis: z.ZodEnum<{
|
|
8
|
+
consent: "consent";
|
|
9
|
+
contract: "contract";
|
|
10
|
+
legitimate_interest: "legitimate_interest";
|
|
11
|
+
other: "other";
|
|
12
|
+
}>;
|
|
13
|
+
export type LegalBasis = z.infer<typeof LegalBasis>;
|
|
14
|
+
export declare const ConsentSource: z.ZodEnum<{
|
|
15
|
+
admin: "admin";
|
|
16
|
+
api: "api";
|
|
17
|
+
double_opt_in: "double_opt_in";
|
|
18
|
+
facebook_dm: "facebook_dm";
|
|
19
|
+
form: "form";
|
|
20
|
+
import: "import";
|
|
21
|
+
instagram_dm: "instagram_dm";
|
|
22
|
+
preference_center: "preference_center";
|
|
23
|
+
sms_keyword: "sms_keyword";
|
|
24
|
+
}>;
|
|
25
|
+
export declare const RevocationScope: z.ZodEnum<{
|
|
26
|
+
all: "all";
|
|
27
|
+
channel: "channel";
|
|
28
|
+
topic: "topic";
|
|
29
|
+
}>;
|
|
30
|
+
export declare const SuppressionReason: z.ZodEnum<{
|
|
31
|
+
complaint: "complaint";
|
|
32
|
+
dnc: "dnc";
|
|
33
|
+
hard_bounce: "hard_bounce";
|
|
34
|
+
invalid: "invalid";
|
|
35
|
+
manual: "manual";
|
|
36
|
+
stop_keyword: "stop_keyword";
|
|
37
|
+
unsubscribe: "unsubscribe";
|
|
38
|
+
}>;
|
|
39
|
+
export declare const SuppressionScope: z.ZodEnum<{
|
|
40
|
+
global: "global";
|
|
41
|
+
purpose: "purpose";
|
|
42
|
+
topic: "topic";
|
|
43
|
+
}>;
|
|
44
|
+
export declare const BlockReason: z.ZodEnum<{
|
|
45
|
+
blocklisted_domain: "blocklisted_domain";
|
|
46
|
+
channel_not_preferred: "channel_not_preferred";
|
|
47
|
+
consent_expired: "consent_expired";
|
|
48
|
+
consent_revoked: "consent_revoked";
|
|
49
|
+
frequency_limited: "frequency_limited";
|
|
50
|
+
jurisdiction_blocked: "jurisdiction_blocked";
|
|
51
|
+
no_consent: "no_consent";
|
|
52
|
+
snoozed: "snoozed";
|
|
53
|
+
suppressed: "suppressed";
|
|
54
|
+
topic_unsubscribed: "topic_unsubscribed";
|
|
55
|
+
transactional_only: "transactional_only";
|
|
56
|
+
}>;
|
|
57
|
+
export type BlockReason = z.infer<typeof BlockReason>;
|
|
58
|
+
/** Consent assertion for one (channel, purpose, topic). */
|
|
59
|
+
export declare const ConsentInputBody: z.ZodObject<{
|
|
60
|
+
channel: z.ZodEnum<{
|
|
61
|
+
email: "email";
|
|
62
|
+
postcard: "postcard";
|
|
63
|
+
push: "push";
|
|
64
|
+
sms: "sms";
|
|
65
|
+
whatsapp: "whatsapp";
|
|
66
|
+
}>;
|
|
67
|
+
purpose: z.ZodEnum<{
|
|
68
|
+
marketing: "marketing";
|
|
69
|
+
operational: "operational";
|
|
70
|
+
prospecting: "prospecting";
|
|
71
|
+
transactional: "transactional";
|
|
72
|
+
}>;
|
|
73
|
+
topicId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
74
|
+
status: z.ZodEnum<{
|
|
75
|
+
granted: "granted";
|
|
76
|
+
pending_confirmation: "pending_confirmation";
|
|
77
|
+
revoked: "revoked";
|
|
78
|
+
}>;
|
|
79
|
+
legalBasis: z.ZodDefault<z.ZodEnum<{
|
|
80
|
+
consent: "consent";
|
|
81
|
+
contract: "contract";
|
|
82
|
+
legitimate_interest: "legitimate_interest";
|
|
83
|
+
other: "other";
|
|
84
|
+
}>>;
|
|
85
|
+
source: z.ZodEnum<{
|
|
86
|
+
admin: "admin";
|
|
87
|
+
api: "api";
|
|
88
|
+
double_opt_in: "double_opt_in";
|
|
89
|
+
facebook_dm: "facebook_dm";
|
|
90
|
+
form: "form";
|
|
91
|
+
import: "import";
|
|
92
|
+
instagram_dm: "instagram_dm";
|
|
93
|
+
preference_center: "preference_center";
|
|
94
|
+
sms_keyword: "sms_keyword";
|
|
95
|
+
}>;
|
|
96
|
+
sourceRef: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
97
|
+
disclosureText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
98
|
+
disclosureVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
99
|
+
ip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
100
|
+
userAgent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
101
|
+
proof: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
102
|
+
expiresAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
|
|
103
|
+
revocationScope: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
104
|
+
all: "all";
|
|
105
|
+
channel: "channel";
|
|
106
|
+
topic: "topic";
|
|
107
|
+
}>>>;
|
|
108
|
+
}, z.core.$strip>;
|
|
109
|
+
export type ConsentInputBody = z.input<typeof ConsentInputBody>;
|
|
110
|
+
export declare const ConsentInput: z.ZodObject<{
|
|
111
|
+
channel: z.ZodEnum<{
|
|
112
|
+
email: "email";
|
|
113
|
+
postcard: "postcard";
|
|
114
|
+
push: "push";
|
|
115
|
+
sms: "sms";
|
|
116
|
+
whatsapp: "whatsapp";
|
|
117
|
+
}>;
|
|
118
|
+
purpose: z.ZodEnum<{
|
|
119
|
+
marketing: "marketing";
|
|
120
|
+
operational: "operational";
|
|
121
|
+
prospecting: "prospecting";
|
|
122
|
+
transactional: "transactional";
|
|
123
|
+
}>;
|
|
124
|
+
topicId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
125
|
+
status: z.ZodEnum<{
|
|
126
|
+
granted: "granted";
|
|
127
|
+
pending_confirmation: "pending_confirmation";
|
|
128
|
+
revoked: "revoked";
|
|
129
|
+
}>;
|
|
130
|
+
legalBasis: z.ZodDefault<z.ZodEnum<{
|
|
131
|
+
consent: "consent";
|
|
132
|
+
contract: "contract";
|
|
133
|
+
legitimate_interest: "legitimate_interest";
|
|
134
|
+
other: "other";
|
|
135
|
+
}>>;
|
|
136
|
+
source: z.ZodEnum<{
|
|
137
|
+
admin: "admin";
|
|
138
|
+
api: "api";
|
|
139
|
+
double_opt_in: "double_opt_in";
|
|
140
|
+
facebook_dm: "facebook_dm";
|
|
141
|
+
form: "form";
|
|
142
|
+
import: "import";
|
|
143
|
+
instagram_dm: "instagram_dm";
|
|
144
|
+
preference_center: "preference_center";
|
|
145
|
+
sms_keyword: "sms_keyword";
|
|
146
|
+
}>;
|
|
147
|
+
sourceRef: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
148
|
+
disclosureText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
149
|
+
disclosureVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
150
|
+
ip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
151
|
+
userAgent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
152
|
+
proof: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
153
|
+
expiresAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
|
|
154
|
+
revocationScope: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
155
|
+
all: "all";
|
|
156
|
+
channel: "channel";
|
|
157
|
+
topic: "topic";
|
|
158
|
+
}>>>;
|
|
159
|
+
profileId: z.ZodUUID;
|
|
160
|
+
}, z.core.$strip>;
|
|
161
|
+
export type ConsentInput = z.infer<typeof ConsentInput>;
|
|
162
|
+
export declare const ConsentRecordDto: z.ZodObject<{
|
|
163
|
+
id: z.ZodUUID;
|
|
164
|
+
profileId: z.ZodUUID;
|
|
165
|
+
channel: z.ZodEnum<{
|
|
166
|
+
email: "email";
|
|
167
|
+
postcard: "postcard";
|
|
168
|
+
push: "push";
|
|
169
|
+
sms: "sms";
|
|
170
|
+
whatsapp: "whatsapp";
|
|
171
|
+
}>;
|
|
172
|
+
purpose: z.ZodEnum<{
|
|
173
|
+
marketing: "marketing";
|
|
174
|
+
operational: "operational";
|
|
175
|
+
prospecting: "prospecting";
|
|
176
|
+
transactional: "transactional";
|
|
177
|
+
}>;
|
|
178
|
+
topicId: z.ZodNullable<z.ZodUUID>;
|
|
179
|
+
status: z.ZodEnum<{
|
|
180
|
+
granted: "granted";
|
|
181
|
+
pending_confirmation: "pending_confirmation";
|
|
182
|
+
revoked: "revoked";
|
|
183
|
+
}>;
|
|
184
|
+
legalBasis: z.ZodEnum<{
|
|
185
|
+
consent: "consent";
|
|
186
|
+
contract: "contract";
|
|
187
|
+
legitimate_interest: "legitimate_interest";
|
|
188
|
+
other: "other";
|
|
189
|
+
}>;
|
|
190
|
+
source: z.ZodEnum<{
|
|
191
|
+
admin: "admin";
|
|
192
|
+
api: "api";
|
|
193
|
+
double_opt_in: "double_opt_in";
|
|
194
|
+
facebook_dm: "facebook_dm";
|
|
195
|
+
form: "form";
|
|
196
|
+
import: "import";
|
|
197
|
+
instagram_dm: "instagram_dm";
|
|
198
|
+
preference_center: "preference_center";
|
|
199
|
+
sms_keyword: "sms_keyword";
|
|
200
|
+
}>;
|
|
201
|
+
sourceRef: z.ZodNullable<z.ZodString>;
|
|
202
|
+
disclosureText: z.ZodNullable<z.ZodString>;
|
|
203
|
+
disclosureVersion: z.ZodNullable<z.ZodString>;
|
|
204
|
+
expiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
205
|
+
revocationScope: z.ZodNullable<z.ZodEnum<{
|
|
206
|
+
all: "all";
|
|
207
|
+
channel: "channel";
|
|
208
|
+
topic: "topic";
|
|
209
|
+
}>>;
|
|
210
|
+
at: z.ZodISODateTime;
|
|
211
|
+
}, z.core.$strip>;
|
|
212
|
+
export declare const ConsentOutcome: z.ZodUnion<readonly [z.ZodObject<{
|
|
213
|
+
record: z.ZodObject<{
|
|
214
|
+
id: z.ZodUUID;
|
|
215
|
+
profileId: z.ZodUUID;
|
|
216
|
+
channel: z.ZodEnum<{
|
|
217
|
+
email: "email";
|
|
218
|
+
postcard: "postcard";
|
|
219
|
+
push: "push";
|
|
220
|
+
sms: "sms";
|
|
221
|
+
whatsapp: "whatsapp";
|
|
222
|
+
}>;
|
|
223
|
+
purpose: z.ZodEnum<{
|
|
224
|
+
marketing: "marketing";
|
|
225
|
+
operational: "operational";
|
|
226
|
+
prospecting: "prospecting";
|
|
227
|
+
transactional: "transactional";
|
|
228
|
+
}>;
|
|
229
|
+
topicId: z.ZodNullable<z.ZodUUID>;
|
|
230
|
+
status: z.ZodEnum<{
|
|
231
|
+
granted: "granted";
|
|
232
|
+
pending_confirmation: "pending_confirmation";
|
|
233
|
+
revoked: "revoked";
|
|
234
|
+
}>;
|
|
235
|
+
legalBasis: z.ZodEnum<{
|
|
236
|
+
consent: "consent";
|
|
237
|
+
contract: "contract";
|
|
238
|
+
legitimate_interest: "legitimate_interest";
|
|
239
|
+
other: "other";
|
|
240
|
+
}>;
|
|
241
|
+
source: z.ZodEnum<{
|
|
242
|
+
admin: "admin";
|
|
243
|
+
api: "api";
|
|
244
|
+
double_opt_in: "double_opt_in";
|
|
245
|
+
facebook_dm: "facebook_dm";
|
|
246
|
+
form: "form";
|
|
247
|
+
import: "import";
|
|
248
|
+
instagram_dm: "instagram_dm";
|
|
249
|
+
preference_center: "preference_center";
|
|
250
|
+
sms_keyword: "sms_keyword";
|
|
251
|
+
}>;
|
|
252
|
+
sourceRef: z.ZodNullable<z.ZodString>;
|
|
253
|
+
disclosureText: z.ZodNullable<z.ZodString>;
|
|
254
|
+
disclosureVersion: z.ZodNullable<z.ZodString>;
|
|
255
|
+
expiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
256
|
+
revocationScope: z.ZodNullable<z.ZodEnum<{
|
|
257
|
+
all: "all";
|
|
258
|
+
channel: "channel";
|
|
259
|
+
topic: "topic";
|
|
260
|
+
}>>;
|
|
261
|
+
at: z.ZodISODateTime;
|
|
262
|
+
}, z.core.$strip>;
|
|
263
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
264
|
+
ignored: z.ZodLiteral<"revoked_previously">;
|
|
265
|
+
}, z.core.$strip>]>;
|
|
266
|
+
/** Latest status per (profile, channel, purpose, topic). */
|
|
267
|
+
export declare const ConsentStateDto: z.ZodObject<{
|
|
268
|
+
profileId: z.ZodUUID;
|
|
269
|
+
channel: z.ZodEnum<{
|
|
270
|
+
email: "email";
|
|
271
|
+
postcard: "postcard";
|
|
272
|
+
push: "push";
|
|
273
|
+
sms: "sms";
|
|
274
|
+
whatsapp: "whatsapp";
|
|
275
|
+
}>;
|
|
276
|
+
purpose: z.ZodEnum<{
|
|
277
|
+
marketing: "marketing";
|
|
278
|
+
operational: "operational";
|
|
279
|
+
prospecting: "prospecting";
|
|
280
|
+
transactional: "transactional";
|
|
281
|
+
}>;
|
|
282
|
+
topicId: z.ZodNullable<z.ZodUUID>;
|
|
283
|
+
status: z.ZodEnum<{
|
|
284
|
+
granted: "granted";
|
|
285
|
+
pending_confirmation: "pending_confirmation";
|
|
286
|
+
revoked: "revoked";
|
|
287
|
+
}>;
|
|
288
|
+
recordId: z.ZodUUID;
|
|
289
|
+
expiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
290
|
+
updatedAt: z.ZodISODateTime;
|
|
291
|
+
source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
292
|
+
}, z.core.$strip>;
|
|
293
|
+
export declare const TopicInput: z.ZodObject<{
|
|
294
|
+
channel: z.ZodEnum<{
|
|
295
|
+
email: "email";
|
|
296
|
+
postcard: "postcard";
|
|
297
|
+
push: "push";
|
|
298
|
+
sms: "sms";
|
|
299
|
+
whatsapp: "whatsapp";
|
|
300
|
+
}>;
|
|
301
|
+
key: z.ZodString;
|
|
302
|
+
name: z.ZodString;
|
|
303
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
304
|
+
defaultOptIn: z.ZodDefault<z.ZodBoolean>;
|
|
305
|
+
visibleInPreferenceCenter: z.ZodDefault<z.ZodBoolean>;
|
|
306
|
+
groupId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
307
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
308
|
+
app: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
309
|
+
}, z.core.$strip>;
|
|
310
|
+
export type TopicInput = z.input<typeof TopicInput>;
|
|
311
|
+
export declare const TopicPatch: z.ZodObject<{
|
|
312
|
+
name: z.ZodOptional<z.ZodString>;
|
|
313
|
+
description: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
314
|
+
groupId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodUUID>>>;
|
|
315
|
+
position: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
|
|
316
|
+
app: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
317
|
+
defaultOptIn: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
318
|
+
visibleInPreferenceCenter: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
319
|
+
}, z.core.$strip>;
|
|
320
|
+
export type TopicPatch = z.infer<typeof TopicPatch>;
|
|
321
|
+
export declare const TopicDto: z.ZodObject<{
|
|
322
|
+
id: z.ZodUUID;
|
|
323
|
+
channel: z.ZodEnum<{
|
|
324
|
+
email: "email";
|
|
325
|
+
postcard: "postcard";
|
|
326
|
+
push: "push";
|
|
327
|
+
sms: "sms";
|
|
328
|
+
whatsapp: "whatsapp";
|
|
329
|
+
}>;
|
|
330
|
+
key: z.ZodString;
|
|
331
|
+
name: z.ZodString;
|
|
332
|
+
description: z.ZodNullable<z.ZodString>;
|
|
333
|
+
defaultOptIn: z.ZodBoolean;
|
|
334
|
+
visibleInPreferenceCenter: z.ZodBoolean;
|
|
335
|
+
groupId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
336
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
337
|
+
app: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
338
|
+
createdAt: z.ZodISODateTime;
|
|
339
|
+
archivedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
340
|
+
subscriberCount: z.ZodOptional<z.ZodNumber>;
|
|
341
|
+
}, z.core.$strip>;
|
|
342
|
+
/** Interest category: groups topics with a display type for the preference centre. */
|
|
343
|
+
export declare const TopicGroupBody: z.ZodObject<{
|
|
344
|
+
name: z.ZodString;
|
|
345
|
+
displayType: z.ZodDefault<z.ZodEnum<{
|
|
346
|
+
checkboxes: "checkboxes";
|
|
347
|
+
dropdown: "dropdown";
|
|
348
|
+
hidden: "hidden";
|
|
349
|
+
radio: "radio";
|
|
350
|
+
}>>;
|
|
351
|
+
position: z.ZodDefault<z.ZodNumber>;
|
|
352
|
+
}, z.core.$strip>;
|
|
353
|
+
export type TopicGroupBody = z.infer<typeof TopicGroupBody>;
|
|
354
|
+
export declare const TopicGroupPatch: z.ZodObject<{
|
|
355
|
+
name: z.ZodOptional<z.ZodString>;
|
|
356
|
+
displayType: z.ZodOptional<z.ZodEnum<{
|
|
357
|
+
checkboxes: "checkboxes";
|
|
358
|
+
dropdown: "dropdown";
|
|
359
|
+
hidden: "hidden";
|
|
360
|
+
radio: "radio";
|
|
361
|
+
}>>;
|
|
362
|
+
position: z.ZodOptional<z.ZodNumber>;
|
|
363
|
+
}, z.core.$strip>;
|
|
364
|
+
export declare const TopicGroupDto: z.ZodObject<{
|
|
365
|
+
id: z.ZodUUID;
|
|
366
|
+
name: z.ZodString;
|
|
367
|
+
displayType: z.ZodString;
|
|
368
|
+
position: z.ZodNumber;
|
|
369
|
+
topicCount: z.ZodOptional<z.ZodNumber>;
|
|
370
|
+
createdAt: z.ZodISODateTime;
|
|
371
|
+
}, z.core.$strip>;
|
|
372
|
+
export declare const SuppressionInput: z.ZodObject<{
|
|
373
|
+
channel: z.ZodEnum<{
|
|
374
|
+
email: "email";
|
|
375
|
+
postcard: "postcard";
|
|
376
|
+
push: "push";
|
|
377
|
+
sms: "sms";
|
|
378
|
+
whatsapp: "whatsapp";
|
|
379
|
+
}>;
|
|
380
|
+
value: z.ZodString;
|
|
381
|
+
scope: z.ZodDefault<z.ZodEnum<{
|
|
382
|
+
global: "global";
|
|
383
|
+
purpose: "purpose";
|
|
384
|
+
topic: "topic";
|
|
385
|
+
}>>;
|
|
386
|
+
topicId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
387
|
+
purpose: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
388
|
+
marketing: "marketing";
|
|
389
|
+
operational: "operational";
|
|
390
|
+
prospecting: "prospecting";
|
|
391
|
+
transactional: "transactional";
|
|
392
|
+
}>>>;
|
|
393
|
+
reason: z.ZodEnum<{
|
|
394
|
+
complaint: "complaint";
|
|
395
|
+
dnc: "dnc";
|
|
396
|
+
hard_bounce: "hard_bounce";
|
|
397
|
+
invalid: "invalid";
|
|
398
|
+
manual: "manual";
|
|
399
|
+
stop_keyword: "stop_keyword";
|
|
400
|
+
unsubscribe: "unsubscribe";
|
|
401
|
+
}>;
|
|
402
|
+
sourceRef: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
403
|
+
}, z.core.$strip>;
|
|
404
|
+
export type SuppressionInput = z.input<typeof SuppressionInput>;
|
|
405
|
+
export declare const SuppressionDto: z.ZodObject<{
|
|
406
|
+
id: z.ZodUUID;
|
|
407
|
+
channel: z.ZodEnum<{
|
|
408
|
+
email: "email";
|
|
409
|
+
postcard: "postcard";
|
|
410
|
+
push: "push";
|
|
411
|
+
sms: "sms";
|
|
412
|
+
whatsapp: "whatsapp";
|
|
413
|
+
}>;
|
|
414
|
+
valueNormalized: z.ZodString;
|
|
415
|
+
scope: z.ZodEnum<{
|
|
416
|
+
global: "global";
|
|
417
|
+
purpose: "purpose";
|
|
418
|
+
topic: "topic";
|
|
419
|
+
}>;
|
|
420
|
+
topicId: z.ZodNullable<z.ZodUUID>;
|
|
421
|
+
purpose: z.ZodNullable<z.ZodEnum<{
|
|
422
|
+
marketing: "marketing";
|
|
423
|
+
operational: "operational";
|
|
424
|
+
prospecting: "prospecting";
|
|
425
|
+
transactional: "transactional";
|
|
426
|
+
}>>;
|
|
427
|
+
reason: z.ZodEnum<{
|
|
428
|
+
complaint: "complaint";
|
|
429
|
+
dnc: "dnc";
|
|
430
|
+
hard_bounce: "hard_bounce";
|
|
431
|
+
invalid: "invalid";
|
|
432
|
+
manual: "manual";
|
|
433
|
+
stop_keyword: "stop_keyword";
|
|
434
|
+
unsubscribe: "unsubscribe";
|
|
435
|
+
}>;
|
|
436
|
+
sourceRef: z.ZodNullable<z.ZodString>;
|
|
437
|
+
liftedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
438
|
+
liftedBy: z.ZodNullable<z.ZodString>;
|
|
439
|
+
liftReason: z.ZodNullable<z.ZodString>;
|
|
440
|
+
createdAt: z.ZodISODateTime;
|
|
441
|
+
}, z.core.$strip>;
|
|
442
|
+
export declare const SuppressionListQuery: z.ZodObject<{
|
|
443
|
+
channel: z.ZodOptional<z.ZodEnum<{
|
|
444
|
+
email: "email";
|
|
445
|
+
postcard: "postcard";
|
|
446
|
+
push: "push";
|
|
447
|
+
sms: "sms";
|
|
448
|
+
whatsapp: "whatsapp";
|
|
449
|
+
}>>;
|
|
450
|
+
active: z.ZodOptional<z.ZodEnum<{
|
|
451
|
+
false: "false";
|
|
452
|
+
true: "true";
|
|
453
|
+
}>>;
|
|
454
|
+
q: z.ZodOptional<z.ZodString>;
|
|
455
|
+
reason: z.ZodOptional<z.ZodEnum<{
|
|
456
|
+
complaint: "complaint";
|
|
457
|
+
dnc: "dnc";
|
|
458
|
+
hard_bounce: "hard_bounce";
|
|
459
|
+
invalid: "invalid";
|
|
460
|
+
manual: "manual";
|
|
461
|
+
stop_keyword: "stop_keyword";
|
|
462
|
+
unsubscribe: "unsubscribe";
|
|
463
|
+
}>>;
|
|
464
|
+
domain: z.ZodOptional<z.ZodString>;
|
|
465
|
+
createdFrom: z.ZodOptional<z.ZodCoercedDate<unknown>>;
|
|
466
|
+
createdTo: z.ZodOptional<z.ZodCoercedDate<unknown>>;
|
|
467
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
468
|
+
cursor: z.ZodOptional<z.ZodUUID>;
|
|
469
|
+
}, z.core.$strip>;
|
|
470
|
+
export declare const LiftSuppressionBody: z.ZodObject<{
|
|
471
|
+
reason: z.ZodString;
|
|
472
|
+
}, z.core.$strip>;
|
|
473
|
+
export declare const BlocklistInput: z.ZodObject<{
|
|
474
|
+
domain: z.ZodString;
|
|
475
|
+
reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
476
|
+
}, z.core.$strip>;
|
|
477
|
+
export declare const BlocklistDto: z.ZodObject<{
|
|
478
|
+
id: z.ZodUUID;
|
|
479
|
+
domain: z.ZodString;
|
|
480
|
+
reason: z.ZodNullable<z.ZodString>;
|
|
481
|
+
createdAt: z.ZodISODateTime;
|
|
482
|
+
}, z.core.$strip>;
|
|
483
|
+
export declare const EligibilityRequest: z.ZodObject<{
|
|
484
|
+
profileId: z.ZodUUID;
|
|
485
|
+
channel: z.ZodEnum<{
|
|
486
|
+
email: "email";
|
|
487
|
+
postcard: "postcard";
|
|
488
|
+
push: "push";
|
|
489
|
+
sms: "sms";
|
|
490
|
+
whatsapp: "whatsapp";
|
|
491
|
+
}>;
|
|
492
|
+
purpose: z.ZodEnum<{
|
|
493
|
+
marketing: "marketing";
|
|
494
|
+
operational: "operational";
|
|
495
|
+
prospecting: "prospecting";
|
|
496
|
+
transactional: "transactional";
|
|
497
|
+
}>;
|
|
498
|
+
topicId: z.ZodOptional<z.ZodUUID>;
|
|
499
|
+
destination: z.ZodString;
|
|
500
|
+
recipientCountry: z.ZodOptional<z.ZodString>;
|
|
501
|
+
sequenceId: z.ZodOptional<z.ZodUUID>;
|
|
502
|
+
}, z.core.$strip>;
|
|
503
|
+
export type EligibilityRequest = z.infer<typeof EligibilityRequest>;
|
|
504
|
+
/** `liaId`: the legitimate-interest assessment that lifted this prospecting send's jurisdiction block. */
|
|
505
|
+
export declare const Eligibility: z.ZodObject<{
|
|
506
|
+
eligible: z.ZodBoolean;
|
|
507
|
+
reasons: z.ZodArray<z.ZodEnum<{
|
|
508
|
+
blocklisted_domain: "blocklisted_domain";
|
|
509
|
+
channel_not_preferred: "channel_not_preferred";
|
|
510
|
+
consent_expired: "consent_expired";
|
|
511
|
+
consent_revoked: "consent_revoked";
|
|
512
|
+
frequency_limited: "frequency_limited";
|
|
513
|
+
jurisdiction_blocked: "jurisdiction_blocked";
|
|
514
|
+
no_consent: "no_consent";
|
|
515
|
+
snoozed: "snoozed";
|
|
516
|
+
suppressed: "suppressed";
|
|
517
|
+
topic_unsubscribed: "topic_unsubscribed";
|
|
518
|
+
transactional_only: "transactional_only";
|
|
519
|
+
}>>;
|
|
520
|
+
liaId: z.ZodOptional<z.ZodString>;
|
|
521
|
+
}, z.core.$strip>;
|
|
522
|
+
export type Eligibility = z.infer<typeof Eligibility>;
|
|
523
|
+
/** Workspace-wide opt-outs (latest consent state revoked), filterable by channel and topic. */
|
|
524
|
+
export declare const OptoutListQuery: z.ZodObject<{
|
|
525
|
+
channel: z.ZodOptional<z.ZodEnum<{
|
|
526
|
+
email: "email";
|
|
527
|
+
postcard: "postcard";
|
|
528
|
+
push: "push";
|
|
529
|
+
sms: "sms";
|
|
530
|
+
whatsapp: "whatsapp";
|
|
531
|
+
}>>;
|
|
532
|
+
topicId: z.ZodOptional<z.ZodUnion<readonly [z.ZodUUID, z.ZodLiteral<"none">]>>;
|
|
533
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
534
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
535
|
+
}, z.core.$strip>;
|
|
536
|
+
export declare const OptoutDto: z.ZodObject<{
|
|
537
|
+
profileId: z.ZodUUID;
|
|
538
|
+
channel: z.ZodEnum<{
|
|
539
|
+
email: "email";
|
|
540
|
+
postcard: "postcard";
|
|
541
|
+
push: "push";
|
|
542
|
+
sms: "sms";
|
|
543
|
+
whatsapp: "whatsapp";
|
|
544
|
+
}>;
|
|
545
|
+
purpose: z.ZodString;
|
|
546
|
+
topicId: z.ZodNullable<z.ZodUUID>;
|
|
547
|
+
revokedAt: z.ZodISODateTime;
|
|
548
|
+
}, z.core.$strip>;
|
|
549
|
+
export declare const OptoutPage: z.ZodObject<{
|
|
550
|
+
items: z.ZodArray<z.ZodObject<{
|
|
551
|
+
profileId: z.ZodUUID;
|
|
552
|
+
channel: z.ZodEnum<{
|
|
553
|
+
email: "email";
|
|
554
|
+
postcard: "postcard";
|
|
555
|
+
push: "push";
|
|
556
|
+
sms: "sms";
|
|
557
|
+
whatsapp: "whatsapp";
|
|
558
|
+
}>;
|
|
559
|
+
purpose: z.ZodString;
|
|
560
|
+
topicId: z.ZodNullable<z.ZodUUID>;
|
|
561
|
+
revokedAt: z.ZodISODateTime;
|
|
562
|
+
}, z.core.$strip>>;
|
|
563
|
+
total: z.ZodNumber;
|
|
564
|
+
}, z.core.$strip>;
|
|
565
|
+
/** Clear hard-bounce suppressions in a date range (or one address); admin only, audited with the reason. */
|
|
566
|
+
export declare const BounceLiftBody: z.ZodObject<{
|
|
567
|
+
startDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
|
|
568
|
+
endDate: z.ZodOptional<z.ZodCoercedDate<unknown>>;
|
|
569
|
+
email: z.ZodOptional<z.ZodString>;
|
|
570
|
+
reason: z.ZodString;
|
|
571
|
+
}, z.core.$strip>;
|
|
572
|
+
export declare const BounceLiftResult: z.ZodObject<{
|
|
573
|
+
lifted: z.ZodNumber;
|
|
574
|
+
}, z.core.$strip>;
|
|
575
|
+
/** Legitimate-interest assessment (D-OUT-29): unlocks prospecting to the listed default-blocked countries until revoked. */
|
|
576
|
+
export declare const LiaInput: z.ZodObject<{
|
|
577
|
+
purpose: z.ZodString;
|
|
578
|
+
balancingTest: z.ZodString;
|
|
579
|
+
optOutWording: z.ZodString;
|
|
580
|
+
countries: z.ZodArray<z.ZodString>;
|
|
581
|
+
sequenceIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
|
|
582
|
+
segmentIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
|
|
583
|
+
reviewAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
|
|
584
|
+
expiresAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
|
|
585
|
+
documentAssetId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
586
|
+
}, z.core.$strip>;
|
|
587
|
+
/** Scope, dates and document of a recorded assessment; the assessment text itself is evidence and does not change (record a new one). */
|
|
588
|
+
export declare const LiaPatch: z.ZodObject<{
|
|
589
|
+
sequenceIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
|
|
590
|
+
segmentIds: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
|
|
591
|
+
reviewAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
|
|
592
|
+
expiresAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
|
|
593
|
+
documentAssetId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
594
|
+
}, z.core.$strip>;
|
|
595
|
+
export declare const LiaDto: z.ZodObject<{
|
|
596
|
+
id: z.ZodUUID;
|
|
597
|
+
purpose: z.ZodString;
|
|
598
|
+
balancingTest: z.ZodString;
|
|
599
|
+
optOutWording: z.ZodString;
|
|
600
|
+
countries: z.ZodArray<z.ZodString>;
|
|
601
|
+
assessedBy: z.ZodNullable<z.ZodUUID>;
|
|
602
|
+
revokedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
603
|
+
createdAt: z.ZodISODateTime;
|
|
604
|
+
sequenceIds: z.ZodArray<z.ZodUUID>;
|
|
605
|
+
segmentIds: z.ZodArray<z.ZodUUID>;
|
|
606
|
+
reviewAt: z.ZodNullable<z.ZodISODateTime>;
|
|
607
|
+
expiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
608
|
+
documentAssetId: z.ZodNullable<z.ZodUUID>;
|
|
609
|
+
}, z.core.$strip>;
|
|
610
|
+
export declare const LiaList: z.ZodObject<{
|
|
611
|
+
items: z.ZodArray<z.ZodObject<{
|
|
612
|
+
id: z.ZodUUID;
|
|
613
|
+
purpose: z.ZodString;
|
|
614
|
+
balancingTest: z.ZodString;
|
|
615
|
+
optOutWording: z.ZodString;
|
|
616
|
+
countries: z.ZodArray<z.ZodString>;
|
|
617
|
+
assessedBy: z.ZodNullable<z.ZodUUID>;
|
|
618
|
+
revokedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
619
|
+
createdAt: z.ZodISODateTime;
|
|
620
|
+
sequenceIds: z.ZodArray<z.ZodUUID>;
|
|
621
|
+
segmentIds: z.ZodArray<z.ZodUUID>;
|
|
622
|
+
reviewAt: z.ZodNullable<z.ZodISODateTime>;
|
|
623
|
+
expiresAt: z.ZodNullable<z.ZodISODateTime>;
|
|
624
|
+
documentAssetId: z.ZodNullable<z.ZodUUID>;
|
|
625
|
+
}, z.core.$strip>>;
|
|
626
|
+
blockedCountries: z.ZodArray<z.ZodString>;
|
|
627
|
+
unlockableCountries: z.ZodArray<z.ZodString>;
|
|
628
|
+
}, z.core.$strip>;
|