rcs-js 1.0.22 → 2.0.0-rc.10

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

@@ -0,0 +1,161 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Detailed phone number analysis including validation status, classification with fraud risk,
+ * precise geographic data, carrier intelligence, and enhanced contact information.
+ * Provides comprehensive insights for risk assessment, compliance, and advanced usage scenarios.
+ */
+export interface AdvancedPhoneInformation {
+    /** Indicates whether the phone number is valid and capable of receiving communications. */
+    isValid: boolean;
+    /** Detailed classification including fraud risk and security recommendations. */
+    type: AdvancedPhoneInformation.Type;
+    /** Different standardized ways the phone number can be formatted for display or dialing. */
+    formats: Pinnacle.NumberFormat;
+    /**
+     * Comprehensive geographic and administrative location data with precise coordinates
+     * and timezone information for accurate localization.
+     */
+    location: AdvancedPhoneInformation.Location;
+    /** Detailed carrier information. */
+    carrier: AdvancedPhoneInformation.Carrier;
+    /** Enhanced contact information associated with the phone number. */
+    contact?: AdvancedPhoneInformation.Contact | null;
+}
+export declare namespace AdvancedPhoneInformation {
+    /**
+     * Detailed classification including fraud risk and security recommendations.
+     */
+    interface Type {
+        /** Technical classification derived from carrier intelligence systems. */
+        value: Pinnacle.DetailedPhoneNumberEnum;
+        /** Explanation of the phone number type and service */
+        description: string;
+        /**
+         * Additional technical details about the service type, billing model,
+         * and typical usage patterns for this number classification.
+         */
+        details: string;
+        /**
+         * Security recommendation based on fraud risk analysis:
+         * - `ALLOW`: Low risk, safe for normal use.
+         * - `BLOCK`: High risk, block or require additional verification.
+         * - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+         */
+        recommendation: Type.Recommendation;
+    }
+    namespace Type {
+        /**
+         * Security recommendation based on fraud risk analysis:
+         * - `ALLOW`: Low risk, safe for normal use.
+         * - `BLOCK`: High risk, block or require additional verification.
+         * - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+         */
+        type Recommendation = "ALLOW" | "BLOCK" | "FLAG";
+        const Recommendation: {
+            readonly Allow: "ALLOW";
+            readonly Block: "BLOCK";
+            readonly Flag: "FLAG";
+        };
+    }
+    /**
+     * Comprehensive geographic and administrative location data with precise coordinates
+     * and timezone information for accurate localization.
+     */
+    interface Location {
+        /** Complete country identification and metadata. */
+        country: Location.Country;
+        /** Primary city or municipality associated with the phone number. */
+        city?: string | null;
+        /**
+         * State, province, or primary administrative division code.
+         * Uses standard 2-letter abbreviations where applicable.
+         */
+        state?: string | null;
+        /** Postal or ZIP code for the phone number's registered location. */
+        zip?: string | null;
+        /**
+         * Primary Metropolitan Statistical Area (PMSA) code for US numbers.
+         * Used for demographic and market analysis purposes.
+         */
+        metroCode?: string | null;
+        /** County or secondary administrative division name. */
+        county?: string | null;
+        /** Coordinates provide the precise latitude and longitude values for the phone number’s registered location. */
+        coordinates: Location.Coordinates;
+        /** IANA timezone identifier for the number’s location. */
+        timeZone?: string | null;
+    }
+    namespace Location {
+        /**
+         * Complete country identification and metadata.
+         */
+        interface Country {
+            /** Name of the country. */
+            name: string;
+            /** Two-letter country code where the number is registered. */
+            code: string;
+            /** Three-letter country code where the number is registered. */
+            code3: string;
+        }
+        /**
+         * Coordinates provide the precise latitude and longitude values for the phone number’s registered location.
+         */
+        interface Coordinates {
+            /** Decimal degrees latitude coordinate. */
+            latitude?: number | null;
+            /** Decimal degrees longitude coordinate. */
+            longitude?: number | null;
+        }
+    }
+    /**
+     * Detailed carrier information.
+     */
+    interface Carrier {
+        /** Carrier or service provider name as registered with telecom authorities. */
+        name: string;
+        /** Standardized carrier name used across data sources. */
+        normalizedCarrier: string;
+        /**
+         * Mobile Country Code - 3-digit identifier assigned by ITU-T for the country.
+         * Used in GSM, UMTS, and LTE networks for international roaming and identification.
+         */
+        mcc: string;
+        /**
+         * Mobile Network Code - 2 or 3-digit identifier for the specific carrier within the country.
+         * Combined with MCC provides unique global identification of the mobile network.
+         */
+        mnc: string;
+    }
+    /**
+     * Enhanced contact information associated with the phone number.
+     */
+    interface Contact {
+        /** Given name of the primary contact. */
+        firstName?: string;
+        /** Family name of the primary contact. */
+        lastName?: string;
+        /** Primary email associated with the number’s registration. */
+        emailAddress?: string;
+        /** Street address including number and street name. */
+        street?: string;
+        /** Secondary address info like suite or apartment number. */
+        unit?: string;
+        /** Combined city, state, and postal info in a human-readable format. */
+        place?: string;
+        /** Postal or ZIP code of the contact’s address. */
+        zip?: string;
+        /** Full state or province name of the contact’s address. */
+        state?: string;
+        /** Full country name of the contact’s registered address. */
+        country?: string;
+        /**
+         * Collection of online profiles and social media accounts associated with the contact. <br>
+         *
+         * These are potential candidates and may be inaccurate. Always double check.
+         */
+        profiles?: Pinnacle.EnhancedContact;
+    }
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdvancedPhoneInformation = void 0;
+var AdvancedPhoneInformation;
+(function (AdvancedPhoneInformation) {
+    let Type;
+    (function (Type) {
+        Type.Recommendation = {
+            Allow: "ALLOW",
+            Block: "BLOCK",
+            Flag: "FLAG",
+        };
+    })(Type = AdvancedPhoneInformation.Type || (AdvancedPhoneInformation.Type = {}));
+})(AdvancedPhoneInformation || (exports.AdvancedPhoneInformation = AdvancedPhoneInformation = {}));

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Use this request to connect a webhook to your phone number and receive real-time event notifications.
+ * You can either attach one of your existing webhooks by providing its ID or create a new webhook by specifying its name, URL, and event type.
+ */
+export type AttachWebhookParams = 
+/**
+ * Attach a webhook you’ve already created in your account to this phone number. */
+{
+    webhookId: number;
+    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+}
+/**
+ * Create a new webhook and immediately attach it to your phone number. */
+ | {
+    name: string;
+    url: string;
+    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+};

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

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface AttachedPhoneNumberResult {
+    /** List of phone numbers. */
+    phoneNumbers: AttachedPhoneNumberResult.PhoneNumbers.Item[];
+    /** List of numbers that were not failed to be attached. */
+    failed: AttachedPhoneNumberResult.Failed.Item[];
+}
+export declare namespace AttachedPhoneNumberResult {
+    type PhoneNumbers = PhoneNumbers.Item[];
+    namespace PhoneNumbers {
+        interface Item {
+            /** Phone number (E.164 format). */
+            phoneNumber: string;
+            /** Campaign that the phone is now attached to. */
+            campaign: Item.Campaign;
+        }
+        namespace Item {
+            /**
+             * Campaign that the phone is now attached to.
+             */
+            interface Campaign {
+                /** Id of the campaign. */
+                id: number;
+                /** Campaign's name. */
+                name: string;
+                type: Pinnacle.MessagingProfileEnum;
+            }
+        }
+    }
+    type Failed = Failed.Item[];
+    namespace Failed {
+        interface Item {
+            /** Phone number (E.164 format). */
+            number: string;
+            /** Error related to why the number was not attached. */
+            error: string;
+        }
+    }
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AutofillCampaignParams {
+    /** Any additional information you want to provide. */
+    additionalInfo?: string;
+    /** Campaign ID. */
+    campaignId?: number;
+}

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

@@ -0,0 +1,104 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface AutofillDlcCampaignResponse {
+    /** Whether the campaign renews automatically. */
+    autoRenew: boolean;
+    /** Brand id. */
+    brand?: number;
+    /** Unique identifier for the campaign. */
+    campaignId?: number;
+    /** Description of the campaign. */
+    description?: string;
+    /** Keyword response configuration. */
+    keywords?: AutofillDlcCampaignResponse.Keywords;
+    /** Legal documentation links. */
+    links?: AutofillDlcCampaignResponse.Links;
+    /** Describe the flow of how users will opt in to this campaign. */
+    messageFlow?: string;
+    /** Display name of the campaign. */
+    name?: string;
+    /** Campaign configuration options. */
+    options?: AutofillDlcCampaignResponse.Options;
+    /** Example messages for the campaign. */
+    sampleMessages?: string[];
+    /** Use case for the campaign. */
+    useCase?: AutofillDlcCampaignResponse.UseCase;
+}
+export declare namespace AutofillDlcCampaignResponse {
+    /**
+     * Keyword response configuration.
+     */
+    interface Keywords {
+        /** Help keyword settings. */
+        HELP?: Keywords.Help;
+        /** Opt-in keyword settings. */
+        OPT_IN?: Keywords.OptIn;
+        /** Opt-out keyword settings. */
+        OPT_OUT?: Keywords.OptOut;
+    }
+    namespace Keywords {
+        /**
+         * Help keyword settings.
+         */
+        interface Help {
+            /** Response message for help keywords. */
+            message?: string;
+            /** Keywords that trigger help response. */
+            values?: string[];
+        }
+        /**
+         * Opt-in keyword settings.
+         */
+        interface OptIn {
+            /** Response message for opt-in keywords. */
+            message: string;
+            /** Keywords that trigger opt-in. */
+            values: string[];
+        }
+        /**
+         * Opt-out keyword settings.
+         */
+        interface OptOut {
+            /** Response message for opt-out keywords. */
+            message?: string;
+            /** Keywords that trigger opt-out. */
+            values?: string[];
+        }
+    }
+    /**
+     * Legal documentation links.
+     */
+    interface Links {
+        /** Privacy policy URL. */
+        privacyPolicy?: string;
+        /** Terms of service URL. */
+        termsOfService?: string;
+    }
+    /**
+     * Campaign configuration options.
+     */
+    interface Options {
+        /** Whether the campaign uses affiliate marketing. */
+        affiliateMarketing?: boolean;
+        /** Whether the campaign is age-gated. */
+        ageGated?: boolean;
+        /** Whether the campaign involves direct lending. */
+        directLending?: boolean;
+        /** Link embedded in campaign message. */
+        embeddedLink?: string;
+        /** Whether messages include phone numbers. */
+        embeddedPhone?: boolean;
+        /** Whether the campaign uses number pooling. */
+        numberPooling?: boolean;
+    }
+    /**
+     * Use case for the campaign.
+     */
+    interface UseCase {
+        /** Sub-use case categories. */
+        sub?: Pinnacle.SubUseCaseEnum[];
+        value?: Pinnacle.DlcCampaignUseCaseEnum;
+    }
+}

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

@@ -1,6 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface BadRequestErrorBody {
-    errors?: string[];
-}
+import * as Pinnacle from "../index.js";
+export type BadRequestErrorBody = 
+/**
+ * See https://zod.dev/error-formatting for more information. */
+Pinnacle.ZodError | Pinnacle.Error_;

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

@@ -0,0 +1,53 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Key details about a phone number, including its validity, type, location, carrier, and contact information.
+ * Provides the essential data required for verification, display, and basic analysis.
+ */
+export interface BasicPhoneInformation {
+    /** Indicates whether the phone number is valid and capable of receiving communications. */
+    isValid: boolean;
+    /** Classification of the phone number. */
+    type: Pinnacle.PhoneNumberEnum;
+    /** Different standardized ways the phone number can be formatted for display. */
+    formats: Pinnacle.NumberFormat;
+    /** Geographic and political details where the phone number is registered. */
+    location: BasicPhoneInformation.Location;
+    /** The telecommunications carrier or service provider for the number. */
+    carrier: string;
+    /** Contact information linked to the phone number registration, if available. */
+    contact: BasicPhoneInformation.Contact;
+}
+export declare namespace BasicPhoneInformation {
+    /**
+     * Geographic and political details where the phone number is registered.
+     */
+    interface Location {
+        /** Information about the country of registration. */
+        country: Location.Country;
+        /** Location description including region, state/province, and city. */
+        place: string;
+    }
+    namespace Location {
+        /**
+         * Information about the country of registration.
+         */
+        interface Country {
+            /** Two-letter country code where the number is registered. */
+            code: string;
+            /** Full name of the country. */
+            name: string;
+            /** International dialing prefix for the country. */
+            prefix: string;
+        }
+    }
+    /**
+     * Contact information linked to the phone number registration, if available.
+     */
+    interface Contact {
+        /** Registered name associated with the phone number. */
+        name: string;
+    }
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Response for get brand status.
+ */
+export interface BrandStatus {
+    /** List of errors that occurred. */
+    errors: string[];
+    /** Id of the brand. */
+    id: number;
+    /**
+     * Current review status of the brand. <br>
+     *
+     * `INCOMPLETE`: Has not been submitted. Use the [submit endpoint](../brands/submit). <br>
+     * `PENDING`: Currently being reviewed. <br>
+     * `VERIFIED`: Verified and good to go. <br>
+     * `UNVERIFIED`: No longer verified due to an update in the brand details. Requires vetting to be reverified. <br>
+     * `VETTED`: Brand has been vetted by an external provider and has received vetting scores. <br>
+     */
+    status: Pinnacle.BrandStatusEnum;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Current review status of the brand.
+ *
+ * `INCOMPLETE`: Has not been submitted.
+ * `PENDING`: Currently being reviewed.
+ * `VERIFIED`: Verified and good to go.
+ * `UNVERIFIED`: No longer verified due to an update in the brand details.
+ * `VETTED`: Brand has been vetted by an external provider and has received vetting scores.
+ */
+export type BrandStatusEnum = "PENDING" | "UNVERIFIED" | "VERIFIED" | "VETTED" | "FAILED" | "INCOMPLETE";
+export declare const BrandStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Unverified: "UNVERIFIED";
+    readonly Verified: "VERIFIED";
+    readonly Vetted: "VETTED";
+    readonly Failed: "FAILED";
+    readonly Incomplete: "INCOMPLETE";
+};

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

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrandStatusEnum = void 0;
+exports.BrandStatusEnum = {
+    Pending: "PENDING",
+    Unverified: "UNVERIFIED",
+    Verified: "VERIFIED",
+    Vetted: "VETTED",
+    Failed: "FAILED",
+    Incomplete: "INCOMPLETE",
+};

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of campaign:
+ * - TOLL_FREE: Toll-free number campaigns
+ * - 10DLC: 10-digit long code campaigns for A2P messaging
+ * - RCS: Rich Communication Services campaigns
+ */
+export type CampaignEnum = "TOLL_FREE" | "10DLC" | "RCS";
+export declare const CampaignEnum: {
+    readonly TollFree: "TOLL_FREE";
+    readonly TenDlc: "10DLC";
+    readonly Rcs: "RCS";
+};

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

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignEnum = void 0;
+exports.CampaignEnum = {
+    TollFree: "TOLL_FREE",
+    TenDlc: "10DLC",
+    Rcs: "RCS",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Information about the campaign associated with a conversation
+ */
+export interface CampaignQuery {
+    /** Unique identifier for the campaign */
+    id: string;
+    type: Pinnacle.CampaignEnum;
+}

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

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

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CampaignValidationResult {
+    /** List of validation errors. */
+    errors: CampaignValidationResult.Errors.Item[];
+    /** Whether the campaign is valid or not. */
+    is_valid: boolean;
+}
+export declare namespace CampaignValidationResult {
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            /** A human-readable description of the error. */
+            description: string;
+            /** An example of a valid value for the field. */
+            example?: string;
+            /** The field that is not valid. */
+            field: string;
+        }
+    }
+}

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

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ClickAction {
+    /** Title of the button or quick reply that was clicked on. */
+    button: string;
+    /** Payload received from the button interaction. */
+    data: ClickAction.Data;
+}
+export declare namespace ClickAction {
+    /**
+     * Payload received from the button interaction.
+     */
+    type Data = 
+    /**
+     * Data that is attached to the button. <br>
+     *
+     * This is only returned when `trigger` buttons are pressed. */
+    {
+        metadata: string;
+        payload: string;
+    }
+    /**
+     * Indicates that the button was clicked. <br>
+     *
+     * This is returned when `openUrl`, `call`, and `scheduleEvent` buttons are clicked. */
+     | "clicked";
+}

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

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Industry the Brand operates in.
+ */
+export type CompanySectorEnum = "AGRICULTURE" | "COMMUNICATION" | "CONSTRUCTION" | "EDUCATION" | "ENERGY" | "ENTERTAINMENT" | "FINANCIAL" | "GAMBLING" | "GOVERNMENT" | "HEALTHCARE" | "HOSPITALITY" | "INSURANCE" | "MANUFACTURING" | "NGO" | "REAL_ESTATE" | "RETAIL" | "TECHNOLOGY";
+export declare const CompanySectorEnum: {
+    readonly Agriculture: "AGRICULTURE";
+    readonly Communication: "COMMUNICATION";
+    readonly Construction: "CONSTRUCTION";
+    readonly Education: "EDUCATION";
+    readonly Energy: "ENERGY";
+    readonly Entertainment: "ENTERTAINMENT";
+    readonly Financial: "FINANCIAL";
+    readonly Gambling: "GAMBLING";
+    readonly Government: "GOVERNMENT";
+    readonly Healthcare: "HEALTHCARE";
+    readonly Hospitality: "HOSPITALITY";
+    readonly Insurance: "INSURANCE";
+    readonly Manufacturing: "MANUFACTURING";
+    readonly Ngo: "NGO";
+    readonly RealEstate: "REAL_ESTATE";
+    readonly Retail: "RETAIL";
+    readonly Technology: "TECHNOLOGY";
+};

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

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompanySectorEnum = void 0;
+exports.CompanySectorEnum = {
+    Agriculture: "AGRICULTURE",
+    Communication: "COMMUNICATION",
+    Construction: "CONSTRUCTION",
+    Education: "EDUCATION",
+    Energy: "ENERGY",
+    Entertainment: "ENTERTAINMENT",
+    Financial: "FINANCIAL",
+    Gambling: "GAMBLING",
+    Government: "GOVERNMENT",
+    Healthcare: "HEALTHCARE",
+    Hospitality: "HOSPITALITY",
+    Insurance: "INSURANCE",
+    Manufacturing: "MANUFACTURING",
+    Ngo: "NGO",
+    RealEstate: "REAL_ESTATE",
+    Retail: "RETAIL",
+    Technology: "TECHNOLOGY",
+};