@messagebird/sdk 0.42.0 → 0.42.1

package/dist/index.d.mts

@@ -1545,12 +1545,24 @@ type SmsSegments = {
    */
   readonly count: number;
   /**
-   * Encoding used for the body. The `GSM_7BIT` encoding fits 160 characters in one segment, or 153 per part in a multi-segment message. The `UCS2` encoding applies when the body contains a character outside the GSM 03.38 alphabet, including emoji, CJK, and some accented characters. It fits 70 characters in one segment, or 67 per part in a multi-segment message.
+   * Encoding used for the body. The `GSM_7BIT` encoding fits 160 septets
+   * (seven-bit units) in one segment, or 153 per part in a multi-segment
+   * message. The `UCS2` encoding applies when the body contains a character
+   * outside the GSM 03.38 alphabet, including emoji, CJK, and some accented
+   * characters. It fits 70 UTF-16 code units in one segment, or 67 per part.
+   *
+   * Neither limit counts characters, and both alphabets have characters that
+   * cost two units. Under `GSM_7BIT` there are ten such entries, and they are
+   * the whole set: `^`, `{`, `}`, `\`, `[`, `]`, `~`, `|`, `€`, and the form
+   * feed control. Eighty of those fill a single segment. Under `UCS2` an emoji
+   * outside the Basic Multilingual Plane is a surrogate pair costing two code
+   * units, so 35 of those fill a single segment.
    *
    */
   readonly encoding: "GSM_7BIT" | "UCS2";
   /**
-   * Character count of the body under the selected encoding.
+   * Character count of the body, counted in Unicode code points under either encoding. This is not the segment measure: a `GSM_7BIT` extended-table character counts once here but costs two septets, and a `UCS2` emoji outside the Basic Multilingual Plane counts once here but costs two of the segment's 70 code units.
+   *
    */
   readonly characters: number;
 };
@@ -8686,7 +8698,7 @@ type PublishRealtimeAppEventData = {
   body: RealtimePublish;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -8717,7 +8729,7 @@ type PublishRealtimeAppBatchData = {
   body: RealtimeBatchPublish;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -8748,7 +8760,7 @@ type ListRealtimeAppChannelsData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -8774,7 +8786,7 @@ type GetRealtimeAppChannelData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -8800,7 +8812,7 @@ type SendRealtimeAppMemberEventData = {
   body: RealtimeMemberPublish;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -9427,7 +9439,7 @@ type ListSmsKeywordRulesData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -9464,7 +9476,7 @@ type CreateSmsKeywordRuleData = {
   body: SmsKeywordRuleCreate;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -9490,7 +9502,7 @@ type UpdateSmsKeywordRuleData = {
   body: SmsKeywordRuleUpdate;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10035,7 +10047,7 @@ type CreatePhoneNumberLookupData = {
   body: PhoneNumberLookupRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10061,7 +10073,7 @@ type CreateEmailLookupData = {
   body: EmailLookupRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10087,7 +10099,7 @@ type CreateVerificationData = {
   body: VerificationCreateRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10113,7 +10125,7 @@ type CreateVerificationCheckData = {
   body: VerificationCheckRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -10139,7 +10151,7 @@ type CreateVerificationNextChannelData = {
   body: VerificationNextChannelRequest;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**
@@ -11350,7 +11362,7 @@ type ListWorkspaceNumbersData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -11395,7 +11407,7 @@ type ListAvailableNumbersData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -11436,7 +11448,7 @@ type ListNumbersOrdersData = {
   body?: never;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
   };
@@ -11465,7 +11477,7 @@ type CreateNumbersOrderData = {
   body: NumbersOrderCreate;
   headers?: {
     /**
-     * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
+     * Workspace context for the request. Required for dashboard authentication. An API key or access token carries its own workspace, so send either that workspace or no header at all; a different one is rejected.
      */
     "X-Workspace-Id"?: string;
     /**

package/dist/index.mjs

@@ -7420,9 +7420,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.42.0`,
+			"User-Agent": `bird-sdk-js/0.42.1`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.42.0"
+			"Bird-Version": "0.42.1"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@messagebird/sdk",
-  "version": "0.42.0",
+  "version": "0.42.1",
   "description": "The official TypeScript SDK for the Bird API: email, SMS, WhatsApp, verification, and Realtime on one typed client.",
   "license": "MIT",
   "author": "Bird",