rcs-js 1.0.18 → 2.0.0-rc.1

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Message with text and/or media files from a phone number.
+ */
+export interface MmsContent {
+    /**
+     * URLs of media files in this message. <br>
+     *
+     * See [supported media types](https://app.pinnacle.sh/supported-file-types?type=MMS).
+     */
+    mediaUrls: string[];
+    /** Text content that accompanies the media files. */
+    text?: string;
+}

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

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

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

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MmsValidationResult {
+    /** Details about how the MMS content would be segmented for delivery. */
+    segments: MmsValidationResult.Segments;
+    /** Total price of this message. Calculated by multiplying the number of segments by the unit cost. */
+    total: number;
+    /** Cost of each segment. */
+    unit: number;
+}
+export declare namespace MmsValidationResult {
+    /**
+     * Details about how the MMS content would be segmented for delivery.
+     */
+    interface Segments {
+        /** Number of segments this message would be split into. */
+        count: number;
+        /**
+         * List of unsupported media files included in the message. <br>
+         *
+         * This may be because the file is unreachable or not supported by the MMS protocol. See [supported file types](https://app.pinnacle.sh/supported-file-types?type=MMS).
+         */
+        unsupportedFiles: string[];
+        /** Message segments with its content breakdown. */
+        value: Segments.Value.Item[];
+    }
+    namespace Segments {
+        type Value = Value.Item[];
+        namespace Value {
+            interface Item {
+                /** Media file URLs that would be included in this segment. */
+                files: string[];
+                /** Size of this segment in bytes. */
+                size: number;
+                /** Text content in this segment. */
+                text: string;
+            }
+        }
+    }
+}

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contact information for the brand.
+ */
+export interface NullableContact {
+    /** Email address of the contact person. */
+    email?: string | null;
+    /** Full name of the contact person. */
+    name?: string | null;
+    /** Phone number of the contact person in E.164 format. */
+    phone?: string | null;
+    /** Job title of the contact person. */
+    title?: string | null;
+}

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Multiple formatting representations of the same phone number for different use cases.
+ * Provides flexibility for display, storage, and integration requirements.
+ */
+export interface NumberFormat {
+    /** Phone number in E.164 format with country code prefix. */
+    international: string;
+    /**
+     * Phone number formatted according to national conventions. <br>
+     *
+     * Includes parentheses, spaces, and dashes as commonly used in the country.
+     */
+    national: string;
+    /** Phone number with only digits, no formatting or country code prefix. */
+    raw: string;
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Opt in options.
+ */
+export type OptInMethodEnum = "DIGITAL" | "PAPER" | "TEXT" | "VERBAL";
+export declare const OptInMethodEnum: {
+    readonly Digital: "DIGITAL";
+    readonly Paper: "PAPER";
+    readonly Text: "TEXT";
+    readonly Verbal: "VERBAL";
+};

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const OptInMethodEnum = {
+    Digital: "DIGITAL",
+    Paper: "PAPER",
+    Text: "TEXT",
+    Verbal: "VERBAL",
+};

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface OptionalBrandInfo {
+    /** Primary brand address where this brand is located. */
+    address?: string;
+    contact?: Pinnacle.OptionalContacts;
+    /** "Doing Business As" name - the public name this brand operates under. */
+    dba?: string | null;
+    /** Brief description of what this brand does. */
+    description?: string;
+    /** Employer Identification Number (EIN) assigned by the IRS. */
+    ein?: string;
+    /** Main contact email address for this brand. */
+    email?: string;
+    /** Legal name of the brand as registered. */
+    name?: string;
+    sector?: Pinnacle.CompanySectorEnum;
+    type?: Pinnacle.CompanyTypeEnum;
+    /** Brand website URL. */
+    website?: string;
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OptionalContact {
+    /** New notes or details for your contact. */
+    description?: string | null;
+    /** New email address for your contact. */
+    email?: string | null;
+    /** New name for your contact. */
+    name?: string | null;
+    /** New tags for your contact. */
+    tags?: string[];
+}

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Contact information for the primary brand representative.
+ */
+export interface OptionalContacts {
+    /** Email address of the contact person. */
+    email?: string;
+    /** Full name of the contact person. */
+    name?: string;
+    /** Phone number of the contact person in E.164 format. */
+    phone?: string;
+    /** Job title or position oft he contact person. */
+    title?: string;
+}

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Represents the communication capabilities available for a phone number.
+ */
+export interface PhoneCapabilities {
+    /** Whether the phone number supports MMS (multimedia messaging). */
+    mms: boolean;
+    /** Whether the phone number supports SMS messaging. */
+    sms: boolean;
+    /** Whether the phone number supports voice calls. */
+    voice: boolean;
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Classification of phone number types based on their billing and geographic properties. <br>
+ *
+ * Determines pricing structure and availability patterns.
+ */
+export type PhoneEnum = "LOCAL" | "TOLL_FREE";
+export declare const PhoneEnum: {
+    readonly Local: "LOCAL";
+    readonly TollFree: "TOLL_FREE";
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const PhoneEnum = {
+    Local: "LOCAL",
+    TollFree: "TOLL_FREE",
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Communication features and capabilities supported by a phone number. <br>
+ *
+ * These features determine what types of communication the number can handle.
+ */
+export type PhoneFeatureEnum = "SMS" | "MMS" | "VOICE" | "FAX" | "EMERGENCY" | "HD_VOICE" | "INTERNATIONAL_SMS" | "LOCAL_CALLING";
+export declare const PhoneFeatureEnum: {
+    readonly Sms: "SMS";
+    readonly Mms: "MMS";
+    readonly Voice: "VOICE";
+    readonly Fax: "FAX";
+    readonly Emergency: "EMERGENCY";
+    readonly HdVoice: "HD_VOICE";
+    readonly InternationalSms: "INTERNATIONAL_SMS";
+    readonly LocalCalling: "LOCAL_CALLING";
+};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const PhoneFeatureEnum = {
+    Sms: "SMS",
+    Mms: "MMS",
+    Voice: "VOICE",
+    Fax: "FAX",
+    Emergency: "EMERGENCY",
+    HdVoice: "HD_VOICE",
+    InternationalSms: "INTERNATIONAL_SMS",
+    LocalCalling: "LOCAL_CALLING",
+};

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

@@ -0,0 +1,49 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Details of a phone number available for purchase.
+ * Includes all essential data required for acquisition and operational planning.
+ */
+export interface PhoneNumberDetails {
+    /** Phone number in E.164 format. */
+    number: string;
+    /** Classification that defines the number's billing model and geographic scope. */
+    phone_type: Pinnacle.PhoneEnum;
+    /** Pricing details for the phone number. */
+    cost: PhoneNumberDetails.Cost;
+    /** Supported communication capabilities associated with the number. */
+    features: Pinnacle.PhoneFeatureEnum[];
+    /** Geographic and routing information for the phone number. */
+    region: PhoneNumberDetails.Region;
+}
+export declare namespace PhoneNumberDetails {
+    /**
+     * Pricing details for the phone number.
+     */
+    interface Cost {
+        /** Recurring monthly fee covering number ownership and basic services. */
+        monthly: number;
+        /** One-time activation or setup fee charged at purchase. */
+        upfront: number;
+        /** Three-letter currency code for all pricing values. */
+        currency: string;
+    }
+    /**
+     * Geographic and routing information for the phone number.
+     */
+    interface Region {
+        /** Two-letter country code where the number is registered. */
+        country: string;
+        /** State or province code applicable to local numbers. */
+        state?: string;
+        /** Primary city or metropolitan area served by the number. */
+        city?: string;
+        /**
+         * Telecommunications rate center used for call routing and billing,
+         * defining local calling area boundaries.
+         */
+        rateCenter?: string;
+    }
+}

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The classification of the phone number based on its service type. <br>
+ *
+ * Determines the billing, usage, and routing characteristics.
+ */
+export type PhoneNumberEnum = "LANDLINE" | "MOBILE" | "SATELLITE" | "PREMIUM" | "PAGING" | "SPECIAL" | "TOLL_FREE" | "UNKNOWN";
+export declare const PhoneNumberEnum: {
+    readonly Landline: "LANDLINE";
+    readonly Mobile: "MOBILE";
+    readonly Satellite: "SATELLITE";
+    readonly Premium: "PREMIUM";
+    readonly Paging: "PAGING";
+    readonly Special: "SPECIAL";
+    readonly TollFree: "TOLL_FREE";
+    readonly Unknown: "UNKNOWN";
+};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const PhoneNumberEnum = {
+    Landline: "LANDLINE",
+    Mobile: "MOBILE",
+    Satellite: "SATELLITE",
+    Premium: "PREMIUM",
+    Paging: "PAGING",
+    Special: "SPECIAL",
+    TollFree: "TOLL_FREE",
+    Unknown: "UNKNOWN",
+};

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+/**
+ * Response for get phone number status.
+ */
+export interface PhoneNumberStatus {
+    /** List of errors that occured. */
+    errors: string[];
+    /** Phone number in E164 format that is in review */
+    phoneNumber: string;
+    /**
+     * Current status of the phone number. <br>
+     *
+     * `PENDING`: Not active during the one or more of the following: purchase pending, brand or campaign pending verification, and pending assignment to a campaign. To use a number, make sure to [attach it](../phone-numbers/attach-campaign) to an active campaign. <br>
+     * `ACTIVE`: Number is ready to send messages. <br>
+     * `FAILURE`: Errors occurred while activating this number. See the [errors field](phone-number#response.body.errors).
+     */
+    status: Pinnacle.PhoneNumberStatusEnum;
+}

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Current status of the phone number.
+ *
+ * `PENDING`: Not active during the one or more of the following: purchase pending, brand or campaign pending verification, and pending assignment to a campaign.
+ * `ACTIVE`: Number is ready to send messages.
+ * `FAILURE`: Errors occurred while activating this number.
+ */
+export type PhoneNumberStatusEnum = "PENDING" | "ACTIVE" | "FAILURE";
+export declare const PhoneNumberStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Active: "ACTIVE";
+    readonly Failure: "FAILURE";
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const PhoneNumberStatusEnum = {
+    Pending: "PENDING",
+    Active: "ACTIVE",
+    Failure: "FAILURE",
+};

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Current review status of the campaign.
+ *
+ * `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";
+export declare const ProfileStatusEnum: {
+    readonly Incomplete: "INCOMPLETE";
+    readonly InReview: "IN REVIEW";
+    readonly Verified: "VERIFIED";
+    readonly Failed: "FAILED";
+};

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const ProfileStatusEnum = {
+    Incomplete: "INCOMPLETE",
+    InReview: "IN REVIEW",
+    Verified: "VERIFIED",
+    Failed: "FAILED",
+};

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

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Details of a phone number that has been successfully purchased and provisioned.
+ * Includes all communication capabilities currently enabled for immediate use.
+ */
+export interface PurchasedNumber {
+    /** Purchased phone number in E.164 format. */
+    number: string;
+    /** Enabled communication features for the phone number. */
+    capabilities: PurchasedNumber.Capabilities;
+}
+export declare namespace PurchasedNumber {
+    /**
+     * Enabled communication features for the phone number.
+     */
+    interface Capabilities {
+        /** Indicates if SMS messaging is enabled and functional. */
+        sms: boolean;
+        /** Indicates if multimedia messaging (images, videos, files) is enabled and functional. */
+        mms: boolean;
+        /** Indicates if voice calling is enabled and functional. */
+        voice: boolean;
+    }
+}

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

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

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;
+}