@messagebird/sdk 0.45.0 → 0.46.0

package/dist/index.mjs

@@ -2935,7 +2935,10 @@ const createVerificationNextChannel = (options) => (options.client ?? client).po
 * Returns the workspace's WhatsApp messages as a cursor-paginated list,
 * newest first, outbound and inbound alike. Each message carries the one
 * content object it was built from: `template`, or free-form `text`,
-* `image`, `video`, `audio`, `sticker`, `document` or `location`. An inbound
+* `image`, `video`, `audio`, `sticker`, `document`, `location`,
+* `interactive` or `contact_cards`. An inbound message carries
+* `interactive_reply` when the contact tapped a reply button or a list row,
+* on an interactive message or on a template's quick reply. An inbound
 * message whose content WhatsApp models and we do not carries `unsupported`
 * instead, naming the type rather than reading back empty.
 * Filter by direction, status, recipient (`to`), sender (`from`),
@@ -2972,8 +2975,9 @@ const listWhatsAppMessages = (options) => (options?.client ?? client).get({
 *
 * Sends one WhatsApp message to one recipient. The request carries exactly one
 * kind of content: a message template, or free-form `text`, `image`, `video`,
-* `audio`, `sticker`, `document` or `location`. A request carrying none is
-* rejected with a `422`, and one carrying more than one is too.
+* `audio`, `sticker`, `document`, `location` or `interactive`. A request
+* carrying none is rejected with a `422`, and one carrying more than one is
+* too.
 *
 * A **template** is the only content WhatsApp delivers outside an open
 * customer service window, so it is what starts a conversation. Name the
@@ -2993,6 +2997,23 @@ const listWhatsAppMessages = (options) => (options?.client ?? client).get({
 * asynchronously, carrying `service_window_expired` on the message's
 * `last_error`. Every free-form send requires `from`.
 *
+* **Interactive content** gives the recipient something to tap. `interactive`
+* names its kind in `type` and carries that kind's own field: reply `buttons`,
+* a `list` menu, a `cta_url` link button, or `cards` for a carousel;
+* `location_request_message` and `request_contact_info` are each a single
+* button asking the recipient for something, so `body_text` is the whole
+* message. A tap on a reply button or a list row comes back as an inbound
+* message carrying `interactive_reply`. The other kinds answer in their own
+* shape: a `cta_url` link opens in the recipient's browser and sends nothing
+* back, and the two request kinds come back as the thing they asked for, an
+* inbound `location` or `contact_cards` message.
+* Interactive content is free-form, so the customer service window and the
+* `from` requirement above both apply.
+*
+* Set `in_reply_to_message_id` to quote a message the contact sees above this
+* one, the way replying in the WhatsApp client does. Any content quotes, and
+* the quoted message must be one from this same conversation.
+*
 * The `202` response is the accepted message, echoing the resolved content; it
 * is not a delivery confirmation. Follow delivery with
 * [Get a WhatsApp message](/docs/api/reference/get-whatsapp-message), the
@@ -3031,7 +3052,7 @@ const createWhatsAppMessage = (options) => (options.client ?? client).post({
 /**
 * Get a WhatsApp message
 *
-* Returns a single WhatsApp message: its current delivery status, per-stage timestamps (`sent_at`, `delivered_at`, `read_at`), and failure detail when it failed. It carries the one content object it was built from: `template`, or free-form `text`, `image`, `video`, `audio`, `sticker`, `document` or `location`. An inbound message whose content WhatsApp models and we do not carries `unsupported` instead, naming the type rather than reading back empty. The `status` advances asynchronously as delivery progresses, so poll this endpoint (or subscribe to `whatsapp.*` webhook events) after a send to confirm delivery. For the per-event timeline, use [List events for a WhatsApp message](/docs/api/reference/list-whatsapp-message-events) instead.
+* Returns a single WhatsApp message: its current delivery status, per-stage timestamps (`sent_at`, `delivered_at`, `read_at`), and failure detail when it failed. It carries the one content object it was built from: `template`, or free-form `text`, `image`, `video`, `audio`, `sticker`, `document`, `location`, `interactive` or `contact_cards`. An inbound message carries `interactive_reply` when the contact tapped a reply button or a list row. An inbound message whose content WhatsApp models and we do not carries `unsupported` instead, naming the type rather than reading back empty. The `status` advances asynchronously as delivery progresses, so poll this endpoint (or subscribe to `whatsapp.*` webhook events) after a send to confirm delivery. For the per-event timeline, use [List events for a WhatsApp message](/docs/api/reference/list-whatsapp-message-events) instead.
 *
 */
 const getWhatsAppMessage = (options) => (options.client ?? client).get({
@@ -6577,7 +6598,7 @@ var SmsTemplatesResource = class extends Resource {
 //#region src/resources/whatsapp.gen.ts
 var WhatsappResourceBase = class extends Resource {
 	/**
-	* Get one WhatsApp message by id: current delivery status, sent/delivered/read timestamps, the one content it was built from (a template, or free-form text, image, video, audio, sticker, document or location), and failure detail if it failed. For the per-event timeline use whatsapp_list_events.
+	* Get one WhatsApp message by id: current delivery status, sent/delivered/read timestamps, the one content it was built from (a template, or free-form text, image, video, audio, sticker, document, location, interactive or contact_cards, or interactive_reply on an inbound tap), and failure detail if it failed. For the per-event timeline use whatsapp_list_events.
 	*
 	* @example Read a message back
 	* const msg = await bird.whatsapp.get("wa_abc123");
@@ -6592,7 +6613,7 @@ var WhatsappResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Each message carries the one content it was built from: a template, or free-form text, image, video, audio, sticker, document or location. Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, recipient (to), sender (from), business-scoped user ID (bsuid), template category, or tag. to and from each accept a phone number or a business-scoped user ID; pair either with direction to search a single side of the message. Use whatsapp_get for one message's current state.
+	* List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Each message carries the one content it was built from: a template, or free-form text, image, video, audio, sticker, document, location, interactive or contact_cards. An inbound tap on a reply button or list row carries interactive_reply instead. Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, recipient (to), sender (from), business-scoped user ID (bsuid), template category, or tag. to and from each accept a phone number or a business-scoped user ID; pair either with direction to search a single side of the message. Use whatsapp_get for one message's current state.
 	*
 	* @example Iterate delivered messages
 	* for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {
@@ -6632,10 +6653,14 @@ var WhatsappResourceBase = class extends Resource {
 var WhatsappResource = class extends WhatsappResourceBase {
 	/**
 	* Send one message, carrying exactly one kind of content: a template, or
-	* free-form `text`, `image`, `video`, `audio`, `sticker`, `document` or
-	* `location`. Every send but a Bird-managed template needs `from`, a number
-	* this workspace owns. The result is `accepted`, not yet delivered — read it
-	* back with `get` to confirm.
+	* free-form `text`, `image`, `video`, `audio`, `sticker`, `document`,
+	* `location` or `interactive` — the last being the arm that gives the
+	* recipient something to tap: reply buttons, a list menu, a link button,
+	* media cards, or a request for their location or contact details. Set
+	* `in_reply_to_message_id` to quote an earlier message from the same
+	* conversation. Every send but a Bird-managed
+	* template needs `from`, a number this workspace owns. The result is
+	* `accepted`, not yet delivered — read it back with `get` to confirm.
 	*
 	* @example
 	* const msg = await bird.whatsapp.send({
@@ -7765,9 +7790,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			...opts.apiKey ? { Authorization: `Bearer ${opts.apiKey}` } : {},
-			"User-Agent": `bird-sdk-js/0.45.0`,
+			"User-Agent": `bird-sdk-js/0.46.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.45.0"
+			"Bird-Version": "0.46.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -8215,6 +8240,48 @@ const WhatsAppEventType = {
 	WhatsappSent: "whatsapp.sent"
 };
 /**
+* Values of WhatsAppInteractiveButtonType 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 WhatsAppInteractiveButtonType = {
+	CtaUrl: "cta_url",
+	QuickReply: "quick_reply"
+};
+/**
+* Values of WhatsAppInteractiveHeaderType 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 WhatsAppInteractiveHeaderType = {
+	Document: "document",
+	Image: "image",
+	Text: "text",
+	Video: "video"
+};
+/**
+* Values of WhatsAppInteractiveReplyType 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 WhatsAppInteractiveReplyType = {
+	Button: "button",
+	List: "list"
+};
+/**
+* Values of WhatsAppInteractiveType 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 WhatsAppInteractiveType = {
+	Button: "button",
+	Carousel: "carousel",
+	CtaUrl: "cta_url",
+	List: "list",
+	LocationRequestMessage: "location_request_message",
+	RequestContactInfo: "request_contact_info"
+};
+/**
 * 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.
@@ -8238,6 +8305,6 @@ const WhatsAppTemplateParameterType = {
 	Video: "video"
 };
 //#endregion
-export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdMissingApiKeyError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, EmailLookupFlag, EmailLookupReason, EmailLookupResult, LookupFlag, LookupPropertyStatus, NumberCapability, NumberType, NumbersOrderStatus, PreferenceChannel, PreferenceOrigin, SMSErrorCode, SMSKeywordOperation, SMSSuppressionCoverage, SMSSuppressionEndReason, SMSSuppressionOrigin, SMSSuppressionReason, TemplateLanguageStatus, TemplateStatus, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppEventType, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
+export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdMissingApiKeyError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, EmailLookupFlag, EmailLookupReason, EmailLookupResult, LookupFlag, LookupPropertyStatus, NumberCapability, NumberType, NumbersOrderStatus, PreferenceChannel, PreferenceOrigin, SMSErrorCode, SMSKeywordOperation, SMSSuppressionCoverage, SMSSuppressionEndReason, SMSSuppressionOrigin, SMSSuppressionReason, TemplateLanguageStatus, TemplateStatus, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppEventType, WhatsAppInteractiveButtonType, WhatsAppInteractiveHeaderType, WhatsAppInteractiveReplyType, WhatsAppInteractiveType, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
 
 //# sourceMappingURL=index.mjs.map