samva 0.22.0 → 0.22.1
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/README.md +1 -1
- package/dist/effect/analytics.d.ts +6 -41
- package/dist/effect/api-keys.d.ts +8 -236
- package/dist/effect/attachments.d.ts +4 -43
- package/dist/effect/brands.d.ts +6 -155
- package/dist/effect/campaigns.d.ts +12 -868
- package/dist/effect/contact-groups.d.ts +10 -135
- package/dist/effect/contacts.d.ts +21 -727
- package/dist/effect/conversations.d.ts +13 -681
- package/dist/effect/custom-fields.d.ts +4 -44
- package/dist/effect/email.d.ts +61 -1299
- package/dist/effect/events.d.ts +2 -32
- package/dist/effect/extension-installations.d.ts +9 -213
- package/dist/effect/extensions.d.ts +5 -95
- package/dist/effect/feedback.d.ts +1 -4
- package/dist/effect/internal/client.d.ts +5 -1
- package/dist/effect/internal/operation.d.ts +3 -3
- package/dist/effect/internal/send.d.ts +3 -3
- package/dist/effect/journeys.d.ts +167 -1836
- package/dist/effect/mailboxes.d.ts +60 -2362
- package/dist/effect/media.d.ts +5 -66
- package/dist/effect/messages.d.ts +9 -264
- package/dist/effect/namespaces.d.ts +8 -55
- package/dist/effect/operations.d.ts +3 -84
- package/dist/effect/organizations.d.ts +7 -161
- package/dist/effect/scheduled-messages.d.ts +5 -401
- package/dist/effect/subscriptions.d.ts +1 -4
- package/dist/effect/templates.d.ts +34 -1506
- package/dist/effect/unsubscribe-groups.d.ts +9 -70
- package/dist/effect/webhooks.d.ts +11 -141
- package/dist/effect/whoami.d.ts +1 -46
- package/dist/package.js +1 -1
- package/package.json +7 -7
|
@@ -2,84 +2,7 @@ export declare const list: ((input?: {
|
|
|
2
2
|
readonly status?: "archived" | "draft" | null | undefined;
|
|
3
3
|
readonly limit?: string | null | undefined;
|
|
4
4
|
readonly cursor?: string | null | undefined;
|
|
5
|
-
} | undefined) => import("
|
|
6
|
-
readonly items: readonly {
|
|
7
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignId">;
|
|
8
|
-
readonly name: string;
|
|
9
|
-
readonly channel: "email";
|
|
10
|
-
readonly content: {
|
|
11
|
-
readonly channel: "email";
|
|
12
|
-
readonly email: {
|
|
13
|
-
readonly subject?: string | null;
|
|
14
|
-
readonly html?: string | null;
|
|
15
|
-
readonly text?: string | null;
|
|
16
|
-
readonly attachments?: readonly {
|
|
17
|
-
readonly filename: string;
|
|
18
|
-
readonly content?: string | null;
|
|
19
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
20
|
-
readonly contentType: string;
|
|
21
|
-
readonly size: number;
|
|
22
|
-
}[] | null;
|
|
23
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
24
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
25
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
26
|
-
readonly templateSlug?: string | null;
|
|
27
|
-
readonly templateData?: {
|
|
28
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
29
|
-
} | null;
|
|
30
|
-
readonly locale?: string;
|
|
31
|
-
readonly timeZone?: string;
|
|
32
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
33
|
-
readonly replyTo?: readonly string[] | null;
|
|
34
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
35
|
-
readonly tracking?: {
|
|
36
|
-
readonly opens?: boolean;
|
|
37
|
-
readonly clicks?: boolean;
|
|
38
|
-
};
|
|
39
|
-
readonly footer?: {
|
|
40
|
-
readonly enabled?: boolean | null;
|
|
41
|
-
};
|
|
42
|
-
};
|
|
43
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
44
|
-
readonly metadata?: {
|
|
45
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
46
|
-
} | null;
|
|
47
|
-
};
|
|
48
|
-
readonly audience: {
|
|
49
|
-
readonly includeTags?: readonly string[] | null;
|
|
50
|
-
readonly excludeTags?: readonly string[] | null;
|
|
51
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
52
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
53
|
-
};
|
|
54
|
-
readonly policy: {
|
|
55
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
56
|
-
readonly pageSize?: number | null;
|
|
57
|
-
};
|
|
58
|
-
readonly definition: {
|
|
59
|
-
readonly state: "archived" | "editable" | "frozen";
|
|
60
|
-
readonly frozenAt: string | null;
|
|
61
|
-
};
|
|
62
|
-
readonly latestRun: {
|
|
63
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
64
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
65
|
-
readonly scheduledFor: string;
|
|
66
|
-
readonly completedAt: string | null;
|
|
67
|
-
readonly totalRecipients: number;
|
|
68
|
-
readonly dispatchedCount: number;
|
|
69
|
-
readonly failedCount: number;
|
|
70
|
-
readonly skippedCount: number;
|
|
71
|
-
readonly pendingCount: number;
|
|
72
|
-
readonly estimatedCompletionAt: string | null;
|
|
73
|
-
} | null;
|
|
74
|
-
readonly createdBy: string | null;
|
|
75
|
-
readonly actorEmail: string;
|
|
76
|
-
readonly memberRole: string;
|
|
77
|
-
readonly createdAt: string;
|
|
78
|
-
readonly updatedAt: string;
|
|
79
|
-
readonly series: readonly number[];
|
|
80
|
-
}[];
|
|
81
|
-
readonly nextCursor: string | null;
|
|
82
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
5
|
+
} | undefined) => import("./internal/operation").OperationResult<"campaignsList">) & {
|
|
83
6
|
readonly pages: (input?: {
|
|
84
7
|
readonly status?: "archived" | "draft" | null | undefined;
|
|
85
8
|
readonly limit?: string | null | undefined;
|
|
@@ -341,232 +264,13 @@ export declare const create: (input: {
|
|
|
341
264
|
readonly unsubscribeGroupId?: string | null | undefined;
|
|
342
265
|
readonly pageSize?: number | null | undefined;
|
|
343
266
|
} | null | undefined;
|
|
344
|
-
}) => import("
|
|
345
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignId">;
|
|
346
|
-
readonly name: string;
|
|
347
|
-
readonly channel: "email";
|
|
348
|
-
readonly content: {
|
|
349
|
-
readonly channel: "email";
|
|
350
|
-
readonly email: {
|
|
351
|
-
readonly subject?: string | null;
|
|
352
|
-
readonly html?: string | null;
|
|
353
|
-
readonly text?: string | null;
|
|
354
|
-
readonly attachments?: readonly {
|
|
355
|
-
readonly filename: string;
|
|
356
|
-
readonly content?: string | null;
|
|
357
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
358
|
-
readonly contentType: string;
|
|
359
|
-
readonly size: number;
|
|
360
|
-
}[] | null;
|
|
361
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
362
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
363
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
364
|
-
readonly templateSlug?: string | null;
|
|
365
|
-
readonly templateData?: {
|
|
366
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
367
|
-
} | null;
|
|
368
|
-
readonly locale?: string;
|
|
369
|
-
readonly timeZone?: string;
|
|
370
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
371
|
-
readonly replyTo?: readonly string[] | null;
|
|
372
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
373
|
-
readonly tracking?: {
|
|
374
|
-
readonly opens?: boolean;
|
|
375
|
-
readonly clicks?: boolean;
|
|
376
|
-
};
|
|
377
|
-
readonly footer?: {
|
|
378
|
-
readonly enabled?: boolean | null;
|
|
379
|
-
};
|
|
380
|
-
};
|
|
381
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
382
|
-
readonly metadata?: {
|
|
383
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
384
|
-
} | null;
|
|
385
|
-
};
|
|
386
|
-
readonly audience: {
|
|
387
|
-
readonly includeTags?: readonly string[] | null;
|
|
388
|
-
readonly excludeTags?: readonly string[] | null;
|
|
389
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
390
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
391
|
-
};
|
|
392
|
-
readonly policy: {
|
|
393
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
394
|
-
readonly pageSize?: number | null;
|
|
395
|
-
};
|
|
396
|
-
readonly definition: {
|
|
397
|
-
readonly state: "archived" | "editable" | "frozen";
|
|
398
|
-
readonly frozenAt: string | null;
|
|
399
|
-
};
|
|
400
|
-
readonly latestRun: {
|
|
401
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
402
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
403
|
-
readonly scheduledFor: string;
|
|
404
|
-
readonly completedAt: string | null;
|
|
405
|
-
readonly totalRecipients: number;
|
|
406
|
-
readonly dispatchedCount: number;
|
|
407
|
-
readonly failedCount: number;
|
|
408
|
-
readonly skippedCount: number;
|
|
409
|
-
readonly pendingCount: number;
|
|
410
|
-
readonly estimatedCompletionAt: string | null;
|
|
411
|
-
} | null;
|
|
412
|
-
readonly createdBy: string | null;
|
|
413
|
-
readonly actorEmail: string;
|
|
414
|
-
readonly memberRole: string;
|
|
415
|
-
readonly createdAt: string;
|
|
416
|
-
readonly updatedAt: string;
|
|
417
|
-
}, import("./errors").FlagDisabledError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
267
|
+
}) => import("./internal/operation").OperationResult<"campaignsCreate">;
|
|
418
268
|
export declare const get: (input: {
|
|
419
269
|
readonly id: string;
|
|
420
|
-
}) => import("
|
|
421
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignId">;
|
|
422
|
-
readonly name: string;
|
|
423
|
-
readonly channel: "email";
|
|
424
|
-
readonly content: {
|
|
425
|
-
readonly channel: "email";
|
|
426
|
-
readonly email: {
|
|
427
|
-
readonly subject?: string | null;
|
|
428
|
-
readonly html?: string | null;
|
|
429
|
-
readonly text?: string | null;
|
|
430
|
-
readonly attachments?: readonly {
|
|
431
|
-
readonly filename: string;
|
|
432
|
-
readonly content?: string | null;
|
|
433
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
434
|
-
readonly contentType: string;
|
|
435
|
-
readonly size: number;
|
|
436
|
-
}[] | null;
|
|
437
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
438
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
439
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
440
|
-
readonly templateSlug?: string | null;
|
|
441
|
-
readonly templateData?: {
|
|
442
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
443
|
-
} | null;
|
|
444
|
-
readonly locale?: string;
|
|
445
|
-
readonly timeZone?: string;
|
|
446
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
447
|
-
readonly replyTo?: readonly string[] | null;
|
|
448
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
449
|
-
readonly tracking?: {
|
|
450
|
-
readonly opens?: boolean;
|
|
451
|
-
readonly clicks?: boolean;
|
|
452
|
-
};
|
|
453
|
-
readonly footer?: {
|
|
454
|
-
readonly enabled?: boolean | null;
|
|
455
|
-
};
|
|
456
|
-
};
|
|
457
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
458
|
-
readonly metadata?: {
|
|
459
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
460
|
-
} | null;
|
|
461
|
-
};
|
|
462
|
-
readonly audience: {
|
|
463
|
-
readonly includeTags?: readonly string[] | null;
|
|
464
|
-
readonly excludeTags?: readonly string[] | null;
|
|
465
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
466
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
467
|
-
};
|
|
468
|
-
readonly policy: {
|
|
469
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
470
|
-
readonly pageSize?: number | null;
|
|
471
|
-
};
|
|
472
|
-
readonly definition: {
|
|
473
|
-
readonly state: "archived" | "editable" | "frozen";
|
|
474
|
-
readonly frozenAt: string | null;
|
|
475
|
-
};
|
|
476
|
-
readonly latestRun: {
|
|
477
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
478
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
479
|
-
readonly scheduledFor: string;
|
|
480
|
-
readonly completedAt: string | null;
|
|
481
|
-
readonly totalRecipients: number;
|
|
482
|
-
readonly dispatchedCount: number;
|
|
483
|
-
readonly failedCount: number;
|
|
484
|
-
readonly skippedCount: number;
|
|
485
|
-
readonly pendingCount: number;
|
|
486
|
-
readonly estimatedCompletionAt: string | null;
|
|
487
|
-
} | null;
|
|
488
|
-
readonly createdBy: string | null;
|
|
489
|
-
readonly actorEmail: string;
|
|
490
|
-
readonly memberRole: string;
|
|
491
|
-
readonly createdAt: string;
|
|
492
|
-
readonly updatedAt: string;
|
|
493
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
270
|
+
}) => import("./internal/operation").OperationResult<"campaignsGet">;
|
|
494
271
|
export declare const archive: (input: {
|
|
495
272
|
readonly id: string;
|
|
496
|
-
}) => import("
|
|
497
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignId">;
|
|
498
|
-
readonly name: string;
|
|
499
|
-
readonly channel: "email";
|
|
500
|
-
readonly content: {
|
|
501
|
-
readonly channel: "email";
|
|
502
|
-
readonly email: {
|
|
503
|
-
readonly subject?: string | null;
|
|
504
|
-
readonly html?: string | null;
|
|
505
|
-
readonly text?: string | null;
|
|
506
|
-
readonly attachments?: readonly {
|
|
507
|
-
readonly filename: string;
|
|
508
|
-
readonly content?: string | null;
|
|
509
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
510
|
-
readonly contentType: string;
|
|
511
|
-
readonly size: number;
|
|
512
|
-
}[] | null;
|
|
513
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
514
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
515
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
516
|
-
readonly templateSlug?: string | null;
|
|
517
|
-
readonly templateData?: {
|
|
518
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
519
|
-
} | null;
|
|
520
|
-
readonly locale?: string;
|
|
521
|
-
readonly timeZone?: string;
|
|
522
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
523
|
-
readonly replyTo?: readonly string[] | null;
|
|
524
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
525
|
-
readonly tracking?: {
|
|
526
|
-
readonly opens?: boolean;
|
|
527
|
-
readonly clicks?: boolean;
|
|
528
|
-
};
|
|
529
|
-
readonly footer?: {
|
|
530
|
-
readonly enabled?: boolean | null;
|
|
531
|
-
};
|
|
532
|
-
};
|
|
533
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
534
|
-
readonly metadata?: {
|
|
535
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
536
|
-
} | null;
|
|
537
|
-
};
|
|
538
|
-
readonly audience: {
|
|
539
|
-
readonly includeTags?: readonly string[] | null;
|
|
540
|
-
readonly excludeTags?: readonly string[] | null;
|
|
541
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
542
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
543
|
-
};
|
|
544
|
-
readonly policy: {
|
|
545
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
546
|
-
readonly pageSize?: number | null;
|
|
547
|
-
};
|
|
548
|
-
readonly definition: {
|
|
549
|
-
readonly state: "archived" | "editable" | "frozen";
|
|
550
|
-
readonly frozenAt: string | null;
|
|
551
|
-
};
|
|
552
|
-
readonly latestRun: {
|
|
553
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
554
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
555
|
-
readonly scheduledFor: string;
|
|
556
|
-
readonly completedAt: string | null;
|
|
557
|
-
readonly totalRecipients: number;
|
|
558
|
-
readonly dispatchedCount: number;
|
|
559
|
-
readonly failedCount: number;
|
|
560
|
-
readonly skippedCount: number;
|
|
561
|
-
readonly pendingCount: number;
|
|
562
|
-
readonly estimatedCompletionAt: string | null;
|
|
563
|
-
} | null;
|
|
564
|
-
readonly createdBy: string | null;
|
|
565
|
-
readonly actorEmail: string;
|
|
566
|
-
readonly memberRole: string;
|
|
567
|
-
readonly createdAt: string;
|
|
568
|
-
readonly updatedAt: string;
|
|
569
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
273
|
+
}) => import("./internal/operation").OperationResult<"campaignsArchive">;
|
|
570
274
|
export declare const update: (input: {
|
|
571
275
|
readonly id: string;
|
|
572
276
|
readonly name?: string | null | undefined;
|
|
@@ -666,166 +370,13 @@ export declare const update: (input: {
|
|
|
666
370
|
readonly unsubscribeGroupId?: string | null | undefined;
|
|
667
371
|
readonly pageSize?: number | null | undefined;
|
|
668
372
|
} | null | undefined;
|
|
669
|
-
}) => import("
|
|
670
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignId">;
|
|
671
|
-
readonly name: string;
|
|
672
|
-
readonly channel: "email";
|
|
673
|
-
readonly content: {
|
|
674
|
-
readonly channel: "email";
|
|
675
|
-
readonly email: {
|
|
676
|
-
readonly subject?: string | null;
|
|
677
|
-
readonly html?: string | null;
|
|
678
|
-
readonly text?: string | null;
|
|
679
|
-
readonly attachments?: readonly {
|
|
680
|
-
readonly filename: string;
|
|
681
|
-
readonly content?: string | null;
|
|
682
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
683
|
-
readonly contentType: string;
|
|
684
|
-
readonly size: number;
|
|
685
|
-
}[] | null;
|
|
686
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
687
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
688
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
689
|
-
readonly templateSlug?: string | null;
|
|
690
|
-
readonly templateData?: {
|
|
691
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
692
|
-
} | null;
|
|
693
|
-
readonly locale?: string;
|
|
694
|
-
readonly timeZone?: string;
|
|
695
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
696
|
-
readonly replyTo?: readonly string[] | null;
|
|
697
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
698
|
-
readonly tracking?: {
|
|
699
|
-
readonly opens?: boolean;
|
|
700
|
-
readonly clicks?: boolean;
|
|
701
|
-
};
|
|
702
|
-
readonly footer?: {
|
|
703
|
-
readonly enabled?: boolean | null;
|
|
704
|
-
};
|
|
705
|
-
};
|
|
706
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
707
|
-
readonly metadata?: {
|
|
708
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
709
|
-
} | null;
|
|
710
|
-
};
|
|
711
|
-
readonly audience: {
|
|
712
|
-
readonly includeTags?: readonly string[] | null;
|
|
713
|
-
readonly excludeTags?: readonly string[] | null;
|
|
714
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
715
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
716
|
-
};
|
|
717
|
-
readonly policy: {
|
|
718
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
719
|
-
readonly pageSize?: number | null;
|
|
720
|
-
};
|
|
721
|
-
readonly definition: {
|
|
722
|
-
readonly state: "archived" | "editable" | "frozen";
|
|
723
|
-
readonly frozenAt: string | null;
|
|
724
|
-
};
|
|
725
|
-
readonly latestRun: {
|
|
726
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
727
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
728
|
-
readonly scheduledFor: string;
|
|
729
|
-
readonly completedAt: string | null;
|
|
730
|
-
readonly totalRecipients: number;
|
|
731
|
-
readonly dispatchedCount: number;
|
|
732
|
-
readonly failedCount: number;
|
|
733
|
-
readonly skippedCount: number;
|
|
734
|
-
readonly pendingCount: number;
|
|
735
|
-
readonly estimatedCompletionAt: string | null;
|
|
736
|
-
} | null;
|
|
737
|
-
readonly createdBy: string | null;
|
|
738
|
-
readonly actorEmail: string;
|
|
739
|
-
readonly memberRole: string;
|
|
740
|
-
readonly createdAt: string;
|
|
741
|
-
readonly updatedAt: string;
|
|
742
|
-
}, import("./errors").ConflictError | import("./errors").FlagDisabledError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
373
|
+
}) => import("./internal/operation").OperationResult<"campaignsUpdate">;
|
|
743
374
|
export declare const listRuns: ((input: {
|
|
744
375
|
readonly id: string;
|
|
745
376
|
readonly status?: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled" | null | undefined;
|
|
746
377
|
readonly limit?: string | null | undefined;
|
|
747
378
|
readonly cursor?: string | null | undefined;
|
|
748
|
-
}) => import("
|
|
749
|
-
readonly items: readonly {
|
|
750
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
751
|
-
readonly campaignId: string & import("effect/Brand").Brand<"CampaignId">;
|
|
752
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
753
|
-
readonly scheduledFor: string;
|
|
754
|
-
readonly idempotencyKey: string | null;
|
|
755
|
-
readonly startedAt: string | null;
|
|
756
|
-
readonly completedAt: string | null;
|
|
757
|
-
readonly contentSnapshot: {
|
|
758
|
-
readonly channel: "email";
|
|
759
|
-
readonly email: {
|
|
760
|
-
readonly subject?: string | null;
|
|
761
|
-
readonly html?: string | null;
|
|
762
|
-
readonly text?: string | null;
|
|
763
|
-
readonly attachments?: readonly {
|
|
764
|
-
readonly filename: string;
|
|
765
|
-
readonly content?: string | null;
|
|
766
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
767
|
-
readonly contentType: string;
|
|
768
|
-
readonly size: number;
|
|
769
|
-
}[] | null;
|
|
770
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
771
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
772
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
773
|
-
readonly templateSlug?: string | null;
|
|
774
|
-
readonly templateData?: {
|
|
775
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
776
|
-
} | null;
|
|
777
|
-
readonly locale?: string;
|
|
778
|
-
readonly timeZone?: string;
|
|
779
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
780
|
-
readonly replyTo?: readonly string[] | null;
|
|
781
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
782
|
-
readonly tracking?: {
|
|
783
|
-
readonly opens?: boolean;
|
|
784
|
-
readonly clicks?: boolean;
|
|
785
|
-
};
|
|
786
|
-
readonly footer?: {
|
|
787
|
-
readonly enabled?: boolean | null;
|
|
788
|
-
};
|
|
789
|
-
};
|
|
790
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
791
|
-
readonly metadata?: {
|
|
792
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
793
|
-
} | null;
|
|
794
|
-
};
|
|
795
|
-
readonly audienceSnapshot: {
|
|
796
|
-
readonly includeTags?: readonly string[] | null;
|
|
797
|
-
readonly excludeTags?: readonly string[] | null;
|
|
798
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
799
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
800
|
-
};
|
|
801
|
-
readonly policySnapshot: {
|
|
802
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
803
|
-
readonly pageSize?: number | null;
|
|
804
|
-
};
|
|
805
|
-
readonly totalRecipients: number;
|
|
806
|
-
readonly dispatchedCount: number;
|
|
807
|
-
readonly failedCount: number;
|
|
808
|
-
readonly skippedCount: number;
|
|
809
|
-
readonly pendingCount: number;
|
|
810
|
-
readonly skippedReasons: readonly {
|
|
811
|
-
readonly reason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed";
|
|
812
|
-
readonly count: number;
|
|
813
|
-
}[];
|
|
814
|
-
readonly estimatedCompletionAt: string | null;
|
|
815
|
-
readonly failureReason: string | null;
|
|
816
|
-
readonly holdReason: string | null;
|
|
817
|
-
readonly holdDomainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
818
|
-
readonly holdUntil: string | null;
|
|
819
|
-
readonly capacityWarning: string | null;
|
|
820
|
-
readonly lastContactId: string | null;
|
|
821
|
-
readonly createdBy: string | null;
|
|
822
|
-
readonly actorEmail: string;
|
|
823
|
-
readonly memberRole: string;
|
|
824
|
-
readonly createdAt: string;
|
|
825
|
-
readonly updatedAt: string;
|
|
826
|
-
}[];
|
|
827
|
-
readonly nextCursor: string | null;
|
|
828
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
379
|
+
}) => import("./internal/operation").OperationResult<"campaignsListRuns">) & {
|
|
829
380
|
readonly pages: (input: {
|
|
830
381
|
readonly id: string;
|
|
831
382
|
readonly status?: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled" | null | undefined;
|
|
@@ -1000,437 +551,30 @@ export declare const scheduleRun: (input: {
|
|
|
1000
551
|
readonly id: string;
|
|
1001
552
|
readonly scheduledFor?: Date | null | undefined;
|
|
1002
553
|
readonly idempotencyKey?: string | null | undefined;
|
|
1003
|
-
}) => import("
|
|
1004
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
1005
|
-
readonly campaignId: string & import("effect/Brand").Brand<"CampaignId">;
|
|
1006
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
1007
|
-
readonly scheduledFor: string;
|
|
1008
|
-
readonly idempotencyKey: string | null;
|
|
1009
|
-
readonly startedAt: string | null;
|
|
1010
|
-
readonly completedAt: string | null;
|
|
1011
|
-
readonly contentSnapshot: {
|
|
1012
|
-
readonly channel: "email";
|
|
1013
|
-
readonly email: {
|
|
1014
|
-
readonly subject?: string | null;
|
|
1015
|
-
readonly html?: string | null;
|
|
1016
|
-
readonly text?: string | null;
|
|
1017
|
-
readonly attachments?: readonly {
|
|
1018
|
-
readonly filename: string;
|
|
1019
|
-
readonly content?: string | null;
|
|
1020
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
1021
|
-
readonly contentType: string;
|
|
1022
|
-
readonly size: number;
|
|
1023
|
-
}[] | null;
|
|
1024
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
1025
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
1026
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
1027
|
-
readonly templateSlug?: string | null;
|
|
1028
|
-
readonly templateData?: {
|
|
1029
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1030
|
-
} | null;
|
|
1031
|
-
readonly locale?: string;
|
|
1032
|
-
readonly timeZone?: string;
|
|
1033
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1034
|
-
readonly replyTo?: readonly string[] | null;
|
|
1035
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1036
|
-
readonly tracking?: {
|
|
1037
|
-
readonly opens?: boolean;
|
|
1038
|
-
readonly clicks?: boolean;
|
|
1039
|
-
};
|
|
1040
|
-
readonly footer?: {
|
|
1041
|
-
readonly enabled?: boolean | null;
|
|
1042
|
-
};
|
|
1043
|
-
};
|
|
1044
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
1045
|
-
readonly metadata?: {
|
|
1046
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1047
|
-
} | null;
|
|
1048
|
-
};
|
|
1049
|
-
readonly audienceSnapshot: {
|
|
1050
|
-
readonly includeTags?: readonly string[] | null;
|
|
1051
|
-
readonly excludeTags?: readonly string[] | null;
|
|
1052
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
1053
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
1054
|
-
};
|
|
1055
|
-
readonly policySnapshot: {
|
|
1056
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1057
|
-
readonly pageSize?: number | null;
|
|
1058
|
-
};
|
|
1059
|
-
readonly totalRecipients: number;
|
|
1060
|
-
readonly dispatchedCount: number;
|
|
1061
|
-
readonly failedCount: number;
|
|
1062
|
-
readonly skippedCount: number;
|
|
1063
|
-
readonly pendingCount: number;
|
|
1064
|
-
readonly skippedReasons: readonly {
|
|
1065
|
-
readonly reason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed";
|
|
1066
|
-
readonly count: number;
|
|
1067
|
-
}[];
|
|
1068
|
-
readonly estimatedCompletionAt: string | null;
|
|
1069
|
-
readonly failureReason: string | null;
|
|
1070
|
-
readonly holdReason: string | null;
|
|
1071
|
-
readonly holdDomainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1072
|
-
readonly holdUntil: string | null;
|
|
1073
|
-
readonly capacityWarning: string | null;
|
|
1074
|
-
readonly lastContactId: string | null;
|
|
1075
|
-
readonly createdBy: string | null;
|
|
1076
|
-
readonly actorEmail: string;
|
|
1077
|
-
readonly memberRole: string;
|
|
1078
|
-
readonly createdAt: string;
|
|
1079
|
-
readonly updatedAt: string;
|
|
1080
|
-
}, import("./errors").BrandAddressRequiredError | import("./errors").CampaignFooterRequiredError | import("./errors").ConflictError | import("./errors").ExternalServiceError | import("./errors").FlagDisabledError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").SenderNotReadyError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
554
|
+
}) => import("./internal/operation").OperationResult<"campaignsScheduleRun">;
|
|
1081
555
|
export declare const getRun: (input: {
|
|
1082
556
|
readonly id: string;
|
|
1083
557
|
readonly runId: string;
|
|
1084
|
-
}) => import("
|
|
1085
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
1086
|
-
readonly campaignId: string & import("effect/Brand").Brand<"CampaignId">;
|
|
1087
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
1088
|
-
readonly scheduledFor: string;
|
|
1089
|
-
readonly idempotencyKey: string | null;
|
|
1090
|
-
readonly startedAt: string | null;
|
|
1091
|
-
readonly completedAt: string | null;
|
|
1092
|
-
readonly contentSnapshot: {
|
|
1093
|
-
readonly channel: "email";
|
|
1094
|
-
readonly email: {
|
|
1095
|
-
readonly subject?: string | null;
|
|
1096
|
-
readonly html?: string | null;
|
|
1097
|
-
readonly text?: string | null;
|
|
1098
|
-
readonly attachments?: readonly {
|
|
1099
|
-
readonly filename: string;
|
|
1100
|
-
readonly content?: string | null;
|
|
1101
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
1102
|
-
readonly contentType: string;
|
|
1103
|
-
readonly size: number;
|
|
1104
|
-
}[] | null;
|
|
1105
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
1106
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
1107
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
1108
|
-
readonly templateSlug?: string | null;
|
|
1109
|
-
readonly templateData?: {
|
|
1110
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1111
|
-
} | null;
|
|
1112
|
-
readonly locale?: string;
|
|
1113
|
-
readonly timeZone?: string;
|
|
1114
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1115
|
-
readonly replyTo?: readonly string[] | null;
|
|
1116
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1117
|
-
readonly tracking?: {
|
|
1118
|
-
readonly opens?: boolean;
|
|
1119
|
-
readonly clicks?: boolean;
|
|
1120
|
-
};
|
|
1121
|
-
readonly footer?: {
|
|
1122
|
-
readonly enabled?: boolean | null;
|
|
1123
|
-
};
|
|
1124
|
-
};
|
|
1125
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
1126
|
-
readonly metadata?: {
|
|
1127
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1128
|
-
} | null;
|
|
1129
|
-
};
|
|
1130
|
-
readonly audienceSnapshot: {
|
|
1131
|
-
readonly includeTags?: readonly string[] | null;
|
|
1132
|
-
readonly excludeTags?: readonly string[] | null;
|
|
1133
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
1134
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
1135
|
-
};
|
|
1136
|
-
readonly policySnapshot: {
|
|
1137
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1138
|
-
readonly pageSize?: number | null;
|
|
1139
|
-
};
|
|
1140
|
-
readonly totalRecipients: number;
|
|
1141
|
-
readonly dispatchedCount: number;
|
|
1142
|
-
readonly failedCount: number;
|
|
1143
|
-
readonly skippedCount: number;
|
|
1144
|
-
readonly pendingCount: number;
|
|
1145
|
-
readonly skippedReasons: readonly {
|
|
1146
|
-
readonly reason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed";
|
|
1147
|
-
readonly count: number;
|
|
1148
|
-
}[];
|
|
1149
|
-
readonly estimatedCompletionAt: string | null;
|
|
1150
|
-
readonly failureReason: string | null;
|
|
1151
|
-
readonly holdReason: string | null;
|
|
1152
|
-
readonly holdDomainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1153
|
-
readonly holdUntil: string | null;
|
|
1154
|
-
readonly capacityWarning: string | null;
|
|
1155
|
-
readonly lastContactId: string | null;
|
|
1156
|
-
readonly createdBy: string | null;
|
|
1157
|
-
readonly actorEmail: string;
|
|
1158
|
-
readonly memberRole: string;
|
|
1159
|
-
readonly createdAt: string;
|
|
1160
|
-
readonly updatedAt: string;
|
|
1161
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
558
|
+
}) => import("./internal/operation").OperationResult<"campaignsGetRun">;
|
|
1162
559
|
export declare const pauseRun: (input: {
|
|
1163
560
|
readonly id: string;
|
|
1164
561
|
readonly runId: string;
|
|
1165
|
-
}) => import("
|
|
1166
|
-
readonly success: boolean;
|
|
1167
|
-
readonly item: {
|
|
1168
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
1169
|
-
readonly campaignId: string & import("effect/Brand").Brand<"CampaignId">;
|
|
1170
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
1171
|
-
readonly scheduledFor: string;
|
|
1172
|
-
readonly idempotencyKey: string | null;
|
|
1173
|
-
readonly startedAt: string | null;
|
|
1174
|
-
readonly completedAt: string | null;
|
|
1175
|
-
readonly contentSnapshot: {
|
|
1176
|
-
readonly channel: "email";
|
|
1177
|
-
readonly email: {
|
|
1178
|
-
readonly subject?: string | null;
|
|
1179
|
-
readonly html?: string | null;
|
|
1180
|
-
readonly text?: string | null;
|
|
1181
|
-
readonly attachments?: readonly {
|
|
1182
|
-
readonly filename: string;
|
|
1183
|
-
readonly content?: string | null;
|
|
1184
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
1185
|
-
readonly contentType: string;
|
|
1186
|
-
readonly size: number;
|
|
1187
|
-
}[] | null;
|
|
1188
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
1189
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
1190
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
1191
|
-
readonly templateSlug?: string | null;
|
|
1192
|
-
readonly templateData?: {
|
|
1193
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1194
|
-
} | null;
|
|
1195
|
-
readonly locale?: string;
|
|
1196
|
-
readonly timeZone?: string;
|
|
1197
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1198
|
-
readonly replyTo?: readonly string[] | null;
|
|
1199
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1200
|
-
readonly tracking?: {
|
|
1201
|
-
readonly opens?: boolean;
|
|
1202
|
-
readonly clicks?: boolean;
|
|
1203
|
-
};
|
|
1204
|
-
readonly footer?: {
|
|
1205
|
-
readonly enabled?: boolean | null;
|
|
1206
|
-
};
|
|
1207
|
-
};
|
|
1208
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
1209
|
-
readonly metadata?: {
|
|
1210
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1211
|
-
} | null;
|
|
1212
|
-
};
|
|
1213
|
-
readonly audienceSnapshot: {
|
|
1214
|
-
readonly includeTags?: readonly string[] | null;
|
|
1215
|
-
readonly excludeTags?: readonly string[] | null;
|
|
1216
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
1217
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
1218
|
-
};
|
|
1219
|
-
readonly policySnapshot: {
|
|
1220
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1221
|
-
readonly pageSize?: number | null;
|
|
1222
|
-
};
|
|
1223
|
-
readonly totalRecipients: number;
|
|
1224
|
-
readonly dispatchedCount: number;
|
|
1225
|
-
readonly failedCount: number;
|
|
1226
|
-
readonly skippedCount: number;
|
|
1227
|
-
readonly pendingCount: number;
|
|
1228
|
-
readonly skippedReasons: readonly {
|
|
1229
|
-
readonly reason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed";
|
|
1230
|
-
readonly count: number;
|
|
1231
|
-
}[];
|
|
1232
|
-
readonly estimatedCompletionAt: string | null;
|
|
1233
|
-
readonly failureReason: string | null;
|
|
1234
|
-
readonly holdReason: string | null;
|
|
1235
|
-
readonly holdDomainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1236
|
-
readonly holdUntil: string | null;
|
|
1237
|
-
readonly capacityWarning: string | null;
|
|
1238
|
-
readonly lastContactId: string | null;
|
|
1239
|
-
readonly createdBy: string | null;
|
|
1240
|
-
readonly actorEmail: string;
|
|
1241
|
-
readonly memberRole: string;
|
|
1242
|
-
readonly createdAt: string;
|
|
1243
|
-
readonly updatedAt: string;
|
|
1244
|
-
};
|
|
1245
|
-
}, import("./errors").ConflictError | import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
562
|
+
}) => import("./internal/operation").OperationResult<"campaignsPauseRun">;
|
|
1246
563
|
export declare const resumeRun: (input: {
|
|
1247
564
|
readonly id: string;
|
|
1248
565
|
readonly runId: string;
|
|
1249
|
-
}) => import("
|
|
1250
|
-
readonly success: boolean;
|
|
1251
|
-
readonly item: {
|
|
1252
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
1253
|
-
readonly campaignId: string & import("effect/Brand").Brand<"CampaignId">;
|
|
1254
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
1255
|
-
readonly scheduledFor: string;
|
|
1256
|
-
readonly idempotencyKey: string | null;
|
|
1257
|
-
readonly startedAt: string | null;
|
|
1258
|
-
readonly completedAt: string | null;
|
|
1259
|
-
readonly contentSnapshot: {
|
|
1260
|
-
readonly channel: "email";
|
|
1261
|
-
readonly email: {
|
|
1262
|
-
readonly subject?: string | null;
|
|
1263
|
-
readonly html?: string | null;
|
|
1264
|
-
readonly text?: string | null;
|
|
1265
|
-
readonly attachments?: readonly {
|
|
1266
|
-
readonly filename: string;
|
|
1267
|
-
readonly content?: string | null;
|
|
1268
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
1269
|
-
readonly contentType: string;
|
|
1270
|
-
readonly size: number;
|
|
1271
|
-
}[] | null;
|
|
1272
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
1273
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
1274
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
1275
|
-
readonly templateSlug?: string | null;
|
|
1276
|
-
readonly templateData?: {
|
|
1277
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1278
|
-
} | null;
|
|
1279
|
-
readonly locale?: string;
|
|
1280
|
-
readonly timeZone?: string;
|
|
1281
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1282
|
-
readonly replyTo?: readonly string[] | null;
|
|
1283
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1284
|
-
readonly tracking?: {
|
|
1285
|
-
readonly opens?: boolean;
|
|
1286
|
-
readonly clicks?: boolean;
|
|
1287
|
-
};
|
|
1288
|
-
readonly footer?: {
|
|
1289
|
-
readonly enabled?: boolean | null;
|
|
1290
|
-
};
|
|
1291
|
-
};
|
|
1292
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
1293
|
-
readonly metadata?: {
|
|
1294
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1295
|
-
} | null;
|
|
1296
|
-
};
|
|
1297
|
-
readonly audienceSnapshot: {
|
|
1298
|
-
readonly includeTags?: readonly string[] | null;
|
|
1299
|
-
readonly excludeTags?: readonly string[] | null;
|
|
1300
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
1301
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
1302
|
-
};
|
|
1303
|
-
readonly policySnapshot: {
|
|
1304
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1305
|
-
readonly pageSize?: number | null;
|
|
1306
|
-
};
|
|
1307
|
-
readonly totalRecipients: number;
|
|
1308
|
-
readonly dispatchedCount: number;
|
|
1309
|
-
readonly failedCount: number;
|
|
1310
|
-
readonly skippedCount: number;
|
|
1311
|
-
readonly pendingCount: number;
|
|
1312
|
-
readonly skippedReasons: readonly {
|
|
1313
|
-
readonly reason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed";
|
|
1314
|
-
readonly count: number;
|
|
1315
|
-
}[];
|
|
1316
|
-
readonly estimatedCompletionAt: string | null;
|
|
1317
|
-
readonly failureReason: string | null;
|
|
1318
|
-
readonly holdReason: string | null;
|
|
1319
|
-
readonly holdDomainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1320
|
-
readonly holdUntil: string | null;
|
|
1321
|
-
readonly capacityWarning: string | null;
|
|
1322
|
-
readonly lastContactId: string | null;
|
|
1323
|
-
readonly createdBy: string | null;
|
|
1324
|
-
readonly actorEmail: string;
|
|
1325
|
-
readonly memberRole: string;
|
|
1326
|
-
readonly createdAt: string;
|
|
1327
|
-
readonly updatedAt: string;
|
|
1328
|
-
};
|
|
1329
|
-
}, import("./errors").ConflictError | import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
566
|
+
}) => import("./internal/operation").OperationResult<"campaignsResumeRun">;
|
|
1330
567
|
export declare const cancelRun: (input: {
|
|
1331
568
|
readonly id: string;
|
|
1332
569
|
readonly runId: string;
|
|
1333
|
-
}) => import("
|
|
1334
|
-
readonly success: boolean;
|
|
1335
|
-
readonly item: {
|
|
1336
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
1337
|
-
readonly campaignId: string & import("effect/Brand").Brand<"CampaignId">;
|
|
1338
|
-
readonly status: "cancelled" | "completed" | "dispatching" | "failed" | "paused" | "resolving" | "scheduled";
|
|
1339
|
-
readonly scheduledFor: string;
|
|
1340
|
-
readonly idempotencyKey: string | null;
|
|
1341
|
-
readonly startedAt: string | null;
|
|
1342
|
-
readonly completedAt: string | null;
|
|
1343
|
-
readonly contentSnapshot: {
|
|
1344
|
-
readonly channel: "email";
|
|
1345
|
-
readonly email: {
|
|
1346
|
-
readonly subject?: string | null;
|
|
1347
|
-
readonly html?: string | null;
|
|
1348
|
-
readonly text?: string | null;
|
|
1349
|
-
readonly attachments?: readonly {
|
|
1350
|
-
readonly filename: string;
|
|
1351
|
-
readonly content?: string | null;
|
|
1352
|
-
readonly mediaId?: (string & import("effect/Brand").Brand<"MediaId">) | null;
|
|
1353
|
-
readonly contentType: string;
|
|
1354
|
-
readonly size: number;
|
|
1355
|
-
}[] | null;
|
|
1356
|
-
readonly publicationId?: string & import("effect/Brand").Brand<"TemplatePublicationId">;
|
|
1357
|
-
readonly inputContractId?: string & import("effect/Brand").Brand<"TemplateInputContractId">;
|
|
1358
|
-
readonly templateId?: (string & import("effect/Brand").Brand<"TemplateId">) | null;
|
|
1359
|
-
readonly templateSlug?: string | null;
|
|
1360
|
-
readonly templateData?: {
|
|
1361
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1362
|
-
} | null;
|
|
1363
|
-
readonly locale?: string;
|
|
1364
|
-
readonly timeZone?: string;
|
|
1365
|
-
readonly inReplyToMessageId?: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1366
|
-
readonly replyTo?: readonly string[] | null;
|
|
1367
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1368
|
-
readonly tracking?: {
|
|
1369
|
-
readonly opens?: boolean;
|
|
1370
|
-
readonly clicks?: boolean;
|
|
1371
|
-
};
|
|
1372
|
-
readonly footer?: {
|
|
1373
|
-
readonly enabled?: boolean | null;
|
|
1374
|
-
};
|
|
1375
|
-
};
|
|
1376
|
-
readonly conversationId?: (string & import("effect/Brand").Brand<"ConversationId">) | null;
|
|
1377
|
-
readonly metadata?: {
|
|
1378
|
-
readonly [x: string]: import("./generated").JsonValue;
|
|
1379
|
-
} | null;
|
|
1380
|
-
};
|
|
1381
|
-
readonly audienceSnapshot: {
|
|
1382
|
-
readonly includeTags?: readonly string[] | null;
|
|
1383
|
-
readonly excludeTags?: readonly string[] | null;
|
|
1384
|
-
readonly contactIds?: readonly (string & import("effect/Brand").Brand<"ContactId">)[] | null;
|
|
1385
|
-
readonly groupIds?: readonly (string & import("effect/Brand").Brand<"ContactGroupId">)[] | null;
|
|
1386
|
-
};
|
|
1387
|
-
readonly policySnapshot: {
|
|
1388
|
-
readonly unsubscribeGroupId?: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
1389
|
-
readonly pageSize?: number | null;
|
|
1390
|
-
};
|
|
1391
|
-
readonly totalRecipients: number;
|
|
1392
|
-
readonly dispatchedCount: number;
|
|
1393
|
-
readonly failedCount: number;
|
|
1394
|
-
readonly skippedCount: number;
|
|
1395
|
-
readonly pendingCount: number;
|
|
1396
|
-
readonly skippedReasons: readonly {
|
|
1397
|
-
readonly reason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed";
|
|
1398
|
-
readonly count: number;
|
|
1399
|
-
}[];
|
|
1400
|
-
readonly estimatedCompletionAt: string | null;
|
|
1401
|
-
readonly failureReason: string | null;
|
|
1402
|
-
readonly holdReason: string | null;
|
|
1403
|
-
readonly holdDomainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1404
|
-
readonly holdUntil: string | null;
|
|
1405
|
-
readonly capacityWarning: string | null;
|
|
1406
|
-
readonly lastContactId: string | null;
|
|
1407
|
-
readonly createdBy: string | null;
|
|
1408
|
-
readonly actorEmail: string;
|
|
1409
|
-
readonly memberRole: string;
|
|
1410
|
-
readonly createdAt: string;
|
|
1411
|
-
readonly updatedAt: string;
|
|
1412
|
-
};
|
|
1413
|
-
}, import("./errors").ConflictError | import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
570
|
+
}) => import("./internal/operation").OperationResult<"campaignsCancelRun">;
|
|
1414
571
|
export declare const listRecipients: ((input: {
|
|
1415
572
|
readonly id: string;
|
|
1416
573
|
readonly runId: string;
|
|
1417
574
|
readonly status?: "dispatched" | "dispatching" | "failed" | "pending" | "skipped" | null | undefined;
|
|
1418
575
|
readonly limit?: string | null | undefined;
|
|
1419
576
|
readonly cursor?: string | null | undefined;
|
|
1420
|
-
}) => import("
|
|
1421
|
-
readonly items: readonly {
|
|
1422
|
-
readonly id: string & import("effect/Brand").Brand<"CampaignRecipientId">;
|
|
1423
|
-
readonly runId: string & import("effect/Brand").Brand<"CampaignRunId">;
|
|
1424
|
-
readonly contactId: string & import("effect/Brand").Brand<"ContactId">;
|
|
1425
|
-
readonly status: "dispatched" | "dispatching" | "failed" | "pending" | "skipped";
|
|
1426
|
-
readonly messageId: string | null;
|
|
1427
|
-
readonly failureReason: string | null;
|
|
1428
|
-
readonly skippedReason: "blocked" | "inactive" | "no_identity" | "opted_out" | "run_cancelled" | "run_failed" | "suppressed" | "unreachable" | "unsubscribed" | null;
|
|
1429
|
-
readonly createdAt: string;
|
|
1430
|
-
readonly updatedAt: string;
|
|
1431
|
-
}[];
|
|
1432
|
-
readonly nextCursor: string | null;
|
|
1433
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
577
|
+
}) => import("./internal/operation").OperationResult<"campaignsListRecipients">) & {
|
|
1434
578
|
readonly pages: (input: {
|
|
1435
579
|
readonly id: string;
|
|
1436
580
|
readonly runId: string;
|