@messagebird/sdk 0.35.0 → 0.37.0

package/dist/index.d.mts

@@ -639,9 +639,11 @@ type LanguageTag = string;
 type EmailTemplateId = string;
 type EmailTemplateVersionId = string;
 /**
- * Structured key/value label attached to a message. Surfaces in list filters, the event log, and webhook payloads. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID). For arbitrary per-send context that does not need to be filterable, use `metadata`.
+ * Structured key/value label attached to a message or a call. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID); they surface in the list filter of whatever carries them.
  *
- * The send request defines the tag-count limit. Tag names are unique within a send; supplying the same name twice is rejected.
+ * On a message they also surface in the event log and in webhook payloads, and a message can carry `metadata` beside them for arbitrary per-send context that does not need to be filterable. A call has none of those three: its tags are set on the wire when the call is placed, and the call record is the one place you read them back.
+ *
+ * Whatever carries the tags defines how many it may have. Tag names are unique: a send that repeats one is rejected, and on a call the first instance of a name wins.
  *
  */
 type Tag = {
@@ -2107,10 +2109,25 @@ type SmsSuppressionCreate = {
   originator: string;
 };
 /**
- * Action taken when an inbound message matches the rule. `stop` unsubscribes the sender, `start` resubscribes them, `help` sends your support information, and `custom` sends the reply you configured. Built-in compliance rules fix the operation for `stop`, `start`, and `help`. This is an open enum. Accept unrecognized values.
+ * What Bird does when an inbound message matches the rule.
+ *
+ * - `stop` unsubscribes the sender from further messages.
+ * - `start` resubscribes them.
+ * - `help` replies with your support information.
+ * - `info` replies with your program information. It behaves exactly as `help` does and is
+ * separate so a country whose INFO answer must differ from its HELP answer can carry both.
+ * Where Bird ships no `info` rule for a country, INFO is one of that country's `help`
+ * keywords and answers with the `help` reply.
+ * - `confirm` marks a double opt-in reply. It sends nothing today, so answer it from your own
+ * handler.
+ * - `custom` replies with the text you configured and has no other effect.
+ *
+ * Bird's built-in rules fix the operation for `stop`, `start` and `help`; you can change their
+ * reply but not what they do. The same holds for `info` in any country where Bird ships an
+ * `info` rule. This is an open enum. Accept unrecognized values.
  *
  */
-type SmsKeywordOperation = "stop" | "start" | "help" | "custom" | (string & {});
+type SmsKeywordOperation = "stop" | "start" | "help" | "info" | "confirm" | "custom" | (string & {});
 /**
  * Whether the rule is one of Bird's defaults (`system`) or one your workspace created (`workspace`). A `workspace` rule takes precedence over Bird's default for the same country, so it is how you replace a reply without losing the keywords Bird ships.
  *
@@ -7970,7 +7987,7 @@ type EventWhatsAppSent = {
  */
 type NumberType$1 = "mobile" | "local" | "national" | "short_code" | "short_code_fteu" | "toll_free" | (string & {});
 /**
- * Channel capability supported by a phone number. New capabilities may be added over time, so treat unrecognized values as supported capabilities rather than errors.
+ * A capability supported by a phone number. New capabilities may be added over time, so treat unrecognized values as supported capabilities rather than errors.
  */
 type NumberCapability$1 = "sms" | "mms" | "voice" | (string & {});
 /**
@@ -8013,7 +8030,7 @@ type Number = {
    */
   readonly number_type: NumberType$1;
   /**
-   * Channel capabilities supported by this number.
+   * Capabilities supported by this number.
    */
   readonly capabilities: Array<NumberCapability$1>;
   /**
@@ -8056,7 +8073,7 @@ type AvailableNumber = {
    */
   number_type: NumberType$1;
   /**
-   * Channel capabilities supported by this number.
+   * Capabilities supported by this number.
    */
   capabilities: Array<NumberCapability$1>;
 };
@@ -8234,6 +8251,10 @@ type VoiceCall = {
    * Why we refused the call before dialing a carrier. Absent when the call connected or failed at the carrier; see `sip_response_code` for the carrier response.
    */
   readonly rejection_reason?: VoiceCallRejectionReason;
+  /**
+   * Your own `{name, value}` labels for this call, taken from the `X-Bird-Call-Tag` headers on the INVITE that placed it. Set them to organise calls by a dimension of your own (campaign, queue, agent, cost centre), then filter this list by them with `tag`. Read-only here: a call is labelled when it is placed, and never afterwards. What is here may be less than what was sent, and the call still goes through either way: a tag whose name or value breaks the rules below is dropped, anything past the first five is ignored, and a name sent more than once keeps its first value. Absent when the call carried none, and on calls recorded before this field existed.
+   */
+  readonly tags?: Array<Tag>;
   /**
    * When the call was initiated.
    */
@@ -8430,7 +8451,7 @@ type ListEmailMessagesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
     /**
@@ -8446,7 +8467,7 @@ type ListEmailMessagesData = {
      */
     status?: EmailMessageStatus;
     /**
-     * Filter by tag. Accepts `name` to match any message carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A message must match every tag listed to be returned.
+     * Filter by tag. Accepts `name` to match any record carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A record must match every tag listed to be returned.
      *
      */
     tag?: Array<string>;
@@ -8500,7 +8521,7 @@ type ListContactsData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
     /**
@@ -8594,7 +8615,7 @@ type ListContactPropertiesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -8666,7 +8687,7 @@ type ListAudiencesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -8743,7 +8764,7 @@ type ListAudienceContactsData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -8816,7 +8837,7 @@ type ListSmsMessagesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
     /**
@@ -8854,7 +8875,7 @@ type ListSmsMessagesData = {
      */
     from?: string;
     /**
-     * Filter by tag. Accepts `name` to match any message carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A message must match every tag listed to be returned.
+     * Filter by tag. Accepts `name` to match any record carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A record must match every tag listed to be returned.
      *
      */
     tag?: Array<string>;
@@ -8929,7 +8950,7 @@ type ListSmsSuppressionsData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -9708,7 +9729,7 @@ type ListWhatsAppMessagesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
     /**
@@ -9755,7 +9776,7 @@ type ListWhatsAppMessagesData = {
      */
     category?: WhatsAppTemplateCategory$1;
     /**
-     * Filter by tag. Accepts `name` to match any message carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A message must match every tag listed to be returned.
+     * Filter by tag. Accepts `name` to match any record carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A record must match every tag listed to be returned.
      *
      */
     tag?: Array<string>;
@@ -10461,7 +10482,7 @@ type ListDomainsData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
     /**
@@ -10553,7 +10574,7 @@ type ListMailboxesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -10667,7 +10688,7 @@ type ListMailboxReceiveRulesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -10747,7 +10768,7 @@ type ListEmailThreadsData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -10843,7 +10864,7 @@ type ListEmailThreadMessagesData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -10907,7 +10928,7 @@ type ListWorkspaceNumbersData = {
      */
     prefix?: string;
     /**
-     * Filter by channel capability. Repeat the parameter to require several at once: `capabilities=sms&capabilities=voice` returns only numbers that support both.
+     * Filter by capability. Repeat the parameter to require several at once: `capabilities=sms&capabilities=voice` returns only numbers that support both.
      */
     capabilities?: Array<string>;
     /**
@@ -10919,7 +10940,7 @@ type ListWorkspaceNumbersData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -10948,7 +10969,7 @@ type ListAvailableNumbersData = {
      */
     prefix?: string;
     /**
-     * Filter by channel capability. Repeat the parameter to require several at once: `capabilities=sms&capabilities=voice` returns only numbers that support both.
+     * Filter by capability. Repeat the parameter to require several at once: `capabilities=sms&capabilities=voice` returns only numbers that support both.
      */
     capabilities?: Array<string>;
     /**
@@ -10960,7 +10981,7 @@ type ListAvailableNumbersData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -10989,7 +11010,7 @@ type ListNumbersOrdersData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -11057,6 +11078,11 @@ type ListVoiceCallsData = {
      * Return only calls where the calling or called number contains this value. Matches a partial number, so a country or area-code prefix returns every call to or from it. Combines with `from`/`to`, which match one side exactly.
      */
     number?: string;
+    /**
+     * Filter by tag. Accepts `name` to match any record carrying that tag name, or `name:value` to match a specific tag pair (for example `category:welcome`). Repeat the parameter to add more tags. A record must match every tag listed to be returned.
+     *
+     */
+    tag?: Array<string>;
     /**
      * Return only calls that started at or after this instant, inclusive. RFC 3339 timestamp.
      */
@@ -11074,7 +11100,7 @@ type ListVoiceCallsData = {
      */
     starting_after?: string;
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Cursor from the `prev_cursor` or `refresh_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order. `prev_cursor` returns the preceding page. `refresh_cursor` anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
      */
     ending_before?: string;
   };
@@ -13497,8 +13523,10 @@ type SMSErrorCodeValue = (typeof SMSErrorCode)[keyof typeof SMSErrorCode];
  * these with a `default` branch rather than treating the set as closed.
  */
 declare const SMSKeywordOperation: {
+  readonly Confirm: "confirm";
   readonly Custom: "custom";
   readonly Help: "help";
+  readonly Info: "info";
   readonly Start: "start";
   readonly Stop: "stop";
 };

package/dist/index.mjs

@@ -7132,9 +7132,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.35.0`,
+			"User-Agent": `bird-sdk-js/0.37.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.35.0"
+			"Bird-Version": "0.37.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -7414,8 +7414,10 @@ const SMSErrorCode = {
 * these with a `default` branch rather than treating the set as closed.
 */
 const SMSKeywordOperation = {
+	Confirm: "confirm",
 	Custom: "custom",
 	Help: "help",
+	Info: "info",
 	Start: "start",
 	Stop: "stop"
 };