@apollo-deploy/signal-schemas 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -0
- package/dist/.tsbuildinfo +1 -0
- package/dist/definitions/common.d.ts +72 -0
- package/dist/definitions/common.d.ts.map +1 -0
- package/dist/definitions/common.js +95 -0
- package/dist/definitions/common.js.map +1 -0
- package/dist/definitions/deliverability/deliverability.schema.d.ts +98 -0
- package/dist/definitions/deliverability/deliverability.schema.d.ts.map +1 -0
- package/dist/definitions/deliverability/deliverability.schema.js +77 -0
- package/dist/definitions/deliverability/domain.schema.d.ts +23 -0
- package/dist/definitions/deliverability/domain.schema.d.ts.map +1 -0
- package/dist/definitions/deliverability/domain.schema.js +12 -0
- package/dist/definitions/deliverability/domain.schema.js.map +1 -0
- package/dist/definitions/deliverability/index.d.ts +4 -0
- package/dist/definitions/deliverability/index.d.ts.map +1 -0
- package/dist/definitions/deliverability/index.js +4 -0
- package/dist/definitions/deliverability/index.js.map +1 -0
- package/dist/definitions/deliverability/request.schema.d.ts +27 -0
- package/dist/definitions/deliverability/request.schema.d.ts.map +1 -0
- package/dist/definitions/deliverability/request.schema.js +17 -0
- package/dist/definitions/deliverability/request.schema.js.map +1 -0
- package/dist/definitions/deliverability/response.schema.d.ts +72 -0
- package/dist/definitions/deliverability/response.schema.d.ts.map +1 -0
- package/dist/definitions/deliverability/response.schema.js +37 -0
- package/dist/definitions/deliverability/response.schema.js.map +1 -0
- package/dist/definitions/deliverability/schemas.d.ts +91 -0
- package/dist/definitions/deliverability/schemas.d.ts.map +1 -0
- package/dist/definitions/deliverability/schemas.js +67 -0
- package/dist/definitions/domains/domain.schema.d.ts +160 -0
- package/dist/definitions/domains/domain.schema.d.ts.map +1 -0
- package/dist/definitions/domains/domain.schema.js +36 -0
- package/dist/definitions/domains/domain.schema.js.map +1 -0
- package/dist/definitions/domains/domains.schema.d.ts +668 -0
- package/dist/definitions/domains/domains.schema.d.ts.map +1 -0
- package/dist/definitions/domains/domains.schema.js +113 -0
- package/dist/definitions/domains/index.d.ts +4 -0
- package/dist/definitions/domains/index.d.ts.map +1 -0
- package/dist/definitions/domains/index.js +4 -0
- package/dist/definitions/domains/index.js.map +1 -0
- package/dist/definitions/domains/request.schema.d.ts +26 -0
- package/dist/definitions/domains/request.schema.d.ts.map +1 -0
- package/dist/definitions/domains/request.schema.js +21 -0
- package/dist/definitions/domains/request.schema.js.map +1 -0
- package/dist/definitions/domains/response.schema.d.ts +491 -0
- package/dist/definitions/domains/response.schema.d.ts.map +1 -0
- package/dist/definitions/domains/response.schema.js +24 -0
- package/dist/definitions/domains/response.schema.js.map +1 -0
- package/dist/definitions/domains/schemas.d.ts +545 -0
- package/dist/definitions/domains/schemas.d.ts.map +1 -0
- package/dist/definitions/domains/schemas.js +110 -0
- package/dist/definitions/emails/domain.schema.d.ts +20 -0
- package/dist/definitions/emails/domain.schema.d.ts.map +1 -0
- package/dist/definitions/emails/domain.schema.js +11 -0
- package/dist/definitions/emails/domain.schema.js.map +1 -0
- package/dist/definitions/emails/emails.schema.d.ts +230 -0
- package/dist/definitions/emails/emails.schema.d.ts.map +1 -0
- package/dist/definitions/emails/emails.schema.js +176 -0
- package/dist/definitions/emails/index.d.ts +4 -0
- package/dist/definitions/emails/index.d.ts.map +1 -0
- package/dist/definitions/emails/index.js +4 -0
- package/dist/definitions/emails/index.js.map +1 -0
- package/dist/definitions/emails/request.schema.d.ts +96 -0
- package/dist/definitions/emails/request.schema.d.ts.map +1 -0
- package/dist/definitions/emails/request.schema.js +65 -0
- package/dist/definitions/emails/request.schema.js.map +1 -0
- package/dist/definitions/emails/response.schema.d.ts +141 -0
- package/dist/definitions/emails/response.schema.d.ts.map +1 -0
- package/dist/definitions/emails/response.schema.js +54 -0
- package/dist/definitions/emails/response.schema.js.map +1 -0
- package/dist/definitions/emails/schemas.d.ts +284 -0
- package/dist/definitions/emails/schemas.d.ts.map +1 -0
- package/dist/definitions/emails/schemas.js +227 -0
- package/dist/definitions/health/domain.schema.d.ts +11 -0
- package/dist/definitions/health/domain.schema.d.ts.map +1 -0
- package/dist/definitions/health/domain.schema.js +8 -0
- package/dist/definitions/health/domain.schema.js.map +1 -0
- package/dist/definitions/health/health.schema.d.ts +27 -0
- package/dist/definitions/health/health.schema.d.ts.map +1 -0
- package/dist/definitions/health/health.schema.js +23 -0
- package/dist/definitions/health/index.d.ts +3 -0
- package/dist/definitions/health/index.d.ts.map +1 -0
- package/dist/definitions/health/index.js +3 -0
- package/dist/definitions/health/index.js.map +1 -0
- package/dist/definitions/health/request.schema.d.ts +8 -0
- package/dist/definitions/health/request.schema.d.ts.map +1 -0
- package/dist/definitions/health/request.schema.js +8 -0
- package/dist/definitions/health/request.schema.js.map +1 -0
- package/dist/definitions/health/response.schema.d.ts +26 -0
- package/dist/definitions/health/response.schema.d.ts.map +1 -0
- package/dist/definitions/health/response.schema.js +16 -0
- package/dist/definitions/health/response.schema.js.map +1 -0
- package/dist/definitions/health/schemas.d.ts +30 -0
- package/dist/definitions/health/schemas.d.ts.map +1 -0
- package/dist/definitions/health/schemas.js +23 -0
- package/dist/definitions/index.d.ts +25 -0
- package/dist/definitions/index.d.ts.map +1 -0
- package/dist/definitions/index.js +25 -0
- package/dist/definitions/index.js.map +1 -0
- package/dist/definitions/projects/domain.schema.d.ts +42 -0
- package/dist/definitions/projects/domain.schema.d.ts.map +1 -0
- package/dist/definitions/projects/domain.schema.js +46 -0
- package/dist/definitions/projects/domain.schema.js.map +1 -0
- package/dist/definitions/projects/index.d.ts +4 -0
- package/dist/definitions/projects/index.d.ts.map +1 -0
- package/dist/definitions/projects/index.js +4 -0
- package/dist/definitions/projects/index.js.map +1 -0
- package/dist/definitions/projects/projects.schema.d.ts +8 -0
- package/dist/definitions/projects/projects.schema.d.ts.map +1 -0
- package/dist/definitions/projects/projects.schema.js +23 -0
- package/dist/definitions/projects/request.schema.d.ts +41 -0
- package/dist/definitions/projects/request.schema.d.ts.map +1 -0
- package/dist/definitions/projects/request.schema.js +43 -0
- package/dist/definitions/projects/request.schema.js.map +1 -0
- package/dist/definitions/projects/response.schema.d.ts +79 -0
- package/dist/definitions/projects/response.schema.d.ts.map +1 -0
- package/dist/definitions/projects/response.schema.js +43 -0
- package/dist/definitions/projects/response.schema.js.map +1 -0
- package/dist/definitions/projects/schemas.d.ts +114 -0
- package/dist/definitions/projects/schemas.d.ts.map +1 -0
- package/dist/definitions/projects/schemas.js +87 -0
- package/dist/definitions/signal-email/domain.schema.d.ts +135 -0
- package/dist/definitions/signal-email/domain.schema.d.ts.map +1 -0
- package/dist/definitions/signal-email/domain.schema.js +130 -0
- package/dist/definitions/signal-email/domain.schema.js.map +1 -0
- package/dist/definitions/signal-email/index.d.ts +23 -0
- package/dist/definitions/signal-email/index.d.ts.map +1 -0
- package/dist/definitions/signal-email/index.js +26 -0
- package/dist/definitions/signal-email/index.js.map +1 -0
- package/dist/definitions/signal-email/request.schema.d.ts +123 -0
- package/dist/definitions/signal-email/request.schema.d.ts.map +1 -0
- package/dist/definitions/signal-email/request.schema.js +201 -0
- package/dist/definitions/signal-email/request.schema.js.map +1 -0
- package/dist/definitions/signal-email/response.schema.d.ts +73 -0
- package/dist/definitions/signal-email/response.schema.d.ts.map +1 -0
- package/dist/definitions/signal-email/response.schema.js +83 -0
- package/dist/definitions/signal-email/response.schema.js.map +1 -0
- package/dist/definitions/signal-projects/domain.schema.d.ts +227 -0
- package/dist/definitions/signal-projects/domain.schema.d.ts.map +1 -0
- package/dist/definitions/signal-projects/domain.schema.js +230 -0
- package/dist/definitions/signal-projects/domain.schema.js.map +1 -0
- package/dist/definitions/signal-projects/index.d.ts +16 -0
- package/dist/definitions/signal-projects/index.d.ts.map +1 -0
- package/dist/definitions/signal-projects/index.js +16 -0
- package/dist/definitions/signal-projects/index.js.map +1 -0
- package/dist/definitions/signal-projects/request.schema.d.ts +254 -0
- package/dist/definitions/signal-projects/request.schema.d.ts.map +1 -0
- package/dist/definitions/signal-projects/request.schema.js +213 -0
- package/dist/definitions/signal-projects/request.schema.js.map +1 -0
- package/dist/definitions/signal-projects/response.schema.d.ts +615 -0
- package/dist/definitions/signal-projects/response.schema.d.ts.map +1 -0
- package/dist/definitions/signal-projects/response.schema.js +267 -0
- package/dist/definitions/signal-projects/response.schema.js.map +1 -0
- package/dist/definitions/suppressions/domain.schema.d.ts +13 -0
- package/dist/definitions/suppressions/domain.schema.d.ts.map +1 -0
- package/dist/definitions/suppressions/domain.schema.js +8 -0
- package/dist/definitions/suppressions/domain.schema.js.map +1 -0
- package/dist/definitions/suppressions/index.d.ts +4 -0
- package/dist/definitions/suppressions/index.d.ts.map +1 -0
- package/dist/definitions/suppressions/index.js +4 -0
- package/dist/definitions/suppressions/index.js.map +1 -0
- package/dist/definitions/suppressions/request.schema.d.ts +39 -0
- package/dist/definitions/suppressions/request.schema.d.ts.map +1 -0
- package/dist/definitions/suppressions/request.schema.js +27 -0
- package/dist/definitions/suppressions/request.schema.js.map +1 -0
- package/dist/definitions/suppressions/response.schema.d.ts +42 -0
- package/dist/definitions/suppressions/response.schema.d.ts.map +1 -0
- package/dist/definitions/suppressions/response.schema.js +18 -0
- package/dist/definitions/suppressions/response.schema.js.map +1 -0
- package/dist/definitions/suppressions/schemas.d.ts +90 -0
- package/dist/definitions/suppressions/schemas.d.ts.map +1 -0
- package/dist/definitions/suppressions/schemas.js +68 -0
- package/dist/definitions/suppressions/suppressions.schema.d.ts +79 -0
- package/dist/definitions/suppressions/suppressions.schema.d.ts.map +1 -0
- package/dist/definitions/suppressions/suppressions.schema.js +63 -0
- package/dist/definitions/templates/domain.schema.d.ts +11 -0
- package/dist/definitions/templates/domain.schema.d.ts.map +1 -0
- package/dist/definitions/templates/domain.schema.js +14 -0
- package/dist/definitions/templates/domain.schema.js.map +1 -0
- package/dist/definitions/templates/index.d.ts +4 -0
- package/dist/definitions/templates/index.d.ts.map +1 -0
- package/dist/definitions/templates/index.js +4 -0
- package/dist/definitions/templates/index.js.map +1 -0
- package/dist/definitions/templates/request.schema.d.ts +33 -0
- package/dist/definitions/templates/request.schema.d.ts.map +1 -0
- package/dist/definitions/templates/request.schema.js +32 -0
- package/dist/definitions/templates/request.schema.js.map +1 -0
- package/dist/definitions/templates/response.schema.d.ts +91 -0
- package/dist/definitions/templates/response.schema.d.ts.map +1 -0
- package/dist/definitions/templates/response.schema.js +49 -0
- package/dist/definitions/templates/response.schema.js.map +1 -0
- package/dist/definitions/templates/schemas.d.ts +113 -0
- package/dist/definitions/templates/schemas.d.ts.map +1 -0
- package/dist/definitions/templates/schemas.js +80 -0
- package/dist/definitions/usage/domain.schema.d.ts +60 -0
- package/dist/definitions/usage/domain.schema.d.ts.map +1 -0
- package/dist/definitions/usage/domain.schema.js +23 -0
- package/dist/definitions/usage/domain.schema.js.map +1 -0
- package/dist/definitions/usage/index.d.ts +4 -0
- package/dist/definitions/usage/index.d.ts.map +1 -0
- package/dist/definitions/usage/index.js +4 -0
- package/dist/definitions/usage/index.js.map +1 -0
- package/dist/definitions/usage/request.schema.d.ts +12 -0
- package/dist/definitions/usage/request.schema.d.ts.map +1 -0
- package/dist/definitions/usage/request.schema.js +13 -0
- package/dist/definitions/usage/request.schema.js.map +1 -0
- package/dist/definitions/usage/response.schema.d.ts +76 -0
- package/dist/definitions/usage/response.schema.d.ts.map +1 -0
- package/dist/definitions/usage/response.schema.js +22 -0
- package/dist/definitions/usage/response.schema.js.map +1 -0
- package/dist/definitions/usage/schemas.d.ts +156 -0
- package/dist/definitions/usage/schemas.d.ts.map +1 -0
- package/dist/definitions/usage/schemas.js +83 -0
- package/dist/definitions/usage/usage.schema.d.ts +140 -0
- package/dist/definitions/usage/usage.schema.d.ts.map +1 -0
- package/dist/definitions/usage/usage.schema.js +77 -0
- package/dist/definitions/webhooks/domain.schema.d.ts +26 -0
- package/dist/definitions/webhooks/domain.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/domain.schema.js +14 -0
- package/dist/definitions/webhooks/domain.schema.js.map +1 -0
- package/dist/definitions/webhooks/index.d.ts +4 -0
- package/dist/definitions/webhooks/index.d.ts.map +1 -0
- package/dist/definitions/webhooks/index.js +4 -0
- package/dist/definitions/webhooks/index.js.map +1 -0
- package/dist/definitions/webhooks/request.schema.d.ts +64 -0
- package/dist/definitions/webhooks/request.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/request.schema.js +32 -0
- package/dist/definitions/webhooks/request.schema.js.map +1 -0
- package/dist/definitions/webhooks/response.schema.d.ts +76 -0
- package/dist/definitions/webhooks/response.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/response.schema.js +27 -0
- package/dist/definitions/webhooks/response.schema.js.map +1 -0
- package/dist/definitions/webhooks/schemas.d.ts +145 -0
- package/dist/definitions/webhooks/schemas.d.ts.map +1 -0
- package/dist/definitions/webhooks/schemas.js +97 -0
- package/dist/definitions/webhooks/webhooks.schema.d.ts +152 -0
- package/dist/definitions/webhooks/webhooks.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/webhooks.schema.js +96 -0
- package/dist/generators/generate-schemas.d.ts +10 -0
- package/dist/generators/generate-schemas.d.ts.map +1 -0
- package/dist/generators/generate-schemas.js +119 -0
- package/dist/generators/generate-schemas.js.map +1 -0
- package/dist/generators/index.d.ts +8 -0
- package/dist/generators/index.d.ts.map +1 -0
- package/dist/generators/index.js +8 -0
- package/dist/generators/index.js.map +1 -0
- package/dist/generators/register-global-registry.d.ts +14 -0
- package/dist/generators/register-global-registry.d.ts.map +1 -0
- package/dist/generators/register-global-registry.js +516 -0
- package/dist/generators/register-global-registry.js.map +1 -0
- package/dist/generators/zod-to-json-schema.d.ts +64 -0
- package/dist/generators/zod-to-json-schema.d.ts.map +1 -0
- package/dist/generators/zod-to-json-schema.js +300 -0
- package/dist/generators/zod-to-json-schema.js.map +1 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/package.json +103 -0
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Apollo Signal — Internal domain (sending domain) schemas.
|
|
4
|
+
*
|
|
5
|
+
* Zod schemas for domain register/verify/list requests and domain response.
|
|
6
|
+
* Internal only — MUST NOT be exported to shared packages.
|
|
7
|
+
*
|
|
8
|
+
* Design §5.3 ; Requirements §3, §4
|
|
9
|
+
*/
|
|
10
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
+
exports.DomainListQuerySchema = exports.DomainParamsSchema = exports.DomainListResponseSchema = exports.DomainVerifyResponseSchema = exports.DomainDnsCheckSchema = exports.DkimDnsCheckRecordSchema = exports.DomainResponseSchema = exports.ListDomainsQuerySchema = exports.DomainIdParamSchema = exports.RegisterDomainBodySchema = void 0;
|
|
12
|
+
var zod_1 = require("zod");
|
|
13
|
+
// ---------------------------------------------------------------------------
|
|
14
|
+
// Pagination
|
|
15
|
+
// ---------------------------------------------------------------------------
|
|
16
|
+
/** Cursor-based page metadata — no totalPages (not supported by cursor pagination). */
|
|
17
|
+
var CursorPageSchema = zod_1.z.object({
|
|
18
|
+
size: zod_1.z.number().int().min(0),
|
|
19
|
+
hasMore: zod_1.z.boolean(),
|
|
20
|
+
});
|
|
21
|
+
// ---------------------------------------------------------------------------
|
|
22
|
+
// Sub-schemas
|
|
23
|
+
// ---------------------------------------------------------------------------
|
|
24
|
+
var VerificationRecordSchema = zod_1.z.object({
|
|
25
|
+
name: zod_1.z.string(),
|
|
26
|
+
type: zod_1.z.string(),
|
|
27
|
+
value: zod_1.z.string(),
|
|
28
|
+
priority: zod_1.z.number().int().optional(),
|
|
29
|
+
optional: zod_1.z.boolean().optional(),
|
|
30
|
+
status: zod_1.z.enum(["pending", "verified", "failed", "missing", "monitor", "quarantine", "reject", "unknown", "not_applicable"]).optional(),
|
|
31
|
+
});
|
|
32
|
+
var VerificationRecordsSchema = zod_1.z.object({
|
|
33
|
+
dkim: zod_1.z.array(VerificationRecordSchema).optional(),
|
|
34
|
+
mailFromMx: VerificationRecordSchema.optional(),
|
|
35
|
+
mailFromSpf: VerificationRecordSchema.optional(),
|
|
36
|
+
dmarcRecommended: VerificationRecordSchema.optional(),
|
|
37
|
+
bimi: VerificationRecordSchema.optional(),
|
|
38
|
+
});
|
|
39
|
+
var DomainSubStatusSchema = zod_1.z.enum([
|
|
40
|
+
"pending",
|
|
41
|
+
"verified",
|
|
42
|
+
"failed",
|
|
43
|
+
"missing",
|
|
44
|
+
"monitor",
|
|
45
|
+
"quarantine",
|
|
46
|
+
"reject",
|
|
47
|
+
"unknown",
|
|
48
|
+
]);
|
|
49
|
+
// ---------------------------------------------------------------------------
|
|
50
|
+
// Request schemas
|
|
51
|
+
// ---------------------------------------------------------------------------
|
|
52
|
+
exports.RegisterDomainBodySchema = zod_1.z.object({
|
|
53
|
+
domain: zod_1.z.string().min(1).max(253),
|
|
54
|
+
region: zod_1.z.enum(["us-east-1", "af-south-1", "eu-west-1", "ap-southeast-1"]),
|
|
55
|
+
});
|
|
56
|
+
exports.DomainIdParamSchema = zod_1.z.object({
|
|
57
|
+
projectId: zod_1.z.string().min(1),
|
|
58
|
+
domainId: zod_1.z.string().min(1),
|
|
59
|
+
});
|
|
60
|
+
exports.ListDomainsQuerySchema = zod_1.z.object({
|
|
61
|
+
limit: zod_1.z.coerce.number().int().min(1).max(100).default(25),
|
|
62
|
+
cursor: zod_1.z.string().optional(),
|
|
63
|
+
});
|
|
64
|
+
// ---------------------------------------------------------------------------
|
|
65
|
+
// Response schema
|
|
66
|
+
// ---------------------------------------------------------------------------
|
|
67
|
+
exports.DomainResponseSchema = zod_1.z.object({
|
|
68
|
+
id: zod_1.z.string(),
|
|
69
|
+
projectId: zod_1.z.string(),
|
|
70
|
+
domain: zod_1.z.string(),
|
|
71
|
+
region: zod_1.z.string(),
|
|
72
|
+
status: zod_1.z.enum(["pending", "verified", "failed", "deleted", "degraded"]),
|
|
73
|
+
dkimStatus: DomainSubStatusSchema,
|
|
74
|
+
spfStatus: DomainSubStatusSchema,
|
|
75
|
+
dmarcStatus: DomainSubStatusSchema,
|
|
76
|
+
mailFromStatus: DomainSubStatusSchema,
|
|
77
|
+
mailFromDomain: zod_1.z.string(),
|
|
78
|
+
verificationRecords: VerificationRecordsSchema,
|
|
79
|
+
bimiStatus: zod_1.z.enum(["unknown", "pending", "verified", "failed", "not_applicable"]),
|
|
80
|
+
bimiLogoUrl: zod_1.z.string().nullable(),
|
|
81
|
+
createdAt: zod_1.z.string().datetime(),
|
|
82
|
+
updatedAt: zod_1.z.string().datetime(),
|
|
83
|
+
verifiedAt: zod_1.z.string().datetime().nullable(),
|
|
84
|
+
});
|
|
85
|
+
// ---------------------------------------------------------------------------
|
|
86
|
+
// DNS check schemas (verify endpoint enrichment — not persisted)
|
|
87
|
+
// ---------------------------------------------------------------------------
|
|
88
|
+
exports.DkimDnsCheckRecordSchema = zod_1.z.object({
|
|
89
|
+
name: zod_1.z.string(),
|
|
90
|
+
found: zod_1.z.boolean(),
|
|
91
|
+
resolvedValue: zod_1.z.string().nullable(),
|
|
92
|
+
});
|
|
93
|
+
exports.DomainDnsCheckSchema = zod_1.z.object({
|
|
94
|
+
dkimRecordsDetected: zod_1.z.boolean(),
|
|
95
|
+
dkimRecords: zod_1.z.array(exports.DkimDnsCheckRecordSchema),
|
|
96
|
+
});
|
|
97
|
+
exports.DomainVerifyResponseSchema = exports.DomainResponseSchema.extend({
|
|
98
|
+
dnsCheck: exports.DomainDnsCheckSchema,
|
|
99
|
+
});
|
|
100
|
+
exports.DomainListResponseSchema = zod_1.z.object({
|
|
101
|
+
data: zod_1.z.array(exports.DomainResponseSchema),
|
|
102
|
+
page: CursorPageSchema,
|
|
103
|
+
});
|
|
104
|
+
// ---------------------------------------------------------------------------
|
|
105
|
+
// Aliases (task-spec canonical names)
|
|
106
|
+
// ---------------------------------------------------------------------------
|
|
107
|
+
/** Alias for {@link DomainIdParamSchema} — canonical name per T-7.1. */
|
|
108
|
+
exports.DomainParamsSchema = exports.DomainIdParamSchema;
|
|
109
|
+
/** Alias for {@link ListDomainsQuerySchema} — canonical name per T-7.1. */
|
|
110
|
+
exports.DomainListQuerySchema = exports.ListDomainsQuerySchema;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Apollo Signal — Emails Domain Schemas
|
|
3
|
+
* Subpath: @apollo-deploy/signal-schemas/emails
|
|
4
|
+
*/
|
|
5
|
+
import { z } from 'zod';
|
|
6
|
+
export declare const EmailStatusSchema: z.ZodEnum<{
|
|
7
|
+
failed: "failed";
|
|
8
|
+
queued: "queued";
|
|
9
|
+
scheduled: "scheduled";
|
|
10
|
+
cancelled: "cancelled";
|
|
11
|
+
sent: "sent";
|
|
12
|
+
delivered: "delivered";
|
|
13
|
+
bounced: "bounced";
|
|
14
|
+
complained: "complained";
|
|
15
|
+
rejected: "rejected";
|
|
16
|
+
suppressed: "suppressed";
|
|
17
|
+
test: "test";
|
|
18
|
+
}>;
|
|
19
|
+
export type EmailStatus = z.infer<typeof EmailStatusSchema>;
|
|
20
|
+
//# sourceMappingURL=domain.schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/emails/domain.schema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,iBAAiB;;;;;;;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Apollo Signal — Emails Domain Schemas
|
|
3
|
+
* Subpath: @apollo-deploy/signal-schemas/emails
|
|
4
|
+
*/
|
|
5
|
+
import { z } from 'zod';
|
|
6
|
+
export const EmailStatusSchema = z.enum([
|
|
7
|
+
'queued', 'scheduled', 'cancelled', 'sent', 'delivered',
|
|
8
|
+
'bounced', 'complained', 'failed', 'rejected', 'suppressed', 'test',
|
|
9
|
+
]);
|
|
10
|
+
z.globalRegistry.add(EmailStatusSchema, { id: 'EmailStatus' });
|
|
11
|
+
//# sourceMappingURL=domain.schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain.schema.js","sourceRoot":"","sources":["../../../src/definitions/emails/domain.schema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC;IACtC,QAAQ,EAAC,WAAW,EAAC,WAAW,EAAC,MAAM,EAAC,WAAW;IACnD,SAAS,EAAC,YAAY,EAAC,QAAQ,EAAC,UAAU,EAAC,YAAY,EAAC,MAAM;CAC/D,CAAC,CAAC;AAGH,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC","sourcesContent":["/**\n * Apollo Signal — Emails Domain Schemas\n * Subpath: @apollo-deploy/signal-schemas/emails\n */\nimport { z } from 'zod';\n\nexport const EmailStatusSchema = z.enum([\n 'queued','scheduled','cancelled','sent','delivered',\n 'bounced','complained','failed','rejected','suppressed','test',\n]);\n\nexport type EmailStatus = z.infer<typeof EmailStatusSchema>;\nz.globalRegistry.add(EmailStatusSchema, { id: 'EmailStatus' });\n"]}
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Apollo Signal — Email Schemas
|
|
3
|
+
*
|
|
4
|
+
* Request, response and domain schemas for the Signal email API.
|
|
5
|
+
* Covers: send, batch-send, list, events, stream, suppression import.
|
|
6
|
+
*
|
|
7
|
+
* Subpath: @apollo-deploy/signal-schemas/emails
|
|
8
|
+
*/
|
|
9
|
+
import { z } from 'zod';
|
|
10
|
+
export declare const SendEmailBodySchema: z.ZodObject<{
|
|
11
|
+
from: z.ZodString;
|
|
12
|
+
to: z.ZodArray<z.ZodString>;
|
|
13
|
+
cc: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
14
|
+
bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
15
|
+
replyTo: z.ZodOptional<z.ZodString>;
|
|
16
|
+
subject: z.ZodString;
|
|
17
|
+
html: z.ZodOptional<z.ZodString>;
|
|
18
|
+
text: z.ZodOptional<z.ZodString>;
|
|
19
|
+
tags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
20
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
21
|
+
idempotencyKey: z.ZodOptional<z.ZodString>;
|
|
22
|
+
testMode: z.ZodOptional<z.ZodBoolean>;
|
|
23
|
+
}, z.core.$strip>;
|
|
24
|
+
export declare const EmailIdParamSchema: z.ZodObject<{
|
|
25
|
+
emailId: z.ZodString;
|
|
26
|
+
}, z.core.$strip>;
|
|
27
|
+
export declare const EmailParamsSchema: z.ZodObject<{
|
|
28
|
+
projectId: z.ZodString;
|
|
29
|
+
emailId: z.ZodString;
|
|
30
|
+
}, z.core.$strip>;
|
|
31
|
+
export declare const EmailProjectParamSchema: z.ZodObject<{
|
|
32
|
+
projectId: z.ZodString;
|
|
33
|
+
}, z.core.$strip>;
|
|
34
|
+
export declare const ListEmailsQuerySchema: z.ZodObject<{
|
|
35
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
36
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
37
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
38
|
+
failed: "failed";
|
|
39
|
+
queued: "queued";
|
|
40
|
+
scheduled: "scheduled";
|
|
41
|
+
cancelled: "cancelled";
|
|
42
|
+
sent: "sent";
|
|
43
|
+
delivered: "delivered";
|
|
44
|
+
bounced: "bounced";
|
|
45
|
+
complained: "complained";
|
|
46
|
+
rejected: "rejected";
|
|
47
|
+
suppressed: "suppressed";
|
|
48
|
+
test: "test";
|
|
49
|
+
}>>;
|
|
50
|
+
from: z.ZodOptional<z.ZodString>;
|
|
51
|
+
to: z.ZodOptional<z.ZodString>;
|
|
52
|
+
tag: z.ZodOptional<z.ZodString>;
|
|
53
|
+
since: z.ZodOptional<z.ZodString>;
|
|
54
|
+
until: z.ZodOptional<z.ZodString>;
|
|
55
|
+
}, z.core.$strip>;
|
|
56
|
+
export declare const SendEmailResponseSchema: z.ZodObject<{
|
|
57
|
+
id: z.ZodString;
|
|
58
|
+
messageId: z.ZodNullable<z.ZodString>;
|
|
59
|
+
status: z.ZodEnum<{
|
|
60
|
+
scheduled: "scheduled";
|
|
61
|
+
sent: "sent";
|
|
62
|
+
test: "test";
|
|
63
|
+
}>;
|
|
64
|
+
createdAt: z.ZodString;
|
|
65
|
+
scheduledAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
66
|
+
}, z.core.$strip>;
|
|
67
|
+
export declare const CancelEmailParamSchema: z.ZodObject<{
|
|
68
|
+
emailId: z.ZodString;
|
|
69
|
+
}, z.core.$strip>;
|
|
70
|
+
export declare const CancelEmailResponseSchema: z.ZodObject<{
|
|
71
|
+
cancelled: z.ZodLiteral<true>;
|
|
72
|
+
}, z.core.$strip>;
|
|
73
|
+
export declare const BulkCancelScheduledQuerySchema: z.ZodObject<{
|
|
74
|
+
from: z.ZodOptional<z.ZodString>;
|
|
75
|
+
to: z.ZodOptional<z.ZodString>;
|
|
76
|
+
}, z.core.$strip>;
|
|
77
|
+
export declare const BulkCancelScheduledResponseSchema: z.ZodObject<{
|
|
78
|
+
cancelled: z.ZodNumber;
|
|
79
|
+
}, z.core.$strip>;
|
|
80
|
+
export declare const StreamTokenResponseSchema: z.ZodObject<{
|
|
81
|
+
token: z.ZodString;
|
|
82
|
+
expiresAt: z.ZodString;
|
|
83
|
+
}, z.core.$strip>;
|
|
84
|
+
export declare const StreamQuerySchema: z.ZodObject<{
|
|
85
|
+
token: z.ZodString;
|
|
86
|
+
}, z.core.$strip>;
|
|
87
|
+
export declare const SuppressionImportBodySchema: z.ZodObject<{
|
|
88
|
+
suppressions: z.ZodArray<z.ZodObject<{
|
|
89
|
+
email: z.ZodString;
|
|
90
|
+
reason: z.ZodDefault<z.ZodEnum<{
|
|
91
|
+
bounce: "bounce";
|
|
92
|
+
complaint: "complaint";
|
|
93
|
+
manual: "manual";
|
|
94
|
+
unsubscribe: "unsubscribe";
|
|
95
|
+
}>>;
|
|
96
|
+
}, z.core.$strip>>;
|
|
97
|
+
}, z.core.$strip>;
|
|
98
|
+
export declare const SuppressionImportResponseSchema: z.ZodObject<{
|
|
99
|
+
imported: z.ZodNumber;
|
|
100
|
+
skipped: z.ZodNumber;
|
|
101
|
+
}, z.core.$strip>;
|
|
102
|
+
export declare const EmailResponseSchema: z.ZodObject<{
|
|
103
|
+
id: z.ZodString;
|
|
104
|
+
projectId: z.ZodString;
|
|
105
|
+
organizationId: z.ZodString;
|
|
106
|
+
apiKeyId: z.ZodNullable<z.ZodString>;
|
|
107
|
+
domainId: z.ZodNullable<z.ZodString>;
|
|
108
|
+
provider: z.ZodLiteral<"ses">;
|
|
109
|
+
providerMessageId: z.ZodNullable<z.ZodString>;
|
|
110
|
+
fromAddress: z.ZodString;
|
|
111
|
+
fromDomain: z.ZodString;
|
|
112
|
+
toRecipients: z.ZodArray<z.ZodString>;
|
|
113
|
+
ccRecipients: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
114
|
+
bccRecipients: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
115
|
+
replyTo: z.ZodNullable<z.ZodString>;
|
|
116
|
+
subject: z.ZodString;
|
|
117
|
+
status: z.ZodEnum<{
|
|
118
|
+
failed: "failed";
|
|
119
|
+
queued: "queued";
|
|
120
|
+
scheduled: "scheduled";
|
|
121
|
+
cancelled: "cancelled";
|
|
122
|
+
sent: "sent";
|
|
123
|
+
delivered: "delivered";
|
|
124
|
+
bounced: "bounced";
|
|
125
|
+
complained: "complained";
|
|
126
|
+
rejected: "rejected";
|
|
127
|
+
suppressed: "suppressed";
|
|
128
|
+
test: "test";
|
|
129
|
+
}>;
|
|
130
|
+
error: z.ZodNullable<z.ZodString>;
|
|
131
|
+
tags: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
132
|
+
testMode: z.ZodBoolean;
|
|
133
|
+
createdAt: z.ZodString;
|
|
134
|
+
sentAt: z.ZodNullable<z.ZodString>;
|
|
135
|
+
updatedAt: z.ZodString;
|
|
136
|
+
}, z.core.$strip>;
|
|
137
|
+
export declare const EmailListResponseSchema: z.ZodObject<{
|
|
138
|
+
data: z.ZodArray<z.ZodObject<{
|
|
139
|
+
id: z.ZodString;
|
|
140
|
+
projectId: z.ZodString;
|
|
141
|
+
organizationId: z.ZodString;
|
|
142
|
+
apiKeyId: z.ZodNullable<z.ZodString>;
|
|
143
|
+
domainId: z.ZodNullable<z.ZodString>;
|
|
144
|
+
provider: z.ZodLiteral<"ses">;
|
|
145
|
+
providerMessageId: z.ZodNullable<z.ZodString>;
|
|
146
|
+
fromAddress: z.ZodString;
|
|
147
|
+
fromDomain: z.ZodString;
|
|
148
|
+
toRecipients: z.ZodArray<z.ZodString>;
|
|
149
|
+
ccRecipients: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
150
|
+
bccRecipients: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
151
|
+
replyTo: z.ZodNullable<z.ZodString>;
|
|
152
|
+
subject: z.ZodString;
|
|
153
|
+
status: z.ZodEnum<{
|
|
154
|
+
failed: "failed";
|
|
155
|
+
queued: "queued";
|
|
156
|
+
scheduled: "scheduled";
|
|
157
|
+
cancelled: "cancelled";
|
|
158
|
+
sent: "sent";
|
|
159
|
+
delivered: "delivered";
|
|
160
|
+
bounced: "bounced";
|
|
161
|
+
complained: "complained";
|
|
162
|
+
rejected: "rejected";
|
|
163
|
+
suppressed: "suppressed";
|
|
164
|
+
test: "test";
|
|
165
|
+
}>;
|
|
166
|
+
error: z.ZodNullable<z.ZodString>;
|
|
167
|
+
tags: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
168
|
+
testMode: z.ZodBoolean;
|
|
169
|
+
createdAt: z.ZodString;
|
|
170
|
+
sentAt: z.ZodNullable<z.ZodString>;
|
|
171
|
+
updatedAt: z.ZodString;
|
|
172
|
+
}, z.core.$strip>>;
|
|
173
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
174
|
+
}, z.core.$strip>;
|
|
175
|
+
export declare const EmailEventResponseSchema: z.ZodObject<{
|
|
176
|
+
id: z.ZodString;
|
|
177
|
+
type: z.ZodString;
|
|
178
|
+
providerEventId: z.ZodNullable<z.ZodString>;
|
|
179
|
+
payload: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
180
|
+
occurredAt: z.ZodString;
|
|
181
|
+
createdAt: z.ZodString;
|
|
182
|
+
}, z.core.$strip>;
|
|
183
|
+
export declare const EmailEventsListResponseSchema: z.ZodObject<{
|
|
184
|
+
data: z.ZodArray<z.ZodObject<{
|
|
185
|
+
id: z.ZodString;
|
|
186
|
+
type: z.ZodString;
|
|
187
|
+
providerEventId: z.ZodNullable<z.ZodString>;
|
|
188
|
+
payload: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
189
|
+
occurredAt: z.ZodString;
|
|
190
|
+
createdAt: z.ZodString;
|
|
191
|
+
}, z.core.$strip>>;
|
|
192
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
193
|
+
}, z.core.$strip>;
|
|
194
|
+
export declare const PreSendValidationBodySchema: z.ZodObject<{
|
|
195
|
+
from: z.ZodString;
|
|
196
|
+
to: z.ZodArray<z.ZodString>;
|
|
197
|
+
subject: z.ZodString;
|
|
198
|
+
html: z.ZodOptional<z.ZodString>;
|
|
199
|
+
text: z.ZodOptional<z.ZodString>;
|
|
200
|
+
scheduledAt: z.ZodOptional<z.ZodString>;
|
|
201
|
+
}, z.core.$strip>;
|
|
202
|
+
export declare const PreSendValidationResponseSchema: z.ZodObject<{
|
|
203
|
+
valid: z.ZodBoolean;
|
|
204
|
+
checks: z.ZodArray<z.ZodObject<{
|
|
205
|
+
name: z.ZodString;
|
|
206
|
+
passed: z.ZodBoolean;
|
|
207
|
+
message: z.ZodOptional<z.ZodString>;
|
|
208
|
+
}, z.core.$strip>>;
|
|
209
|
+
}, z.core.$strip>;
|
|
210
|
+
export type SendEmailBody = z.infer<typeof SendEmailBodySchema>;
|
|
211
|
+
export type EmailIdParam = z.infer<typeof EmailIdParamSchema>;
|
|
212
|
+
export type EmailParams = z.infer<typeof EmailParamsSchema>;
|
|
213
|
+
export type EmailProjectParam = z.infer<typeof EmailProjectParamSchema>;
|
|
214
|
+
export type ListEmailsQuery = z.infer<typeof ListEmailsQuerySchema>;
|
|
215
|
+
export type SendEmailResponse = z.infer<typeof SendEmailResponseSchema>;
|
|
216
|
+
export type CancelEmailParam = z.infer<typeof CancelEmailParamSchema>;
|
|
217
|
+
export type CancelEmailResponse = z.infer<typeof CancelEmailResponseSchema>;
|
|
218
|
+
export type BulkCancelScheduledQuery = z.infer<typeof BulkCancelScheduledQuerySchema>;
|
|
219
|
+
export type BulkCancelScheduledResponse = z.infer<typeof BulkCancelScheduledResponseSchema>;
|
|
220
|
+
export type StreamTokenResponse = z.infer<typeof StreamTokenResponseSchema>;
|
|
221
|
+
export type StreamQuery = z.infer<typeof StreamQuerySchema>;
|
|
222
|
+
export type SuppressionImportBody = z.infer<typeof SuppressionImportBodySchema>;
|
|
223
|
+
export type SuppressionImportResponse = z.infer<typeof SuppressionImportResponseSchema>;
|
|
224
|
+
export type EmailResponse = z.infer<typeof EmailResponseSchema>;
|
|
225
|
+
export type EmailListResponse = z.infer<typeof EmailListResponseSchema>;
|
|
226
|
+
export type EmailEventResponse = z.infer<typeof EmailEventResponseSchema>;
|
|
227
|
+
export type EmailEventsListResponse = z.infer<typeof EmailEventsListResponseSchema>;
|
|
228
|
+
export type PreSendValidationBody = z.infer<typeof PreSendValidationBodySchema>;
|
|
229
|
+
export type PreSendValidationResponse = z.infer<typeof PreSendValidationResponseSchema>;
|
|
230
|
+
//# sourceMappingURL=emails.schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"emails.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/emails/emails.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;iBAa9B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;iBAE7B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;iBAG5B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;iBAElC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;iBAYhC,CAAC;AAMH,eAAO,MAAM,uBAAuB;;;;;;;;;;iBAMlC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;iBAEpC,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;iBAGzC,CAAC;AAEH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAC;AAEH,eAAO,MAAM,iBAAiB;;iBAE5B,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;iBAKtC,CAAC;AAEH,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyB9B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGlC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;iBAOnC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAGxC,CAAC;AAMH,eAAO,MAAM,2BAA2B;;;;;;;iBAOtC,CAAC;AAEH,eAAO,MAAM,+BAA+B;;;;;;;iBAO1C,CAAC;AAMH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAC5F,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AACxF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AACpF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC"}
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Apollo Signal — Email Schemas
|
|
4
|
+
*
|
|
5
|
+
* Request, response and domain schemas for the Signal email API.
|
|
6
|
+
* Covers: send, batch-send, list, events, stream, suppression import.
|
|
7
|
+
*
|
|
8
|
+
* Subpath: @apollo-deploy/signal-schemas/emails
|
|
9
|
+
*/
|
|
10
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
+
exports.PreSendValidationResponseSchema = exports.PreSendValidationBodySchema = exports.EmailEventsListResponseSchema = exports.EmailEventResponseSchema = exports.EmailListResponseSchema = exports.EmailResponseSchema = exports.SuppressionImportResponseSchema = exports.SuppressionImportBodySchema = exports.StreamQuerySchema = exports.StreamTokenResponseSchema = exports.BulkCancelScheduledResponseSchema = exports.BulkCancelScheduledQuerySchema = exports.CancelEmailResponseSchema = exports.CancelEmailParamSchema = exports.SendEmailResponseSchema = exports.ListEmailsQuerySchema = exports.EmailProjectParamSchema = exports.EmailParamsSchema = exports.EmailIdParamSchema = exports.SendEmailBodySchema = void 0;
|
|
12
|
+
var zod_1 = require("zod");
|
|
13
|
+
// ---------------------------------------------------------------------------
|
|
14
|
+
// Request schemas
|
|
15
|
+
// ---------------------------------------------------------------------------
|
|
16
|
+
exports.SendEmailBodySchema = zod_1.z.object({
|
|
17
|
+
from: zod_1.z.string().email(),
|
|
18
|
+
to: zod_1.z.array(zod_1.z.string().email()).min(1),
|
|
19
|
+
cc: zod_1.z.array(zod_1.z.string().email()).optional(),
|
|
20
|
+
bcc: zod_1.z.array(zod_1.z.string().email()).optional(),
|
|
21
|
+
replyTo: zod_1.z.string().email().optional(),
|
|
22
|
+
subject: zod_1.z.string().min(1).max(998),
|
|
23
|
+
html: zod_1.z.string().optional(),
|
|
24
|
+
text: zod_1.z.string().optional(),
|
|
25
|
+
tags: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).optional(),
|
|
26
|
+
metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).optional(),
|
|
27
|
+
idempotencyKey: zod_1.z.string().max(255).optional(),
|
|
28
|
+
testMode: zod_1.z.boolean().optional(),
|
|
29
|
+
});
|
|
30
|
+
exports.EmailIdParamSchema = zod_1.z.object({
|
|
31
|
+
emailId: zod_1.z.string().min(1),
|
|
32
|
+
});
|
|
33
|
+
exports.EmailParamsSchema = zod_1.z.object({
|
|
34
|
+
projectId: zod_1.z.string().min(1),
|
|
35
|
+
emailId: zod_1.z.string().min(1),
|
|
36
|
+
});
|
|
37
|
+
exports.EmailProjectParamSchema = zod_1.z.object({
|
|
38
|
+
projectId: zod_1.z.string().min(1),
|
|
39
|
+
});
|
|
40
|
+
exports.ListEmailsQuerySchema = zod_1.z.object({
|
|
41
|
+
limit: zod_1.z.coerce.number().int().min(1).max(100).default(25),
|
|
42
|
+
cursor: zod_1.z.string().optional(),
|
|
43
|
+
status: zod_1.z.enum([
|
|
44
|
+
'queued', 'scheduled', 'cancelled', 'sent', 'delivered',
|
|
45
|
+
'bounced', 'complained', 'failed', 'rejected', 'suppressed', 'test',
|
|
46
|
+
]).optional(),
|
|
47
|
+
from: zod_1.z.string().optional(),
|
|
48
|
+
to: zod_1.z.string().optional(),
|
|
49
|
+
tag: zod_1.z.string().optional(),
|
|
50
|
+
since: zod_1.z.string().datetime().optional(),
|
|
51
|
+
until: zod_1.z.string().datetime().optional(),
|
|
52
|
+
});
|
|
53
|
+
// ---------------------------------------------------------------------------
|
|
54
|
+
// Response schemas
|
|
55
|
+
// ---------------------------------------------------------------------------
|
|
56
|
+
exports.SendEmailResponseSchema = zod_1.z.object({
|
|
57
|
+
id: zod_1.z.string(),
|
|
58
|
+
messageId: zod_1.z.string().nullable(),
|
|
59
|
+
status: zod_1.z.enum(['sent', 'test', 'scheduled']),
|
|
60
|
+
createdAt: zod_1.z.string().datetime(),
|
|
61
|
+
scheduledAt: zod_1.z.string().datetime().nullable().optional(),
|
|
62
|
+
});
|
|
63
|
+
exports.CancelEmailParamSchema = zod_1.z.object({
|
|
64
|
+
emailId: zod_1.z.string().min(1),
|
|
65
|
+
});
|
|
66
|
+
exports.CancelEmailResponseSchema = zod_1.z.object({
|
|
67
|
+
cancelled: zod_1.z.literal(true),
|
|
68
|
+
});
|
|
69
|
+
exports.BulkCancelScheduledQuerySchema = zod_1.z.object({
|
|
70
|
+
from: zod_1.z.string().datetime({ offset: true }).optional(),
|
|
71
|
+
to: zod_1.z.string().datetime({ offset: true }).optional(),
|
|
72
|
+
});
|
|
73
|
+
exports.BulkCancelScheduledResponseSchema = zod_1.z.object({
|
|
74
|
+
cancelled: zod_1.z.number().int(),
|
|
75
|
+
});
|
|
76
|
+
exports.StreamTokenResponseSchema = zod_1.z.object({
|
|
77
|
+
token: zod_1.z.string(),
|
|
78
|
+
expiresAt: zod_1.z.string().datetime(),
|
|
79
|
+
});
|
|
80
|
+
exports.StreamQuerySchema = zod_1.z.object({
|
|
81
|
+
token: zod_1.z.string().min(1),
|
|
82
|
+
});
|
|
83
|
+
exports.SuppressionImportBodySchema = zod_1.z.object({
|
|
84
|
+
suppressions: zod_1.z.array(zod_1.z.object({
|
|
85
|
+
email: zod_1.z.string().email(),
|
|
86
|
+
reason: zod_1.z.enum(['bounce', 'complaint', 'manual', 'unsubscribe']).default('manual'),
|
|
87
|
+
})).min(1).max(10000),
|
|
88
|
+
});
|
|
89
|
+
exports.SuppressionImportResponseSchema = zod_1.z.object({
|
|
90
|
+
imported: zod_1.z.number().int(),
|
|
91
|
+
skipped: zod_1.z.number().int(),
|
|
92
|
+
});
|
|
93
|
+
exports.EmailResponseSchema = zod_1.z.object({
|
|
94
|
+
id: zod_1.z.string(),
|
|
95
|
+
projectId: zod_1.z.string(),
|
|
96
|
+
organizationId: zod_1.z.string(),
|
|
97
|
+
apiKeyId: zod_1.z.string().nullable(),
|
|
98
|
+
domainId: zod_1.z.string().nullable(),
|
|
99
|
+
provider: zod_1.z.literal('ses'),
|
|
100
|
+
providerMessageId: zod_1.z.string().nullable(),
|
|
101
|
+
fromAddress: zod_1.z.string(),
|
|
102
|
+
fromDomain: zod_1.z.string(),
|
|
103
|
+
toRecipients: zod_1.z.array(zod_1.z.string()),
|
|
104
|
+
ccRecipients: zod_1.z.array(zod_1.z.string()).nullable(),
|
|
105
|
+
bccRecipients: zod_1.z.array(zod_1.z.string()).nullable(),
|
|
106
|
+
replyTo: zod_1.z.string().nullable(),
|
|
107
|
+
subject: zod_1.z.string(),
|
|
108
|
+
status: zod_1.z.enum([
|
|
109
|
+
'queued', 'scheduled', 'cancelled', 'sent', 'delivered',
|
|
110
|
+
'bounced', 'complained', 'failed', 'rejected', 'suppressed', 'test',
|
|
111
|
+
]),
|
|
112
|
+
error: zod_1.z.string().nullable(),
|
|
113
|
+
tags: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).nullable(),
|
|
114
|
+
testMode: zod_1.z.boolean(),
|
|
115
|
+
createdAt: zod_1.z.string().datetime(),
|
|
116
|
+
sentAt: zod_1.z.string().datetime().nullable(),
|
|
117
|
+
updatedAt: zod_1.z.string().datetime(),
|
|
118
|
+
});
|
|
119
|
+
exports.EmailListResponseSchema = zod_1.z.object({
|
|
120
|
+
data: zod_1.z.array(exports.EmailResponseSchema),
|
|
121
|
+
nextCursor: zod_1.z.string().nullable(),
|
|
122
|
+
});
|
|
123
|
+
exports.EmailEventResponseSchema = zod_1.z.object({
|
|
124
|
+
id: zod_1.z.string(),
|
|
125
|
+
type: zod_1.z.string(),
|
|
126
|
+
providerEventId: zod_1.z.string().nullable(),
|
|
127
|
+
payload: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
|
|
128
|
+
occurredAt: zod_1.z.string().datetime(),
|
|
129
|
+
createdAt: zod_1.z.string().datetime(),
|
|
130
|
+
});
|
|
131
|
+
exports.EmailEventsListResponseSchema = zod_1.z.object({
|
|
132
|
+
data: zod_1.z.array(exports.EmailEventResponseSchema),
|
|
133
|
+
nextCursor: zod_1.z.string().nullable(),
|
|
134
|
+
});
|
|
135
|
+
// ---------------------------------------------------------------------------
|
|
136
|
+
// Pre-send validation
|
|
137
|
+
// ---------------------------------------------------------------------------
|
|
138
|
+
exports.PreSendValidationBodySchema = zod_1.z.object({
|
|
139
|
+
from: zod_1.z.string().min(1),
|
|
140
|
+
to: zod_1.z.array(zod_1.z.string().email()).min(1).max(50),
|
|
141
|
+
subject: zod_1.z.string(),
|
|
142
|
+
html: zod_1.z.string().optional(),
|
|
143
|
+
text: zod_1.z.string().optional(),
|
|
144
|
+
scheduledAt: zod_1.z.string().datetime().optional(),
|
|
145
|
+
});
|
|
146
|
+
exports.PreSendValidationResponseSchema = zod_1.z.object({
|
|
147
|
+
valid: zod_1.z.boolean(),
|
|
148
|
+
checks: zod_1.z.array(zod_1.z.object({
|
|
149
|
+
name: zod_1.z.string(),
|
|
150
|
+
passed: zod_1.z.boolean(),
|
|
151
|
+
message: zod_1.z.string().optional(),
|
|
152
|
+
})),
|
|
153
|
+
});
|
|
154
|
+
// ---------------------------------------------------------------------------
|
|
155
|
+
// Schema registry — promotes types to OpenAPI components/schemas
|
|
156
|
+
// ---------------------------------------------------------------------------
|
|
157
|
+
zod_1.z.globalRegistry.add(exports.SendEmailBodySchema, { id: 'SendEmailBody' });
|
|
158
|
+
zod_1.z.globalRegistry.add(exports.EmailIdParamSchema, { id: 'EmailIdParam' });
|
|
159
|
+
zod_1.z.globalRegistry.add(exports.EmailParamsSchema, { id: 'EmailParams' });
|
|
160
|
+
zod_1.z.globalRegistry.add(exports.EmailProjectParamSchema, { id: 'EmailProjectParam' });
|
|
161
|
+
zod_1.z.globalRegistry.add(exports.ListEmailsQuerySchema, { id: 'ListEmailsQuery' });
|
|
162
|
+
zod_1.z.globalRegistry.add(exports.SendEmailResponseSchema, { id: 'SendEmailResponse' });
|
|
163
|
+
zod_1.z.globalRegistry.add(exports.CancelEmailParamSchema, { id: 'CancelEmailParam' });
|
|
164
|
+
zod_1.z.globalRegistry.add(exports.CancelEmailResponseSchema, { id: 'CancelEmailResponse' });
|
|
165
|
+
zod_1.z.globalRegistry.add(exports.BulkCancelScheduledQuerySchema, { id: 'BulkCancelScheduledQuery' });
|
|
166
|
+
zod_1.z.globalRegistry.add(exports.BulkCancelScheduledResponseSchema, { id: 'BulkCancelScheduledResponse' });
|
|
167
|
+
zod_1.z.globalRegistry.add(exports.StreamTokenResponseSchema, { id: 'StreamTokenResponse' });
|
|
168
|
+
zod_1.z.globalRegistry.add(exports.StreamQuerySchema, { id: 'StreamQuery' });
|
|
169
|
+
zod_1.z.globalRegistry.add(exports.SuppressionImportBodySchema, { id: 'EmailSuppressionImportBody' });
|
|
170
|
+
zod_1.z.globalRegistry.add(exports.SuppressionImportResponseSchema, { id: 'EmailSuppressionImportResponse' });
|
|
171
|
+
zod_1.z.globalRegistry.add(exports.EmailResponseSchema, { id: 'EmailResponse' });
|
|
172
|
+
zod_1.z.globalRegistry.add(exports.EmailListResponseSchema, { id: 'EmailListResponse' });
|
|
173
|
+
zod_1.z.globalRegistry.add(exports.EmailEventResponseSchema, { id: 'EmailEventResponse' });
|
|
174
|
+
zod_1.z.globalRegistry.add(exports.EmailEventsListResponseSchema, { id: 'EmailEventsListResponse' });
|
|
175
|
+
zod_1.z.globalRegistry.add(exports.PreSendValidationBodySchema, { id: 'PreSendValidationBody' });
|
|
176
|
+
zod_1.z.globalRegistry.add(exports.PreSendValidationResponseSchema, { id: 'PreSendValidationResponse' });
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/definitions/emails/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definitions/emails/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC","sourcesContent":["export * from './domain.schema.js';\nexport * from './request.schema.js';\nexport * from './response.schema.js';\n"]}
|