@messagebird/sdk 0.50.0 → 0.52.0

package/dist/index.d.mts

@@ -1063,10 +1063,15 @@ type EmailMessageSendRequest = {
   scheduled_at?: string;
 };
 /**
- * Batch of email message send requests. All items are validated before any are queued. Attachments are allowed on individual messages. Each message must stay within the 20 MB estimated generated message-size cap. The serialized JSON request body for the batch has a hard 20 MB cap.
- *
+ * Batch of email message send requests.
  */
-type EmailMessageBatchRequest = Array<EmailMessageSendRequest>;
+type EmailMessageBatchRequest = {
+  /**
+   * Email message send requests, up to 100. All items are validated before any are queued. Attachments are allowed on individual messages. Each message must stay within the 20 MB estimated generated message-size cap. The serialized JSON request body for the batch has a hard 20 MB cap.
+   *
+   */
+  messages: Array<EmailMessageSendRequest>;
+};
 type EmailMessageBatchItem = {
   /**
    * Message ID assigned to this batch item.
@@ -1885,9 +1890,14 @@ type SmsMessageSendRequest = unknown & {
   };
 };
 /**
- * Batch of SMS message send requests. All items are validated before any are queued.
+ * Batch of SMS message send requests.
  */
-type SmsMessageBatchRequest = Array<SmsMessageSendRequest>;
+type SmsMessageBatchRequest = {
+  /**
+   * SMS message send requests, up to 100. Each is an independent send; all are validated before any is queued.
+   */
+  messages: Array<SmsMessageSendRequest>;
+};
 /**
  * Aggregate result for an SMS batch.
  */
@@ -6570,7 +6580,7 @@ type Mailbox = {
    */
   receive_policy: "open" | "replies_only" | "allowlist" | "drop";
   /**
-   * Lifecycle state. Suspended mailboxes stop emitting events. Inbound mail is retained as blocked.
+   * Lifecycle state. `active` means the mailbox can send, receive, and expose conversations. `suspended` pauses sending, conversation reads, and events; inbound mail is retained with the `blocked` label until you resume it.
    */
   readonly state: "active" | "suspended";
   /**
@@ -6595,7 +6605,7 @@ type Mailbox = {
    */
   readonly thread_count: number;
   /**
-   * Stored bytes across the mailbox's retained messages: the metadata and extracted text kept for the retention tier plus attachment bytes. Message bodies and raw MIME expire after 30 days and do not count. Maintained with each message written or deleted, so the value is current; messages stored before the counter existed are not counted.
+   * Stored bytes across the mailbox's retained messages: subject, preview, extracted text, and attachment bytes. Message bodies and raw MIME expire after 30 days and do not count. Maintained with each message written or deleted, so the value is current; messages stored before the counter existed are not counted.
    */
   readonly size_bytes: number;
   /**
@@ -6612,7 +6622,7 @@ type Mailbox = {
   /**
    * Whether we generated the local part of the address. `false` means a custom handle was chosen at creation. On the shared `inbox.ai` domain a custom handle counts against your plan's custom-handle allowance.
    */
-  readonly local_part_generated?: boolean;
+  readonly local_part_generated: boolean;
   /**
    * When the mailbox was created.
    */
@@ -6622,7 +6632,7 @@ type Mailbox = {
    */
   readonly updated_at: string;
   /**
-   * When the mailbox was deleted, or `null` if it is active. A deleted mailbox stops receiving mail immediately but can be restored for 30 days, after which it and its remembered messages are permanently removed.
+   * When the mailbox was deleted, or `null` if it is active. A deleted mailbox stops receiving mail immediately but can be restored for 30 days, after which it and any remaining remembered messages are permanently removed.
    */
   readonly deleted_at?: string | null;
 };
@@ -6694,7 +6704,7 @@ type MailboxUpdate = {
    */
   receive_policy?: "open" | "replies_only" | "allowlist" | "drop";
   /**
-   * How long the mailbox remembers message metadata, extracted text, and attachments. Message bodies and raw MIME stay available for 30 days regardless of tier. Tiers longer than 30 days require a plan that includes them. Lowering the tier deletes remembered messages older than the new horizon, and requires `confirm=true` when that would happen.
+   * How long the mailbox remembers message metadata, extracted text, and attachments. Message bodies and raw MIME stay available for 30 days regardless of tier. Tiers longer than 30 days require a plan that includes them. Lowering the tier immediately hides remembered messages older than the new horizon. Deletion waits at least ten minutes and until the background retention update has processed every stored message. The update starts every ten minutes and can take hours for large mailboxes; the next hourly purge deletes eligible messages. A lowering that would affect messages requires `confirm=true`.
    */
   retention_tier?: "30d" | "90d" | "1y";
   /**
@@ -7156,7 +7166,7 @@ type EmailThreadMessageReplyRequest = {
   };
   category?: EmailMessageCategory;
   /**
-   * File attachments to include with the reply. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata stays on the message's `attachment_manifest`, and the bytes are downloadable for 30 days.
+   * File attachments to include with the reply. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata stays on the message's `attachment_manifest`, and the bytes are downloadable for the mailbox's retention tier.
    *
    */
   attachments?: Array<EmailAttachment>;
@@ -7196,7 +7206,7 @@ type EmailMailboxComposeRequest = {
    */
   reply_to?: Array<EmailAddressInput>;
   /**
-   * File attachments. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata stays on the message's `attachment_manifest`, and the bytes are downloadable for 30 days.
+   * File attachments. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata stays on the message's `attachment_manifest`, and the bytes are downloadable for the mailbox's retention tier.
    *
    */
   attachments?: Array<EmailAttachment>;
@@ -8021,7 +8031,7 @@ type EventEmailMailboxMessageReceivedData = {
    */
   truncated_text?: boolean;
   /**
-   * Number of attachments on the message. Attachment content remains available during the 30-day original-source retention window.
+   * Number of attachments on the message. Attachment content remains available for the mailbox's retention tier.
    */
   attachment_count: number;
   /**
@@ -12069,7 +12079,7 @@ type UpdateMailboxData = {
   };
   query?: {
     /**
-     * Set to `true` when lowering `retention_tier` would delete remembered messages older than the new cutoff. The request is rejected without it in that case.
+     * Set to `true` when lowering `retention_tier` would make remembered messages older than the new cutoff eligible for deletion. The request is rejected without it in that case.
      */
     confirm?: boolean;
   };
@@ -13061,8 +13071,10 @@ type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type DefaultedKeys<D> = D extends object ? Extract<keyof D, keyof EmailMessageSendRequest> : never;
 /** `send` params with defaulted fields made optional. */
 type EmailSend<D> = PartialBy<EmailMessageSendRequest, DefaultedKeys<D>>;
-/** `sendBatch` params — every item relaxed the same way `send` is. */
-type EmailSendBatch<D> = Array<EmailSend<D>>;
+/** `sendBatch` params — every item under `messages` relaxed the same way `send` is. */
+type EmailSendBatch<D> = {
+  messages: Array<EmailSend<D>>;
+};
 //#endregion
 //#region src/resources/emailStats.gen.d.ts
 type EmailStatsSummaryQuery = NonNullable<GetEmailStatsSummaryData["query"]>;
@@ -13296,7 +13308,7 @@ declare class EmailMailboxesResourceBase extends Resource {
    */
   get(mailboxId: string, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Update a mailbox's display name, reply-to, receive policy, retention tier, IP pool, or metadata. Lowering the retention tier requires `confirm=true` when it would delete remembered messages older than the new cutoff.
+   * Update a mailbox's display name, reply-to, receive policy, retention tier, IP pool, or metadata. Lowering the retention tier requires `confirm=true` when it would make remembered messages older than the new cutoff eligible for deletion. Retention tier changes apply in the background, and lowering the tier again before the first change finishes is refused.
    *
    * @example Change a mailbox's receive policy
    * const mailbox = await bird.email.mailboxes.update("mbx_01abc", {
@@ -13306,14 +13318,14 @@ declare class EmailMailboxesResourceBase extends Resource {
    */
   update(mailboxId: string, params?: EmailMailboxesUpdateParams, query?: EmailMailboxesUpdateQuery, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Delete a mailbox. The address stops receiving immediately and is quarantined. The mailbox and its remembered messages stay restorable for 30 days through the restore endpoint, then are permanently deleted.
+   * Delete a mailbox. The address stops receiving immediately and is quarantined. The mailbox can be restored for 30 days, while normal message-retention expiry continues. After 30 days, the mailbox and its remaining messages are permanently deleted.
    *
    * @example Delete a mailbox
    * await bird.email.mailboxes.delete("mbx_01abc");
    */
   delete(mailboxId: string, options?: RequestOptions): APIPromise<void>;
   /**
-   * Restore a mailbox deleted less than 30 days ago: the address starts receiving again and the remembered messages are back. Past the window the mailbox is permanently deleted and returns `404`. A mailbox that is not deleted returns `409`.
+   * Restore a mailbox deleted less than 30 days ago: the address starts receiving again and its remaining remembered messages are available. Normal message-retention expiry continues while a mailbox is deleted. Past the restore window the mailbox is permanently deleted and returns `404`. A mailbox that is not deleted returns `409`.
    *
    * @example Restore a deleted mailbox
    * const mailbox = await bird.email.mailboxes.restore("mbx_01abc");
@@ -13615,24 +13627,29 @@ declare class EmailResource<D extends EmailChannelDefaults | undefined = undefin
    * is accepted (the API's 202). Channel defaults are applied per item, so a
    * field set as a default may be omitted from every item (per-item value wins).
    *
+   * Passing a bare array of sends is deprecated — wrap them in
+   * `{ messages: [...] }`.
+   *
    * @example Send a batch of messages
-   * const batch = await bird.email.sendBatch([
-   *   {
-   *     from: { email: "onboarding@messagebird.dev", name: "Bird" },
-   *     to: ["alice@example.com"],
-   *     subject: "Your receipt",
-   *     html: "<p>Thanks, Alice.</p>",
-   *   },
-   *   {
-   *     from: { email: "onboarding@messagebird.dev", name: "Bird" },
-   *     to: ["bob@example.com"],
-   *     subject: "Your receipt",
-   *     html: "<p>Thanks, Bob.</p>",
-   *   },
-   * ]);
+   * const batch = await bird.email.sendBatch({
+   *   messages: [
+   *     {
+   *       from: { email: "onboarding@messagebird.dev", name: "Bird" },
+   *       to: ["alice@example.com"],
+   *       subject: "Your receipt",
+   *       html: "<p>Thanks, Alice.</p>",
+   *     },
+   *     {
+   *       from: { email: "onboarding@messagebird.dev", name: "Bird" },
+   *       to: ["bob@example.com"],
+   *       subject: "Your receipt",
+   *       html: "<p>Thanks, Bob.</p>",
+   *     },
+   *   ],
+   * });
    * for (const item of batch.data) console.log(item.id, item.status);
    */
-  sendBatch(params: EmailSendBatch<D>, options?: RequestOptions): APIPromise<EmailSendBatchResult>;
+  sendBatch(params: EmailSendBatch<D> | Array<EmailSend<D>>, options?: RequestOptions): APIPromise<EmailSendBatchResult>;
 }
 //#endregion
 //#region src/resources/audiences.gen.d.ts
@@ -14284,26 +14301,32 @@ declare class SmsResource extends SmsResourceBase {
    */
   send(params: SmsSendParams, options?: RequestOptions): APIPromise<SmsMessage>;
   /**
-   * Send up to 100 independent SMS messages in one call. Each item is a full send
-   * (free text or template); all items are validated before any are queued.
+   * Send up to 100 independent SMS messages in one call. Each item under
+   * `messages` is a full send (free text or template); all items are validated
+   * before any are queued.
+   *
+   * Passing a bare array of sends is deprecated — wrap them in
+   * `{ messages: [...] }`.
    *
    * @example
-   * const result = await bird.sms.sendBatch([
-   *   {
-   *     from: "+15557654321",
-   *     to: "+15551111111",
-   *     text: "Hi Alice!",
-   *     category: "marketing",
-   *   },
-   *   {
-   *     from: "+15557654321",
-   *     to: "+15552222222",
-   *     text: "Hi Bob!",
-   *     category: "marketing",
-   *   },
-   * ]);
+   * const result = await bird.sms.sendBatch({
+   *   messages: [
+   *     {
+   *       from: "+15557654321",
+   *       to: "+15551111111",
+   *       text: "Hi Alice!",
+   *       category: "marketing",
+   *     },
+   *     {
+   *       from: "+15557654321",
+   *       to: "+15552222222",
+   *       text: "Hi Bob!",
+   *       category: "marketing",
+   *     },
+   *   ],
+   * });
    */
-  sendBatch(params: SmsSendBatchParams, options?: RequestOptions): APIPromise<SmsSendBatchResult>;
+  sendBatch(params: SmsSendBatchParams | SmsSendParams[], options?: RequestOptions): APIPromise<SmsSendBatchResult>;
 }
 //#endregion
 //#region src/resources/smsKeywordRules.gen.d.ts

package/dist/index.mjs

@@ -3671,7 +3671,7 @@ const createMailbox = (options) => (options.client ?? client).post({
 /**
 * Delete a mailbox
 *
-* Deletes a mailbox. The address stops receiving mail immediately and enters quarantine. After 30 days, your workspace can bind the address to a new mailbox; the address remains reserved to your workspace. The mailbox and its remembered messages are kept for 30 days, so you can bring it back with `POST /email/mailboxes/{mailbox_id}/restore`. Once those 30 days are up they are deleted for good.
+* Deletes a mailbox. The address stops receiving mail immediately and enters quarantine. After 30 days, your workspace can bind the address to a new mailbox; the address remains reserved to your workspace. You can restore the mailbox for 30 days with `POST /email/mailboxes/{mailbox_id}/restore`. Normal message-retention expiry continues during that period. After 30 days, the mailbox and its remaining messages are permanently deleted.
 *
 */
 const deleteMailbox = (options) => (options.client ?? client).delete({
@@ -3707,7 +3707,7 @@ const getMailbox = (options) => (options.client ?? client).get({
 /**
 * Update a mailbox
 *
-* Updates a mailbox. The address and domain are immutable. Lowering the retention tier deletes any remembered message older than the new cutoff, so the request requires `confirm=true`.
+* Updates a mailbox. The address and domain are immutable. Lowering the retention tier makes remembered messages older than the new cutoff eligible for deletion. If any exist, the request requires `confirm=true`. A tier change is applied to the mailbox's stored messages in the background; lowering the tier again while that is still being applied is refused with `E17050`. You can still raise it to a tier your plan permits.
 *
 */
 const updateMailbox = (options) => (options.client ?? client).patch({
@@ -3729,7 +3729,7 @@ const updateMailbox = (options) => (options.client ?? client).patch({
 /**
 * Restore a deleted mailbox
 *
-* Restores a mailbox deleted less than 30 days ago. The address is bound back to the mailbox and starts receiving again, and the remembered messages and conversations are available as before the delete. Once the 30-day window has passed the mailbox and its messages are permanently deleted and can no longer be restored (`404`). Restoring a mailbox that is not deleted returns a conflict, as does an address that is no longer available.
+* Restores a mailbox deleted less than 30 days ago. The address is bound back to the mailbox and starts receiving again. Remaining remembered messages and conversations become available again; normal message-retention expiry continues while a mailbox is deleted. Once the 30-day window has passed, the mailbox and any remaining messages are permanently deleted and can no longer be restored (`404`). Restoring a mailbox that is not deleted returns a conflict, as does an address that is no longer available.
 *
 */
 const restoreMailbox = (options) => (options.client ?? client).post({
@@ -4927,7 +4927,7 @@ var EmailMailboxesResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* Update a mailbox's display name, reply-to, receive policy, retention tier, IP pool, or metadata. Lowering the retention tier requires `confirm=true` when it would delete remembered messages older than the new cutoff.
+	* Update a mailbox's display name, reply-to, receive policy, retention tier, IP pool, or metadata. Lowering the retention tier requires `confirm=true` when it would make remembered messages older than the new cutoff eligible for deletion. Retention tier changes apply in the background, and lowering the tier again before the first change finishes is refused.
 	*
 	* @example Change a mailbox's receive policy
 	* const mailbox = await bird.email.mailboxes.update("mbx_01abc", {
@@ -4946,7 +4946,7 @@ var EmailMailboxesResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* Delete a mailbox. The address stops receiving immediately and is quarantined. The mailbox and its remembered messages stay restorable for 30 days through the restore endpoint, then are permanently deleted.
+	* Delete a mailbox. The address stops receiving immediately and is quarantined. The mailbox can be restored for 30 days, while normal message-retention expiry continues. After 30 days, the mailbox and its remaining messages are permanently deleted.
 	*
 	* @example Delete a mailbox
 	* await bird.email.mailboxes.delete("mbx_01abc");
@@ -4960,7 +4960,7 @@ var EmailMailboxesResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* Restore a mailbox deleted less than 30 days ago: the address starts receiving again and the remembered messages are back. Past the window the mailbox is permanently deleted and returns `404`. A mailbox that is not deleted returns `409`.
+	* Restore a mailbox deleted less than 30 days ago: the address starts receiving again and its remaining remembered messages are available. Normal message-retention expiry continues while a mailbox is deleted. Past the restore window the mailbox is permanently deleted and returns `404`. A mailbox that is not deleted returns `409`.
 	*
 	* @example Restore a deleted mailbox
 	* const mailbox = await bird.email.mailboxes.restore("mbx_01abc");
@@ -5427,25 +5427,30 @@ var EmailResource = class extends EmailResourceBase {
 	* is accepted (the API's 202). Channel defaults are applied per item, so a
 	* field set as a default may be omitted from every item (per-item value wins).
 	*
+	* Passing a bare array of sends is deprecated — wrap them in
+	* `{ messages: [...] }`.
+	*
 	* @example Send a batch of messages
-	* const batch = await bird.email.sendBatch([
-	*   {
-	*     from: { email: "onboarding@messagebird.dev", name: "Bird" },
-	*     to: ["alice@example.com"],
-	*     subject: "Your receipt",
-	*     html: "<p>Thanks, Alice.</p>",
-	*   },
-	*   {
-	*     from: { email: "onboarding@messagebird.dev", name: "Bird" },
-	*     to: ["bob@example.com"],
-	*     subject: "Your receipt",
-	*     html: "<p>Thanks, Bob.</p>",
-	*   },
-	* ]);
+	* const batch = await bird.email.sendBatch({
+	*   messages: [
+	*     {
+	*       from: { email: "onboarding@messagebird.dev", name: "Bird" },
+	*       to: ["alice@example.com"],
+	*       subject: "Your receipt",
+	*       html: "<p>Thanks, Alice.</p>",
+	*     },
+	*     {
+	*       from: { email: "onboarding@messagebird.dev", name: "Bird" },
+	*       to: ["bob@example.com"],
+	*       subject: "Your receipt",
+	*       html: "<p>Thanks, Bob.</p>",
+	*     },
+	*   ],
+	* });
 	* for (const item of batch.data) console.log(item.id, item.status);
 	*/
 	sendBatch(params, options) {
-		const body = params.map((item) => withDefaults(this.#defaults, item));
+		const body = { messages: (Array.isArray(params) ? params : params.messages).map((item) => withDefaults(this.#defaults, item)) };
 		return this.call("POST", options, ({ signal, headers }) => createEmailMessageBatch({
 			client: this.client,
 			body,
@@ -6465,29 +6470,36 @@ var SmsResource = class extends SmsResourceBase {
 		}));
 	}
 	/**
-	* Send up to 100 independent SMS messages in one call. Each item is a full send
-	* (free text or template); all items are validated before any are queued.
+	* Send up to 100 independent SMS messages in one call. Each item under
+	* `messages` is a full send (free text or template); all items are validated
+	* before any are queued.
+	*
+	* Passing a bare array of sends is deprecated — wrap them in
+	* `{ messages: [...] }`.
 	*
 	* @example
-	* const result = await bird.sms.sendBatch([
-	*   {
-	*     from: "+15557654321",
-	*     to: "+15551111111",
-	*     text: "Hi Alice!",
-	*     category: "marketing",
-	*   },
-	*   {
-	*     from: "+15557654321",
-	*     to: "+15552222222",
-	*     text: "Hi Bob!",
-	*     category: "marketing",
-	*   },
-	* ]);
+	* const result = await bird.sms.sendBatch({
+	*   messages: [
+	*     {
+	*       from: "+15557654321",
+	*       to: "+15551111111",
+	*       text: "Hi Alice!",
+	*       category: "marketing",
+	*     },
+	*     {
+	*       from: "+15557654321",
+	*       to: "+15552222222",
+	*       text: "Hi Bob!",
+	*       category: "marketing",
+	*     },
+	*   ],
+	* });
 	*/
 	sendBatch(params, options) {
+		const body = Array.isArray(params) ? { messages: params } : params;
 		return this.call("POST", options, ({ signal, headers }) => createSmsMessageBatch({
 			client: this.client,
-			body: params,
+			body,
 			headers,
 			signal
 		}));
@@ -7927,9 +7939,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			...opts.apiKey ? { Authorization: `Bearer ${opts.apiKey}` } : {},
-			"User-Agent": `bird-sdk-js/0.50.0`,
+			"User-Agent": `bird-sdk-js/0.52.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.50.0"
+			"Bird-Version": "0.52.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;