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

package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Dlc {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -67,8 +67,8 @@ class Dlc {
      *
      * @example
      *     await client.campaigns.dlc.autofill({
-     *         additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
-     *         campaignId: 161
+     *         additionalInfo: "Please autofill missing campaign fields using my brand profile",
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     autofill(request, requestOptions) {
@@ -127,9 +127,9 @@ class Dlc {
         });
     }
     /**
-     * Retrieve DLC campaign.
+     * Retrieve 10DLC campaign.
      *
-     * @param {number} campaignId - Unique identifier of the DLC campaign.
+     * @param {string} campaignId - Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -138,7 +138,7 @@ class Dlc {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.dlc.get(28)
+     *     await client.campaigns.dlc.get("dlc_1234567890")
      */
     get(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
@@ -198,9 +198,10 @@ class Dlc {
         });
     }
     /**
-     * Submit your DLC campaign for approval and activation with carriers.
+     * Submit your 10DLC campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the DLC campaign to submit.
+     * @param {string} campaignId - Unique identifier of the 10DLC campaign to submit.
+     *                              <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
      * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -209,7 +210,7 @@ class Dlc {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.dlc.submit(161)
+     *     await client.campaigns.dlc.submit("dlc_1234567890")
      */
     submit(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
@@ -266,7 +267,7 @@ class Dlc {
         });
     }
     /**
-     * Create a new DLC campaign or updates an existing one. <br>
+     * Create a new 10DLC campaign or updates an existing one. <br>
      *
      * Omit campaignId to create a campaign.
      *
@@ -281,19 +282,19 @@ class Dlc {
      * @example
      *     await client.campaigns.dlc.upsert({
      *         autoRenew: true,
-     *         brand: 1,
-     *         campaignId: 161,
+     *         brand: "b_1234567890",
+     *         campaignId: "dlc_1234567890",
      *         keywords: {
      *             HELP: {
      *                 message: "Reply HELP for assistance, STOP to opt-out",
      *                 values: ["HELP", "INFO", "SUPPORT"]
      *             },
      *             OPT_IN: {
-     *                 message: "Welcome! You're now subscribed to Pinnacle.",
+     *                 message: "Welcome. You are now subscribed to Pinnacle.",
      *                 values: ["JOIN", "START", "SUBSCRIBE"]
      *             },
      *             OPT_OUT: {
-     *                 message: "You've been unsubscribed. Reply START to rejoin.",
+     *                 message: "You have been unsubscribed. Reply START to rejoin.",
      *                 values: ["STOP", "QUIT", "UNSUBSCRIBE"]
      *             }
      *         },
@@ -379,7 +380,7 @@ class Dlc {
         });
     }
     /**
-     * Validate your DLC campaign configuration against carrier requirements and compliance rules.
+     * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
      *
      * @param {Pinnacle.ValidateCampaignParams} request
      * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -391,7 +392,7 @@ class Dlc {
      * @example
      *     await client.campaigns.dlc.validate({
      *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-     *         campaignId: 161
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     validate(request, requestOptions) {

package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts

@@ -6,19 +6,19 @@ import * as Pinnacle from "../../../../../../index.js";
  * @example
  *     {
  *         autoRenew: true,
- *         brand: 1,
- *         campaignId: 161,
+ *         brand: "b_1234567890",
+ *         campaignId: "dlc_1234567890",
  *         keywords: {
  *             HELP: {
  *                 message: "Reply HELP for assistance, STOP to opt-out",
  *                 values: ["HELP", "INFO", "SUPPORT"]
  *             },
  *             OPT_IN: {
- *                 message: "Welcome! You're now subscribed to Pinnacle.",
+ *                 message: "Welcome. You are now subscribed to Pinnacle.",
  *                 values: ["JOIN", "START", "SUBSCRIBE"]
  *             },
  *             OPT_OUT: {
- *                 message: "You've been unsubscribed. Reply START to rejoin.",
+ *                 message: "You have been unsubscribed. Reply START to rejoin.",
  *                 values: ["STOP", "QUIT", "UNSUBSCRIBE"]
  *             }
  *         },
@@ -46,10 +46,10 @@ import * as Pinnacle from "../../../../../../index.js";
 export interface UpsertDlcCampaignParams {
     /** Whether the campaign renews automatically. */
     autoRenew?: boolean;
-    /** Brand id. */
-    brand?: number;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    brand?: string;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
+    campaignId?: string;
     /** Description of the campaign. */
     description?: string;
     /** Keyword response configuration. */

package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Rcs {
         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,7 +28,7 @@ export declare namespace Rcs {
 }
 export declare class Rcs {
     protected readonly _options: Rcs.Options;
-    constructor(_options: Rcs.Options);
+    constructor(_options?: Rcs.Options);
     /**
      * Generate campaign details based off existing campaign and the brand it's connected to.
      *
@@ -41,8 +41,8 @@ export declare class Rcs {
      *
      * @example
      *     await client.campaigns.rcs.autofill({
-     *         additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
-     *         campaignId: 161
+     *         additionalInfo: "Please autofill missing campaign fields using my brand profile",
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.RcsAutofillResponse>;
@@ -50,7 +50,7 @@ export declare class Rcs {
     /**
      * Retrieve RCS campaign.
      *
-     * @param {number} campaignId - Unique identifier of the RCS campaign.
+     * @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -59,25 +59,26 @@ export declare class Rcs {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.rcs.get(161)
+     *     await client.campaigns.rcs.get("rcs_1234567890")
      */
-    get(campaignId: number, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
+    get(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
     private __get;
     /**
      * Submit your RCS campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the RCS campaign to retrieve.
+     * @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.rcs.submit(161)
+     *     await client.campaigns.rcs.submit("rcs_1234567890")
      */
-    submit(campaignId: number, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
+    submit(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
     private __submit;
     /**
      * Create a new RCS campaign or updates an existing one. <br>
@@ -113,7 +114,9 @@ export declare class Rcs {
      *                     url: "https://www.trypinnacle.app/"
      *                 }]
      *         },
-     *         brand: 2,
+     *         brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
+     *         brand: "b_1234567890",
+     *         campaignId: "rcs_1234567890",
      *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
      *         links: {
      *             privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -148,12 +151,12 @@ export declare class Rcs {
      * @example
      *     await client.campaigns.rcs.validate({
      *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-     *         campaignId: 161
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
     private __validate;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Rcs {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -67,8 +67,8 @@ class Rcs {
      *
      * @example
      *     await client.campaigns.rcs.autofill({
-     *         additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
-     *         campaignId: 161
+     *         additionalInfo: "Please autofill missing campaign fields using my brand profile",
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     autofill(request, requestOptions) {
@@ -132,7 +132,7 @@ class Rcs {
     /**
      * Retrieve RCS campaign.
      *
-     * @param {number} campaignId - Unique identifier of the RCS campaign.
+     * @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -141,7 +141,7 @@ class Rcs {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.rcs.get(161)
+     *     await client.campaigns.rcs.get("rcs_1234567890")
      */
     get(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
@@ -200,16 +200,17 @@ class Rcs {
     /**
      * Submit your RCS campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the RCS campaign to retrieve.
+     * @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.rcs.submit(161)
+     *     await client.campaigns.rcs.submit("rcs_1234567890")
      */
     submit(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
@@ -236,6 +237,8 @@ class Rcs {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -299,7 +302,9 @@ class Rcs {
      *                     url: "https://www.trypinnacle.app/"
      *                 }]
      *         },
-     *         brand: 2,
+     *         brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
+     *         brand: "b_1234567890",
+     *         campaignId: "rcs_1234567890",
      *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
      *         links: {
      *             privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -389,7 +394,7 @@ class Rcs {
      * @example
      *     await client.campaigns.rcs.validate({
      *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-     *         campaignId: 161
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     validate(request, requestOptions) {

package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts

@@ -24,7 +24,9 @@ import * as Pinnacle from "../../../../../../index.js";
  *                     url: "https://www.trypinnacle.app/"
  *                 }]
  *         },
- *         brand: 2,
+ *         brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
+ *         brand: "b_1234567890",
+ *         campaignId: "rcs_1234567890",
  *         expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
  *         links: {
  *             privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -47,10 +49,12 @@ import * as Pinnacle from "../../../../../../index.js";
 export interface UpsertRcsCampaignParams {
     /** Create an agent for the campaign. */
     agent?: UpsertRcsCampaignParams.Agent;
+    /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
+    brandVerificationUrl?: string;
     /** Unique identifier for the brand. */
-    brand?: number;
+    brand?: string;
     /** Unique identifier for the campaign. */
-    campaignId?: number;
+    campaignId?: string;
     /** List of what the agent might say to users (1-5 required). */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
@@ -67,8 +71,6 @@ export declare namespace UpsertRcsCampaignParams {
      * Create an agent for the campaign.
      */
     interface Agent {
-        /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
-        brandVerificationUrl?: string;
         /**
          * Color of the agent's buttons. <br>
          *
@@ -79,9 +81,9 @@ export declare namespace UpsertRcsCampaignParams {
         description?: string;
         /** List of emails (1-3 required). */
         emails?: Agent.Emails.Item[];
-        /** Link to the agent's hero. */
+        /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
-        /** Link to the agent's icon. */
+        /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
         iconUrl?: string;
         /** Name of the agent. */
         name?: string;

package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts

@@ -3,5 +3,5 @@
  */
 import * as Pinnacle from "../../../../../index.js";
 export interface RcsAutofillResponse extends Pinnacle.RcsCampaign {
-    brand?: number;
+    brand?: string;
 }

package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace TollFree {
         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,7 +28,7 @@ export declare namespace TollFree {
 }
 export declare class TollFree {
     protected readonly _options: TollFree.Options;
-    constructor(_options: TollFree.Options);
+    constructor(_options?: TollFree.Options);
     /**
      * Generate campaign details based off existing campaign and the brand it's connected to.
      *
@@ -41,8 +41,8 @@ export declare class TollFree {
      *
      * @example
      *     await client.campaigns.tollFree.autofill({
-     *         additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
-     *         campaignId: 161
+     *         additionalInfo: "Please autofill missing campaign fields using my brand profile",
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.TollFreeAutofillResponse>;
@@ -50,7 +50,7 @@ export declare class TollFree {
     /**
      * Retrieve Toll-Free campaign.
      *
-     * @param {number} campaignId - Unique identifier of toll-free campaign.
+     * @param {string} campaignId - Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
      * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class TollFree {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.tollFree.get(161)
+     *     await client.campaigns.tollFree.get("tf_1234567890")
      */
-    get(campaignId: number, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
+    get(campaignId: string, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
     private __get;
     /**
      * Submit your toll-free campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the toll-free campaign to submit.
+     * @param {string} campaignId - Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
      * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -75,9 +75,9 @@ export declare class TollFree {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.tollFree.submit(161)
+     *     await client.campaigns.tollFree.submit("tf_1234567890")
      */
-    submit(campaignId: number, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
+    submit(campaignId: string, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
     private __submit;
     /**
      * Create a new toll-free campaign or updates an existing one.<br>
@@ -94,8 +94,8 @@ export declare class TollFree {
      *
      * @example
      *     await client.campaigns.tollFree.upsert({
-     *         brand: 2,
-     *         campaignId: 161,
+     *         brand: "b_1234567890",
+     *         campaignId: "tf_1234567890",
      *         monthlyVolume: "1,000",
      *         name: "Pinnacle",
      *         optIn: {
@@ -103,7 +103,7 @@ export declare class TollFree {
      *             url: "https://www.pinnacle.sh/",
      *             workflowDescription: "Visit https://www.pinnacle.sh/"
      *         },
-     *         productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
+     *         productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
      *         useCase: {
      *             summary: "Alerts clients about any Pinnacle hosted workshops.",
      *             value: "WORKSHOP_ALERTS"
@@ -125,12 +125,12 @@ export declare class TollFree {
      * @example
      *     await client.campaigns.tollFree.validate({
      *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-     *         campaignId: 161
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
     private __validate;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class TollFree {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -67,8 +67,8 @@ class TollFree {
      *
      * @example
      *     await client.campaigns.tollFree.autofill({
-     *         additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
-     *         campaignId: 161
+     *         additionalInfo: "Please autofill missing campaign fields using my brand profile",
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     autofill(request, requestOptions) {
@@ -132,7 +132,7 @@ class TollFree {
     /**
      * Retrieve Toll-Free campaign.
      *
-     * @param {number} campaignId - Unique identifier of toll-free campaign.
+     * @param {string} campaignId - Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
      * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -141,7 +141,7 @@ class TollFree {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.tollFree.get(161)
+     *     await client.campaigns.tollFree.get("tf_1234567890")
      */
     get(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
@@ -203,7 +203,7 @@ class TollFree {
     /**
      * Submit your toll-free campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the toll-free campaign to submit.
+     * @param {string} campaignId - Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
      * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -212,7 +212,7 @@ class TollFree {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.tollFree.submit(161)
+     *     await client.campaigns.tollFree.submit("tf_1234567890")
      */
     submit(campaignId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
@@ -283,8 +283,8 @@ class TollFree {
      *
      * @example
      *     await client.campaigns.tollFree.upsert({
-     *         brand: 2,
-     *         campaignId: 161,
+     *         brand: "b_1234567890",
+     *         campaignId: "tf_1234567890",
      *         monthlyVolume: "1,000",
      *         name: "Pinnacle",
      *         optIn: {
@@ -292,7 +292,7 @@ class TollFree {
      *             url: "https://www.pinnacle.sh/",
      *             workflowDescription: "Visit https://www.pinnacle.sh/"
      *         },
-     *         productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
+     *         productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
      *         useCase: {
      *             summary: "Alerts clients about any Pinnacle hosted workshops.",
      *             value: "WORKSHOP_ALERTS"
@@ -372,7 +372,7 @@ class TollFree {
      * @example
      *     await client.campaigns.tollFree.validate({
      *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-     *         campaignId: 161
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     validate(request, requestOptions) {

package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts

@@ -5,8 +5,8 @@ import * as Pinnacle from "../../../../../../index.js";
 /**
  * @example
  *     {
- *         brand: 2,
- *         campaignId: 161,
+ *         brand: "b_1234567890",
+ *         campaignId: "tf_1234567890",
  *         monthlyVolume: "1,000",
  *         name: "Pinnacle",
  *         optIn: {
@@ -14,7 +14,7 @@ import * as Pinnacle from "../../../../../../index.js";
  *             url: "https://www.pinnacle.sh/",
  *             workflowDescription: "Visit https://www.pinnacle.sh/"
  *         },
- *         productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
+ *         productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
  *         useCase: {
  *             summary: "Alerts clients about any Pinnacle hosted workshops.",
  *             value: "WORKSHOP_ALERTS"
@@ -22,10 +22,10 @@ import * as Pinnacle from "../../../../../../index.js";
  *     }
  */
 export interface UpsertTollFreeCampaignParams {
-    /** Brand id. */
-    brand?: number;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    brand?: string;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`. */
+    campaignId?: string;
     monthlyVolume?: Pinnacle.MessageVolumeEnum;
     /** Display name of the campaign. */
     name?: string;

package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts

@@ -3,5 +3,5 @@
  */
 import * as Pinnacle from "../../../../../index.js";
 export interface TollFreeAutofillResponse extends Pinnacle.TollFreeCampaign {
-    brand?: number;
+    brand?: string;
 }

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

@@ -9,7 +9,7 @@ export declare namespace Contacts {
         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,7 +28,7 @@ export declare namespace Contacts {
 }
 export declare class Contacts {
     protected readonly _options: Contacts.Options;
-    constructor(_options: Contacts.Options);
+    constructor(_options?: Contacts.Options);
     /**
      * Retrieve contact information for a given number.
      *
@@ -41,7 +41,9 @@ export declare class Contacts {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.contacts.get()
+     *     await client.contacts.get({
+     *         id: "co_1234567890"
+     *     })
      */
     get(request?: Pinnacle.ContactsGetRequest, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.Contact>;
     private __get;
@@ -79,12 +81,12 @@ export declare class Contacts {
      *         email: "alvaroopedtech@pinnacle.sh",
      *         name: "Retired Bestie",
      *         tags: ["friend"],
-     *         id: 137
+     *         id: "co_1234567890"
      *     })
      */
     update(request: Pinnacle.UpdateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.UpdatedContactId>;
     private __update;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }