rcs-js 2.0.6 → 2.0.8

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Detailed phone number analysis including validation status, classification with fraud risk,
  * precise geographic data, carrier intelligence, and enhanced contact information.
@@ -53,12 +50,12 @@ export declare namespace AdvancedPhoneInformation {
          * - `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";
         };
+        type Recommendation = (typeof Recommendation)[keyof typeof Recommendation];
     }
     /**
      * Comprehensive geographic and administrative location data with precise coordinates

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

@@ -1,10 +1,14 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export var AdvancedPhoneInformation;
 (function (AdvancedPhoneInformation) {
     let Type;
     (function (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: "ALLOW",
             Block: "BLOCK",

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

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

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 export interface AttachedPhoneNumberResult {
     /** List of phone numbers. */
     phoneNumbers: AttachedPhoneNumberResult.PhoneNumbers.Item[];

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface AudienceCountOnly {
     /** Audience public ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
     id: string;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 export interface AudienceWithPagination {
     /** Audience public ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
     id: string;

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface AutofillCampaignParams {
     /** Any additional information you want to provide. */
     additionalInfo?: string;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 export interface AutofillDlcCampaignResponse {
     /** Whether the campaign renews automatically. */
     autoRenew: boolean;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 export type BadRequestErrorBody = 
 /**
  * See https://zod.dev/error-formatting for more information. */

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

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

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

@@ -0,0 +1,9 @@
+import type * as Pinnacle from "../index.mjs";
+export interface BaseRichMessage {
+    /** Your RCS agent ID which must be prefixed with 'agent_'. */
+    from: string;
+    /** Configure how your RCS message is sent and tracked. */
+    options?: Pinnacle.SendRichMessageOptions;
+    /** Recipient's phone number in E.164 format. */
+    to: string;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Response containing details about the scheduled blast.
+ */
+export interface BlastDetails {
+    /** Unique identifier for the blast. This identifier is a string that always begins with the prefix `blast_`, for example: `blast_1234567890`. */
+    blastId: string;
+    /** The audience ID the blast was sent to. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    audienceId: string;
+    /** Total number of recipients in the audience. */
+    totalRecipients: number;
+    /** Total number of messages to be sent. */
+    totalMessages: number;
+    /** Total number of message segments across all messages. */
+    totalSegments: number;
+    /** Total estimated cost of the blast. Calculated by multiplying the number of segments by the number of messages by the unit cost. */
+    totalCost: number;
+}

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Response for get brand status.
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Current review status of the brand.
  *
@@ -10,7 +7,6 @@
  * `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";
@@ -19,3 +15,4 @@ export declare const BrandStatusEnum: {
     readonly Failed: "FAILED";
     readonly Incomplete: "INCOMPLETE";
 };
+export type BrandStatusEnum = (typeof BrandStatusEnum)[keyof typeof BrandStatusEnum];

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

@@ -1,5 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
 /**
- * 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 const BrandStatusEnum = {
     Pending: "PENDING",

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 export type ButtonClicked = 
 /**
  * Data about a button that was clicked. */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Unified data structure for button click events.
  */
@@ -39,11 +36,11 @@ export declare namespace ButtonClickedData {
          * - `QUICK_REPLY` for quick replies.
          * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
          */
-        type Type = "CARD" | "QUICK_REPLY";
         const Type: {
             readonly Card: "CARD";
             readonly QuickReply: "QUICK_REPLY";
         };
+        type Type = (typeof Type)[keyof typeof Type];
         /**
          * Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title.
          */

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

@@ -1,10 +1,14 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export var ButtonClickedData;
 (function (ButtonClickedData) {
     let Button;
     (function (Button) {
+        /**
+         * Type of button clicked.
+         * - `CARD` for card buttons,
+         * - `QUICK_REPLY` for quick replies.
+         * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
+         */
         Button.Type = {
             Card: "CARD",
             QuickReply: "QUICK_REPLY",

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

@@ -1,15 +1,12 @@
-/**
- * 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";
 };
+export type CampaignEnum = (typeof CampaignEnum)[keyof typeof CampaignEnum];

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

@@ -1,5 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
 /**
- * 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 const CampaignEnum = {
     TollFree: "TOLL_FREE",

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Information about the campaign associated with a conversation
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * 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/esm/api/types/CampaignSubmissionResult.mjs

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CampaignValidationResult {
     /** List of validation errors. */
     errors: CampaignValidationResult.Errors.Item[];

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

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

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

@@ -0,0 +1,9 @@
+/** Legal entity type of the brand. */
+export declare const CompanyEntityTypeEnum: {
+    readonly Llc: "LLC";
+    readonly SoleProprietorship: "SOLE_PROPRIETORSHIP";
+    readonly Partnership: "PARTNERSHIP";
+    readonly Corp: "CORP";
+    readonly SCorp: "S_CORP";
+};
+export type CompanyEntityTypeEnum = (typeof CompanyEntityTypeEnum)[keyof typeof CompanyEntityTypeEnum];

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Legal entity type of the brand. */
+export const CompanyEntityTypeEnum = {
+    Llc: "LLC",
+    SoleProprietorship: "SOLE_PROPRIETORSHIP",
+    Partnership: "PARTNERSHIP",
+    Corp: "CORP",
+    SCorp: "S_CORP",
+};

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

@@ -1,10 +1,4 @@
-/**
- * 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";
+/** Industry the Brand operates in. */
 export declare const CompanySectorEnum: {
     readonly Agriculture: "AGRICULTURE";
     readonly Communication: "COMMUNICATION";
@@ -24,3 +18,4 @@ export declare const CompanySectorEnum: {
     readonly Retail: "RETAIL";
     readonly Technology: "TECHNOLOGY";
 };
+export type CompanySectorEnum = (typeof CompanySectorEnum)[keyof typeof CompanySectorEnum];

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

@@ -1,6 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
+/** Industry the Brand operates in. */
 export const CompanySectorEnum = {
     Agriculture: "AGRICULTURE",
     Communication: "COMMUNICATION",

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

@@ -1,10 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Legal structure of the brand.
- */
-export type CompanyTypeEnum = "GOVERNMENT" | "NON_PROFIT" | "PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "SOLE_PROPRIETOR";
+/** Legal structure of the brand. */
 export declare const CompanyTypeEnum: {
     readonly Government: "GOVERNMENT";
     readonly NonProfit: "NON_PROFIT";
@@ -12,3 +6,4 @@ export declare const CompanyTypeEnum: {
     readonly PublicProfit: "PUBLIC_PROFIT";
     readonly SoleProprietor: "SOLE_PROPRIETOR";
 };
+export type CompanyTypeEnum = (typeof CompanyTypeEnum)[keyof typeof CompanyTypeEnum];

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

@@ -1,6 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
+/** Legal structure of the brand. */
 export const CompanyTypeEnum = {
     Government: "GOVERNMENT",
     NonProfit: "NON_PROFIT",

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Confirmation that a webhook has been successfully attached to the specified phone number.
  * Includes detailed webhook information, the subscribed event type, and the associated phone number.

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface Contact {
     /** Additional information about the contact. */
     description?: string;

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface ContactId {
     /** Unique ID of the created contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
     id: string;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Conversation that was found.
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 /**
  * Response for list conversation.
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CreateUrlOptions {
     /**
      * Expiration date in ISO 8601 format for the shortened URL. <br>

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface DeleteAudienceResponse {
     /** Indicates successful deletion. */
     success: boolean;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Pinnacle from "../index.mjs";
+import type * as Pinnacle from "../index.mjs";
 export interface DetachedPhoneNumberResult {
     /** List of phone numbers. */
     phoneNumbers: DetachedPhoneNumberResult.PhoneNumbers.Item[];

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface DetachedWebhookInfo {
     /** Confirmation message. */
     message: string;

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

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