@messagebird/sdk 0.37.1 → 0.37.2

package/dist/index.d.mts

@@ -8017,7 +8017,7 @@ type Number = {
    */
   readonly id: AllocatedNumberId;
   /**
-   * How this number is allocated. `dedicated` is allocated to this workspace alone and billed as a subscription. `shared` is a shortcode allocated to several workspaces at once and managed by us.
+   * How this number is allocated. `dedicated` belongs to your workspace and is billed as a subscription. `shared` is provided through Bird-managed shared infrastructure and is not owned or billed as a workspace subscription.
    */
   readonly kind: "dedicated" | "shared";
   /**
@@ -13078,7 +13078,7 @@ declare class NumbersResourceBase extends Resource {
    *
    * @example List the numbers allocated to you
    * for await (const allocated of bird.numbers.list({ country_code: "GB" })) {
-   *   // kind tells a number you bought from one Bird manages for several workspaces.
+   *   // kind distinguishes a number you bought from one Bird manages.
    *   console.log(allocated.number, allocated.kind, allocated.status);
    * }
    */

package/dist/index.mjs

@@ -3441,7 +3441,7 @@ const listMailboxes = (options) => (options?.client ?? client).get({
 /**
 * Create a mailbox
 *
-* Creates a mailbox. The address is `local_part@domain`. The domain defaults to `inbox.ai`, Bird's shared mailbox domain, where creating the mailbox claims the address for your organization. It is first come, first served, and reserved to your organization even after the mailbox is deleted. You may instead name one of your own domains that is enabled for receiving email. An omitted local part is generated. On a custom domain, addresses of deleted mailboxes are quarantined. The same workspace can rebind one 30 days after deletion, but other workspaces never can.
+* Creates a mailbox. The address is `local_part@domain`. The domain defaults to `inbox.ai`, Bird's shared mailbox domain, where creating the mailbox claims the address for your organization. It is first come, first served, and reserved to your organization even after the mailbox is deleted. You may instead name one of your own domains that is enabled for receiving email. An omitted local part is generated. On a custom domain, addresses of deleted mailboxes are quarantined for 30 days and remain reserved for your workspace.
 *
 */
 const createMailbox = (options) => (options.client ?? client).post({
@@ -3463,7 +3463,7 @@ const createMailbox = (options) => (options.client ?? client).post({
 /**
 * Delete a mailbox
 *
-* Deletes a mailbox. The address stops receiving mail immediately and enters quarantine. The same workspace can bind it to a new mailbox after 30 days, but other workspaces never can. 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. 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.
 *
 */
 const deleteMailbox = (options) => (options.client ?? client).delete({
@@ -3986,7 +3986,7 @@ const getNumbersOrder = (options) => (options.client ?? client).get({
 /**
 * Release a dedicated number
 *
-* Releases one of your workspace's dedicated numbers and stops its monthly charge. Your workspace can no longer use the number after release. Shared numbers cannot be released because they serve multiple workspaces.
+* Releases one of your workspace's dedicated numbers and stops its monthly charge. Your workspace can no longer use the number after release. Shared numbers belong to Bird-managed shared infrastructure and cannot be released from your workspace.
 */
 const releaseWorkspaceNumber = (options) => (options.client ?? client).delete({
 	security: [{
@@ -6872,7 +6872,7 @@ var NumbersResourceBase = class extends Resource {
 	*
 	* @example List the numbers allocated to you
 	* for await (const allocated of bird.numbers.list({ country_code: "GB" })) {
-	*   // kind tells a number you bought from one Bird manages for several workspaces.
+	*   // kind distinguishes a number you bought from one Bird manages.
 	*   console.log(allocated.number, allocated.kind, allocated.status);
 	* }
 	*/
@@ -7132,9 +7132,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.37.1`,
+			"User-Agent": `bird-sdk-js/0.37.2`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.37.1"
+			"Bird-Version": "0.37.2"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;