rcs-js 2.0.0 → 2.0.1-rc.1

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

@@ -22,8 +22,8 @@ export declare namespace DetachedPhoneNumberResult {
              * Campaign that the phone is now detached from.
              */
             interface Campaign {
-                /** Id of the campaign. */
-                id: number;
+                /** Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with the prefix `dlc_`, for example: `dlc_1234567890`. */
+                id: string;
                 /** Campaign's name. */
                 name: string;
                 type: Pinnacle.MessagingProfileEnum;

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

@@ -4,8 +4,8 @@
 export interface DetachedWebhookInfo {
     /** Confirmation message. */
     message: string;
-    /** ID of the detached webhook. */
-    webhookId: number;
+    /** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
+    webhookId: string;
     /** Phone number the webhook was detached from in E.164 format. */
     phoneNumber: string;
 }

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

@@ -12,8 +12,8 @@ export interface DlcCampaignStatus {
      * These errors may request additional information or point out erroneous and/or missing fields.
      */
     error: string;
-    /** Id of the DLC campaign. */
-    id: number;
+    /** The unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
+    id: string;
     /**
      * Current review status of the DLC campaign. <br>
      *

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

@@ -10,8 +10,8 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     autoRenew: boolean;
     /** Brand associated with this campaign. */
     brand: Pinnacle.ExtendedBrand;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** 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/types/ExtendedBrand.d.ts

@@ -5,8 +5,8 @@ import * as Pinnacle from "../index.js";
 export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
     /** ISO 8601 formatted timestamp of when this brand was added to our system. */
     createdAt: string;
-    /** The brand's ID. */
-    id: number;
+    /** The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    id: string;
     /** Indicates if this brand is archived. */
     isArchived: boolean;
     /**

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

@@ -13,8 +13,8 @@ export interface ExtendedRcsCampaign {
     brandVerificationUrl?: string;
     /** Indicates whether the brand has provided an attestation. */
     brandAttestation: boolean;
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`. */
+    campaignId?: string;
     /** List of what the agent might say to users. */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */

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

@@ -8,7 +8,7 @@ export type GetConversationParams =
 /**
  * Retrieve conversation information by ID. */
 {
-    id: number;
+    id: string;
 }
 /**
  * Retrieve conversation information by sender and recipient. */

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

@@ -36,8 +36,6 @@ export interface LinkClickEvent {
     fingerprint_id?: string | null;
     /** Google Click Identifier. */
     gclid?: string | null;
-    /** Unique identifier for the click event. */
-    id: number;
     /** IP address of the visitor (may be anonymized). */
     ip_address?: string | null;
     /** Chain of IP addresses for proxied requests. */
@@ -48,8 +46,6 @@ export interface LinkClickEvent {
     latency_ms?: number | null;
     /** Geographic latitude. */
     latitude?: number | null;
-    /** ID of your shortened URL. */
-    link_id: number;
     /** Geographic longitude. */
     longitude?: number | null;
     /** Additional metadata as JSON object. */

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

@@ -22,8 +22,8 @@ export interface Message {
      * Null indicates no errors.
      */
     error: string | null;
-    /** Unique identifier of the message. */
-    id: number;
+    /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    id: string;
     method: Pinnacle.MessageMethodEnum;
     /** Number of segments the message was split into for delivery. */
     numSegments: number;

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

@@ -30,8 +30,11 @@ export declare namespace MessageEvent {
      * Conversation metadata containing the conversation ID, sender, and recipient information.
      */
     interface Conversation {
-        /** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
-        id: number;
+        /**
+         * Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
+         * To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint.
+         */
+        id: string;
         /** Sender's phone number or agent ID. */
         from: string;
         /** Recipient's phone number. */
@@ -49,8 +52,11 @@ export declare namespace MessageEvent {
      * Message details including ID and content.
      */
     interface Message {
-        /** Unique identifier of the message. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
-        id: number;
+        /**
+         * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+         * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
+         */
+        id: string;
         content: Pinnacle.MessageContent;
     }
 }

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Paginated list of messages in a conversation.
+ */
+export interface MessageList {
+    /** Array of messages in the conversation. */
+    messages: Pinnacle.MessageWithReaction[];
+    /** Indicates if more messages are available beyond the current page. */
+    hasMore: boolean;
+    /** Total number of messages in the conversation. */
+    count: number;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Message with additional conversation-specific fields including direction and reaction.
+ */
+export interface MessageWithReaction extends Pinnacle.Message {
+    /** Direction of the message flow. */
+    direction: MessageWithReaction.Direction;
+    /**
+     * Unicode emoji reaction attached to this message. <br>
+     *
+     * Null indicates no reaction has been added.
+     */
+    reaction: string | null;
+}
+export declare namespace MessageWithReaction {
+    /**
+     * Direction of the message flow.
+     */
+    type Direction = "INBOUND" | "OUTBOUND";
+    const Direction: {
+        readonly Inbound: "INBOUND";
+        readonly Outbound: "OUTBOUND";
+    };
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageWithReaction = void 0;
+var MessageWithReaction;
+(function (MessageWithReaction) {
+    MessageWithReaction.Direction = {
+        Inbound: "INBOUND",
+        Outbound: "OUTBOUND",
+    };
+})(MessageWithReaction || (exports.MessageWithReaction = MessageWithReaction = {}));

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface NotFoundErrorBody {
+    error?: string;
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -6,7 +6,7 @@ export interface RcsCampaign {
     /** Agent configured to the campaign. */
     agent?: RcsCampaign.Agent;
     /** Unique identifier for the campaign. */
-    campaignId?: number;
+    campaignId?: string;
     /** 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;
     /** List of what the agent might say to users. */

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

@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.js";
 export interface RcsCampaignStatus {
     /** List of errors that occured. */
     errors: string[];
-    /** Id of the RCS campaign. */
-    id: number;
+    /** The unique identifier of the RCS campaign. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`. */
+    id: string;
     /**
      * Current review status of the RCS campaign. <br>
      *

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ReactionResult {
-    /** ID of the message. */
-    messageId: number;
-    /** Unique identifier for the reaction. */
-    reactionMessageId: number;
+    /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
+    /** Unique identifier of the message with the reaction. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    reactionMessageId: string;
 }

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ScheduledMessaage {
-    /** Unique identifier for the scheduled send. */
-    scheduleId: number;
+    /** Unique identifier for the scheduled send. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`. */
+    scheduleId: string;
     /** Configuration for the scheduled message. */
     config: ScheduledMessaage.Config;
 }

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentMmsDetails {
-    /** Array of unique identifiers for the sent MMS messages. */
-    messageIds: number[];
+    /** Array of unique identifiers for the sent MMS messages. This identifiers are strings that always begin with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageIds: string[];
     /** Total number of segments used across the message. */
     segments: number;
     /** Total cost of sending the message. */

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentRcsDetails {
-    /** Unique identifier for the sent MMS messages. */
-    messageIds?: number;
+    /** Unique identifier for the sent RCS message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
     /** Total number of segments used across the message. */
     segments: number;
     /** Total cost of sending the message. */

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentSmsDetails {
-    /** Unique identifier for the sent message. */
-    messageId: number;
+    /** Unique identifier for the sent message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
     /** Details about how the message was segmented for sending. */
     segments: SentSmsDetails.Segments;
     /** Total cost of sending the message. */

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

@@ -3,8 +3,8 @@
  */
 import * as Pinnacle from "../index.js";
 export interface TollFreeCampaign {
-    /** Unique identifier for the campaign. */
-    campaignId?: number;
+    /** Unique identifier for the campaign. Must begin with the prefix `tf_`. */
+    campaignId?: string;
     monthlyVolume?: Pinnacle.MessageVolumeEnum;
     /** Display name of the campaign. */
     name?: string;

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

@@ -12,8 +12,8 @@ export interface TollFreeCampaignStatus {
      * These errors may request additional information or point out erroneous and/or missing fields.
      */
     error?: string;
-    /** Id of the toll-free campaign. */
-    id: number;
+    /** The unique identifier of the toll-free campaign. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`. */
+    id: string;
     /**
      * Status of phone numbers that are being attached to this campaign. <br>
      *

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

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface UpdatedContactId {
-    /** Unique ID of the updated contact. */
-    id: number;
+    /** Unique ID of the updated contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+    id: string;
 }

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Represents an event triggered by a user such as when they start typing.
+ */
+export interface UserEvent {
+    /** Type of user event. */
+    type: "USER.TYPING";
+    /** Timestamp when the user event started in ISO 8601 format. */
+    startedAt: string;
+    /** Conversation metadata containing the conversation ID, sender, and recipient information. */
+    conversation: UserEvent.Conversation;
+}
+export declare namespace UserEvent {
+    /**
+     * Conversation metadata containing the conversation ID, sender, and recipient information.
+     */
+    interface Conversation {
+        /** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
+        id: number;
+        /** Phone number of the user who triggered the event. */
+        from: string;
+        /** Agent ID that the user is interacting with. */
+        to: string;
+    }
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -4,6 +4,11 @@
 export interface ValidateCampaignParams {
     /** Any additional information you want to provide. */
     additionalInfo?: string;
-    /** Campaign ID. */
-    campaignId: number;
+    /**
+     * Unique identifier for the campaign.
+     * - When validating 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`)
+     * - When validating toll-free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`)
+     * - When validating RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)
+     */
+    campaignId: string;
 }

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

@@ -3,8 +3,8 @@
  */
 import * as Pinnacle from "../index.js";
 export interface Vcard {
-    /** Unique identifier for the contact. */
-    id?: number;
+    /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
+    id?: string;
     /** Full display name for the vCard. */
     formattedName?: string;
     /** Structured name components. */

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

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface VcardResource {
-    /** Contact's id */
-    id?: number;
+    /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
+    id?: string;
     /**
      * Presigned download url to download vCard data. <br>
      *

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

@@ -7,8 +7,8 @@
 export interface Webhooks {
     /** URL where webhook events are delivered. */
     endpoint: string;
-    /** Unique identifier for the webhook. */
-    id: number;
+    /** The unique identifier of the webhook. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
+    id: string;
     /** Name of the webhook. */
     name: string;
 }

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

@@ -1,4 +1,5 @@
 export * from "./BadRequestErrorBody.js";
+export * from "./NotFoundErrorBody.js";
 export * from "./OptionalContacts.js";
 export * from "./CompanySectorEnum.js";
 export * from "./CompanyTypeEnum.js";
@@ -67,6 +68,8 @@ export * from "./MessageMethodEnum.js";
 export * from "./MessageStatusEnum.js";
 export * from "./MessageProtocolEnum.js";
 export * from "./Message.js";
+export * from "./MessageWithReaction.js";
+export * from "./MessageList.js";
 export * from "./ReactionResult.js";
 export * from "./MessageSchedule.js";
 export * from "./Tracking.js";
@@ -130,3 +133,4 @@ export * from "./VcardResource.js";
 export * from "./Webhooks.js";
 export * from "./WebhookResult.js";
 export * from "./MessageEvent.js";
+export * from "./UserEvent.js";

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

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestErrorBody.js"), exports);
+__exportStar(require("./NotFoundErrorBody.js"), exports);
 __exportStar(require("./OptionalContacts.js"), exports);
 __exportStar(require("./CompanySectorEnum.js"), exports);
 __exportStar(require("./CompanyTypeEnum.js"), exports);
@@ -83,6 +84,8 @@ __exportStar(require("./MessageMethodEnum.js"), exports);
 __exportStar(require("./MessageStatusEnum.js"), exports);
 __exportStar(require("./MessageProtocolEnum.js"), exports);
 __exportStar(require("./Message.js"), exports);
+__exportStar(require("./MessageWithReaction.js"), exports);
+__exportStar(require("./MessageList.js"), exports);
 __exportStar(require("./ReactionResult.js"), exports);
 __exportStar(require("./MessageSchedule.js"), exports);
 __exportStar(require("./Tracking.js"), exports);
@@ -146,3 +149,4 @@ __exportStar(require("./VcardResource.js"), exports);
 __exportStar(require("./Webhooks.js"), exports);
 __exportStar(require("./WebhookResult.js"), exports);
 __exportStar(require("./MessageEvent.js"), exports);
+__exportStar(require("./UserEvent.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.0";
+export declare const SDK_VERSION = "2.0.2";

package/dist/cjs/version.js

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

package/dist/cjs/wrapper/messages/Client.d.ts

@@ -8,6 +8,6 @@ interface ExpressLikeRequest {
     originalUrl?: string;
 }
 export declare class EnhancedMessages extends Messages {
-    process(req: Request | ExpressLikeRequest, secret?: string): Promise<Pinnacle.MessageEvent>;
+    process(req: Request | ExpressLikeRequest, secret?: string): Promise<Pinnacle.MessageEvent | Pinnacle.UserEvent>;
 }
 export {};

package/dist/esm/Client.mjs

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

package/dist/esm/api/errors/NotFoundError.d.mts

@@ -2,8 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index.mjs";
-import * as Pinnacle from "../index.mjs";
 import * as core from "../../core/index.mjs";
 export declare class NotFoundError extends errors.PinnacleError {
-    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
 }

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

@@ -74,7 +74,7 @@ export declare 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",
@@ -86,7 +86,8 @@ export declare 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.
      *
@@ -96,16 +97,15 @@ export declare class Brands {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.brands.get(1)
+     *     await client.brands.get("b_1234567890")
      */
-    get(id: number, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
+    get(id: string, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
     private __get;
     /**
      * 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}
@@ -116,9 +116,9 @@ export declare class Brands {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.brands.submit(1)
+     *     await client.brands.submit("b_1234567890")
      */
-    submit(brandId: number, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
+    submit(brandId: string, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
     private __submit;
     /**
      * Validate your brand information for compliance and correctness before submission or storage.
@@ -154,9 +154,9 @@ export declare 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.
      *
@@ -168,9 +168,9 @@ export declare class Brands {
      * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.brands.vet(1, {})
+     *     await client.brands.vet("b_1234567890", {})
      */
-    vet(brandId: number, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
+    vet(brandId: string, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
     private __vet;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "PINNACLE-API-KEY": string | undefined;