samva 0.27.0 → 0.28.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/AGENTS.md +7 -0
- package/README.md +12 -7
- package/dist/client/sdk.gen.d.ts +322 -143
- package/dist/client/sdk.gen.js +604 -95
- package/dist/client/types.gen.d.ts +1342 -479
- package/dist/effect/agents.d.ts +6 -8
- package/dist/effect/analytics.d.ts +1 -1
- package/dist/effect/api-keys.d.ts +6 -6
- package/dist/effect/attachments.d.ts +1 -1
- package/dist/effect/brands.d.ts +2 -0
- package/dist/effect/campaigns.d.ts +275 -25
- package/dist/effect/campaigns.js +7 -1
- package/dist/effect/contact-groups.d.ts +9 -9
- package/dist/effect/contacts.d.ts +74 -81
- package/dist/effect/contacts.js +7 -3
- package/dist/effect/conversations.d.ts +14 -6
- package/dist/effect/email.d.ts +34 -34
- package/dist/effect/errors.d.ts +1 -1
- package/dist/effect/errors.js +2 -2
- package/dist/effect/extension-installations.d.ts +3 -3
- package/dist/effect/extensions.d.ts +6 -6
- package/dist/effect/generated/agents.d.ts +6 -28
- package/dist/effect/generated/agents.js +2 -3
- package/dist/effect/generated/analytics.d.ts +3 -3
- package/dist/effect/generated/analytics.js +1 -1
- package/dist/effect/generated/api-keys.d.ts +6 -6
- package/dist/effect/generated/api-keys.js +2 -2
- package/dist/effect/generated/attachments.d.ts +3 -3
- package/dist/effect/generated/attachments.js +1 -1
- package/dist/effect/generated/brands.d.ts +16 -0
- package/dist/effect/generated/campaigns.d.ts +1181 -302
- package/dist/effect/generated/campaigns.js +169 -36
- package/dist/effect/generated/contact-events.d.ts +3 -3
- package/dist/effect/generated/contact-events.js +1 -1
- package/dist/effect/generated/contact-groups.d.ts +9 -9
- package/dist/effect/generated/contact-groups.js +7 -7
- package/dist/effect/generated/contacts.d.ts +2063 -290
- package/dist/effect/generated/contacts.js +343 -75
- package/dist/effect/generated/conversations.d.ts +14 -6
- package/dist/effect/generated/conversations.js +6 -6
- package/dist/effect/generated/email.d.ts +40 -40
- package/dist/effect/generated/email.js +15 -15
- package/dist/effect/generated/extension-installations.d.ts +3 -3
- package/dist/effect/generated/extension-installations.js +1 -1
- package/dist/effect/generated/extensions.d.ts +6 -6
- package/dist/effect/generated/extensions.js +2 -2
- package/dist/effect/generated/index.d.ts +5 -3
- package/dist/effect/generated/journeys.d.ts +9 -9
- package/dist/effect/generated/journeys.js +3 -3
- package/dist/effect/generated/mailboxes.d.ts +172 -124
- package/dist/effect/generated/mailboxes.js +22 -14
- package/dist/effect/generated/messages.d.ts +53 -29
- package/dist/effect/generated/messages.js +9 -5
- package/dist/effect/generated/namespaces.d.ts +3 -3
- package/dist/effect/generated/namespaces.js +1 -1
- package/dist/effect/generated/operations.d.ts +3 -3
- package/dist/effect/generated/operations.js +1 -1
- package/dist/effect/generated/organizations.d.ts +0 -9
- package/dist/effect/generated/organizations.js +1 -4
- package/dist/effect/generated/scheduled-messages.d.ts +69 -20
- package/dist/effect/generated/scheduled-messages.js +22 -3
- package/dist/effect/generated/shared.d.ts +396 -107
- package/dist/effect/generated/shared.js +170 -89
- package/dist/effect/generated/subscriptions.d.ts +4 -7
- package/dist/effect/generated/subscriptions.js +3 -4
- package/dist/effect/generated/templates.d.ts +71 -407
- package/dist/effect/generated/templates.js +23 -23
- package/dist/effect/generated/topic-forms.d.ts +656 -0
- package/dist/effect/generated/topic-forms.js +145 -0
- package/dist/effect/generated/{unsubscribe-groups.d.ts → topics.d.ts} +640 -435
- package/dist/effect/generated/topics.js +267 -0
- package/dist/effect/generated/webhooks.d.ts +6 -6
- package/dist/effect/generated/webhooks.js +2 -2
- package/dist/effect/generated-metadata.d.ts +78 -24
- package/dist/effect/generated-metadata.js +61 -27
- package/dist/effect/index.d.ts +2 -1
- package/dist/effect/index.js +4 -3
- package/dist/effect/internal/operation.js +3 -3
- package/dist/effect/internal/send.d.ts +4 -4
- package/dist/effect/journeys.d.ts +7 -7
- package/dist/effect/mailboxes.d.ts +137 -121
- package/dist/effect/messages.d.ts +19 -11
- package/dist/effect/namespaces.d.ts +3 -3
- package/dist/effect/operations.d.ts +3 -3
- package/dist/effect/scheduled-messages.d.ts +6 -6
- package/dist/effect/subscriptions.d.ts +1 -2
- package/dist/effect/templates.d.ts +13 -13
- package/dist/effect/topic-forms.d.ts +30 -0
- package/dist/effect/topic-forms.js +21 -0
- package/dist/effect/topics.d.ts +94 -0
- package/dist/effect/topics.js +29 -0
- package/dist/effect/webhooks.d.ts +6 -6
- package/dist/index.js +2 -2
- package/dist/package.js +1 -1
- package/dist/promises/errors.gen.d.ts +65 -8
- package/dist/promises/errors.gen.js +139 -7
- package/dist/promises/index.d.ts +5 -3
- package/dist/promises/index.js +7 -5
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/service-map.d.ts +74 -25
- package/dist/service-map.js +43 -12
- package/package.json +12 -8
- package/dist/effect/generated/unsubscribe-groups.js +0 -284
- package/dist/effect/unsubscribe-groups.d.ts +0 -74
- package/dist/effect/unsubscribe-groups.js +0 -29
|
@@ -1,9 +1,58 @@
|
|
|
1
1
|
import type * as EffectBrand from "effect/Brand";
|
|
2
2
|
import { HttpApiEndpoint, HttpApiGroup } from "effect/http-api";
|
|
3
3
|
import * as Schema from "effect/Schema";
|
|
4
|
-
import { ApiKeySecurityMiddleware, ConflictError, ConversationId, Cursor, EmailBccRecipients, EmailCcRecipients, EmailContent,
|
|
4
|
+
import { ApiKeySecurityMiddleware, ConflictError, ConversationId, Cursor, EmailAttachments, EmailBccRecipients, EmailCcRecipients, EmailContent, EmailCustomHeaders, EmailFooterOverride, EmailRecipients, EmailSender, EmailTrackingOverrideV1, ExternalServiceError, FlagDisabledError, ForbiddenError, FromAddressRequiredError, GatewayTimeoutError, IanaTimezone, InternalError, MessageId, MessageMetadata, RenderLocale, RenderTimeZone, ReplyToAddresses, ResourceNotFoundError, SenderNotReadyError, TemplateData, TemplateId, TemplateInputContractId, TemplatePublicationId, TopicId, UnauthorizedError, ValidationError, __SamvaRuntimeAbsoluteInstant } from "./shared";
|
|
5
5
|
export type ScheduledMessageId = string & EffectBrand.Brand<"ScheduledMessageId">;
|
|
6
6
|
export declare const ScheduledMessageId: Schema.brand<Schema.String, "ScheduledMessageId">;
|
|
7
|
+
export type EmailDispatchContent = {
|
|
8
|
+
readonly subject?: string | null;
|
|
9
|
+
readonly html?: string | null;
|
|
10
|
+
readonly text?: string | null;
|
|
11
|
+
readonly attachments?: EmailAttachments;
|
|
12
|
+
readonly publicationId?: TemplatePublicationId;
|
|
13
|
+
readonly inputContractId?: TemplateInputContractId;
|
|
14
|
+
readonly templateId?: TemplateId | null;
|
|
15
|
+
readonly templateSlug?: string | null;
|
|
16
|
+
readonly templateData?: TemplateData;
|
|
17
|
+
readonly locale?: RenderLocale;
|
|
18
|
+
readonly timeZone?: RenderTimeZone;
|
|
19
|
+
readonly inReplyToMessageId?: MessageId | null;
|
|
20
|
+
readonly replyTo?: ReplyToAddresses;
|
|
21
|
+
readonly topicId?: TopicId | null | null;
|
|
22
|
+
readonly tracking?: EmailTrackingOverrideV1;
|
|
23
|
+
readonly footer?: EmailFooterOverride;
|
|
24
|
+
readonly headers?: EmailCustomHeaders | null;
|
|
25
|
+
};
|
|
26
|
+
export declare const EmailDispatchContent: Schema.Struct<{
|
|
27
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
28
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
29
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
30
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
31
|
+
readonly filename: Schema.String;
|
|
32
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
33
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
34
|
+
readonly contentType: Schema.String;
|
|
35
|
+
readonly size: Schema.Finite;
|
|
36
|
+
}>>, Schema.Null]>>;
|
|
37
|
+
readonly publicationId: Schema.optionalKey<Schema.brand<Schema.String, "TemplatePublicationId">>;
|
|
38
|
+
readonly inputContractId: Schema.optionalKey<Schema.brand<Schema.String, "TemplateInputContractId">>;
|
|
39
|
+
readonly templateId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "TemplateId">, Schema.Null]>>;
|
|
40
|
+
readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
41
|
+
readonly templateData: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<import("./shared").JsonValue, import("./shared").JsonValue, never, never>>>, Schema.Null]>>;
|
|
42
|
+
readonly locale: Schema.optionalKey<Schema.String>;
|
|
43
|
+
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
44
|
+
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
45
|
+
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
46
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
47
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
48
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
49
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
50
|
+
}>>;
|
|
51
|
+
readonly footer: Schema.optionalKey<Schema.Struct<{
|
|
52
|
+
readonly enabled: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
53
|
+
}>>;
|
|
54
|
+
readonly headers: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.String>, Schema.Null]>>;
|
|
55
|
+
}>;
|
|
7
56
|
export type SendMessagePayload = {
|
|
8
57
|
readonly conversationId?: ConversationId | null | null;
|
|
9
58
|
readonly metadata?: MessageMetadata;
|
|
@@ -63,7 +112,7 @@ export declare const SendMessagePayload: Schema.Struct<{
|
|
|
63
112
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
64
113
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
65
114
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
66
|
-
readonly
|
|
115
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
67
116
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
68
117
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
69
118
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -133,7 +182,7 @@ export declare const DispatchSendMessagePayload: Schema.Struct<{
|
|
|
133
182
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
134
183
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
135
184
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
136
|
-
readonly
|
|
185
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
137
186
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
138
187
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
139
188
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -215,7 +264,7 @@ export declare const ScheduledMessage: Schema.Struct<{
|
|
|
215
264
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
216
265
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
217
266
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
218
|
-
readonly
|
|
267
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
219
268
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
220
269
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
221
270
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -296,7 +345,7 @@ export declare const ScheduledMessagePage: Schema.Struct<{
|
|
|
296
345
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
297
346
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
298
347
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
299
|
-
readonly
|
|
348
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
300
349
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
301
350
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
302
351
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -321,12 +370,12 @@ export declare const ScheduledMessagePage: Schema.Struct<{
|
|
|
321
370
|
readonly nextCursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
322
371
|
}>;
|
|
323
372
|
export type ScheduledMessagesListQuery = {
|
|
324
|
-
readonly limit?:
|
|
373
|
+
readonly limit?: number | null;
|
|
325
374
|
readonly cursor?: Cursor | null;
|
|
326
375
|
readonly status?: "pending" | "dispatching" | "paused" | "dispatched" | "cancelled" | "failed" | null;
|
|
327
376
|
};
|
|
328
377
|
export declare const ScheduledMessagesListQuery: Schema.Struct<{
|
|
329
|
-
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.
|
|
378
|
+
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.Finite, Schema.Null]>>;
|
|
330
379
|
readonly cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
331
380
|
readonly status: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"dispatching">, Schema.Literal<"paused">, Schema.Literal<"dispatched">, Schema.Literal<"cancelled">, Schema.Literal<"failed">]>, Schema.Null]>>;
|
|
332
381
|
}>;
|
|
@@ -386,7 +435,7 @@ export declare const ScheduledMessagesList200: Schema.Struct<{
|
|
|
386
435
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
387
436
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
388
437
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
389
|
-
readonly
|
|
438
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
390
439
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
391
440
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
392
441
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -477,7 +526,7 @@ export declare const ScheduledMessagesCreateRequestJson: Schema.Struct<{
|
|
|
477
526
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
478
527
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
479
528
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
480
|
-
readonly
|
|
529
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
481
530
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
482
531
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
483
532
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -548,7 +597,7 @@ export declare const ScheduledMessagesCreate201: Schema.Struct<{
|
|
|
548
597
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
549
598
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
550
599
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
551
|
-
readonly
|
|
600
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
552
601
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
553
602
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
554
603
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -645,7 +694,7 @@ export declare const ScheduledMessagesGet200: Schema.Struct<{
|
|
|
645
694
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
646
695
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
647
696
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
648
|
-
readonly
|
|
697
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
649
698
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
650
699
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
651
700
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -745,7 +794,7 @@ export declare const ScheduledMessagesCancel200: Schema.Struct<{
|
|
|
745
794
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
746
795
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
747
796
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
748
|
-
readonly
|
|
797
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
749
798
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
750
799
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
751
800
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -855,7 +904,7 @@ export declare const ScheduledMessagesResume200: Schema.Struct<{
|
|
|
855
904
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
856
905
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
857
906
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
858
|
-
readonly
|
|
907
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
859
908
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
860
909
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
861
910
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -953,7 +1002,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
953
1002
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
954
1003
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
955
1004
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
956
|
-
readonly
|
|
1005
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
957
1006
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
958
1007
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
959
1008
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -1125,7 +1174,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
1125
1174
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
1126
1175
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
1127
1176
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
1128
|
-
readonly
|
|
1177
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
1129
1178
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1130
1179
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1131
1180
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -1194,7 +1243,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
1194
1243
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
1195
1244
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
1196
1245
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
1197
|
-
readonly
|
|
1246
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
1198
1247
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1199
1248
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1200
1249
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -1351,7 +1400,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
1351
1400
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
1352
1401
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
1353
1402
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
1354
|
-
readonly
|
|
1403
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
1355
1404
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1356
1405
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1357
1406
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -1453,7 +1502,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
1453
1502
|
readonly message: Schema.String;
|
|
1454
1503
|
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1455
1504
|
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"scheduledMessagesList", "GET", "/v1/messages/scheduled", never, Schema.toCodecStringTree<Schema.Struct<{
|
|
1456
|
-
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.
|
|
1505
|
+
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.Finite, Schema.Null]>>;
|
|
1457
1506
|
readonly cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1458
1507
|
readonly status: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"dispatching">, Schema.Literal<"paused">, Schema.Literal<"dispatched">, Schema.Literal<"cancelled">, Schema.Literal<"failed">]>, Schema.Null]>>;
|
|
1459
1508
|
}>>, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
@@ -1511,7 +1560,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
1511
1560
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
1512
1561
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
1513
1562
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
1514
|
-
readonly
|
|
1563
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
1515
1564
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1516
1565
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1517
1566
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -1655,7 +1704,7 @@ declare const ScheduledMessagesGroup_base: HttpApiGroup.HttpApiGroup<"Scheduled
|
|
|
1655
1704
|
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
1656
1705
|
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
1657
1706
|
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
1658
|
-
readonly
|
|
1707
|
+
readonly topicId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "TopicId">, Schema.Null]>, Schema.Null]>>;
|
|
1659
1708
|
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1660
1709
|
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1661
1710
|
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AbsoluteInstant } from "../runtime.js";
|
|
2
|
-
import { ApiKeySecurityMiddleware, ConflictError, ConversationId, Cursor, EmailBccRecipients, EmailCcRecipients, EmailContent,
|
|
2
|
+
import { ApiKeySecurityMiddleware, ConflictError, ConversationId, Cursor, EmailAttachments, EmailBccRecipients, EmailCcRecipients, EmailContent, EmailCustomHeaders, EmailFooterOverride, EmailRecipients, EmailSender, EmailTrackingOverrideV1, ExternalServiceError, FlagDisabledError, ForbiddenError, FromAddressRequiredError, GatewayTimeoutError, IanaTimezone, InternalError, MessageId, MessageMetadata, RenderLocale, RenderTimeZone, ReplyToAddresses, ResourceNotFoundError, SenderNotReadyError, TemplateData, TemplateId, TemplateInputContractId, TemplatePublicationId, TopicId, UnauthorizedError, ValidationError } from "./shared.js";
|
|
3
3
|
import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
|
|
4
4
|
import * as Schema from "effect/Schema";
|
|
5
5
|
//#region src/effect/generated/scheduled-messages.ts
|
|
@@ -7,6 +7,25 @@ const ScheduledMessageId = /* @__PURE__ */ Schema.String.check(Schema.isPattern(
|
|
|
7
7
|
expected: "a string matching the RegExp ^sched_[0-9a-hjkmnp-tv-z]{16,24}$",
|
|
8
8
|
identifier: "ScheduledMessageId"
|
|
9
9
|
})).pipe(Schema.brand("ScheduledMessageId"));
|
|
10
|
+
const EmailDispatchContent = /* @__PURE__ */ Schema.Struct({
|
|
11
|
+
subject: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
|
|
12
|
+
html: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
|
|
13
|
+
text: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
|
|
14
|
+
attachments: Schema.optionalKey(EmailAttachments),
|
|
15
|
+
publicationId: Schema.optionalKey(TemplatePublicationId),
|
|
16
|
+
inputContractId: Schema.optionalKey(TemplateInputContractId),
|
|
17
|
+
templateId: Schema.optionalKey(Schema.Union([TemplateId, Schema.Null])),
|
|
18
|
+
templateSlug: Schema.optionalKey(Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^(?=.{1,100}$)[a-z0-9]+(?:-[a-z0-9]+)*$", "u")).annotate({ expected: "a string matching the RegExp ^(?=.{1,100}$)[a-z0-9]+(?:-[a-z0-9]+)*$" })), Schema.Null])),
|
|
19
|
+
templateData: Schema.optionalKey(TemplateData),
|
|
20
|
+
locale: Schema.optionalKey(RenderLocale),
|
|
21
|
+
timeZone: Schema.optionalKey(RenderTimeZone),
|
|
22
|
+
inReplyToMessageId: Schema.optionalKey(Schema.Union([MessageId, Schema.Null])),
|
|
23
|
+
replyTo: Schema.optionalKey(ReplyToAddresses),
|
|
24
|
+
topicId: Schema.optionalKey(Schema.Union([Schema.Union([TopicId, Schema.Null]), Schema.Null]).annotate({ description: "The topic for this send. Omit to inherit the template topic; null disables topic inheritance for a direct send. Campaigns require a topic." })),
|
|
25
|
+
tracking: Schema.optionalKey(EmailTrackingOverrideV1),
|
|
26
|
+
footer: Schema.optionalKey(EmailFooterOverride),
|
|
27
|
+
headers: Schema.optionalKey(Schema.Union([EmailCustomHeaders, Schema.Null]))
|
|
28
|
+
}).annotate({ identifier: "EmailDispatchContent" });
|
|
10
29
|
const SendMessagePayload = /* @__PURE__ */ Schema.Struct({
|
|
11
30
|
conversationId: Schema.optionalKey(Schema.Union([Schema.Union([ConversationId, Schema.Null]), Schema.Null])),
|
|
12
31
|
metadata: Schema.optionalKey(MessageMetadata),
|
|
@@ -56,7 +75,7 @@ const ScheduledMessagePage = /* @__PURE__ */ Schema.Struct({
|
|
|
56
75
|
nextCursor: Schema.Union([Schema.String, Schema.Null])
|
|
57
76
|
}).annotate({ identifier: "ScheduledMessagePage" });
|
|
58
77
|
const ScheduledMessagesListQuery = /* @__PURE__ */ Schema.Struct({
|
|
59
|
-
limit: Schema.optionalKey(Schema.Union([Schema.
|
|
78
|
+
limit: Schema.optionalKey(Schema.Union([Schema.Finite.annotate({ description: "Items per page, at most 100." }).check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isLessThanOrEqualTo(100).annotate({ expected: "a value less than or equal to 100" })).check(Schema.isGreaterThan(0).annotate({ expected: "a value greater than 0" })), Schema.Null])),
|
|
60
79
|
cursor: Schema.optionalKey(Schema.Union([Cursor, Schema.Null])),
|
|
61
80
|
status: Schema.optionalKey(Schema.Union([Schema.Union([
|
|
62
81
|
Schema.Literal("pending"),
|
|
@@ -185,6 +204,6 @@ var ScheduledMessagesGroup = class extends HttpApiGroup.make("Scheduled Messages
|
|
|
185
204
|
]
|
|
186
205
|
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "scheduledMessages.resume").annotate(OpenApi.Summary, "Resume a review-paused scheduled message").annotate(OpenApi.Description, "Explicitly resumes a scheduled message after onboarding review clearance. An overdue message requires either send_now or a new future scheduledFor value.")).annotate(OpenApi.Description, "One-off scheduled message timers") {};
|
|
187
206
|
//#endregion
|
|
188
|
-
export { DispatchSendMessagePayload, ScheduledMessage, ScheduledMessageId, ScheduledMessagePage, ScheduledMessagesCancel200, ScheduledMessagesCancel401, ScheduledMessagesCancel403, ScheduledMessagesCancel404, ScheduledMessagesCancel409, ScheduledMessagesCancel422, ScheduledMessagesCancel500, ScheduledMessagesCancel504, ScheduledMessagesCancelPathParams, ScheduledMessagesCreate201, ScheduledMessagesCreate401, ScheduledMessagesCreate403, ScheduledMessagesCreate409, ScheduledMessagesCreate422, ScheduledMessagesCreate500, ScheduledMessagesCreate502, ScheduledMessagesCreate504, ScheduledMessagesCreateRequestJson, ScheduledMessagesGet200, ScheduledMessagesGet401, ScheduledMessagesGet403, ScheduledMessagesGet404, ScheduledMessagesGet422, ScheduledMessagesGet500, ScheduledMessagesGet504, ScheduledMessagesGetPathParams, ScheduledMessagesGroup, ScheduledMessagesList200, ScheduledMessagesList401, ScheduledMessagesList403, ScheduledMessagesList422, ScheduledMessagesList500, ScheduledMessagesList504, ScheduledMessagesListQuery, ScheduledMessagesResume200, ScheduledMessagesResume401, ScheduledMessagesResume403, ScheduledMessagesResume404, ScheduledMessagesResume409, ScheduledMessagesResume422, ScheduledMessagesResume500, ScheduledMessagesResume502, ScheduledMessagesResume503, ScheduledMessagesResume504, ScheduledMessagesResumePathParams, ScheduledMessagesResumeRequestJson, SendMessagePayload };
|
|
207
|
+
export { DispatchSendMessagePayload, EmailDispatchContent, ScheduledMessage, ScheduledMessageId, ScheduledMessagePage, ScheduledMessagesCancel200, ScheduledMessagesCancel401, ScheduledMessagesCancel403, ScheduledMessagesCancel404, ScheduledMessagesCancel409, ScheduledMessagesCancel422, ScheduledMessagesCancel500, ScheduledMessagesCancel504, ScheduledMessagesCancelPathParams, ScheduledMessagesCreate201, ScheduledMessagesCreate401, ScheduledMessagesCreate403, ScheduledMessagesCreate409, ScheduledMessagesCreate422, ScheduledMessagesCreate500, ScheduledMessagesCreate502, ScheduledMessagesCreate504, ScheduledMessagesCreateRequestJson, ScheduledMessagesGet200, ScheduledMessagesGet401, ScheduledMessagesGet403, ScheduledMessagesGet404, ScheduledMessagesGet422, ScheduledMessagesGet500, ScheduledMessagesGet504, ScheduledMessagesGetPathParams, ScheduledMessagesGroup, ScheduledMessagesList200, ScheduledMessagesList401, ScheduledMessagesList403, ScheduledMessagesList422, ScheduledMessagesList500, ScheduledMessagesList504, ScheduledMessagesListQuery, ScheduledMessagesResume200, ScheduledMessagesResume401, ScheduledMessagesResume403, ScheduledMessagesResume404, ScheduledMessagesResume409, ScheduledMessagesResume422, ScheduledMessagesResume500, ScheduledMessagesResume502, ScheduledMessagesResume503, ScheduledMessagesResume504, ScheduledMessagesResumePathParams, ScheduledMessagesResumeRequestJson, SendMessagePayload };
|
|
189
208
|
|
|
190
209
|
//# sourceMappingURL=scheduled-messages.js.map
|