rcs-js 2.0.23 → 2.0.24-rc.2

package/dist/cjs/Client.d.ts

@@ -3,6 +3,7 @@ import { Brands } from "./api/resources/brands/client/Client.js";
 import { Campaigns } from "./api/resources/campaigns/client/Client.js";
 import { Contacts } from "./api/resources/contacts/client/Client.js";
 import { Conversations } from "./api/resources/conversations/client/Client.js";
+import { Faxes } from "./api/resources/faxes/client/Client.js";
 import { Forms } from "./api/resources/forms/client/Client.js";
 import { Messages } from "./api/resources/messages/client/Client.js";
 import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.js";
@@ -27,6 +28,7 @@ export declare class PinnacleClient {
     protected _phoneNumbers: PhoneNumbers | undefined;
     protected _rcs: Rcs | undefined;
     protected _webhooks: Webhooks | undefined;
+    protected _faxes: Faxes | undefined;
     protected _forms: Forms | undefined;
     protected _campaigns: Campaigns | undefined;
     protected _status: Status | undefined;
@@ -40,6 +42,7 @@ export declare class PinnacleClient {
     get phoneNumbers(): PhoneNumbers;
     get rcs(): Rcs;
     get webhooks(): Webhooks;
+    get faxes(): Faxes;
     get forms(): Forms;
     get campaigns(): Campaigns;
     get status(): Status;

package/dist/cjs/Client.js

@@ -40,13 +40,14 @@ const Client_js_2 = require("./api/resources/brands/client/Client.js");
 const Client_js_3 = require("./api/resources/campaigns/client/Client.js");
 const Client_js_4 = require("./api/resources/contacts/client/Client.js");
 const Client_js_5 = require("./api/resources/conversations/client/Client.js");
-const Client_js_6 = require("./api/resources/forms/client/Client.js");
-const Client_js_7 = require("./api/resources/messages/client/Client.js");
-const Client_js_8 = require("./api/resources/phoneNumbers/client/Client.js");
-const Client_js_9 = require("./api/resources/rcs/client/Client.js");
-const Client_js_10 = require("./api/resources/status/client/Client.js");
-const Client_js_11 = require("./api/resources/tools/client/Client.js");
-const Client_js_12 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_6 = require("./api/resources/faxes/client/Client.js");
+const Client_js_7 = require("./api/resources/forms/client/Client.js");
+const Client_js_8 = require("./api/resources/messages/client/Client.js");
+const Client_js_9 = require("./api/resources/phoneNumbers/client/Client.js");
+const Client_js_10 = require("./api/resources/rcs/client/Client.js");
+const Client_js_11 = require("./api/resources/status/client/Client.js");
+const Client_js_12 = require("./api/resources/tools/client/Client.js");
+const Client_js_13 = require("./api/resources/webhooks/client/Client.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
 class PinnacleClient {
@@ -54,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.23",
-                "User-Agent": "rcs-js/2.0.23",
+                "X-Fern-SDK-Version": "2.0.24-rc.2",
+                "User-Agent": "rcs-js/2.0.24-rc.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -78,23 +79,27 @@ class PinnacleClient {
     }
     get messages() {
         var _a;
-        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_7.Messages(this._options)));
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_8.Messages(this._options)));
     }
     get phoneNumbers() {
         var _a;
-        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_8.PhoneNumbers(this._options)));
+        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_9.PhoneNumbers(this._options)));
     }
     get rcs() {
         var _a;
-        return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_9.Rcs(this._options)));
+        return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_10.Rcs(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_12.Webhooks(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_13.Webhooks(this._options)));
+    }
+    get faxes() {
+        var _a;
+        return ((_a = this._faxes) !== null && _a !== void 0 ? _a : (this._faxes = new Client_js_6.Faxes(this._options)));
     }
     get forms() {
         var _a;
-        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Client_js_6.Forms(this._options)));
+        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Client_js_7.Forms(this._options)));
     }
     get campaigns() {
         var _a;
@@ -102,11 +107,11 @@ class PinnacleClient {
     }
     get status() {
         var _a;
-        return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_10.Status(this._options)));
+        return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_11.Status(this._options)));
     }
     get tools() {
         var _a;
-        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_11.Tools(this._options)));
+        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_12.Tools(this._options)));
     }
 }
 exports.PinnacleClient = PinnacleClient;

package/dist/cjs/api/errors/ConflictError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Pinnacle from "../index.js";
+export declare class ConflictError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/ConflictError.js

@@ -0,0 +1,50 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConflictError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class ConflictError extends errors.PinnacleError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ConflictError",
+            statusCode: 409,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ConflictError.prototype);
+    }
+}
+exports.ConflictError = ConflictError;

package/dist/cjs/api/errors/ServiceUnavailableError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Pinnacle from "../index.js";
+export declare class ServiceUnavailableError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/ServiceUnavailableError.js

@@ -0,0 +1,50 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceUnavailableError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class ServiceUnavailableError extends errors.PinnacleError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ServiceUnavailableError",
+            statusCode: 503,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ServiceUnavailableError.prototype);
+    }
+}
+exports.ServiceUnavailableError = ServiceUnavailableError;

package/dist/cjs/api/errors/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./BadRequestError.js";
+export * from "./ConflictError.js";
 export * from "./ForbiddenError.js";
 export * from "./InternalServerError.js";
 export * from "./NotFoundError.js";
 export * from "./NotImplementedError.js";
 export * from "./PaymentRequiredError.js";
+export * from "./ServiceUnavailableError.js";
 export * from "./UnauthorizedError.js";

package/dist/cjs/api/errors/index.js

@@ -15,9 +15,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError.js"), exports);
+__exportStar(require("./ConflictError.js"), exports);
 __exportStar(require("./ForbiddenError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);
 __exportStar(require("./NotImplementedError.js"), exports);
 __exportStar(require("./PaymentRequiredError.js"), exports);
+__exportStar(require("./ServiceUnavailableError.js"), exports);
 __exportStar(require("./UnauthorizedError.js"), exports);

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

@@ -0,0 +1,129 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pinnacle from "../../../index.js";
+export declare namespace Faxes {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Faxes {
+    protected readonly _options: Faxes.Options;
+    constructor(_options: Faxes.Options);
+    /**
+     * List your team's fax history, newest first.
+     *
+     * **HIPAA only:** this endpoint exists only in Pinnacle's HIPAA cell and is unavailable at `https://api.pinnacle.sh`.
+     *
+     * Results contain complete faxes only. Use `nextOffset` until it is null. The maximum page size is 100 records and the maximum offset is 100,000.
+     *
+     * @param {Pinnacle.FaxesListRequest} request
+     * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.faxes.list()
+     */
+    list(request?: Pinnacle.FaxesListRequest, requestOptions?: Faxes.RequestOptions): core.HttpResponsePromise<Pinnacle.ListFaxesResponse>;
+    private __list;
+    /**
+     * Send one PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, or TXT document from a configured fax number.
+     *
+     * **HIPAA only:** this endpoint exists only in Pinnacle's HIPAA cell. Complete HIPAA onboarding and use the connection details provided by Pinnacle. It is not available at `https://api.pinnacle.sh`.
+     *
+     * **Availability:** `from` must be an enabled fax number owned by your team. Fax sending is unavailable for development-mode teams and sandbox numbers. Each request accepts exactly one document; cover pages and per-request webhook URLs are not supported.
+     *
+     * **Source URL:** `mediaUrl` must be a publicly reachable HTTPS URL on port 443. Signed query parameters are supported. URLs with credentials, redirects, private or local network addresses, and non-200 responses are rejected. Downloads must complete within 30 seconds.
+     *
+     * **Document limits:** the document must contain 1–3,500 pages and be no larger than 50 MB. Documents over 350 pages are split automatically and remain one fax in the API. File extensions and response headers do not override file validation.
+     *
+     * **Document safety:** encrypted files, macros, ActiveX controls, embedded objects, symbolic links, unsafe archive paths, and malformed documents are rejected.
+     *
+     * **Quality:** `HIGH` is the default and recommended choice for most documents. Use `NORMAL` when speed matters more than detail, `VERY_HIGH` for small text and fine lines, `ULTRA_LIGHT` for image-heavy documents, or `ULTRA_DARK` for text-heavy documents.
+     *
+     * **Asynchronous processing:** the request returns 202 after preparation is queued. Downloading, validation, conversion, splitting, and archival happen afterward. A 202 response does not mean the document is valid or delivered. Watch `FAX.STATUS` webhooks or retrieve the fax for the final result. The initial status is `PREPARING`, `reservedCost` is zero, and `hasMedia` is false.
+     *
+     * **Multipart delivery:** the original `id` identifies the complete fax across list, detail, cancellation, billing, media, and webhooks. Parts are sent in order. If a part fails, later parts are not sent. The fax becomes `FAILED`, and `partialContent` is true if any earlier pages were transmitted.
+     *
+     * **Pricing:** sent and received faxes cost $0.025 per transmitted page. Quality does not change the rate. Pinnacle reserves the estimated cost after preparation, charges only for transmitted pages, and returns unused reserved credits. If your balance is too low, the fax becomes `FAILED` with `failureReason: INSUFFICIENT_CREDITS`.
+     *
+     * **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:** `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.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.ConflictError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.faxes.send({
+     *         from: "from",
+     *         to: "to",
+     *         mediaUrl: "mediaUrl"
+     *     })
+     */
+    send(request: Pinnacle.SendFaxParams, requestOptions?: Faxes.RequestOptions): core.HttpResponsePromise<Pinnacle.Fax>;
+    private __send;
+    /**
+     * Retrieve a fax and a one-hour signed document URL when its media is available.
+     *
+     * **HIPAA only:** this endpoint exists only in Pinnacle's HIPAA cell and is unavailable at `https://api.pinnacle.sh`.
+     *
+     * Only faxes owned by your team are accessible. Unknown IDs and records removed by your team's HIPAA retention policy return 404. `mediaUrl` is null until archival completes and expires one hour after retrieval; request the fax again for a new URL.
+     *
+     * @param {string} id - Fax ID returned by send, list, or a fax webhook.
+     * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.faxes.get("id")
+     */
+    get(id: string, requestOptions?: Faxes.RequestOptions): core.HttpResponsePromise<Pinnacle.FaxDetail>;
+    private __get;
+    /**
+     * Cancel an outbound fax before transmission starts.
+     *
+     * Cancellation stops queued preparation and every unsent part, releases the credit reservation, and changes the status to `CANCELLED`. Repeating a successful cancellation returns the same fax.
+     *
+     * Cancellation is unavailable for inbound faxes, completed faxes, and `SUBMISSION_UNKNOWN` faxes. Pinnacle returns 409 once transmission may have started, even when later parts remain unsent.
+     *
+     * **HIPAA only:** this endpoint exists only in Pinnacle's HIPAA cell and is unavailable at `https://api.pinnacle.sh`.
+     *
+     * Only a fax ID owned by your team is accepted. Unknown IDs return 404.
+     *
+     * @param {string} id - Fax ID returned by send, list, or a fax webhook.
+     * @param {Faxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.ConflictError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.faxes.cancel("id")
+     */
+    cancel(id: string, requestOptions?: Faxes.RequestOptions): core.HttpResponsePromise<Pinnacle.Fax>;
+    private __cancel;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}