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

package/dist/esm/api/types/Conversation.d.mts

@@ -6,16 +6,16 @@ import * as Pinnacle from "../index.mjs";
  * Conversation that was found.
  */
 export interface Conversation {
-    /** Identifier for the brand associated with this conversation. */
-    brandId?: number | null;
-    /** Campaign information if this conversation is part of a marketing campaign. */
-    campaign?: Pinnacle.CampaignQuery | null;
+    /** The unique identifier of the brand associated with this conversation. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
+    brandId: string | null;
+    /** Campaign information if this conversation is part of a marketing campaign. This is an object that contains the campaign ID and type. */
+    campaign: Pinnacle.CampaignQuery | null;
     /** Contact information for the recipient in a conversation. */
     contact: Conversation.Contact;
     /** ISO 8601 timestamp when the conversation was created. */
     createdAt: string;
-    /** Unique identifier for the conversation. */
-    id: number;
+    /** Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. */
+    id: string;
     /** Free-form notes or comments about the conversation. */
     notes: string;
     /**
@@ -24,7 +24,7 @@ export interface Conversation {
      * - An RCS agent with ID and name
      * - `null` if no sender is associated
      */
-    sender?: Conversation.Sender | null;
+    sender: Conversation.Sender | null;
     /** ISO 8601 timestamp when the conversation was last updated. */
     updatedAt: string;
 }
@@ -33,8 +33,8 @@ export declare namespace Conversation {
      * Contact information for the recipient in a conversation.
      */
     interface Contact {
-        /** Unique identifier for the contact. */
-        id: number;
+        /** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
+        id: string;
         /** The contact's phone number in E.164 format. */
         phoneNumber: string;
     }

package/dist/esm/api/types/CreateUrlOptions.d.mts

@@ -5,7 +5,7 @@ export interface CreateUrlOptions {
     /**
      * Expiration date in ISO 8601 format for the shortened URL. <br>
      *
-     * If omitted, then a permalink is generated instead.
+     * If omitted, then a permalink is generated instead. Short permalinks contain a 30-digit link id. Short links with an expiration date contain a 8-digit link id.
      */
     expiresAt?: string | null;
 }

package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts

@@ -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/esm/api/types/DetachedWebhookInfo.d.mts

@@ -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/esm/api/types/DlcCampaignStatus.d.mts

@@ -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>
      *
@@ -24,7 +24,7 @@ export interface DlcCampaignStatus {
      */
     status: Pinnacle.ProfileStatusEnum;
     /**
-     * Status of toll free numbers that are being attached to this campaign. <br>
+     * Status of local long code numbers that are being attached to this campaign. <br>
      *
      * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
      */
@@ -32,7 +32,7 @@ export interface DlcCampaignStatus {
 }
 export declare namespace DlcCampaignStatus {
     /**
-     * Status of toll free numbers that are being attached to this campaign. <br>
+     * Status of local long code numbers that are being attached to this campaign. <br>
      *
      * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
      */

package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts

@@ -10,12 +10,12 @@ 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. */
-    keywords?: DlcCampaignWithExtendedBrandAndStatus.Keywords;
+    keywords: DlcCampaignWithExtendedBrandAndStatus.Keywords;
     /** Legal documentation links. */
     links?: DlcCampaignWithExtendedBrandAndStatus.Links;
     /** Describe the flow of how users will opt in to this campaign. */
@@ -23,16 +23,19 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     /** Display name of the campaign. */
     name?: string;
     /** Campaign configuration options. */
-    options?: DlcCampaignWithExtendedBrandAndStatus.Options;
+    options: DlcCampaignWithExtendedBrandAndStatus.Options;
     /** Example messages for the campaign. */
     sampleMessages?: string[];
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the campaign. <br>
      *
-     * `INCOMPLETE`: Not submitted.<br>
-     * `IN REVIEW`: Being reviewed by carriers.<br>
-     * `VERIFIED`: Approved and ready to send messages.<br>
-     * `FAILED`: Issues and errors related to the campaign's details.<br>
+     * `INCOMPLETE`: Not submitted. <br>
+     *
+     * `IN REVIEW`: Being reviewed by carriers. <br>
+     *
+     * `VERIFIED`: Approved and ready to send messages. <br>
+     *
+     * `FAILED`: Issues and errors related to the campaign's details.
      */
     status: Pinnacle.ProfileStatusEnum;
     /** Use case for the campaign. */
@@ -58,14 +61,14 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
             /** Response message for help keywords. */
             message?: string;
             /** Keywords that trigger help response. */
-            values?: string[];
+            values: string[];
         }
         /**
          * Opt-in keyword settings.
          */
         interface OptIn {
             /** Response message for opt-in keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-in. */
             values: string[];
         }
@@ -74,7 +77,7 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
          */
         interface OptOut {
             /** Response message for opt-out keywords. */
-            message: string;
+            message?: string;
             /** Keywords that trigger opt-out. */
             values: string[];
         }

package/dist/esm/api/types/EnhancedContactItem.d.mts

@@ -18,7 +18,7 @@ export interface EnhancedContactItem {
      * LinkedIn profile URL if available and publicly accessible.
      * Null if no LinkedIn profile is found or accessible.
      */
-    linkedin?: string | null;
+    linkedin: string | null;
     /** Full name of the contact person associated with this profile. */
     name: string;
 }

package/dist/esm/api/types/ExtendedBrand.d.mts

@@ -5,17 +5,24 @@ import * as Pinnacle from "../index.mjs";
 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;
     /**
-     * Current review status of the campaign.<br>
+     * Current review status of the brand. <br>
      *
-     * `INCOMPLETE`: Not submitted.<br>
-     * `IN REVIEW`: Being reviewed by carriers.<br>
-     * `VERIFIED`: Approved and ready to send messages.<br>
-     * `FAILED`: Issues and errors related to the campaign's details.
+     * `INCOMPLETE`: Not submitted. <br>
+     *
+     * `IN REVIEW`: Being reviewed by carriers. <br>
+     *
+     * `VERIFIED`: Approved and ready to send messages. <br>
+     *
+     * `FAILED`: Issues and errors related to the campaign's details. <br>
+     *
+     * `VETTED`: Has undergone additional vetting by a third party service post the brand being verified. Your brand will be assigned a trust score, with higher trust scores having higher message volumes. <br>
+     *
+     * `UNVERIFIED`: Brand details have been updated, and the brand will need to undergo re-verification.
      */
     status: Pinnacle.BrandStatusEnum;
     /** ISO 8601 formatted timestamp of when this brand was last updated. */

package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts

@@ -4,9 +4,9 @@
 import * as Pinnacle from "../index.mjs";
 export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
     /** ISO 8601 formatted timestamp of the last TCR vetting. */
-    lastTcrVettingDate?: string | null;
+    lastTcrVettingDate: string | null;
     /** Feedback from The Campaign Registry if TCR vetting was performed. */
-    tcrFeedback?: Pinnacle.VettingFeedback[] | null;
+    tcrFeedback: Pinnacle.VettingFeedback[] | null;
     /** History of all external vetting attempts for this brand. */
     vettingHistory: Pinnacle.VettingHistory[];
 }

package/dist/esm/api/types/ExtendedRcsCampaign.d.mts

@@ -9,20 +9,23 @@ export interface ExtendedRcsCampaign {
     agentId: string;
     /** Brand associated with this campaign. */
     brand: Pinnacle.ExtendedBrand;
+    /** 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;
     /** 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. */
-    links: ExtendedRcsCampaign.Links;
+    links?: ExtendedRcsCampaign.Links;
+    status: Pinnacle.ProfileStatusEnum;
     /** Opt-in configuration. */
-    optIn: ExtendedRcsCampaign.OptIn;
+    optIn?: ExtendedRcsCampaign.OptIn;
     /** Opt-out configuration. */
-    optOut: ExtendedRcsCampaign.OptOut;
+    optOut?: ExtendedRcsCampaign.OptOut;
     /** Use case classification for the campaign. */
-    useCase: ExtendedRcsCampaign.UseCase;
+    useCase?: ExtendedRcsCampaign.UseCase;
 }
 export declare namespace ExtendedRcsCampaign {
     /**
@@ -34,19 +37,17 @@ export declare namespace ExtendedRcsCampaign {
         /** Description of the agent. */
         description?: string;
         /** List of emails. */
-        emails?: Agent.Emails.Item[];
-        /** 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;
-        /** Link to the agent's hero. */
+        emails: Agent.Emails.Item[];
+        /** 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;
         /** List of phone numbers. */
-        phones?: Agent.Phones.Item[];
+        phones: Agent.Phones.Item[];
         /** List of urls. */
-        websites?: Agent.Websites.Item[];
+        websites: Agent.Websites.Item[];
     }
     namespace Agent {
         type Emails = Emails.Item[];

package/dist/esm/api/types/GetConversationParams.d.mts

@@ -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/esm/api/types/LinkClickEvent.d.mts

@@ -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/esm/api/types/Message.d.mts

@@ -9,21 +9,21 @@ export interface Message {
      *
      * Null means the message incurred no cost or has not been charged yet.
      */
-    cost?: number | null;
+    cost: number | null;
     /**
      * Timestamp indicating when the message was successfully delivered to the recipient. <br>
      *
      * Null indicates the message has not yet been delivered.
      */
-    deliveredAt?: string | null;
+    deliveredAt: string | null;
     /**
      * Detailed explanation of any errors that occurred while delivering the message. <br>
      *
      * Null indicates no errors.
      */
-    error?: string | null;
-    /** Unique identifier of the message. */
-    id: number;
+    error: string | null;
+    /** 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;
@@ -36,7 +36,7 @@ export interface Message {
      *
      * Null indicates the message is still in the queue.
      */
-    sentAt?: string | null;
+    sentAt: string | null;
     status: Pinnacle.MessageStatusEnum;
     type: Pinnacle.MessageProtocolEnum;
 }

package/dist/esm/api/types/MessageContent.d.mts

@@ -18,5 +18,5 @@ Pinnacle.SmsContent
  * Message that contains richer content (longer text, higher quality media, cards, buttons, and quick replies) from an RCS agent. */
  | Pinnacle.RcsContent
 /**
- * Message that represents when a user clicks on a RCS button or quick reply that was previously sent. */
- | Pinnacle.InboundButton;
+ * Message that represents when a user clicks on a RCS button or quick reply. */
+ | Pinnacle.ButtonClicked;

package/dist/esm/api/types/MessageEvent.d.mts

@@ -0,0 +1,62 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Represents an incoming message or message status update received via webhook.
+ */
+export interface MessageEvent {
+    /** Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages. */
+    type: Pinnacle.WebhookEventEnum;
+    /** Conversation metadata containing the conversation ID, sender, and recipient information. */
+    conversation: MessageEvent.Conversation;
+    status: Pinnacle.MessageStatusEnum;
+    /** Direction of the message flow. */
+    direction: MessageEvent.Direction;
+    /** Number of segments for this message. */
+    segments: number;
+    /** Timestamp when the message was sent in ISO 8601 format. */
+    sentAt: string;
+    /**
+     * Timestamp when the message was delivered in ISO 8601 format.
+     * Null if not yet delivered or for inbound messages.
+     */
+    deliveredAt?: string | null;
+    /** Message details including ID and content. */
+    message: MessageEvent.Message;
+}
+export declare namespace MessageEvent {
+    /**
+     * Conversation metadata containing the conversation ID, sender, and recipient information.
+     */
+    interface Conversation {
+        /**
+         * 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. */
+        to: string;
+    }
+    /**
+     * Direction of the message flow.
+     */
+    type Direction = "INBOUND" | "OUTBOUND";
+    const Direction: {
+        readonly Inbound: "INBOUND";
+        readonly Outbound: "OUTBOUND";
+    };
+    /**
+     * Message details including ID and content.
+     */
+    interface Message {
+        /**
+         * 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/esm/api/types/MessageEvent.mjs

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var MessageEvent;
+(function (MessageEvent) {
+    MessageEvent.Direction = {
+        Inbound: "INBOUND",
+        Outbound: "OUTBOUND",
+    };
+})(MessageEvent || (MessageEvent = {}));

package/dist/esm/api/types/MessageList.d.mts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * 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/esm/api/types/MessageList.mjs

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

package/dist/esm/api/types/MessageWithReaction.d.mts

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * 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/esm/api/types/MessageWithReaction.mjs

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var MessageWithReaction;
+(function (MessageWithReaction) {
+    MessageWithReaction.Direction = {
+        Inbound: "INBOUND",
+        Outbound: "OUTBOUND",
+    };
+})(MessageWithReaction || (MessageWithReaction = {}));

package/dist/esm/api/types/NotFoundErrorBody.d.mts

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

package/dist/esm/api/types/NotFoundErrorBody.mjs

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

package/dist/esm/api/types/ProfileStatusEnum.d.mts

@@ -2,11 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Current review status of the campaign.
+ * Current review status of the campaign. <br>
+ *
+ * `INCOMPLETE`: Not submitted. <br>
+ *
+ * `IN REVIEW`: Being reviewed by carriers. <br>
+ *
+ * `VERIFIED`: Approved and ready to send messages.<br>
  *
- * `INCOMPLETE`: Not submitted.
- * `IN REVIEW`: Being reviewed by carriers.
- * `VERIFIED`: Approved and ready to send messages.
  * `FAILED`: Issues and errors related to the campaign's details.
  */
 export type ProfileStatusEnum = "INCOMPLETE" | "IN REVIEW" | "VERIFIED" | "FAILED";

package/dist/esm/api/types/RcsBase.d.mts

@@ -19,6 +19,8 @@ export declare namespace RcsBase {
         /** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
         test_mode?: boolean;
         tracking?: Pinnacle.Tracking;
+        /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
+        transcode?: boolean;
         /**
          * Validate your message for any unsupported files. <br>
          *

package/dist/esm/api/types/RcsButtonCall.d.mts

@@ -5,6 +5,8 @@
  * Button that initiates a phone call when tapped by the recipient.
  */
 export interface RcsButtonCall {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Phone number to call in E.164 format */
     payload: string;
     /** Display text for the button. */

package/dist/esm/api/types/RcsButtonOpenUrl.d.mts

@@ -5,6 +5,8 @@
  * Button that opens a URL when tapped by the recipient.
  */
 export interface RcsButtonOpenUrl {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL. */
     payload: string;
     /** Display text for the button. */

package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts

@@ -5,6 +5,8 @@
  * Button that prompts the recipient to share their current location.
  */
 export interface RcsButtonRequestUserLocation {
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }

package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts

@@ -13,6 +13,8 @@ export interface RcsButtonScheduleEvent {
     eventStartTime: string;
     /** Title of the event. */
     eventTitle: string;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }

package/dist/esm/api/types/RcsButtonSendLocation.d.mts

@@ -7,6 +7,8 @@
 export interface RcsButtonSendLocation {
     /** Geographic coordinates of the location to share. */
     latLong: RcsButtonSendLocation.LatLong;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Display text for the button. */
     title: string;
 }

package/dist/esm/api/types/RcsButtonTrigger.d.mts

@@ -5,8 +5,8 @@
  * Button that sends custom data back to your application when tapped by the recipient.
  */
 export interface RcsButtonTrigger {
-    /** Additional data attached to the button interaction. */
-    metadata: string;
+    /** Optional additional data to attach to this button. */
+    metadata?: string;
     /** Custom data sent to your webhook when the button is tapped. Use this to identify the user's choice. */
     payload: string;
     /** Display text for the button. */

package/dist/esm/api/types/RcsCampaign.d.mts

@@ -6,7 +6,9 @@ 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. */
     expectedAgentResponses?: string[];
     /** Legal documentation links. */
@@ -25,8 +27,6 @@ export declare namespace RcsCampaign {
     interface Agent {
         /** Name of the agent. */
         name?: 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;
         /** Description of the agent. */
         description?: string;
         /** Color of the agent's buttons. */
@@ -37,9 +37,9 @@ export declare namespace RcsCampaign {
         phones?: Agent.Phones.Item[];
         /** List of urls. */
         websites?: Agent.Websites.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;
     }
     namespace Agent {