@workwae/sdk 0.1.0-alpha.1 → 0.1.0-alpha.3
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 +7 -7
- package/client.d.ts +1 -1
- package/contract/accounts/models.d.ts +85 -45
- package/contract/accounts/routes.d.ts +191 -29
- package/contract/ai/models.d.ts +0 -1
- package/contract/ai/routes.d.ts +9 -0
- package/contract/audit-log/models.d.ts +22 -5
- package/contract/audit-log/routes.d.ts +11 -1
- package/contract/calendar/models.d.ts +249 -74
- package/contract/calendar/routes.d.ts +574 -30
- package/contract/connect/models.d.ts +30 -16
- package/contract/connect/routes.d.ts +51 -7
- package/contract/connect-domain/models.d.ts +41 -0
- package/contract/connect-domain/routes.d.ts +197 -0
- package/contract/contacts/models.d.ts +0 -10
- package/contract/contacts/routes.d.ts +14 -0
- package/contract/custom-domain.d.ts +12 -0
- package/contract/email-validation/models.d.ts +119 -0
- package/contract/email-validation/routes.d.ts +106 -0
- package/contract/errors.d.ts +28 -20
- package/contract/events/models.d.ts +139 -79
- package/contract/events/routes.d.ts +54 -44
- package/contract/exports/routes.d.ts +10 -0
- package/contract/identities/models.d.ts +7 -9
- package/contract/identities/routes.d.ts +79 -10
- package/contract/limits.d.ts +27 -73
- package/contract/mail/models.d.ts +230 -50
- package/contract/mail/routes.d.ts +649 -59
- package/contract/mcp-keys/models.d.ts +125 -0
- package/contract/mcp-keys/routes.d.ts +151 -0
- package/contract/meetings/models.d.ts +39 -33
- package/contract/meetings/routes.d.ts +121 -23
- package/contract/oauth-apps/models.d.ts +6 -6
- package/contract/oauth-apps/routes.d.ts +34 -4
- package/contract/org-connections/models.d.ts +93 -39
- package/contract/org-connections/routes.d.ts +352 -43
- package/contract/plans/credit-packs.d.ts +30 -0
- package/contract/plans/models.d.ts +208 -0
- package/contract/primitives.d.ts +7 -62
- package/contract/public.d.ts +7 -0
- package/contract/reasons.d.ts +559 -21
- package/contract/router.d.ts +6447 -2719
- package/contract/scheduling/models.d.ts +405 -0
- package/contract/scheduling/routes.d.ts +756 -0
- package/contract/send/models.d.ts +140 -45
- package/contract/send/routes.d.ts +310 -31
- package/contract/settings/models.d.ts +73 -13
- package/contract/settings/routes.d.ts +56 -4
- package/contract/suppressions/models.d.ts +21 -28
- package/contract/suppressions/routes.d.ts +62 -14
- package/contract/templates/models.d.ts +0 -14
- package/contract/templates/routes.d.ts +30 -6
- package/contract/threads/models.d.ts +0 -5
- package/contract/threads/routes.d.ts +40 -0
- package/contract/tracking-domain/models.d.ts +41 -0
- package/contract/tracking-domain/routes.d.ts +193 -0
- package/contract/usage/models.d.ts +98 -126
- package/contract/usage/routes.d.ts +48 -20
- package/contract/webhooks/models.d.ts +45 -30
- package/contract/webhooks/routes.d.ts +52 -9
- package/contract/webhooks/signing.d.ts +0 -16
- package/index.js +1 -4334
- package/package.json +6 -7
- package/index.js.map +0 -59
|
@@ -5,7 +5,6 @@ export declare const BodyStorage: z.ZodEnum<{
|
|
|
5
5
|
full: "full";
|
|
6
6
|
}>;
|
|
7
7
|
export type BodyStorage = z.infer<typeof BodyStorage>;
|
|
8
|
-
/** null syncWindowDays = full mailbox history. */
|
|
9
8
|
export declare const EffectiveSettings: z.ZodObject<{
|
|
10
9
|
bodyStorage: z.ZodEnum<{
|
|
11
10
|
none: "none";
|
|
@@ -13,15 +12,20 @@ export declare const EffectiveSettings: z.ZodObject<{
|
|
|
13
12
|
full: "full";
|
|
14
13
|
}>;
|
|
15
14
|
syncWindowDays: z.ZodNullable<z.ZodNumber>;
|
|
15
|
+
mailEnabled: z.ZodBoolean;
|
|
16
16
|
calendarEnabled: z.ZodBoolean;
|
|
17
17
|
contactsEnabled: z.ZodBoolean;
|
|
18
18
|
undoSendSeconds: z.ZodNumber;
|
|
19
19
|
trackOpens: z.ZodBoolean;
|
|
20
20
|
trackClicks: z.ZodBoolean;
|
|
21
21
|
trackingHoneypot: z.ZodBoolean;
|
|
22
|
+
suppressionCheck: z.ZodEnum<{
|
|
23
|
+
lists: "lists";
|
|
24
|
+
always: "always";
|
|
25
|
+
}>;
|
|
26
|
+
sendsPerMinute: z.ZodNullable<z.ZodNumber>;
|
|
22
27
|
}, z.core.$strip>;
|
|
23
28
|
export type EffectiveSettings = z.infer<typeof EffectiveSettings>;
|
|
24
|
-
/** Keys present override the tenant default; absent keys inherit it. */
|
|
25
29
|
export declare const SettingsOverride: z.ZodObject<{
|
|
26
30
|
bodyStorage: z.ZodOptional<z.ZodEnum<{
|
|
27
31
|
none: "none";
|
|
@@ -29,31 +33,56 @@ export declare const SettingsOverride: z.ZodObject<{
|
|
|
29
33
|
full: "full";
|
|
30
34
|
}>>;
|
|
31
35
|
syncWindowDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
36
|
+
mailEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
32
37
|
calendarEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
33
38
|
contactsEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
34
39
|
undoSendSeconds: z.ZodOptional<z.ZodNumber>;
|
|
35
40
|
trackOpens: z.ZodOptional<z.ZodBoolean>;
|
|
36
41
|
trackClicks: z.ZodOptional<z.ZodBoolean>;
|
|
37
42
|
trackingHoneypot: z.ZodOptional<z.ZodBoolean>;
|
|
43
|
+
suppressionCheck: z.ZodOptional<z.ZodEnum<{
|
|
44
|
+
lists: "lists";
|
|
45
|
+
always: "always";
|
|
46
|
+
}>>;
|
|
47
|
+
sendsPerMinute: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
38
48
|
}, z.core.$strip>;
|
|
39
49
|
export type SettingsOverride = z.infer<typeof SettingsOverride>;
|
|
40
|
-
/**
|
|
41
|
-
* Why `uri` cannot go on the redirect URI allowlist, or null when it can: entries are absolute
|
|
42
|
-
* https URLs, plain http only for local development hosts.
|
|
43
|
-
*/
|
|
44
50
|
export declare function redirectUriProblem(uri: string): string | null;
|
|
45
|
-
/** off: detected opt-outs are ignored; review: AI-classified replies wait in
|
|
46
|
-
* GET /v1/suppression-reviews for a person, while feedback-loop complaints, which are certain,
|
|
47
|
-
* suppress at once; suppress: the address goes on the list at once. Auto-replies saying the
|
|
48
|
-
* person is no longer at the address (source inactive) wait for review under both review and
|
|
49
|
-
* suppress. Unsubscribe links and one-click unsubscribe always suppress, whatever this says
|
|
50
|
-
* (RFC 8058, Gmail and Yahoo sender rules). */
|
|
51
51
|
export declare const OptOutHandling: z.ZodEnum<{
|
|
52
52
|
off: "off";
|
|
53
53
|
review: "review";
|
|
54
54
|
suppress: "suppress";
|
|
55
55
|
}>;
|
|
56
56
|
export type OptOutHandling = z.infer<typeof OptOutHandling>;
|
|
57
|
+
export declare const McpSendMode: z.ZodEnum<{
|
|
58
|
+
allow: "allow";
|
|
59
|
+
confirm: "confirm";
|
|
60
|
+
drafts_only: "drafts_only";
|
|
61
|
+
}>;
|
|
62
|
+
export type McpSendMode = z.infer<typeof McpSendMode>;
|
|
63
|
+
export declare const RecipientDomain: z.ZodString;
|
|
64
|
+
export declare const McpSendPolicy: z.ZodObject<{
|
|
65
|
+
mode: z.ZodEnum<{
|
|
66
|
+
allow: "allow";
|
|
67
|
+
confirm: "confirm";
|
|
68
|
+
drafts_only: "drafts_only";
|
|
69
|
+
}>;
|
|
70
|
+
allowedRecipientDomains: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
71
|
+
dailySendLimit: z.ZodNullable<z.ZodNumber>;
|
|
72
|
+
externalRecipientConfirmation: z.ZodBoolean;
|
|
73
|
+
}, z.core.$strip>;
|
|
74
|
+
export type McpSendPolicy = z.infer<typeof McpSendPolicy>;
|
|
75
|
+
export declare const McpSendPolicyPatch: z.ZodObject<{
|
|
76
|
+
mode: z.ZodOptional<z.ZodEnum<{
|
|
77
|
+
allow: "allow";
|
|
78
|
+
confirm: "confirm";
|
|
79
|
+
drafts_only: "drafts_only";
|
|
80
|
+
}>>;
|
|
81
|
+
allowedRecipientDomains: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
82
|
+
dailySendLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
83
|
+
externalRecipientConfirmation: z.ZodOptional<z.ZodBoolean>;
|
|
84
|
+
}, z.core.$strip>;
|
|
85
|
+
export type McpSendPolicyPatch = z.infer<typeof McpSendPolicyPatch>;
|
|
57
86
|
export declare const TenantSettings: z.ZodObject<{
|
|
58
87
|
bodyStorage: z.ZodEnum<{
|
|
59
88
|
none: "none";
|
|
@@ -61,12 +90,18 @@ export declare const TenantSettings: z.ZodObject<{
|
|
|
61
90
|
full: "full";
|
|
62
91
|
}>;
|
|
63
92
|
syncWindowDays: z.ZodNullable<z.ZodNumber>;
|
|
93
|
+
mailEnabled: z.ZodBoolean;
|
|
64
94
|
calendarEnabled: z.ZodBoolean;
|
|
65
95
|
contactsEnabled: z.ZodBoolean;
|
|
66
96
|
undoSendSeconds: z.ZodNumber;
|
|
67
97
|
trackOpens: z.ZodBoolean;
|
|
68
98
|
trackClicks: z.ZodBoolean;
|
|
69
99
|
trackingHoneypot: z.ZodBoolean;
|
|
100
|
+
suppressionCheck: z.ZodEnum<{
|
|
101
|
+
lists: "lists";
|
|
102
|
+
always: "always";
|
|
103
|
+
}>;
|
|
104
|
+
sendsPerMinute: z.ZodNullable<z.ZodNumber>;
|
|
70
105
|
optOutHandling: z.ZodEnum<{
|
|
71
106
|
off: "off";
|
|
72
107
|
review: "review";
|
|
@@ -75,9 +110,18 @@ export declare const TenantSettings: z.ZodObject<{
|
|
|
75
110
|
eventRetentionDays: z.ZodNumber;
|
|
76
111
|
redirectUris: z.ZodArray<z.ZodURL>;
|
|
77
112
|
aiReplyClassification: z.ZodBoolean;
|
|
113
|
+
mcpSendPolicy: z.ZodObject<{
|
|
114
|
+
mode: z.ZodEnum<{
|
|
115
|
+
allow: "allow";
|
|
116
|
+
confirm: "confirm";
|
|
117
|
+
drafts_only: "drafts_only";
|
|
118
|
+
}>;
|
|
119
|
+
allowedRecipientDomains: z.ZodNullable<z.ZodArray<z.ZodString>>;
|
|
120
|
+
dailySendLimit: z.ZodNullable<z.ZodNumber>;
|
|
121
|
+
externalRecipientConfirmation: z.ZodBoolean;
|
|
122
|
+
}, z.core.$strip>;
|
|
78
123
|
}, z.core.$strip>;
|
|
79
124
|
export type TenantSettings = z.infer<typeof TenantSettings>;
|
|
80
|
-
/** Keys present change; absent keys stay. */
|
|
81
125
|
export declare const UpdateTenantSettings: z.ZodObject<{
|
|
82
126
|
bodyStorage: z.ZodOptional<z.ZodEnum<{
|
|
83
127
|
none: "none";
|
|
@@ -85,12 +129,18 @@ export declare const UpdateTenantSettings: z.ZodObject<{
|
|
|
85
129
|
full: "full";
|
|
86
130
|
}>>;
|
|
87
131
|
syncWindowDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
132
|
+
mailEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
88
133
|
calendarEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
89
134
|
contactsEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
90
135
|
undoSendSeconds: z.ZodOptional<z.ZodNumber>;
|
|
91
136
|
trackOpens: z.ZodOptional<z.ZodBoolean>;
|
|
92
137
|
trackClicks: z.ZodOptional<z.ZodBoolean>;
|
|
93
138
|
trackingHoneypot: z.ZodOptional<z.ZodBoolean>;
|
|
139
|
+
suppressionCheck: z.ZodOptional<z.ZodEnum<{
|
|
140
|
+
lists: "lists";
|
|
141
|
+
always: "always";
|
|
142
|
+
}>>;
|
|
143
|
+
sendsPerMinute: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
94
144
|
optOutHandling: z.ZodOptional<z.ZodEnum<{
|
|
95
145
|
off: "off";
|
|
96
146
|
review: "review";
|
|
@@ -99,5 +149,15 @@ export declare const UpdateTenantSettings: z.ZodObject<{
|
|
|
99
149
|
eventRetentionDays: z.ZodOptional<z.ZodNumber>;
|
|
100
150
|
redirectUris: z.ZodOptional<z.ZodArray<z.ZodURL>>;
|
|
101
151
|
aiReplyClassification: z.ZodOptional<z.ZodBoolean>;
|
|
152
|
+
mcpSendPolicy: z.ZodOptional<z.ZodObject<{
|
|
153
|
+
mode: z.ZodOptional<z.ZodEnum<{
|
|
154
|
+
allow: "allow";
|
|
155
|
+
confirm: "confirm";
|
|
156
|
+
drafts_only: "drafts_only";
|
|
157
|
+
}>>;
|
|
158
|
+
allowedRecipientDomains: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
|
|
159
|
+
dailySendLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
160
|
+
externalRecipientConfirmation: z.ZodOptional<z.ZodBoolean>;
|
|
161
|
+
}, z.core.$strip>>;
|
|
102
162
|
}, z.core.$strip>;
|
|
103
163
|
export type UpdateTenantSettings = z.infer<typeof UpdateTenantSettings>;
|
|
@@ -6,12 +6,18 @@ export declare const settings: {
|
|
|
6
6
|
full: "full";
|
|
7
7
|
}>;
|
|
8
8
|
syncWindowDays: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
9
|
+
mailEnabled: import("zod").ZodBoolean;
|
|
9
10
|
calendarEnabled: import("zod").ZodBoolean;
|
|
10
11
|
contactsEnabled: import("zod").ZodBoolean;
|
|
11
12
|
undoSendSeconds: import("zod").ZodNumber;
|
|
12
13
|
trackOpens: import("zod").ZodBoolean;
|
|
13
14
|
trackClicks: import("zod").ZodBoolean;
|
|
14
15
|
trackingHoneypot: import("zod").ZodBoolean;
|
|
16
|
+
suppressionCheck: import("zod").ZodEnum<{
|
|
17
|
+
lists: "lists";
|
|
18
|
+
always: "always";
|
|
19
|
+
}>;
|
|
20
|
+
sendsPerMinute: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
15
21
|
optOutHandling: import("zod").ZodEnum<{
|
|
16
22
|
off: "off";
|
|
17
23
|
review: "review";
|
|
@@ -20,6 +26,16 @@ export declare const settings: {
|
|
|
20
26
|
eventRetentionDays: import("zod").ZodNumber;
|
|
21
27
|
redirectUris: import("zod").ZodArray<import("zod").ZodURL>;
|
|
22
28
|
aiReplyClassification: import("zod").ZodBoolean;
|
|
29
|
+
mcpSendPolicy: import("zod").ZodObject<{
|
|
30
|
+
mode: import("zod").ZodEnum<{
|
|
31
|
+
allow: "allow";
|
|
32
|
+
confirm: "confirm";
|
|
33
|
+
drafts_only: "drafts_only";
|
|
34
|
+
}>;
|
|
35
|
+
allowedRecipientDomains: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodString>>;
|
|
36
|
+
dailySendLimit: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
37
|
+
externalRecipientConfirmation: import("zod").ZodBoolean;
|
|
38
|
+
}, import("zod/v4/core").$strip>;
|
|
23
39
|
}, import("zod/v4/core").$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, import("../errors.js").DeclaredErrors<{
|
|
24
40
|
readonly invalid_input: "The request does not match the operation's input schema (a malformed body included); data.issues names each problem.";
|
|
25
41
|
readonly unauthenticated: "No usable credential: none was sent, or it is malformed, unknown, revoked or an expired account token.";
|
|
@@ -27,6 +43,8 @@ export declare const settings: {
|
|
|
27
43
|
readonly missing_scope: "The API key lacks the scope the operation needs.";
|
|
28
44
|
readonly role_forbidden: "The member's role does not allow the operation.";
|
|
29
45
|
readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
|
|
46
|
+
readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
|
|
47
|
+
readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
|
|
30
48
|
readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
|
|
31
49
|
readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
|
|
32
50
|
readonly overloaded: "The API is shedding load; retry after Retry-After.";
|
|
@@ -43,12 +61,18 @@ export declare const settings: {
|
|
|
43
61
|
full: "full";
|
|
44
62
|
}>>;
|
|
45
63
|
syncWindowDays: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
|
|
64
|
+
mailEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
46
65
|
calendarEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
47
66
|
contactsEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
48
67
|
undoSendSeconds: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
49
68
|
trackOpens: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
50
69
|
trackClicks: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
51
70
|
trackingHoneypot: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
71
|
+
suppressionCheck: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
72
|
+
lists: "lists";
|
|
73
|
+
always: "always";
|
|
74
|
+
}>>;
|
|
75
|
+
sendsPerMinute: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
|
|
52
76
|
optOutHandling: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
53
77
|
off: "off";
|
|
54
78
|
review: "review";
|
|
@@ -57,6 +81,16 @@ export declare const settings: {
|
|
|
57
81
|
eventRetentionDays: import("zod").ZodOptional<import("zod").ZodNumber>;
|
|
58
82
|
redirectUris: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodURL>>;
|
|
59
83
|
aiReplyClassification: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
84
|
+
mcpSendPolicy: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
85
|
+
mode: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
86
|
+
allow: "allow";
|
|
87
|
+
confirm: "confirm";
|
|
88
|
+
drafts_only: "drafts_only";
|
|
89
|
+
}>>;
|
|
90
|
+
allowedRecipientDomains: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodString>>>;
|
|
91
|
+
dailySendLimit: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
|
|
92
|
+
externalRecipientConfirmation: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
93
|
+
}, import("zod/v4/core").$strip>>;
|
|
60
94
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
61
95
|
bodyStorage: import("zod").ZodEnum<{
|
|
62
96
|
none: "none";
|
|
@@ -64,12 +98,18 @@ export declare const settings: {
|
|
|
64
98
|
full: "full";
|
|
65
99
|
}>;
|
|
66
100
|
syncWindowDays: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
101
|
+
mailEnabled: import("zod").ZodBoolean;
|
|
67
102
|
calendarEnabled: import("zod").ZodBoolean;
|
|
68
103
|
contactsEnabled: import("zod").ZodBoolean;
|
|
69
104
|
undoSendSeconds: import("zod").ZodNumber;
|
|
70
105
|
trackOpens: import("zod").ZodBoolean;
|
|
71
106
|
trackClicks: import("zod").ZodBoolean;
|
|
72
107
|
trackingHoneypot: import("zod").ZodBoolean;
|
|
108
|
+
suppressionCheck: import("zod").ZodEnum<{
|
|
109
|
+
lists: "lists";
|
|
110
|
+
always: "always";
|
|
111
|
+
}>;
|
|
112
|
+
sendsPerMinute: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
73
113
|
optOutHandling: import("zod").ZodEnum<{
|
|
74
114
|
off: "off";
|
|
75
115
|
review: "review";
|
|
@@ -78,6 +118,16 @@ export declare const settings: {
|
|
|
78
118
|
eventRetentionDays: import("zod").ZodNumber;
|
|
79
119
|
redirectUris: import("zod").ZodArray<import("zod").ZodURL>;
|
|
80
120
|
aiReplyClassification: import("zod").ZodBoolean;
|
|
121
|
+
mcpSendPolicy: import("zod").ZodObject<{
|
|
122
|
+
mode: import("zod").ZodEnum<{
|
|
123
|
+
allow: "allow";
|
|
124
|
+
confirm: "confirm";
|
|
125
|
+
drafts_only: "drafts_only";
|
|
126
|
+
}>;
|
|
127
|
+
allowedRecipientDomains: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodString>>;
|
|
128
|
+
dailySendLimit: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
129
|
+
externalRecipientConfirmation: import("zod").ZodBoolean;
|
|
130
|
+
}, import("zod/v4/core").$strip>;
|
|
81
131
|
}, import("zod/v4/core").$strip>, import("@orpc/contract").MergedErrorMap<import("@orpc/contract").MergedErrorMap<Record<never, never>, import("../errors.js").DeclaredErrors<{
|
|
82
132
|
readonly invalid_input: "The request does not match the operation's input schema (a malformed body included); data.issues names each problem.";
|
|
83
133
|
readonly unauthenticated: "No usable credential: none was sent, or it is malformed, unknown, revoked or an expired account token.";
|
|
@@ -85,6 +135,8 @@ export declare const settings: {
|
|
|
85
135
|
readonly missing_scope: "The API key lacks the scope the operation needs.";
|
|
86
136
|
readonly role_forbidden: "The member's role does not allow the operation.";
|
|
87
137
|
readonly account_token_forbidden: "An account token called an operation account tokens cannot call.";
|
|
138
|
+
readonly account_scope_forbidden: "A credential limited to specific accounts called an operation that reaches beyond them.";
|
|
139
|
+
readonly mcp_only_key: "An MCP-only key (minted for an end user's MCP client) was used outside the MCP server.";
|
|
88
140
|
readonly rate_limited: "The tenant used up its plan's request rate; Retry-After says when the window ends.";
|
|
89
141
|
readonly too_many_requests: "The credential has too many requests in flight at once; retry after Retry-After.";
|
|
90
142
|
readonly overloaded: "The API is shedding load; retry after Retry-After.";
|
|
@@ -98,13 +150,13 @@ export declare const settings: {
|
|
|
98
150
|
status: 400;
|
|
99
151
|
message: string;
|
|
100
152
|
};
|
|
101
|
-
plan_limit_storage:
|
|
102
|
-
status: 403;
|
|
103
|
-
message: string;
|
|
104
|
-
};
|
|
153
|
+
plan_limit_storage: import("../errors.js").DeclaredError<"plan_limit_storage">;
|
|
105
154
|
storage_unavailable: {
|
|
106
155
|
status: 400;
|
|
107
156
|
message: string;
|
|
108
157
|
};
|
|
158
|
+
plan_limit_accounts: import("../errors.js").DeclaredError<"plan_limit_accounts">;
|
|
159
|
+
plan_required: import("../errors.js").DeclaredError<"plan_required">;
|
|
160
|
+
spend_cap_reached: import("../errors.js").DeclaredError<"spend_cap_reached">;
|
|
109
161
|
}>, Record<never, never>>;
|
|
110
162
|
};
|
|
@@ -1,21 +1,12 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
|
-
/** The list every send that names a list consults. Not a name a send can give. */
|
|
3
2
|
export declare const GLOBAL_LIST_ID = "global";
|
|
4
|
-
/** The built-in global list's name; it cannot be renamed. */
|
|
5
3
|
export declare const GLOBAL_LIST_NAME = "Everyone (global)";
|
|
6
|
-
/** A hostname label, as EmailEngine's listId: letters, digits and inner hyphens, 1 to 63. */
|
|
7
4
|
export declare const LIST_ID_PATTERN: RegExp;
|
|
8
|
-
/** A list id as the suppression routes take it: a named list or "global". Case-insensitive. */
|
|
9
5
|
export declare const SuppressionListId: z.ZodString;
|
|
10
|
-
/** A list a send names: a hostname label other than "global". */
|
|
11
6
|
export declare const ListId: z.ZodString;
|
|
12
|
-
/** unsubscribe: the recipient's one-click POST or the confirm page; bounce: a permanent bounce
|
|
13
|
-
* saying the address is gone; api: POST /v1/suppressions/{listId}/entries; reply: a reply asking to opt
|
|
14
|
-
* out; complaint: an abuse report (ARF) from the recipient's provider; inactive: an auto-reply
|
|
15
|
-
* saying the person is no longer at this address. reply, complaint and inactive are detected, and
|
|
16
|
-
* land per the tenant's optOutHandling. */
|
|
17
7
|
export declare const SuppressionSource: z.ZodEnum<{
|
|
18
8
|
api: "api";
|
|
9
|
+
invalid: "invalid";
|
|
19
10
|
bounce: "bounce";
|
|
20
11
|
unsubscribe: "unsubscribe";
|
|
21
12
|
reply: "reply";
|
|
@@ -23,8 +14,6 @@ export declare const SuppressionSource: z.ZodEnum<{
|
|
|
23
14
|
inactive: "inactive";
|
|
24
15
|
}>;
|
|
25
16
|
export type SuppressionSource = z.infer<typeof SuppressionSource>;
|
|
26
|
-
/** Opt-outs detected in mail rather than stated by a link: see optOutHandling. inactive (an
|
|
27
|
-
* auto-reply saying the person left or moved to another address) always waits for review. */
|
|
28
17
|
export declare const DetectedOptOutSource: z.ZodEnum<{
|
|
29
18
|
reply: "reply";
|
|
30
19
|
complaint: "complaint";
|
|
@@ -35,6 +24,7 @@ export declare const SuppressionEntry: z.ZodObject<{
|
|
|
35
24
|
address: z.ZodString;
|
|
36
25
|
source: z.ZodEnum<{
|
|
37
26
|
api: "api";
|
|
27
|
+
invalid: "invalid";
|
|
38
28
|
bounce: "bounce";
|
|
39
29
|
unsubscribe: "unsubscribe";
|
|
40
30
|
reply: "reply";
|
|
@@ -50,6 +40,7 @@ export declare const SuppressionEntryPage: z.ZodObject<{
|
|
|
50
40
|
address: z.ZodString;
|
|
51
41
|
source: z.ZodEnum<{
|
|
52
42
|
api: "api";
|
|
43
|
+
invalid: "invalid";
|
|
53
44
|
bounce: "bounce";
|
|
54
45
|
unsubscribe: "unsubscribe";
|
|
55
46
|
reply: "reply";
|
|
@@ -62,7 +53,6 @@ export declare const SuppressionEntryPage: z.ZodObject<{
|
|
|
62
53
|
nextCursor: z.ZodNullable<z.ZodString>;
|
|
63
54
|
}, z.core.$strip>;
|
|
64
55
|
export type SuppressionEntryPage = z.infer<typeof SuppressionEntryPage>;
|
|
65
|
-
/** Addresses on a list by source. */
|
|
66
56
|
export declare const SuppressionCounts: z.ZodObject<{
|
|
67
57
|
unsubscribe: z.ZodNumber;
|
|
68
58
|
bounce: z.ZodNumber;
|
|
@@ -70,6 +60,7 @@ export declare const SuppressionCounts: z.ZodObject<{
|
|
|
70
60
|
reply: z.ZodNumber;
|
|
71
61
|
complaint: z.ZodNumber;
|
|
72
62
|
inactive: z.ZodNumber;
|
|
63
|
+
invalid: z.ZodNumber;
|
|
73
64
|
}, z.core.$strip>;
|
|
74
65
|
export type SuppressionCounts = z.infer<typeof SuppressionCounts>;
|
|
75
66
|
export declare const SuppressionList: z.ZodObject<{
|
|
@@ -84,6 +75,7 @@ export declare const SuppressionList: z.ZodObject<{
|
|
|
84
75
|
reply: z.ZodNumber;
|
|
85
76
|
complaint: z.ZodNumber;
|
|
86
77
|
inactive: z.ZodNumber;
|
|
78
|
+
invalid: z.ZodNumber;
|
|
87
79
|
}, z.core.$strip>;
|
|
88
80
|
createdAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
|
|
89
81
|
}, z.core.$strip>;
|
|
@@ -101,12 +93,12 @@ export declare const SuppressionListList: z.ZodObject<{
|
|
|
101
93
|
reply: z.ZodNumber;
|
|
102
94
|
complaint: z.ZodNumber;
|
|
103
95
|
inactive: z.ZodNumber;
|
|
96
|
+
invalid: z.ZodNumber;
|
|
104
97
|
}, z.core.$strip>;
|
|
105
98
|
createdAt: z.ZodNullable<z.ZodPreprocess<z.ZodDate, Date>>;
|
|
106
99
|
}, z.core.$strip>>;
|
|
107
100
|
}, z.core.$strip>;
|
|
108
101
|
export type SuppressionListList = z.infer<typeof SuppressionListList>;
|
|
109
|
-
/** A detected opt-out waiting for a person (optOutHandling "review"). */
|
|
110
102
|
export declare const SuppressionReview: z.ZodObject<{
|
|
111
103
|
id: z.ZodUUID;
|
|
112
104
|
listId: z.ZodString;
|
|
@@ -166,22 +158,27 @@ export declare const UpdateSuppressionList: z.ZodObject<{
|
|
|
166
158
|
}, z.core.$strip>;
|
|
167
159
|
export type UpdateSuppressionList = z.infer<typeof UpdateSuppressionList>;
|
|
168
160
|
export declare const DeleteSuppressionListQuery: z.ZodObject<{
|
|
169
|
-
withEntries: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
161
|
+
withEntries: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [
|
|
162
|
+
z.ZodBoolean,
|
|
163
|
+
z.ZodEnum<{
|
|
164
|
+
true: "true";
|
|
165
|
+
false: "false";
|
|
166
|
+
}>
|
|
167
|
+
]>, z.ZodTransform<boolean, boolean | "true" | "false">>>;
|
|
173
168
|
}, z.core.$strip>;
|
|
174
169
|
export type DeleteSuppressionListQuery = z.infer<typeof DeleteSuppressionListQuery>;
|
|
175
|
-
/** The path's list and the query's options, as a DELETE takes them. */
|
|
176
170
|
export declare const DeleteSuppressionListInput: z.ZodObject<{
|
|
177
171
|
params: z.ZodObject<{
|
|
178
172
|
listId: z.ZodString;
|
|
179
173
|
}, z.core.$strip>;
|
|
180
174
|
query: z.ZodObject<{
|
|
181
|
-
withEntries: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
175
|
+
withEntries: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [
|
|
176
|
+
z.ZodBoolean,
|
|
177
|
+
z.ZodEnum<{
|
|
178
|
+
true: "true";
|
|
179
|
+
false: "false";
|
|
180
|
+
}>
|
|
181
|
+
]>, z.ZodTransform<boolean, boolean | "true" | "false">>>;
|
|
185
182
|
}, z.core.$strip>;
|
|
186
183
|
}, z.core.$strip>;
|
|
187
184
|
export type DeleteSuppressionListInput = z.infer<typeof DeleteSuppressionListInput>;
|
|
@@ -191,6 +188,7 @@ export declare const ListSuppressionEntriesQuery: z.ZodObject<{
|
|
|
191
188
|
address: z.ZodOptional<z.ZodString>;
|
|
192
189
|
source: z.ZodOptional<z.ZodEnum<{
|
|
193
190
|
api: "api";
|
|
191
|
+
invalid: "invalid";
|
|
194
192
|
bounce: "bounce";
|
|
195
193
|
unsubscribe: "unsubscribe";
|
|
196
194
|
reply: "reply";
|
|
@@ -199,14 +197,11 @@ export declare const ListSuppressionEntriesQuery: z.ZodObject<{
|
|
|
199
197
|
}>>;
|
|
200
198
|
}, z.core.$strip>;
|
|
201
199
|
export type ListSuppressionEntriesQuery = z.infer<typeof ListSuppressionEntriesQuery>;
|
|
202
|
-
/** Addresses to put on a list; a repeated address counts once. */
|
|
203
200
|
export declare const AddSuppressionEntriesRequest: z.ZodObject<{
|
|
204
201
|
addresses: z.ZodArray<z.ZodEmail>;
|
|
205
202
|
reason: z.ZodOptional<z.ZodString>;
|
|
206
203
|
}, z.core.$strip>;
|
|
207
204
|
export type AddSuppressionEntriesRequest = z.infer<typeof AddSuppressionEntriesRequest>;
|
|
208
|
-
/** An entry of a list, by its address. Any stored address can be released, including one an
|
|
209
|
-
* older rule let in. */
|
|
210
205
|
export declare const SuppressionEntryInput: z.ZodObject<{
|
|
211
206
|
listId: z.ZodString;
|
|
212
207
|
address: z.ZodString;
|
|
@@ -218,12 +213,10 @@ export declare const ListSuppressionReviewsQuery: z.ZodObject<{
|
|
|
218
213
|
listId: z.ZodOptional<z.ZodString>;
|
|
219
214
|
}, z.core.$strip>;
|
|
220
215
|
export type ListSuppressionReviewsQuery = z.infer<typeof ListSuppressionReviewsQuery>;
|
|
221
|
-
/** added: false when the address was on the list already, which is left as it was. */
|
|
222
216
|
export declare const SuppressionAdded: z.ZodObject<{
|
|
223
217
|
added: z.ZodBoolean;
|
|
224
218
|
}, z.core.$strip>;
|
|
225
219
|
export type SuppressionAdded = z.infer<typeof SuppressionAdded>;
|
|
226
|
-
/** added: addresses put on the list; alreadyListed: those on it already, left as they were. */
|
|
227
220
|
export declare const SuppressionEntriesAdded: z.ZodObject<{
|
|
228
221
|
added: z.ZodNumber;
|
|
229
222
|
alreadyListed: z.ZodNumber;
|