rcs-js 2.0.0 → 2.0.1-rc.1

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

@@ -117,7 +117,7 @@ export class Brands {
      *         description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
      *         ein: "88-1234567",
      *         email: "founders@trypinnacle.app",
-     *         id: 1,
+     *         id: "b_1234567890",
      *         name: "Pinnacle",
      *         sector: "TECHNOLOGY",
      *         type: "PRIVATE_PROFIT",
@@ -182,7 +182,8 @@ export class Brands {
     /**
      * Retrieve detailed information for a specific brand in your account by ID.
      *
-     * @param {number} id - ID of an existing brand in your account that you want to retrieve.
+     * @param {string} id - The unique identifier of the brand you want to retrieve from your account.
+     *                      <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
      * @param {Pinnacle.BrandsGetRequest} request
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -192,7 +193,7 @@ export class Brands {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.brands.get(1)
+     *     await client.brands.get("b_1234567890")
      */
     get(id, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(id, request, requestOptions));
@@ -256,9 +257,8 @@ export class Brands {
     /**
      * Submit your brand for review and approval by the compliance team.
      *
-     * @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
-     *
-     *                           Must correspond to an existing brand in your account that is ready for submission.
+     * @param {string} brandId - The unique identifier of the brand you want to submit for review. <br><br>
+     *                           This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -269,7 +269,7 @@ export class Brands {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.brands.submit(1)
+     *     await client.brands.submit("b_1234567890")
      */
     submit(brandId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__submit(brandId, requestOptions));
@@ -416,9 +416,9 @@ export class Brands {
     /**
      * Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
      *
-     * @param {number} brandId - The unique identifier of the brand to vet. <br>
+     * @param {string} brandId - The unique identifier of the brand to vet. <br>
      *
-     *                           The brand must be already registered before it can be vetted.
+     *                           This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
      * @param {Pinnacle.VetBrandParams} request
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -430,7 +430,7 @@ export class Brands {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.brands.vet(1, {})
+     *     await client.brands.vet("b_1234567890", {})
      */
     vet(brandId, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__vet(brandId, request, requestOptions));

package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../index.mjs";
  *         description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
  *         ein: "88-1234567",
  *         email: "founders@trypinnacle.app",
- *         id: 1,
+ *         id: "b_1234567890",
  *         name: "Pinnacle",
  *         sector: "TECHNOLOGY",
  *         type: "PRIVATE_PROFIT",
@@ -36,8 +36,11 @@ export interface UpsertBrandParams {
     ein?: string | null;
     /** Main contact email address for the brand. */
     email?: string | null;
-    /** Brand ID - include only when updating an existing brand, omit to create a new one. */
-    id?: number;
+    /**
+     * The unique identifier of the brand you want to update.
+     * <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
+     */
+    id?: string;
     /** Legal name of the brand as registered. */
     name?: string | null;
     /** Industry the brand operates in. */

package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts

@@ -41,8 +41,8 @@ export declare 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: Pinnacle.AutofillCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.AutofillDlcCampaignResponse>;
@@ -50,7 +50,7 @@ export declare class Dlc {
     /**
      * Retrieve 10DLC campaign.
      *
-     * @param {number} campaignId - Unique identifier of the 10DLC 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}
@@ -59,14 +59,15 @@ export declare class Dlc {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.dlc.get(28)
+     *     await client.campaigns.dlc.get("dlc_1234567890")
      */
-    get(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
+    get(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
     private __get;
     /**
      * Submit your 10DLC campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the 10DLC 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}
@@ -75,9 +76,9 @@ export declare class Dlc {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.campaigns.dlc.submit(161)
+     *     await client.campaigns.dlc.submit("dlc_1234567890")
      */
-    submit(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
+    submit(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
     private __submit;
     /**
      * Create a new 10DLC campaign or updates an existing one. <br>
@@ -95,19 +96,19 @@ export declare 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"]
      *             }
      *         },
@@ -147,7 +148,7 @@ export declare class Dlc {
      * @example
      *     await client.campaigns.dlc.validate({
      *         additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
-     *         campaignId: 161
+     *         campaignId: "dlc_1234567890"
      *     })
      */
     validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;

package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs

@@ -31,8 +31,8 @@ export 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) {
@@ -93,7 +93,7 @@ export class Dlc {
     /**
      * Retrieve 10DLC campaign.
      *
-     * @param {number} campaignId - Unique identifier of the 10DLC 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}
@@ -102,7 +102,7 @@ export 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));
@@ -164,7 +164,8 @@ export class Dlc {
     /**
      * Submit your 10DLC campaign for approval and activation with carriers.
      *
-     * @param {number} campaignId - Unique identifier of the 10DLC 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}
@@ -173,7 +174,7 @@ export 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));
@@ -245,19 +246,19 @@ export 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"]
      *             }
      *         },
@@ -355,7 +356,7 @@ export 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/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts

@@ -6,19 +6,19 @@ import * as Pinnacle from "../../../../../../index.mjs";
  * @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.mjs";
 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/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts

@@ -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,14 +59,14 @@ 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}
@@ -76,9 +76,9 @@ export declare class Rcs {
      * @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>
@@ -115,7 +115,8 @@ export declare class Rcs {
      *                 }]
      *         },
      *         brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
-     *         brand: 2,
+     *         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",
@@ -150,7 +151,7 @@ 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>;

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

@@ -31,8 +31,8 @@ export 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) {
@@ -96,7 +96,7 @@ export 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}
@@ -105,7 +105,7 @@ export 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));
@@ -164,7 +164,7 @@ export 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}
@@ -174,7 +174,7 @@ export class Rcs {
      * @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));
@@ -267,7 +267,8 @@ export class Rcs {
      *                 }]
      *         },
      *         brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
-     *         brand: 2,
+     *         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",
@@ -357,7 +358,7 @@ export 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/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts

@@ -25,7 +25,8 @@ import * as Pinnacle from "../../../../../../index.mjs";
  *                 }]
  *         },
  *         brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
- *         brand: 2,
+ *         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",
@@ -51,9 +52,9 @@ export interface UpsertRcsCampaignParams {
     /** 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. */

package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts

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

package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts

@@ -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,7 +125,7 @@ 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>;

package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs

@@ -31,8 +31,8 @@ export 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) {
@@ -96,7 +96,7 @@ export 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}
@@ -105,7 +105,7 @@ export 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));
@@ -167,7 +167,7 @@ export 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}
@@ -176,7 +176,7 @@ export 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));
@@ -247,8 +247,8 @@ export class TollFree {
      *
      * @example
      *     await client.campaigns.tollFree.upsert({
-     *         brand: 2,
-     *         campaignId: 161,
+     *         brand: "b_1234567890",
+     *         campaignId: "tf_1234567890",
      *         monthlyVolume: "1,000",
      *         name: "Pinnacle",
      *         optIn: {
@@ -256,7 +256,7 @@ export 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"
@@ -336,7 +336,7 @@ export 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/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts

@@ -5,8 +5,8 @@ import * as Pinnacle from "../../../../../../index.mjs";
 /**
  * @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.mjs";
  *             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.mjs";
  *     }
  */
 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;