@messagebird/sdk 0.35.0 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2107,10 +2107,25 @@ type SmsSuppressionCreate = {
2107
2107
  originator: string;
2108
2108
  };
2109
2109
  /**
2110
- * 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.
2110
+ * What Bird does when an inbound message matches the rule.
2111
+ *
2112
+ * - `stop` unsubscribes the sender from further messages.
2113
+ * - `start` resubscribes them.
2114
+ * - `help` replies with your support information.
2115
+ * - `info` replies with your program information. It behaves exactly as `help` does and is
2116
+ * separate so a country whose INFO answer must differ from its HELP answer can carry both.
2117
+ * Where Bird ships no `info` rule for a country, INFO is one of that country's `help`
2118
+ * keywords and answers with the `help` reply.
2119
+ * - `confirm` marks a double opt-in reply. It sends nothing today, so answer it from your own
2120
+ * handler.
2121
+ * - `custom` replies with the text you configured and has no other effect.
2122
+ *
2123
+ * Bird's built-in rules fix the operation for `stop`, `start` and `help`; you can change their
2124
+ * reply but not what they do. The same holds for `info` in any country where Bird ships an
2125
+ * `info` rule. This is an open enum. Accept unrecognized values.
2111
2126
  *
2112
2127
  */
2113
- type SmsKeywordOperation = "stop" | "start" | "help" | "custom" | (string & {});
2128
+ type SmsKeywordOperation = "stop" | "start" | "help" | "info" | "confirm" | "custom" | (string & {});
2114
2129
  /**
2115
2130
  * 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.
2116
2131
  *
@@ -13497,8 +13512,10 @@ type SMSErrorCodeValue = (typeof SMSErrorCode)[keyof typeof SMSErrorCode];
13497
13512
  * these with a `default` branch rather than treating the set as closed.
13498
13513
  */
13499
13514
  declare const SMSKeywordOperation: {
13515
+ readonly Confirm: "confirm";
13500
13516
  readonly Custom: "custom";
13501
13517
  readonly Help: "help";
13518
+ readonly Info: "info";
13502
13519
  readonly Start: "start";
13503
13520
  readonly Stop: "stop";
13504
13521
  };
package/dist/index.mjs CHANGED
@@ -7132,9 +7132,9 @@ var BirdClient = class {
7132
7132
  this.#headers = {
7133
7133
  ...opts.defaultHeaders,
7134
7134
  Authorization: `Bearer ${opts.apiKey}`,
7135
- "User-Agent": `bird-sdk-js/0.35.0`,
7135
+ "User-Agent": `bird-sdk-js/0.36.0`,
7136
7136
  "Bird-Surface": "sdk-js",
7137
- "Bird-Version": "0.35.0"
7137
+ "Bird-Version": "0.36.0"
7138
7138
  };
7139
7139
  const caller = detectCaller();
7140
7140
  if (caller) this.#headers["Bird-Caller"] = caller;
@@ -7414,8 +7414,10 @@ const SMSErrorCode = {
7414
7414
  * these with a `default` branch rather than treating the set as closed.
7415
7415
  */
7416
7416
  const SMSKeywordOperation = {
7417
+ Confirm: "confirm",
7417
7418
  Custom: "custom",
7418
7419
  Help: "help",
7420
+ Info: "info",
7419
7421
  Start: "start",
7420
7422
  Stop: "stop"
7421
7423
  };