rcs-js 1.0.22 → 2.0.0-rc.2

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/RcsContent.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/RcsMedia.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+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/cjs/api/types/RcsMedia.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/RcsMediaContent.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/RcsMediaContent.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/RcsMediaDetailsContent.d.ts

@@ -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/cjs/api/types/RcsMediaDetailsContent.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/RcsText.d.ts

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

package/dist/cjs/api/types/RcsText.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/RcsTextContent.d.ts

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

package/dist/cjs/api/types/RcsTextContent.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/RcsValidateContent.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export type RcsValidateContent = 
+/**
+ * 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 media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
+ | {
+    media: string;
+}
+/**
+ * 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.RcsCards;

package/dist/cjs/api/types/RcsValidateContent.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/RcsValidationResult.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RcsValidationResult {
+    /** Total price of this message. Calculated by multiplying the number of messages by the unit cost. */
+    total: number;
+    /** Cost per message. */
+    unit: number;
+    /** List of unsupported media file names or URLs. */
+    unsupportedFiles: string[];
+}

package/dist/cjs/api/types/RcsValidationResult.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/ReactionResult.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;
+}

package/dist/cjs/api/types/ReactionResult.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/ScheduledMessaage.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ScheduledMessaage {
+    /** Unique identifier for the scheduled send. */
+    scheduleId: number;
+    /** Configuration for the scheduled message. */
+    config: ScheduledMessaage.Config;
+}
+export declare namespace ScheduledMessaage {
+    /**
+     * Configuration for the scheduled message.
+     */
+    interface Config {
+        /** When the message will be sent in ISO 8601 format. */
+        sendAt: string;
+        /** AWS cron expression used for recurring messages. */
+        recurrence?: string;
+        /** IANA timezone identifier. */
+        timezone: string;
+        /** When the recurring messages stops in ISO 8601 format. */
+        endDate?: string;
+    }
+}

package/dist/cjs/api/types/ScheduledMessaage.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/Sender.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The sender identifier. Can be either:
+ * - A phone number in E.164 format
+ * - An RCS agent ID prefixed with 'agent_'
+ */
+export type Sender = string;

package/dist/cjs/api/types/Sender.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/SentMmsDetails.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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[];
+    /** Total number of segments used across the message. */
+    segments: number;
+    /** Total cost of sending the message. */
+    totalCost: number;
+    /** Sender's phone number in E.164 format. */
+    sender: string;
+    /** Recipient's phone number in E.164 format. */
+    recipient: string;
+    /** Message is queued for delivery. */
+    status: "queued";
+}

package/dist/cjs/api/types/SentMmsDetails.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/SentRcsDetails.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SentRcsDetails {
+    /** Unique identifier for the sent MMS messages. */
+    messageIds?: number;
+    /** Total number of segments used across the message. */
+    segments: number;
+    /** Total cost of sending the message. */
+    totalCost: number;
+    /** Sender's phone number in E.164 format. */
+    sender: string;
+    /** Recipient's phone number in E.164 format. */
+    recipient: string;
+    /** Current status of the message. */
+    status: "queued";
+}

package/dist/cjs/api/types/SentRcsDetails.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/SentSmsDetails.d.ts

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SentSmsDetails {
+    /** Unique identifier for the sent message. */
+    messageId: number;
+    /** Details about how the message was segmented for sending. */
+    segments: SentSmsDetails.Segments;
+    /** Total cost of sending the message. */
+    totalCost: number;
+    /** Sender's phone number in E.164 format. */
+    sender: string;
+    /** Recipient's phone number in E.164 format. */
+    recipient: string;
+    /** Message is queued for delivery. */
+    status: "queued";
+}
+export declare namespace SentSmsDetails {
+    /**
+     * Details about how the message was segmented for sending.
+     */
+    interface Segments {
+        /** Number of message segments used to send this message. */
+        count: number;
+        /** Encoding used for the message segments. */
+        encoding: Segments.Encoding;
+    }
+    namespace Segments {
+        /**
+         * Encoding used for the message segments.
+         */
+        type Encoding = "gsm7" | "utf16";
+        const Encoding: {
+            readonly Gsm7: "gsm7";
+            readonly Utf16: "utf16";
+        };
+    }
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentSmsDetails = void 0;
+var SentSmsDetails;
+(function (SentSmsDetails) {
+    let Segments;
+    (function (Segments) {
+        Segments.Encoding = {
+            Gsm7: "gsm7",
+            Utf16: "utf16",
+        };
+    })(Segments = SentSmsDetails.Segments || (SentSmsDetails.Segments = {}));
+})(SentSmsDetails || (exports.SentSmsDetails = SentSmsDetails = {}));

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ShortenedUrl {
+    /** Your custom shortened link following the format `https://pncl.to/{linkId}`, where `{linkId}` is the unique identifier for the URL that can be used with our other endpoint. */
+    url: string;
+    config: ShortenedUrl.Config;
+}
+export declare namespace ShortenedUrl {
+    interface Config {
+        /** Destination URL that your shortened link redirects to. */
+        to: string;
+        /** Expiration date for your shortened link in ISO 8601 format, or null if it's permanent. */
+        expiresAt?: string | null;
+    }
+}

package/dist/cjs/api/types/ShortenedUrl.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/ShortenedUrlWithClickData.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface ShortenedUrlWithClickData extends Pinnacle.ShortenedUrl {
+    /**
+     * Array of click analytics data for this URL. <br>
+     *
+     * Click data will be empty if no one has visited your link yet.
+     */
+    clicks: Pinnacle.LinkClickEvent[];
+}

package/dist/cjs/api/types/ShortenedUrlWithClickData.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/SmsContent.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * SMS message containing plain text only.
+ */
+export interface SmsContent {
+    /** Message content. */
+    text: string;
+}

package/dist/cjs/api/types/SmsContent.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/SmsValidationResult.d.ts

@@ -0,0 +1,59 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SmsValidationResult {
+    /**
+     * Indicates if the message exceeds the allowed segment limit. <br>
+     *
+     * For SMS, this is limit is 10.
+     */
+    isOverSegmentLimit?: boolean;
+    /** Details about how the SMS content would be segmented for delivery. */
+    segments: SmsValidationResult.Segments;
+    total: SmsValidationResult.Total;
+    /** Cost per message segment. */
+    unit: number;
+}
+export declare namespace SmsValidationResult {
+    /**
+     * Details about how the SMS content would be segmented for delivery.
+     */
+    interface Segments {
+        /** Segmentation details when your message is encoded with GSM-7. */
+        gsm7: Segments.Gsm7;
+        /** Segmentation details when your message is encoded with UTF-16. */
+        utf16: Segments.Utf16;
+    }
+    namespace Segments {
+        /**
+         * Segmentation details when your message is encoded with GSM-7.
+         */
+        interface Gsm7 {
+            /** Total number of bytes used by the GSM-7 segments. */
+            totalBytes: number;
+            /** Characters not supported by GSM-7 encoding. */
+            unsupported: string[];
+            /** Message broken down into segments using GSM-7 encoding. */
+            value: string[];
+        }
+        /**
+         * Segmentation details when your message is encoded with UTF-16.
+         */
+        interface Utf16 {
+            /** Total number of bytes used by the UTF-16 segments. */
+            totalBytes: number;
+            /** Message broken down into segments using UTF-16 encoding. */
+            value: string[];
+        }
+    }
+    interface Total {
+        /**
+         * Total price of this message. Calculated by multiplying the number of GSM-7 segments by the unit cost. <br>
+         *
+         * You must remove all unsupported UTF-16 characters before this message can be sent as GSM-7.
+         */
+        gsm7: number;
+        /** Total price of this message. Calculated by multiplying the number of UTF-16 segments by the unit cost. */
+        utf16: number;
+    }
+}

package/dist/cjs/api/types/SmsValidationResult.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/SubUseCaseEnum.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Additional subcategories for the primary use case.
+ */
+export type SubUseCaseEnum = "ACCOUNT_NOTIFICATION" | "CUSTOMER_CARE" | "DELIVERY_NOTIFICATION" | "FRAUD_ALERT" | "HIGHER_EDUCATION" | "MARKETING" | "POLLING_VOTING" | "PUBLIC_SERVICE_ANNOUNCEMENT" | "SECURITY_ALERT" | "TWO_FA";
+export declare const SubUseCaseEnum: {
+    readonly AccountNotification: "ACCOUNT_NOTIFICATION";
+    readonly CustomerCare: "CUSTOMER_CARE";
+    readonly DeliveryNotification: "DELIVERY_NOTIFICATION";
+    readonly FraudAlert: "FRAUD_ALERT";
+    readonly HigherEducation: "HIGHER_EDUCATION";
+    readonly Marketing: "MARKETING";
+    readonly PollingVoting: "POLLING_VOTING";
+    readonly PublicServiceAnnouncement: "PUBLIC_SERVICE_ANNOUNCEMENT";
+    readonly SecurityAlert: "SECURITY_ALERT";
+    readonly TwoFa: "TWO_FA";
+};

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

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubUseCaseEnum = void 0;
+exports.SubUseCaseEnum = {
+    AccountNotification: "ACCOUNT_NOTIFICATION",
+    CustomerCare: "CUSTOMER_CARE",
+    DeliveryNotification: "DELIVERY_NOTIFICATION",
+    FraudAlert: "FRAUD_ALERT",
+    HigherEducation: "HIGHER_EDUCATION",
+    Marketing: "MARKETING",
+    PollingVoting: "POLLING_VOTING",
+    PublicServiceAnnouncement: "PUBLIC_SERVICE_ANNOUNCEMENT",
+    SecurityAlert: "SECURITY_ALERT",
+    TwoFa: "TWO_FA",
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SubmissionResults {
+    /** Indicates if the submission was successful. */
+    success: boolean;
+}

package/dist/cjs/api/types/SubmissionResults.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/SuccessfulConversationUpdate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Successfully updated conversation.
+ */
+export interface SuccessfulConversationUpdate {
+    /** Indicates the operation was successful. */
+    success: boolean;
+}

package/dist/cjs/api/types/SuccessfulConversationUpdate.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/TollFreeCampaign.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface TollFreeCampaign {
+    /** Unique identifier for the campaign. */
+    campaignId?: number;
+    monthlyVolume?: Pinnacle.MessageVolumeEnum;
+    /** Display name of the campaign. */
+    name?: string;
+    /** Opt-in keyword settings. */
+    optIn?: TollFreeCampaign.OptIn;
+    /** Explain message that would be sent. */
+    productionMessageContent?: string;
+    /** Use case classification for the campaign. */
+    useCase?: TollFreeCampaign.UseCase;
+}
+export declare namespace TollFreeCampaign {
+    /**
+     * Opt-in keyword settings.
+     */
+    interface OptIn {
+        method?: Pinnacle.OptInMethodEnum;
+        /** Url to opt in. */
+        url?: string;
+        /** Explain how users find the opt-in. */
+        workflowDescription?: string;
+    }
+    /**
+     * Use case classification for the campaign.
+     */
+    interface UseCase {
+        /** Summary of the use case. */
+        summary?: string;
+        value?: Pinnacle.TollFreeCampaignUseCaseEnum;
+    }
+}

package/dist/cjs/api/types/TollFreeCampaign.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/TollFreeCampaignStatus.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Response for get toll-free campaign status.
+ */
+export interface TollFreeCampaignStatus {
+    /**
+     * Summary of errors related to the verification process. <br>
+     *
+     * These errors may request additional information or point out erroneous and/or missing fields.
+     */
+    error?: string;
+    /** Id of the toll-free campaign. */
+    id: number;
+    /**
+     * Status of phone 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).
+     */
+    updates: TollFreeCampaignStatus.Updates;
+}
+export declare namespace TollFreeCampaignStatus {
+    /**
+     * Status of phone 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).
+     */
+    interface Updates {
+        /** List of errors that occurred. */
+        errors: string[];
+        /** Number associated with the campaign in E.164 format. */
+        number: string;
+        /**
+         * Current assignment status of the toll free number to this campaign. <br>
+         *
+         * `IN_PROGRESS`: Being reviewed.<br>
+         * `WAITING_FOR_PROVIDER`: Being reviewed by our toll-free vendor.<br>
+         * `WAITING_FOR_TELECO:` Final review by carriers before number is live.<br>
+         * `VERIFIED`: Verified and ready to send messages.<br>
+         * `REJECTED`: Issues were found related to your campaign. See the [errors field](toll-free-campaign#response.body.error).
+         */
+        status: Pinnacle.TollFreeStatusEnum;
+    }
+}