samva 0.18.0 → 0.19.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 +2 -0
- package/dist/client/sdk.gen.d.ts +39 -23
- package/dist/client/sdk.gen.js +83 -21
- package/dist/client/types.gen.d.ts +175 -44
- package/dist/effect/contact-groups.d.ts +39 -3
- package/dist/effect/contacts.d.ts +216 -13
- package/dist/effect/contacts.js +3 -1
- package/dist/effect/conversations.d.ts +11 -11
- package/dist/effect/extension-installations.d.ts +12 -12
- package/dist/effect/extensions.d.ts +3 -3
- package/dist/effect/generated/contact-groups.d.ts +33 -3
- package/dist/effect/generated/contacts.d.ts +477 -54
- package/dist/effect/generated/contacts.js +39 -9
- package/dist/effect/generated/conversations.d.ts +25 -25
- package/dist/effect/generated/conversations.js +1 -1
- package/dist/effect/generated/extension-installations.d.ts +44 -44
- package/dist/effect/generated/extension-installations.js +6 -0
- package/dist/effect/generated/extensions.d.ts +10 -10
- package/dist/effect/generated/extensions.js +2 -0
- package/dist/effect/generated/mailboxes.d.ts +310 -0
- package/dist/effect/generated/mailboxes.js +37 -4
- package/dist/effect/generated/messages.d.ts +31 -0
- package/dist/effect/generated/messages.js +7 -1
- package/dist/effect/generated/organizations.d.ts +13 -11
- package/dist/effect/generated/organizations.js +7 -3
- package/dist/effect/generated/shared.d.ts +70 -20
- package/dist/effect/generated/shared.js +27 -7
- package/dist/effect/generated/unsubscribe-groups.d.ts +173 -78
- package/dist/effect/generated/unsubscribe-groups.js +75 -58
- package/dist/effect/generated/webhooks.d.ts +19 -19
- package/dist/effect/generated/webhooks.js +8 -0
- package/dist/effect/generated-metadata.d.ts +7 -2
- package/dist/effect/generated-metadata.js +331 -325
- package/dist/effect/mailboxes.d.ts +133 -1
- package/dist/effect/messages.d.ts +5 -0
- package/dist/effect/organizations.d.ts +4 -4
- package/dist/effect/unsubscribe-groups.d.ts +29 -18
- package/dist/effect/unsubscribe-groups.js +5 -5
- package/dist/effect/webhooks.d.ts +8 -8
- package/dist/mailbox-events.d.ts +31 -4
- package/dist/mailbox-events.js +39 -11
- package/dist/package.js +1 -1
- package/dist/promises/index.d.ts +1 -1
- package/dist/promises/types.gen.d.ts +1 -1
- package/dist/service-map.d.ts +9 -4
- package/dist/service-map.js +10 -2
- package/package.json +2 -2
|
@@ -1,12 +1,28 @@
|
|
|
1
|
-
import { ApiKeySecurityMiddleware, ConflictError, Cursor, ForbiddenError, GatewayTimeoutError, InternalError, ResourceNotFoundError, UnauthorizedError, UnsubscribeId, ValidationError } from "./shared.js";
|
|
1
|
+
import { ApiKeySecurityMiddleware, BillingProviderError, ConflictError, ContactId, Cursor, ForbiddenError, GatewayTimeoutError, InternalError, PaymentRequiredError, ResourceNotFoundError, UnauthorizedError, UnsubscribeId, ValidationError } from "./shared.js";
|
|
2
2
|
import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
|
|
3
3
|
import * as Schema from "effect/Schema";
|
|
4
4
|
//#region src/effect/generated/unsubscribe-groups.ts
|
|
5
|
+
const UnsubscribeGroupMemberId = /* @__PURE__ */ Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^unsubm_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
|
|
6
|
+
expected: "a string matching the RegExp ^unsubm_[0-9a-hjkmnp-tv-z]{16,24}$",
|
|
7
|
+
identifier: "UnsubscribeGroupMemberId"
|
|
8
|
+
})).pipe(Schema.brand("UnsubscribeGroupMemberId"));
|
|
9
|
+
const UnsubscribeGroupMemberByEmail = /* @__PURE__ */ Schema.Struct({ email: Schema.String }).annotate({ identifier: "UnsubscribeGroupMemberByEmail" });
|
|
10
|
+
const UnsubscribeGroupMemberByPhone = /* @__PURE__ */ Schema.Struct({ phone: Schema.String }).annotate({ identifier: "UnsubscribeGroupMemberByPhone" });
|
|
11
|
+
const UnsubscribeGroupList = /* @__PURE__ */ Schema.Struct({ items: Schema.Array(Schema.Struct({
|
|
12
|
+
id: UnsubscribeId,
|
|
13
|
+
organizationId: Schema.String,
|
|
14
|
+
name: Schema.String,
|
|
15
|
+
description: Schema.Union([Schema.String, Schema.Null]),
|
|
16
|
+
isDefault: Schema.Boolean,
|
|
17
|
+
memberCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
|
|
18
|
+
createdAt: Schema.String,
|
|
19
|
+
updatedAt: Schema.String
|
|
20
|
+
})).check(Schema.isMaxLength(200).annotate({ expected: "a value with a length of at most 200" })) }).annotate({ identifier: "UnsubscribeGroupList" });
|
|
21
|
+
const UnsubscribeGroupMemberByContact = /* @__PURE__ */ Schema.Struct({ contactId: ContactId }).annotate({ identifier: "UnsubscribeGroupMemberByContact" });
|
|
5
22
|
const UnsubscribeGroupMemberPage = /* @__PURE__ */ Schema.Struct({
|
|
6
23
|
items: Schema.Array(Schema.Struct({
|
|
7
|
-
id:
|
|
8
|
-
|
|
9
|
-
contactId: Schema.Union([Schema.String, Schema.Null]),
|
|
24
|
+
id: UnsubscribeGroupMemberId,
|
|
25
|
+
contactId: ContactId,
|
|
10
26
|
source: Schema.Union([
|
|
11
27
|
Schema.Literal("link"),
|
|
12
28
|
Schema.Literal("api"),
|
|
@@ -18,16 +34,11 @@ const UnsubscribeGroupMemberPage = /* @__PURE__ */ Schema.Struct({
|
|
|
18
34
|
})),
|
|
19
35
|
nextCursor: Schema.Union([Schema.String, Schema.Null])
|
|
20
36
|
}).annotate({ identifier: "UnsubscribeGroupMemberPage" });
|
|
21
|
-
const
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
isDefault: Schema.Boolean,
|
|
27
|
-
memberCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
|
|
28
|
-
createdAt: Schema.String,
|
|
29
|
-
updatedAt: Schema.String
|
|
30
|
-
})).check(Schema.isMaxLength(200).annotate({ expected: "a value with a length of at most 200" })) }).annotate({ identifier: "UnsubscribeGroupList" });
|
|
37
|
+
const UnsubscribeGroupMemberRef = /* @__PURE__ */ Schema.Union([
|
|
38
|
+
UnsubscribeGroupMemberByContact,
|
|
39
|
+
UnsubscribeGroupMemberByEmail,
|
|
40
|
+
UnsubscribeGroupMemberByPhone
|
|
41
|
+
]).annotate({ identifier: "UnsubscribeGroupMemberRef" });
|
|
31
42
|
const UnsubscribeList200 = UnsubscribeGroupList;
|
|
32
43
|
const UnsubscribeList401 = UnauthorizedError;
|
|
33
44
|
const UnsubscribeList403 = ForbiddenError;
|
|
@@ -113,9 +124,9 @@ const UnsubscribeListMembers404 = ResourceNotFoundError;
|
|
|
113
124
|
const UnsubscribeListMembers422 = ValidationError;
|
|
114
125
|
const UnsubscribeListMembers500 = InternalError;
|
|
115
126
|
const UnsubscribeListMembers504 = GatewayTimeoutError;
|
|
116
|
-
const
|
|
117
|
-
const
|
|
118
|
-
|
|
127
|
+
const UnsubscribeAddMembersPathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
|
|
128
|
+
const UnsubscribeAddMembersRequestJson = /* @__PURE__ */ Schema.Struct({
|
|
129
|
+
members: Schema.Array(UnsubscribeGroupMemberRef).check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })),
|
|
119
130
|
source: Schema.optionalKey(Schema.Union([Schema.Union([
|
|
120
131
|
Schema.Literal("link"),
|
|
121
132
|
Schema.Literal("api"),
|
|
@@ -123,31 +134,35 @@ const UnsubscribeAddEmailsRequestJson = /* @__PURE__ */ Schema.Struct({
|
|
|
123
134
|
Schema.Literal("complaint")
|
|
124
135
|
]), Schema.Null]))
|
|
125
136
|
});
|
|
126
|
-
const
|
|
137
|
+
const UnsubscribeAddMembers200 = /* @__PURE__ */ Schema.Struct({
|
|
127
138
|
added: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
|
|
128
139
|
skipped: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
|
|
129
140
|
});
|
|
130
|
-
const
|
|
131
|
-
const
|
|
132
|
-
const
|
|
133
|
-
const
|
|
134
|
-
const
|
|
135
|
-
const
|
|
136
|
-
const
|
|
137
|
-
const
|
|
138
|
-
const
|
|
139
|
-
const
|
|
140
|
-
const
|
|
141
|
-
const
|
|
142
|
-
const
|
|
143
|
-
const
|
|
144
|
-
const
|
|
141
|
+
const UnsubscribeAddMembers401 = UnauthorizedError;
|
|
142
|
+
const UnsubscribeAddMembers402 = PaymentRequiredError;
|
|
143
|
+
const UnsubscribeAddMembers403 = ForbiddenError;
|
|
144
|
+
const UnsubscribeAddMembers404 = ResourceNotFoundError;
|
|
145
|
+
const UnsubscribeAddMembers422 = ValidationError;
|
|
146
|
+
const UnsubscribeAddMembers500 = InternalError;
|
|
147
|
+
const UnsubscribeAddMembers502 = BillingProviderError;
|
|
148
|
+
const UnsubscribeAddMembers504 = GatewayTimeoutError;
|
|
149
|
+
const UnsubscribeRemoveMembersPathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
|
|
150
|
+
const UnsubscribeRemoveMembersRequestJson = /* @__PURE__ */ Schema.Struct({ members: Schema.Array(UnsubscribeGroupMemberRef).check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })) });
|
|
151
|
+
const UnsubscribeRemoveMembers200 = /* @__PURE__ */ Schema.Struct({ removed: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })) });
|
|
152
|
+
const UnsubscribeRemoveMembers401 = UnauthorizedError;
|
|
153
|
+
const UnsubscribeRemoveMembers403 = ForbiddenError;
|
|
154
|
+
const UnsubscribeRemoveMembers404 = ResourceNotFoundError;
|
|
155
|
+
const UnsubscribeRemoveMembers422 = ValidationError;
|
|
156
|
+
const UnsubscribeRemoveMembers500 = InternalError;
|
|
157
|
+
const UnsubscribeRemoveMembers504 = GatewayTimeoutError;
|
|
145
158
|
const UnsubscribeCheckSubscriptionQuery = /* @__PURE__ */ Schema.Struct({
|
|
146
|
-
|
|
159
|
+
contactId: Schema.optionalKey(Schema.Union([ContactId, Schema.Null])),
|
|
160
|
+
email: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
|
|
161
|
+
phone: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
|
|
147
162
|
groupIds: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]))
|
|
148
163
|
});
|
|
149
164
|
const UnsubscribeCheckSubscription200 = /* @__PURE__ */ Schema.Struct({
|
|
150
|
-
|
|
165
|
+
contactId: Schema.Union([ContactId, Schema.Null]),
|
|
151
166
|
unsubscribedGroups: Schema.Array(Schema.Struct({
|
|
152
167
|
groupId: Schema.String,
|
|
153
168
|
groupName: Schema.String,
|
|
@@ -226,31 +241,33 @@ var UnsubscribeGroupsGroup = class extends HttpApiGroup.make("Unsubscribe Groups
|
|
|
226
241
|
UnsubscribeListMembers500,
|
|
227
242
|
UnsubscribeListMembers504.pipe(HttpApiSchema.status(504))
|
|
228
243
|
]
|
|
229
|
-
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.listMembers").annotate(OpenApi.Summary, "List unsubscribe group members").annotate(OpenApi.Description, "Returns the
|
|
230
|
-
params:
|
|
231
|
-
payload:
|
|
232
|
-
success:
|
|
244
|
+
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.listMembers").annotate(OpenApi.Summary, "List unsubscribe group members").annotate(OpenApi.Description, "Returns the contacts that have left an unsubscribe group, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page."), HttpApiEndpoint.post("unsubscribeAddMembers", "/v1/unsubscribe-groups/:id/members", {
|
|
245
|
+
params: UnsubscribeAddMembersPathParams,
|
|
246
|
+
payload: UnsubscribeAddMembersRequestJson,
|
|
247
|
+
success: UnsubscribeAddMembers200,
|
|
233
248
|
error: [
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
249
|
+
UnsubscribeAddMembers401.pipe(HttpApiSchema.status(401)),
|
|
250
|
+
UnsubscribeAddMembers402.pipe(HttpApiSchema.status(402)),
|
|
251
|
+
UnsubscribeAddMembers403.pipe(HttpApiSchema.status(403)),
|
|
252
|
+
UnsubscribeAddMembers404.pipe(HttpApiSchema.status(404)),
|
|
253
|
+
UnsubscribeAddMembers422.pipe(HttpApiSchema.status(422)),
|
|
254
|
+
UnsubscribeAddMembers500,
|
|
255
|
+
UnsubscribeAddMembers502.pipe(HttpApiSchema.status(502)),
|
|
256
|
+
UnsubscribeAddMembers504.pipe(HttpApiSchema.status(504))
|
|
240
257
|
]
|
|
241
|
-
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.
|
|
242
|
-
params:
|
|
243
|
-
payload:
|
|
244
|
-
success:
|
|
258
|
+
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.addMembers").annotate(OpenApi.Summary, "Add contacts to an unsubscribe group").annotate(OpenApi.Description, "Moves contacts out of an unsubscribe group's audience and returns the number added and the number skipped. Leaving a group stops that group's sends to the contact on every channel. Each member is a contact ID, an email address, or a phone number; an address no contact holds gets a new contact, so an import from another email service needs no contacts first."), HttpApiEndpoint.delete("unsubscribeRemoveMembers", "/v1/unsubscribe-groups/:id/members", {
|
|
259
|
+
params: UnsubscribeRemoveMembersPathParams,
|
|
260
|
+
payload: UnsubscribeRemoveMembersRequestJson,
|
|
261
|
+
success: UnsubscribeRemoveMembers200,
|
|
245
262
|
error: [
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
263
|
+
UnsubscribeRemoveMembers401.pipe(HttpApiSchema.status(401)),
|
|
264
|
+
UnsubscribeRemoveMembers403.pipe(HttpApiSchema.status(403)),
|
|
265
|
+
UnsubscribeRemoveMembers404.pipe(HttpApiSchema.status(404)),
|
|
266
|
+
UnsubscribeRemoveMembers422.pipe(HttpApiSchema.status(422)),
|
|
267
|
+
UnsubscribeRemoveMembers500,
|
|
268
|
+
UnsubscribeRemoveMembers504.pipe(HttpApiSchema.status(504))
|
|
252
269
|
]
|
|
253
|
-
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.
|
|
270
|
+
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.removeMembers").annotate(OpenApi.Summary, "Remove contacts from an unsubscribe group").annotate(OpenApi.Description, "Returns contacts to an unsubscribe group's audience and returns the number removed. Each member is a contact ID, an email address, or a phone number; an address no contact holds is skipped."), HttpApiEndpoint.get("unsubscribeCheckSubscription", "/v1/unsubscribe-groups/check", {
|
|
254
271
|
query: UnsubscribeCheckSubscriptionQuery,
|
|
255
272
|
success: UnsubscribeCheckSubscription200,
|
|
256
273
|
error: [
|
|
@@ -260,8 +277,8 @@ var UnsubscribeGroupsGroup = class extends HttpApiGroup.make("Unsubscribe Groups
|
|
|
260
277
|
UnsubscribeCheckSubscription500,
|
|
261
278
|
UnsubscribeCheckSubscription504.pipe(HttpApiSchema.status(504))
|
|
262
279
|
]
|
|
263
|
-
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.checkSubscription").annotate(OpenApi.Summary, "Check unsubscribe group membership").annotate(OpenApi.Description, "Returns the unsubscribe groups
|
|
280
|
+
}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.checkSubscription").annotate(OpenApi.Summary, "Check unsubscribe group membership").annotate(OpenApi.Description, "Returns the unsubscribe groups a contact has left, optionally limited to a specified set of groups. Name the contact by exactly one of `contactId`, `email`, or `phone`. Membership belongs to the contact, so the answer is the same whichever identifier names it; `contactId` is null, and no groups are returned, when no contact holds the email or phone.")).annotate(OpenApi.Description, "Manage unsubscribe groups and members") {};
|
|
264
281
|
//#endregion
|
|
265
|
-
export {
|
|
282
|
+
export { UnsubscribeAddMembers200, UnsubscribeAddMembers401, UnsubscribeAddMembers402, UnsubscribeAddMembers403, UnsubscribeAddMembers404, UnsubscribeAddMembers422, UnsubscribeAddMembers500, UnsubscribeAddMembers502, UnsubscribeAddMembers504, UnsubscribeAddMembersPathParams, UnsubscribeAddMembersRequestJson, UnsubscribeCheckSubscription200, UnsubscribeCheckSubscription401, UnsubscribeCheckSubscription403, UnsubscribeCheckSubscription422, UnsubscribeCheckSubscription500, UnsubscribeCheckSubscription504, UnsubscribeCheckSubscriptionQuery, UnsubscribeCreate201, UnsubscribeCreate401, UnsubscribeCreate403, UnsubscribeCreate409, UnsubscribeCreate422, UnsubscribeCreate500, UnsubscribeCreate504, UnsubscribeCreateRequestJson, UnsubscribeGroupList, UnsubscribeGroupMemberByContact, UnsubscribeGroupMemberByEmail, UnsubscribeGroupMemberByPhone, UnsubscribeGroupMemberId, UnsubscribeGroupMemberPage, UnsubscribeGroupMemberRef, UnsubscribeGroupsGroup, UnsubscribeList200, UnsubscribeList401, UnsubscribeList403, UnsubscribeList422, UnsubscribeList500, UnsubscribeList504, UnsubscribeListMembers200, UnsubscribeListMembers401, UnsubscribeListMembers403, UnsubscribeListMembers404, UnsubscribeListMembers422, UnsubscribeListMembers500, UnsubscribeListMembers504, UnsubscribeListMembersPathParams, UnsubscribeListMembersQuery, UnsubscribeRemove200, UnsubscribeRemove401, UnsubscribeRemove403, UnsubscribeRemove404, UnsubscribeRemove409, UnsubscribeRemove422, UnsubscribeRemove500, UnsubscribeRemove504, UnsubscribeRemoveMembers200, UnsubscribeRemoveMembers401, UnsubscribeRemoveMembers403, UnsubscribeRemoveMembers404, UnsubscribeRemoveMembers422, UnsubscribeRemoveMembers500, UnsubscribeRemoveMembers504, UnsubscribeRemoveMembersPathParams, UnsubscribeRemoveMembersRequestJson, UnsubscribeRemovePathParams, UnsubscribeSetDefault200, UnsubscribeSetDefault401, UnsubscribeSetDefault403, UnsubscribeSetDefault404, UnsubscribeSetDefault422, UnsubscribeSetDefault500, UnsubscribeSetDefault504, UnsubscribeSetDefaultPathParams, UnsubscribeUpdate200, UnsubscribeUpdate401, UnsubscribeUpdate403, UnsubscribeUpdate404, UnsubscribeUpdate422, UnsubscribeUpdate500, UnsubscribeUpdate504, UnsubscribeUpdatePathParams, UnsubscribeUpdateRequestJson };
|
|
266
283
|
|
|
267
284
|
//# sourceMappingURL=unsubscribe-groups.js.map
|
|
@@ -40,7 +40,7 @@ export type WebhookEndpoint = {
|
|
|
40
40
|
readonly id: WebhookEndpointId;
|
|
41
41
|
readonly name: string;
|
|
42
42
|
readonly url: string;
|
|
43
|
-
readonly eventTypes: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
43
|
+
readonly eventTypes: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "contact.consent_changed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
44
44
|
readonly channels: ReadonlyArray<"email"> | null;
|
|
45
45
|
readonly mailboxIds: ReadonlyArray<MailboxId> | null;
|
|
46
46
|
readonly namespaceId: NamespaceId | null;
|
|
@@ -55,7 +55,7 @@ export declare const WebhookEndpoint: Schema.Struct<{
|
|
|
55
55
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
56
56
|
readonly name: Schema.String;
|
|
57
57
|
readonly url: Schema.String;
|
|
58
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
58
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
59
59
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
60
60
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
61
61
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -70,7 +70,7 @@ export type WebhookEndpointListItem = {
|
|
|
70
70
|
readonly id: WebhookEndpointId;
|
|
71
71
|
readonly name: string;
|
|
72
72
|
readonly url: string;
|
|
73
|
-
readonly eventTypes: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
73
|
+
readonly eventTypes: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "contact.consent_changed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
74
74
|
readonly channels: ReadonlyArray<"email"> | null;
|
|
75
75
|
readonly mailboxIds: ReadonlyArray<MailboxId> | null;
|
|
76
76
|
readonly namespaceId: NamespaceId | null;
|
|
@@ -86,7 +86,7 @@ export declare const WebhookEndpointListItem: Schema.Struct<{
|
|
|
86
86
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
87
87
|
readonly name: Schema.String;
|
|
88
88
|
readonly url: Schema.String;
|
|
89
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
89
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
90
90
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
91
91
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
92
92
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -197,7 +197,7 @@ export declare const WebhookEndpointPage: Schema.Struct<{
|
|
|
197
197
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
198
198
|
readonly name: Schema.String;
|
|
199
199
|
readonly url: Schema.String;
|
|
200
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
200
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
201
201
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
202
202
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
203
203
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -235,7 +235,7 @@ export declare const WebhooksList200: Schema.Struct<{
|
|
|
235
235
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
236
236
|
readonly name: Schema.String;
|
|
237
237
|
readonly url: Schema.String;
|
|
238
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
238
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
239
239
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
240
240
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
241
241
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -268,7 +268,7 @@ export declare const WebhooksList504: typeof GatewayTimeoutError;
|
|
|
268
268
|
export type WebhooksCreateRequestJson = {
|
|
269
269
|
readonly name: string;
|
|
270
270
|
readonly url: string;
|
|
271
|
-
readonly eventTypes: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
271
|
+
readonly eventTypes: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "contact.consent_changed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook">;
|
|
272
272
|
readonly channels?: ReadonlyArray<"email"> | null;
|
|
273
273
|
readonly mailboxIds?: readonly [MailboxId, ...Array<MailboxId>] | null;
|
|
274
274
|
readonly namespaceId?: NamespaceId | null;
|
|
@@ -280,7 +280,7 @@ export type WebhooksCreateRequestJson = {
|
|
|
280
280
|
export declare const WebhooksCreateRequestJson: Schema.Struct<{
|
|
281
281
|
readonly name: Schema.String;
|
|
282
282
|
readonly url: Schema.String;
|
|
283
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
283
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
284
284
|
readonly channels: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>>;
|
|
285
285
|
readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>>;
|
|
286
286
|
readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>>;
|
|
@@ -296,7 +296,7 @@ export declare const WebhooksCreate201: Schema.Struct<{
|
|
|
296
296
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
297
297
|
readonly name: Schema.String;
|
|
298
298
|
readonly url: Schema.String;
|
|
299
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
299
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
300
300
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
301
301
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
302
302
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -338,7 +338,7 @@ export declare const WebhooksGet200: Schema.Struct<{
|
|
|
338
338
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
339
339
|
readonly name: Schema.String;
|
|
340
340
|
readonly url: Schema.String;
|
|
341
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
341
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
342
342
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
343
343
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
344
344
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -394,7 +394,7 @@ export declare const WebhooksUpdatePathParams: Schema.Struct<{
|
|
|
394
394
|
export type WebhooksUpdateRequestJson = {
|
|
395
395
|
readonly name?: string | null;
|
|
396
396
|
readonly url?: string | null;
|
|
397
|
-
readonly eventTypes?: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook"> | null;
|
|
397
|
+
readonly eventTypes?: ReadonlyArray<"message.sent" | "message.delivered" | "message.read" | "message.failed" | "message.bounced" | "message.complained" | "message.received" | "message.opened" | "message.clicked" | "contact.created" | "contact.updated" | "contact.deleted" | "contact.subscribed" | "contact.unsubscribed" | "contact.resubscribed" | "contact.consent_changed" | "conversation.created" | "conversation.updated" | "conversation.archived" | "webhook.created" | "webhook.updated" | "webhook.deleted" | "webhook.test" | "domain.updated" | "domain.warming.updated" | "mailbox.message.received" | "mailbox.message.sent" | "mailbox.action.pending_approval" | "mailbox.action.resolved" | "mailbox.message.quarantined" | "mailbox.message.released" | "mailbox.message.discarded" | "journey.webhook"> | null;
|
|
398
398
|
readonly channels?: ReadonlyArray<"email"> | null | null;
|
|
399
399
|
readonly mailboxIds?: readonly [MailboxId, ...Array<MailboxId>] | null | null;
|
|
400
400
|
readonly namespaceId?: NamespaceId | null | null;
|
|
@@ -406,7 +406,7 @@ export type WebhooksUpdateRequestJson = {
|
|
|
406
406
|
export declare const WebhooksUpdateRequestJson: Schema.Struct<{
|
|
407
407
|
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
408
408
|
readonly url: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
409
|
-
readonly eventTypes: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>, Schema.Null]>>;
|
|
409
|
+
readonly eventTypes: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>, Schema.Null]>>;
|
|
410
410
|
readonly channels: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>, Schema.Null]>>;
|
|
411
411
|
readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>, Schema.Null]>>;
|
|
412
412
|
readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>, Schema.Null]>>;
|
|
@@ -418,7 +418,7 @@ export declare const WebhooksUpdate200: Schema.Struct<{
|
|
|
418
418
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
419
419
|
readonly name: Schema.String;
|
|
420
420
|
readonly url: Schema.String;
|
|
421
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
421
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
422
422
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
423
423
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
424
424
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -638,7 +638,7 @@ export declare const WebhooksTest504: typeof GatewayTimeoutError;
|
|
|
638
638
|
declare const WebhooksGroup_base: HttpApiGroup.HttpApiGroup<"Webhooks", HttpApiEndpoint.HttpApiEndpoint<"webhooksCreate", "POST", "/v1/webhooks", never, never, Schema.toCodecJson<Schema.Struct<{
|
|
639
639
|
readonly name: Schema.String;
|
|
640
640
|
readonly url: Schema.String;
|
|
641
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
641
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
642
642
|
readonly channels: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>>;
|
|
643
643
|
readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>>;
|
|
644
644
|
readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>>;
|
|
@@ -649,7 +649,7 @@ declare const WebhooksGroup_base: HttpApiGroup.HttpApiGroup<"Webhooks", HttpApiE
|
|
|
649
649
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
650
650
|
readonly name: Schema.String;
|
|
651
651
|
readonly url: Schema.String;
|
|
652
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
652
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
653
653
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
654
654
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
655
655
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -803,7 +803,7 @@ declare const WebhooksGroup_base: HttpApiGroup.HttpApiGroup<"Webhooks", HttpApiE
|
|
|
803
803
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
804
804
|
readonly name: Schema.String;
|
|
805
805
|
readonly url: Schema.String;
|
|
806
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
806
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
807
807
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
808
808
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
809
809
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -1115,7 +1115,7 @@ declare const WebhooksGroup_base: HttpApiGroup.HttpApiGroup<"Webhooks", HttpApiE
|
|
|
1115
1115
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
1116
1116
|
readonly name: Schema.String;
|
|
1117
1117
|
readonly url: Schema.String;
|
|
1118
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
1118
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
1119
1119
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
1120
1120
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
1121
1121
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -1571,7 +1571,7 @@ declare const WebhooksGroup_base: HttpApiGroup.HttpApiGroup<"Webhooks", HttpApiE
|
|
|
1571
1571
|
}>>, never, Schema.toCodecJson<Schema.Struct<{
|
|
1572
1572
|
readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1573
1573
|
readonly url: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
|
|
1574
|
-
readonly eventTypes: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>, Schema.Null]>>;
|
|
1574
|
+
readonly eventTypes: Schema.optionalKey<Schema.Union<readonly [Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>, Schema.Null]>>;
|
|
1575
1575
|
readonly channels: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>, Schema.Null]>>;
|
|
1576
1576
|
readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>, Schema.Null]>>;
|
|
1577
1577
|
readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>, Schema.Null]>>;
|
|
@@ -1581,7 +1581,7 @@ declare const WebhooksGroup_base: HttpApiGroup.HttpApiGroup<"Webhooks", HttpApiE
|
|
|
1581
1581
|
readonly id: Schema.brand<Schema.String, "WebhookEndpointId">;
|
|
1582
1582
|
readonly name: Schema.String;
|
|
1583
1583
|
readonly url: Schema.String;
|
|
1584
|
-
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
1584
|
+
readonly eventTypes: Schema.$Array<Schema.Union<readonly [Schema.Literal<"message.sent">, Schema.Literal<"message.delivered">, Schema.Literal<"message.read">, Schema.Literal<"message.failed">, Schema.Literal<"message.bounced">, Schema.Literal<"message.complained">, Schema.Literal<"message.received">, Schema.Literal<"message.opened">, Schema.Literal<"message.clicked">, Schema.Literal<"contact.created">, Schema.Literal<"contact.updated">, Schema.Literal<"contact.deleted">, Schema.Literal<"contact.subscribed">, Schema.Literal<"contact.unsubscribed">, Schema.Literal<"contact.resubscribed">, Schema.Literal<"contact.consent_changed">, Schema.Literal<"conversation.created">, Schema.Literal<"conversation.updated">, Schema.Literal<"conversation.archived">, Schema.Literal<"webhook.created">, Schema.Literal<"webhook.updated">, Schema.Literal<"webhook.deleted">, Schema.Literal<"webhook.test">, Schema.Literal<"domain.updated">, Schema.Literal<"domain.warming.updated">, Schema.Literal<"mailbox.message.received">, Schema.Literal<"mailbox.message.sent">, Schema.Literal<"mailbox.action.pending_approval">, Schema.Literal<"mailbox.action.resolved">, Schema.Literal<"mailbox.message.quarantined">, Schema.Literal<"mailbox.message.released">, Schema.Literal<"mailbox.message.discarded">, Schema.Literal<"journey.webhook">]>>;
|
|
1585
1585
|
readonly channels: Schema.Union<readonly [Schema.$Array<Schema.Literal<"email">>, Schema.Null]>;
|
|
1586
1586
|
readonly mailboxIds: Schema.Union<readonly [Schema.$Array<Schema.brand<Schema.String, "MailboxId">>, Schema.Null]>;
|
|
1587
1587
|
readonly namespaceId: Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>;
|
|
@@ -49,6 +49,7 @@ const WebhookEndpoint = /* @__PURE__ */ Schema.Struct({
|
|
|
49
49
|
Schema.Literal("contact.subscribed"),
|
|
50
50
|
Schema.Literal("contact.unsubscribed"),
|
|
51
51
|
Schema.Literal("contact.resubscribed"),
|
|
52
|
+
Schema.Literal("contact.consent_changed"),
|
|
52
53
|
Schema.Literal("conversation.created"),
|
|
53
54
|
Schema.Literal("conversation.updated"),
|
|
54
55
|
Schema.Literal("conversation.archived"),
|
|
@@ -61,6 +62,7 @@ const WebhookEndpoint = /* @__PURE__ */ Schema.Struct({
|
|
|
61
62
|
Schema.Literal("mailbox.message.received"),
|
|
62
63
|
Schema.Literal("mailbox.message.sent"),
|
|
63
64
|
Schema.Literal("mailbox.action.pending_approval"),
|
|
65
|
+
Schema.Literal("mailbox.action.resolved"),
|
|
64
66
|
Schema.Literal("mailbox.message.quarantined"),
|
|
65
67
|
Schema.Literal("mailbox.message.released"),
|
|
66
68
|
Schema.Literal("mailbox.message.discarded"),
|
|
@@ -96,6 +98,7 @@ const WebhookEndpointListItem = /* @__PURE__ */ Schema.Struct({
|
|
|
96
98
|
Schema.Literal("contact.subscribed"),
|
|
97
99
|
Schema.Literal("contact.unsubscribed"),
|
|
98
100
|
Schema.Literal("contact.resubscribed"),
|
|
101
|
+
Schema.Literal("contact.consent_changed"),
|
|
99
102
|
Schema.Literal("conversation.created"),
|
|
100
103
|
Schema.Literal("conversation.updated"),
|
|
101
104
|
Schema.Literal("conversation.archived"),
|
|
@@ -108,6 +111,7 @@ const WebhookEndpointListItem = /* @__PURE__ */ Schema.Struct({
|
|
|
108
111
|
Schema.Literal("mailbox.message.received"),
|
|
109
112
|
Schema.Literal("mailbox.message.sent"),
|
|
110
113
|
Schema.Literal("mailbox.action.pending_approval"),
|
|
114
|
+
Schema.Literal("mailbox.action.resolved"),
|
|
111
115
|
Schema.Literal("mailbox.message.quarantined"),
|
|
112
116
|
Schema.Literal("mailbox.message.released"),
|
|
113
117
|
Schema.Literal("mailbox.message.discarded"),
|
|
@@ -208,6 +212,7 @@ const WebhooksCreateRequestJson = /* @__PURE__ */ Schema.Struct({
|
|
|
208
212
|
Schema.Literal("contact.subscribed"),
|
|
209
213
|
Schema.Literal("contact.unsubscribed"),
|
|
210
214
|
Schema.Literal("contact.resubscribed"),
|
|
215
|
+
Schema.Literal("contact.consent_changed"),
|
|
211
216
|
Schema.Literal("conversation.created"),
|
|
212
217
|
Schema.Literal("conversation.updated"),
|
|
213
218
|
Schema.Literal("conversation.archived"),
|
|
@@ -220,6 +225,7 @@ const WebhooksCreateRequestJson = /* @__PURE__ */ Schema.Struct({
|
|
|
220
225
|
Schema.Literal("mailbox.message.received"),
|
|
221
226
|
Schema.Literal("mailbox.message.sent"),
|
|
222
227
|
Schema.Literal("mailbox.action.pending_approval"),
|
|
228
|
+
Schema.Literal("mailbox.action.resolved"),
|
|
223
229
|
Schema.Literal("mailbox.message.quarantined"),
|
|
224
230
|
Schema.Literal("mailbox.message.released"),
|
|
225
231
|
Schema.Literal("mailbox.message.discarded"),
|
|
@@ -281,6 +287,7 @@ const WebhooksUpdateRequestJson = /* @__PURE__ */ Schema.Struct({
|
|
|
281
287
|
Schema.Literal("contact.subscribed"),
|
|
282
288
|
Schema.Literal("contact.unsubscribed"),
|
|
283
289
|
Schema.Literal("contact.resubscribed"),
|
|
290
|
+
Schema.Literal("contact.consent_changed"),
|
|
284
291
|
Schema.Literal("conversation.created"),
|
|
285
292
|
Schema.Literal("conversation.updated"),
|
|
286
293
|
Schema.Literal("conversation.archived"),
|
|
@@ -293,6 +300,7 @@ const WebhooksUpdateRequestJson = /* @__PURE__ */ Schema.Struct({
|
|
|
293
300
|
Schema.Literal("mailbox.message.received"),
|
|
294
301
|
Schema.Literal("mailbox.message.sent"),
|
|
295
302
|
Schema.Literal("mailbox.action.pending_approval"),
|
|
303
|
+
Schema.Literal("mailbox.action.resolved"),
|
|
296
304
|
Schema.Literal("mailbox.message.quarantined"),
|
|
297
305
|
Schema.Literal("mailbox.message.released"),
|
|
298
306
|
Schema.Literal("mailbox.message.discarded"),
|
|
@@ -374,6 +374,11 @@ export declare const SamvaOperations: {
|
|
|
374
374
|
readonly method: "DELETE";
|
|
375
375
|
readonly paginated: false;
|
|
376
376
|
};
|
|
377
|
+
readonly contactsSetConsent: {
|
|
378
|
+
readonly group: "Contacts";
|
|
379
|
+
readonly method: "PUT";
|
|
380
|
+
readonly paginated: false;
|
|
381
|
+
};
|
|
377
382
|
readonly contactsAddTags: {
|
|
378
383
|
readonly group: "Contacts";
|
|
379
384
|
readonly method: "POST";
|
|
@@ -1644,12 +1649,12 @@ export declare const SamvaOperations: {
|
|
|
1644
1649
|
readonly method: "GET";
|
|
1645
1650
|
readonly paginated: true;
|
|
1646
1651
|
};
|
|
1647
|
-
readonly
|
|
1652
|
+
readonly unsubscribeAddMembers: {
|
|
1648
1653
|
readonly group: "Unsubscribe Groups";
|
|
1649
1654
|
readonly method: "POST";
|
|
1650
1655
|
readonly paginated: false;
|
|
1651
1656
|
};
|
|
1652
|
-
readonly
|
|
1657
|
+
readonly unsubscribeRemoveMembers: {
|
|
1653
1658
|
readonly group: "Unsubscribe Groups";
|
|
1654
1659
|
readonly method: "DELETE";
|
|
1655
1660
|
readonly paginated: false;
|