rcs-js 1.0.22 → 2.0.0-rc.2

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export type Rcs = 
+/**
+ * Send a text RCS message with optional quick reply buttons. */
+Pinnacle.RcsText
+/**
+ * Send a media RCS message with optional quick reply buttons. */
+ | Pinnacle.RcsMedia
+/**
+ * Send a cards RCS message with optional quick reply buttons. */
+ | Pinnacle.RcsCard;

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

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

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

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface RcsBase {
+    /** Your RCS agent ID which must be prefixed with 'agent_'. */
+    from: string;
+    /** Configure how your RCS message is sent and tracked. */
+    options?: RcsBase.Options;
+    /** Recipient's phone number in E.164 format. */
+    to: string;
+}
+export declare namespace RcsBase {
+    /**
+     * Configure how your RCS message is sent and tracked.
+     */
+    interface Options {
+        schedule?: Pinnacle.MessageSchedule;
+        /** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
+        test_mode?: boolean;
+        tracking?: Pinnacle.Tracking;
+        /**
+         * Validate your message for any unsupported files. <br>
+         *
+         * If failed, errors will be thrown and the message will not send.
+         */
+        validate?: boolean;
+    }
+}

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Button that initiates a phone call when tapped by the recipient.
+ */
+export interface RcsButtonCall {
+    /** Phone number to call in E.164 format */
+    payload: string;
+    /** Display text for the button. */
+    title: string;
+}

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

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

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export type RcsButtonContent = Pinnacle.RcsButtonContent.OpenUrl | Pinnacle.RcsButtonContent.Call | Pinnacle.RcsButtonContent.Trigger | Pinnacle.RcsButtonContent.RequestUserLocation | Pinnacle.RcsButtonContent.ScheduleEvent | Pinnacle.RcsButtonContent.SendLocation;
+export declare namespace RcsButtonContent {
+    interface OpenUrl extends Pinnacle.RcsButtonOpenUrl {
+        type: "openUrl";
+    }
+    interface Call extends Pinnacle.RcsButtonCall {
+        type: "call";
+    }
+    interface Trigger extends Pinnacle.RcsButtonTrigger {
+        type: "trigger";
+    }
+    interface RequestUserLocation extends Pinnacle.RcsButtonRequestUserLocation {
+        type: "requestUserLocation";
+    }
+    interface ScheduleEvent extends Pinnacle.RcsButtonScheduleEvent {
+        type: "scheduleEvent";
+    }
+    interface SendLocation extends Pinnacle.RcsButtonSendLocation {
+        type: "sendLocation";
+    }
+}

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Button that opens a URL when tapped by the recipient.
+ */
+export interface RcsButtonOpenUrl {
+    /** The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL. */
+    payload: string;
+    /** Display text for the button. */
+    title: string;
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Button that prompts the recipient to share their current location.
+ */
+export interface RcsButtonRequestUserLocation {
+    /** Display text for the button. */
+    title: string;
+}

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

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

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Button that prompts the recipient to add an event to their calendar.
+ */
+export interface RcsButtonScheduleEvent {
+    /** Detailed description for the calendar event. */
+    eventDescription?: string;
+    /** End time in ISO 8601 format. */
+    eventEndTime: string;
+    /** Starting time in ISO 8601 format. */
+    eventStartTime: string;
+    /** Title of the event. */
+    eventTitle: string;
+    /** Display text for the button. */
+    title: string;
+}

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Button that shares a specific location with the recipient when tapped.
+ */
+export interface RcsButtonSendLocation {
+    /** Geographic coordinates of the location to share. */
+    latLong: RcsButtonSendLocation.LatLong;
+    /** Display text for the button. */
+    title: string;
+}
+export declare namespace RcsButtonSendLocation {
+    /**
+     * Geographic coordinates of the location to share.
+     */
+    interface LatLong {
+        /** Latitude coordinate in decimal degrees. */
+        lat: number;
+        /** Longitude coordinate in decimal degrees. */
+        lng: number;
+    }
+}

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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;
+    /** 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. */
+    title: string;
+}

package/dist/esm/api/types/RcsButtonTrigger.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

@@ -0,0 +1,106 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface RcsCampaign {
+    /** Agent configured to the campaign. */
+    agent?: RcsCampaign.Agent;
+    /** Unique identifier for the campaign. */
+    campaignId?: number;
+    /** List of what the agent might say to users. */
+    expectedAgentResponses?: string[];
+    /** Legal documentation links. */
+    links?: RcsCampaign.Links;
+    /** Opt-in configuration. */
+    optIn?: RcsCampaign.OptIn;
+    /** Opt-out configuration. */
+    optOut?: RcsCampaign.OptOut;
+    /** Use case classification for the campaign. */
+    useCase?: RcsCampaign.UseCase;
+}
+export declare namespace RcsCampaign {
+    /**
+     * Agent configured to the campaign.
+     */
+    interface Agent {
+        /** Name of the agent. */
+        name?: string;
+        /** Description of the agent. */
+        description?: string;
+        /** Color of the agent's buttons. */
+        color?: string;
+        /** List of emails. */
+        emails?: Agent.Emails.Item[];
+        /** List of phone numbers. */
+        phones?: Agent.Phones.Item[];
+        /** List of urls. */
+        websites?: Agent.Websites.Item[];
+        /** Link to the agent's hero. */
+        heroUrl?: string;
+        /** Link to the agent's icon. */
+        iconUrl?: string;
+    }
+    namespace Agent {
+        type Emails = Emails.Item[];
+        namespace Emails {
+            interface Item {
+                /** Email attached to the agent. */
+                email?: string;
+                /** Label for the email. */
+                label?: string;
+            }
+        }
+        type Phones = Phones.Item[];
+        namespace Phones {
+            interface Item {
+                /** Phone number attached to the agent in E.164 format. */
+                phone?: string;
+                /** Label for the phone number. */
+                label?: string;
+            }
+        }
+        type Websites = Websites.Item[];
+        namespace Websites {
+            interface Item {
+                /** Url attached to the agent. */
+                url?: string;
+                /** Label for the url. */
+                label?: string;
+            }
+        }
+    }
+    /**
+     * Legal documentation links.
+     */
+    interface Links {
+        /** Privacy policy URL. */
+        privacyPolicy?: string;
+        /** Terms of service URL. */
+        termsOfService?: string;
+    }
+    /**
+     * Opt-in configuration.
+     */
+    interface OptIn {
+        /** Message shown to users explaining what they are agreeing to when opting in. */
+        termsAndConditions?: string;
+        method?: Pinnacle.RcsCampaignOptInMethodEnum;
+    }
+    /**
+     * 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. */
+        behavior?: string;
+        value?: Pinnacle.RcsCampaignUseCaseEnum;
+    }
+}

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Opt in options.
+ */
+export type RcsCampaignOptInMethodEnum = "WEBSITE" | "SMS" | "APP" | "VERBAL" | "WRITTEN" | "OTHER";
+export declare const RcsCampaignOptInMethodEnum: {
+    readonly Website: "WEBSITE";
+    readonly Sms: "SMS";
+    readonly App: "APP";
+    readonly Verbal: "VERBAL";
+    readonly Written: "WRITTEN";
+    readonly Other: "OTHER";
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const RcsCampaignOptInMethodEnum = {
+    Website: "WEBSITE",
+    Sms: "SMS",
+    App: "APP",
+    Verbal: "VERBAL",
+    Written: "WRITTEN",
+    Other: "OTHER",
+};

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Response for get RCS campaign status.
+ */
+export interface RcsCampaignStatus {
+    /** List of errors that occured. */
+    errors: string[];
+    /** Id of the RCS campaign. */
+    id: number;
+    /**
+     * Current review status of the RCS 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. See [errors](rcs-campaign#response.body.errors) for these potential issues.<br>
+     */
+    status: Pinnacle.ProfileStatusEnum;
+}

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The primary use case classification for this campaign.
+ */
+export type RcsCampaignUseCaseEnum = "ENTERTAINMENT" | "SHOPPING_AND_RETAIL" | "GAMES" | "NEWS" | "HEALTH" | "UTILITIES" | "FINANCE" | "SPORTS" | "SOCIAL" | "FOOD_AND_BEVERAGE" | "UNCATEGORIZED" | "TRAVEL" | "PRODUCTIVITY" | "OTHER";
+export declare const RcsCampaignUseCaseEnum: {
+    readonly Entertainment: "ENTERTAINMENT";
+    readonly ShoppingAndRetail: "SHOPPING_AND_RETAIL";
+    readonly Games: "GAMES";
+    readonly News: "NEWS";
+    readonly Health: "HEALTH";
+    readonly Utilities: "UTILITIES";
+    readonly Finance: "FINANCE";
+    readonly Sports: "SPORTS";
+    readonly Social: "SOCIAL";
+    readonly FoodAndBeverage: "FOOD_AND_BEVERAGE";
+    readonly Uncategorized: "UNCATEGORIZED";
+    readonly Travel: "TRAVEL";
+    readonly Productivity: "PRODUCTIVITY";
+    readonly Other: "OTHER";
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const RcsCampaignUseCaseEnum = {
+    Entertainment: "ENTERTAINMENT",
+    ShoppingAndRetail: "SHOPPING_AND_RETAIL",
+    Games: "GAMES",
+    News: "NEWS",
+    Health: "HEALTH",
+    Utilities: "UTILITIES",
+    Finance: "FINANCE",
+    Sports: "SPORTS",
+    Social: "SOCIAL",
+    FoodAndBeverage: "FOOD_AND_BEVERAGE",
+    Uncategorized: "UNCATEGORIZED",
+    Travel: "TRAVEL",
+    Productivity: "PRODUCTIVITY",
+    Other: "OTHER",
+};

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface RcsCard extends Pinnacle.RcsBase, Pinnacle.RcsCards {
+}

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

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

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

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
+ *
+ * See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
+ */
+export interface RcsCards {
+    /** Collection of cards attached to the message. */
+    cards: RcsCards.Cards.Item[];
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RcsButtonContent[];
+}
+export declare namespace RcsCards {
+    type Cards = Cards.Item[];
+    namespace Cards {
+        /**
+         * Individual card containing title, optional media, and action buttons.
+         */
+        interface Item {
+            /** Action buttons attached to the card. */
+            buttons: Pinnacle.RcsButtonContent[];
+            /** Media file URLs to send. */
+            media?: string;
+            /** Secondary text displayed below the title for additional context. */
+            subtitle?: string;
+            /** Title displayed on the card. */
+            title: string;
+        }
+    }
+}

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

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

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

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
+ *
+ * See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
+ */
+export interface RcsCardsContent {
+    /** Collection of cards attached to the message. */
+    cards: RcsCardsContent.Cards.Item[];
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RcsButtonContent[];
+}
+export declare namespace RcsCardsContent {
+    type Cards = Cards.Item[];
+    namespace Cards {
+        /**
+         * Individual card containing title, optional media, and action buttons.
+         */
+        interface Item {
+            /** Action buttons attached to the card. */
+            buttons: Pinnacle.RcsButtonContent[];
+            media?: Pinnacle.RcsMediaDetailsContent;
+            /** Secondary text displayed below the title for additional context. */
+            subtitle?: string;
+            /** Title displayed on the card. */
+            title: string;
+        }
+    }
+}

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

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

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Message with richer content (longer text, media files, cards, and buttons) from interacting with an RCS agent.
+ */
+export type RcsContent = 
+/**
+ * Message containing longer text content with optional quick reply buttons. */
+Pinnacle.RcsTextContent
+/**
+ * Message containing a media file and/or text with optional quick reply buttons. <br>
+ *
+ * See [supported file types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
+ | Pinnacle.RcsMediaContent
+/**
+ * Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
+ *
+ * See [supported file types](https://app.pinnacle.sh/supported-file-types?type=RCS-CARD). */
+ | Pinnacle.RcsCardsContent;

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface RcsMedia extends Pinnacle.RcsBase {
+    /**
+     * Media file URLs to send. <br>
+     *
+     * See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
+     */
+    media: string;
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RcsButtonContent[];
+}

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Message containing a media file and/or text with optional quick reply buttons. <br>
+ *
+ * See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA].
+ */
+export interface RcsMediaContent {
+    media: Pinnacle.RcsMediaDetailsContent;
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RcsButtonContent[];
+}

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Metadata about the media file in the message.
+ */
+export interface RcsMediaDetailsContent {
+    /** Path to the file in Pinnacle's storage. */
+    fullPath?: string;
+    /** Detected MIME type of the media file. */
+    mimeType: string;
+    /** Direct URL to the media file. */
+    url: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface RcsText extends Pinnacle.RcsBase, Pinnacle.RcsTextContent {
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Message containing longer text content with optional quick reply buttons.
+ */
+export interface RcsTextContent {
+    /** List of interactive quick reply buttons in the message. */
+    quickReplies: Pinnacle.RcsButtonContent[];
+    /** Text content of the RCS message. */
+    text: string;
+}