samva 0.22.0 → 0.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/effect/analytics.d.ts +6 -41
- package/dist/effect/api-keys.d.ts +8 -236
- package/dist/effect/attachments.d.ts +4 -43
- package/dist/effect/brands.d.ts +6 -155
- package/dist/effect/campaigns.d.ts +12 -868
- package/dist/effect/contact-groups.d.ts +10 -135
- package/dist/effect/contacts.d.ts +21 -727
- package/dist/effect/conversations.d.ts +13 -681
- package/dist/effect/custom-fields.d.ts +4 -44
- package/dist/effect/email.d.ts +61 -1299
- package/dist/effect/events.d.ts +2 -32
- package/dist/effect/extension-installations.d.ts +9 -213
- package/dist/effect/extensions.d.ts +5 -95
- package/dist/effect/feedback.d.ts +1 -4
- package/dist/effect/internal/client.d.ts +5 -1
- package/dist/effect/internal/operation.d.ts +3 -3
- package/dist/effect/internal/send.d.ts +3 -3
- package/dist/effect/journeys.d.ts +167 -1836
- package/dist/effect/mailboxes.d.ts +60 -2362
- package/dist/effect/media.d.ts +5 -66
- package/dist/effect/messages.d.ts +9 -264
- package/dist/effect/namespaces.d.ts +8 -55
- package/dist/effect/operations.d.ts +3 -84
- package/dist/effect/organizations.d.ts +7 -161
- package/dist/effect/scheduled-messages.d.ts +5 -401
- package/dist/effect/subscriptions.d.ts +1 -4
- package/dist/effect/templates.d.ts +34 -1506
- package/dist/effect/unsubscribe-groups.d.ts +9 -70
- package/dist/effect/webhooks.d.ts +11 -141
- package/dist/effect/whoami.d.ts +1 -46
- package/dist/package.js +1 -1
- package/package.json +7 -7
package/dist/effect/email.d.ts
CHANGED
|
@@ -14,62 +14,24 @@ export declare const send: (input: EmailSendInput, options?: SendOptions | undef
|
|
|
14
14
|
}[];
|
|
15
15
|
readonly createdAt: string;
|
|
16
16
|
}, import("./errors").BillingProviderError | import("./errors").ConflictError | import("./errors").DeliveryUnavailableError | import("./errors").ExternalServiceError | import("./errors").FlagDisabledError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("..").MediaUploadError | import("./errors").OnboardingReviewRequiredError | import("./errors").PaymentRequiredError | import("./errors").RateLimitedError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").SenderNotReadyError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
17
|
-
export declare const getTrackingDefaults: (_?: never) => import("
|
|
18
|
-
readonly opens: boolean;
|
|
19
|
-
readonly clicks: boolean;
|
|
20
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
17
|
+
export declare const getTrackingDefaults: (_?: never) => import("./internal/operation").OperationResult<"emailGetTrackingDefaults">;
|
|
21
18
|
export declare const updateTrackingDefaults: (input?: {
|
|
22
19
|
readonly opens?: boolean | undefined;
|
|
23
20
|
readonly clicks?: boolean | undefined;
|
|
24
|
-
} | undefined) => import("
|
|
25
|
-
readonly opens: boolean;
|
|
26
|
-
readonly clicks: boolean;
|
|
27
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
21
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailUpdateTrackingDefaults">;
|
|
28
22
|
export declare const getRecipientTrackingPreference: (input: {
|
|
29
23
|
readonly email: string;
|
|
30
|
-
}) => import("
|
|
31
|
-
readonly email: string;
|
|
32
|
-
readonly optedOut: boolean;
|
|
33
|
-
readonly trackingOptedOutAt: string | null;
|
|
34
|
-
readonly createdAt: string | null;
|
|
35
|
-
readonly updatedAt: string | null;
|
|
36
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
24
|
+
}) => import("./internal/operation").OperationResult<"emailGetRecipientTrackingPreference">;
|
|
37
25
|
export declare const updateRecipientTrackingPreference: (input: {
|
|
38
26
|
readonly email: string;
|
|
39
27
|
readonly optedOut: boolean;
|
|
40
|
-
}) => import("
|
|
41
|
-
readonly email: string;
|
|
42
|
-
readonly optedOut: boolean;
|
|
43
|
-
readonly trackingOptedOutAt: string | null;
|
|
44
|
-
readonly createdAt: string | null;
|
|
45
|
-
readonly updatedAt: string | null;
|
|
46
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
28
|
+
}) => import("./internal/operation").OperationResult<"emailUpdateRecipientTrackingPreference">;
|
|
47
29
|
export declare const listDomains: ((input?: {
|
|
48
30
|
readonly limit?: string | null | undefined;
|
|
49
31
|
readonly cursor?: string | null | undefined;
|
|
50
32
|
readonly sendable?: "true" | null | undefined;
|
|
51
33
|
readonly namespaceId?: string | null | undefined;
|
|
52
|
-
} | undefined) => import("
|
|
53
|
-
readonly items: readonly {
|
|
54
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
55
|
-
readonly domain: string;
|
|
56
|
-
readonly phase: "degraded" | "dns-setup" | "failed" | "provisioning" | "ready" | "verifying";
|
|
57
|
-
readonly dkimSelector?: string | null;
|
|
58
|
-
readonly dkimPublicKey?: string | null;
|
|
59
|
-
readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
|
|
60
|
-
readonly isDefault: boolean;
|
|
61
|
-
readonly deliverability: {
|
|
62
|
-
readonly bounceRate: number;
|
|
63
|
-
readonly complaintRate: number;
|
|
64
|
-
readonly windowSends: number;
|
|
65
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
66
|
-
};
|
|
67
|
-
readonly series: readonly number[];
|
|
68
|
-
readonly createdAt: string;
|
|
69
|
-
readonly updatedAt: string;
|
|
70
|
-
}[];
|
|
71
|
-
readonly nextCursor: string | null;
|
|
72
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
34
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailListDomains">) & {
|
|
73
35
|
readonly pages: (input?: {
|
|
74
36
|
readonly limit?: string | null | undefined;
|
|
75
37
|
readonly cursor?: string | null | undefined;
|
|
@@ -127,324 +89,27 @@ export declare const addDomain: (input: {
|
|
|
127
89
|
readonly zone: string;
|
|
128
90
|
} | null | undefined;
|
|
129
91
|
readonly namespaceId?: string | null | undefined;
|
|
130
|
-
}) => import("
|
|
131
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
132
|
-
readonly domain: string;
|
|
133
|
-
readonly phase: "degraded" | "dns-setup" | "failed" | "provisioning" | "ready" | "verifying";
|
|
134
|
-
readonly dkimSelector?: string | null;
|
|
135
|
-
readonly dkimPublicKey?: string | null;
|
|
136
|
-
readonly dnsRecords: readonly {
|
|
137
|
-
readonly type: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT";
|
|
138
|
-
readonly name: string;
|
|
139
|
-
readonly value: string;
|
|
140
|
-
readonly ttl?: string | null;
|
|
141
|
-
readonly description?: string | null;
|
|
142
|
-
readonly priority?: number | null;
|
|
143
|
-
}[];
|
|
144
|
-
readonly verifiedAt: string | null;
|
|
145
|
-
readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
|
|
146
|
-
readonly isDefault: boolean;
|
|
147
|
-
readonly deliverability: {
|
|
148
|
-
readonly bounceRate: number;
|
|
149
|
-
readonly complaintRate: number;
|
|
150
|
-
readonly windowSends: number;
|
|
151
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
152
|
-
};
|
|
153
|
-
readonly createdAt: string;
|
|
154
|
-
readonly updatedAt: string;
|
|
155
|
-
}, import("./errors").BillingProviderError | import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").PaymentRequiredError | import("./errors").RateLimitedError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
92
|
+
}) => import("./internal/operation").OperationResult<"emailAddDomain">;
|
|
156
93
|
export declare const rotateDomainDkim: (input: {
|
|
157
94
|
readonly id: string;
|
|
158
95
|
} & {
|
|
159
96
|
readonly idempotencyKey: string;
|
|
160
|
-
}) => import("
|
|
161
|
-
readonly id: string;
|
|
162
|
-
readonly domainId: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
163
|
-
readonly phase: "complete" | "cutover" | "staged";
|
|
164
|
-
readonly selector: string;
|
|
165
|
-
readonly record: {
|
|
166
|
-
readonly name: string;
|
|
167
|
-
readonly type: "TXT";
|
|
168
|
-
readonly value: string;
|
|
169
|
-
readonly ttl: string;
|
|
170
|
-
};
|
|
171
|
-
readonly formerRecord: {
|
|
172
|
-
readonly name: string;
|
|
173
|
-
readonly type: "TXT";
|
|
174
|
-
readonly value: string;
|
|
175
|
-
};
|
|
176
|
-
readonly minimumRetainUntil: string | null;
|
|
177
|
-
}, import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
97
|
+
}) => import("./internal/operation").OperationResult<"emailRotateDomainDkim">;
|
|
178
98
|
export declare const getDomainVerification: (input: {
|
|
179
99
|
readonly id: string;
|
|
180
|
-
}) => import("
|
|
181
|
-
readonly domainId: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
182
|
-
readonly domain: string;
|
|
183
|
-
readonly phase: "degraded" | "dns-setup" | "failed" | "provisioning" | "ready" | "verifying";
|
|
184
|
-
readonly dns: {
|
|
185
|
-
readonly observed: boolean;
|
|
186
|
-
readonly total: number;
|
|
187
|
-
readonly satisfied: number;
|
|
188
|
-
readonly missing: number;
|
|
189
|
-
readonly mismatch: number;
|
|
190
|
-
readonly unknown: number;
|
|
191
|
-
};
|
|
192
|
-
readonly requirements: readonly {
|
|
193
|
-
readonly key: string;
|
|
194
|
-
readonly record: {
|
|
195
|
-
readonly type: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT";
|
|
196
|
-
readonly name: string;
|
|
197
|
-
readonly value: string;
|
|
198
|
-
readonly ttl?: string | null;
|
|
199
|
-
readonly description?: string | null;
|
|
200
|
-
readonly priority?: number | null;
|
|
201
|
-
};
|
|
202
|
-
readonly status: "mismatch" | "missing" | "satisfied" | "unknown";
|
|
203
|
-
readonly evidence: readonly ({
|
|
204
|
-
readonly _tag: "PublicDns";
|
|
205
|
-
readonly resolver: string;
|
|
206
|
-
readonly status: "mismatch" | "missing" | "satisfied" | "unknown";
|
|
207
|
-
readonly values: readonly string[];
|
|
208
|
-
readonly detail: string | null;
|
|
209
|
-
readonly observedAt: string;
|
|
210
|
-
} | {
|
|
211
|
-
readonly _tag: "Provider";
|
|
212
|
-
readonly provider: string;
|
|
213
|
-
readonly status: "mismatch" | "missing" | "satisfied" | "unknown";
|
|
214
|
-
readonly values: readonly string[];
|
|
215
|
-
readonly detail: string | null;
|
|
216
|
-
readonly observedAt: string;
|
|
217
|
-
} | {
|
|
218
|
-
readonly _tag: "Host";
|
|
219
|
-
readonly source: string;
|
|
220
|
-
readonly status: "failed" | "ok" | "pending";
|
|
221
|
-
readonly label: string;
|
|
222
|
-
readonly detail: string | null;
|
|
223
|
-
readonly observedAt: string;
|
|
224
|
-
})[];
|
|
225
|
-
}[];
|
|
226
|
-
readonly provider: {
|
|
227
|
-
readonly identity: "failed" | "pending" | "unknown" | "verified";
|
|
228
|
-
readonly dkim?: "failed" | "pending" | "unknown" | "verified" | null;
|
|
229
|
-
readonly mailFrom?: "failed" | "pending" | "unknown" | "verified" | null;
|
|
230
|
-
} | null;
|
|
231
|
-
readonly operationId: (string & import("effect/Brand").Brand<"OperationId">) | null;
|
|
232
|
-
readonly checkedAt: string | null;
|
|
233
|
-
readonly nextCheckAt: string | null;
|
|
234
|
-
readonly failure: {
|
|
235
|
-
readonly code: string;
|
|
236
|
-
readonly message: string;
|
|
237
|
-
readonly failedAt: string;
|
|
238
|
-
} | null;
|
|
239
|
-
readonly provisioning: {
|
|
240
|
-
readonly status: "failed" | "none" | "running" | "succeeded";
|
|
241
|
-
readonly generation: number;
|
|
242
|
-
readonly revision: number;
|
|
243
|
-
};
|
|
244
|
-
readonly health: {
|
|
245
|
-
readonly actionOwner: "customer" | "none" | "samva" | "upstream";
|
|
246
|
-
readonly action: string;
|
|
247
|
-
readonly freshness: "current" | "stale" | "unknown";
|
|
248
|
-
readonly observedAt: string | null;
|
|
249
|
-
readonly staleAt: string | null;
|
|
250
|
-
readonly nextRetryAt: string | null;
|
|
251
|
-
readonly reason: "dns-action-required" | "dns-unavailable" | "inactive" | "observation-stale" | "observation-unknown" | "ownership-conflict" | "ready" | "samva-repair" | "signing-custody-action-required" | "verification-failed" | "verification-pending";
|
|
252
|
-
};
|
|
253
|
-
readonly sending: {
|
|
254
|
-
readonly actionOwner: "customer" | "none" | "samva" | "upstream";
|
|
255
|
-
readonly action: string;
|
|
256
|
-
readonly freshness: "current" | "stale" | "unknown";
|
|
257
|
-
readonly observedAt: string | null;
|
|
258
|
-
readonly staleAt: string | null;
|
|
259
|
-
readonly nextRetryAt: string | null;
|
|
260
|
-
readonly status: "blocked" | "ready" | "unknown";
|
|
261
|
-
readonly reason: "domain-not-ready" | "domain-observation-stale" | "operator-paused" | "ready" | "sending-paused" | "sending-status-unknown";
|
|
262
|
-
};
|
|
263
|
-
readonly dmarc: {
|
|
264
|
-
readonly status: "invalid" | "missing" | "multiple" | "unknown" | "valid";
|
|
265
|
-
readonly source: "direct" | "none" | "organizational";
|
|
266
|
-
readonly policyDomain: string | null;
|
|
267
|
-
readonly policy: "none" | "quarantine" | "reject" | null;
|
|
268
|
-
readonly subdomainPolicy: "none" | "quarantine" | "reject" | null;
|
|
269
|
-
readonly effectivePolicy: "none" | "quarantine" | "reject" | null;
|
|
270
|
-
readonly observedAt: string | null;
|
|
271
|
-
readonly staleAt: string | null;
|
|
272
|
-
readonly guidance: string;
|
|
273
|
-
};
|
|
274
|
-
readonly rotation: {
|
|
275
|
-
readonly id: string;
|
|
276
|
-
readonly domainId: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
277
|
-
readonly phase: "complete" | "cutover" | "staged";
|
|
278
|
-
readonly selector: string;
|
|
279
|
-
readonly record: {
|
|
280
|
-
readonly name: string;
|
|
281
|
-
readonly type: "TXT";
|
|
282
|
-
readonly value: string;
|
|
283
|
-
readonly ttl: string;
|
|
284
|
-
};
|
|
285
|
-
readonly formerRecord: {
|
|
286
|
-
readonly name: string;
|
|
287
|
-
readonly type: "TXT";
|
|
288
|
-
readonly value: string;
|
|
289
|
-
};
|
|
290
|
-
readonly minimumRetainUntil: string | null;
|
|
291
|
-
} | null;
|
|
292
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
100
|
+
}) => import("./internal/operation").OperationResult<"emailGetDomainVerification">;
|
|
293
101
|
export declare const advanceDomainVerification: (input: {
|
|
294
102
|
readonly id: string;
|
|
295
|
-
}) => import("
|
|
296
|
-
readonly domainId: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
297
|
-
readonly domain: string;
|
|
298
|
-
readonly phase: "degraded" | "dns-setup" | "failed" | "provisioning" | "ready" | "verifying";
|
|
299
|
-
readonly dns: {
|
|
300
|
-
readonly observed: boolean;
|
|
301
|
-
readonly total: number;
|
|
302
|
-
readonly satisfied: number;
|
|
303
|
-
readonly missing: number;
|
|
304
|
-
readonly mismatch: number;
|
|
305
|
-
readonly unknown: number;
|
|
306
|
-
};
|
|
307
|
-
readonly requirements: readonly {
|
|
308
|
-
readonly key: string;
|
|
309
|
-
readonly record: {
|
|
310
|
-
readonly type: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT";
|
|
311
|
-
readonly name: string;
|
|
312
|
-
readonly value: string;
|
|
313
|
-
readonly ttl?: string | null;
|
|
314
|
-
readonly description?: string | null;
|
|
315
|
-
readonly priority?: number | null;
|
|
316
|
-
};
|
|
317
|
-
readonly status: "mismatch" | "missing" | "satisfied" | "unknown";
|
|
318
|
-
readonly evidence: readonly ({
|
|
319
|
-
readonly _tag: "PublicDns";
|
|
320
|
-
readonly resolver: string;
|
|
321
|
-
readonly status: "mismatch" | "missing" | "satisfied" | "unknown";
|
|
322
|
-
readonly values: readonly string[];
|
|
323
|
-
readonly detail: string | null;
|
|
324
|
-
readonly observedAt: string;
|
|
325
|
-
} | {
|
|
326
|
-
readonly _tag: "Provider";
|
|
327
|
-
readonly provider: string;
|
|
328
|
-
readonly status: "mismatch" | "missing" | "satisfied" | "unknown";
|
|
329
|
-
readonly values: readonly string[];
|
|
330
|
-
readonly detail: string | null;
|
|
331
|
-
readonly observedAt: string;
|
|
332
|
-
} | {
|
|
333
|
-
readonly _tag: "Host";
|
|
334
|
-
readonly source: string;
|
|
335
|
-
readonly status: "failed" | "ok" | "pending";
|
|
336
|
-
readonly label: string;
|
|
337
|
-
readonly detail: string | null;
|
|
338
|
-
readonly observedAt: string;
|
|
339
|
-
})[];
|
|
340
|
-
}[];
|
|
341
|
-
readonly provider: {
|
|
342
|
-
readonly identity: "failed" | "pending" | "unknown" | "verified";
|
|
343
|
-
readonly dkim?: "failed" | "pending" | "unknown" | "verified" | null;
|
|
344
|
-
readonly mailFrom?: "failed" | "pending" | "unknown" | "verified" | null;
|
|
345
|
-
} | null;
|
|
346
|
-
readonly operationId: (string & import("effect/Brand").Brand<"OperationId">) | null;
|
|
347
|
-
readonly checkedAt: string | null;
|
|
348
|
-
readonly nextCheckAt: string | null;
|
|
349
|
-
readonly failure: {
|
|
350
|
-
readonly code: string;
|
|
351
|
-
readonly message: string;
|
|
352
|
-
readonly failedAt: string;
|
|
353
|
-
} | null;
|
|
354
|
-
readonly provisioning: {
|
|
355
|
-
readonly status: "failed" | "none" | "running" | "succeeded";
|
|
356
|
-
readonly generation: number;
|
|
357
|
-
readonly revision: number;
|
|
358
|
-
};
|
|
359
|
-
readonly health: {
|
|
360
|
-
readonly actionOwner: "customer" | "none" | "samva" | "upstream";
|
|
361
|
-
readonly action: string;
|
|
362
|
-
readonly freshness: "current" | "stale" | "unknown";
|
|
363
|
-
readonly observedAt: string | null;
|
|
364
|
-
readonly staleAt: string | null;
|
|
365
|
-
readonly nextRetryAt: string | null;
|
|
366
|
-
readonly reason: "dns-action-required" | "dns-unavailable" | "inactive" | "observation-stale" | "observation-unknown" | "ownership-conflict" | "ready" | "samva-repair" | "signing-custody-action-required" | "verification-failed" | "verification-pending";
|
|
367
|
-
};
|
|
368
|
-
readonly sending: {
|
|
369
|
-
readonly actionOwner: "customer" | "none" | "samva" | "upstream";
|
|
370
|
-
readonly action: string;
|
|
371
|
-
readonly freshness: "current" | "stale" | "unknown";
|
|
372
|
-
readonly observedAt: string | null;
|
|
373
|
-
readonly staleAt: string | null;
|
|
374
|
-
readonly nextRetryAt: string | null;
|
|
375
|
-
readonly status: "blocked" | "ready" | "unknown";
|
|
376
|
-
readonly reason: "domain-not-ready" | "domain-observation-stale" | "operator-paused" | "ready" | "sending-paused" | "sending-status-unknown";
|
|
377
|
-
};
|
|
378
|
-
readonly dmarc: {
|
|
379
|
-
readonly status: "invalid" | "missing" | "multiple" | "unknown" | "valid";
|
|
380
|
-
readonly source: "direct" | "none" | "organizational";
|
|
381
|
-
readonly policyDomain: string | null;
|
|
382
|
-
readonly policy: "none" | "quarantine" | "reject" | null;
|
|
383
|
-
readonly subdomainPolicy: "none" | "quarantine" | "reject" | null;
|
|
384
|
-
readonly effectivePolicy: "none" | "quarantine" | "reject" | null;
|
|
385
|
-
readonly observedAt: string | null;
|
|
386
|
-
readonly staleAt: string | null;
|
|
387
|
-
readonly guidance: string;
|
|
388
|
-
};
|
|
389
|
-
readonly rotation: {
|
|
390
|
-
readonly id: string;
|
|
391
|
-
readonly domainId: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
392
|
-
readonly phase: "complete" | "cutover" | "staged";
|
|
393
|
-
readonly selector: string;
|
|
394
|
-
readonly record: {
|
|
395
|
-
readonly name: string;
|
|
396
|
-
readonly type: "TXT";
|
|
397
|
-
readonly value: string;
|
|
398
|
-
readonly ttl: string;
|
|
399
|
-
};
|
|
400
|
-
readonly formerRecord: {
|
|
401
|
-
readonly name: string;
|
|
402
|
-
readonly type: "TXT";
|
|
403
|
-
readonly value: string;
|
|
404
|
-
};
|
|
405
|
-
readonly minimumRetainUntil: string | null;
|
|
406
|
-
} | null;
|
|
407
|
-
}, import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").RateLimitedError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
103
|
+
}) => import("./internal/operation").OperationResult<"emailAdvanceDomainVerification">;
|
|
408
104
|
export declare const getDomainById: (input: {
|
|
409
105
|
readonly id: string;
|
|
410
|
-
}) => import("
|
|
411
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
412
|
-
readonly domain: string;
|
|
413
|
-
readonly phase: "degraded" | "dns-setup" | "failed" | "provisioning" | "ready" | "verifying";
|
|
414
|
-
readonly dkimSelector?: string | null;
|
|
415
|
-
readonly dkimPublicKey?: string | null;
|
|
416
|
-
readonly dnsRecords: readonly {
|
|
417
|
-
readonly type: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT";
|
|
418
|
-
readonly name: string;
|
|
419
|
-
readonly value: string;
|
|
420
|
-
readonly ttl?: string | null;
|
|
421
|
-
readonly description?: string | null;
|
|
422
|
-
readonly priority?: number | null;
|
|
423
|
-
}[];
|
|
424
|
-
readonly verifiedAt: string | null;
|
|
425
|
-
readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
|
|
426
|
-
readonly isDefault: boolean;
|
|
427
|
-
readonly deliverability: {
|
|
428
|
-
readonly bounceRate: number;
|
|
429
|
-
readonly complaintRate: number;
|
|
430
|
-
readonly windowSends: number;
|
|
431
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
432
|
-
};
|
|
433
|
-
readonly createdAt: string;
|
|
434
|
-
readonly updatedAt: string;
|
|
435
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
106
|
+
}) => import("./internal/operation").OperationResult<"emailGetDomainById">;
|
|
436
107
|
export declare const removeDomain: (input: {
|
|
437
108
|
readonly id: string;
|
|
438
|
-
}) => import("
|
|
439
|
-
readonly success: boolean;
|
|
440
|
-
readonly message: string;
|
|
441
|
-
}, import("./errors").BillingProviderError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
109
|
+
}) => import("./internal/operation").OperationResult<"emailRemoveDomain">;
|
|
442
110
|
export declare const setDefaultDomain: (input: {
|
|
443
111
|
readonly id: string;
|
|
444
|
-
}) => import("
|
|
445
|
-
readonly success: boolean;
|
|
446
|
-
readonly message: string;
|
|
447
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
112
|
+
}) => import("./internal/operation").OperationResult<"emailSetDefaultDomain">;
|
|
448
113
|
export declare const updateDomainConfig: (input: {
|
|
449
114
|
readonly id: string;
|
|
450
115
|
readonly openTracking?: boolean | null | undefined;
|
|
@@ -453,782 +118,101 @@ export declare const updateDomainConfig: (input: {
|
|
|
453
118
|
readonly unsubscribeGroupId?: string | null | undefined;
|
|
454
119
|
readonly footerEnabled?: boolean | null | undefined;
|
|
455
120
|
readonly brandSlug?: string | null | undefined;
|
|
456
|
-
}) => import("
|
|
457
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
458
|
-
readonly openTracking: boolean | null;
|
|
459
|
-
readonly clickTracking: boolean | null;
|
|
460
|
-
readonly replyTo: readonly string[] | null;
|
|
461
|
-
readonly unsubscribeGroupId: (string & import("effect/Brand").Brand<"UnsubscribeId">) | null;
|
|
462
|
-
readonly footerEnabled: boolean | null;
|
|
463
|
-
readonly brandSlug: string | null;
|
|
464
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
121
|
+
}) => import("./internal/operation").OperationResult<"emailUpdateDomainConfig">;
|
|
465
122
|
export declare const detectRegistrar: (input: {
|
|
466
123
|
readonly id: string;
|
|
467
124
|
readonly domain: string;
|
|
468
|
-
}) => import("
|
|
469
|
-
readonly provider: string;
|
|
470
|
-
readonly name: string;
|
|
471
|
-
readonly nameservers: readonly string[];
|
|
472
|
-
readonly docsUrl: string;
|
|
473
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
125
|
+
}) => import("./internal/operation").OperationResult<"emailDetectRegistrar">;
|
|
474
126
|
export declare const getDomainConnect: (input: {
|
|
475
127
|
readonly id: string;
|
|
476
128
|
readonly mode: "send-and-receive" | "send-only";
|
|
477
|
-
}) => import("
|
|
478
|
-
readonly eligible: false;
|
|
479
|
-
readonly reason: "no-record" | "no-settings" | "no-sync" | "no-template" | "unavailable";
|
|
480
|
-
} | {
|
|
481
|
-
readonly eligible: true;
|
|
482
|
-
readonly providerName?: string | null;
|
|
483
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
129
|
+
}) => import("./internal/operation").OperationResult<"emailGetDomainConnect">;
|
|
484
130
|
export declare const buildDomainConnectApplyUrl: (input: {
|
|
485
131
|
readonly id: string;
|
|
486
132
|
readonly mode: "send-and-receive" | "send-only";
|
|
487
|
-
}) => import("
|
|
488
|
-
readonly url: string;
|
|
489
|
-
}, import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
133
|
+
}) => import("./internal/operation").OperationResult<"emailBuildDomainConnectApplyUrl">;
|
|
490
134
|
export declare const completeDomainConnect: (input: {
|
|
491
135
|
readonly id: string;
|
|
492
136
|
readonly state: string;
|
|
493
137
|
readonly error?: string | null | undefined;
|
|
494
138
|
readonly errorDescription?: string | null | undefined;
|
|
495
|
-
}) => import("
|
|
496
|
-
readonly status: "applied" | "cancelled" | "failed" | "invalid";
|
|
497
|
-
}, import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
139
|
+
}) => import("./internal/operation").OperationResult<"emailCompleteDomainConnect">;
|
|
498
140
|
export declare const enableReceiving: (input: {
|
|
499
141
|
readonly id: string;
|
|
500
142
|
readonly domain: string;
|
|
501
143
|
readonly catchAll?: boolean | null | undefined;
|
|
502
144
|
readonly endpointId?: string | null | undefined;
|
|
503
145
|
readonly addresses?: readonly string[] | null | undefined;
|
|
504
|
-
}) => import("
|
|
505
|
-
readonly success: true;
|
|
506
|
-
readonly recipients: readonly string[];
|
|
507
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
146
|
+
}) => import("./internal/operation").OperationResult<"emailEnableReceiving">;
|
|
508
147
|
export declare const getReceivingStatus: (input: {
|
|
509
148
|
readonly id: string;
|
|
510
|
-
}) => import("
|
|
511
|
-
readonly domain: string;
|
|
512
|
-
readonly receivingHost: string;
|
|
513
|
-
readonly sending: {
|
|
514
|
-
readonly satisfied: boolean;
|
|
515
|
-
readonly phase: "degraded" | "dns-setup" | "failed" | "provisioning" | "ready" | "verifying";
|
|
516
|
-
};
|
|
517
|
-
readonly destination: {
|
|
518
|
-
readonly satisfied: boolean;
|
|
519
|
-
readonly endpointId: (string & import("effect/Brand").Brand<"WebhookEndpointId">) | null;
|
|
520
|
-
readonly forwardingRules: number;
|
|
521
|
-
readonly mailboxes: number;
|
|
522
|
-
};
|
|
523
|
-
readonly receiving: {
|
|
524
|
-
readonly satisfied: boolean;
|
|
525
|
-
readonly catchAll: boolean;
|
|
526
|
-
};
|
|
527
|
-
readonly mx: {
|
|
528
|
-
readonly satisfied: boolean;
|
|
529
|
-
readonly state: "elsewhere" | "missing" | "pointing-here" | "unknown";
|
|
530
|
-
readonly expected: {
|
|
531
|
-
readonly exchange: string;
|
|
532
|
-
readonly priority: number;
|
|
533
|
-
};
|
|
534
|
-
readonly current: readonly {
|
|
535
|
-
readonly exchange: string;
|
|
536
|
-
readonly priority: number;
|
|
537
|
-
}[];
|
|
538
|
-
};
|
|
539
|
-
readonly ready: boolean;
|
|
540
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
149
|
+
}) => import("./internal/operation").OperationResult<"emailGetReceivingStatus">;
|
|
541
150
|
export declare const enableCustomTracking: (input: {
|
|
542
151
|
readonly id: string;
|
|
543
152
|
readonly label?: string | null | undefined;
|
|
544
|
-
}) => import("
|
|
545
|
-
readonly enabled: boolean;
|
|
546
|
-
readonly customTracking: {
|
|
547
|
-
readonly status: "active" | "caa-blocked" | "disabled" | "pending" | "teardown-scheduled";
|
|
548
|
-
readonly label: string;
|
|
549
|
-
readonly hostname: string;
|
|
550
|
-
readonly region: string;
|
|
551
|
-
readonly sslStatus: string | null;
|
|
552
|
-
readonly certificate: {
|
|
553
|
-
readonly reason: {
|
|
554
|
-
readonly code: "awaiting-dcv" | "awaiting-hostname" | "caa-blocked" | "initializing" | "issuing" | "provider-unreachable" | "ready" | "timed-out" | "validation-error" | "verifying-route";
|
|
555
|
-
readonly message: string;
|
|
556
|
-
};
|
|
557
|
-
readonly lastCheckedAt: string | null;
|
|
558
|
-
readonly nextCheckAt: string | null;
|
|
559
|
-
} | null;
|
|
560
|
-
readonly dnsRecords: {
|
|
561
|
-
readonly tracking: {
|
|
562
|
-
readonly name: string;
|
|
563
|
-
readonly type: string;
|
|
564
|
-
readonly value: string;
|
|
565
|
-
} | null;
|
|
566
|
-
readonly dcvDelegation: {
|
|
567
|
-
readonly name: string;
|
|
568
|
-
readonly type: string;
|
|
569
|
-
readonly value: string;
|
|
570
|
-
} | null;
|
|
571
|
-
};
|
|
572
|
-
readonly caaBlocked: boolean;
|
|
573
|
-
readonly verificationErrors: readonly string[];
|
|
574
|
-
readonly teardownScheduledAt: string | null;
|
|
575
|
-
} | null;
|
|
576
|
-
}, import("./errors").BillingProviderError | import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
153
|
+
}) => import("./internal/operation").OperationResult<"emailEnableCustomTracking">;
|
|
577
154
|
export declare const getCustomTracking: (input: {
|
|
578
155
|
readonly id: string;
|
|
579
|
-
}) => import("
|
|
580
|
-
readonly enabled: boolean;
|
|
581
|
-
readonly customTracking: {
|
|
582
|
-
readonly status: "active" | "caa-blocked" | "disabled" | "pending" | "teardown-scheduled";
|
|
583
|
-
readonly label: string;
|
|
584
|
-
readonly hostname: string;
|
|
585
|
-
readonly region: string;
|
|
586
|
-
readonly sslStatus: string | null;
|
|
587
|
-
readonly certificate: {
|
|
588
|
-
readonly reason: {
|
|
589
|
-
readonly code: "awaiting-dcv" | "awaiting-hostname" | "caa-blocked" | "initializing" | "issuing" | "provider-unreachable" | "ready" | "timed-out" | "validation-error" | "verifying-route";
|
|
590
|
-
readonly message: string;
|
|
591
|
-
};
|
|
592
|
-
readonly lastCheckedAt: string | null;
|
|
593
|
-
readonly nextCheckAt: string | null;
|
|
594
|
-
} | null;
|
|
595
|
-
readonly dnsRecords: {
|
|
596
|
-
readonly tracking: {
|
|
597
|
-
readonly name: string;
|
|
598
|
-
readonly type: string;
|
|
599
|
-
readonly value: string;
|
|
600
|
-
} | null;
|
|
601
|
-
readonly dcvDelegation: {
|
|
602
|
-
readonly name: string;
|
|
603
|
-
readonly type: string;
|
|
604
|
-
readonly value: string;
|
|
605
|
-
} | null;
|
|
606
|
-
};
|
|
607
|
-
readonly caaBlocked: boolean;
|
|
608
|
-
readonly verificationErrors: readonly string[];
|
|
609
|
-
readonly teardownScheduledAt: string | null;
|
|
610
|
-
} | null;
|
|
611
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
156
|
+
}) => import("./internal/operation").OperationResult<"emailGetCustomTracking">;
|
|
612
157
|
export declare const recheckCustomTracking: (input: {
|
|
613
158
|
readonly id: string;
|
|
614
|
-
}) => import("
|
|
615
|
-
readonly enabled: boolean;
|
|
616
|
-
readonly customTracking: {
|
|
617
|
-
readonly status: "active" | "caa-blocked" | "disabled" | "pending" | "teardown-scheduled";
|
|
618
|
-
readonly label: string;
|
|
619
|
-
readonly hostname: string;
|
|
620
|
-
readonly region: string;
|
|
621
|
-
readonly sslStatus: string | null;
|
|
622
|
-
readonly certificate: {
|
|
623
|
-
readonly reason: {
|
|
624
|
-
readonly code: "awaiting-dcv" | "awaiting-hostname" | "caa-blocked" | "initializing" | "issuing" | "provider-unreachable" | "ready" | "timed-out" | "validation-error" | "verifying-route";
|
|
625
|
-
readonly message: string;
|
|
626
|
-
};
|
|
627
|
-
readonly lastCheckedAt: string | null;
|
|
628
|
-
readonly nextCheckAt: string | null;
|
|
629
|
-
} | null;
|
|
630
|
-
readonly dnsRecords: {
|
|
631
|
-
readonly tracking: {
|
|
632
|
-
readonly name: string;
|
|
633
|
-
readonly type: string;
|
|
634
|
-
readonly value: string;
|
|
635
|
-
} | null;
|
|
636
|
-
readonly dcvDelegation: {
|
|
637
|
-
readonly name: string;
|
|
638
|
-
readonly type: string;
|
|
639
|
-
readonly value: string;
|
|
640
|
-
} | null;
|
|
641
|
-
};
|
|
642
|
-
readonly caaBlocked: boolean;
|
|
643
|
-
readonly verificationErrors: readonly string[];
|
|
644
|
-
readonly teardownScheduledAt: string | null;
|
|
645
|
-
} | null;
|
|
646
|
-
}, import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
159
|
+
}) => import("./internal/operation").OperationResult<"emailRecheckCustomTracking">;
|
|
647
160
|
export declare const getCustomTrackingDomainConnect: (input: {
|
|
648
161
|
readonly id: string;
|
|
649
|
-
}) => import("
|
|
650
|
-
readonly eligible: false;
|
|
651
|
-
readonly reason: "no-record" | "no-settings" | "no-sync" | "no-template" | "unavailable";
|
|
652
|
-
} | {
|
|
653
|
-
readonly eligible: true;
|
|
654
|
-
readonly providerName?: string | null;
|
|
655
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
162
|
+
}) => import("./internal/operation").OperationResult<"emailGetCustomTrackingDomainConnect">;
|
|
656
163
|
export declare const buildCustomTrackingDomainConnectApplyUrl: (input: {
|
|
657
164
|
readonly id: string;
|
|
658
|
-
}) => import("
|
|
659
|
-
readonly url: string;
|
|
660
|
-
}, import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
165
|
+
}) => import("./internal/operation").OperationResult<"emailBuildCustomTrackingDomainConnectApplyUrl">;
|
|
661
166
|
export declare const completeCustomTrackingDomainConnect: (input: {
|
|
662
167
|
readonly id: string;
|
|
663
168
|
readonly state: string;
|
|
664
169
|
readonly error?: string | null | undefined;
|
|
665
170
|
readonly errorDescription?: string | null | undefined;
|
|
666
|
-
}) => import("
|
|
667
|
-
readonly status: "applied" | "cancelled" | "failed" | "invalid" | "stale";
|
|
668
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
171
|
+
}) => import("./internal/operation").OperationResult<"emailCompleteCustomTrackingDomainConnect">;
|
|
669
172
|
export declare const disableCustomTracking: (input: {
|
|
670
173
|
readonly id: string;
|
|
671
|
-
}) => import("
|
|
672
|
-
readonly success: boolean;
|
|
673
|
-
readonly message: string;
|
|
674
|
-
}, import("./errors").ConflictError | import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
174
|
+
}) => import("./internal/operation").OperationResult<"emailDisableCustomTracking">;
|
|
675
175
|
export declare const getDomainWarming: (input: {
|
|
676
176
|
readonly id: string;
|
|
677
|
-
}) => import("
|
|
678
|
-
readonly domain: {
|
|
679
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
680
|
-
readonly domain: string;
|
|
681
|
-
};
|
|
682
|
-
readonly plan: {
|
|
683
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
684
|
-
readonly status: "active" | "completed" | "paused";
|
|
685
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
686
|
-
readonly initialDailyRecipients: number;
|
|
687
|
-
readonly dailyGrowthPercent: number;
|
|
688
|
-
readonly targetDailyRecipients: number;
|
|
689
|
-
readonly holdReason: string | null;
|
|
690
|
-
readonly heldAt: string | null;
|
|
691
|
-
readonly pausedAt: string | null;
|
|
692
|
-
readonly completedAt: string | null;
|
|
693
|
-
readonly createdAt: string;
|
|
694
|
-
readonly updatedAt: string;
|
|
695
|
-
} | null;
|
|
696
|
-
readonly batches: readonly {
|
|
697
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
698
|
-
readonly sequence: number;
|
|
699
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
700
|
-
readonly startsAt: string;
|
|
701
|
-
readonly endsAt: string;
|
|
702
|
-
readonly allowanceRecipients: number;
|
|
703
|
-
readonly dailyGrowthPercent: number;
|
|
704
|
-
readonly targetDailyRecipients: number;
|
|
705
|
-
readonly reservedRecipients: number;
|
|
706
|
-
readonly acceptedRecipients: number;
|
|
707
|
-
readonly cancelledAt: string | null;
|
|
708
|
-
readonly createdAt: string;
|
|
709
|
-
}[];
|
|
710
|
-
readonly decisions: readonly {
|
|
711
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
712
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
713
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
714
|
-
readonly actor: string;
|
|
715
|
-
readonly note: string | null;
|
|
716
|
-
readonly createdAt: string;
|
|
717
|
-
}[];
|
|
718
|
-
readonly evidence: {
|
|
719
|
-
readonly observedAt: string;
|
|
720
|
-
readonly windowHours: number;
|
|
721
|
-
readonly minimumSends: number;
|
|
722
|
-
readonly sent: number;
|
|
723
|
-
readonly bounced: number;
|
|
724
|
-
readonly complained: number;
|
|
725
|
-
readonly hourly: readonly {
|
|
726
|
-
readonly sent: number;
|
|
727
|
-
readonly bounced: number;
|
|
728
|
-
readonly complained: number;
|
|
729
|
-
}[];
|
|
730
|
-
readonly bounceThreshold: number;
|
|
731
|
-
readonly complaintThreshold: number;
|
|
732
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
733
|
-
readonly thresholdReason: string | null;
|
|
734
|
-
};
|
|
735
|
-
readonly holds: {
|
|
736
|
-
readonly workspacePausedAt: string | null;
|
|
737
|
-
readonly workspacePauseReason: string | null;
|
|
738
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
739
|
-
};
|
|
740
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
177
|
+
}) => import("./internal/operation").OperationResult<"emailGetDomainWarming">;
|
|
741
178
|
export declare const createDomainWarmingPlan: (input: {
|
|
742
179
|
readonly id: string;
|
|
743
180
|
readonly identity: "migrating" | "new" | "returning";
|
|
744
181
|
readonly initialDailyRecipients: number;
|
|
745
182
|
readonly dailyGrowthPercent: number;
|
|
746
183
|
readonly targetDailyRecipients: number;
|
|
747
|
-
}) => import("
|
|
748
|
-
readonly domain: {
|
|
749
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
750
|
-
readonly domain: string;
|
|
751
|
-
};
|
|
752
|
-
readonly plan: {
|
|
753
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
754
|
-
readonly status: "active" | "completed" | "paused";
|
|
755
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
756
|
-
readonly initialDailyRecipients: number;
|
|
757
|
-
readonly dailyGrowthPercent: number;
|
|
758
|
-
readonly targetDailyRecipients: number;
|
|
759
|
-
readonly holdReason: string | null;
|
|
760
|
-
readonly heldAt: string | null;
|
|
761
|
-
readonly pausedAt: string | null;
|
|
762
|
-
readonly completedAt: string | null;
|
|
763
|
-
readonly createdAt: string;
|
|
764
|
-
readonly updatedAt: string;
|
|
765
|
-
} | null;
|
|
766
|
-
readonly batches: readonly {
|
|
767
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
768
|
-
readonly sequence: number;
|
|
769
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
770
|
-
readonly startsAt: string;
|
|
771
|
-
readonly endsAt: string;
|
|
772
|
-
readonly allowanceRecipients: number;
|
|
773
|
-
readonly dailyGrowthPercent: number;
|
|
774
|
-
readonly targetDailyRecipients: number;
|
|
775
|
-
readonly reservedRecipients: number;
|
|
776
|
-
readonly acceptedRecipients: number;
|
|
777
|
-
readonly cancelledAt: string | null;
|
|
778
|
-
readonly createdAt: string;
|
|
779
|
-
}[];
|
|
780
|
-
readonly decisions: readonly {
|
|
781
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
782
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
783
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
784
|
-
readonly actor: string;
|
|
785
|
-
readonly note: string | null;
|
|
786
|
-
readonly createdAt: string;
|
|
787
|
-
}[];
|
|
788
|
-
readonly evidence: {
|
|
789
|
-
readonly observedAt: string;
|
|
790
|
-
readonly windowHours: number;
|
|
791
|
-
readonly minimumSends: number;
|
|
792
|
-
readonly sent: number;
|
|
793
|
-
readonly bounced: number;
|
|
794
|
-
readonly complained: number;
|
|
795
|
-
readonly hourly: readonly {
|
|
796
|
-
readonly sent: number;
|
|
797
|
-
readonly bounced: number;
|
|
798
|
-
readonly complained: number;
|
|
799
|
-
}[];
|
|
800
|
-
readonly bounceThreshold: number;
|
|
801
|
-
readonly complaintThreshold: number;
|
|
802
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
803
|
-
readonly thresholdReason: string | null;
|
|
804
|
-
};
|
|
805
|
-
readonly holds: {
|
|
806
|
-
readonly workspacePausedAt: string | null;
|
|
807
|
-
readonly workspacePauseReason: string | null;
|
|
808
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
809
|
-
};
|
|
810
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
184
|
+
}) => import("./internal/operation").OperationResult<"emailCreateDomainWarmingPlan">;
|
|
811
185
|
export declare const updateDomainWarmingPolicy: (input: {
|
|
812
186
|
readonly id: string;
|
|
813
187
|
readonly dailyGrowthPercent: number;
|
|
814
188
|
readonly targetDailyRecipients: number;
|
|
815
189
|
readonly note?: string | null | undefined;
|
|
816
|
-
}) => import("
|
|
817
|
-
readonly domain: {
|
|
818
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
819
|
-
readonly domain: string;
|
|
820
|
-
};
|
|
821
|
-
readonly plan: {
|
|
822
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
823
|
-
readonly status: "active" | "completed" | "paused";
|
|
824
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
825
|
-
readonly initialDailyRecipients: number;
|
|
826
|
-
readonly dailyGrowthPercent: number;
|
|
827
|
-
readonly targetDailyRecipients: number;
|
|
828
|
-
readonly holdReason: string | null;
|
|
829
|
-
readonly heldAt: string | null;
|
|
830
|
-
readonly pausedAt: string | null;
|
|
831
|
-
readonly completedAt: string | null;
|
|
832
|
-
readonly createdAt: string;
|
|
833
|
-
readonly updatedAt: string;
|
|
834
|
-
} | null;
|
|
835
|
-
readonly batches: readonly {
|
|
836
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
837
|
-
readonly sequence: number;
|
|
838
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
839
|
-
readonly startsAt: string;
|
|
840
|
-
readonly endsAt: string;
|
|
841
|
-
readonly allowanceRecipients: number;
|
|
842
|
-
readonly dailyGrowthPercent: number;
|
|
843
|
-
readonly targetDailyRecipients: number;
|
|
844
|
-
readonly reservedRecipients: number;
|
|
845
|
-
readonly acceptedRecipients: number;
|
|
846
|
-
readonly cancelledAt: string | null;
|
|
847
|
-
readonly createdAt: string;
|
|
848
|
-
}[];
|
|
849
|
-
readonly decisions: readonly {
|
|
850
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
851
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
852
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
853
|
-
readonly actor: string;
|
|
854
|
-
readonly note: string | null;
|
|
855
|
-
readonly createdAt: string;
|
|
856
|
-
}[];
|
|
857
|
-
readonly evidence: {
|
|
858
|
-
readonly observedAt: string;
|
|
859
|
-
readonly windowHours: number;
|
|
860
|
-
readonly minimumSends: number;
|
|
861
|
-
readonly sent: number;
|
|
862
|
-
readonly bounced: number;
|
|
863
|
-
readonly complained: number;
|
|
864
|
-
readonly hourly: readonly {
|
|
865
|
-
readonly sent: number;
|
|
866
|
-
readonly bounced: number;
|
|
867
|
-
readonly complained: number;
|
|
868
|
-
}[];
|
|
869
|
-
readonly bounceThreshold: number;
|
|
870
|
-
readonly complaintThreshold: number;
|
|
871
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
872
|
-
readonly thresholdReason: string | null;
|
|
873
|
-
};
|
|
874
|
-
readonly holds: {
|
|
875
|
-
readonly workspacePausedAt: string | null;
|
|
876
|
-
readonly workspacePauseReason: string | null;
|
|
877
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
878
|
-
};
|
|
879
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
190
|
+
}) => import("./internal/operation").OperationResult<"emailUpdateDomainWarmingPolicy">;
|
|
880
191
|
export declare const cancelDomainWarmingBatch: (input: {
|
|
881
192
|
readonly id: string;
|
|
882
193
|
readonly batchId: string;
|
|
883
|
-
}) => import("
|
|
884
|
-
readonly domain: {
|
|
885
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
886
|
-
readonly domain: string;
|
|
887
|
-
};
|
|
888
|
-
readonly plan: {
|
|
889
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
890
|
-
readonly status: "active" | "completed" | "paused";
|
|
891
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
892
|
-
readonly initialDailyRecipients: number;
|
|
893
|
-
readonly dailyGrowthPercent: number;
|
|
894
|
-
readonly targetDailyRecipients: number;
|
|
895
|
-
readonly holdReason: string | null;
|
|
896
|
-
readonly heldAt: string | null;
|
|
897
|
-
readonly pausedAt: string | null;
|
|
898
|
-
readonly completedAt: string | null;
|
|
899
|
-
readonly createdAt: string;
|
|
900
|
-
readonly updatedAt: string;
|
|
901
|
-
} | null;
|
|
902
|
-
readonly batches: readonly {
|
|
903
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
904
|
-
readonly sequence: number;
|
|
905
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
906
|
-
readonly startsAt: string;
|
|
907
|
-
readonly endsAt: string;
|
|
908
|
-
readonly allowanceRecipients: number;
|
|
909
|
-
readonly dailyGrowthPercent: number;
|
|
910
|
-
readonly targetDailyRecipients: number;
|
|
911
|
-
readonly reservedRecipients: number;
|
|
912
|
-
readonly acceptedRecipients: number;
|
|
913
|
-
readonly cancelledAt: string | null;
|
|
914
|
-
readonly createdAt: string;
|
|
915
|
-
}[];
|
|
916
|
-
readonly decisions: readonly {
|
|
917
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
918
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
919
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
920
|
-
readonly actor: string;
|
|
921
|
-
readonly note: string | null;
|
|
922
|
-
readonly createdAt: string;
|
|
923
|
-
}[];
|
|
924
|
-
readonly evidence: {
|
|
925
|
-
readonly observedAt: string;
|
|
926
|
-
readonly windowHours: number;
|
|
927
|
-
readonly minimumSends: number;
|
|
928
|
-
readonly sent: number;
|
|
929
|
-
readonly bounced: number;
|
|
930
|
-
readonly complained: number;
|
|
931
|
-
readonly hourly: readonly {
|
|
932
|
-
readonly sent: number;
|
|
933
|
-
readonly bounced: number;
|
|
934
|
-
readonly complained: number;
|
|
935
|
-
}[];
|
|
936
|
-
readonly bounceThreshold: number;
|
|
937
|
-
readonly complaintThreshold: number;
|
|
938
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
939
|
-
readonly thresholdReason: string | null;
|
|
940
|
-
};
|
|
941
|
-
readonly holds: {
|
|
942
|
-
readonly workspacePausedAt: string | null;
|
|
943
|
-
readonly workspacePauseReason: string | null;
|
|
944
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
945
|
-
};
|
|
946
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
194
|
+
}) => import("./internal/operation").OperationResult<"emailCancelDomainWarmingBatch">;
|
|
947
195
|
export declare const pauseDomainWarming: (input: {
|
|
948
196
|
readonly id: string;
|
|
949
197
|
readonly note?: string | null | undefined;
|
|
950
|
-
}) => import("
|
|
951
|
-
readonly domain: {
|
|
952
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
953
|
-
readonly domain: string;
|
|
954
|
-
};
|
|
955
|
-
readonly plan: {
|
|
956
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
957
|
-
readonly status: "active" | "completed" | "paused";
|
|
958
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
959
|
-
readonly initialDailyRecipients: number;
|
|
960
|
-
readonly dailyGrowthPercent: number;
|
|
961
|
-
readonly targetDailyRecipients: number;
|
|
962
|
-
readonly holdReason: string | null;
|
|
963
|
-
readonly heldAt: string | null;
|
|
964
|
-
readonly pausedAt: string | null;
|
|
965
|
-
readonly completedAt: string | null;
|
|
966
|
-
readonly createdAt: string;
|
|
967
|
-
readonly updatedAt: string;
|
|
968
|
-
} | null;
|
|
969
|
-
readonly batches: readonly {
|
|
970
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
971
|
-
readonly sequence: number;
|
|
972
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
973
|
-
readonly startsAt: string;
|
|
974
|
-
readonly endsAt: string;
|
|
975
|
-
readonly allowanceRecipients: number;
|
|
976
|
-
readonly dailyGrowthPercent: number;
|
|
977
|
-
readonly targetDailyRecipients: number;
|
|
978
|
-
readonly reservedRecipients: number;
|
|
979
|
-
readonly acceptedRecipients: number;
|
|
980
|
-
readonly cancelledAt: string | null;
|
|
981
|
-
readonly createdAt: string;
|
|
982
|
-
}[];
|
|
983
|
-
readonly decisions: readonly {
|
|
984
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
985
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
986
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
987
|
-
readonly actor: string;
|
|
988
|
-
readonly note: string | null;
|
|
989
|
-
readonly createdAt: string;
|
|
990
|
-
}[];
|
|
991
|
-
readonly evidence: {
|
|
992
|
-
readonly observedAt: string;
|
|
993
|
-
readonly windowHours: number;
|
|
994
|
-
readonly minimumSends: number;
|
|
995
|
-
readonly sent: number;
|
|
996
|
-
readonly bounced: number;
|
|
997
|
-
readonly complained: number;
|
|
998
|
-
readonly hourly: readonly {
|
|
999
|
-
readonly sent: number;
|
|
1000
|
-
readonly bounced: number;
|
|
1001
|
-
readonly complained: number;
|
|
1002
|
-
}[];
|
|
1003
|
-
readonly bounceThreshold: number;
|
|
1004
|
-
readonly complaintThreshold: number;
|
|
1005
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
1006
|
-
readonly thresholdReason: string | null;
|
|
1007
|
-
};
|
|
1008
|
-
readonly holds: {
|
|
1009
|
-
readonly workspacePausedAt: string | null;
|
|
1010
|
-
readonly workspacePauseReason: string | null;
|
|
1011
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
1012
|
-
};
|
|
1013
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
198
|
+
}) => import("./internal/operation").OperationResult<"emailPauseDomainWarming">;
|
|
1014
199
|
export declare const resumeDomainWarming: (input: {
|
|
1015
200
|
readonly id: string;
|
|
1016
201
|
readonly note?: string | null | undefined;
|
|
1017
|
-
}) => import("
|
|
1018
|
-
readonly domain: {
|
|
1019
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
1020
|
-
readonly domain: string;
|
|
1021
|
-
};
|
|
1022
|
-
readonly plan: {
|
|
1023
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
1024
|
-
readonly status: "active" | "completed" | "paused";
|
|
1025
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
1026
|
-
readonly initialDailyRecipients: number;
|
|
1027
|
-
readonly dailyGrowthPercent: number;
|
|
1028
|
-
readonly targetDailyRecipients: number;
|
|
1029
|
-
readonly holdReason: string | null;
|
|
1030
|
-
readonly heldAt: string | null;
|
|
1031
|
-
readonly pausedAt: string | null;
|
|
1032
|
-
readonly completedAt: string | null;
|
|
1033
|
-
readonly createdAt: string;
|
|
1034
|
-
readonly updatedAt: string;
|
|
1035
|
-
} | null;
|
|
1036
|
-
readonly batches: readonly {
|
|
1037
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
1038
|
-
readonly sequence: number;
|
|
1039
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
1040
|
-
readonly startsAt: string;
|
|
1041
|
-
readonly endsAt: string;
|
|
1042
|
-
readonly allowanceRecipients: number;
|
|
1043
|
-
readonly dailyGrowthPercent: number;
|
|
1044
|
-
readonly targetDailyRecipients: number;
|
|
1045
|
-
readonly reservedRecipients: number;
|
|
1046
|
-
readonly acceptedRecipients: number;
|
|
1047
|
-
readonly cancelledAt: string | null;
|
|
1048
|
-
readonly createdAt: string;
|
|
1049
|
-
}[];
|
|
1050
|
-
readonly decisions: readonly {
|
|
1051
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
1052
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
1053
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
1054
|
-
readonly actor: string;
|
|
1055
|
-
readonly note: string | null;
|
|
1056
|
-
readonly createdAt: string;
|
|
1057
|
-
}[];
|
|
1058
|
-
readonly evidence: {
|
|
1059
|
-
readonly observedAt: string;
|
|
1060
|
-
readonly windowHours: number;
|
|
1061
|
-
readonly minimumSends: number;
|
|
1062
|
-
readonly sent: number;
|
|
1063
|
-
readonly bounced: number;
|
|
1064
|
-
readonly complained: number;
|
|
1065
|
-
readonly hourly: readonly {
|
|
1066
|
-
readonly sent: number;
|
|
1067
|
-
readonly bounced: number;
|
|
1068
|
-
readonly complained: number;
|
|
1069
|
-
}[];
|
|
1070
|
-
readonly bounceThreshold: number;
|
|
1071
|
-
readonly complaintThreshold: number;
|
|
1072
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
1073
|
-
readonly thresholdReason: string | null;
|
|
1074
|
-
};
|
|
1075
|
-
readonly holds: {
|
|
1076
|
-
readonly workspacePausedAt: string | null;
|
|
1077
|
-
readonly workspacePauseReason: string | null;
|
|
1078
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
1079
|
-
};
|
|
1080
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
202
|
+
}) => import("./internal/operation").OperationResult<"emailResumeDomainWarming">;
|
|
1081
203
|
export declare const completeDomainWarming: (input: {
|
|
1082
204
|
readonly id: string;
|
|
1083
205
|
readonly note?: string | null | undefined;
|
|
1084
|
-
}) => import("
|
|
1085
|
-
|
|
1086
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainId">;
|
|
1087
|
-
readonly domain: string;
|
|
1088
|
-
};
|
|
1089
|
-
readonly plan: {
|
|
1090
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingPlanId">;
|
|
1091
|
-
readonly status: "active" | "completed" | "paused";
|
|
1092
|
-
readonly identity: "migrating" | "new" | "returning";
|
|
1093
|
-
readonly initialDailyRecipients: number;
|
|
1094
|
-
readonly dailyGrowthPercent: number;
|
|
1095
|
-
readonly targetDailyRecipients: number;
|
|
1096
|
-
readonly holdReason: string | null;
|
|
1097
|
-
readonly heldAt: string | null;
|
|
1098
|
-
readonly pausedAt: string | null;
|
|
1099
|
-
readonly completedAt: string | null;
|
|
1100
|
-
readonly createdAt: string;
|
|
1101
|
-
readonly updatedAt: string;
|
|
1102
|
-
} | null;
|
|
1103
|
-
readonly batches: readonly {
|
|
1104
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">;
|
|
1105
|
-
readonly sequence: number;
|
|
1106
|
-
readonly state: "cancelled" | "closed" | "open" | "scheduled";
|
|
1107
|
-
readonly startsAt: string;
|
|
1108
|
-
readonly endsAt: string;
|
|
1109
|
-
readonly allowanceRecipients: number;
|
|
1110
|
-
readonly dailyGrowthPercent: number;
|
|
1111
|
-
readonly targetDailyRecipients: number;
|
|
1112
|
-
readonly reservedRecipients: number;
|
|
1113
|
-
readonly acceptedRecipients: number;
|
|
1114
|
-
readonly cancelledAt: string | null;
|
|
1115
|
-
readonly createdAt: string;
|
|
1116
|
-
}[];
|
|
1117
|
-
readonly decisions: readonly {
|
|
1118
|
-
readonly id: string & import("effect/Brand").Brand<"EmailDomainWarmingDecisionId">;
|
|
1119
|
-
readonly kind: "completed" | "held" | "paused" | "plan-created" | "policy-updated" | "resumed" | "window-cancelled" | "window-opened";
|
|
1120
|
-
readonly batchId: (string & import("effect/Brand").Brand<"EmailDomainWarmingBatchId">) | null;
|
|
1121
|
-
readonly actor: string;
|
|
1122
|
-
readonly note: string | null;
|
|
1123
|
-
readonly createdAt: string;
|
|
1124
|
-
}[];
|
|
1125
|
-
readonly evidence: {
|
|
1126
|
-
readonly observedAt: string;
|
|
1127
|
-
readonly windowHours: number;
|
|
1128
|
-
readonly minimumSends: number;
|
|
1129
|
-
readonly sent: number;
|
|
1130
|
-
readonly bounced: number;
|
|
1131
|
-
readonly complained: number;
|
|
1132
|
-
readonly hourly: readonly {
|
|
1133
|
-
readonly sent: number;
|
|
1134
|
-
readonly bounced: number;
|
|
1135
|
-
readonly complained: number;
|
|
1136
|
-
}[];
|
|
1137
|
-
readonly bounceThreshold: number;
|
|
1138
|
-
readonly complaintThreshold: number;
|
|
1139
|
-
readonly verdict: "healthy" | "insufficient-evidence" | "over-threshold";
|
|
1140
|
-
readonly thresholdReason: string | null;
|
|
1141
|
-
};
|
|
1142
|
-
readonly holds: {
|
|
1143
|
-
readonly workspacePausedAt: string | null;
|
|
1144
|
-
readonly workspacePauseReason: string | null;
|
|
1145
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
1146
|
-
};
|
|
1147
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
1148
|
-
export declare const getOnboardingReview: (_?: never) => import("effect/Effect").Effect<{
|
|
1149
|
-
readonly decision: "approved" | "rejected" | "undecided";
|
|
1150
|
-
readonly trustTier: "established" | "probation" | "screened";
|
|
1151
|
-
readonly stage: "automated_review" | "collecting" | "complete" | "information_requested" | "manual_review";
|
|
1152
|
-
readonly generation: number;
|
|
1153
|
-
readonly canSend: boolean;
|
|
1154
|
-
readonly code: "identity_changed" | "identity_review_rejected" | "identity_review_required" | "information_required" | "review_in_progress" | "review_rejected" | "review_required" | null;
|
|
1155
|
-
readonly nextAction: "contact_support" | "provide_information" | "reapply" | "verify_sending_identity" | "wait_for_review" | null;
|
|
1156
|
-
readonly canReapply: boolean;
|
|
1157
|
-
readonly informationRequest: {
|
|
1158
|
-
readonly id: string;
|
|
1159
|
-
readonly requestedFields: readonly string[];
|
|
1160
|
-
readonly requestedAt: string;
|
|
1161
|
-
readonly canRespond: boolean;
|
|
1162
|
-
} | null;
|
|
1163
|
-
readonly identities: readonly {
|
|
1164
|
-
readonly identityId: string;
|
|
1165
|
-
readonly decision: "approved" | "rejected" | "undecided";
|
|
1166
|
-
readonly generation: number;
|
|
1167
|
-
readonly canSend: boolean;
|
|
1168
|
-
readonly code: "identity_changed" | "identity_review_rejected" | "identity_review_required" | "information_required" | "review_in_progress" | "review_rejected" | "review_required" | null;
|
|
1169
|
-
readonly nextAction: "contact_support" | "provide_information" | "reapply" | "verify_sending_identity" | "wait_for_review" | null;
|
|
1170
|
-
readonly updatedAt: string;
|
|
1171
|
-
}[];
|
|
1172
|
-
readonly updatedAt: string | null;
|
|
1173
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
206
|
+
}) => import("./internal/operation").OperationResult<"emailCompleteDomainWarming">;
|
|
207
|
+
export declare const getOnboardingReview: (_?: never) => import("./internal/operation").OperationResult<"emailGetOnboardingReview">;
|
|
1174
208
|
export declare const reapplyOnboardingReview: (input: {
|
|
1175
209
|
readonly expectedGeneration: number;
|
|
1176
|
-
}) => import("
|
|
1177
|
-
readonly decision: "approved" | "rejected" | "undecided";
|
|
1178
|
-
readonly trustTier: "established" | "probation" | "screened";
|
|
1179
|
-
readonly stage: "automated_review" | "collecting" | "complete" | "information_requested" | "manual_review";
|
|
1180
|
-
readonly generation: number;
|
|
1181
|
-
readonly canSend: boolean;
|
|
1182
|
-
readonly code: "identity_changed" | "identity_review_rejected" | "identity_review_required" | "information_required" | "review_in_progress" | "review_rejected" | "review_required" | null;
|
|
1183
|
-
readonly nextAction: "contact_support" | "provide_information" | "reapply" | "verify_sending_identity" | "wait_for_review" | null;
|
|
1184
|
-
readonly canReapply: boolean;
|
|
1185
|
-
readonly informationRequest: {
|
|
1186
|
-
readonly id: string;
|
|
1187
|
-
readonly requestedFields: readonly string[];
|
|
1188
|
-
readonly requestedAt: string;
|
|
1189
|
-
readonly canRespond: boolean;
|
|
1190
|
-
} | null;
|
|
1191
|
-
readonly identities: readonly {
|
|
1192
|
-
readonly identityId: string;
|
|
1193
|
-
readonly decision: "approved" | "rejected" | "undecided";
|
|
1194
|
-
readonly generation: number;
|
|
1195
|
-
readonly canSend: boolean;
|
|
1196
|
-
readonly code: "identity_changed" | "identity_review_rejected" | "identity_review_required" | "information_required" | "review_in_progress" | "review_rejected" | "review_required" | null;
|
|
1197
|
-
readonly nextAction: "contact_support" | "provide_information" | "reapply" | "verify_sending_identity" | "wait_for_review" | null;
|
|
1198
|
-
readonly updatedAt: string;
|
|
1199
|
-
}[];
|
|
1200
|
-
readonly updatedAt: string | null;
|
|
1201
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
210
|
+
}) => import("./internal/operation").OperationResult<"emailReapplyOnboardingReview">;
|
|
1202
211
|
export declare const respondToOnboardingInformationRequest: (input: {
|
|
1203
212
|
readonly expectedGeneration: number;
|
|
1204
213
|
readonly responseText: string;
|
|
1205
214
|
readonly evidenceMediaIds: readonly string[];
|
|
1206
|
-
}) => import("
|
|
1207
|
-
readonly decision: "approved" | "rejected" | "undecided";
|
|
1208
|
-
readonly trustTier: "established" | "probation" | "screened";
|
|
1209
|
-
readonly stage: "automated_review" | "collecting" | "complete" | "information_requested" | "manual_review";
|
|
1210
|
-
readonly generation: number;
|
|
1211
|
-
readonly canSend: boolean;
|
|
1212
|
-
readonly code: "identity_changed" | "identity_review_rejected" | "identity_review_required" | "information_required" | "review_in_progress" | "review_rejected" | "review_required" | null;
|
|
1213
|
-
readonly nextAction: "contact_support" | "provide_information" | "reapply" | "verify_sending_identity" | "wait_for_review" | null;
|
|
1214
|
-
readonly canReapply: boolean;
|
|
1215
|
-
readonly informationRequest: {
|
|
1216
|
-
readonly id: string;
|
|
1217
|
-
readonly requestedFields: readonly string[];
|
|
1218
|
-
readonly requestedAt: string;
|
|
1219
|
-
readonly canRespond: boolean;
|
|
1220
|
-
} | null;
|
|
1221
|
-
readonly identities: readonly {
|
|
1222
|
-
readonly identityId: string;
|
|
1223
|
-
readonly decision: "approved" | "rejected" | "undecided";
|
|
1224
|
-
readonly generation: number;
|
|
1225
|
-
readonly canSend: boolean;
|
|
1226
|
-
readonly code: "identity_changed" | "identity_review_rejected" | "identity_review_required" | "information_required" | "review_in_progress" | "review_rejected" | "review_required" | null;
|
|
1227
|
-
readonly nextAction: "contact_support" | "provide_information" | "reapply" | "verify_sending_identity" | "wait_for_review" | null;
|
|
1228
|
-
readonly updatedAt: string;
|
|
1229
|
-
}[];
|
|
1230
|
-
readonly updatedAt: string | null;
|
|
1231
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
215
|
+
}) => import("./internal/operation").OperationResult<"emailRespondToOnboardingInformationRequest">;
|
|
1232
216
|
export declare const listSenders: ((input?: {
|
|
1233
217
|
readonly limit?: string | null | undefined;
|
|
1234
218
|
readonly cursor?: string | null | undefined;
|
|
@@ -1236,34 +220,7 @@ export declare const listSenders: ((input?: {
|
|
|
1236
220
|
readonly isActive?: string | null | undefined;
|
|
1237
221
|
readonly isDefault?: string | null | undefined;
|
|
1238
222
|
readonly namespaceId?: string | null | undefined;
|
|
1239
|
-
} | undefined) => import("
|
|
1240
|
-
readonly items: readonly {
|
|
1241
|
-
readonly id: string & import("effect/Brand").Brand<"EmailSenderId">;
|
|
1242
|
-
readonly organizationId: string;
|
|
1243
|
-
readonly email: string;
|
|
1244
|
-
readonly name: string | null;
|
|
1245
|
-
readonly domainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1246
|
-
readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
|
|
1247
|
-
readonly verificationStatus: "failed" | "pending" | "verified";
|
|
1248
|
-
readonly verifiedAt: string | null;
|
|
1249
|
-
readonly verificationToken: string | null;
|
|
1250
|
-
readonly providerLifecycle: "active" | "deleting" | "failed" | "provisioning";
|
|
1251
|
-
readonly providerFailureCode: string | null;
|
|
1252
|
-
readonly isDefault: boolean;
|
|
1253
|
-
readonly replyToEmails: readonly string[] | null;
|
|
1254
|
-
readonly deliverability: {
|
|
1255
|
-
readonly bounceRate: number;
|
|
1256
|
-
readonly complaintRate: number;
|
|
1257
|
-
readonly windowSends: number;
|
|
1258
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
1259
|
-
};
|
|
1260
|
-
readonly series: readonly number[];
|
|
1261
|
-
readonly isActive: boolean;
|
|
1262
|
-
readonly createdAt: string;
|
|
1263
|
-
readonly updatedAt: string;
|
|
1264
|
-
}[];
|
|
1265
|
-
readonly nextCursor: string | null;
|
|
1266
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
223
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailListSenders">) & {
|
|
1267
224
|
readonly pages: (input?: {
|
|
1268
225
|
readonly limit?: string | null | undefined;
|
|
1269
226
|
readonly cursor?: string | null | undefined;
|
|
@@ -1334,31 +291,7 @@ export declare const listSenders: ((input?: {
|
|
|
1334
291
|
};
|
|
1335
292
|
export declare const getSender: (input: {
|
|
1336
293
|
readonly id: string;
|
|
1337
|
-
}) => import("
|
|
1338
|
-
readonly id: string & import("effect/Brand").Brand<"EmailSenderId">;
|
|
1339
|
-
readonly organizationId: string;
|
|
1340
|
-
readonly email: string;
|
|
1341
|
-
readonly name: string | null;
|
|
1342
|
-
readonly domainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1343
|
-
readonly namespaceId: (string & import("effect/Brand").Brand<"NamespaceId">) | null;
|
|
1344
|
-
readonly verificationStatus: "failed" | "pending" | "verified";
|
|
1345
|
-
readonly verifiedAt: string | null;
|
|
1346
|
-
readonly verificationToken: string | null;
|
|
1347
|
-
readonly providerLifecycle: "active" | "deleting" | "failed" | "provisioning";
|
|
1348
|
-
readonly providerFailureCode: string | null;
|
|
1349
|
-
readonly isDefault: boolean;
|
|
1350
|
-
readonly replyToEmails: readonly string[] | null;
|
|
1351
|
-
readonly deliverability: {
|
|
1352
|
-
readonly bounceRate: number;
|
|
1353
|
-
readonly complaintRate: number;
|
|
1354
|
-
readonly windowSends: number;
|
|
1355
|
-
readonly sendingStatus: "disabled" | "enabled" | "reinstated" | "unknown";
|
|
1356
|
-
};
|
|
1357
|
-
readonly series: readonly number[];
|
|
1358
|
-
readonly isActive: boolean;
|
|
1359
|
-
readonly createdAt: string;
|
|
1360
|
-
readonly updatedAt: string;
|
|
1361
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
294
|
+
}) => import("./internal/operation").OperationResult<"emailGetSender">;
|
|
1362
295
|
export declare const addSender: (input: EmailAddSenderInput, options?: SendOptions | undefined) => import("effect/Effect").Effect<{
|
|
1363
296
|
readonly id: string & import("effect/Brand").Brand<"EmailSenderId">;
|
|
1364
297
|
readonly email: string;
|
|
@@ -1369,98 +302,43 @@ export declare const addSender: (input: EmailAddSenderInput, options?: SendOptio
|
|
|
1369
302
|
}, import("./errors").ConflictError | import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
1370
303
|
export declare const checkSenderVerification: (input: {
|
|
1371
304
|
readonly id: string;
|
|
1372
|
-
}) => import("
|
|
1373
|
-
readonly id: string & import("effect/Brand").Brand<"EmailSenderId">;
|
|
1374
|
-
readonly email: string;
|
|
1375
|
-
readonly status: "failed" | "pending" | "verified";
|
|
1376
|
-
readonly verifiedAt: string | null;
|
|
1377
|
-
}, import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
305
|
+
}) => import("./internal/operation").OperationResult<"emailCheckSenderVerification">;
|
|
1378
306
|
export declare const removeSender: (input: {
|
|
1379
307
|
readonly id: string;
|
|
1380
|
-
}) => import("
|
|
1381
|
-
readonly success: boolean;
|
|
1382
|
-
readonly message: string;
|
|
1383
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
308
|
+
}) => import("./internal/operation").OperationResult<"emailRemoveSender">;
|
|
1384
309
|
export declare const setDefaultSender: (input: {
|
|
1385
310
|
readonly id: string;
|
|
1386
|
-
}) => import("
|
|
1387
|
-
readonly success: boolean;
|
|
1388
|
-
readonly message: string;
|
|
1389
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
311
|
+
}) => import("./internal/operation").OperationResult<"emailSetDefaultSender">;
|
|
1390
312
|
export declare const getStats: (input?: {
|
|
1391
313
|
readonly after?: string | null | undefined;
|
|
1392
314
|
readonly before?: string | null | undefined;
|
|
1393
|
-
} | undefined) => import("
|
|
1394
|
-
readonly totalSent: number;
|
|
1395
|
-
readonly totalDelivered: number;
|
|
1396
|
-
readonly totalBounced: number;
|
|
1397
|
-
readonly totalComplained: number;
|
|
1398
|
-
readonly deliveryRate: number;
|
|
1399
|
-
readonly bounceRate: number;
|
|
1400
|
-
readonly complaintRate: number;
|
|
1401
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
315
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailGetStats">;
|
|
1402
316
|
export declare const enableCatchAll: (input: {
|
|
1403
317
|
readonly id: string;
|
|
1404
318
|
readonly endpointId?: string | null | undefined;
|
|
1405
|
-
}) => import("
|
|
1406
|
-
readonly success: true;
|
|
1407
|
-
}, import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
319
|
+
}) => import("./internal/operation").OperationResult<"emailEnableCatchAll">;
|
|
1408
320
|
export declare const disableCatchAll: (input: {
|
|
1409
321
|
readonly id: string;
|
|
1410
|
-
}) => import("
|
|
1411
|
-
readonly success: true;
|
|
1412
|
-
}, import("./errors").ExternalServiceError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
322
|
+
}) => import("./internal/operation").OperationResult<"emailDisableCatchAll">;
|
|
1413
323
|
export declare const getCatchAllConfig: (input: {
|
|
1414
324
|
readonly domainId: string;
|
|
1415
|
-
}) => import("
|
|
1416
|
-
readonly enabled: boolean;
|
|
1417
|
-
readonly endpointId: (string & import("effect/Brand").Brand<"WebhookEndpointId">) | null;
|
|
1418
|
-
readonly emailCount: number;
|
|
1419
|
-
readonly lastEmailAt: string | null;
|
|
1420
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
325
|
+
}) => import("./internal/operation").OperationResult<"emailGetCatchAllConfig">;
|
|
1421
326
|
export declare const updateCatchAllConfig: (input: {
|
|
1422
327
|
readonly domainId: string;
|
|
1423
328
|
readonly endpointId?: string | null | undefined;
|
|
1424
|
-
}) => import("
|
|
1425
|
-
readonly success: true;
|
|
1426
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
329
|
+
}) => import("./internal/operation").OperationResult<"emailUpdateCatchAllConfig">;
|
|
1427
330
|
export declare const getCatchAllStats: (input: {
|
|
1428
331
|
readonly domainId: string;
|
|
1429
332
|
readonly after?: string | null | undefined;
|
|
1430
333
|
readonly before?: string | null | undefined;
|
|
1431
|
-
}) => import("
|
|
1432
|
-
readonly domain: string;
|
|
1433
|
-
readonly isCatchAllEnabled: boolean;
|
|
1434
|
-
readonly catchAllEmailCount: number;
|
|
1435
|
-
readonly catchAllLastEmailAt: string | null;
|
|
1436
|
-
readonly timeRange?: {
|
|
1437
|
-
readonly emailsReceived: number;
|
|
1438
|
-
readonly firstEmail: string | null;
|
|
1439
|
-
readonly lastEmail: string | null;
|
|
1440
|
-
readonly avgPerDay: number;
|
|
1441
|
-
} | null;
|
|
1442
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
334
|
+
}) => import("./internal/operation").OperationResult<"emailGetCatchAllStats">;
|
|
1443
335
|
export declare const listSuppressions: ((input?: {
|
|
1444
336
|
readonly type?: "bounce" | "complaint" | "manual" | "unsubscribe" | null | undefined;
|
|
1445
337
|
readonly status?: "active" | "expired" | null | undefined;
|
|
1446
338
|
readonly search?: string | null | undefined;
|
|
1447
339
|
readonly limit?: string | null | undefined;
|
|
1448
340
|
readonly cursor?: string | null | undefined;
|
|
1449
|
-
} | undefined) => import("
|
|
1450
|
-
readonly items: readonly {
|
|
1451
|
-
readonly id: string & import("effect/Brand").Brand<"SuppressionId">;
|
|
1452
|
-
readonly email: string;
|
|
1453
|
-
readonly type: "bounce" | "complaint" | "manual" | "unsubscribe";
|
|
1454
|
-
readonly bounceType: string | null;
|
|
1455
|
-
readonly bounceSubType: string | null;
|
|
1456
|
-
readonly reason: string | null;
|
|
1457
|
-
readonly messageId: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1458
|
-
readonly isActive: boolean;
|
|
1459
|
-
readonly expiresAt: string | null;
|
|
1460
|
-
readonly createdAt: string;
|
|
1461
|
-
}[];
|
|
1462
|
-
readonly nextCursor: string | null;
|
|
1463
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
341
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailListSuppressions">) & {
|
|
1464
342
|
readonly pages: (input?: {
|
|
1465
343
|
readonly type?: "bounce" | "complaint" | "manual" | "unsubscribe" | null | undefined;
|
|
1466
344
|
readonly status?: "active" | "expired" | null | undefined;
|
|
@@ -1501,38 +379,16 @@ export declare const listSuppressions: ((input?: {
|
|
|
1501
379
|
readonly createdAt: string;
|
|
1502
380
|
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
1503
381
|
};
|
|
1504
|
-
export declare const countSuppressions: (_?: never) => import("
|
|
1505
|
-
readonly bounce: number;
|
|
1506
|
-
readonly complaint: number;
|
|
1507
|
-
readonly unsubscribe: number;
|
|
1508
|
-
readonly manual: number;
|
|
1509
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
382
|
+
export declare const countSuppressions: (_?: never) => import("./internal/operation").OperationResult<"emailCountSuppressions">;
|
|
1510
383
|
export declare const removeSuppression: (input: {
|
|
1511
384
|
readonly id: string;
|
|
1512
|
-
}) => import("
|
|
1513
|
-
readonly success: boolean;
|
|
1514
|
-
readonly message: string;
|
|
1515
|
-
}, import("./errors").EmailChannelError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
385
|
+
}) => import("./internal/operation").OperationResult<"emailRemoveSuppression">;
|
|
1516
386
|
export declare const listBlocks: ((input?: {
|
|
1517
387
|
readonly blockType?: "domain" | "email" | null | undefined;
|
|
1518
388
|
readonly isActive?: string | null | undefined;
|
|
1519
389
|
readonly limit?: string | null | undefined;
|
|
1520
390
|
readonly cursor?: string | null | undefined;
|
|
1521
|
-
} | undefined) => import("
|
|
1522
|
-
readonly items: readonly {
|
|
1523
|
-
readonly id: string & import("effect/Brand").Brand<"BlockedEmailId">;
|
|
1524
|
-
readonly blockType: "domain" | "email";
|
|
1525
|
-
readonly blockValue: string;
|
|
1526
|
-
readonly reason: string;
|
|
1527
|
-
readonly notes: string | null;
|
|
1528
|
-
readonly isActive: boolean;
|
|
1529
|
-
readonly blockCount: number;
|
|
1530
|
-
readonly lastBlockedAt: string | null;
|
|
1531
|
-
readonly expiresAt: string | null;
|
|
1532
|
-
readonly createdAt: string;
|
|
1533
|
-
}[];
|
|
1534
|
-
readonly nextCursor: string | null;
|
|
1535
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
391
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailListBlocks">) & {
|
|
1536
392
|
readonly pages: (input?: {
|
|
1537
393
|
readonly blockType?: "domain" | "email" | null | undefined;
|
|
1538
394
|
readonly isActive?: string | null | undefined;
|
|
@@ -1577,38 +433,17 @@ export declare const addBlock: (input: {
|
|
|
1577
433
|
readonly reason: string;
|
|
1578
434
|
readonly notes?: string | null | undefined;
|
|
1579
435
|
readonly expiresAt?: string | null | undefined;
|
|
1580
|
-
}) => import("
|
|
1581
|
-
readonly id: string & import("effect/Brand").Brand<"BlockedEmailId">;
|
|
1582
|
-
readonly blockType: "domain" | "email";
|
|
1583
|
-
readonly blockValue: string;
|
|
1584
|
-
readonly reason: string;
|
|
1585
|
-
readonly notes: string | null;
|
|
1586
|
-
readonly isActive: boolean;
|
|
1587
|
-
readonly expiresAt: string | null;
|
|
1588
|
-
readonly createdAt: string;
|
|
1589
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
436
|
+
}) => import("./internal/operation").OperationResult<"emailAddBlock">;
|
|
1590
437
|
export declare const removeBlock: (input: {
|
|
1591
438
|
readonly id: string;
|
|
1592
|
-
}) => import("
|
|
1593
|
-
readonly success: boolean;
|
|
1594
|
-
readonly message: string;
|
|
1595
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
439
|
+
}) => import("./internal/operation").OperationResult<"emailRemoveBlock">;
|
|
1596
440
|
export declare const updateBlock: (input: {
|
|
1597
441
|
readonly id: string;
|
|
1598
442
|
readonly reason?: string | null | undefined;
|
|
1599
443
|
readonly notes?: string | null | undefined;
|
|
1600
444
|
readonly isActive?: boolean | null | undefined;
|
|
1601
445
|
readonly expiresAt?: string | null | undefined;
|
|
1602
|
-
}) => import("
|
|
1603
|
-
readonly id: string & import("effect/Brand").Brand<"BlockedEmailId">;
|
|
1604
|
-
readonly blockType: "domain" | "email";
|
|
1605
|
-
readonly blockValue: string;
|
|
1606
|
-
readonly reason: string;
|
|
1607
|
-
readonly notes: string | null;
|
|
1608
|
-
readonly isActive: boolean;
|
|
1609
|
-
readonly expiresAt: string | null;
|
|
1610
|
-
readonly updatedAt: string;
|
|
1611
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
446
|
+
}) => import("./internal/operation").OperationResult<"emailUpdateBlock">;
|
|
1612
447
|
export declare const getBlockLogs: ((input?: {
|
|
1613
448
|
readonly blockedEmailId?: string | null | undefined;
|
|
1614
449
|
readonly fromAddress?: string | null | undefined;
|
|
@@ -1616,22 +451,7 @@ export declare const getBlockLogs: ((input?: {
|
|
|
1616
451
|
readonly before?: string | null | undefined;
|
|
1617
452
|
readonly limit?: string | null | undefined;
|
|
1618
453
|
readonly cursor?: string | null | undefined;
|
|
1619
|
-
} | undefined) => import("
|
|
1620
|
-
readonly items: readonly {
|
|
1621
|
-
readonly id: string & import("effect/Brand").Brand<"BlockedEmailLogId">;
|
|
1622
|
-
readonly fromAddress: string;
|
|
1623
|
-
readonly toAddress: string;
|
|
1624
|
-
readonly subject: string | null;
|
|
1625
|
-
readonly blockType: "domain" | "email";
|
|
1626
|
-
readonly blockValue: string;
|
|
1627
|
-
readonly blockReason: string;
|
|
1628
|
-
readonly spfResult: "fail" | "neutral" | "none" | "pass" | "permerror" | "policy" | "softfail" | "temperror" | null;
|
|
1629
|
-
readonly dkimResult: "fail" | "neutral" | "none" | "pass" | "permerror" | "policy" | "softfail" | "temperror" | null;
|
|
1630
|
-
readonly dmarcResult: "fail" | "neutral" | "none" | "pass" | "permerror" | "policy" | "softfail" | "temperror" | null;
|
|
1631
|
-
readonly blockedAt: string;
|
|
1632
|
-
}[];
|
|
1633
|
-
readonly nextCursor: string | null;
|
|
1634
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
454
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailGetBlockLogs">) & {
|
|
1635
455
|
readonly pages: (input?: {
|
|
1636
456
|
readonly blockedEmailId?: string | null | undefined;
|
|
1637
457
|
readonly fromAddress?: string | null | undefined;
|
|
@@ -1678,37 +498,11 @@ export declare const getBlockLogs: ((input?: {
|
|
|
1678
498
|
};
|
|
1679
499
|
export declare const checkBlocked: (input: {
|
|
1680
500
|
readonly emailAddress: string;
|
|
1681
|
-
}) => import("
|
|
1682
|
-
readonly isBlocked: boolean;
|
|
1683
|
-
readonly blockingRule: {
|
|
1684
|
-
readonly id: string & import("effect/Brand").Brand<"BlockedEmailId">;
|
|
1685
|
-
readonly blockType: "domain" | "email";
|
|
1686
|
-
readonly blockValue: string;
|
|
1687
|
-
readonly reason: string;
|
|
1688
|
-
readonly expiresAt: string | null;
|
|
1689
|
-
} | null;
|
|
1690
|
-
readonly reason: string | null;
|
|
1691
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
501
|
+
}) => import("./internal/operation").OperationResult<"emailCheckBlocked">;
|
|
1692
502
|
export declare const listForwardingRules: (input?: {
|
|
1693
503
|
readonly domainId?: string | null | undefined;
|
|
1694
504
|
readonly isActive?: string | null | undefined;
|
|
1695
|
-
} | undefined) => import("
|
|
1696
|
-
readonly items: readonly {
|
|
1697
|
-
readonly id: string & import("effect/Brand").Brand<"EmailForwardingRuleId">;
|
|
1698
|
-
readonly name: string;
|
|
1699
|
-
readonly description: string | null;
|
|
1700
|
-
readonly domainId: (string & import("effect/Brand").Brand<"EmailDomainId">) | null;
|
|
1701
|
-
readonly sourcePattern: string | null;
|
|
1702
|
-
readonly forwardTo: readonly string[];
|
|
1703
|
-
readonly preserveHeaders: boolean;
|
|
1704
|
-
readonly priority: number;
|
|
1705
|
-
readonly isActive: boolean;
|
|
1706
|
-
readonly forwardCount: number;
|
|
1707
|
-
readonly failureCount: number;
|
|
1708
|
-
readonly lastForwardedAt: string | null;
|
|
1709
|
-
readonly createdAt: string;
|
|
1710
|
-
}[];
|
|
1711
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
505
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailListForwardingRules">;
|
|
1712
506
|
export declare const createForwardingRule: (input: {
|
|
1713
507
|
readonly name: string;
|
|
1714
508
|
readonly description?: string | null | undefined;
|
|
@@ -1751,20 +545,10 @@ export declare const createForwardingRule: (input: {
|
|
|
1751
545
|
readonly [x: string]: string | number | boolean | any | any | null | undefined;
|
|
1752
546
|
} | null | undefined;
|
|
1753
547
|
} | null | undefined;
|
|
1754
|
-
}) => import("
|
|
1755
|
-
readonly id: string & import("effect/Brand").Brand<"EmailForwardingRuleId">;
|
|
1756
|
-
readonly name: string;
|
|
1757
|
-
readonly forwardTo: readonly string[];
|
|
1758
|
-
readonly priority: number;
|
|
1759
|
-
readonly isActive: boolean;
|
|
1760
|
-
readonly createdAt: string;
|
|
1761
|
-
}, import("./errors").ConflictError | import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
548
|
+
}) => import("./internal/operation").OperationResult<"emailCreateForwardingRule">;
|
|
1762
549
|
export declare const deleteForwardingRule: (input: {
|
|
1763
550
|
readonly id: string;
|
|
1764
|
-
}) => import("
|
|
1765
|
-
readonly success: boolean;
|
|
1766
|
-
readonly message: string;
|
|
1767
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
551
|
+
}) => import("./internal/operation").OperationResult<"emailDeleteForwardingRule">;
|
|
1768
552
|
export declare const updateForwardingRule: (input: {
|
|
1769
553
|
readonly id: string;
|
|
1770
554
|
readonly name?: string | null | undefined;
|
|
@@ -1808,14 +592,7 @@ export declare const updateForwardingRule: (input: {
|
|
|
1808
592
|
readonly [x: string]: string | number | boolean | any | any | null | undefined;
|
|
1809
593
|
} | null | undefined;
|
|
1810
594
|
} | null | undefined;
|
|
1811
|
-
}) => import("
|
|
1812
|
-
readonly id: string & import("effect/Brand").Brand<"EmailForwardingRuleId">;
|
|
1813
|
-
readonly name: string;
|
|
1814
|
-
readonly forwardTo: readonly string[];
|
|
1815
|
-
readonly priority: number;
|
|
1816
|
-
readonly isActive: boolean;
|
|
1817
|
-
readonly updatedAt: string;
|
|
1818
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("./errors").ResourceNotFoundError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>;
|
|
595
|
+
}) => import("./internal/operation").OperationResult<"emailUpdateForwardingRule">;
|
|
1819
596
|
export declare const getForwardingLog: ((input?: {
|
|
1820
597
|
readonly forwardingRuleId?: string | null | undefined;
|
|
1821
598
|
readonly status?: "failed" | "forwarded" | "pending" | null | undefined;
|
|
@@ -1823,22 +600,7 @@ export declare const getForwardingLog: ((input?: {
|
|
|
1823
600
|
readonly before?: string | null | undefined;
|
|
1824
601
|
readonly limit?: string | null | undefined;
|
|
1825
602
|
readonly cursor?: string | null | undefined;
|
|
1826
|
-
} | undefined) => import("
|
|
1827
|
-
readonly items: readonly {
|
|
1828
|
-
readonly id: string;
|
|
1829
|
-
readonly forwardingRuleId: (string & import("effect/Brand").Brand<"EmailForwardingRuleId">) | null;
|
|
1830
|
-
readonly originalFromAddress: string;
|
|
1831
|
-
readonly originalToAddress: string;
|
|
1832
|
-
readonly originalSubject: string | null;
|
|
1833
|
-
readonly forwardedTo: readonly string[];
|
|
1834
|
-
readonly status: "failed" | "forwarded" | "pending";
|
|
1835
|
-
readonly errorMessage: string | null;
|
|
1836
|
-
readonly messageId: (string & import("effect/Brand").Brand<"MessageId">) | null;
|
|
1837
|
-
readonly forwardedAt: string | null;
|
|
1838
|
-
readonly createdAt: string;
|
|
1839
|
-
}[];
|
|
1840
|
-
readonly nextCursor: string | null;
|
|
1841
|
-
}, import("./errors").ForbiddenError | import("./errors").GatewayTimeoutError | import("effect/http/HttpClientError").HttpClientError | import("./errors").InternalError | import("effect/Schema").SchemaError | import("./errors").UnauthorizedError | import("./errors").ValidationError, import("./client").Service>) & {
|
|
603
|
+
} | undefined) => import("./internal/operation").OperationResult<"emailGetForwardingLog">) & {
|
|
1842
604
|
readonly pages: (input?: {
|
|
1843
605
|
readonly forwardingRuleId?: string | null | undefined;
|
|
1844
606
|
readonly status?: "failed" | "forwarded" | "pending" | null | undefined;
|