samva 0.16.0 → 0.17.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 +4 -1
- package/README.md +44 -1
- package/dist/analytics-CaqPRsry.js +207 -0
- package/dist/api-keys-Ce1Y4_Ip.js +274 -0
- package/dist/attachments-DYqVIraC.js +140 -0
- package/dist/brands-ZwuOGIWO.js +175 -0
- package/dist/campaigns-DZlz1E9E.js +522 -0
- package/dist/categories-CA4XIQAb.js +1011 -0
- package/dist/client/sdk.gen.d.ts +174 -3
- package/dist/client/types.gen.d.ts +1126 -11
- package/dist/client-DOzUrdTE.js +1115 -0
- package/dist/contact-groups-BLbFXnjq.js +446 -0
- package/dist/contacts-BbsoXXB4.js +787 -0
- package/dist/conversations-_sRHueML.js +494 -0
- package/dist/custom-fields-BHWbwlKn.js +176 -0
- package/dist/effect/analytics.js +2 -21
- package/dist/effect/api-keys.d.ts +1 -1
- package/dist/effect/api-keys.js +2 -28
- package/dist/effect/attachments.js +2 -17
- package/dist/effect/brands.d.ts +1 -1
- package/dist/effect/brands.js +3 -24
- package/dist/effect/campaigns.js +2 -33
- package/dist/effect/categories.js +1 -1
- package/dist/effect/client.d.ts +1 -1
- package/dist/effect/client.js +3 -4
- package/dist/effect/contact-groups.js +2 -29
- package/dist/effect/contacts.d.ts +52 -0
- package/dist/effect/contacts.js +2 -47
- package/dist/effect/conversations.js +2 -35
- package/dist/effect/custom-fields.js +2 -17
- package/dist/effect/email.d.ts +3 -2
- package/dist/effect/email.js +2 -137
- package/dist/effect/events.d.ts +121 -0
- package/dist/effect/events.js +3 -0
- package/dist/effect/extension-installations.js +2 -27
- package/dist/effect/extensions.js +2 -19
- package/dist/effect/feedback.d.ts +1 -1
- package/dist/effect/feedback.js +3 -13
- package/dist/effect/generated/analytics.d.ts +715 -0
- package/dist/effect/generated/api-keys.d.ts +1627 -0
- package/dist/effect/generated/attachments.d.ts +554 -0
- package/dist/effect/generated/brands.d.ts +1118 -0
- package/dist/effect/generated/campaigns.d.ts +3783 -0
- package/dist/effect/generated/contact-events.d.ts +158 -0
- package/dist/effect/generated/contact-groups.d.ts +1445 -0
- package/dist/effect/generated/contacts.d.ts +3789 -0
- package/dist/effect/generated/conversations.d.ts +2870 -0
- package/dist/effect/generated/custom-fields.d.ts +562 -0
- package/dist/effect/generated/email.d.ts +10622 -0
- package/dist/effect/generated/events.d.ts +463 -0
- package/dist/effect/generated/extension-installations.d.ts +1786 -0
- package/dist/effect/generated/extensions.d.ts +927 -0
- package/dist/effect/generated/feedback.d.ts +116 -0
- package/dist/effect/generated/index.d.ts +61 -0
- package/dist/effect/generated/journeys.d.ts +6135 -0
- package/dist/effect/generated/mailboxes.d.ts +13641 -0
- package/dist/effect/generated/media.d.ts +741 -0
- package/dist/effect/generated/messages.d.ts +2355 -0
- package/dist/effect/generated/namespaces.d.ts +654 -0
- package/dist/effect/generated/operations.d.ts +514 -0
- package/dist/effect/generated/organizations.d.ts +1111 -0
- package/dist/effect/generated/scheduled-messages.d.ts +1798 -0
- package/dist/effect/generated/shared.d.ts +3250 -0
- package/dist/effect/generated/subscriptions.d.ts +188 -0
- package/dist/effect/generated/templates.d.ts +8177 -0
- package/dist/effect/generated/unsubscribe-groups.d.ts +1153 -0
- package/dist/effect/generated/webhooks.d.ts +1697 -0
- package/dist/effect/generated/whoami.d.ts +291 -0
- package/dist/effect/generated-metadata.d.ts +1627 -0
- package/dist/effect/index.d.ts +3 -1
- package/dist/effect/index.js +29 -27
- package/dist/effect/internal/client.d.ts +10 -7
- package/dist/effect/internal/email-sender.d.ts +17 -0
- package/dist/effect/internal/operation.d.ts +12 -72
- package/dist/effect/internal/send.d.ts +60 -0
- package/dist/effect/journeys.d.ts +2153 -0
- package/dist/effect/journeys.js +2 -0
- package/dist/effect/mailboxes.d.ts +112 -112
- package/dist/effect/mailboxes.js +1 -1
- package/dist/effect/media.js +3 -1
- package/dist/effect/messages.d.ts +2 -2
- package/dist/effect/messages.js +3 -1
- package/dist/effect/namespaces.js +2 -19
- package/dist/effect/operations.js +2 -15
- package/dist/effect/organizations.js +2 -23
- package/dist/effect/retry.js +1 -1
- package/dist/effect/scheduled-messages.js +2 -19
- package/dist/effect/subscriptions.js +2 -9
- package/dist/effect/templates.d.ts +1 -1
- package/dist/effect/templates.js +3 -78
- package/dist/effect/unsubscribe-groups.js +2 -27
- package/dist/effect/webhooks.d.ts +9 -9
- package/dist/effect/webhooks.js +3 -33
- package/dist/effect/whoami.d.ts +8 -8
- package/dist/effect/whoami.js +2 -9
- package/dist/email-R0NAA9PW.js +2498 -0
- package/dist/events-CxbTUHYT.js +82 -0
- package/dist/extension-installations-CD94LPmk.js +407 -0
- package/dist/extensions-BKyNQLvu.js +220 -0
- package/dist/feedback-Bpa09JOS.js +52 -0
- package/dist/index.js +2 -2
- package/dist/{inline-attachments-Cegg6tTF.js → inline-attachments-Bi1hDltp.js} +2 -2
- package/dist/journeys-CARo_BJT.js +499 -0
- package/dist/mailboxes-BRDn7BIK.js +2470 -0
- package/dist/media-VrrtNnft.js +181 -0
- package/dist/namespaces-CcvEbG-y.js +152 -0
- package/dist/{operation-BTXjPrwf.js → operation-n_IYgNVK.js} +75 -90
- package/dist/operations-CmB3FHwf.js +93 -0
- package/dist/organizations-A-plufWc.js +252 -0
- package/dist/promises/index.d.ts +7 -3
- package/dist/promises/index.js +2 -2
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/{promises-KrA2nSLg.js → promises---Kbh-7z.js} +467 -3
- package/dist/runtime-P0l1_2-C.js +25 -0
- package/dist/scheduled-messages-DkKZRRaN.js +207 -0
- package/dist/send-Bxc0XfGE.js +722 -0
- package/dist/service-map.d.ts +85 -0
- package/dist/subscriptions-DEXYtMXg.js +67 -0
- package/dist/templates-DZomxsG7.js +2289 -0
- package/dist/unsubscribe-groups-Iqk4Isf9.js +291 -0
- package/dist/webhooks-CPXuu8Xf.js +530 -0
- package/dist/whoami-Ccz0jwlt.js +59 -0
- package/package.json +13 -3
- package/dist/categories-DV51kr2H.js +0 -187
- package/dist/client-BMUew5Wp.js +0 -13794
- package/dist/effect/generated.d.ts +0 -64004
- package/dist/mailboxes-Thp5z0oX.js +0 -161
|
@@ -0,0 +1,2355 @@
|
|
|
1
|
+
import type * as EffectBrand from "effect/Brand";
|
|
2
|
+
import { HttpApiEndpoint, HttpApiGroup } from "effect/http-api";
|
|
3
|
+
import * as Schema from "effect/Schema";
|
|
4
|
+
import { ApiKeyId, ApiKeySecurityMiddleware, AttachmentId, BillingProviderError, ConflictError, ContactId, ConversationId, Cursor, DeliveryUnavailableError, EmailBccRecipients, EmailCcRecipients, EmailContent, EmailRecipients, EmailSender, EmailTrackingOverrideV1, ExternalServiceError, FlagDisabledError, ForbiddenError, GatewayTimeoutError, InternalError, JsonValue, MediaId, MessageId, MessageMetadata, MessagePage, OnboardingReviewRequiredError, PaymentRequiredError, RateLimitedError, ResourceNotFoundError, SenderNotReadyError, SkippedRecipient, UnauthorizedError, UserId, ValidationError } from "./shared";
|
|
5
|
+
export type MessageSender = {
|
|
6
|
+
readonly address: string;
|
|
7
|
+
readonly name: string | null;
|
|
8
|
+
};
|
|
9
|
+
export declare const MessageSender: Schema.Struct<{
|
|
10
|
+
readonly address: Schema.String;
|
|
11
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
12
|
+
}>;
|
|
13
|
+
export type SubmissionClient = {
|
|
14
|
+
readonly surface: "typescript-promise" | "typescript-effect" | "cli" | "mcp";
|
|
15
|
+
readonly version: string;
|
|
16
|
+
};
|
|
17
|
+
export declare const SubmissionClient: Schema.Struct<{
|
|
18
|
+
readonly surface: Schema.Union<readonly [Schema.Literal<"typescript-promise">, Schema.Literal<"typescript-effect">, Schema.Literal<"cli">, Schema.Literal<"mcp">]>;
|
|
19
|
+
readonly version: Schema.String;
|
|
20
|
+
}>;
|
|
21
|
+
export type MessageDeliveryId = string & EffectBrand.Brand<"MessageDeliveryId">;
|
|
22
|
+
export declare const MessageDeliveryId: Schema.brand<Schema.String, "MessageDeliveryId">;
|
|
23
|
+
export type MessageDeliveryError = {
|
|
24
|
+
readonly code: string | null;
|
|
25
|
+
readonly message: string | null;
|
|
26
|
+
readonly retryable: boolean | null;
|
|
27
|
+
};
|
|
28
|
+
export declare const MessageDeliveryError: Schema.Struct<{
|
|
29
|
+
readonly code: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
30
|
+
readonly message: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
31
|
+
readonly retryable: Schema.Union<readonly [Schema.Boolean, Schema.Null]>;
|
|
32
|
+
}>;
|
|
33
|
+
export type DeliveryErrorDetails = {
|
|
34
|
+
readonly code?: string | null;
|
|
35
|
+
readonly name?: string | null;
|
|
36
|
+
readonly message?: string | null;
|
|
37
|
+
readonly details?: {
|
|
38
|
+
readonly [x: string]: string | number | null;
|
|
39
|
+
} | null;
|
|
40
|
+
readonly retryable?: boolean | null;
|
|
41
|
+
};
|
|
42
|
+
export declare const DeliveryErrorDetails: Schema.Struct<{
|
|
43
|
+
readonly code: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
44
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
45
|
+
readonly message: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
46
|
+
readonly details: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.Finite, Schema.Null]>>, Schema.Null]>>;
|
|
47
|
+
readonly retryable: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
48
|
+
}>;
|
|
49
|
+
export type EmailAddress = {
|
|
50
|
+
readonly email: string;
|
|
51
|
+
readonly name: string | null;
|
|
52
|
+
};
|
|
53
|
+
export declare const EmailAddress: Schema.Struct<{
|
|
54
|
+
readonly email: Schema.String;
|
|
55
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
56
|
+
}>;
|
|
57
|
+
export type MessageEventId = string & EffectBrand.Brand<"MessageEventId">;
|
|
58
|
+
export declare const MessageEventId: Schema.brand<Schema.String, "MessageEventId">;
|
|
59
|
+
export type ValidateEmailResponse = {
|
|
60
|
+
readonly valid: true;
|
|
61
|
+
readonly from: {
|
|
62
|
+
readonly email: string;
|
|
63
|
+
readonly name: string | null;
|
|
64
|
+
};
|
|
65
|
+
readonly recipientCount: number;
|
|
66
|
+
readonly content: {
|
|
67
|
+
readonly source: "inline" | "template";
|
|
68
|
+
readonly subject: string;
|
|
69
|
+
readonly hasHtml: boolean;
|
|
70
|
+
readonly hasText: boolean;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
export declare const ValidateEmailResponse: Schema.Struct<{
|
|
74
|
+
readonly valid: Schema.Literal<true>;
|
|
75
|
+
readonly from: Schema.Struct<{
|
|
76
|
+
readonly email: Schema.String;
|
|
77
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
78
|
+
}>;
|
|
79
|
+
readonly recipientCount: Schema.Finite;
|
|
80
|
+
readonly content: Schema.Struct<{
|
|
81
|
+
readonly source: Schema.Union<readonly [Schema.Literal<"inline">, Schema.Literal<"template">]>;
|
|
82
|
+
readonly subject: Schema.String;
|
|
83
|
+
readonly hasHtml: Schema.Boolean;
|
|
84
|
+
readonly hasText: Schema.Boolean;
|
|
85
|
+
}>;
|
|
86
|
+
}>;
|
|
87
|
+
export type SubmissionCredential = {
|
|
88
|
+
readonly kind: "api_key";
|
|
89
|
+
readonly apiKeyId: ApiKeyId | null;
|
|
90
|
+
} | {
|
|
91
|
+
readonly kind: "oauth";
|
|
92
|
+
readonly clientId: string | null;
|
|
93
|
+
} | {
|
|
94
|
+
readonly kind: "session";
|
|
95
|
+
};
|
|
96
|
+
export declare const SubmissionCredential: Schema.Union<readonly [Schema.Struct<{
|
|
97
|
+
readonly kind: Schema.Literal<"api_key">;
|
|
98
|
+
readonly apiKeyId: Schema.Union<readonly [Schema.brand<Schema.String, "ApiKeyId">, Schema.Null]>;
|
|
99
|
+
}>, Schema.Struct<{
|
|
100
|
+
readonly kind: Schema.Literal<"oauth">;
|
|
101
|
+
readonly clientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
102
|
+
}>, Schema.Struct<{
|
|
103
|
+
readonly kind: Schema.Literal<"session">;
|
|
104
|
+
}>]>;
|
|
105
|
+
export type MessageContent = {
|
|
106
|
+
readonly text?: string | null;
|
|
107
|
+
readonly html?: string | null;
|
|
108
|
+
readonly markdown?: string | null;
|
|
109
|
+
readonly email?: {
|
|
110
|
+
readonly subject?: string | null;
|
|
111
|
+
readonly html?: string | null;
|
|
112
|
+
readonly text?: string | null;
|
|
113
|
+
readonly headers?: {
|
|
114
|
+
readonly [x: string]: string;
|
|
115
|
+
} | null;
|
|
116
|
+
readonly tracking?: EmailTrackingOverrideV1;
|
|
117
|
+
readonly attachments?: ReadonlyArray<{
|
|
118
|
+
readonly filename: string;
|
|
119
|
+
readonly contentId?: string | null;
|
|
120
|
+
readonly isInline?: boolean | null;
|
|
121
|
+
readonly content?: string | null;
|
|
122
|
+
readonly mediaId?: MediaId | null;
|
|
123
|
+
readonly contentType: string;
|
|
124
|
+
readonly size: number;
|
|
125
|
+
}> | null;
|
|
126
|
+
} | null;
|
|
127
|
+
readonly metadata?: {
|
|
128
|
+
readonly [x: string]: JsonValue;
|
|
129
|
+
} | null;
|
|
130
|
+
};
|
|
131
|
+
export declare const MessageContent: Schema.Struct<{
|
|
132
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
133
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
134
|
+
readonly markdown: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
135
|
+
readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
136
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
137
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
138
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
139
|
+
readonly headers: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.String>, Schema.Null]>>;
|
|
140
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
141
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
142
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
143
|
+
}>>;
|
|
144
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
145
|
+
readonly filename: Schema.String;
|
|
146
|
+
readonly contentId: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
147
|
+
readonly isInline: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
148
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
149
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
150
|
+
readonly contentType: Schema.String;
|
|
151
|
+
readonly size: Schema.Finite;
|
|
152
|
+
}>>, Schema.Null]>>;
|
|
153
|
+
}>, Schema.Null]>>;
|
|
154
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
155
|
+
}>;
|
|
156
|
+
export type MessageAddress = {
|
|
157
|
+
readonly address: string;
|
|
158
|
+
readonly contactId: ContactId | null;
|
|
159
|
+
};
|
|
160
|
+
export declare const MessageAddress: Schema.Struct<{
|
|
161
|
+
readonly address: Schema.String;
|
|
162
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
163
|
+
}>;
|
|
164
|
+
export type MessageDelivery = {
|
|
165
|
+
readonly id: MessageDeliveryId;
|
|
166
|
+
readonly recipient: string | null;
|
|
167
|
+
readonly status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
168
|
+
readonly attemptCount: number;
|
|
169
|
+
readonly waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
170
|
+
readonly nextRetryAt: string | null;
|
|
171
|
+
readonly sentAt: string | null;
|
|
172
|
+
readonly deliveredAt: string | null;
|
|
173
|
+
readonly readAt: string | null;
|
|
174
|
+
readonly failedAt: string | null;
|
|
175
|
+
readonly error: MessageDeliveryError | null;
|
|
176
|
+
readonly createdAt: string;
|
|
177
|
+
readonly updatedAt: string;
|
|
178
|
+
};
|
|
179
|
+
export declare const MessageDelivery: Schema.Struct<{
|
|
180
|
+
readonly id: Schema.brand<Schema.String, "MessageDeliveryId">;
|
|
181
|
+
readonly recipient: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
182
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
183
|
+
readonly attemptCount: Schema.Finite;
|
|
184
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
185
|
+
readonly nextRetryAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
186
|
+
readonly sentAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
187
|
+
readonly deliveredAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
188
|
+
readonly readAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
189
|
+
readonly failedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
190
|
+
readonly error: Schema.Union<readonly [Schema.Struct<{
|
|
191
|
+
readonly code: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
192
|
+
readonly message: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
193
|
+
readonly retryable: Schema.Union<readonly [Schema.Boolean, Schema.Null]>;
|
|
194
|
+
}>, Schema.Null]>;
|
|
195
|
+
readonly createdAt: Schema.String;
|
|
196
|
+
readonly updatedAt: Schema.String;
|
|
197
|
+
}>;
|
|
198
|
+
export type MessageEventPage = {
|
|
199
|
+
readonly items: ReadonlyArray<{
|
|
200
|
+
readonly id: MessageEventId;
|
|
201
|
+
readonly messageId: MessageId;
|
|
202
|
+
readonly eventType: string;
|
|
203
|
+
readonly status: string;
|
|
204
|
+
readonly timestamp: string;
|
|
205
|
+
readonly metadata?: {
|
|
206
|
+
readonly [x: string]: JsonValue;
|
|
207
|
+
} | null;
|
|
208
|
+
}>;
|
|
209
|
+
readonly nextCursor: string | null;
|
|
210
|
+
};
|
|
211
|
+
export declare const MessageEventPage: Schema.Struct<{
|
|
212
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
213
|
+
readonly id: Schema.brand<Schema.String, "MessageEventId">;
|
|
214
|
+
readonly messageId: Schema.brand<Schema.String, "MessageId">;
|
|
215
|
+
readonly eventType: Schema.String;
|
|
216
|
+
readonly status: Schema.String;
|
|
217
|
+
readonly timestamp: Schema.String;
|
|
218
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
219
|
+
}>>;
|
|
220
|
+
readonly nextCursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
221
|
+
}>;
|
|
222
|
+
export type MessageSubmission = {
|
|
223
|
+
readonly origin: "direct" | "campaign" | "scheduled" | "mailbox" | "forwarding" | "journey";
|
|
224
|
+
readonly transport: "http" | null;
|
|
225
|
+
readonly credential: SubmissionCredential | null;
|
|
226
|
+
readonly userId: UserId | null;
|
|
227
|
+
readonly client: SubmissionClient | null;
|
|
228
|
+
};
|
|
229
|
+
export declare const MessageSubmission: Schema.Struct<{
|
|
230
|
+
readonly origin: Schema.Union<readonly [Schema.Literal<"direct">, Schema.Literal<"campaign">, Schema.Literal<"scheduled">, Schema.Literal<"mailbox">, Schema.Literal<"forwarding">, Schema.Literal<"journey">]>;
|
|
231
|
+
readonly transport: Schema.Union<readonly [Schema.Literal<"http">, Schema.Null]>;
|
|
232
|
+
readonly credential: Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{
|
|
233
|
+
readonly kind: Schema.Literal<"api_key">;
|
|
234
|
+
readonly apiKeyId: Schema.Union<readonly [Schema.brand<Schema.String, "ApiKeyId">, Schema.Null]>;
|
|
235
|
+
}>, Schema.Struct<{
|
|
236
|
+
readonly kind: Schema.Literal<"oauth">;
|
|
237
|
+
readonly clientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
238
|
+
}>, Schema.Struct<{
|
|
239
|
+
readonly kind: Schema.Literal<"session">;
|
|
240
|
+
}>]>, Schema.Null]>;
|
|
241
|
+
readonly userId: Schema.Union<readonly [Schema.brand<Schema.String, "UserId">, Schema.Null]>;
|
|
242
|
+
readonly client: Schema.Union<readonly [Schema.Struct<{
|
|
243
|
+
readonly surface: Schema.Union<readonly [Schema.Literal<"typescript-promise">, Schema.Literal<"typescript-effect">, Schema.Literal<"cli">, Schema.Literal<"mcp">]>;
|
|
244
|
+
readonly version: Schema.String;
|
|
245
|
+
}>, Schema.Null]>;
|
|
246
|
+
}>;
|
|
247
|
+
export type MessageReceipt = {
|
|
248
|
+
readonly id: MessageId;
|
|
249
|
+
readonly status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
250
|
+
readonly waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
251
|
+
readonly reviewExpectedAt: string | null;
|
|
252
|
+
readonly skippedRecipients: ReadonlyArray<SkippedRecipient>;
|
|
253
|
+
readonly createdAt: string;
|
|
254
|
+
};
|
|
255
|
+
export declare const MessageReceipt: Schema.Struct<{
|
|
256
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
257
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
258
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
259
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
260
|
+
readonly skippedRecipients: Schema.$Array<Schema.Struct<{
|
|
261
|
+
readonly address: Schema.String;
|
|
262
|
+
readonly reason: Schema.Union<readonly [Schema.Literal<"bounce">, Schema.Literal<"complaint">, Schema.Literal<"unsubscribe">, Schema.Literal<"manual">, Schema.Literal<"group-unsubscribe">]>;
|
|
263
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
|
|
264
|
+
}>>;
|
|
265
|
+
readonly createdAt: Schema.String;
|
|
266
|
+
}>;
|
|
267
|
+
export type MessageDeliveryList = {
|
|
268
|
+
readonly items: ReadonlyArray<MessageDelivery>;
|
|
269
|
+
};
|
|
270
|
+
export declare const MessageDeliveryList: Schema.Struct<{
|
|
271
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
272
|
+
readonly id: Schema.brand<Schema.String, "MessageDeliveryId">;
|
|
273
|
+
readonly recipient: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
274
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
275
|
+
readonly attemptCount: Schema.Finite;
|
|
276
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
277
|
+
readonly nextRetryAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
278
|
+
readonly sentAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
279
|
+
readonly deliveredAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
280
|
+
readonly readAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
281
|
+
readonly failedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
282
|
+
readonly error: Schema.Union<readonly [Schema.Struct<{
|
|
283
|
+
readonly code: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
284
|
+
readonly message: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
285
|
+
readonly retryable: Schema.Union<readonly [Schema.Boolean, Schema.Null]>;
|
|
286
|
+
}>, Schema.Null]>;
|
|
287
|
+
readonly createdAt: Schema.String;
|
|
288
|
+
readonly updatedAt: Schema.String;
|
|
289
|
+
}>>;
|
|
290
|
+
}>;
|
|
291
|
+
export type Message = {
|
|
292
|
+
readonly id: MessageId;
|
|
293
|
+
readonly channel: "email";
|
|
294
|
+
readonly direction: "outbound" | "inbound";
|
|
295
|
+
readonly status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
296
|
+
readonly from: MessageSender | null;
|
|
297
|
+
readonly to: ReadonlyArray<MessageAddress>;
|
|
298
|
+
readonly cc: ReadonlyArray<MessageAddress>;
|
|
299
|
+
readonly bcc: ReadonlyArray<MessageAddress>;
|
|
300
|
+
readonly replyTo: ReadonlyArray<string>;
|
|
301
|
+
readonly subject: string | null;
|
|
302
|
+
readonly conversationId: ConversationId | null;
|
|
303
|
+
readonly inReplyToMessageId: MessageId | null;
|
|
304
|
+
readonly tags: ReadonlyArray<string>;
|
|
305
|
+
readonly metadata: {
|
|
306
|
+
readonly [x: string]: JsonValue;
|
|
307
|
+
} | null;
|
|
308
|
+
readonly isTest: boolean;
|
|
309
|
+
readonly scheduledAt: string | null;
|
|
310
|
+
readonly submission: MessageSubmission | null;
|
|
311
|
+
readonly waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
312
|
+
readonly reviewExpectedAt: string | null;
|
|
313
|
+
readonly skippedRecipients: ReadonlyArray<SkippedRecipient>;
|
|
314
|
+
readonly createdAt: string;
|
|
315
|
+
readonly updatedAt: string;
|
|
316
|
+
};
|
|
317
|
+
export declare const Message: Schema.Struct<{
|
|
318
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
319
|
+
readonly channel: Schema.Literal<"email">;
|
|
320
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
321
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
322
|
+
readonly from: Schema.Union<readonly [Schema.Struct<{
|
|
323
|
+
readonly address: Schema.String;
|
|
324
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
325
|
+
}>, Schema.Null]>;
|
|
326
|
+
readonly to: Schema.$Array<Schema.Struct<{
|
|
327
|
+
readonly address: Schema.String;
|
|
328
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
329
|
+
}>>;
|
|
330
|
+
readonly cc: Schema.$Array<Schema.Struct<{
|
|
331
|
+
readonly address: Schema.String;
|
|
332
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
333
|
+
}>>;
|
|
334
|
+
readonly bcc: Schema.$Array<Schema.Struct<{
|
|
335
|
+
readonly address: Schema.String;
|
|
336
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
337
|
+
}>>;
|
|
338
|
+
readonly replyTo: Schema.$Array<Schema.String>;
|
|
339
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
340
|
+
readonly conversationId: Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>;
|
|
341
|
+
readonly inReplyToMessageId: Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>;
|
|
342
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
343
|
+
readonly metadata: Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>;
|
|
344
|
+
readonly isTest: Schema.Boolean;
|
|
345
|
+
readonly scheduledAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
346
|
+
readonly submission: Schema.Union<readonly [Schema.Struct<{
|
|
347
|
+
readonly origin: Schema.Union<readonly [Schema.Literal<"direct">, Schema.Literal<"campaign">, Schema.Literal<"scheduled">, Schema.Literal<"mailbox">, Schema.Literal<"forwarding">, Schema.Literal<"journey">]>;
|
|
348
|
+
readonly transport: Schema.Union<readonly [Schema.Literal<"http">, Schema.Null]>;
|
|
349
|
+
readonly credential: Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{
|
|
350
|
+
readonly kind: Schema.Literal<"api_key">;
|
|
351
|
+
readonly apiKeyId: Schema.Union<readonly [Schema.brand<Schema.String, "ApiKeyId">, Schema.Null]>;
|
|
352
|
+
}>, Schema.Struct<{
|
|
353
|
+
readonly kind: Schema.Literal<"oauth">;
|
|
354
|
+
readonly clientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
355
|
+
}>, Schema.Struct<{
|
|
356
|
+
readonly kind: Schema.Literal<"session">;
|
|
357
|
+
}>]>, Schema.Null]>;
|
|
358
|
+
readonly userId: Schema.Union<readonly [Schema.brand<Schema.String, "UserId">, Schema.Null]>;
|
|
359
|
+
readonly client: Schema.Union<readonly [Schema.Struct<{
|
|
360
|
+
readonly surface: Schema.Union<readonly [Schema.Literal<"typescript-promise">, Schema.Literal<"typescript-effect">, Schema.Literal<"cli">, Schema.Literal<"mcp">]>;
|
|
361
|
+
readonly version: Schema.String;
|
|
362
|
+
}>, Schema.Null]>;
|
|
363
|
+
}>, Schema.Null]>;
|
|
364
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
365
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
366
|
+
readonly skippedRecipients: Schema.$Array<Schema.Struct<{
|
|
367
|
+
readonly address: Schema.String;
|
|
368
|
+
readonly reason: Schema.Union<readonly [Schema.Literal<"bounce">, Schema.Literal<"complaint">, Schema.Literal<"unsubscribe">, Schema.Literal<"manual">, Schema.Literal<"group-unsubscribe">]>;
|
|
369
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
|
|
370
|
+
}>>;
|
|
371
|
+
readonly createdAt: Schema.String;
|
|
372
|
+
readonly updatedAt: Schema.String;
|
|
373
|
+
}>;
|
|
374
|
+
export type MessagesListQuery = {
|
|
375
|
+
readonly limit?: string | null;
|
|
376
|
+
readonly cursor?: Cursor | null;
|
|
377
|
+
readonly channel?: "email" | null;
|
|
378
|
+
readonly direction?: "outbound" | "inbound" | null;
|
|
379
|
+
readonly status?: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained" | null;
|
|
380
|
+
readonly conversationId?: ConversationId | null;
|
|
381
|
+
readonly contactId?: ContactId | null;
|
|
382
|
+
readonly from?: string | null;
|
|
383
|
+
readonly after?: string | null;
|
|
384
|
+
readonly before?: string | null;
|
|
385
|
+
};
|
|
386
|
+
export declare const MessagesListQuery: Schema.Struct<{
|
|
387
|
+
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
388
|
+
readonly cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
389
|
+
readonly channel: Schema.optionalKey<Schema.Union<readonly [Schema.Literal<"email">, Schema.Null]>>;
|
|
390
|
+
readonly direction: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>, Schema.Null]>>;
|
|
391
|
+
readonly status: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>, Schema.Null]>>;
|
|
392
|
+
readonly conversationId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>>;
|
|
393
|
+
readonly contactId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>>;
|
|
394
|
+
readonly from: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
395
|
+
readonly after: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
396
|
+
readonly before: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
397
|
+
}>;
|
|
398
|
+
export type MessagesList200 = MessagePage;
|
|
399
|
+
export declare const MessagesList200: Schema.Struct<{
|
|
400
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
401
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
402
|
+
readonly channel: Schema.Literal<"email">;
|
|
403
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
404
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
405
|
+
readonly from: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
406
|
+
readonly to: Schema.$Array<Schema.String>;
|
|
407
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
408
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
409
|
+
readonly createdAt: Schema.String;
|
|
410
|
+
}>>;
|
|
411
|
+
readonly nextCursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
412
|
+
}>;
|
|
413
|
+
export type MessagesList401 = UnauthorizedError;
|
|
414
|
+
export declare const MessagesList401: typeof UnauthorizedError;
|
|
415
|
+
export type MessagesList403 = ForbiddenError;
|
|
416
|
+
export declare const MessagesList403: typeof ForbiddenError;
|
|
417
|
+
export type MessagesList422 = ValidationError;
|
|
418
|
+
export declare const MessagesList422: typeof ValidationError;
|
|
419
|
+
export type MessagesList500 = InternalError;
|
|
420
|
+
export declare const MessagesList500: typeof InternalError;
|
|
421
|
+
export type MessagesList504 = GatewayTimeoutError;
|
|
422
|
+
export declare const MessagesList504: typeof GatewayTimeoutError;
|
|
423
|
+
export type MessagesSendHeaders = {
|
|
424
|
+
readonly "idempotency-key"?: string | null;
|
|
425
|
+
};
|
|
426
|
+
export declare const MessagesSendHeaders: Schema.Struct<{
|
|
427
|
+
readonly "idempotency-key": Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
428
|
+
}>;
|
|
429
|
+
export type MessagesSendRequestJson = {
|
|
430
|
+
readonly conversationId?: ConversationId | null | null;
|
|
431
|
+
readonly metadata?: MessageMetadata;
|
|
432
|
+
readonly channel: "email";
|
|
433
|
+
readonly to: EmailRecipients;
|
|
434
|
+
readonly cc?: EmailCcRecipients;
|
|
435
|
+
readonly bcc?: EmailBccRecipients;
|
|
436
|
+
readonly from?: EmailSender;
|
|
437
|
+
readonly email: EmailContent;
|
|
438
|
+
};
|
|
439
|
+
export declare const MessagesSendRequestJson: Schema.Struct<{
|
|
440
|
+
readonly conversationId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>, Schema.Null]>>;
|
|
441
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
442
|
+
readonly channel: Schema.Literal<"email">;
|
|
443
|
+
readonly to: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
444
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
445
|
+
}>, Schema.Struct<{
|
|
446
|
+
readonly email: Schema.String;
|
|
447
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
448
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
449
|
+
}>]>>;
|
|
450
|
+
readonly cc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
451
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
452
|
+
}>, Schema.Struct<{
|
|
453
|
+
readonly email: Schema.String;
|
|
454
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
455
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
456
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
457
|
+
readonly bcc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
458
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
459
|
+
}>, Schema.Struct<{
|
|
460
|
+
readonly email: Schema.String;
|
|
461
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
462
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
463
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
464
|
+
readonly from: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
465
|
+
readonly email: Schema.String;
|
|
466
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
467
|
+
}>, Schema.Null]>>;
|
|
468
|
+
readonly email: Schema.Struct<{
|
|
469
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
470
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
471
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
472
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
473
|
+
readonly filename: Schema.String;
|
|
474
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
475
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
476
|
+
readonly contentType: Schema.String;
|
|
477
|
+
readonly size: Schema.Finite;
|
|
478
|
+
}>>, Schema.Null]>>;
|
|
479
|
+
readonly publicationId: Schema.optionalKey<Schema.brand<Schema.String, "TemplatePublicationId">>;
|
|
480
|
+
readonly inputContractId: Schema.optionalKey<Schema.brand<Schema.String, "TemplateInputContractId">>;
|
|
481
|
+
readonly templateId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "TemplateId">, Schema.Null]>>;
|
|
482
|
+
readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
483
|
+
readonly templateData: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
484
|
+
readonly locale: Schema.optionalKey<Schema.String>;
|
|
485
|
+
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
486
|
+
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
487
|
+
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
488
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>, Schema.Null]>>;
|
|
489
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
490
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
491
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
492
|
+
}>>;
|
|
493
|
+
readonly footer: Schema.optionalKey<Schema.Struct<{
|
|
494
|
+
readonly enabled: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
495
|
+
}>>;
|
|
496
|
+
}>;
|
|
497
|
+
}>;
|
|
498
|
+
export type MessagesSend201 = MessageReceipt;
|
|
499
|
+
export declare const MessagesSend201: Schema.Struct<{
|
|
500
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
501
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
502
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
503
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
504
|
+
readonly skippedRecipients: Schema.$Array<Schema.Struct<{
|
|
505
|
+
readonly address: Schema.String;
|
|
506
|
+
readonly reason: Schema.Union<readonly [Schema.Literal<"bounce">, Schema.Literal<"complaint">, Schema.Literal<"unsubscribe">, Schema.Literal<"manual">, Schema.Literal<"group-unsubscribe">]>;
|
|
507
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
|
|
508
|
+
}>>;
|
|
509
|
+
readonly createdAt: Schema.String;
|
|
510
|
+
}>;
|
|
511
|
+
export type MessagesSend401 = UnauthorizedError;
|
|
512
|
+
export declare const MessagesSend401: typeof UnauthorizedError;
|
|
513
|
+
export type MessagesSend402 = PaymentRequiredError;
|
|
514
|
+
export declare const MessagesSend402: typeof PaymentRequiredError;
|
|
515
|
+
export type MessagesSend403 = ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError;
|
|
516
|
+
export declare const MessagesSend403: Schema.Union<readonly [typeof ForbiddenError, typeof OnboardingReviewRequiredError, typeof FlagDisabledError]>;
|
|
517
|
+
export type MessagesSend404 = ResourceNotFoundError;
|
|
518
|
+
export declare const MessagesSend404: typeof ResourceNotFoundError;
|
|
519
|
+
export type MessagesSend409 = ConflictError;
|
|
520
|
+
export declare const MessagesSend409: typeof ConflictError;
|
|
521
|
+
export type MessagesSend422 = ValidationError;
|
|
522
|
+
export declare const MessagesSend422: typeof ValidationError;
|
|
523
|
+
export type MessagesSend429 = RateLimitedError;
|
|
524
|
+
export declare const MessagesSend429: typeof RateLimitedError;
|
|
525
|
+
export type MessagesSend500 = InternalError;
|
|
526
|
+
export declare const MessagesSend500: typeof InternalError;
|
|
527
|
+
export type MessagesSend502 = BillingProviderError | ExternalServiceError;
|
|
528
|
+
export declare const MessagesSend502: Schema.Union<readonly [typeof BillingProviderError, typeof ExternalServiceError]>;
|
|
529
|
+
export type MessagesSend503 = SenderNotReadyError | DeliveryUnavailableError;
|
|
530
|
+
export declare const MessagesSend503: Schema.Union<readonly [typeof SenderNotReadyError, typeof DeliveryUnavailableError]>;
|
|
531
|
+
export type MessagesSend504 = GatewayTimeoutError;
|
|
532
|
+
export declare const MessagesSend504: typeof GatewayTimeoutError;
|
|
533
|
+
export type MessagesGetPathParams = {
|
|
534
|
+
readonly id: MessageId;
|
|
535
|
+
};
|
|
536
|
+
export declare const MessagesGetPathParams: Schema.Struct<{
|
|
537
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
538
|
+
}>;
|
|
539
|
+
export type MessagesGet200 = Message;
|
|
540
|
+
export declare const MessagesGet200: Schema.Struct<{
|
|
541
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
542
|
+
readonly channel: Schema.Literal<"email">;
|
|
543
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
544
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
545
|
+
readonly from: Schema.Union<readonly [Schema.Struct<{
|
|
546
|
+
readonly address: Schema.String;
|
|
547
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
548
|
+
}>, Schema.Null]>;
|
|
549
|
+
readonly to: Schema.$Array<Schema.Struct<{
|
|
550
|
+
readonly address: Schema.String;
|
|
551
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
552
|
+
}>>;
|
|
553
|
+
readonly cc: Schema.$Array<Schema.Struct<{
|
|
554
|
+
readonly address: Schema.String;
|
|
555
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
556
|
+
}>>;
|
|
557
|
+
readonly bcc: Schema.$Array<Schema.Struct<{
|
|
558
|
+
readonly address: Schema.String;
|
|
559
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
560
|
+
}>>;
|
|
561
|
+
readonly replyTo: Schema.$Array<Schema.String>;
|
|
562
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
563
|
+
readonly conversationId: Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>;
|
|
564
|
+
readonly inReplyToMessageId: Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>;
|
|
565
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
566
|
+
readonly metadata: Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>;
|
|
567
|
+
readonly isTest: Schema.Boolean;
|
|
568
|
+
readonly scheduledAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
569
|
+
readonly submission: Schema.Union<readonly [Schema.Struct<{
|
|
570
|
+
readonly origin: Schema.Union<readonly [Schema.Literal<"direct">, Schema.Literal<"campaign">, Schema.Literal<"scheduled">, Schema.Literal<"mailbox">, Schema.Literal<"forwarding">, Schema.Literal<"journey">]>;
|
|
571
|
+
readonly transport: Schema.Union<readonly [Schema.Literal<"http">, Schema.Null]>;
|
|
572
|
+
readonly credential: Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{
|
|
573
|
+
readonly kind: Schema.Literal<"api_key">;
|
|
574
|
+
readonly apiKeyId: Schema.Union<readonly [Schema.brand<Schema.String, "ApiKeyId">, Schema.Null]>;
|
|
575
|
+
}>, Schema.Struct<{
|
|
576
|
+
readonly kind: Schema.Literal<"oauth">;
|
|
577
|
+
readonly clientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
578
|
+
}>, Schema.Struct<{
|
|
579
|
+
readonly kind: Schema.Literal<"session">;
|
|
580
|
+
}>]>, Schema.Null]>;
|
|
581
|
+
readonly userId: Schema.Union<readonly [Schema.brand<Schema.String, "UserId">, Schema.Null]>;
|
|
582
|
+
readonly client: Schema.Union<readonly [Schema.Struct<{
|
|
583
|
+
readonly surface: Schema.Union<readonly [Schema.Literal<"typescript-promise">, Schema.Literal<"typescript-effect">, Schema.Literal<"cli">, Schema.Literal<"mcp">]>;
|
|
584
|
+
readonly version: Schema.String;
|
|
585
|
+
}>, Schema.Null]>;
|
|
586
|
+
}>, Schema.Null]>;
|
|
587
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
588
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
589
|
+
readonly skippedRecipients: Schema.$Array<Schema.Struct<{
|
|
590
|
+
readonly address: Schema.String;
|
|
591
|
+
readonly reason: Schema.Union<readonly [Schema.Literal<"bounce">, Schema.Literal<"complaint">, Schema.Literal<"unsubscribe">, Schema.Literal<"manual">, Schema.Literal<"group-unsubscribe">]>;
|
|
592
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
|
|
593
|
+
}>>;
|
|
594
|
+
readonly createdAt: Schema.String;
|
|
595
|
+
readonly updatedAt: Schema.String;
|
|
596
|
+
}>;
|
|
597
|
+
export type MessagesGet401 = UnauthorizedError;
|
|
598
|
+
export declare const MessagesGet401: typeof UnauthorizedError;
|
|
599
|
+
export type MessagesGet403 = ForbiddenError;
|
|
600
|
+
export declare const MessagesGet403: typeof ForbiddenError;
|
|
601
|
+
export type MessagesGet404 = ResourceNotFoundError;
|
|
602
|
+
export declare const MessagesGet404: typeof ResourceNotFoundError;
|
|
603
|
+
export type MessagesGet422 = ValidationError;
|
|
604
|
+
export declare const MessagesGet422: typeof ValidationError;
|
|
605
|
+
export type MessagesGet500 = InternalError;
|
|
606
|
+
export declare const MessagesGet500: typeof InternalError;
|
|
607
|
+
export type MessagesGet504 = GatewayTimeoutError;
|
|
608
|
+
export declare const MessagesGet504: typeof GatewayTimeoutError;
|
|
609
|
+
export type MessagesRemovePathParams = {
|
|
610
|
+
readonly id: MessageId;
|
|
611
|
+
};
|
|
612
|
+
export declare const MessagesRemovePathParams: Schema.Struct<{
|
|
613
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
614
|
+
}>;
|
|
615
|
+
export type MessagesRemove200 = {
|
|
616
|
+
readonly success: boolean;
|
|
617
|
+
readonly message: string;
|
|
618
|
+
};
|
|
619
|
+
export declare const MessagesRemove200: Schema.Struct<{
|
|
620
|
+
readonly success: Schema.Boolean;
|
|
621
|
+
readonly message: Schema.String;
|
|
622
|
+
}>;
|
|
623
|
+
export type MessagesRemove401 = UnauthorizedError;
|
|
624
|
+
export declare const MessagesRemove401: typeof UnauthorizedError;
|
|
625
|
+
export type MessagesRemove403 = ForbiddenError;
|
|
626
|
+
export declare const MessagesRemove403: typeof ForbiddenError;
|
|
627
|
+
export type MessagesRemove404 = ResourceNotFoundError;
|
|
628
|
+
export declare const MessagesRemove404: typeof ResourceNotFoundError;
|
|
629
|
+
export type MessagesRemove422 = ValidationError;
|
|
630
|
+
export declare const MessagesRemove422: typeof ValidationError;
|
|
631
|
+
export type MessagesRemove500 = InternalError;
|
|
632
|
+
export declare const MessagesRemove500: typeof InternalError;
|
|
633
|
+
export type MessagesRemove502 = BillingProviderError;
|
|
634
|
+
export declare const MessagesRemove502: typeof BillingProviderError;
|
|
635
|
+
export type MessagesRemove504 = GatewayTimeoutError;
|
|
636
|
+
export declare const MessagesRemove504: typeof GatewayTimeoutError;
|
|
637
|
+
export type MessagesGetContentPathParams = {
|
|
638
|
+
readonly id: MessageId;
|
|
639
|
+
};
|
|
640
|
+
export declare const MessagesGetContentPathParams: Schema.Struct<{
|
|
641
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
642
|
+
}>;
|
|
643
|
+
export type MessagesGetContent200 = MessageContent;
|
|
644
|
+
export declare const MessagesGetContent200: Schema.Struct<{
|
|
645
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
646
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
647
|
+
readonly markdown: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
648
|
+
readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
649
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
650
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
651
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
652
|
+
readonly headers: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.String>, Schema.Null]>>;
|
|
653
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
654
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
655
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
656
|
+
}>>;
|
|
657
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
658
|
+
readonly filename: Schema.String;
|
|
659
|
+
readonly contentId: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
660
|
+
readonly isInline: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
661
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
662
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
663
|
+
readonly contentType: Schema.String;
|
|
664
|
+
readonly size: Schema.Finite;
|
|
665
|
+
}>>, Schema.Null]>>;
|
|
666
|
+
}>, Schema.Null]>>;
|
|
667
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
668
|
+
}>;
|
|
669
|
+
export type MessagesGetContent401 = UnauthorizedError;
|
|
670
|
+
export declare const MessagesGetContent401: typeof UnauthorizedError;
|
|
671
|
+
export type MessagesGetContent403 = ForbiddenError;
|
|
672
|
+
export declare const MessagesGetContent403: typeof ForbiddenError;
|
|
673
|
+
export type MessagesGetContent404 = ResourceNotFoundError;
|
|
674
|
+
export declare const MessagesGetContent404: typeof ResourceNotFoundError;
|
|
675
|
+
export type MessagesGetContent422 = ValidationError;
|
|
676
|
+
export declare const MessagesGetContent422: typeof ValidationError;
|
|
677
|
+
export type MessagesGetContent500 = InternalError;
|
|
678
|
+
export declare const MessagesGetContent500: typeof InternalError;
|
|
679
|
+
export type MessagesGetContent504 = GatewayTimeoutError;
|
|
680
|
+
export declare const MessagesGetContent504: typeof GatewayTimeoutError;
|
|
681
|
+
export type MessagesListDeliveriesPathParams = {
|
|
682
|
+
readonly id: MessageId;
|
|
683
|
+
};
|
|
684
|
+
export declare const MessagesListDeliveriesPathParams: Schema.Struct<{
|
|
685
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
686
|
+
}>;
|
|
687
|
+
export type MessagesListDeliveries200 = MessageDeliveryList;
|
|
688
|
+
export declare const MessagesListDeliveries200: Schema.Struct<{
|
|
689
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
690
|
+
readonly id: Schema.brand<Schema.String, "MessageDeliveryId">;
|
|
691
|
+
readonly recipient: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
692
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
693
|
+
readonly attemptCount: Schema.Finite;
|
|
694
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
695
|
+
readonly nextRetryAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
696
|
+
readonly sentAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
697
|
+
readonly deliveredAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
698
|
+
readonly readAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
699
|
+
readonly failedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
700
|
+
readonly error: Schema.Union<readonly [Schema.Struct<{
|
|
701
|
+
readonly code: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
702
|
+
readonly message: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
703
|
+
readonly retryable: Schema.Union<readonly [Schema.Boolean, Schema.Null]>;
|
|
704
|
+
}>, Schema.Null]>;
|
|
705
|
+
readonly createdAt: Schema.String;
|
|
706
|
+
readonly updatedAt: Schema.String;
|
|
707
|
+
}>>;
|
|
708
|
+
}>;
|
|
709
|
+
export type MessagesListDeliveries401 = UnauthorizedError;
|
|
710
|
+
export declare const MessagesListDeliveries401: typeof UnauthorizedError;
|
|
711
|
+
export type MessagesListDeliveries403 = ForbiddenError;
|
|
712
|
+
export declare const MessagesListDeliveries403: typeof ForbiddenError;
|
|
713
|
+
export type MessagesListDeliveries404 = ResourceNotFoundError;
|
|
714
|
+
export declare const MessagesListDeliveries404: typeof ResourceNotFoundError;
|
|
715
|
+
export type MessagesListDeliveries422 = ValidationError;
|
|
716
|
+
export declare const MessagesListDeliveries422: typeof ValidationError;
|
|
717
|
+
export type MessagesListDeliveries500 = InternalError;
|
|
718
|
+
export declare const MessagesListDeliveries500: typeof InternalError;
|
|
719
|
+
export type MessagesListDeliveries504 = GatewayTimeoutError;
|
|
720
|
+
export declare const MessagesListDeliveries504: typeof GatewayTimeoutError;
|
|
721
|
+
export type MessagesGetEmailPathParams = {
|
|
722
|
+
readonly id: MessageId;
|
|
723
|
+
};
|
|
724
|
+
export declare const MessagesGetEmailPathParams: Schema.Struct<{
|
|
725
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
726
|
+
}>;
|
|
727
|
+
export type MessagesGetEmailQuery = {
|
|
728
|
+
readonly includeDownloadUrls?: string | null;
|
|
729
|
+
readonly urlExpiresIn?: string | null;
|
|
730
|
+
};
|
|
731
|
+
export declare const MessagesGetEmailQuery: Schema.Struct<{
|
|
732
|
+
readonly includeDownloadUrls: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
733
|
+
readonly urlExpiresIn: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
734
|
+
}>;
|
|
735
|
+
export type MessagesGetEmail200 = {
|
|
736
|
+
readonly deliveries: ReadonlyArray<{
|
|
737
|
+
readonly scheduling: {
|
|
738
|
+
readonly dueAt: string;
|
|
739
|
+
readonly expiresAt: string;
|
|
740
|
+
readonly waitReason: "rate" | "daily-quota" | "domain-health" | "sending-paused" | "upstream-unavailable" | "retry" | "campaign-paused" | "domain-warming" | "onboarding-review" | "content-review" | "screening-unavailable" | null;
|
|
741
|
+
readonly reviewExpectedAt: string | null;
|
|
742
|
+
} | null;
|
|
743
|
+
readonly id: string;
|
|
744
|
+
readonly messageId: string;
|
|
745
|
+
readonly recipientId: string | null;
|
|
746
|
+
readonly channel: "email";
|
|
747
|
+
readonly status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
748
|
+
readonly attemptCount: number;
|
|
749
|
+
readonly maxAttempts: number;
|
|
750
|
+
readonly queuedAt: string | null;
|
|
751
|
+
readonly claimedAt: string | null;
|
|
752
|
+
readonly lastAttemptAt: string | null;
|
|
753
|
+
readonly nextRetryAt: string | null;
|
|
754
|
+
readonly sentAt: string | null;
|
|
755
|
+
readonly deliveredAt: string | null;
|
|
756
|
+
readonly readAt: string | null;
|
|
757
|
+
readonly failedAt: string | null;
|
|
758
|
+
readonly terminalAt: string | null;
|
|
759
|
+
readonly errorCode: string | null;
|
|
760
|
+
readonly errorMessage: string | null;
|
|
761
|
+
readonly errorDetails: DeliveryErrorDetails | null;
|
|
762
|
+
readonly cost: string;
|
|
763
|
+
readonly currency: string;
|
|
764
|
+
readonly idempotencyKey: string | null;
|
|
765
|
+
readonly createdAt: string;
|
|
766
|
+
readonly updatedAt: string;
|
|
767
|
+
}>;
|
|
768
|
+
readonly id: MessageId;
|
|
769
|
+
readonly organizationId: string;
|
|
770
|
+
readonly conversationId: ConversationId | null;
|
|
771
|
+
readonly status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
772
|
+
readonly channel: "email";
|
|
773
|
+
readonly direction: "outbound" | "inbound";
|
|
774
|
+
readonly subject: string | null;
|
|
775
|
+
readonly fromEmail: string;
|
|
776
|
+
readonly fromName: string | null;
|
|
777
|
+
readonly toEmails: ReadonlyArray<EmailAddress>;
|
|
778
|
+
readonly ccEmails: ReadonlyArray<EmailAddress> | null;
|
|
779
|
+
readonly bccEmails: ReadonlyArray<EmailAddress> | null;
|
|
780
|
+
readonly replyToEmails: ReadonlyArray<string> | null;
|
|
781
|
+
readonly messageIdHeader: string;
|
|
782
|
+
readonly inReplyTo: string | null;
|
|
783
|
+
readonly references: ReadonlyArray<string> | null;
|
|
784
|
+
readonly threadPosition: number | null;
|
|
785
|
+
readonly newContent: string | null;
|
|
786
|
+
readonly quotedContent: string | null;
|
|
787
|
+
readonly hasQuotedContent: boolean;
|
|
788
|
+
readonly dkimVerdict: "pass" | "fail" | "softfail" | "neutral" | "none" | "policy" | "temperror" | "permerror" | null;
|
|
789
|
+
readonly spfVerdict: "pass" | "fail" | "softfail" | "neutral" | "none" | "policy" | "temperror" | "permerror" | null;
|
|
790
|
+
readonly dmarcVerdict: "pass" | "fail" | "softfail" | "neutral" | "none" | "policy" | "temperror" | "permerror" | null;
|
|
791
|
+
readonly isAutoReply: boolean;
|
|
792
|
+
readonly autoReplyReason: "out-of-office" | "auto-response" | "delivery-status" | "read-receipt" | null;
|
|
793
|
+
readonly listUnsubscribeUrl: string | null;
|
|
794
|
+
readonly listUnsubscribeEmail: string | null;
|
|
795
|
+
readonly priority: "high" | "normal" | "low" | null;
|
|
796
|
+
readonly parsingErrors: ReadonlyArray<string> | null;
|
|
797
|
+
readonly parsingDuration: number | null;
|
|
798
|
+
readonly hasAttachments: boolean;
|
|
799
|
+
readonly attachmentCount: number;
|
|
800
|
+
readonly attachments: ReadonlyArray<{
|
|
801
|
+
readonly id: AttachmentId;
|
|
802
|
+
readonly filename: string;
|
|
803
|
+
readonly contentType: string;
|
|
804
|
+
readonly size: number;
|
|
805
|
+
readonly isInline: boolean;
|
|
806
|
+
readonly contentId: string | null;
|
|
807
|
+
}>;
|
|
808
|
+
readonly downloadUrls: {
|
|
809
|
+
readonly rawMime: string | null;
|
|
810
|
+
readonly html: string | null;
|
|
811
|
+
readonly text: string | null;
|
|
812
|
+
readonly expiresAt: string;
|
|
813
|
+
} | null;
|
|
814
|
+
readonly createdAt: string;
|
|
815
|
+
readonly receivedAt: string | null;
|
|
816
|
+
readonly processedAt: string | null;
|
|
817
|
+
};
|
|
818
|
+
export declare const MessagesGetEmail200: Schema.Struct<{
|
|
819
|
+
readonly deliveries: Schema.$Array<Schema.Struct<{
|
|
820
|
+
readonly scheduling: Schema.Union<readonly [Schema.Struct<{
|
|
821
|
+
readonly dueAt: Schema.String;
|
|
822
|
+
readonly expiresAt: Schema.String;
|
|
823
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
824
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
825
|
+
}>, Schema.Null]>;
|
|
826
|
+
readonly id: Schema.String;
|
|
827
|
+
readonly messageId: Schema.String;
|
|
828
|
+
readonly recipientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
829
|
+
readonly channel: Schema.Literal<"email">;
|
|
830
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
831
|
+
readonly attemptCount: Schema.Finite;
|
|
832
|
+
readonly maxAttempts: Schema.Finite;
|
|
833
|
+
readonly queuedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
834
|
+
readonly claimedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
835
|
+
readonly lastAttemptAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
836
|
+
readonly nextRetryAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
837
|
+
readonly sentAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
838
|
+
readonly deliveredAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
839
|
+
readonly readAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
840
|
+
readonly failedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
841
|
+
readonly terminalAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
842
|
+
readonly errorCode: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
843
|
+
readonly errorMessage: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
844
|
+
readonly errorDetails: Schema.Union<readonly [Schema.Struct<{
|
|
845
|
+
readonly code: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
846
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
847
|
+
readonly message: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
848
|
+
readonly details: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.Finite, Schema.Null]>>, Schema.Null]>>;
|
|
849
|
+
readonly retryable: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
850
|
+
}>, Schema.Null]>;
|
|
851
|
+
readonly cost: Schema.String;
|
|
852
|
+
readonly currency: Schema.String;
|
|
853
|
+
readonly idempotencyKey: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
854
|
+
readonly createdAt: Schema.String;
|
|
855
|
+
readonly updatedAt: Schema.String;
|
|
856
|
+
}>>;
|
|
857
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
858
|
+
readonly organizationId: Schema.String;
|
|
859
|
+
readonly conversationId: Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>;
|
|
860
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
861
|
+
readonly channel: Schema.Literal<"email">;
|
|
862
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
863
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
864
|
+
readonly fromEmail: Schema.String;
|
|
865
|
+
readonly fromName: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
866
|
+
readonly toEmails: Schema.$Array<Schema.Struct<{
|
|
867
|
+
readonly email: Schema.String;
|
|
868
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
869
|
+
}>>;
|
|
870
|
+
readonly ccEmails: Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
871
|
+
readonly email: Schema.String;
|
|
872
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
873
|
+
}>>, Schema.Null]>;
|
|
874
|
+
readonly bccEmails: Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
875
|
+
readonly email: Schema.String;
|
|
876
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
877
|
+
}>>, Schema.Null]>;
|
|
878
|
+
readonly replyToEmails: Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>;
|
|
879
|
+
readonly messageIdHeader: Schema.String;
|
|
880
|
+
readonly inReplyTo: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
881
|
+
readonly references: Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>;
|
|
882
|
+
readonly threadPosition: Schema.Union<readonly [Schema.Finite, Schema.Null]>;
|
|
883
|
+
readonly newContent: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
884
|
+
readonly quotedContent: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
885
|
+
readonly hasQuotedContent: Schema.Boolean;
|
|
886
|
+
readonly dkimVerdict: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pass">, Schema.Literal<"fail">, Schema.Literal<"softfail">, Schema.Literal<"neutral">, Schema.Literal<"none">, Schema.Literal<"policy">, Schema.Literal<"temperror">, Schema.Literal<"permerror">]>, Schema.Null]>;
|
|
887
|
+
readonly spfVerdict: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pass">, Schema.Literal<"fail">, Schema.Literal<"softfail">, Schema.Literal<"neutral">, Schema.Literal<"none">, Schema.Literal<"policy">, Schema.Literal<"temperror">, Schema.Literal<"permerror">]>, Schema.Null]>;
|
|
888
|
+
readonly dmarcVerdict: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pass">, Schema.Literal<"fail">, Schema.Literal<"softfail">, Schema.Literal<"neutral">, Schema.Literal<"none">, Schema.Literal<"policy">, Schema.Literal<"temperror">, Schema.Literal<"permerror">]>, Schema.Null]>;
|
|
889
|
+
readonly isAutoReply: Schema.Boolean;
|
|
890
|
+
readonly autoReplyReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"out-of-office">, Schema.Literal<"auto-response">, Schema.Literal<"delivery-status">, Schema.Literal<"read-receipt">]>, Schema.Null]>;
|
|
891
|
+
readonly listUnsubscribeUrl: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
892
|
+
readonly listUnsubscribeEmail: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
893
|
+
readonly priority: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"high">, Schema.Literal<"normal">, Schema.Literal<"low">]>, Schema.Null]>;
|
|
894
|
+
readonly parsingErrors: Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>;
|
|
895
|
+
readonly parsingDuration: Schema.Union<readonly [Schema.Finite, Schema.Null]>;
|
|
896
|
+
readonly hasAttachments: Schema.Boolean;
|
|
897
|
+
readonly attachmentCount: Schema.Finite;
|
|
898
|
+
readonly attachments: Schema.$Array<Schema.Struct<{
|
|
899
|
+
readonly id: Schema.brand<Schema.String, "AttachmentId">;
|
|
900
|
+
readonly filename: Schema.String;
|
|
901
|
+
readonly contentType: Schema.String;
|
|
902
|
+
readonly size: Schema.Finite;
|
|
903
|
+
readonly isInline: Schema.Boolean;
|
|
904
|
+
readonly contentId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
905
|
+
}>>;
|
|
906
|
+
readonly downloadUrls: Schema.Union<readonly [Schema.Struct<{
|
|
907
|
+
readonly rawMime: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
908
|
+
readonly html: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
909
|
+
readonly text: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
910
|
+
readonly expiresAt: Schema.String;
|
|
911
|
+
}>, Schema.Null]>;
|
|
912
|
+
readonly createdAt: Schema.String;
|
|
913
|
+
readonly receivedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
914
|
+
readonly processedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
915
|
+
}>;
|
|
916
|
+
export type MessagesGetEmail401 = UnauthorizedError;
|
|
917
|
+
export declare const MessagesGetEmail401: typeof UnauthorizedError;
|
|
918
|
+
export type MessagesGetEmail403 = ForbiddenError;
|
|
919
|
+
export declare const MessagesGetEmail403: typeof ForbiddenError;
|
|
920
|
+
export type MessagesGetEmail404 = ResourceNotFoundError;
|
|
921
|
+
export declare const MessagesGetEmail404: typeof ResourceNotFoundError;
|
|
922
|
+
export type MessagesGetEmail422 = ValidationError;
|
|
923
|
+
export declare const MessagesGetEmail422: typeof ValidationError;
|
|
924
|
+
export type MessagesGetEmail500 = InternalError;
|
|
925
|
+
export declare const MessagesGetEmail500: typeof InternalError;
|
|
926
|
+
export type MessagesGetEmail504 = GatewayTimeoutError;
|
|
927
|
+
export declare const MessagesGetEmail504: typeof GatewayTimeoutError;
|
|
928
|
+
export type MessagesGetEventsPathParams = {
|
|
929
|
+
readonly id: MessageId;
|
|
930
|
+
};
|
|
931
|
+
export declare const MessagesGetEventsPathParams: Schema.Struct<{
|
|
932
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
933
|
+
}>;
|
|
934
|
+
export type MessagesGetEventsQuery = {
|
|
935
|
+
readonly limit?: string | null;
|
|
936
|
+
readonly cursor?: Cursor | null;
|
|
937
|
+
};
|
|
938
|
+
export declare const MessagesGetEventsQuery: Schema.Struct<{
|
|
939
|
+
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
940
|
+
readonly cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
941
|
+
}>;
|
|
942
|
+
export type MessagesGetEvents200 = MessageEventPage;
|
|
943
|
+
export declare const MessagesGetEvents200: Schema.Struct<{
|
|
944
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
945
|
+
readonly id: Schema.brand<Schema.String, "MessageEventId">;
|
|
946
|
+
readonly messageId: Schema.brand<Schema.String, "MessageId">;
|
|
947
|
+
readonly eventType: Schema.String;
|
|
948
|
+
readonly status: Schema.String;
|
|
949
|
+
readonly timestamp: Schema.String;
|
|
950
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
951
|
+
}>>;
|
|
952
|
+
readonly nextCursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
953
|
+
}>;
|
|
954
|
+
export type MessagesGetEvents401 = UnauthorizedError;
|
|
955
|
+
export declare const MessagesGetEvents401: typeof UnauthorizedError;
|
|
956
|
+
export type MessagesGetEvents403 = ForbiddenError;
|
|
957
|
+
export declare const MessagesGetEvents403: typeof ForbiddenError;
|
|
958
|
+
export type MessagesGetEvents404 = ResourceNotFoundError;
|
|
959
|
+
export declare const MessagesGetEvents404: typeof ResourceNotFoundError;
|
|
960
|
+
export type MessagesGetEvents422 = ValidationError;
|
|
961
|
+
export declare const MessagesGetEvents422: typeof ValidationError;
|
|
962
|
+
export type MessagesGetEvents500 = InternalError;
|
|
963
|
+
export declare const MessagesGetEvents500: typeof InternalError;
|
|
964
|
+
export type MessagesGetEvents504 = GatewayTimeoutError;
|
|
965
|
+
export declare const MessagesGetEvents504: typeof GatewayTimeoutError;
|
|
966
|
+
export type MessagesGetStatusPathParams = {
|
|
967
|
+
readonly id: MessageId;
|
|
968
|
+
};
|
|
969
|
+
export declare const MessagesGetStatusPathParams: Schema.Struct<{
|
|
970
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
971
|
+
}>;
|
|
972
|
+
export type MessagesGetStatus200 = {
|
|
973
|
+
readonly id: MessageId;
|
|
974
|
+
readonly status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
|
|
975
|
+
readonly updatedAt: string;
|
|
976
|
+
};
|
|
977
|
+
export declare const MessagesGetStatus200: Schema.Struct<{
|
|
978
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
979
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
980
|
+
readonly updatedAt: Schema.String;
|
|
981
|
+
}>;
|
|
982
|
+
export type MessagesGetStatus401 = UnauthorizedError;
|
|
983
|
+
export declare const MessagesGetStatus401: typeof UnauthorizedError;
|
|
984
|
+
export type MessagesGetStatus403 = ForbiddenError;
|
|
985
|
+
export declare const MessagesGetStatus403: typeof ForbiddenError;
|
|
986
|
+
export type MessagesGetStatus404 = ResourceNotFoundError;
|
|
987
|
+
export declare const MessagesGetStatus404: typeof ResourceNotFoundError;
|
|
988
|
+
export type MessagesGetStatus422 = ValidationError;
|
|
989
|
+
export declare const MessagesGetStatus422: typeof ValidationError;
|
|
990
|
+
export type MessagesGetStatus500 = InternalError;
|
|
991
|
+
export declare const MessagesGetStatus500: typeof InternalError;
|
|
992
|
+
export type MessagesGetStatus504 = GatewayTimeoutError;
|
|
993
|
+
export declare const MessagesGetStatus504: typeof GatewayTimeoutError;
|
|
994
|
+
export type MessagesValidateEmailRequestJson = {
|
|
995
|
+
readonly conversationId?: ConversationId | null | null;
|
|
996
|
+
readonly metadata?: MessageMetadata;
|
|
997
|
+
readonly channel: "email";
|
|
998
|
+
readonly to: EmailRecipients;
|
|
999
|
+
readonly cc?: EmailCcRecipients;
|
|
1000
|
+
readonly bcc?: EmailBccRecipients;
|
|
1001
|
+
readonly from?: EmailSender;
|
|
1002
|
+
readonly email: EmailContent;
|
|
1003
|
+
};
|
|
1004
|
+
export declare const MessagesValidateEmailRequestJson: Schema.Struct<{
|
|
1005
|
+
readonly conversationId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>, Schema.Null]>>;
|
|
1006
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
1007
|
+
readonly channel: Schema.Literal<"email">;
|
|
1008
|
+
readonly to: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1009
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
1010
|
+
}>, Schema.Struct<{
|
|
1011
|
+
readonly email: Schema.String;
|
|
1012
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1013
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
1014
|
+
}>]>>;
|
|
1015
|
+
readonly cc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1016
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
1017
|
+
}>, Schema.Struct<{
|
|
1018
|
+
readonly email: Schema.String;
|
|
1019
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1020
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
1021
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
1022
|
+
readonly bcc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1023
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
1024
|
+
}>, Schema.Struct<{
|
|
1025
|
+
readonly email: Schema.String;
|
|
1026
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1027
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
1028
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
1029
|
+
readonly from: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
1030
|
+
readonly email: Schema.String;
|
|
1031
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1032
|
+
}>, Schema.Null]>>;
|
|
1033
|
+
readonly email: Schema.Struct<{
|
|
1034
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1035
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1036
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1037
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
1038
|
+
readonly filename: Schema.String;
|
|
1039
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1040
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
1041
|
+
readonly contentType: Schema.String;
|
|
1042
|
+
readonly size: Schema.Finite;
|
|
1043
|
+
}>>, Schema.Null]>>;
|
|
1044
|
+
readonly publicationId: Schema.optionalKey<Schema.brand<Schema.String, "TemplatePublicationId">>;
|
|
1045
|
+
readonly inputContractId: Schema.optionalKey<Schema.brand<Schema.String, "TemplateInputContractId">>;
|
|
1046
|
+
readonly templateId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "TemplateId">, Schema.Null]>>;
|
|
1047
|
+
readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1048
|
+
readonly templateData: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
1049
|
+
readonly locale: Schema.optionalKey<Schema.String>;
|
|
1050
|
+
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
1051
|
+
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
1052
|
+
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
1053
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>, Schema.Null]>>;
|
|
1054
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1055
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1056
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
1057
|
+
}>>;
|
|
1058
|
+
readonly footer: Schema.optionalKey<Schema.Struct<{
|
|
1059
|
+
readonly enabled: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
1060
|
+
}>>;
|
|
1061
|
+
}>;
|
|
1062
|
+
}>;
|
|
1063
|
+
export type MessagesValidateEmail200 = ValidateEmailResponse;
|
|
1064
|
+
export declare const MessagesValidateEmail200: Schema.Struct<{
|
|
1065
|
+
readonly valid: Schema.Literal<true>;
|
|
1066
|
+
readonly from: Schema.Struct<{
|
|
1067
|
+
readonly email: Schema.String;
|
|
1068
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1069
|
+
}>;
|
|
1070
|
+
readonly recipientCount: Schema.Finite;
|
|
1071
|
+
readonly content: Schema.Struct<{
|
|
1072
|
+
readonly source: Schema.Union<readonly [Schema.Literal<"inline">, Schema.Literal<"template">]>;
|
|
1073
|
+
readonly subject: Schema.String;
|
|
1074
|
+
readonly hasHtml: Schema.Boolean;
|
|
1075
|
+
readonly hasText: Schema.Boolean;
|
|
1076
|
+
}>;
|
|
1077
|
+
}>;
|
|
1078
|
+
export type MessagesValidateEmail401 = UnauthorizedError;
|
|
1079
|
+
export declare const MessagesValidateEmail401: typeof UnauthorizedError;
|
|
1080
|
+
export type MessagesValidateEmail403 = ForbiddenError;
|
|
1081
|
+
export declare const MessagesValidateEmail403: typeof ForbiddenError;
|
|
1082
|
+
export type MessagesValidateEmail404 = ResourceNotFoundError;
|
|
1083
|
+
export declare const MessagesValidateEmail404: typeof ResourceNotFoundError;
|
|
1084
|
+
export type MessagesValidateEmail422 = ValidationError;
|
|
1085
|
+
export declare const MessagesValidateEmail422: typeof ValidationError;
|
|
1086
|
+
export type MessagesValidateEmail500 = InternalError;
|
|
1087
|
+
export declare const MessagesValidateEmail500: typeof InternalError;
|
|
1088
|
+
export type MessagesValidateEmail503 = SenderNotReadyError;
|
|
1089
|
+
export declare const MessagesValidateEmail503: typeof SenderNotReadyError;
|
|
1090
|
+
export type MessagesValidateEmail504 = GatewayTimeoutError;
|
|
1091
|
+
export declare const MessagesValidateEmail504: typeof GatewayTimeoutError;
|
|
1092
|
+
declare const MessagesGroup_base: HttpApiGroup.HttpApiGroup<"Messages", HttpApiEndpoint.HttpApiEndpoint<"messagesGet", "GET", "/v1/messages/:id", Schema.toCodecStringTree<Schema.Struct<{
|
|
1093
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1094
|
+
}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1095
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1096
|
+
readonly channel: Schema.Literal<"email">;
|
|
1097
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
1098
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
1099
|
+
readonly from: Schema.Union<readonly [Schema.Struct<{
|
|
1100
|
+
readonly address: Schema.String;
|
|
1101
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1102
|
+
}>, Schema.Null]>;
|
|
1103
|
+
readonly to: Schema.$Array<Schema.Struct<{
|
|
1104
|
+
readonly address: Schema.String;
|
|
1105
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
1106
|
+
}>>;
|
|
1107
|
+
readonly cc: Schema.$Array<Schema.Struct<{
|
|
1108
|
+
readonly address: Schema.String;
|
|
1109
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
1110
|
+
}>>;
|
|
1111
|
+
readonly bcc: Schema.$Array<Schema.Struct<{
|
|
1112
|
+
readonly address: Schema.String;
|
|
1113
|
+
readonly contactId: Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>;
|
|
1114
|
+
}>>;
|
|
1115
|
+
readonly replyTo: Schema.$Array<Schema.String>;
|
|
1116
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1117
|
+
readonly conversationId: Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>;
|
|
1118
|
+
readonly inReplyToMessageId: Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>;
|
|
1119
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
1120
|
+
readonly metadata: Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>;
|
|
1121
|
+
readonly isTest: Schema.Boolean;
|
|
1122
|
+
readonly scheduledAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1123
|
+
readonly submission: Schema.Union<readonly [Schema.Struct<{
|
|
1124
|
+
readonly origin: Schema.Union<readonly [Schema.Literal<"direct">, Schema.Literal<"campaign">, Schema.Literal<"scheduled">, Schema.Literal<"mailbox">, Schema.Literal<"forwarding">, Schema.Literal<"journey">]>;
|
|
1125
|
+
readonly transport: Schema.Union<readonly [Schema.Literal<"http">, Schema.Null]>;
|
|
1126
|
+
readonly credential: Schema.Union<readonly [Schema.Union<readonly [Schema.Struct<{
|
|
1127
|
+
readonly kind: Schema.Literal<"api_key">;
|
|
1128
|
+
readonly apiKeyId: Schema.Union<readonly [Schema.brand<Schema.String, "ApiKeyId">, Schema.Null]>;
|
|
1129
|
+
}>, Schema.Struct<{
|
|
1130
|
+
readonly kind: Schema.Literal<"oauth">;
|
|
1131
|
+
readonly clientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1132
|
+
}>, Schema.Struct<{
|
|
1133
|
+
readonly kind: Schema.Literal<"session">;
|
|
1134
|
+
}>]>, Schema.Null]>;
|
|
1135
|
+
readonly userId: Schema.Union<readonly [Schema.brand<Schema.String, "UserId">, Schema.Null]>;
|
|
1136
|
+
readonly client: Schema.Union<readonly [Schema.Struct<{
|
|
1137
|
+
readonly surface: Schema.Union<readonly [Schema.Literal<"typescript-promise">, Schema.Literal<"typescript-effect">, Schema.Literal<"cli">, Schema.Literal<"mcp">]>;
|
|
1138
|
+
readonly version: Schema.String;
|
|
1139
|
+
}>, Schema.Null]>;
|
|
1140
|
+
}>, Schema.Null]>;
|
|
1141
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
1142
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1143
|
+
readonly skippedRecipients: Schema.$Array<Schema.Struct<{
|
|
1144
|
+
readonly address: Schema.String;
|
|
1145
|
+
readonly reason: Schema.Union<readonly [Schema.Literal<"bounce">, Schema.Literal<"complaint">, Schema.Literal<"unsubscribe">, Schema.Literal<"manual">, Schema.Literal<"group-unsubscribe">]>;
|
|
1146
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
|
|
1147
|
+
}>>;
|
|
1148
|
+
readonly createdAt: Schema.String;
|
|
1149
|
+
readonly updatedAt: Schema.String;
|
|
1150
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1151
|
+
readonly _tag: "ForbiddenError";
|
|
1152
|
+
readonly message: string;
|
|
1153
|
+
}, readonly [Schema.Struct<{
|
|
1154
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1155
|
+
readonly message: Schema.String;
|
|
1156
|
+
}>], {
|
|
1157
|
+
readonly _tag: "ForbiddenError";
|
|
1158
|
+
readonly message: string;
|
|
1159
|
+
}>, Schema.Struct<{
|
|
1160
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1161
|
+
readonly message: Schema.String;
|
|
1162
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1163
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1164
|
+
readonly message: string;
|
|
1165
|
+
readonly retryAfterSeconds: number;
|
|
1166
|
+
}, readonly [Schema.Struct<{
|
|
1167
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1168
|
+
readonly message: Schema.String;
|
|
1169
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1170
|
+
}>], {
|
|
1171
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1172
|
+
readonly message: string;
|
|
1173
|
+
readonly retryAfterSeconds: number;
|
|
1174
|
+
}>, Schema.Struct<{
|
|
1175
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1176
|
+
readonly message: Schema.String;
|
|
1177
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1178
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1179
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1180
|
+
readonly resource: string;
|
|
1181
|
+
readonly id: string;
|
|
1182
|
+
readonly message: string;
|
|
1183
|
+
}, readonly [Schema.Struct<{
|
|
1184
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1185
|
+
readonly resource: Schema.String;
|
|
1186
|
+
readonly id: Schema.String;
|
|
1187
|
+
readonly message: Schema.String;
|
|
1188
|
+
}>], {
|
|
1189
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1190
|
+
readonly resource: string;
|
|
1191
|
+
readonly id: string;
|
|
1192
|
+
readonly message: string;
|
|
1193
|
+
}>, Schema.Struct<{
|
|
1194
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1195
|
+
readonly resource: Schema.String;
|
|
1196
|
+
readonly id: Schema.String;
|
|
1197
|
+
readonly message: Schema.String;
|
|
1198
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1199
|
+
readonly _tag: "UnauthorizedError";
|
|
1200
|
+
readonly message: string;
|
|
1201
|
+
}, readonly [Schema.Struct<{
|
|
1202
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1203
|
+
readonly message: Schema.String;
|
|
1204
|
+
}>], {
|
|
1205
|
+
readonly _tag: "UnauthorizedError";
|
|
1206
|
+
readonly message: string;
|
|
1207
|
+
}>, Schema.Struct<{
|
|
1208
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1209
|
+
readonly message: Schema.String;
|
|
1210
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1211
|
+
readonly _tag: "ValidationError";
|
|
1212
|
+
readonly message: string;
|
|
1213
|
+
readonly fields?: {
|
|
1214
|
+
readonly [x: string]: readonly string[];
|
|
1215
|
+
} | null;
|
|
1216
|
+
}, readonly [Schema.Struct<{
|
|
1217
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1218
|
+
readonly message: Schema.String;
|
|
1219
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1220
|
+
}>], {
|
|
1221
|
+
readonly _tag: "ValidationError";
|
|
1222
|
+
readonly message: string;
|
|
1223
|
+
readonly fields?: {
|
|
1224
|
+
readonly [x: string]: readonly string[];
|
|
1225
|
+
} | null;
|
|
1226
|
+
}>, Schema.Struct<{
|
|
1227
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1228
|
+
readonly message: Schema.String;
|
|
1229
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1230
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesGetContent", "GET", "/v1/messages/:id/content", Schema.toCodecStringTree<Schema.Struct<{
|
|
1231
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1232
|
+
}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1233
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1234
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1235
|
+
readonly markdown: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1236
|
+
readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
1237
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1238
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1239
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1240
|
+
readonly headers: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.String>, Schema.Null]>>;
|
|
1241
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
1242
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
1243
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
1244
|
+
}>>;
|
|
1245
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
1246
|
+
readonly filename: Schema.String;
|
|
1247
|
+
readonly contentId: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1248
|
+
readonly isInline: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
1249
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1250
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
1251
|
+
readonly contentType: Schema.String;
|
|
1252
|
+
readonly size: Schema.Finite;
|
|
1253
|
+
}>>, Schema.Null]>>;
|
|
1254
|
+
}>, Schema.Null]>>;
|
|
1255
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
1256
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1257
|
+
readonly _tag: "ForbiddenError";
|
|
1258
|
+
readonly message: string;
|
|
1259
|
+
}, readonly [Schema.Struct<{
|
|
1260
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1261
|
+
readonly message: Schema.String;
|
|
1262
|
+
}>], {
|
|
1263
|
+
readonly _tag: "ForbiddenError";
|
|
1264
|
+
readonly message: string;
|
|
1265
|
+
}>, Schema.Struct<{
|
|
1266
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1267
|
+
readonly message: Schema.String;
|
|
1268
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1269
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1270
|
+
readonly message: string;
|
|
1271
|
+
readonly retryAfterSeconds: number;
|
|
1272
|
+
}, readonly [Schema.Struct<{
|
|
1273
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1274
|
+
readonly message: Schema.String;
|
|
1275
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1276
|
+
}>], {
|
|
1277
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1278
|
+
readonly message: string;
|
|
1279
|
+
readonly retryAfterSeconds: number;
|
|
1280
|
+
}>, Schema.Struct<{
|
|
1281
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1282
|
+
readonly message: Schema.String;
|
|
1283
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1284
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1285
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1286
|
+
readonly resource: string;
|
|
1287
|
+
readonly id: string;
|
|
1288
|
+
readonly message: string;
|
|
1289
|
+
}, readonly [Schema.Struct<{
|
|
1290
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1291
|
+
readonly resource: Schema.String;
|
|
1292
|
+
readonly id: Schema.String;
|
|
1293
|
+
readonly message: Schema.String;
|
|
1294
|
+
}>], {
|
|
1295
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1296
|
+
readonly resource: string;
|
|
1297
|
+
readonly id: string;
|
|
1298
|
+
readonly message: string;
|
|
1299
|
+
}>, Schema.Struct<{
|
|
1300
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1301
|
+
readonly resource: Schema.String;
|
|
1302
|
+
readonly id: Schema.String;
|
|
1303
|
+
readonly message: Schema.String;
|
|
1304
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1305
|
+
readonly _tag: "UnauthorizedError";
|
|
1306
|
+
readonly message: string;
|
|
1307
|
+
}, readonly [Schema.Struct<{
|
|
1308
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1309
|
+
readonly message: Schema.String;
|
|
1310
|
+
}>], {
|
|
1311
|
+
readonly _tag: "UnauthorizedError";
|
|
1312
|
+
readonly message: string;
|
|
1313
|
+
}>, Schema.Struct<{
|
|
1314
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1315
|
+
readonly message: Schema.String;
|
|
1316
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1317
|
+
readonly _tag: "ValidationError";
|
|
1318
|
+
readonly message: string;
|
|
1319
|
+
readonly fields?: {
|
|
1320
|
+
readonly [x: string]: readonly string[];
|
|
1321
|
+
} | null;
|
|
1322
|
+
}, readonly [Schema.Struct<{
|
|
1323
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1324
|
+
readonly message: Schema.String;
|
|
1325
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1326
|
+
}>], {
|
|
1327
|
+
readonly _tag: "ValidationError";
|
|
1328
|
+
readonly message: string;
|
|
1329
|
+
readonly fields?: {
|
|
1330
|
+
readonly [x: string]: readonly string[];
|
|
1331
|
+
} | null;
|
|
1332
|
+
}>, Schema.Struct<{
|
|
1333
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1334
|
+
readonly message: Schema.String;
|
|
1335
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1336
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesGetEmail", "GET", "/v1/messages/:id/email", Schema.toCodecStringTree<Schema.Struct<{
|
|
1337
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1338
|
+
}>>, Schema.toCodecStringTree<Schema.Struct<{
|
|
1339
|
+
readonly includeDownloadUrls: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1340
|
+
readonly urlExpiresIn: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1341
|
+
}>>, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1342
|
+
readonly deliveries: Schema.$Array<Schema.Struct<{
|
|
1343
|
+
readonly scheduling: Schema.Union<readonly [Schema.Struct<{
|
|
1344
|
+
readonly dueAt: Schema.String;
|
|
1345
|
+
readonly expiresAt: Schema.String;
|
|
1346
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
1347
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1348
|
+
}>, Schema.Null]>;
|
|
1349
|
+
readonly id: Schema.String;
|
|
1350
|
+
readonly messageId: Schema.String;
|
|
1351
|
+
readonly recipientId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1352
|
+
readonly channel: Schema.Literal<"email">;
|
|
1353
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
1354
|
+
readonly attemptCount: Schema.Finite;
|
|
1355
|
+
readonly maxAttempts: Schema.Finite;
|
|
1356
|
+
readonly queuedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1357
|
+
readonly claimedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1358
|
+
readonly lastAttemptAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1359
|
+
readonly nextRetryAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1360
|
+
readonly sentAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1361
|
+
readonly deliveredAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1362
|
+
readonly readAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1363
|
+
readonly failedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1364
|
+
readonly terminalAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1365
|
+
readonly errorCode: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1366
|
+
readonly errorMessage: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1367
|
+
readonly errorDetails: Schema.Union<readonly [Schema.Struct<{
|
|
1368
|
+
readonly code: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1369
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1370
|
+
readonly message: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1371
|
+
readonly details: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.Finite, Schema.Null]>>, Schema.Null]>>;
|
|
1372
|
+
readonly retryable: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
1373
|
+
}>, Schema.Null]>;
|
|
1374
|
+
readonly cost: Schema.String;
|
|
1375
|
+
readonly currency: Schema.String;
|
|
1376
|
+
readonly idempotencyKey: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1377
|
+
readonly createdAt: Schema.String;
|
|
1378
|
+
readonly updatedAt: Schema.String;
|
|
1379
|
+
}>>;
|
|
1380
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1381
|
+
readonly organizationId: Schema.String;
|
|
1382
|
+
readonly conversationId: Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>;
|
|
1383
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
1384
|
+
readonly channel: Schema.Literal<"email">;
|
|
1385
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
1386
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1387
|
+
readonly fromEmail: Schema.String;
|
|
1388
|
+
readonly fromName: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1389
|
+
readonly toEmails: Schema.$Array<Schema.Struct<{
|
|
1390
|
+
readonly email: Schema.String;
|
|
1391
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1392
|
+
}>>;
|
|
1393
|
+
readonly ccEmails: Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
1394
|
+
readonly email: Schema.String;
|
|
1395
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1396
|
+
}>>, Schema.Null]>;
|
|
1397
|
+
readonly bccEmails: Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
1398
|
+
readonly email: Schema.String;
|
|
1399
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1400
|
+
}>>, Schema.Null]>;
|
|
1401
|
+
readonly replyToEmails: Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>;
|
|
1402
|
+
readonly messageIdHeader: Schema.String;
|
|
1403
|
+
readonly inReplyTo: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1404
|
+
readonly references: Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>;
|
|
1405
|
+
readonly threadPosition: Schema.Union<readonly [Schema.Finite, Schema.Null]>;
|
|
1406
|
+
readonly newContent: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1407
|
+
readonly quotedContent: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1408
|
+
readonly hasQuotedContent: Schema.Boolean;
|
|
1409
|
+
readonly dkimVerdict: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pass">, Schema.Literal<"fail">, Schema.Literal<"softfail">, Schema.Literal<"neutral">, Schema.Literal<"none">, Schema.Literal<"policy">, Schema.Literal<"temperror">, Schema.Literal<"permerror">]>, Schema.Null]>;
|
|
1410
|
+
readonly spfVerdict: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pass">, Schema.Literal<"fail">, Schema.Literal<"softfail">, Schema.Literal<"neutral">, Schema.Literal<"none">, Schema.Literal<"policy">, Schema.Literal<"temperror">, Schema.Literal<"permerror">]>, Schema.Null]>;
|
|
1411
|
+
readonly dmarcVerdict: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pass">, Schema.Literal<"fail">, Schema.Literal<"softfail">, Schema.Literal<"neutral">, Schema.Literal<"none">, Schema.Literal<"policy">, Schema.Literal<"temperror">, Schema.Literal<"permerror">]>, Schema.Null]>;
|
|
1412
|
+
readonly isAutoReply: Schema.Boolean;
|
|
1413
|
+
readonly autoReplyReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"out-of-office">, Schema.Literal<"auto-response">, Schema.Literal<"delivery-status">, Schema.Literal<"read-receipt">]>, Schema.Null]>;
|
|
1414
|
+
readonly listUnsubscribeUrl: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1415
|
+
readonly listUnsubscribeEmail: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1416
|
+
readonly priority: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"high">, Schema.Literal<"normal">, Schema.Literal<"low">]>, Schema.Null]>;
|
|
1417
|
+
readonly parsingErrors: Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>;
|
|
1418
|
+
readonly parsingDuration: Schema.Union<readonly [Schema.Finite, Schema.Null]>;
|
|
1419
|
+
readonly hasAttachments: Schema.Boolean;
|
|
1420
|
+
readonly attachmentCount: Schema.Finite;
|
|
1421
|
+
readonly attachments: Schema.$Array<Schema.Struct<{
|
|
1422
|
+
readonly id: Schema.brand<Schema.String, "AttachmentId">;
|
|
1423
|
+
readonly filename: Schema.String;
|
|
1424
|
+
readonly contentType: Schema.String;
|
|
1425
|
+
readonly size: Schema.Finite;
|
|
1426
|
+
readonly isInline: Schema.Boolean;
|
|
1427
|
+
readonly contentId: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1428
|
+
}>>;
|
|
1429
|
+
readonly downloadUrls: Schema.Union<readonly [Schema.Struct<{
|
|
1430
|
+
readonly rawMime: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1431
|
+
readonly html: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1432
|
+
readonly text: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1433
|
+
readonly expiresAt: Schema.String;
|
|
1434
|
+
}>, Schema.Null]>;
|
|
1435
|
+
readonly createdAt: Schema.String;
|
|
1436
|
+
readonly receivedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1437
|
+
readonly processedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1438
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1439
|
+
readonly _tag: "ForbiddenError";
|
|
1440
|
+
readonly message: string;
|
|
1441
|
+
}, readonly [Schema.Struct<{
|
|
1442
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1443
|
+
readonly message: Schema.String;
|
|
1444
|
+
}>], {
|
|
1445
|
+
readonly _tag: "ForbiddenError";
|
|
1446
|
+
readonly message: string;
|
|
1447
|
+
}>, Schema.Struct<{
|
|
1448
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1449
|
+
readonly message: Schema.String;
|
|
1450
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1451
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1452
|
+
readonly message: string;
|
|
1453
|
+
readonly retryAfterSeconds: number;
|
|
1454
|
+
}, readonly [Schema.Struct<{
|
|
1455
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1456
|
+
readonly message: Schema.String;
|
|
1457
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1458
|
+
}>], {
|
|
1459
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1460
|
+
readonly message: string;
|
|
1461
|
+
readonly retryAfterSeconds: number;
|
|
1462
|
+
}>, Schema.Struct<{
|
|
1463
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1464
|
+
readonly message: Schema.String;
|
|
1465
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1466
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1467
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1468
|
+
readonly resource: string;
|
|
1469
|
+
readonly id: string;
|
|
1470
|
+
readonly message: string;
|
|
1471
|
+
}, readonly [Schema.Struct<{
|
|
1472
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1473
|
+
readonly resource: Schema.String;
|
|
1474
|
+
readonly id: Schema.String;
|
|
1475
|
+
readonly message: Schema.String;
|
|
1476
|
+
}>], {
|
|
1477
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1478
|
+
readonly resource: string;
|
|
1479
|
+
readonly id: string;
|
|
1480
|
+
readonly message: string;
|
|
1481
|
+
}>, Schema.Struct<{
|
|
1482
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1483
|
+
readonly resource: Schema.String;
|
|
1484
|
+
readonly id: Schema.String;
|
|
1485
|
+
readonly message: Schema.String;
|
|
1486
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1487
|
+
readonly _tag: "UnauthorizedError";
|
|
1488
|
+
readonly message: string;
|
|
1489
|
+
}, readonly [Schema.Struct<{
|
|
1490
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1491
|
+
readonly message: Schema.String;
|
|
1492
|
+
}>], {
|
|
1493
|
+
readonly _tag: "UnauthorizedError";
|
|
1494
|
+
readonly message: string;
|
|
1495
|
+
}>, Schema.Struct<{
|
|
1496
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1497
|
+
readonly message: Schema.String;
|
|
1498
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1499
|
+
readonly _tag: "ValidationError";
|
|
1500
|
+
readonly message: string;
|
|
1501
|
+
readonly fields?: {
|
|
1502
|
+
readonly [x: string]: readonly string[];
|
|
1503
|
+
} | null;
|
|
1504
|
+
}, readonly [Schema.Struct<{
|
|
1505
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1506
|
+
readonly message: Schema.String;
|
|
1507
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1508
|
+
}>], {
|
|
1509
|
+
readonly _tag: "ValidationError";
|
|
1510
|
+
readonly message: string;
|
|
1511
|
+
readonly fields?: {
|
|
1512
|
+
readonly [x: string]: readonly string[];
|
|
1513
|
+
} | null;
|
|
1514
|
+
}>, Schema.Struct<{
|
|
1515
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1516
|
+
readonly message: Schema.String;
|
|
1517
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1518
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesGetEvents", "GET", "/v1/messages/:id/events", Schema.toCodecStringTree<Schema.Struct<{
|
|
1519
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1520
|
+
}>>, Schema.toCodecStringTree<Schema.Struct<{
|
|
1521
|
+
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1522
|
+
readonly cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1523
|
+
}>>, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1524
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
1525
|
+
readonly id: Schema.brand<Schema.String, "MessageEventId">;
|
|
1526
|
+
readonly messageId: Schema.brand<Schema.String, "MessageId">;
|
|
1527
|
+
readonly eventType: Schema.String;
|
|
1528
|
+
readonly status: Schema.String;
|
|
1529
|
+
readonly timestamp: Schema.String;
|
|
1530
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
1531
|
+
}>>;
|
|
1532
|
+
readonly nextCursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1533
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1534
|
+
readonly _tag: "ForbiddenError";
|
|
1535
|
+
readonly message: string;
|
|
1536
|
+
}, readonly [Schema.Struct<{
|
|
1537
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1538
|
+
readonly message: Schema.String;
|
|
1539
|
+
}>], {
|
|
1540
|
+
readonly _tag: "ForbiddenError";
|
|
1541
|
+
readonly message: string;
|
|
1542
|
+
}>, Schema.Struct<{
|
|
1543
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1544
|
+
readonly message: Schema.String;
|
|
1545
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1546
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1547
|
+
readonly message: string;
|
|
1548
|
+
readonly retryAfterSeconds: number;
|
|
1549
|
+
}, readonly [Schema.Struct<{
|
|
1550
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1551
|
+
readonly message: Schema.String;
|
|
1552
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1553
|
+
}>], {
|
|
1554
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1555
|
+
readonly message: string;
|
|
1556
|
+
readonly retryAfterSeconds: number;
|
|
1557
|
+
}>, Schema.Struct<{
|
|
1558
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1559
|
+
readonly message: Schema.String;
|
|
1560
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1561
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1562
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1563
|
+
readonly resource: string;
|
|
1564
|
+
readonly id: string;
|
|
1565
|
+
readonly message: string;
|
|
1566
|
+
}, readonly [Schema.Struct<{
|
|
1567
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1568
|
+
readonly resource: Schema.String;
|
|
1569
|
+
readonly id: Schema.String;
|
|
1570
|
+
readonly message: Schema.String;
|
|
1571
|
+
}>], {
|
|
1572
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1573
|
+
readonly resource: string;
|
|
1574
|
+
readonly id: string;
|
|
1575
|
+
readonly message: string;
|
|
1576
|
+
}>, Schema.Struct<{
|
|
1577
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1578
|
+
readonly resource: Schema.String;
|
|
1579
|
+
readonly id: Schema.String;
|
|
1580
|
+
readonly message: Schema.String;
|
|
1581
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1582
|
+
readonly _tag: "UnauthorizedError";
|
|
1583
|
+
readonly message: string;
|
|
1584
|
+
}, readonly [Schema.Struct<{
|
|
1585
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1586
|
+
readonly message: Schema.String;
|
|
1587
|
+
}>], {
|
|
1588
|
+
readonly _tag: "UnauthorizedError";
|
|
1589
|
+
readonly message: string;
|
|
1590
|
+
}>, Schema.Struct<{
|
|
1591
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1592
|
+
readonly message: Schema.String;
|
|
1593
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1594
|
+
readonly _tag: "ValidationError";
|
|
1595
|
+
readonly message: string;
|
|
1596
|
+
readonly fields?: {
|
|
1597
|
+
readonly [x: string]: readonly string[];
|
|
1598
|
+
} | null;
|
|
1599
|
+
}, readonly [Schema.Struct<{
|
|
1600
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1601
|
+
readonly message: Schema.String;
|
|
1602
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1603
|
+
}>], {
|
|
1604
|
+
readonly _tag: "ValidationError";
|
|
1605
|
+
readonly message: string;
|
|
1606
|
+
readonly fields?: {
|
|
1607
|
+
readonly [x: string]: readonly string[];
|
|
1608
|
+
} | null;
|
|
1609
|
+
}>, Schema.Struct<{
|
|
1610
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1611
|
+
readonly message: Schema.String;
|
|
1612
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1613
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesGetStatus", "GET", "/v1/messages/:id/status", Schema.toCodecStringTree<Schema.Struct<{
|
|
1614
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1615
|
+
}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1616
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1617
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
1618
|
+
readonly updatedAt: Schema.String;
|
|
1619
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1620
|
+
readonly _tag: "ForbiddenError";
|
|
1621
|
+
readonly message: string;
|
|
1622
|
+
}, readonly [Schema.Struct<{
|
|
1623
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1624
|
+
readonly message: Schema.String;
|
|
1625
|
+
}>], {
|
|
1626
|
+
readonly _tag: "ForbiddenError";
|
|
1627
|
+
readonly message: string;
|
|
1628
|
+
}>, Schema.Struct<{
|
|
1629
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1630
|
+
readonly message: Schema.String;
|
|
1631
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1632
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1633
|
+
readonly message: string;
|
|
1634
|
+
readonly retryAfterSeconds: number;
|
|
1635
|
+
}, readonly [Schema.Struct<{
|
|
1636
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1637
|
+
readonly message: Schema.String;
|
|
1638
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1639
|
+
}>], {
|
|
1640
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1641
|
+
readonly message: string;
|
|
1642
|
+
readonly retryAfterSeconds: number;
|
|
1643
|
+
}>, Schema.Struct<{
|
|
1644
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1645
|
+
readonly message: Schema.String;
|
|
1646
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1647
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1648
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1649
|
+
readonly resource: string;
|
|
1650
|
+
readonly id: string;
|
|
1651
|
+
readonly message: string;
|
|
1652
|
+
}, readonly [Schema.Struct<{
|
|
1653
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1654
|
+
readonly resource: Schema.String;
|
|
1655
|
+
readonly id: Schema.String;
|
|
1656
|
+
readonly message: Schema.String;
|
|
1657
|
+
}>], {
|
|
1658
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1659
|
+
readonly resource: string;
|
|
1660
|
+
readonly id: string;
|
|
1661
|
+
readonly message: string;
|
|
1662
|
+
}>, Schema.Struct<{
|
|
1663
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1664
|
+
readonly resource: Schema.String;
|
|
1665
|
+
readonly id: Schema.String;
|
|
1666
|
+
readonly message: Schema.String;
|
|
1667
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1668
|
+
readonly _tag: "UnauthorizedError";
|
|
1669
|
+
readonly message: string;
|
|
1670
|
+
}, readonly [Schema.Struct<{
|
|
1671
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1672
|
+
readonly message: Schema.String;
|
|
1673
|
+
}>], {
|
|
1674
|
+
readonly _tag: "UnauthorizedError";
|
|
1675
|
+
readonly message: string;
|
|
1676
|
+
}>, Schema.Struct<{
|
|
1677
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1678
|
+
readonly message: Schema.String;
|
|
1679
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1680
|
+
readonly _tag: "ValidationError";
|
|
1681
|
+
readonly message: string;
|
|
1682
|
+
readonly fields?: {
|
|
1683
|
+
readonly [x: string]: readonly string[];
|
|
1684
|
+
} | null;
|
|
1685
|
+
}, readonly [Schema.Struct<{
|
|
1686
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1687
|
+
readonly message: Schema.String;
|
|
1688
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1689
|
+
}>], {
|
|
1690
|
+
readonly _tag: "ValidationError";
|
|
1691
|
+
readonly message: string;
|
|
1692
|
+
readonly fields?: {
|
|
1693
|
+
readonly [x: string]: readonly string[];
|
|
1694
|
+
} | null;
|
|
1695
|
+
}>, Schema.Struct<{
|
|
1696
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1697
|
+
readonly message: Schema.String;
|
|
1698
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1699
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesList", "GET", "/v1/messages", never, Schema.toCodecStringTree<Schema.Struct<{
|
|
1700
|
+
readonly limit: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1701
|
+
readonly cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1702
|
+
readonly channel: Schema.optionalKey<Schema.Union<readonly [Schema.Literal<"email">, Schema.Null]>>;
|
|
1703
|
+
readonly direction: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>, Schema.Null]>>;
|
|
1704
|
+
readonly status: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>, Schema.Null]>>;
|
|
1705
|
+
readonly conversationId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>>;
|
|
1706
|
+
readonly contactId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "ContactId">, Schema.Null]>>;
|
|
1707
|
+
readonly from: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1708
|
+
readonly after: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1709
|
+
readonly before: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1710
|
+
}>>, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1711
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
1712
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1713
|
+
readonly channel: Schema.Literal<"email">;
|
|
1714
|
+
readonly direction: Schema.Union<readonly [Schema.Literal<"outbound">, Schema.Literal<"inbound">]>;
|
|
1715
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
1716
|
+
readonly from: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1717
|
+
readonly to: Schema.$Array<Schema.String>;
|
|
1718
|
+
readonly subject: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1719
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
1720
|
+
readonly createdAt: Schema.String;
|
|
1721
|
+
}>>;
|
|
1722
|
+
readonly nextCursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1723
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1724
|
+
readonly _tag: "ForbiddenError";
|
|
1725
|
+
readonly message: string;
|
|
1726
|
+
}, readonly [Schema.Struct<{
|
|
1727
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1728
|
+
readonly message: Schema.String;
|
|
1729
|
+
}>], {
|
|
1730
|
+
readonly _tag: "ForbiddenError";
|
|
1731
|
+
readonly message: string;
|
|
1732
|
+
}>, Schema.Struct<{
|
|
1733
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1734
|
+
readonly message: Schema.String;
|
|
1735
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1736
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1737
|
+
readonly message: string;
|
|
1738
|
+
readonly retryAfterSeconds: number;
|
|
1739
|
+
}, readonly [Schema.Struct<{
|
|
1740
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1741
|
+
readonly message: Schema.String;
|
|
1742
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1743
|
+
}>], {
|
|
1744
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1745
|
+
readonly message: string;
|
|
1746
|
+
readonly retryAfterSeconds: number;
|
|
1747
|
+
}>, Schema.Struct<{
|
|
1748
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1749
|
+
readonly message: Schema.String;
|
|
1750
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1751
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1752
|
+
readonly _tag: "UnauthorizedError";
|
|
1753
|
+
readonly message: string;
|
|
1754
|
+
}, readonly [Schema.Struct<{
|
|
1755
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1756
|
+
readonly message: Schema.String;
|
|
1757
|
+
}>], {
|
|
1758
|
+
readonly _tag: "UnauthorizedError";
|
|
1759
|
+
readonly message: string;
|
|
1760
|
+
}>, Schema.Struct<{
|
|
1761
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1762
|
+
readonly message: Schema.String;
|
|
1763
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1764
|
+
readonly _tag: "ValidationError";
|
|
1765
|
+
readonly message: string;
|
|
1766
|
+
readonly fields?: {
|
|
1767
|
+
readonly [x: string]: readonly string[];
|
|
1768
|
+
} | null;
|
|
1769
|
+
}, readonly [Schema.Struct<{
|
|
1770
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1771
|
+
readonly message: Schema.String;
|
|
1772
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1773
|
+
}>], {
|
|
1774
|
+
readonly _tag: "ValidationError";
|
|
1775
|
+
readonly message: string;
|
|
1776
|
+
readonly fields?: {
|
|
1777
|
+
readonly [x: string]: readonly string[];
|
|
1778
|
+
} | null;
|
|
1779
|
+
}>, Schema.Struct<{
|
|
1780
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1781
|
+
readonly message: Schema.String;
|
|
1782
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1783
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesListDeliveries", "GET", "/v1/messages/:id/deliveries", Schema.toCodecStringTree<Schema.Struct<{
|
|
1784
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1785
|
+
}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1786
|
+
readonly items: Schema.$Array<Schema.Struct<{
|
|
1787
|
+
readonly id: Schema.brand<Schema.String, "MessageDeliveryId">;
|
|
1788
|
+
readonly recipient: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1789
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
1790
|
+
readonly attemptCount: Schema.Finite;
|
|
1791
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
1792
|
+
readonly nextRetryAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1793
|
+
readonly sentAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1794
|
+
readonly deliveredAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1795
|
+
readonly readAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1796
|
+
readonly failedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1797
|
+
readonly error: Schema.Union<readonly [Schema.Struct<{
|
|
1798
|
+
readonly code: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1799
|
+
readonly message: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
1800
|
+
readonly retryable: Schema.Union<readonly [Schema.Boolean, Schema.Null]>;
|
|
1801
|
+
}>, Schema.Null]>;
|
|
1802
|
+
readonly createdAt: Schema.String;
|
|
1803
|
+
readonly updatedAt: Schema.String;
|
|
1804
|
+
}>>;
|
|
1805
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1806
|
+
readonly _tag: "ForbiddenError";
|
|
1807
|
+
readonly message: string;
|
|
1808
|
+
}, readonly [Schema.Struct<{
|
|
1809
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1810
|
+
readonly message: Schema.String;
|
|
1811
|
+
}>], {
|
|
1812
|
+
readonly _tag: "ForbiddenError";
|
|
1813
|
+
readonly message: string;
|
|
1814
|
+
}>, Schema.Struct<{
|
|
1815
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1816
|
+
readonly message: Schema.String;
|
|
1817
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1818
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1819
|
+
readonly message: string;
|
|
1820
|
+
readonly retryAfterSeconds: number;
|
|
1821
|
+
}, readonly [Schema.Struct<{
|
|
1822
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1823
|
+
readonly message: Schema.String;
|
|
1824
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1825
|
+
}>], {
|
|
1826
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1827
|
+
readonly message: string;
|
|
1828
|
+
readonly retryAfterSeconds: number;
|
|
1829
|
+
}>, Schema.Struct<{
|
|
1830
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1831
|
+
readonly message: Schema.String;
|
|
1832
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1833
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1834
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1835
|
+
readonly resource: string;
|
|
1836
|
+
readonly id: string;
|
|
1837
|
+
readonly message: string;
|
|
1838
|
+
}, readonly [Schema.Struct<{
|
|
1839
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1840
|
+
readonly resource: Schema.String;
|
|
1841
|
+
readonly id: Schema.String;
|
|
1842
|
+
readonly message: Schema.String;
|
|
1843
|
+
}>], {
|
|
1844
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1845
|
+
readonly resource: string;
|
|
1846
|
+
readonly id: string;
|
|
1847
|
+
readonly message: string;
|
|
1848
|
+
}>, Schema.Struct<{
|
|
1849
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1850
|
+
readonly resource: Schema.String;
|
|
1851
|
+
readonly id: Schema.String;
|
|
1852
|
+
readonly message: Schema.String;
|
|
1853
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1854
|
+
readonly _tag: "UnauthorizedError";
|
|
1855
|
+
readonly message: string;
|
|
1856
|
+
}, readonly [Schema.Struct<{
|
|
1857
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1858
|
+
readonly message: Schema.String;
|
|
1859
|
+
}>], {
|
|
1860
|
+
readonly _tag: "UnauthorizedError";
|
|
1861
|
+
readonly message: string;
|
|
1862
|
+
}>, Schema.Struct<{
|
|
1863
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1864
|
+
readonly message: Schema.String;
|
|
1865
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1866
|
+
readonly _tag: "ValidationError";
|
|
1867
|
+
readonly message: string;
|
|
1868
|
+
readonly fields?: {
|
|
1869
|
+
readonly [x: string]: readonly string[];
|
|
1870
|
+
} | null;
|
|
1871
|
+
}, readonly [Schema.Struct<{
|
|
1872
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1873
|
+
readonly message: Schema.String;
|
|
1874
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1875
|
+
}>], {
|
|
1876
|
+
readonly _tag: "ValidationError";
|
|
1877
|
+
readonly message: string;
|
|
1878
|
+
readonly fields?: {
|
|
1879
|
+
readonly [x: string]: readonly string[];
|
|
1880
|
+
} | null;
|
|
1881
|
+
}>, Schema.Struct<{
|
|
1882
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1883
|
+
readonly message: Schema.String;
|
|
1884
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1885
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesRemove", "DELETE", "/v1/messages/:id", Schema.toCodecStringTree<Schema.Struct<{
|
|
1886
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
1887
|
+
}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1888
|
+
readonly success: Schema.Boolean;
|
|
1889
|
+
readonly message: Schema.String;
|
|
1890
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<BillingProviderError, {
|
|
1891
|
+
readonly _tag: "BillingProviderError";
|
|
1892
|
+
readonly message: string;
|
|
1893
|
+
}, readonly [Schema.Struct<{
|
|
1894
|
+
readonly _tag: Schema.tag<"BillingProviderError">;
|
|
1895
|
+
readonly message: Schema.String;
|
|
1896
|
+
}>], {
|
|
1897
|
+
readonly _tag: "BillingProviderError";
|
|
1898
|
+
readonly message: string;
|
|
1899
|
+
}>, Schema.Struct<{
|
|
1900
|
+
readonly _tag: Schema.tag<"BillingProviderError">;
|
|
1901
|
+
readonly message: Schema.String;
|
|
1902
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
1903
|
+
readonly _tag: "ForbiddenError";
|
|
1904
|
+
readonly message: string;
|
|
1905
|
+
}, readonly [Schema.Struct<{
|
|
1906
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1907
|
+
readonly message: Schema.String;
|
|
1908
|
+
}>], {
|
|
1909
|
+
readonly _tag: "ForbiddenError";
|
|
1910
|
+
readonly message: string;
|
|
1911
|
+
}>, Schema.Struct<{
|
|
1912
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
1913
|
+
readonly message: Schema.String;
|
|
1914
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
1915
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1916
|
+
readonly message: string;
|
|
1917
|
+
readonly retryAfterSeconds: number;
|
|
1918
|
+
}, readonly [Schema.Struct<{
|
|
1919
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1920
|
+
readonly message: Schema.String;
|
|
1921
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1922
|
+
}>], {
|
|
1923
|
+
readonly _tag: "GatewayTimeoutError";
|
|
1924
|
+
readonly message: string;
|
|
1925
|
+
readonly retryAfterSeconds: number;
|
|
1926
|
+
}>, Schema.Struct<{
|
|
1927
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
1928
|
+
readonly message: Schema.String;
|
|
1929
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
1930
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
1931
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1932
|
+
readonly resource: string;
|
|
1933
|
+
readonly id: string;
|
|
1934
|
+
readonly message: string;
|
|
1935
|
+
}, readonly [Schema.Struct<{
|
|
1936
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1937
|
+
readonly resource: Schema.String;
|
|
1938
|
+
readonly id: Schema.String;
|
|
1939
|
+
readonly message: Schema.String;
|
|
1940
|
+
}>], {
|
|
1941
|
+
readonly _tag: "ResourceNotFoundError";
|
|
1942
|
+
readonly resource: string;
|
|
1943
|
+
readonly id: string;
|
|
1944
|
+
readonly message: string;
|
|
1945
|
+
}>, Schema.Struct<{
|
|
1946
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
1947
|
+
readonly resource: Schema.String;
|
|
1948
|
+
readonly id: Schema.String;
|
|
1949
|
+
readonly message: Schema.String;
|
|
1950
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
1951
|
+
readonly _tag: "UnauthorizedError";
|
|
1952
|
+
readonly message: string;
|
|
1953
|
+
}, readonly [Schema.Struct<{
|
|
1954
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1955
|
+
readonly message: Schema.String;
|
|
1956
|
+
}>], {
|
|
1957
|
+
readonly _tag: "UnauthorizedError";
|
|
1958
|
+
readonly message: string;
|
|
1959
|
+
}>, Schema.Struct<{
|
|
1960
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
1961
|
+
readonly message: Schema.String;
|
|
1962
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
1963
|
+
readonly _tag: "ValidationError";
|
|
1964
|
+
readonly message: string;
|
|
1965
|
+
readonly fields?: {
|
|
1966
|
+
readonly [x: string]: readonly string[];
|
|
1967
|
+
} | null;
|
|
1968
|
+
}, readonly [Schema.Struct<{
|
|
1969
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1970
|
+
readonly message: Schema.String;
|
|
1971
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1972
|
+
}>], {
|
|
1973
|
+
readonly _tag: "ValidationError";
|
|
1974
|
+
readonly message: string;
|
|
1975
|
+
readonly fields?: {
|
|
1976
|
+
readonly [x: string]: readonly string[];
|
|
1977
|
+
} | null;
|
|
1978
|
+
}>, Schema.Struct<{
|
|
1979
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
1980
|
+
readonly message: Schema.String;
|
|
1981
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
1982
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesSend", "POST", "/v1/messages", never, never, Schema.toCodecJson<Schema.Struct<{
|
|
1983
|
+
readonly conversationId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>, Schema.Null]>>;
|
|
1984
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
1985
|
+
readonly channel: Schema.Literal<"email">;
|
|
1986
|
+
readonly to: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1987
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
1988
|
+
}>, Schema.Struct<{
|
|
1989
|
+
readonly email: Schema.String;
|
|
1990
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1991
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
1992
|
+
}>]>>;
|
|
1993
|
+
readonly cc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
1994
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
1995
|
+
}>, Schema.Struct<{
|
|
1996
|
+
readonly email: Schema.String;
|
|
1997
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1998
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
1999
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
2000
|
+
readonly bcc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
2001
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
2002
|
+
}>, Schema.Struct<{
|
|
2003
|
+
readonly email: Schema.String;
|
|
2004
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2005
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
2006
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
2007
|
+
readonly from: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
2008
|
+
readonly email: Schema.String;
|
|
2009
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2010
|
+
}>, Schema.Null]>>;
|
|
2011
|
+
readonly email: Schema.Struct<{
|
|
2012
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2013
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2014
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2015
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
2016
|
+
readonly filename: Schema.String;
|
|
2017
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2018
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
2019
|
+
readonly contentType: Schema.String;
|
|
2020
|
+
readonly size: Schema.Finite;
|
|
2021
|
+
}>>, Schema.Null]>>;
|
|
2022
|
+
readonly publicationId: Schema.optionalKey<Schema.brand<Schema.String, "TemplatePublicationId">>;
|
|
2023
|
+
readonly inputContractId: Schema.optionalKey<Schema.brand<Schema.String, "TemplateInputContractId">>;
|
|
2024
|
+
readonly templateId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "TemplateId">, Schema.Null]>>;
|
|
2025
|
+
readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2026
|
+
readonly templateData: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
2027
|
+
readonly locale: Schema.optionalKey<Schema.String>;
|
|
2028
|
+
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
2029
|
+
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
2030
|
+
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
2031
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>, Schema.Null]>>;
|
|
2032
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
2033
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
2034
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
2035
|
+
}>>;
|
|
2036
|
+
readonly footer: Schema.optionalKey<Schema.Struct<{
|
|
2037
|
+
readonly enabled: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
2038
|
+
}>>;
|
|
2039
|
+
}>;
|
|
2040
|
+
}>>, Schema.toCodecStringTree<Schema.Struct<{
|
|
2041
|
+
readonly "idempotency-key": Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2042
|
+
}>>, Schema.toCodecJson<Schema.Struct<{
|
|
2043
|
+
readonly id: Schema.brand<Schema.String, "MessageId">;
|
|
2044
|
+
readonly status: Schema.Union<readonly [Schema.Literal<"pending">, Schema.Literal<"scheduled">, Schema.Literal<"queued">, Schema.Literal<"processing">, Schema.Literal<"sent">, Schema.Literal<"delivered">, Schema.Literal<"read">, Schema.Literal<"failed">, Schema.Literal<"bounced">, Schema.Literal<"complained">]>;
|
|
2045
|
+
readonly waitReason: Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"rate">, Schema.Literal<"daily-quota">, Schema.Literal<"domain-health">, Schema.Literal<"sending-paused">, Schema.Literal<"upstream-unavailable">, Schema.Literal<"retry">, Schema.Literal<"campaign-paused">, Schema.Literal<"domain-warming">, Schema.Literal<"onboarding-review">, Schema.Literal<"content-review">, Schema.Literal<"screening-unavailable">]>, Schema.Null]>;
|
|
2046
|
+
readonly reviewExpectedAt: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
2047
|
+
readonly skippedRecipients: Schema.$Array<Schema.Struct<{
|
|
2048
|
+
readonly address: Schema.String;
|
|
2049
|
+
readonly reason: Schema.Union<readonly [Schema.Literal<"bounce">, Schema.Literal<"complaint">, Schema.Literal<"unsubscribe">, Schema.Literal<"manual">, Schema.Literal<"group-unsubscribe">]>;
|
|
2050
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
|
|
2051
|
+
}>>;
|
|
2052
|
+
readonly createdAt: Schema.String;
|
|
2053
|
+
}>>, Schema.toCodecJson<Schema.Union<readonly [typeof BillingProviderError, typeof ExternalServiceError]> | Schema.Union<readonly [typeof SenderNotReadyError, typeof DeliveryUnavailableError]> | Schema.Union<readonly [typeof ForbiddenError, typeof OnboardingReviewRequiredError, typeof FlagDisabledError]> | Schema.decodeTo<Schema.declareConstructor<ConflictError, {
|
|
2054
|
+
readonly _tag: "ConflictError";
|
|
2055
|
+
readonly message: string;
|
|
2056
|
+
readonly resource: string;
|
|
2057
|
+
readonly id?: string | null;
|
|
2058
|
+
}, readonly [Schema.Struct<{
|
|
2059
|
+
readonly _tag: Schema.tag<"ConflictError">;
|
|
2060
|
+
readonly message: Schema.String;
|
|
2061
|
+
readonly resource: Schema.String;
|
|
2062
|
+
readonly id: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2063
|
+
}>], {
|
|
2064
|
+
readonly _tag: "ConflictError";
|
|
2065
|
+
readonly message: string;
|
|
2066
|
+
readonly resource: string;
|
|
2067
|
+
readonly id?: string | null;
|
|
2068
|
+
}>, Schema.Struct<{
|
|
2069
|
+
readonly _tag: Schema.tag<"ConflictError">;
|
|
2070
|
+
readonly message: Schema.String;
|
|
2071
|
+
readonly resource: Schema.String;
|
|
2072
|
+
readonly id: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2073
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
2074
|
+
readonly _tag: "GatewayTimeoutError";
|
|
2075
|
+
readonly message: string;
|
|
2076
|
+
readonly retryAfterSeconds: number;
|
|
2077
|
+
}, readonly [Schema.Struct<{
|
|
2078
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
2079
|
+
readonly message: Schema.String;
|
|
2080
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
2081
|
+
}>], {
|
|
2082
|
+
readonly _tag: "GatewayTimeoutError";
|
|
2083
|
+
readonly message: string;
|
|
2084
|
+
readonly retryAfterSeconds: number;
|
|
2085
|
+
}>, Schema.Struct<{
|
|
2086
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
2087
|
+
readonly message: Schema.String;
|
|
2088
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
2089
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<PaymentRequiredError, {
|
|
2090
|
+
readonly _tag: "PaymentRequiredError";
|
|
2091
|
+
readonly message: string;
|
|
2092
|
+
readonly resource: string;
|
|
2093
|
+
readonly currentUsage: number;
|
|
2094
|
+
readonly limit: number;
|
|
2095
|
+
}, readonly [Schema.Struct<{
|
|
2096
|
+
readonly _tag: Schema.tag<"PaymentRequiredError">;
|
|
2097
|
+
readonly message: Schema.String;
|
|
2098
|
+
readonly resource: Schema.String;
|
|
2099
|
+
readonly currentUsage: Schema.Finite;
|
|
2100
|
+
readonly limit: Schema.Finite;
|
|
2101
|
+
}>], {
|
|
2102
|
+
readonly _tag: "PaymentRequiredError";
|
|
2103
|
+
readonly message: string;
|
|
2104
|
+
readonly resource: string;
|
|
2105
|
+
readonly currentUsage: number;
|
|
2106
|
+
readonly limit: number;
|
|
2107
|
+
}>, Schema.Struct<{
|
|
2108
|
+
readonly _tag: Schema.tag<"PaymentRequiredError">;
|
|
2109
|
+
readonly message: Schema.String;
|
|
2110
|
+
readonly resource: Schema.String;
|
|
2111
|
+
readonly currentUsage: Schema.Finite;
|
|
2112
|
+
readonly limit: Schema.Finite;
|
|
2113
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<RateLimitedError, {
|
|
2114
|
+
readonly _tag: "RateLimitedError";
|
|
2115
|
+
readonly message: string;
|
|
2116
|
+
readonly retryAfterSeconds: number;
|
|
2117
|
+
}, readonly [Schema.Struct<{
|
|
2118
|
+
readonly _tag: Schema.tag<"RateLimitedError">;
|
|
2119
|
+
readonly message: Schema.String;
|
|
2120
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
2121
|
+
}>], {
|
|
2122
|
+
readonly _tag: "RateLimitedError";
|
|
2123
|
+
readonly message: string;
|
|
2124
|
+
readonly retryAfterSeconds: number;
|
|
2125
|
+
}>, Schema.Struct<{
|
|
2126
|
+
readonly _tag: Schema.tag<"RateLimitedError">;
|
|
2127
|
+
readonly message: Schema.String;
|
|
2128
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
2129
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
2130
|
+
readonly _tag: "ResourceNotFoundError";
|
|
2131
|
+
readonly resource: string;
|
|
2132
|
+
readonly id: string;
|
|
2133
|
+
readonly message: string;
|
|
2134
|
+
}, readonly [Schema.Struct<{
|
|
2135
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
2136
|
+
readonly resource: Schema.String;
|
|
2137
|
+
readonly id: Schema.String;
|
|
2138
|
+
readonly message: Schema.String;
|
|
2139
|
+
}>], {
|
|
2140
|
+
readonly _tag: "ResourceNotFoundError";
|
|
2141
|
+
readonly resource: string;
|
|
2142
|
+
readonly id: string;
|
|
2143
|
+
readonly message: string;
|
|
2144
|
+
}>, Schema.Struct<{
|
|
2145
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
2146
|
+
readonly resource: Schema.String;
|
|
2147
|
+
readonly id: Schema.String;
|
|
2148
|
+
readonly message: Schema.String;
|
|
2149
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
2150
|
+
readonly _tag: "UnauthorizedError";
|
|
2151
|
+
readonly message: string;
|
|
2152
|
+
}, readonly [Schema.Struct<{
|
|
2153
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
2154
|
+
readonly message: Schema.String;
|
|
2155
|
+
}>], {
|
|
2156
|
+
readonly _tag: "UnauthorizedError";
|
|
2157
|
+
readonly message: string;
|
|
2158
|
+
}>, Schema.Struct<{
|
|
2159
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
2160
|
+
readonly message: Schema.String;
|
|
2161
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
2162
|
+
readonly _tag: "ValidationError";
|
|
2163
|
+
readonly message: string;
|
|
2164
|
+
readonly fields?: {
|
|
2165
|
+
readonly [x: string]: readonly string[];
|
|
2166
|
+
} | null;
|
|
2167
|
+
}, readonly [Schema.Struct<{
|
|
2168
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
2169
|
+
readonly message: Schema.String;
|
|
2170
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
2171
|
+
}>], {
|
|
2172
|
+
readonly _tag: "ValidationError";
|
|
2173
|
+
readonly message: string;
|
|
2174
|
+
readonly fields?: {
|
|
2175
|
+
readonly [x: string]: readonly string[];
|
|
2176
|
+
} | null;
|
|
2177
|
+
}>, Schema.Struct<{
|
|
2178
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
2179
|
+
readonly message: Schema.String;
|
|
2180
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
2181
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never> | HttpApiEndpoint.HttpApiEndpoint<"messagesValidateEmail", "POST", "/v1/messages/validate/email", never, never, Schema.toCodecJson<Schema.Struct<{
|
|
2182
|
+
readonly conversationId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "ConversationId">, Schema.Null]>, Schema.Null]>>;
|
|
2183
|
+
readonly metadata: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
2184
|
+
readonly channel: Schema.Literal<"email">;
|
|
2185
|
+
readonly to: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
2186
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
2187
|
+
}>, Schema.Struct<{
|
|
2188
|
+
readonly email: Schema.String;
|
|
2189
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2190
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
2191
|
+
}>]>>;
|
|
2192
|
+
readonly cc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
2193
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
2194
|
+
}>, Schema.Struct<{
|
|
2195
|
+
readonly email: Schema.String;
|
|
2196
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2197
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
2198
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
2199
|
+
readonly bcc: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
2200
|
+
readonly contactId: Schema.brand<Schema.String, "ContactId">;
|
|
2201
|
+
}>, Schema.Struct<{
|
|
2202
|
+
readonly email: Schema.String;
|
|
2203
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2204
|
+
readonly displayName: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Null]>, Schema.Null]>>;
|
|
2205
|
+
}>]>>, Schema.Null]>, Schema.Null]>>;
|
|
2206
|
+
readonly from: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
|
|
2207
|
+
readonly email: Schema.String;
|
|
2208
|
+
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2209
|
+
}>, Schema.Null]>>;
|
|
2210
|
+
readonly email: Schema.Struct<{
|
|
2211
|
+
readonly subject: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2212
|
+
readonly html: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2213
|
+
readonly text: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2214
|
+
readonly attachments: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Struct<{
|
|
2215
|
+
readonly filename: Schema.String;
|
|
2216
|
+
readonly content: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2217
|
+
readonly mediaId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MediaId">, Schema.Null]>>;
|
|
2218
|
+
readonly contentType: Schema.String;
|
|
2219
|
+
readonly size: Schema.Finite;
|
|
2220
|
+
}>>, Schema.Null]>>;
|
|
2221
|
+
readonly publicationId: Schema.optionalKey<Schema.brand<Schema.String, "TemplatePublicationId">>;
|
|
2222
|
+
readonly inputContractId: Schema.optionalKey<Schema.brand<Schema.String, "TemplateInputContractId">>;
|
|
2223
|
+
readonly templateId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "TemplateId">, Schema.Null]>>;
|
|
2224
|
+
readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
2225
|
+
readonly templateData: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.suspend<Schema.Codec<JsonValue, JsonValue, never, never>>>, Schema.Null]>>;
|
|
2226
|
+
readonly locale: Schema.optionalKey<Schema.String>;
|
|
2227
|
+
readonly timeZone: Schema.optionalKey<Schema.String>;
|
|
2228
|
+
readonly inReplyToMessageId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "MessageId">, Schema.Null]>>;
|
|
2229
|
+
readonly replyTo: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.String>, Schema.Null]>, Schema.Null]>>;
|
|
2230
|
+
readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>, Schema.Null]>>;
|
|
2231
|
+
readonly tracking: Schema.optionalKey<Schema.Struct<{
|
|
2232
|
+
readonly opens: Schema.optionalKey<Schema.Boolean>;
|
|
2233
|
+
readonly clicks: Schema.optionalKey<Schema.Boolean>;
|
|
2234
|
+
}>>;
|
|
2235
|
+
readonly footer: Schema.optionalKey<Schema.Struct<{
|
|
2236
|
+
readonly enabled: Schema.optionalKey<Schema.Union<readonly [Schema.Boolean, Schema.Null]>>;
|
|
2237
|
+
}>>;
|
|
2238
|
+
}>;
|
|
2239
|
+
}>>, never, Schema.toCodecJson<Schema.Struct<{
|
|
2240
|
+
readonly valid: Schema.Literal<true>;
|
|
2241
|
+
readonly from: Schema.Struct<{
|
|
2242
|
+
readonly email: Schema.String;
|
|
2243
|
+
readonly name: Schema.Union<readonly [Schema.String, Schema.Null]>;
|
|
2244
|
+
}>;
|
|
2245
|
+
readonly recipientCount: Schema.Finite;
|
|
2246
|
+
readonly content: Schema.Struct<{
|
|
2247
|
+
readonly source: Schema.Union<readonly [Schema.Literal<"inline">, Schema.Literal<"template">]>;
|
|
2248
|
+
readonly subject: Schema.String;
|
|
2249
|
+
readonly hasHtml: Schema.Boolean;
|
|
2250
|
+
readonly hasText: Schema.Boolean;
|
|
2251
|
+
}>;
|
|
2252
|
+
}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
|
|
2253
|
+
readonly _tag: "ForbiddenError";
|
|
2254
|
+
readonly message: string;
|
|
2255
|
+
}, readonly [Schema.Struct<{
|
|
2256
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
2257
|
+
readonly message: Schema.String;
|
|
2258
|
+
}>], {
|
|
2259
|
+
readonly _tag: "ForbiddenError";
|
|
2260
|
+
readonly message: string;
|
|
2261
|
+
}>, Schema.Struct<{
|
|
2262
|
+
readonly _tag: Schema.tag<"ForbiddenError">;
|
|
2263
|
+
readonly message: Schema.String;
|
|
2264
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
|
|
2265
|
+
readonly _tag: "GatewayTimeoutError";
|
|
2266
|
+
readonly message: string;
|
|
2267
|
+
readonly retryAfterSeconds: number;
|
|
2268
|
+
}, readonly [Schema.Struct<{
|
|
2269
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
2270
|
+
readonly message: Schema.String;
|
|
2271
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
2272
|
+
}>], {
|
|
2273
|
+
readonly _tag: "GatewayTimeoutError";
|
|
2274
|
+
readonly message: string;
|
|
2275
|
+
readonly retryAfterSeconds: number;
|
|
2276
|
+
}>, Schema.Struct<{
|
|
2277
|
+
readonly _tag: Schema.tag<"GatewayTimeoutError">;
|
|
2278
|
+
readonly message: Schema.String;
|
|
2279
|
+
readonly retryAfterSeconds: Schema.Finite;
|
|
2280
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
|
|
2281
|
+
readonly _tag: "ResourceNotFoundError";
|
|
2282
|
+
readonly resource: string;
|
|
2283
|
+
readonly id: string;
|
|
2284
|
+
readonly message: string;
|
|
2285
|
+
}, readonly [Schema.Struct<{
|
|
2286
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
2287
|
+
readonly resource: Schema.String;
|
|
2288
|
+
readonly id: Schema.String;
|
|
2289
|
+
readonly message: Schema.String;
|
|
2290
|
+
}>], {
|
|
2291
|
+
readonly _tag: "ResourceNotFoundError";
|
|
2292
|
+
readonly resource: string;
|
|
2293
|
+
readonly id: string;
|
|
2294
|
+
readonly message: string;
|
|
2295
|
+
}>, Schema.Struct<{
|
|
2296
|
+
readonly _tag: Schema.tag<"ResourceNotFoundError">;
|
|
2297
|
+
readonly resource: Schema.String;
|
|
2298
|
+
readonly id: Schema.String;
|
|
2299
|
+
readonly message: Schema.String;
|
|
2300
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<SenderNotReadyError, {
|
|
2301
|
+
readonly _tag: "SenderNotReadyError";
|
|
2302
|
+
readonly message: string;
|
|
2303
|
+
readonly sender: string;
|
|
2304
|
+
readonly retryAfterSeconds?: number | null;
|
|
2305
|
+
}, readonly [Schema.Struct<{
|
|
2306
|
+
readonly _tag: Schema.tag<"SenderNotReadyError">;
|
|
2307
|
+
readonly message: Schema.String;
|
|
2308
|
+
readonly sender: Schema.String;
|
|
2309
|
+
readonly retryAfterSeconds: Schema.optionalKey<Schema.Union<readonly [Schema.Finite, Schema.Null]>>;
|
|
2310
|
+
}>], {
|
|
2311
|
+
readonly _tag: "SenderNotReadyError";
|
|
2312
|
+
readonly message: string;
|
|
2313
|
+
readonly sender: string;
|
|
2314
|
+
readonly retryAfterSeconds?: number | null;
|
|
2315
|
+
}>, Schema.Struct<{
|
|
2316
|
+
readonly _tag: Schema.tag<"SenderNotReadyError">;
|
|
2317
|
+
readonly message: Schema.String;
|
|
2318
|
+
readonly sender: Schema.String;
|
|
2319
|
+
readonly retryAfterSeconds: Schema.optionalKey<Schema.Union<readonly [Schema.Finite, Schema.Null]>>;
|
|
2320
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
|
|
2321
|
+
readonly _tag: "UnauthorizedError";
|
|
2322
|
+
readonly message: string;
|
|
2323
|
+
}, readonly [Schema.Struct<{
|
|
2324
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
2325
|
+
readonly message: Schema.String;
|
|
2326
|
+
}>], {
|
|
2327
|
+
readonly _tag: "UnauthorizedError";
|
|
2328
|
+
readonly message: string;
|
|
2329
|
+
}>, Schema.Struct<{
|
|
2330
|
+
readonly _tag: Schema.tag<"UnauthorizedError">;
|
|
2331
|
+
readonly message: Schema.String;
|
|
2332
|
+
}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
|
|
2333
|
+
readonly _tag: "ValidationError";
|
|
2334
|
+
readonly message: string;
|
|
2335
|
+
readonly fields?: {
|
|
2336
|
+
readonly [x: string]: readonly string[];
|
|
2337
|
+
} | null;
|
|
2338
|
+
}, readonly [Schema.Struct<{
|
|
2339
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
2340
|
+
readonly message: Schema.String;
|
|
2341
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
2342
|
+
}>], {
|
|
2343
|
+
readonly _tag: "ValidationError";
|
|
2344
|
+
readonly message: string;
|
|
2345
|
+
readonly fields?: {
|
|
2346
|
+
readonly [x: string]: readonly string[];
|
|
2347
|
+
} | null;
|
|
2348
|
+
}>, Schema.Struct<{
|
|
2349
|
+
readonly _tag: Schema.tag<"ValidationError">;
|
|
2350
|
+
readonly message: Schema.String;
|
|
2351
|
+
readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
|
|
2352
|
+
}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never>, false>;
|
|
2353
|
+
export declare class MessagesGroup extends MessagesGroup_base {
|
|
2354
|
+
}
|
|
2355
|
+
export {};
|