@samva/webhooks 0.18.0 → 0.20.0

package/dist/schemas.gen.js

@@ -473,8 +473,30 @@ const MessageReceivedEventSchema = Schema.StructWithRest(Schema.Struct({
 					footer: Schema.optionalKey(Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(60).annotate({ expected: "a string with at most 60 code points" }))),
 					displayText: Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(20).annotate({ expected: "a string with at most 20 code points" })),
 					url: Schema.String
-				}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppCtaUrlMessage" })
-			]).annotate({ identifier: "WhatsAppInteractive" })),
+				}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppCtaUrlMessage" }),
+				Schema.StructWithRest(Schema.Struct({
+					type: Schema.Literal("flow"),
+					header: Schema.optionalKey(Schema.StructWithRest(Schema.Struct({
+						type: Schema.Literal("text"),
+						text: Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(60).annotate({ expected: "a string with at most 60 code points" }))
+					}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppTextHeader_1" })),
+					body: Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(1024).annotate({ expected: "a string with at most 1024 code points" })),
+					footer: Schema.optionalKey(Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(60).annotate({ expected: "a string with at most 60 code points" }))),
+					flowId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^waflow_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+						expected: "a string matching the RegExp ^waflow_[0-9a-hjkmnp-tv-z]{16,24}$",
+						identifier: "WhatsAppFlowId"
+					})),
+					cta: Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(30).annotate({ expected: "a string with at most 30 code points" })),
+					token: Schema.optionalKey(Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(1024).annotate({ expected: "a string with at most 1024 code points" }))),
+					screen: Schema.optionalKey(Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^[A-Za-z_]{1,100}$", "u")).annotate({ expected: "a string matching the RegExp ^[A-Za-z_]{1,100}$" }))),
+					data: Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))),
+					flowVersionId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^wafver_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+						expected: "a string matching the RegExp ^wafver_[0-9a-hjkmnp-tv-z]{16,24}$",
+						identifier: "WhatsAppFlowVersionId"
+					})),
+					providerFlowId: Schema.String
+				}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppStoredFlowMessage" })
+			]).annotate({ identifier: "WhatsAppStoredInteractive" })),
 			media: Schema.optionalKey(Schema.Union([Schema.Union([
 				Schema.StructWithRest(Schema.Struct({
 					type: Schema.Literals([
@@ -580,6 +602,11 @@ const MessageReceivedEventSchema = Schema.StructWithRest(Schema.Struct({
 				title: Schema.String,
 				description: Schema.optionalKey(Schema.String)
 			}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppReceivedReply" })),
+			flowResponse: Schema.optionalKey(Schema.StructWithRest(Schema.Struct({
+				flowToken: Schema.Union([Schema.String, Schema.Null]),
+				response: Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" })),
+				body: Schema.optionalKey(Schema.String)
+			}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppReceivedFlowResponse" })),
 			context: Schema.optionalKey(Schema.StructWithRest(Schema.Struct({
 				messageId: Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^msg_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
 					expected: "a string matching the RegExp ^msg_[0-9a-hjkmnp-tv-z]{16,24}$",
@@ -705,11 +732,7 @@ const ContactCreatedEventSchema = Schema.StructWithRest(Schema.Struct({
 		name: Schema.String,
 		displayName: Schema.optionalKey(Schema.Union([Schema.Union([Schema.String, Schema.Null]), Schema.Null])),
 		identities: Schema.Array(Schema.StructWithRest(Schema.Struct({
-			channel: Schema.Literals([
-				"sms",
-				"whatsapp",
-				"email"
-			]),
+			type: Schema.Literals(["email", "phone"]),
 			identifier: Schema.String,
 			verified: Schema.Boolean
 		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "ContactEventIdentity" })),
@@ -736,11 +759,7 @@ const ContactUpdatedEventSchema = Schema.StructWithRest(Schema.Struct({
 		name: Schema.String,
 		displayName: Schema.optionalKey(Schema.Union([Schema.Union([Schema.String, Schema.Null]), Schema.Null])),
 		identities: Schema.Array(Schema.StructWithRest(Schema.Struct({
-			channel: Schema.Literals([
-				"sms",
-				"whatsapp",
-				"email"
-			]),
+			type: Schema.Literals(["email", "phone"]),
 			identifier: Schema.String,
 			verified: Schema.Boolean
 		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "ContactEventIdentity" })),
@@ -767,11 +786,7 @@ const ContactDeletedEventSchema = Schema.StructWithRest(Schema.Struct({
 		name: Schema.String,
 		displayName: Schema.optionalKey(Schema.Union([Schema.Union([Schema.String, Schema.Null]), Schema.Null])),
 		identities: Schema.Array(Schema.StructWithRest(Schema.Struct({
-			channel: Schema.Literals([
-				"sms",
-				"whatsapp",
-				"email"
-			]),
+			type: Schema.Literals(["email", "phone"]),
 			identifier: Schema.String,
 			verified: Schema.Boolean
 		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "ContactEventIdentity" })),
@@ -789,8 +804,11 @@ const ContactSubscribedEventSchema = Schema.StructWithRest(Schema.Struct({
 			expected: "a string matching the RegExp ^org_[0-9a-hjkmnp-tv-z]{16,24}$",
 			identifier: "OrganizationId"
 		})),
-		contactId: Schema.Union([Schema.String, Schema.Null]),
-		email: Schema.String,
+		contactId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^contact_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^contact_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "ContactId"
+		})),
+		email: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
 		groupId: Schema.String,
 		groupName: Schema.String,
 		contactGroupId: Schema.optionalKey(Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^cgrp_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
@@ -832,8 +850,11 @@ const ContactUnsubscribedEventSchema = Schema.StructWithRest(Schema.Struct({
 			expected: "a string matching the RegExp ^org_[0-9a-hjkmnp-tv-z]{16,24}$",
 			identifier: "OrganizationId"
 		})),
-		contactId: Schema.Union([Schema.String, Schema.Null]),
-		email: Schema.String,
+		contactId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^contact_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^contact_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "ContactId"
+		})),
+		email: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
 		groupId: Schema.String,
 		groupName: Schema.String,
 		contactGroupId: Schema.optionalKey(Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^cgrp_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
@@ -875,8 +896,11 @@ const ContactResubscribedEventSchema = Schema.StructWithRest(Schema.Struct({
 			expected: "a string matching the RegExp ^org_[0-9a-hjkmnp-tv-z]{16,24}$",
 			identifier: "OrganizationId"
 		})),
-		contactId: Schema.Union([Schema.String, Schema.Null]),
-		email: Schema.String,
+		contactId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^contact_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^contact_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "ContactId"
+		})),
+		email: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
 		groupId: Schema.String,
 		groupName: Schema.String,
 		contactGroupId: Schema.optionalKey(Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^cgrp_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
@@ -910,6 +934,37 @@ const ContactResubscribedEventSchema = Schema.StructWithRest(Schema.Struct({
 		occurredAt: Schema.String
 	}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
 }), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]);
+const ContactConsentChangedEventSchema = Schema.StructWithRest(Schema.Struct({
+	type: Schema.Literal("contact.consent_changed"),
+	timestamp: Schema.String,
+	data: Schema.StructWithRest(Schema.Struct({
+		organizationId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^org_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^org_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "OrganizationId"
+		})),
+		contactId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^contact_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^contact_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "ContactId"
+		})),
+		identity: Schema.StructWithRest(Schema.Struct({
+			id: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^cident_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+				expected: "a string matching the RegExp ^cident_[0-9a-hjkmnp-tv-z]{16,24}$",
+				identifier: "ContactIdentityId"
+			})),
+			type: Schema.Literals(["email", "phone"]),
+			identifier: Schema.String
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]),
+		channel: Schema.Literals([
+			"sms",
+			"whatsapp",
+			"email"
+		]),
+		status: Schema.Literals(["opted_in", "opted_out"]),
+		previousStatus: Schema.Union([Schema.Literals(["opted_in", "opted_out"]), Schema.Null]),
+		source: Schema.String,
+		capturedAt: Schema.String
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]);
 const ConversationCreatedEventSchema = Schema.StructWithRest(Schema.Struct({
 	type: Schema.Literal("conversation.created"),
 	timestamp: Schema.String,
@@ -1271,6 +1326,57 @@ const TemplateRegistrationUpdatedEventSchema = Schema.StructWithRest(Schema.Stru
 		])
 	}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
 }), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]);
+const FlowRegistrationUpdatedEventSchema = Schema.StructWithRest(Schema.Struct({
+	type: Schema.Literal("flow.registration.updated"),
+	timestamp: Schema.String,
+	data: Schema.StructWithRest(Schema.Struct({
+		id: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^wafreg_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^wafreg_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "WhatsAppFlowRegistrationId"
+		})),
+		flowId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^waflow_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^waflow_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "WhatsAppFlowId"
+		})),
+		versionId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^wafver_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^wafver_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "WhatsAppFlowVersionId"
+		})),
+		versionNumber: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })),
+		wabaId: Schema.String,
+		providerFlowId: Schema.Union([Schema.String, Schema.Null]),
+		name: Schema.String,
+		status: Schema.Literals([
+			"draft",
+			"published",
+			"throttled",
+			"blocked",
+			"deprecated"
+		]),
+		validationErrors: Schema.Array(Schema.StructWithRest(Schema.Struct({
+			error: Schema.String,
+			message: Schema.String,
+			path: Schema.optionalKey(Schema.String),
+			line: Schema.optionalKey(Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" }))),
+			column: Schema.optionalKey(Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })))
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ identifier: "WhatsAppFlowValidationError" })),
+		publishedAt: Schema.Union([Schema.String, Schema.Null]),
+		statusChangedAt: Schema.String,
+		createdAt: Schema.String,
+		updatedAt: Schema.String,
+		organizationId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^org_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^org_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "OrganizationId"
+		})),
+		previousStatus: Schema.Union([Schema.Literals([
+			"draft",
+			"published",
+			"throttled",
+			"blocked",
+			"deprecated"
+		]), Schema.Null])
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]);
 const MailboxMessageReceivedEventSchema = Schema.StructWithRest(Schema.Struct({
 	type: Schema.Literal("mailbox.message.received"),
 	timestamp: Schema.String,
@@ -1492,6 +1598,91 @@ const MailboxActionPendingApprovalEventSchema = Schema.StructWithRest(Schema.Str
 		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
 	}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
 }), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]);
+const MailboxActionResolvedEventSchema = Schema.StructWithRest(Schema.Struct({
+	type: Schema.Literal("mailbox.action.resolved"),
+	timestamp: Schema.String,
+	data: Schema.StructWithRest(Schema.Struct({
+		mailboxId: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^mbx_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^mbx_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "MailboxId"
+		})),
+		namespaceId: Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^ns_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+			expected: "a string matching the RegExp ^ns_[0-9a-hjkmnp-tv-z]{16,24}$",
+			identifier: "NamespaceId"
+		})), Schema.Null]),
+		action: Schema.StructWithRest(Schema.Struct({
+			id: Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^mbxact_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+				expected: "a string matching the RegExp ^mbxact_[0-9a-hjkmnp-tv-z]{16,24}$",
+				identifier: "MailboxActionId"
+			})),
+			type: Schema.Literals([
+				"sendMessage",
+				"reply",
+				"updateDraft",
+				"createNote",
+				"assignThread",
+				"changeThreadState",
+				"call",
+				"extensionRequest"
+			]),
+			threadId: Schema.Union([Schema.String.check(Schema.isPattern(/* @__PURE__ */ new RegExp("^thread_[0-9a-hjkmnp-tv-z]{16,24}$", "u")).annotate({
+				expected: "a string matching the RegExp ^thread_[0-9a-hjkmnp-tv-z]{16,24}$",
+				identifier: "MailboxThreadId"
+			})), Schema.Null]),
+			proposedBy: Schema.StructWithRest(Schema.Struct({
+				kind: Schema.Literals([
+					"user",
+					"apiKey",
+					"extension",
+					"externalAgent",
+					"samvaAgent",
+					"system"
+				]),
+				id: Schema.String,
+				displayName: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+				source: Schema.Literals([
+					"humanUi",
+					"externalApi",
+					"externalAgent",
+					"extension",
+					"system"
+				])
+			}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]),
+			createdAt: Schema.String
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]),
+		resolution: Schema.StructWithRest(Schema.Struct({
+			outcome: Schema.Literals([
+				"approved",
+				"denied",
+				"cancelled"
+			]),
+			actor: Schema.StructWithRest(Schema.Struct({
+				kind: Schema.Literals([
+					"user",
+					"apiKey",
+					"extension",
+					"externalAgent",
+					"samvaAgent",
+					"system"
+				]),
+				id: Schema.String,
+				displayName: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+				source: Schema.Literals([
+					"humanUi",
+					"externalApi",
+					"externalAgent",
+					"extension",
+					"system"
+				])
+			}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({ description: "Who resolved the approval." }),
+			resolvedAt: Schema.String,
+			reason: Schema.Union([Schema.String, Schema.Null]).annotate({ description: "The denial reason; null for an approval or a cancellation." })
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]).annotate({
+			description: "How the action's approval ended.",
+			identifier: "MailboxActionResolution"
+		})
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))])
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ expected: "JSON value" }))]);
 const MailboxMessageQuarantinedEventSchema = Schema.StructWithRest(Schema.Struct({
 	type: Schema.Literal("mailbox.message.quarantined"),
 	timestamp: Schema.String,
@@ -1720,6 +1911,7 @@ const SamvaWebhookEventSchema = Schema.Union([
 	ContactSubscribedEventSchema,
 	ContactUnsubscribedEventSchema,
 	ContactResubscribedEventSchema,
+	ContactConsentChangedEventSchema,
 	ConversationCreatedEventSchema,
 	ConversationUpdatedEventSchema,
 	ConversationArchivedEventSchema,
@@ -1730,15 +1922,17 @@ const SamvaWebhookEventSchema = Schema.Union([
 	DomainUpdatedEventSchema,
 	DomainWarmingUpdatedEventSchema,
 	TemplateRegistrationUpdatedEventSchema,
+	FlowRegistrationUpdatedEventSchema,
 	MailboxMessageReceivedEventSchema,
 	MailboxMessageSentEventSchema,
 	MailboxActionPendingApprovalEventSchema,
+	MailboxActionResolvedEventSchema,
 	MailboxMessageQuarantinedEventSchema,
 	MailboxMessageReleasedEventSchema,
 	MailboxMessageDiscardedEventSchema,
 	JourneyWebhookEventSchema
 ]);
 //#endregion
-export { ContactCreatedEventSchema, ContactDeletedEventSchema, ContactResubscribedEventSchema, ContactSubscribedEventSchema, ContactUnsubscribedEventSchema, ContactUpdatedEventSchema, ConversationArchivedEventSchema, ConversationCreatedEventSchema, ConversationUpdatedEventSchema, DomainUpdatedEventSchema, DomainWarmingUpdatedEventSchema, JourneyWebhookEventSchema, MailboxActionPendingApprovalEventSchema, MailboxMessageDiscardedEventSchema, MailboxMessageQuarantinedEventSchema, MailboxMessageReceivedEventSchema, MailboxMessageReleasedEventSchema, MailboxMessageSentEventSchema, MessageBouncedEventSchema, MessageClickedEventSchema, MessageComplainedEventSchema, MessageDeliveredEventSchema, MessageFailedEventSchema, MessageOpenedEventSchema, MessageReadEventSchema, MessageReceivedEventSchema, MessageSentEventSchema, SamvaWebhookEventSchema, TemplateRegistrationUpdatedEventSchema, WebhookCreatedEventSchema, WebhookDeletedEventSchema, WebhookTestEventSchema, WebhookUpdatedEventSchema };
+export { ContactConsentChangedEventSchema, ContactCreatedEventSchema, ContactDeletedEventSchema, ContactResubscribedEventSchema, ContactSubscribedEventSchema, ContactUnsubscribedEventSchema, ContactUpdatedEventSchema, ConversationArchivedEventSchema, ConversationCreatedEventSchema, ConversationUpdatedEventSchema, DomainUpdatedEventSchema, DomainWarmingUpdatedEventSchema, FlowRegistrationUpdatedEventSchema, JourneyWebhookEventSchema, MailboxActionPendingApprovalEventSchema, MailboxActionResolvedEventSchema, MailboxMessageDiscardedEventSchema, MailboxMessageQuarantinedEventSchema, MailboxMessageReceivedEventSchema, MailboxMessageReleasedEventSchema, MailboxMessageSentEventSchema, MessageBouncedEventSchema, MessageClickedEventSchema, MessageComplainedEventSchema, MessageDeliveredEventSchema, MessageFailedEventSchema, MessageOpenedEventSchema, MessageReadEventSchema, MessageReceivedEventSchema, MessageSentEventSchema, SamvaWebhookEventSchema, TemplateRegistrationUpdatedEventSchema, WebhookCreatedEventSchema, WebhookDeletedEventSchema, WebhookTestEventSchema, WebhookUpdatedEventSchema };
 
 //# sourceMappingURL=schemas.gen.js.map

package/dist/types.gen.d.ts

@@ -457,6 +457,27 @@ export type MessageReceivedEvent = {
                 readonly url: string;
             } & {
                 readonly [x: string]: JsonValue;
+            }) | ({
+                readonly type: "flow";
+                readonly header?: {
+                    readonly type: "text";
+                    readonly text: string;
+                } & {
+                    readonly [x: string]: JsonValue;
+                };
+                readonly body: string;
+                readonly footer?: string;
+                readonly flowId: string;
+                readonly cta: string;
+                readonly token?: string;
+                readonly screen?: string;
+                readonly data?: {
+                    readonly [x: string]: JsonValue;
+                };
+                readonly flowVersionId: string;
+                readonly providerFlowId: string;
+            } & {
+                readonly [x: string]: JsonValue;
             });
             readonly media?: ({
                 readonly type: "image" | "video" | "audio" | "document" | "sticker";
@@ -557,6 +578,15 @@ export type MessageReceivedEvent = {
             } & {
                 readonly [x: string]: JsonValue;
             };
+            readonly flowResponse?: {
+                readonly flowToken: string | null;
+                readonly response: {
+                    readonly [x: string]: JsonValue;
+                };
+                readonly body?: string;
+            } & {
+                readonly [x: string]: JsonValue;
+            };
             readonly context?: {
                 readonly messageId: string | null;
                 readonly providerMessageId: string;
@@ -654,7 +684,7 @@ export type ContactCreatedEvent = {
         readonly name: string;
         readonly displayName?: string | null | null;
         readonly identities: ReadonlyArray<{
-            readonly channel: "sms" | "whatsapp" | "email";
+            readonly type: "email" | "phone";
             readonly identifier: string;
             readonly verified: boolean;
         } & {
@@ -680,7 +710,7 @@ export type ContactUpdatedEvent = {
         readonly name: string;
         readonly displayName?: string | null | null;
         readonly identities: ReadonlyArray<{
-            readonly channel: "sms" | "whatsapp" | "email";
+            readonly type: "email" | "phone";
             readonly identifier: string;
             readonly verified: boolean;
         } & {
@@ -706,7 +736,7 @@ export type ContactDeletedEvent = {
         readonly name: string;
         readonly displayName?: string | null | null;
         readonly identities: ReadonlyArray<{
-            readonly channel: "sms" | "whatsapp" | "email";
+            readonly type: "email" | "phone";
             readonly identifier: string;
             readonly verified: boolean;
         } & {
@@ -728,8 +758,8 @@ export type ContactSubscribedEvent = {
     readonly timestamp: string;
     readonly data: {
         readonly organizationId: string;
-        readonly contactId: string | null;
-        readonly email: string;
+        readonly contactId: string;
+        readonly email?: string | null;
         readonly groupId: string;
         readonly groupName: string;
         readonly contactGroupId?: string | null;
@@ -753,8 +783,8 @@ export type ContactUnsubscribedEvent = {
     readonly timestamp: string;
     readonly data: {
         readonly organizationId: string;
-        readonly contactId: string | null;
-        readonly email: string;
+        readonly contactId: string;
+        readonly email?: string | null;
         readonly groupId: string;
         readonly groupName: string;
         readonly contactGroupId?: string | null;
@@ -778,8 +808,8 @@ export type ContactResubscribedEvent = {
     readonly timestamp: string;
     readonly data: {
         readonly organizationId: string;
-        readonly contactId: string | null;
-        readonly email: string;
+        readonly contactId: string;
+        readonly email?: string | null;
         readonly groupId: string;
         readonly groupName: string;
         readonly contactGroupId?: string | null;
@@ -798,6 +828,31 @@ export type ContactResubscribedEvent = {
     readonly [x: string]: JsonValue;
 };
 export type ContactResubscribedPayload = ContactResubscribedEvent["data"];
+export type ContactConsentChangedEvent = {
+    readonly type: "contact.consent_changed";
+    readonly timestamp: string;
+    readonly data: {
+        readonly organizationId: string;
+        readonly contactId: string;
+        readonly identity: {
+            readonly id: string;
+            readonly type: "email" | "phone";
+            readonly identifier: string;
+        } & {
+            readonly [x: string]: JsonValue;
+        };
+        readonly channel: "sms" | "whatsapp" | "email";
+        readonly status: "opted_in" | "opted_out";
+        readonly previousStatus: "opted_in" | "opted_out" | null;
+        readonly source: string;
+        readonly capturedAt: string;
+    } & {
+        readonly [x: string]: JsonValue;
+    };
+} & {
+    readonly [x: string]: JsonValue;
+};
+export type ContactConsentChangedPayload = ContactConsentChangedEvent["data"];
 export type ConversationCreatedEvent = {
     readonly type: "conversation.created";
     readonly timestamp: string;
@@ -1041,6 +1096,40 @@ export type TemplateRegistrationUpdatedEvent = {
     readonly [x: string]: JsonValue;
 };
 export type TemplateRegistrationUpdatedPayload = TemplateRegistrationUpdatedEvent["data"];
+export type FlowRegistrationUpdatedEvent = {
+    readonly type: "flow.registration.updated";
+    readonly timestamp: string;
+    readonly data: {
+        readonly id: string;
+        readonly flowId: string;
+        readonly versionId: string;
+        readonly versionNumber: number;
+        readonly wabaId: string;
+        readonly providerFlowId: string | null;
+        readonly name: string;
+        readonly status: "draft" | "published" | "throttled" | "blocked" | "deprecated";
+        readonly validationErrors: ReadonlyArray<{
+            readonly error: string;
+            readonly message: string;
+            readonly path?: string;
+            readonly line?: number;
+            readonly column?: number;
+        } & {
+            readonly [x: string]: JsonValue;
+        }>;
+        readonly publishedAt: string | null;
+        readonly statusChangedAt: string;
+        readonly createdAt: string;
+        readonly updatedAt: string;
+        readonly organizationId: string;
+        readonly previousStatus: "draft" | "published" | "throttled" | "blocked" | "deprecated" | null;
+    } & {
+        readonly [x: string]: JsonValue;
+    };
+} & {
+    readonly [x: string]: JsonValue;
+};
+export type FlowRegistrationUpdatedPayload = FlowRegistrationUpdatedEvent["data"];
 export type MailboxMessageReceivedEvent = {
     readonly type: "mailbox.message.received";
     readonly timestamp: string;
@@ -1187,6 +1276,50 @@ export type MailboxActionPendingApprovalEvent = {
     readonly [x: string]: JsonValue;
 };
 export type MailboxActionPendingApprovalPayload = MailboxActionPendingApprovalEvent["data"];
+export type MailboxActionResolvedEvent = {
+    readonly type: "mailbox.action.resolved";
+    readonly timestamp: string;
+    readonly data: {
+        readonly mailboxId: string;
+        readonly namespaceId: string | null;
+        readonly action: {
+            readonly id: string;
+            readonly type: "sendMessage" | "reply" | "updateDraft" | "createNote" | "assignThread" | "changeThreadState" | "call" | "extensionRequest";
+            readonly threadId: string | null;
+            readonly proposedBy: {
+                readonly kind: "user" | "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system";
+                readonly id: string;
+                readonly displayName?: string | null;
+                readonly source: "humanUi" | "externalApi" | "externalAgent" | "extension" | "system";
+            } & {
+                readonly [x: string]: JsonValue;
+            };
+            readonly createdAt: string;
+        } & {
+            readonly [x: string]: JsonValue;
+        };
+        readonly resolution: {
+            readonly outcome: "approved" | "denied" | "cancelled";
+            readonly actor: {
+                readonly kind: "user" | "apiKey" | "extension" | "externalAgent" | "samvaAgent" | "system";
+                readonly id: string;
+                readonly displayName?: string | null;
+                readonly source: "humanUi" | "externalApi" | "externalAgent" | "extension" | "system";
+            } & {
+                readonly [x: string]: JsonValue;
+            };
+            readonly resolvedAt: string;
+            readonly reason: string | null;
+        } & {
+            readonly [x: string]: JsonValue;
+        };
+    } & {
+        readonly [x: string]: JsonValue;
+    };
+} & {
+    readonly [x: string]: JsonValue;
+};
+export type MailboxActionResolvedPayload = MailboxActionResolvedEvent["data"];
 export type MailboxMessageQuarantinedEvent = {
     readonly type: "mailbox.message.quarantined";
     readonly timestamp: string;
@@ -1335,7 +1468,7 @@ export type JourneyWebhookEvent = {
     readonly [x: string]: JsonValue;
 };
 export type JourneyWebhookPayload = JourneyWebhookEvent["data"];
-export type SamvaWebhookEvent = MessageSentEvent | MessageDeliveredEvent | MessageReadEvent | MessageFailedEvent | MessageBouncedEvent | MessageComplainedEvent | MessageReceivedEvent | MessageOpenedEvent | MessageClickedEvent | ContactCreatedEvent | ContactUpdatedEvent | ContactDeletedEvent | ContactSubscribedEvent | ContactUnsubscribedEvent | ContactResubscribedEvent | ConversationCreatedEvent | ConversationUpdatedEvent | ConversationArchivedEvent | WebhookCreatedEvent | WebhookUpdatedEvent | WebhookDeletedEvent | WebhookTestEvent | DomainUpdatedEvent | DomainWarmingUpdatedEvent | TemplateRegistrationUpdatedEvent | MailboxMessageReceivedEvent | MailboxMessageSentEvent | MailboxActionPendingApprovalEvent | MailboxMessageQuarantinedEvent | MailboxMessageReleasedEvent | MailboxMessageDiscardedEvent | JourneyWebhookEvent;
+export type SamvaWebhookEvent = MessageSentEvent | MessageDeliveredEvent | MessageReadEvent | MessageFailedEvent | MessageBouncedEvent | MessageComplainedEvent | MessageReceivedEvent | MessageOpenedEvent | MessageClickedEvent | ContactCreatedEvent | ContactUpdatedEvent | ContactDeletedEvent | ContactSubscribedEvent | ContactUnsubscribedEvent | ContactResubscribedEvent | ContactConsentChangedEvent | ConversationCreatedEvent | ConversationUpdatedEvent | ConversationArchivedEvent | WebhookCreatedEvent | WebhookUpdatedEvent | WebhookDeletedEvent | WebhookTestEvent | DomainUpdatedEvent | DomainWarmingUpdatedEvent | TemplateRegistrationUpdatedEvent | FlowRegistrationUpdatedEvent | MailboxMessageReceivedEvent | MailboxMessageSentEvent | MailboxActionPendingApprovalEvent | MailboxActionResolvedEvent | MailboxMessageQuarantinedEvent | MailboxMessageReleasedEvent | MailboxMessageDiscardedEvent | JourneyWebhookEvent;
 export interface UnknownWebhookEvent {
     readonly type: string;
     readonly timestamp: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samva/webhooks",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "Runtime-neutral verification for Samva webhook deliveries",
   "keywords": [
     "samva",