@messagebird/sdk 0.4.2 → 0.6.0

package/dist/index.mjs

@@ -809,6 +809,7 @@ var BirdAPIError = class extends BirdError {
 	vendorCode;
 	remediation;
 	next;
+	unmetGates;
 	constructor(fields) {
 		super(fields.message);
 		this.name = "BirdAPIError";
@@ -822,6 +823,7 @@ var BirdAPIError = class extends BirdError {
 		this.vendorCode = fields.vendorCode;
 		this.remediation = fields.remediation;
 		this.next = fields.next;
+		this.unmetGates = fields.unmetGates;
 		Object.setPrototypeOf(this, new.target.prototype);
 	}
 };
@@ -991,7 +993,8 @@ function mapResponseToError(status, body, headers) {
 		param: b.param,
 		vendorCode: b.vendor_code,
 		remediation: b.remediation,
-		next: b.next ?? []
+		next: b.next ?? [],
+		unmetGates: b.unmet_gates ?? []
 	};
 	switch (fields.type) {
 		case "auth_error": return new BirdAuthError(fields);
@@ -1261,6 +1264,24 @@ const getEmailMessage = (options) => (options.client ?? client).get({
 	...options
 });
 /**
+* Cancel a scheduled message
+*
+* Cancels a message that was scheduled with `scheduled_at` before it sends. Only a message that is still scheduled can be canceled; a message that already started sending, was delivered, or was previously canceled returns a conflict error. The message's status becomes `canceled` and an `email.canceled` webhook event fires. Canceling does not return consumed scheduled-send quota.
+*
+*/
+const cancelEmailMessage = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/messages/{message_id}/cancel",
+	...options
+});
+/**
 * List contacts
 *
 * Returns a paginated list of contacts in the workspace, newest first. Look up a single contact by its exact `email` or `external_id`, or search by email substring with `search`.
@@ -1496,7 +1517,8 @@ const unarchiveContactProperty = (options) => (options.client ?? client).post({
 /**
 * List audiences
 *
-* Returns a paginated list of audiences in the workspace, newest first.
+* Returns a paginated list of audiences in the workspace, newest first. Filter to audiences whose name contains a substring with `search`.
+*
 */
 const listAudiences = (options) => (options?.client ?? client).get({
 	security: [{
@@ -1782,70 +1804,11 @@ const getSmsTemplate = (options) => (options.client ?? client).get({
 	...options
 });
 /**
-* List email templates
-*
-* Returns a paginated list of the workspace's email templates, newest first. Filter by category, source, or a case-insensitive search that matches the template's name or description.
-*
-*/
-const listEmailTemplates = (options) => (options?.client ?? client).get({
-	security: [{
-		scheme: "bearer",
-		type: "http"
-	}, {
-		in: "cookie",
-		name: "bird_session",
-		type: "apiKey"
-	}],
-	url: "/v1/email/templates",
-	...options
-});
-/**
-* Create an email template
-*
-* Creates a template and its initial editable draft. The body carries the template's name, category, authoring format (`source`), and the draft's content (`subject`, `html`, `text`). A name already used in the workspace returns a conflict.
-*
-*/
-const createEmailTemplate = (options) => (options.client ?? client).post({
-	security: [{
-		scheme: "bearer",
-		type: "http"
-	}, {
-		in: "cookie",
-		name: "bird_session",
-		type: "apiKey"
-	}],
-	url: "/v1/email/templates",
-	...options,
-	headers: {
-		"Content-Type": "application/json",
-		...options.headers
-	}
-});
-/**
-* Delete an email template
-*
-* Deletes the template and all its versions. The name becomes available for reuse within the workspace.
-*
-*/
-const deleteEmailTemplate = (options) => (options.client ?? client).delete({
-	security: [{
-		scheme: "bearer",
-		type: "http"
-	}, {
-		in: "cookie",
-		name: "bird_session",
-		type: "apiKey"
-	}],
-	url: "/v1/email/templates/{template_id}",
-	...options
-});
-/**
-* Get an email template
-*
-* Returns a single email template with its current draft content (subject, HTML, and plain text), the draft revision, and its draft and published version ids.
+* List WhatsApp messages
 *
+* Returns a paginated list of WhatsApp messages in the workspace, newest first.
 */
-const getEmailTemplate = (options) => (options.client ?? client).get({
+const listWhatsAppMessages = (options) => (options?.client ?? client).get({
 	security: [{
 		scheme: "bearer",
 		type: "http"
@@ -1854,16 +1817,15 @@ const getEmailTemplate = (options) => (options.client ?? client).get({
 		name: "bird_session",
 		type: "apiKey"
 	}],
-	url: "/v1/email/templates/{template_id}",
+	url: "/v1/whatsapp/messages",
 	...options
 });
 /**
-* Update an email template
-*
-* Updates a template's metadata and its draft content. Only the fields you send are changed. Send the draft `revision` you last read; if it is stale (someone else edited the draft first) the request returns a conflict so you can reload and retry.
+* Send a message
 *
+* Sends a template message. Bird selects the sender number from the template's category.
 */
-const updateEmailTemplate = (options) => (options.client ?? client).patch({
+const sendWhatsAppMessage = (options) => (options.client ?? client).post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
@@ -1872,7 +1834,7 @@ const updateEmailTemplate = (options) => (options.client ?? client).patch({
 		name: "bird_session",
 		type: "apiKey"
 	}],
-	url: "/v1/email/templates/{template_id}",
+	url: "/v1/whatsapp/messages",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -1880,12 +1842,11 @@ const updateEmailTemplate = (options) => (options.client ?? client).patch({
 	}
 });
 /**
-* List email template versions
-*
-* Returns every version of the template — the current draft plus all published versions — newest first.
+* Get a WhatsApp message
 *
+* Returns a single WhatsApp message with its current delivery status and failure detail if applicable.
 */
-const listEmailTemplateVersions = (options) => (options.client ?? client).get({
+const getWhatsAppMessage = (options) => (options.client ?? client).get({
 	security: [{
 		scheme: "bearer",
 		type: "http"
@@ -1894,15 +1855,15 @@ const listEmailTemplateVersions = (options) => (options.client ?? client).get({
 		name: "bird_session",
 		type: "apiKey"
 	}],
-	url: "/v1/email/templates/{template_id}/versions",
+	url: "/v1/whatsapp/messages/{message_id}",
 	...options
 });
 /**
-* Get an email template version
+* List events for a WhatsApp message
 *
-* Returns a single version of an email template.
+* Returns the lifecycle event timeline for a WhatsApp message, in chronological order.
 */
-const getEmailTemplateVersion = (options) => (options.client ?? client).get({
+const listWhatsAppMessageEvents = (options) => (options.client ?? client).get({
 	security: [{
 		scheme: "bearer",
 		type: "http"
@@ -1911,16 +1872,15 @@ const getEmailTemplateVersion = (options) => (options.client ?? client).get({
 		name: "bird_session",
 		type: "apiKey"
 	}],
-	url: "/v1/email/templates/{template_id}/versions/{version_id}",
+	url: "/v1/whatsapp/messages/{message_id}/events",
 	...options
 });
 /**
-* Publish an email template
-*
-* Publishes the template's current draft as a new immutable, numbered version and makes it the live version used by sends. The draft remains editable for future changes. The draft must have a subject and a body; an empty draft is rejected.
+* List available message templates
 *
+* Returns the message templates available to this workspace.
 */
-const publishEmailTemplate = (options) => (options.client ?? client).post({
+const listWhatsAppTemplates = (options) => (options?.client ?? client).get({
 	security: [{
 		scheme: "bearer",
 		type: "http"
@@ -1929,7 +1889,7 @@ const publishEmailTemplate = (options) => (options.client ?? client).post({
 		name: "bird_session",
 		type: "apiKey"
 	}],
-	url: "/v1/email/templates/{template_id}/publish",
+	url: "/v1/whatsapp/templates",
 	...options
 });
 //#endregion
@@ -2106,6 +2066,23 @@ var EmailResource = class extends Resource {
 		}));
 	}
 	/**
+	* Cancel a message scheduled with `scheduled_at` before it sends. Only a
+	* message that is still scheduled can be canceled; one that already started
+	* sending — or was previously canceled — rejects with a conflict error.
+	* Canceling does not return consumed scheduled-send quota.
+	*
+	* @example
+	* await bird.email.cancel("em_abc123");
+	*/
+	cancel(messageId, options) {
+		return this.call("POST", options, ({ signal, headers }) => cancelEmailMessage({
+			client: this.client,
+			path: { message_id: messageId },
+			headers,
+			signal
+		}));
+	}
+	/**
 	* List messages, newest first. `await` resolves the first page; `for await`
 	* walks every message across all pages.
 	*
@@ -2487,166 +2464,6 @@ var ContactsResource = class extends Resource {
 	}
 };
 //#endregion
-//#region src/resources/emailTemplates.ts
-var EmailTemplatesResource = class extends Resource {
-	/**
-	* Create a template and its initial editable draft. Pick the authoring format
-	* with `source` (`liquid`, `handlebars`, or `html`); the name must be unique
-	* in the workspace or the call throws a `BirdConflictError`.
-	*
-	* @example Create a template
-	* const tpl = await bird.emailTemplates.create({
-	*   name: "welcome-email",
-	*   description: "Welcome",
-	*   category: "transactional",
-	*   source: "handlebars",
-	*   subject: "Welcome, {{ first_name }}!",
-	*   html: "<h1>Hi {{ first_name }}</h1>",
-	* });
-	* console.log(tpl.id, tpl.revision); // "emt_…", 0
-	*/
-	create(params, options) {
-		return this.call("POST", options, ({ signal, headers }) => createEmailTemplate({
-			client: this.client,
-			body: params,
-			headers,
-			signal
-		}));
-	}
-	/**
-	* List the workspace's templates, newest first. `await` resolves the first
-	* page; `for await` walks every template across all pages. Filter by
-	* `category`, `source`, or a case-insensitive `name` prefix.
-	*
-	* @example Iterate every template, or take one page
-	* for await (const tpl of bird.emailTemplates.list({ category: "transactional" })) {
-	*   console.log(tpl.id, tpl.name);
-	* }
-	* const page = await bird.emailTemplates.list({ limit: 50 }); // page.data, page.next_cursor
-	*/
-	list(query, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailTemplates({
-			client: this.client,
-			query: {
-				...query,
-				starting_after: cursor ?? query?.starting_after
-			},
-			headers,
-			signal
-		}));
-	}
-	/**
-	* Fetch a template with its current draft content (subject, HTML, text), the
-	* draft `revision`, and its draft/published version ids.
-	*
-	* @example
-	* const tpl = await bird.emailTemplates.get("emt_abc123");
-	* tpl.subject;
-	* tpl.published_version_id; // null until first publish
-	*/
-	get(templateId, options) {
-		return this.call("GET", options, ({ signal, headers }) => getEmailTemplate({
-			client: this.client,
-			path: { template_id: templateId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* Update a template's metadata and draft content. Only the fields you send
-	* change. Pass the draft `revision` you last read; if another edit landed
-	* first the call throws a `BirdConflictError` — reload and retry.
-	*
-	* @example Edit the draft, guarded by the revision you read
-	* const tpl = await bird.emailTemplates.get("emt_abc123");
-	* const updated = await bird.emailTemplates.update("emt_abc123", {
-	*   revision: tpl.revision,
-	*   subject: "Welcome aboard, {{ first_name }}!",
-	* });
-	*/
-	update(templateId, params, options) {
-		return this.call("PATCH", options, ({ signal, headers }) => updateEmailTemplate({
-			client: this.client,
-			path: { template_id: templateId },
-			body: params,
-			headers,
-			signal
-		}));
-	}
-	/**
-	* Delete a template and all its versions. The name becomes available for
-	* reuse in the workspace.
-	*
-	* @example
-	* await bird.emailTemplates.delete("emt_abc123");
-	*/
-	delete(templateId, options) {
-		return this.call("DELETE", options, ({ signal, headers }) => deleteEmailTemplate({
-			client: this.client,
-			path: { template_id: templateId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* Publish the current draft as a new immutable, numbered version and make it
-	* the live version used by sends. The draft stays editable. The draft must
-	* have a subject and a body, or the call throws.
-	*
-	* @example Publish, then send by template
-	* const version = await bird.emailTemplates.publish("emt_abc123");
-	* console.log(version.version_number); // 1, 2, 3…
-	* await bird.email.send({
-	*   from: "hello@acme.com",
-	*   to: ["alice@example.com"],
-	*   template: { id: "emt_abc123", parameters: { first_name: "Alice" } },
-	* });
-	*/
-	publish(templateId, options) {
-		return this.call("POST", options, ({ signal, headers }) => publishEmailTemplate({
-			client: this.client,
-			path: { template_id: templateId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* List every version of a template — the current draft plus all published
-	* versions — newest first. Returns the full set in one response (`.data`);
-	* this list is not paginated.
-	*
-	* @example
-	* const { data } = await bird.emailTemplates.listVersions("emt_abc123");
-	* for (const v of data) console.log(v.version_number, v.status);
-	*/
-	listVersions(templateId, options) {
-		return this.call("GET", options, ({ signal, headers }) => listEmailTemplateVersions({
-			client: this.client,
-			path: { template_id: templateId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* Fetch a single version of a template.
-	*
-	* @example
-	* const version = await bird.emailTemplates.getVersion("emt_abc123", "emv_def456");
-	* version.status; // "draft" | "published"
-	*/
-	getVersion(templateId, versionId, options) {
-		return this.call("GET", options, ({ signal, headers }) => getEmailTemplateVersion({
-			client: this.client,
-			path: {
-				template_id: templateId,
-				version_id: versionId
-			},
-			headers,
-			signal
-		}));
-	}
-};
-//#endregion
 //#region src/resources/sms.ts
 var SmsResource = class extends Resource {
 	/**
@@ -2771,6 +2588,111 @@ 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/webhooks.ts
 var WebhooksResource = class {
 	#secret;
@@ -2887,12 +2809,14 @@ var BirdClient = class {
 	#headers;
 	/** The email channel — `bird.email.send(...)`, `.get(...)`, `.list(...)`. */
 	email;
-	/** Email templates — `bird.emailTemplates.create(...)`, `.list(...)`, `.publish(...)`, … */
-	emailTemplates;
 	/** The SMS channel — `bird.sms.send(...)`, `.get(...)`, `.list(...)`. */
 	sms;
 	/** SMS templates — `bird.smsTemplates.list(...)`, `.get(...)`. */
 	smsTemplates;
+	/** The WhatsApp channel — `bird.whatsapp.send(...)`, `.get(...)`, `.list(...)`, `.listEvents(...)`. */
+	whatsapp;
+	/** WhatsApp templates — `bird.whatsappTemplates.list(...)`. */
+	whatsappTemplates;
 	/** Contacts — `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
 	contacts;
 	/** Audiences — `bird.audiences.create(...)`, `.list(...)`, `.addContacts(...)`, … */
@@ -2908,9 +2832,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.4.2`,
+			"User-Agent": `bird-sdk-js/0.6.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.4.2"
+			"Bird-Version": "0.6.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -2924,9 +2848,10 @@ var BirdClient = class {
 			maxRetries: opts.maxRetries ?? DEFAULT_MAX_RETRIES
 		});
 		this.email = new EmailResource(this.core, this.#client, opts.email);
-		this.emailTemplates = new EmailTemplatesResource(this.core, this.#client);
 		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.contacts = new ContactsResource(this.core, this.#client);
 		this.audiences = new AudiencesResource(this.core, this.#client);
 		this.contactProperties = new ContactPropertiesResource(this.core, this.#client);
@@ -3003,8 +2928,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",