rcs-js 2.0.0-rc.9 → 2.0.1-rc.1

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

@@ -0,0 +1,283 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as errors from "../../../../errors/index.mjs";
+export class Rcs {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Check RCS capabilities for one or more phone numbers.
+     *
+     * This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
+     * on specific phone numbers before sending RCS messages to them.
+     *
+     * @param {Pinnacle.RcsCapabilitiesQuery} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.rcs.getCapabilities({
+     *         phoneNumbers: ["+12345678901", "+19876543210"]
+     *     })
+     */
+    getCapabilities(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getCapabilities(request, requestOptions));
+    }
+    __getCapabilities(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (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, "rcs/capabilities"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/capabilities.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Whitelist a phone number for testing with your test RCS agent.
+     *
+     * ## Overview
+     * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
+     * Use this endpoint to add test devices to your agent's whitelist before sending test messages.
+     *
+     * ## Verification Process
+     * After whitelisting a number, you'll need to complete verification:
+     *
+     * 1. Check the test device for an "RBM Tester Management" request
+     * 2. Accept the request on the device
+     * 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+     *    ```
+     *    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+     *    ```
+     *
+     * > **Important Notes**
+     * >
+     * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
+     * > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
+     * > - **Verification required:** The whitelist request isn't complete until you verify the device.
+     *
+     * @param {Pinnacle.RcsWhitelistRequest} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.rcs.whitelist({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         phoneNumber: "+12345678901"
+     *     })
+     */
+    whitelist(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__whitelist(request, requestOptions));
+    }
+    __whitelist(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (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, "rcs/whitelist"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/whitelist.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Generate a link for initiating an RCS conversation with your agent.
+     *
+     * Users can click these links to start conversations with your RCS agent directly
+     * from websites, emails, or other applications.
+     *
+     * @param {Pinnacle.RcsLinkRequest} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.rcs.getLink({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         testMode: false,
+     *         phoneNumber: "+12345678901",
+     *         body: "Hello, I need help with my order"
+     *     })
+     */
+    getLink(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getLink(request, requestOptions));
+    }
+    __getLink(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (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, "rcs/link"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/link.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "PINNACLE-API-KEY": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/rcs/client/index.d.mts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/rcs/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         phoneNumbers: ["+12345678901", "+19876543210"]
+ *     }
+ */
+export interface RcsCapabilitiesQuery {
+    /** List of phone numbers to check RCS capabilities for (E.164 format) */
+    phoneNumbers: string[];
+}

package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         agentId: "agent_XXXXXXXXXXXX",
+ *         testMode: false,
+ *         phoneNumber: "+12345678901",
+ *         body: "Hello, I need help with my order"
+ *     }
+ */
+export interface RcsLinkRequest {
+    /** The RCS agent ID (must be prefixed with 'agent_') */
+    agentId: string;
+    /** Link to the test agent or the production agent if false */
+    testMode?: boolean;
+    /** Fallback phone number (E.164 format) to use if the phone number does not support RCS. If not provided, no url will be generated. */
+    phoneNumber?: string;
+    /** Optional message body to pre-fill after the user clicks the link */
+    body?: string;
+}

package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         agentId: "agent_XXXXXXXXXXXX",
+ *         phoneNumber: "+12345678901"
+ *     }
+ */
+export interface RcsWhitelistRequest {
+    /** The RCS agent ID (must be prefixed with 'agent_') */
+    agentId: string;
+    /** Phone number to whitelist for testing (E.164 format) */
+    phoneNumber: string;
+}

package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/rcs/client/requests/index.d.mts

@@ -0,0 +1,3 @@
+export { type RcsCapabilitiesQuery } from "./RcsCapabilitiesQuery.mjs";
+export { type RcsWhitelistRequest } from "./RcsWhitelistRequest.mjs";
+export { type RcsLinkRequest } from "./RcsLinkRequest.mjs";

package/dist/esm/api/resources/rcs/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/rcs/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/rcs/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

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

@@ -9,7 +9,7 @@ export declare namespace Status {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -17,6 +17,6 @@ export declare namespace Status {
 export declare class Status {
     protected readonly _options: Status.Options;
     protected _get: Get | undefined;
-    constructor(_options: Status.Options);
+    constructor(_options?: Status.Options);
     get get(): Get;
 }

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

@@ -3,7 +3,7 @@
  */
 import { Get } from "../resources/get/client/Client.mjs";
 export class Status {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get get() {

package/dist/esm/api/resources/status/resources/get/client/Client.d.mts

@@ -9,7 +9,7 @@ export declare namespace Get {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,11 +28,11 @@ export declare namespace Get {
 }
 export declare class Get {
     protected readonly _options: Get.Options;
-    constructor(_options: Get.Options);
+    constructor(_options?: Get.Options);
     /**
      * Retrieve a brand's status.
      *
-     * @param {number} brandId - ID of the brand.
+     * @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -42,14 +42,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.brand(28)
+     *     await client.status.get.brand("b_1234567890")
      */
-    brand(brandId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
+    brand(brandId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
     private __brand;
     /**
      * Retrieve a toll-free campaign's status.
      *
-     * @param {number} campaignId - ID of the toll-free campaign.
+     * @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.tollFree(28)
+     *     await client.status.get.tollFree("tf_1234567890")
      */
-    tollFree(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
+    tollFree(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
     private __tollFree;
     /**
-     * Retrieve a DLC campaign's status.
+     * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the DLC campaign.
+     * @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -76,14 +76,14 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.dlc(28)
+     *     await client.status.get.dlc("dlc_1234567890")
      */
-    dlc(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
+    dlc(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
     private __dlc;
     /**
      * Retrieve a RCS campaign's status.
      *
-     * @param {number} campaignId - ID of the campaign.
+     * @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -93,9 +93,9 @@ export declare class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.rcs(28)
+     *     await client.status.get.rcs("rcs_1234567890")
      */
-    rcs(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
+    rcs(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
     private __rcs;
     /**
      * Retrieve a phone number's order status and campaign attachment status. <br>
@@ -117,6 +117,6 @@ export declare class Get {
     phoneNumber(phoneNumber: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.PhoneNumberStatus>;
     private __phoneNumber;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/esm/api/resources/status/resources/get/client/Client.mjs

@@ -16,13 +16,13 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class Get {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Retrieve a brand's status.
      *
-     * @param {number} brandId - ID of the brand.
+     * @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -32,7 +32,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.brand(28)
+     *     await client.status.get.brand("b_1234567890")
      */
     brand(brandId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__brand(brandId, requestOptions));
@@ -93,7 +93,7 @@ export class Get {
     /**
      * Retrieve a toll-free campaign's status.
      *
-     * @param {number} campaignId - ID of the toll-free campaign.
+     * @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -103,7 +103,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.tollFree(28)
+     *     await client.status.get.tollFree("tf_1234567890")
      */
     tollFree(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__tollFree(campaignId, requestOptions));
@@ -162,9 +162,9 @@ export class Get {
         });
     }
     /**
-     * Retrieve a DLC campaign's status.
+     * Retrieve a 10DLC campaign's status.
      *
-     * @param {number} campaignId - ID of the DLC campaign.
+     * @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -174,7 +174,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.dlc(28)
+     *     await client.status.get.dlc("dlc_1234567890")
      */
     dlc(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__dlc(campaignId, requestOptions));
@@ -235,7 +235,7 @@ export class Get {
     /**
      * Retrieve a RCS campaign's status.
      *
-     * @param {number} campaignId - ID of the campaign.
+     * @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
      * @param {Get.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -245,7 +245,7 @@ export class Get {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.status.get.rcs(28)
+     *     await client.status.get.rcs("rcs_1234567890")
      */
     rcs(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__rcs(campaignId, requestOptions));

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

@@ -11,7 +11,7 @@ export declare namespace Tools {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -21,7 +21,7 @@ export declare class Tools {
     protected _url: Url | undefined;
     protected _file: File_ | undefined;
     protected _contactCard: ContactCard | undefined;
-    constructor(_options: Tools.Options);
+    constructor(_options?: Tools.Options);
     get url(): Url;
     get file(): File_;
     get contactCard(): ContactCard;

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

@@ -5,7 +5,7 @@ import { Url } from "../resources/url/client/Client.mjs";
 import { File_ } from "../resources/file/client/Client.mjs";
 import { ContactCard } from "../resources/contactCard/client/Client.mjs";
 export class Tools {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get url() {

package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts

@@ -9,7 +9,7 @@ export declare namespace ContactCard {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,9 +28,9 @@ export declare namespace ContactCard {
 }
 export declare class ContactCard {
     protected readonly _options: ContactCard.Options;
-    constructor(_options: ContactCard.Options);
+    constructor(_options?: ContactCard.Options);
     /**
-     * Retrieve contact information as a vCard and get a presigned URL to download the file.
+     * Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
      *
      * @param {Pinnacle.tools.GetVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -41,13 +41,13 @@ export declare class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.get({
-     *         id: 33
+     *         id: "cc_1234567890"
      *     })
      */
     get(request: Pinnacle.tools.GetVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VCardData>;
     private __get;
     /**
-     * Create a new contact card or updates an existing one with full vCard data.
+     * Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
      *
      * @param {Pinnacle.tools.UpsertVcardParams} request
      * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -58,7 +58,7 @@ export declare class ContactCard {
      *
      * @example
      *     await client.tools.contactCard.upsert({
-     *         id: 34,
+     *         id: "cc_1234567890",
      *         formattedName: "Jane Smith",
      *         name: {
      *             familyName: "Smith",
@@ -107,6 +107,6 @@ export declare class ContactCard {
     upsert(request?: Pinnacle.tools.UpsertVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VcardResource>;
     private __upsert;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }