@messagebird/sdk 0.5.0 → 0.7.0

package/dist/index.mjs

@@ -1803,6 +1803,139 @@ const getSmsTemplate = (options) => (options.client ?? client).get({
 	url: "/v1/sms/templates/{template_ref}",
 	...options
 });
+/**
+* Create a verification
+*
+* Creates a verification for a recipient and sends them a one-time passcode. Provide a recipient in `to` — an email address (verified over email), a phone number (verified over SMS), or both. If a verification is already in progress for the same recipient, that one is reused and its passcode is re-sent once the resend cooldown has elapsed, rather than starting a second verification. The response includes the verification's current state; the passcode itself is never returned. Submit the passcode the recipient enters with the check endpoint.
+*
+*/
+const createVerification = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/verify/verifications",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* Check a verification passcode
+*
+* Checks a passcode for a recipient and returns the outcome together with the verification's current state. Identify the verification by the same `to` recipient used to create it — you do not need to store a verification id. A wrong, expired, or already-used passcode is reported in the response body, with `success` set to `false` and a `reason` such as `incorrect_code` or `expired`, rather than as an HTTP error; only a missing verification, malformed input, or rate limiting return an error status.
+*
+*/
+const createVerificationCheck = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/verify/verifications/check",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* List WhatsApp messages
+*
+* Returns a paginated list of WhatsApp messages in the workspace, newest first.
+*/
+const listWhatsAppMessages = (options) => (options?.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/whatsapp/messages",
+	...options
+});
+/**
+* Send a message
+*
+* Sends a template message. Bird selects the sender number from the template's category.
+*/
+const sendWhatsAppMessage = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/whatsapp/messages",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* Get a WhatsApp message
+*
+* Returns a single WhatsApp message with its current delivery status and failure detail if applicable.
+*/
+const getWhatsAppMessage = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/whatsapp/messages/{message_id}",
+	...options
+});
+/**
+* List events for a WhatsApp message
+*
+* Returns the lifecycle event timeline for a WhatsApp message, in chronological order.
+*/
+const listWhatsAppMessageEvents = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/whatsapp/messages/{message_id}/events",
+	...options
+});
+/**
+* List available message templates
+*
+* Returns the message templates available to this workspace.
+*/
+const listWhatsAppTemplates = (options) => (options?.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/whatsapp/templates",
+	...options
+});
 //#endregion
 //#region src/resources/base.ts
 var Resource = class {
@@ -2499,6 +2632,163 @@ var SmsTemplatesResource = class extends Resource {
 	}
 };
 //#endregion
+//#region src/resources/whatsapp.ts
+var WhatsappResource = class extends Resource {
+	/**
+	* Send a template message. Bird selects the sender number from the
+	* template's category, so there is no sender field on the request. The
+	* result is `accepted`, not yet delivered — read it back with `get` to
+	* confirm.
+	*
+	* @example
+	* const msg = await bird.whatsapp.send({
+	*   to: "+15551234567",
+	*   template: {
+	*     name: "bird_otp",
+	*     components: [
+	*       { type: "body", parameters: [{ type: "text", text: "123456" }] },
+	*     ],
+	*   },
+	* });
+	* console.log(msg.id, msg.status);
+	*/
+	send(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => sendWhatsAppMessage({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Fetch a single WhatsApp message: its current delivery status and failure
+	* detail if it failed.
+	*
+	* @example
+	* const msg = await bird.whatsapp.get("wa_abc123");
+	* msg.status; // "accepted" | "delivered" | …
+	*/
+	get(messageId, options) {
+		return this.call("GET", options, ({ signal, headers }) => getWhatsAppMessage({
+			client: this.client,
+			path: { message_id: messageId },
+			headers,
+			signal
+		}));
+	}
+	/**
+	* List WhatsApp messages, newest first. `await` resolves the first page;
+	* `for await` walks every message across all pages. Filter by status,
+	* recipient phone number, or business-scoped user ID.
+	*
+	* @example
+	* for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {
+	*   console.log(msg.id, msg.status);
+	* }
+	*/
+	list(query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listWhatsAppMessages({
+			client: this.client,
+			query: {
+				...query,
+				starting_after: cursor ?? query?.starting_after
+			},
+			headers,
+			signal
+		}));
+	}
+	/**
+	* List a WhatsApp message's lifecycle event timeline, in chronological
+	* order. The timeline is bounded and returned in full — this list is not
+	* paginated.
+	*
+	* @example
+	* const { data } = await bird.whatsapp.listEvents("wa_abc123");
+	* for (const event of data) console.log(event.type, event.occurred_at);
+	*/
+	listEvents(messageId, query, options) {
+		return this.call("GET", options, ({ signal, headers }) => listWhatsAppMessageEvents({
+			client: this.client,
+			path: { message_id: messageId },
+			query,
+			headers,
+			signal
+		}));
+	}
+};
+//#endregion
+//#region src/resources/whatsappTemplates.ts
+var WhatsappTemplatesResource = class extends Resource {
+	/**
+	* List the WhatsApp message templates available to the workspace — Meta's
+	* approved templates for this business account. The catalogue is small and
+	* returned in full (`.data`); this list is not paginated.
+	*
+	* @example
+	* const { data } = await bird.whatsappTemplates.list();
+	* for (const tpl of data) console.log(tpl.name, tpl.status);
+	*/
+	list(options) {
+		return this.call("GET", options, ({ signal, headers }) => listWhatsAppTemplates({
+			client: this.client,
+			headers,
+			signal
+		}));
+	}
+};
+//#endregion
+//#region src/resources/verify.ts
+var VerificationsResource = class extends Resource {
+	/**
+	* Start a verification and send a one-time passcode to the recipient in `to`
+	* (a `phone_number` over SMS, an `email_address` over email, or both). Calling
+	* again for the same recipient re-sends the code after the cooldown rather than
+	* starting a second verification. The passcode is never returned — submit the
+	* recipient's entry with `check`.
+	*
+	* @example Start over SMS
+	* const verification = await bird.verify.verifications.create({
+	*   to: { phone_number: "+15551234567" },
+	* });
+	* console.log(verification.id, verification.status);
+	*/
+	create(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createVerification({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Check a passcode the recipient submitted. Identify the verification by the same
+	* `to` recipient used to start it — no id needed. A wrong, expired, or already-used
+	* code resolves with `success: false` and a `reason`, not an error.
+	*
+	* @example
+	* const result = await bird.verify.verifications.check({
+	*   to: { phone_number: "+15551234567" },
+	*   code: "123456",
+	* });
+	* console.log(result.success);
+	*/
+	check(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createVerificationCheck({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+};
+/** The Verify product namespace — holds the `verifications` collection. */
+var VerifyResource = class {
+	verifications;
+	constructor(...args) {
+		this.verifications = new VerificationsResource(...args);
+	}
+};
+//#endregion
 //#region src/resources/webhooks.ts
 var WebhooksResource = class {
 	#secret;
@@ -2619,6 +2909,12 @@ var BirdClient = class {
 	sms;
 	/** SMS templates — `bird.smsTemplates.list(...)`, `.get(...)`. */
 	smsTemplates;
+	/** The WhatsApp channel — `bird.whatsapp.send(...)`, `.get(...)`, `.list(...)`, `.listEvents(...)`. */
+	whatsapp;
+	/** WhatsApp templates — `bird.whatsappTemplates.list(...)`. */
+	whatsappTemplates;
+	/** The Verify product — `bird.verify.verifications.create(...)`, `.check(...)`. */
+	verify;
 	/** Contacts — `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
 	contacts;
 	/** Audiences — `bird.audiences.create(...)`, `.list(...)`, `.addContacts(...)`, … */
@@ -2634,9 +2930,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.5.0`,
+			"User-Agent": `bird-sdk-js/0.7.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.5.0"
+			"Bird-Version": "0.7.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -2652,6 +2948,9 @@ var BirdClient = class {
 		this.email = new EmailResource(this.core, this.#client, opts.email);
 		this.sms = new SmsResource(this.core, this.#client);
 		this.smsTemplates = new SmsTemplatesResource(this.core, this.#client);
+		this.whatsapp = new WhatsappResource(this.core, this.#client);
+		this.whatsappTemplates = new WhatsappTemplatesResource(this.core, this.#client);
+		this.verify = new VerifyResource(this.core, this.#client);
 		this.contacts = new ContactsResource(this.core, this.#client);
 		this.audiences = new AudiencesResource(this.core, this.#client);
 		this.contactProperties = new ContactPropertiesResource(this.core, this.#client);
@@ -2728,8 +3027,6 @@ const WebhookEventType = {
 	EmailMailboxMessageDelivered: "email_mailbox.message_delivered",
 	EmailMailboxMessageFailed: "email_mailbox.message_failed",
 	EmailMailboxMessageReceived: "email_mailbox.message_received",
-	EmailMailboxMessageReceivedBlocked: "email_mailbox.message_received_blocked",
-	EmailMailboxMessageReceivedUnauthenticated: "email_mailbox.message_received_unauthenticated",
 	EmailMailboxMessageSent: "email_mailbox.message_sent",
 	EmailMailboxSuspended: "email_mailbox.suspended",
 	EmailMailboxThreadCreated: "email_mailbox.thread_created",