@messagebird/sdk 0.28.0 → 0.29.0

package/dist/index.mjs

@@ -1532,7 +1532,7 @@ const cancelEmailMessage = (options) => (options.client ?? client).post({
 /**
 * List contacts
 *
-* Returns a paginated list of contacts in the workspace, newest first. Look up a single contact by its exact `email`, `phone_number`, or `external_id`, or search by email, first name, last name, or phone substring with `q`. Pass `include_total=true` to add the total number of matching contacts to the response.
+* Returns a paginated list of contacts in the workspace, newest first. Look up a single contact by its exact `email`, `phone_number`, or `external_id`, or search by email, first name, last name, or phone substring with `q`. Repeat `phone_number` to resolve up to 50 numbers to their contacts in one request, raising `limit` to at least the number of values you pass. Pass `include_total=true` to add the total number of matching contacts to the response.
 *
 */
 const listContacts = (options) => (options?.client ?? client).get({
@@ -4179,6 +4179,29 @@ var EmailResource = class extends EmailResourceBase {
 	* });
 	* console.log(msg.id, msg.status); // "em_…", "accepted"
 	*
+	* @example Send a published template instead of inline content
+	* const msg = await bird.email.send({
+	*   from: { email: "onboarding@messagebird.dev", name: "Bird" },
+	*   to: ["delivered@messagebird.dev"],
+	*   category: "transactional",
+	*   template: {
+	*     slug: "welcome-email",
+	*     parameters: { first_name: "Jane" },
+	*   },
+	* });
+	* console.log(msg.id, msg.status);
+	*
+	* @example Sending to the sandbox bounce address, which hard-bounces every time
+	* const msg = await bird.email.send({
+	*   from: { email: "onboarding@messagebird.dev", name: "Bird" },
+	*   to: ["bounce+signup-flow@messagebird.dev"],
+	*   subject: "Sandbox bounce test",
+	*   html: "<p>This message will hard-bounce.</p>",
+	*   tags: [{ name: "flow", value: "signup" }],
+	*   metadata: { test_run: "docs-capture-1" },
+	* });
+	* console.log(msg.id, msg.status); // "em_…", "accepted"
+	*
 	* @example A richer send — cc/bcc, reply-to, tags, metadata, click-tracking off, and an idempotency key (safe to retry; the server dedupes)
 	* await bird.email.send(
 	*   {
@@ -4632,7 +4655,7 @@ var ContactPropertiesResource = class extends Resource {
 //#region src/resources/contacts.gen.ts
 var ContactsResource = class extends Resource {
 	/**
-	* List the workspace's contacts as a cursor page, newest first. Look one up by exact email, phone_number, or external_id, or search by email, name, or phone substring. Pass include_total for a total count.
+	* List the workspace's contacts as a cursor page, newest first. Look one up by exact email, phone_number, or external_id, repeating phone_number to resolve up to 50 numbers in one call (raise limit to match), or search by email, name, or phone substring. Pass include_total for a total count.
 	*
 	* @example Iterate every contact, or take one page
 	* for await (const contact of bird.contacts.list({ q: "acme.com" })) {
@@ -4780,7 +4803,7 @@ var SmsResourceBase = class extends Resource {
 var SmsResource = class extends SmsResourceBase {
 	/**
 	* Send one SMS to a single recipient. Supply either `text` (with a `category`)
-	* or a stored `template` (by `id` or `name`, with its `parameters`). The
+	* or a stored `template` (by `id` or `slug`, with its `parameters`). The
 	* result is `accepted`, not yet delivered — read it back with `get` to confirm.
 	*
 	* @example Send free text
@@ -4795,7 +4818,7 @@ var SmsResource = class extends SmsResourceBase {
 	* @example Send by template
 	* await bird.sms.send({
 	*   to: "+14155550100",
-	*   template: { name: "bird_otp_verification", parameters: { code: "123456" } },
+	*   template: { slug: "bird_otp_verification", parameters: { code: "123456" } },
 	* });
 	*/
 	send(params, options) {
@@ -4833,7 +4856,7 @@ var SmsTemplatesResource = class extends Resource {
 	*
 	* @example List the built-in templates
 	* const { data } = await bird.smsTemplates.list({ scope: "system" });
-	* for (const tpl of data) console.log(tpl.id, tpl.name);
+	* for (const tpl of data) console.log(tpl.id, tpl.slug);
 	*/
 	list(query, options) {
 		return this.call("GET", options, ({ signal, headers }) => listSmsTemplates({
@@ -4844,9 +4867,9 @@ var SmsTemplatesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Get one SMS template by its name or id, including its body and the variables it expects. Fetch it before sms_send to see which parameter keys a template send requires.
+	* Get one SMS template by its slug or id, including its body and the variables it expects. Fetch it before sms_send to see which parameter keys a template send requires.
 	*
-	* @example Read one template by name or id
+	* @example Read one template by slug or id
 	* const tpl = await bird.smsTemplates.get("bird_otp_verification");
 	* console.log(tpl.body, tpl.variables);
 	*/
@@ -4927,9 +4950,7 @@ var WhatsappResource = class extends WhatsappResourceBase {
 	*   to: "+15551234567",
 	*   template: {
 	*     slug: "bird_otp",
-	*     components: [
-	*       { type: "body", parameters: [{ type: "text", text: "123456" }] },
-	*     ],
+	*     components: [{ type: "body", parameters: [{ type: "text", text: "123456" }] }],
 	*   },
 	* });
 	* console.log(msg.id, msg.status);
@@ -4986,7 +5007,7 @@ var VoiceResource = class extends Resource {
 //#region src/resources/verifyVerifications.gen.ts
 var VerifyVerificationsResource = class extends Resource {
 	/**
-	* Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over the phone channels enabled for its destination country; an email address over email; or both). It is sent over one channel at a time and fails over to the next in the plan, never over two at once. Calling again for the same recipient reuses the in-progress verification and sends a fresh code after the resend cooldown; it does not start a second one, so use this both to send and to resend. The passcode is never returned; submit what the recipient enters with verify_verifications_check. SMS delivery draws on the workspace's SMS balance.
+	* Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over the phone channels enabled for its destination country; an email address over email; or both). It is sent over one channel at a time and fails over to the next in the plan, never over two at once. Calling again for the same recipient reuses the in-progress verification and sends a fresh code after the resend cooldown; it does not start a second one, so use this both to send and to resend. The passcode is never returned; submit what the recipient enters with verify_verifications_check. SMS, WhatsApp and Telegram delivery all draw on the workspace's balance.
 	*
 	* @example Start a verification over SMS
 	* const verification = await bird.verify.verifications.create({
@@ -5386,9 +5407,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.28.0`,
+			"User-Agent": `bird-sdk-js/0.29.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.28.0"
+			"Bird-Version": "0.29.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -5622,6 +5643,28 @@ const SMSErrorCode = {
 	Unreachable: "unreachable"
 };
 /**
+* Values of TemplateLanguageStatus known at this SDK version. The wire value is an open
+* string: a value added by a newer server deserializes unchanged, so switch on
+* these with a `default` branch rather than treating the set as closed.
+*/
+const TemplateLanguageStatus = {
+	Draft: "draft",
+	Live: "live",
+	Superseded: "superseded"
+};
+/**
+* Values of TemplateStatus known at this SDK version. The wire value is an open
+* string: a value added by a newer server deserializes unchanged, so switch on
+* these with a `default` branch rather than treating the set as closed.
+*/
+const TemplateStatus = {
+	Active: "active",
+	Draft: "draft",
+	Inactive: "inactive",
+	Pending: "pending",
+	Rejected: "rejected"
+};
+/**
 * Values of VerificationAttemptFailureReason known at this SDK version. The wire value is an open
 * string: a value added by a newer server deserializes unchanged, so switch on
 * these with a `default` branch rather than treating the set as closed.
@@ -5643,6 +5686,7 @@ const VerificationAttemptFailureReason = {
 const VerificationChannel = {
 	Email: "email",
 	Sms: "sms",
+	Telegram: "telegram",
 	Whatsapp: "whatsapp"
 };
 /**
@@ -5669,6 +5713,19 @@ const WhatsAppErrorCode = {
 	Undeliverable: "undeliverable"
 };
 /**
+* Values of WhatsAppEventType known at this SDK version. The wire value is an open
+* string: a value added by a newer server deserializes unchanged, so switch on
+* these with a `default` branch rather than treating the set as closed.
+*/
+const WhatsAppEventType = {
+	WhatsappAccepted: "whatsapp.accepted",
+	WhatsappDelivered: "whatsapp.delivered",
+	WhatsappFailed: "whatsapp.failed",
+	WhatsappRead: "whatsapp.read",
+	WhatsappRejected: "whatsapp.rejected",
+	WhatsappSent: "whatsapp.sent"
+};
+/**
 * Values of WhatsAppTemplateCategory known at this SDK version. The wire value is an open
 * string: a value added by a newer server deserializes unchanged, so switch on
 * these with a `default` branch rather than treating the set as closed.
@@ -5692,6 +5749,6 @@ const WhatsAppTemplateParameterType = {
 	Video: "video"
 };
 //#endregion
-export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, EmailLookupFlag, EmailLookupReason, EmailLookupResult, LookupFlag, LookupPropertyStatus, SMSErrorCode, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
+export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, EmailLookupFlag, EmailLookupReason, EmailLookupResult, LookupFlag, LookupPropertyStatus, SMSErrorCode, TemplateLanguageStatus, TemplateStatus, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppEventType, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
 
 //# sourceMappingURL=index.mjs.map