rcs-js 2.0.24-rc.1 → 2.0.24

package/dist/cjs/Client.js

@@ -55,8 +55,8 @@ class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.24-rc.1",
-                "User-Agent": "rcs-js/2.0.24-rc.1",
+                "X-Fern-SDK-Version": "2.0.24",
+                "User-Agent": "rcs-js/2.0.24",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/faxes/client/Client.d.ts

@@ -54,7 +54,7 @@ export declare class Faxes {
      *
      * **Delivery uncertainty:** Pinnacle does not automatically retry a fax after transmission may have started, which prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
      *
-     * **Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing logical fax; changing any of those fields returns 409 and never sends another fax.
+     * **Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries. For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of those fields returns 409.
      *
      * @param {Pinnacle.SendFaxParams} request
      * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +69,6 @@ export declare class Faxes {
      *
      * @example
      *     await client.faxes.send({
-     *         "Idempotency-Key": "Idempotency-Key",
      *         from: "from",
      *         to: "to",
      *         mediaUrl: "mediaUrl"

package/dist/cjs/api/resources/faxes/client/Client.js

@@ -175,7 +175,7 @@ class Faxes {
      *
      * **Delivery uncertainty:** Pinnacle does not automatically retry a fax after transmission may have started, which prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
      *
-     * **Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing logical fax; changing any of those fields returns 409 and never sends another fax.
+     * **Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries. For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of those fields returns 409.
      *
      * @param {Pinnacle.SendFaxParams} request
      * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
@@ -190,7 +190,6 @@ class Faxes {
      *
      * @example
      *     await client.faxes.send({
-     *         "Idempotency-Key": "Idempotency-Key",
      *         from: "from",
      *         to: "to",
      *         mediaUrl: "mediaUrl"
@@ -203,7 +202,7 @@ class Faxes {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { "Idempotency-Key": idempotencyKey } = request, _body = __rest(request, ["Idempotency-Key"]);
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ "Idempotency-Key": idempotencyKey }, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ "Idempotency-Key": idempotencyKey != null ? idempotencyKey : undefined }, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "fax"),
                 method: "POST",

package/dist/cjs/api/resources/faxes/client/requests/SendFaxParams.d.ts

@@ -2,15 +2,14 @@ import type * as Pinnacle from "../../../../index.js";
 /**
  * @example
  *     {
- *         "Idempotency-Key": "Idempotency-Key",
  *         from: "from",
  *         to: "to",
  *         mediaUrl: "mediaUrl"
  *     }
  */
 export interface SendFaxParams {
-    /** Unique key for one logical send. Use 1–128 ASCII letters, numbers, periods, underscores, or hyphens. Reuse it only with the identical `from`, `to`, `mediaUrl`, and effective `quality`; any change returns 409. */
-    "Idempotency-Key": string;
+    /** Optional unique key for one logical send. Without it, every request creates a new fax. Use 1–128 ASCII letters, numbers, periods, underscores, or hyphens. Reuse it only with the identical `from`, `to`, `mediaUrl`, and effective `quality`; any change returns 409. */
+    "Idempotency-Key"?: string;
     /** Fax-enabled, non-sandbox number owned by your HIPAA team, in E.164 format (`+` followed by 10–15 digits; the first digit cannot be zero). The number must remain enabled and configured through preparation. Fax sending is unavailable to development-mode teams. */
     from: string;
     /** Recipient fax number in E.164 format (`+` followed by 10–15 digits; the first digit cannot be zero). */

package/dist/cjs/api/types/RichCards.d.ts

@@ -30,10 +30,33 @@ export declare namespace RichCards {
             buttons?: Pinnacle.RichButton[];
             /** Media file URLs to send. */
             media?: string;
+            /**
+             * Height of the card media. <br><br>
+             * **Default:** `MEDIUM` <br>
+             * **Valid for:** Carousel cards and vertical standalone cards. <br>
+             * **Not valid for:** Horizontal standalone cards. <br>
+             * **Requires:** The card must include a `media` field.
+             */
+            mediaHeight?: Item.MediaHeight;
             /** Secondary text displayed below the title for additional context. */
             subtitle?: string;
             /** Title displayed on the card. */
             title: string;
         }
+        namespace Item {
+            /**
+             * Height of the card media. <br><br>
+             * **Default:** `MEDIUM` <br>
+             * **Valid for:** Carousel cards and vertical standalone cards. <br>
+             * **Not valid for:** Horizontal standalone cards. <br>
+             * **Requires:** The card must include a `media` field.
+             */
+            const MediaHeight: {
+                readonly Short: "SHORT";
+                readonly Medium: "MEDIUM";
+                readonly Tall: "TALL";
+            };
+            type MediaHeight = (typeof MediaHeight)[keyof typeof MediaHeight];
+        }
     }
 }

package/dist/cjs/api/types/RichCards.js

@@ -1,3 +1,25 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RichCards = void 0;
+var RichCards;
+(function (RichCards) {
+    let Cards;
+    (function (Cards) {
+        let Item;
+        (function (Item) {
+            /**
+             * Height of the card media. <br><br>
+             * **Default:** `MEDIUM` <br>
+             * **Valid for:** Carousel cards and vertical standalone cards. <br>
+             * **Not valid for:** Horizontal standalone cards. <br>
+             * **Requires:** The card must include a `media` field.
+             */
+            Item.MediaHeight = {
+                Short: "SHORT",
+                Medium: "MEDIUM",
+                Tall: "TALL",
+            };
+        })(Item = Cards.Item || (Cards.Item = {}));
+    })(Cards = RichCards.Cards || (RichCards.Cards = {}));
+})(RichCards || (exports.RichCards = RichCards = {}));

package/dist/cjs/api/types/RichCardsMessage.d.ts

@@ -32,6 +32,13 @@ export declare namespace RichCardsMessage {
          * > GIFs and videos are not supported and will be rendered as vertical cards.
          */
         standalone_card?: Options.StandaloneCard;
+        /**
+         * Width of each card in a carousel. <br><br>
+         * **Default:** `MEDIUM` <br>
+         * **Valid for:** Multi-card messages (2 to 10 cards). <br>
+         * **Not valid for:** Single-card messages. Setting it with one card fails validation.
+         */
+        cardWidth?: Options.CardWidth;
     }
     namespace Options {
         /**
@@ -62,5 +69,16 @@ export declare namespace RichCardsMessage {
             };
             type ImageAlignment = (typeof ImageAlignment)[keyof typeof ImageAlignment];
         }
+        /**
+         * Width of each card in a carousel. <br><br>
+         * **Default:** `MEDIUM` <br>
+         * **Valid for:** Multi-card messages (2 to 10 cards). <br>
+         * **Not valid for:** Single-card messages. Setting it with one card fails validation.
+         */
+        const CardWidth: {
+            readonly Small: "SMALL";
+            readonly Medium: "MEDIUM";
+        };
+        type CardWidth = (typeof CardWidth)[keyof typeof CardWidth];
     }
 }

package/dist/cjs/api/types/RichCardsMessage.js

@@ -19,5 +19,15 @@ var RichCardsMessage;
                 Right: "RIGHT",
             };
         })(StandaloneCard = Options.StandaloneCard || (Options.StandaloneCard = {}));
+        /**
+         * Width of each card in a carousel. <br><br>
+         * **Default:** `MEDIUM` <br>
+         * **Valid for:** Multi-card messages (2 to 10 cards). <br>
+         * **Not valid for:** Single-card messages. Setting it with one card fails validation.
+         */
+        Options.CardWidth = {
+            Small: "SMALL",
+            Medium: "MEDIUM",
+        };
     })(Options = RichCardsMessage.Options || (RichCardsMessage.Options = {}));
 })(RichCardsMessage || (exports.RichCardsMessage = RichCardsMessage = {}));

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.24-rc.1";
+export declare const SDK_VERSION = "2.0.24";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "2.0.24-rc.1";
+exports.SDK_VERSION = "2.0.24";

package/dist/esm/Client.mjs

@@ -19,8 +19,8 @@ export class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.24-rc.1",
-                "User-Agent": "rcs-js/2.0.24-rc.1",
+                "X-Fern-SDK-Version": "2.0.24",
+                "User-Agent": "rcs-js/2.0.24",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/faxes/client/Client.d.mts

@@ -54,7 +54,7 @@ export declare class Faxes {
      *
      * **Delivery uncertainty:** Pinnacle does not automatically retry a fax after transmission may have started, which prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
      *
-     * **Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing logical fax; changing any of those fields returns 409 and never sends another fax.
+     * **Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries. For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of those fields returns 409.
      *
      * @param {Pinnacle.SendFaxParams} request
      * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +69,6 @@ export declare class Faxes {
      *
      * @example
      *     await client.faxes.send({
-     *         "Idempotency-Key": "Idempotency-Key",
      *         from: "from",
      *         to: "to",
      *         mediaUrl: "mediaUrl"

package/dist/esm/api/resources/faxes/client/Client.mjs

@@ -139,7 +139,7 @@ export class Faxes {
      *
      * **Delivery uncertainty:** Pinnacle does not automatically retry a fax after transmission may have started, which prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
      *
-     * **Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing logical fax; changing any of those fields returns 409 and never sends another fax.
+     * **Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries. For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of those fields returns 409.
      *
      * @param {Pinnacle.SendFaxParams} request
      * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
@@ -154,7 +154,6 @@ export class Faxes {
      *
      * @example
      *     await client.faxes.send({
-     *         "Idempotency-Key": "Idempotency-Key",
      *         from: "from",
      *         to: "to",
      *         mediaUrl: "mediaUrl"
@@ -167,7 +166,7 @@ export class Faxes {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { "Idempotency-Key": idempotencyKey } = request, _body = __rest(request, ["Idempotency-Key"]);
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({ "Idempotency-Key": idempotencyKey }, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({ "Idempotency-Key": idempotencyKey != null ? idempotencyKey : undefined }, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "fax"),
                 method: "POST",

package/dist/esm/api/resources/faxes/client/requests/SendFaxParams.d.mts

@@ -2,15 +2,14 @@ import type * as Pinnacle from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         "Idempotency-Key": "Idempotency-Key",
  *         from: "from",
  *         to: "to",
  *         mediaUrl: "mediaUrl"
  *     }
  */
 export interface SendFaxParams {
-    /** Unique key for one logical send. Use 1–128 ASCII letters, numbers, periods, underscores, or hyphens. Reuse it only with the identical `from`, `to`, `mediaUrl`, and effective `quality`; any change returns 409. */
-    "Idempotency-Key": string;
+    /** Optional unique key for one logical send. Without it, every request creates a new fax. Use 1–128 ASCII letters, numbers, periods, underscores, or hyphens. Reuse it only with the identical `from`, `to`, `mediaUrl`, and effective `quality`; any change returns 409. */
+    "Idempotency-Key"?: string;
     /** Fax-enabled, non-sandbox number owned by your HIPAA team, in E.164 format (`+` followed by 10–15 digits; the first digit cannot be zero). The number must remain enabled and configured through preparation. Fax sending is unavailable to development-mode teams. */
     from: string;
     /** Recipient fax number in E.164 format (`+` followed by 10–15 digits; the first digit cannot be zero). */

package/dist/esm/api/types/RichCards.d.mts

@@ -30,10 +30,33 @@ export declare namespace RichCards {
             buttons?: Pinnacle.RichButton[];
             /** Media file URLs to send. */
             media?: string;
+            /**
+             * Height of the card media. <br><br>
+             * **Default:** `MEDIUM` <br>
+             * **Valid for:** Carousel cards and vertical standalone cards. <br>
+             * **Not valid for:** Horizontal standalone cards. <br>
+             * **Requires:** The card must include a `media` field.
+             */
+            mediaHeight?: Item.MediaHeight;
             /** Secondary text displayed below the title for additional context. */
             subtitle?: string;
             /** Title displayed on the card. */
             title: string;
         }
+        namespace Item {
+            /**
+             * Height of the card media. <br><br>
+             * **Default:** `MEDIUM` <br>
+             * **Valid for:** Carousel cards and vertical standalone cards. <br>
+             * **Not valid for:** Horizontal standalone cards. <br>
+             * **Requires:** The card must include a `media` field.
+             */
+            const MediaHeight: {
+                readonly Short: "SHORT";
+                readonly Medium: "MEDIUM";
+                readonly Tall: "TALL";
+            };
+            type MediaHeight = (typeof MediaHeight)[keyof typeof MediaHeight];
+        }
     }
 }

package/dist/esm/api/types/RichCards.mjs

@@ -1,2 +1,22 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var RichCards;
+(function (RichCards) {
+    let Cards;
+    (function (Cards) {
+        let Item;
+        (function (Item) {
+            /**
+             * Height of the card media. <br><br>
+             * **Default:** `MEDIUM` <br>
+             * **Valid for:** Carousel cards and vertical standalone cards. <br>
+             * **Not valid for:** Horizontal standalone cards. <br>
+             * **Requires:** The card must include a `media` field.
+             */
+            Item.MediaHeight = {
+                Short: "SHORT",
+                Medium: "MEDIUM",
+                Tall: "TALL",
+            };
+        })(Item = Cards.Item || (Cards.Item = {}));
+    })(Cards = RichCards.Cards || (RichCards.Cards = {}));
+})(RichCards || (RichCards = {}));

package/dist/esm/api/types/RichCardsMessage.d.mts

@@ -32,6 +32,13 @@ export declare namespace RichCardsMessage {
          * > GIFs and videos are not supported and will be rendered as vertical cards.
          */
         standalone_card?: Options.StandaloneCard;
+        /**
+         * Width of each card in a carousel. <br><br>
+         * **Default:** `MEDIUM` <br>
+         * **Valid for:** Multi-card messages (2 to 10 cards). <br>
+         * **Not valid for:** Single-card messages. Setting it with one card fails validation.
+         */
+        cardWidth?: Options.CardWidth;
     }
     namespace Options {
         /**
@@ -62,5 +69,16 @@ export declare namespace RichCardsMessage {
             };
             type ImageAlignment = (typeof ImageAlignment)[keyof typeof ImageAlignment];
         }
+        /**
+         * Width of each card in a carousel. <br><br>
+         * **Default:** `MEDIUM` <br>
+         * **Valid for:** Multi-card messages (2 to 10 cards). <br>
+         * **Not valid for:** Single-card messages. Setting it with one card fails validation.
+         */
+        const CardWidth: {
+            readonly Small: "SMALL";
+            readonly Medium: "MEDIUM";
+        };
+        type CardWidth = (typeof CardWidth)[keyof typeof CardWidth];
     }
 }

package/dist/esm/api/types/RichCardsMessage.mjs

@@ -16,5 +16,15 @@ export var RichCardsMessage;
                 Right: "RIGHT",
             };
         })(StandaloneCard = Options.StandaloneCard || (Options.StandaloneCard = {}));
+        /**
+         * Width of each card in a carousel. <br><br>
+         * **Default:** `MEDIUM` <br>
+         * **Valid for:** Multi-card messages (2 to 10 cards). <br>
+         * **Not valid for:** Single-card messages. Setting it with one card fails validation.
+         */
+        Options.CardWidth = {
+            Small: "SMALL",
+            Medium: "MEDIUM",
+        };
     })(Options = RichCardsMessage.Options || (RichCardsMessage.Options = {}));
 })(RichCardsMessage || (RichCardsMessage = {}));

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.24-rc.1";
+export declare const SDK_VERSION = "2.0.24";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.24-rc.1";
+export const SDK_VERSION = "2.0.24";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.24-rc.1",
+    "version": "2.0.24",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",

package/reference.md

@@ -2417,7 +2417,7 @@ Send one PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, or TXT document from a configured
 
 **Delivery uncertainty:** Pinnacle does not automatically retry a fax after transmission may have started, which prevents duplicate delivery and charges. If transmission cannot be confirmed, status becomes `SUBMISSION_UNKNOWN` while Pinnacle reconciles the fax.
 
-**Idempotency:** reuse the same `Idempotency-Key` and identical body after a client timeout. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing logical fax; changing any of those fields returns 409 and never sends another fax.
+**Idempotency:** `Idempotency-Key` is optional. Without it, each request creates a new fax, including retries. For retry-safe sending, generate a UUID for each intended fax and retain it until the outcome is known. After a client timeout, retry with the same key and identical body. The key is scoped to your team and covers `from`, `to`, `mediaUrl`, and `quality`. Reusing it with an identical body returns the existing fax; changing any of those fields returns 409.
 </dd>
 </dl>
 </dd>
@@ -2433,7 +2433,6 @@ Send one PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, or TXT document from a configured
 
 ```typescript
 await client.faxes.send({
-    "Idempotency-Key": "Idempotency-Key",
     from: "from",
     to: "to",
     mediaUrl: "mediaUrl"