rcs-js 2.0.6 → 2.0.8

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * 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;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
     /** ISO 8601 formatted timestamp of the last TCR vetting. */
     lastTcrVettingDate: string | null;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 export interface ExtendedRcsCampaign {
     /** Agent configured to the campaign. */
     agent: ExtendedRcsCampaign.Agent;
@@ -9,10 +6,6 @@ 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. 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. */
@@ -20,12 +13,30 @@ export interface ExtendedRcsCampaign {
     /** Legal documentation links. */
     links?: ExtendedRcsCampaign.Links;
     status: Pinnacle.ProfileStatusEnum;
-    /** Opt-in configuration. */
-    optIn?: ExtendedRcsCampaign.OptIn;
-    /** Opt-out configuration. */
-    optOut?: ExtendedRcsCampaign.OptOut;
     /** Use case classification for the campaign. */
     useCase?: ExtendedRcsCampaign.UseCase;
+    /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. */
+    optInTermsAndConditions?: string;
+    messagingType?: Pinnacle.RcsMessagingTypeEnum;
+    /** Description of the agent's purpose, shown to carriers for approval. */
+    carrierDescription?: string;
+    keywords?: ExtendedRcsCampaign.Keywords;
+    traffic?: ExtendedRcsCampaign.Traffic;
+    /** Explanation of how the agent is triggered. This includes how the first message is delivered, whether messages follow a schedule or triggered by user actions, and any external triggers. */
+    agentTriggers?: string;
+    /** Description of all agent interactions. */
+    interactionDescription?: string;
+    /** Whether the agent supports conversational flows or respond to P2A messages from the users. Set to false for one-way messages from agent to user. */
+    isConversational?: boolean;
+    /**
+     * Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. The text should meet the US CTIA requirements and is usually in the following format: <br>
+     *
+     * [Program description of the company sending the messages and what type of messages are being sent]. Msg&data rates may apply. [Message frequency: How frequently messages are sent]. [Privacy statement or link to privacy policy]. [Link to full mobile
+     * T&Cs page].
+     */
+    ctaLanguage?: string;
+    /** Instructions on how an external reviewer can trigger messages and an example flow from the agent. This is usually an inbound text message to the agent that will start a flow of messages between the agent and the user. */
+    demoTrigger?: string;
 }
 export declare namespace ExtendedRcsCampaign {
     /**
@@ -87,29 +98,43 @@ export declare namespace ExtendedRcsCampaign {
         /** Terms of service URL. */
         termsOfService?: string;
     }
-    /**
-     * Opt-in configuration.
-     */
-    interface OptIn {
-        method?: Pinnacle.RcsCampaignOptInMethodEnum;
-        /** Message shown to users explaining what they are agreeing to when opting in. */
-        termsAndConditions?: string;
-    }
-    /**
-     * Opt-out configuration.
-     */
-    interface OptOut {
-        /** Description for the keyword. */
-        description?: string;
-        /** Keywords to opt-out. */
-        keywords?: string[];
-    }
     /**
      * Use case classification for the campaign.
      */
     interface UseCase {
-        /** Summary of the use case. */
+        /** Detailed summary of what the brand is and how this agent will be used. */
         behavior?: string;
         value?: Pinnacle.RcsCampaignUseCaseEnum;
     }
+    interface Keywords {
+        HELP?: Keywords.Help;
+        OPT_IN?: Keywords.OptIn;
+        OPT_OUT?: Keywords.OptOut;
+    }
+    namespace Keywords {
+        interface Help {
+            /** Message sent when a user sends HELP. Must include at least one support contact method (phone, email, or website). */
+            message?: string;
+            /** Keywords that trigger help response. */
+            keywords?: string[];
+        }
+        interface OptIn {
+            /** Message sent when a user opt-in. Must include brand name, confirmation of subscription, and disclosures (STOP and HELP instructions, message and data rates). */
+            message?: string;
+            /** Keywords that trigger opt-in response. */
+            keywords?: string[];
+        }
+        interface OptOut {
+            /** Message sent when a user opt-out. Must include brand name, acknowledge opt-out request and state user will not receive further messages. No marketing or re-engagement attempts. */
+            message?: string;
+            /** Keywords that trigger opt-out response. */
+            keywords?: string[];
+        }
+    }
+    interface Traffic {
+        /** Estimated monthly website visitors. */
+        monthlyWebsite?: number;
+        /** Estimated monthly RCS messages sent. */
+        monthlyRcsEstimate?: number;
+    }
 }

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Parameters for getting a specific conversation.
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface LinkClickEvent {
     /** Accept-Language header value. */
     accept_language?: string | null;

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface LocationShareAction {
     /** Location data shared by the user. */
     data: LocationShareAction.Data;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 export interface Message {
     content: Pinnacle.MessageContent;
     /**

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * Content type of the message.
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * Represents an incoming message or message status update received via webhook.
  */
@@ -39,12 +36,10 @@ export declare namespace MessageEvent {
         /** Recipient's phone number. */
         to: string;
     }
-    /**
-     * Direction of the message flow.
-     */
-    type Direction = "INBOUND" | "OUTBOUND";
+    /** Direction of the message flow. */
     const Direction: {
         readonly Inbound: "INBOUND";
         readonly Outbound: "OUTBOUND";
     };
+    type Direction = (typeof Direction)[keyof typeof Direction];
 }

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * Content of an incoming or outgoing message. Discriminated by the `type` field.
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * MMS message with text and/or media files from a phone number.
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * Button click event data received when a user clicks on an RCS button or quick reply (excluding `requestUserLocation` buttons).
  *

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * RCS message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
  *

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * Location sharing event data received when a user responds to a `requestUserLocation` button and shares their current location.
  *

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * RCS message containing a media file with optional quick reply buttons. <br>
  *

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * RCS message containing longer text content with optional quick reply buttons.
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * SMS message containing plain text only.
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.js";
+import type * as Pinnacle from "../index.js";
 /**
  * Paginated list of messages in a conversation.
  */

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

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

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

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Method used to send the message.
- */
-export type MessageMethodEnum = "API" | "SDK" | "OTHER";
+/** Method used to send the message. */
 export declare const MessageMethodEnum: {
     readonly Api: "API";
     readonly Sdk: "SDK";
     readonly Other: "OTHER";
 };
+export type MessageMethodEnum = (typeof MessageMethodEnum)[keyof typeof MessageMethodEnum];

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

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageMethodEnum = void 0;
+/** Method used to send the message. */
 exports.MessageMethodEnum = {
     Api: "API",
     Sdk: "SDK",

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

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Delivery protocol used for sending this message.
- */
-export type MessageProtocolEnum = "SMS" | "MMS" | "RCS";
+/** Delivery protocol used for sending this message. */
 export declare const MessageProtocolEnum: {
     readonly Sms: "SMS";
     readonly Mms: "MMS";
     readonly Rcs: "RCS";
 };
+export type MessageProtocolEnum = (typeof MessageProtocolEnum)[keyof typeof MessageProtocolEnum];

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

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageProtocolEnum = void 0;
+/** Delivery protocol used for sending this message. */
 exports.MessageProtocolEnum = {
     Sms: "SMS",
     Mms: "MMS",

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

@@ -1,20 +1,37 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Define when and how your message should be sent.
  */
 export interface MessageSchedule {
-    /** Date and time when you want recurring messages to stop in ISO 8601 format. */
-    endDate?: string;
     /**
-     * Provide an AWS cron expression to control the when messages are sent. <br>
+     * The date and time you want your message to be sent.
+     * - Use [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), for example: `2024-12-17T14:30:00Z`. Format: `YYYY-MM-DDThh:mm` (e.g., `2024-12-25T14:30`).
+     * - This time must be at least 5 minutes in the future.
+     * - The message will be scheduled based on the `timezone` you provide.
+     * - If you set a `recurrence` schedule, this is the start date and time for the recurring schedule.
+     */
+    sendAt: string;
+    /**
+     * AWS cron expression for recurring schedules (6 fields). <br>
      *
-     * [Learn more about cron expressions](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).
+     * [Learn more about cron expressions](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html). <br>
+     *
+     * **Examples:**
+     * - `0 10 * * ? *` - Every day at 10:00 AM
+     * - `0/30 * * * ? *` - Every 30 minutes
+     * - `0 9 ? * MON-FRI *` - Every weekday at 9:00 AM
+     * - `0 12 1 * ? *` - First day of every month at noon
      */
     recurrence?: string;
-    /** Date and time when you want to send your message in ISO 8601 format. */
-    sendAt: string;
-    /** Timezone for your scheduled message, using an IANA identifier. */
-    timezone: string;
+    /**
+     * IANA timezone identifier (e.g., `America/New_York`, `UTC`). <br>
+     *
+     * Defaults to `UTC` if not specified.
+     */
+    timezone?: string;
+    /**
+     * Date and time when recurring messages should stop. <br>
+     *
+     * Format: `YYYY-MM-DDThh:mm`. Required if `recurrence` is set.
+     */
+    endDate?: string;
 }

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

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

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

@@ -1,11 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Current status of the message.
- */
-export type MessageStatusEnum = "PENDING" | "SENT" | "SEND_FAILED" | "DELIVERED" | "DELIVERY_FAILED" | "RECEIVED" | "READ";
+/** Current status of the message. */
 export declare const MessageStatusEnum: {
+    readonly Queued: "QUEUED";
     readonly Pending: "PENDING";
     readonly Sent: "SENT";
     readonly SendFailed: "SEND_FAILED";
@@ -14,3 +9,4 @@ export declare const MessageStatusEnum: {
     readonly Received: "RECEIVED";
     readonly Read: "READ";
 };
+export type MessageStatusEnum = (typeof MessageStatusEnum)[keyof typeof MessageStatusEnum];

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

@@ -1,10 +1,10 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageStatusEnum = void 0;
+/** Current status of the message. */
 exports.MessageStatusEnum = {
+    Queued: "QUEUED",
     Pending: "PENDING",
     Sent: "SENT",
     SendFailed: "SEND_FAILED",

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

@@ -1,10 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Message volume.
- */
-export type MessageVolumeEnum = "10" | "100" | "1,000" | "10,000" | "100,000" | "250,000" | "500,000" | "750,000" | "1,000,000" | "5,000,000" | "10,000,000+";
+/** Message volume. */
 export declare const MessageVolumeEnum: {
     readonly Ten: "10";
     readonly OneHundred: "100";
@@ -18,3 +12,4 @@ export declare const MessageVolumeEnum: {
     readonly Five000000: "5,000,000";
     readonly Ten000000: "10,000,000+";
 };
+export type MessageVolumeEnum = (typeof MessageVolumeEnum)[keyof typeof MessageVolumeEnum];

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

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageVolumeEnum = void 0;
+/** Message volume. */
 exports.MessageVolumeEnum = {
     Ten: "10",
     OneHundred: "100",