rcs-js 2.0.0 → 2.0.1-rc.1

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

@@ -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/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/RcsCampaign.d.mts

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

@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.mjs";
 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/esm/api/types/ReactionResult.d.mts

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

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

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

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

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

@@ -3,8 +3,8 @@
  */
 import * as Pinnacle from "../index.mjs";
 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/esm/api/types/TollFreeCampaignStatus.d.mts

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

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

@@ -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/esm/api/types/UserEvent.mjs

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

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

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

@@ -3,8 +3,8 @@
  */
 import * as Pinnacle from "../index.mjs";
 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/esm/api/types/VcardResource.d.mts

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

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

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

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

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

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/dist/esm/wrapper/messages/Client.d.mts

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.0",
+    "version": "2.0.1-rc.1",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",
@@ -66,4 +66,4 @@
         "node": ">=18.0.0"
     },
     "sideEffects": false
-}
+}