rcs-js 2.0.5 → 2.0.7

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * SMS message containing plain text only.
  */

package/dist/esm/api/types/MessageEventSmsContent.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/MessageList.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";
 /**
  * Paginated list of messages in a conversation.
  */

package/dist/esm/api/types/MessageList.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/MessageMethodEnum.d.mts

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Method used to send the message.
- */
-export type MessageMethodEnum = "API" | "SDK" | "OTHER";
+/** Method used to send the message. */
 export declare const MessageMethodEnum: {
     readonly Api: "API";
     readonly Sdk: "SDK";
     readonly Other: "OTHER";
 };
+export type MessageMethodEnum = (typeof MessageMethodEnum)[keyof typeof MessageMethodEnum];

package/dist/esm/api/types/MessageMethodEnum.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.
+/** Method used to send the message. */
 export const MessageMethodEnum = {
     Api: "API",
     Sdk: "SDK",

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

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Delivery protocol used for sending this message.
- */
-export type MessageProtocolEnum = "SMS" | "MMS" | "RCS";
+/** Delivery protocol used for sending this message. */
 export declare const MessageProtocolEnum: {
     readonly Sms: "SMS";
     readonly Mms: "MMS";
     readonly Rcs: "RCS";
 };
+export type MessageProtocolEnum = (typeof MessageProtocolEnum)[keyof typeof MessageProtocolEnum];

package/dist/esm/api/types/MessageProtocolEnum.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.
+/** Delivery protocol used for sending this message. */
 export const MessageProtocolEnum = {
     Sms: "SMS",
     Mms: "MMS",

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Define when and how your message should be sent.
  */
@@ -13,7 +10,13 @@ export interface MessageSchedule {
      * [Learn more about cron expressions](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).
      */
     recurrence?: string;
-    /** Date and time when you want to send your message in ISO 8601 format. */
+    /**
+     * The date and time you want your message to be sent.
+     * - Use [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), for example: `2024-12-17T14:30:00Z`.
+     * - This time must be at least 5 minutes in the future.
+     * - The message will be scheduled based on the `timezone` you provide.
+     * - If you set a `recurrence` schedule, this is the start date and time for the recurring schedule.
+     */
     sendAt: string;
     /** Timezone for your scheduled message, using an IANA identifier. */
     timezone: string;

package/dist/esm/api/types/MessageSchedule.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/MessageStatusEnum.d.mts

@@ -1,10 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Current status of the message.
- */
-export type MessageStatusEnum = "PENDING" | "SENT" | "SEND_FAILED" | "DELIVERED" | "DELIVERY_FAILED" | "RECEIVED" | "READ";
+/** Current status of the message. */
 export declare const MessageStatusEnum: {
     readonly Pending: "PENDING";
     readonly Sent: "SENT";
@@ -14,3 +8,4 @@ export declare const MessageStatusEnum: {
     readonly Received: "RECEIVED";
     readonly Read: "READ";
 };
+export type MessageStatusEnum = (typeof MessageStatusEnum)[keyof typeof MessageStatusEnum];

package/dist/esm/api/types/MessageStatusEnum.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.
+/** Current status of the message. */
 export const MessageStatusEnum = {
     Pending: "PENDING",
     Sent: "SENT",

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

@@ -1,10 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Message volume.
- */
-export type MessageVolumeEnum = "10" | "100" | "1,000" | "10,000" | "100,000" | "250,000" | "500,000" | "750,000" | "1,000,000" | "5,000,000" | "10,000,000+";
+/** Message volume. */
 export declare const MessageVolumeEnum: {
     readonly Ten: "10";
     readonly OneHundred: "100";
@@ -18,3 +12,4 @@ export declare const MessageVolumeEnum: {
     readonly Five000000: "5,000,000";
     readonly Ten000000: "10,000,000+";
 };
+export type MessageVolumeEnum = (typeof MessageVolumeEnum)[keyof typeof MessageVolumeEnum];

package/dist/esm/api/types/MessageVolumeEnum.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.
+/** Message volume. */
 export const MessageVolumeEnum = {
     Ten: "10",
     OneHundred: "100",

package/dist/esm/api/types/MessageWithReaction.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";
 /**
  * Message with additional conversation-specific fields including direction and reaction.
  */
@@ -16,12 +13,10 @@ export interface MessageWithReaction extends Pinnacle.Message {
     reaction: string | null;
 }
 export declare namespace MessageWithReaction {
-    /**
-     * Direction of the message flow.
-     */
-    type Direction = "INBOUND" | "OUTBOUND";
+    /** Direction of the message flow. */
     const Direction: {
         readonly Inbound: "INBOUND";
         readonly Outbound: "OUTBOUND";
     };
+    type Direction = (typeof Direction)[keyof typeof Direction];
 }

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

@@ -1,8 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export var MessageWithReaction;
 (function (MessageWithReaction) {
+    /** Direction of the message flow. */
     MessageWithReaction.Direction = {
         Inbound: "INBOUND",
         Outbound: "OUTBOUND",

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

@@ -1,11 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Type of messaging profile associated with the phone number.
- */
-export type MessagingProfileEnum = "TOLL_FREE" | "10DLC";
+/** Type of messaging profile associated with the phone number. */
 export declare const MessagingProfileEnum: {
     readonly TollFree: "TOLL_FREE";
     readonly TenDlc: "10DLC";
 };
+export type MessagingProfileEnum = (typeof MessagingProfileEnum)[keyof typeof MessagingProfileEnum];

package/dist/esm/api/types/MessagingProfileEnum.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.
+/** Type of messaging profile associated with the phone number. */
 export const MessagingProfileEnum = {
     TollFree: "TOLL_FREE",
     TenDlc: "10DLC",

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Message with text and/or media files from a phone number.
  */

package/dist/esm/api/types/MmsContent.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/MmsValidationResult.d.mts

@@ -1,6 +1,3 @@
-/**
- * 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;

package/dist/esm/api/types/MmsValidationResult.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/NotFoundErrorBody.d.mts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface NotFoundErrorBody {
     error?: string;
 }

package/dist/esm/api/types/NotFoundErrorBody.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/NumberFormat.d.mts

@@ -1,6 +1,3 @@
-/**
- * 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.

package/dist/esm/api/types/NumberFormat.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/OptInMethodEnum.d.mts

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

package/dist/esm/api/types/OptInMethodEnum.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.
+/** Opt in options. */
 export const OptInMethodEnum = {
     Digital: "DIGITAL",
     Paper: "PAPER",

package/dist/esm/api/types/OptionalBrandInfo.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 OptionalBrandInfo {
     /** Primary brand address where this brand is located. */
     address?: string;
@@ -18,6 +15,8 @@ export interface OptionalBrandInfo {
     name?: string;
     sector?: Pinnacle.CompanySectorEnum;
     type?: Pinnacle.CompanyTypeEnum;
+    /** Legal entity type of the brand. */
+    entityType?: Pinnacle.CompanyEntityTypeEnum;
     /** Brand website URL. */
     website?: string;
 }

package/dist/esm/api/types/OptionalBrandInfo.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/OptionalContact.d.mts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface OptionalContact {
     /** New notes or details for your contact. */
     description?: string | null;

package/dist/esm/api/types/OptionalContact.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/OptionalContacts.d.mts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Contact information for the primary brand representative.
  */

package/dist/esm/api/types/OptionalContacts.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/Pagination.d.mts

@@ -0,0 +1,10 @@
+export interface Pagination {
+    /** Current page number (1-indexed). */
+    page: number;
+    /** Items per page (max 100, default 50). */
+    limit: number;
+    /** Total number of contacts in the audience. */
+    total: number;
+    /** Whether more pages exist. */
+    hasMore: boolean;
+}

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Represents the communication capabilities available for a phone number.
  */

package/dist/esm/api/types/PhoneCapabilities.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/PhoneEnum.d.mts

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

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

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

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

@@ -1,12 +1,8 @@
-/**
- * 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";
@@ -17,3 +13,4 @@ export declare const PhoneFeatureEnum: {
     readonly InternationalSms: "INTERNATIONAL_SMS";
     readonly LocalCalling: "LOCAL_CALLING";
 };
+export type PhoneFeatureEnum = (typeof PhoneFeatureEnum)[keyof typeof PhoneFeatureEnum];

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

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

package/dist/esm/api/types/PhoneNumberDetails.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";
 /**
  * Details of a phone number available for purchase.
  * Includes all essential data required for acquisition and operational planning.

package/dist/esm/api/types/PhoneNumberDetails.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/PhoneNumberEnum.d.mts

@@ -1,12 +1,8 @@
-/**
- * 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";
@@ -17,3 +13,4 @@ export declare const PhoneNumberEnum: {
     readonly TollFree: "TOLL_FREE";
     readonly Unknown: "UNKNOWN";
 };
+export type PhoneNumberEnum = (typeof PhoneNumberEnum)[keyof typeof PhoneNumberEnum];

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

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

package/dist/esm/api/types/PhoneNumberStatus.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 phone number status.
  */

package/dist/esm/api/types/PhoneNumberStatus.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/PhoneNumberStatusEnum.d.mts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Current status of the phone number.
  *
@@ -8,9 +5,9 @@
  * `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";
 };
+export type PhoneNumberStatusEnum = (typeof PhoneNumberStatusEnum)[keyof typeof PhoneNumberStatusEnum];

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Current review status of the campaign. <br>
  *
@@ -12,10 +9,10 @@
  *
  * `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";
 };
+export type ProfileStatusEnum = (typeof ProfileStatusEnum)[keyof typeof ProfileStatusEnum];

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

@@ -1,5 +1,14 @@
+// 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 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.
  */
 export const ProfileStatusEnum = {
     Incomplete: "INCOMPLETE",

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

@@ -1,6 +1,3 @@
-/**
- * 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.

package/dist/esm/api/types/PurchasedNumber.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/RcsButtonCall.d.mts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Button that initiates a phone call when tapped by the recipient.
  */

package/dist/esm/api/types/RcsButtonCall.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 {};