rcs-js 2.0.19 → 2.0.21

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Numeric input with optional `min` / `max` bounds and `step` granularity.
+ */
+export interface NumberField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+    /** Minimum accepted value. */
+    min?: number;
+    /** Maximum accepted value. */
+    max?: number;
+    /** Increment between valid values. For example, `step: 0.5` lets the user enter 1, 1.5, 2, etc. */
+    step?: number;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Phone input. Client formats the value as the user types ("(555) 555-1212") and normalizes to E.164 ("+15555551212") before submission.
+ */
+export interface PhoneField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Single-select radio group.
+ */
+export interface RadioField extends Pinnacle.FieldBase {
+    /** Choices shown as radio buttons. At least one is required. */
+    options: Pinnacle.FormFieldOption[];
+}

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

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

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Slider input. `min`/`max` define the bounds, `step` the granularity.
+ */
+export interface RangeField extends Pinnacle.FieldBase {
+    /** Lower bound of the slider. */
+    min?: number;
+    /** Upper bound of the slider. */
+    max?: number;
+    /** Increment between adjacent slider stops. */
+    step?: number;
+}

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

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

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

@@ -0,0 +1,10 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Star rating 1..`max`. Submitted value is the selected integer.
+ */
+export interface RatingField extends Pinnacle.FieldBase {
+    /** Minimum allowed rating. `0` means the submitter can clear their selection. */
+    min?: number;
+    /** Number of stars rendered. */
+    max?: number;
+}

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

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

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

@@ -0,0 +1,20 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Response shape for a scheduled form send — returned in place of `SendFormResponse` when `options.schedule` is set.
+ */
+export interface ScheduledFormSendResult {
+    scheduleId: string;
+    config: Pinnacle.MessageSchedule;
+    form: ScheduledFormSendResult.Form;
+    submission: ScheduledFormSendResult.Submission;
+}
+export declare namespace ScheduledFormSendResult {
+    interface Form {
+        id: string;
+        name: string | null;
+    }
+    interface Submission {
+        id: string;
+        url: string;
+    }
+}

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

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

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

@@ -0,0 +1,10 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Single-select dropdown.
+ */
+export interface SelectField extends Pinnacle.FieldBase {
+    /** Choices shown in the dropdown. At least one is required. */
+    options: Pinnacle.FormFieldOption[];
+    /** Placeholder row shown when no option is selected (e.g. "Select…"). */
+    placeholder?: string;
+}

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

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

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

@@ -0,0 +1,18 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Optional delivery knobs shared by RCS and SMS sends.
+ */
+export interface SendFormOptions {
+    schedule?: Pinnacle.MessageSchedule;
+    /** RCS webview size for the open-url button action. Ignored for SMS. */
+    webview_mode?: SendFormOptions.WebviewMode;
+}
+export declare namespace SendFormOptions {
+    /** RCS webview size for the open-url button action. Ignored for SMS. */
+    const WebviewMode: {
+        readonly Full: "FULL";
+        readonly Half: "HALF";
+        readonly Tall: "TALL";
+    };
+    type WebviewMode = (typeof WebviewMode)[keyof typeof WebviewMode];
+}

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

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var SendFormOptions;
+(function (SendFormOptions) {
+    /** RCS webview size for the open-url button action. Ignored for SMS. */
+    SendFormOptions.WebviewMode = {
+        Full: "FULL",
+        Half: "HALF",
+        Tall: "TALL",
+    };
+})(SendFormOptions || (SendFormOptions = {}));

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

@@ -0,0 +1,9 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Send a form to a recipient over SMS or RCS in one call, or mint a standalone submission URL when `to` is omitted. Picks the SMS or RCS branch based on the shape of `from` (agent_* → RCS, E.164 → SMS).
+ *
+ * When `to` is provided, Pinnacle dispatches the message immediately and the recipient is recorded on the response (`submission.to` is set to the same E.164 number, and `message_id` is the id of the outbound SMS/RCS).
+ *
+ * When `to` is omitted, no message is sent — `submission.to` and `message_id` are both `null` and only the submission URL is returned.
+ */
+export type SendFormParams = Pinnacle.SendFormViaRcsParams | Pinnacle.SendFormViaSmsParams;

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

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

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

@@ -0,0 +1,13 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Successful `POST /forms/send` response.
+ *
+ * - When `to` was provided in the request, the message was dispatched: `submission.to` echoes that recipient and `message_id` is the id of the outbound SMS/RCS that carried the URL.
+ * - When `to` was omitted, no message was sent: both `submission.to` and `message_id` are `null` and only the submission URL is returned.
+ */
+export interface SendFormResult {
+    form: Pinnacle.Form;
+    submission: Pinnacle.FormSubmission;
+    /** Id of the outbound SMS/RCS message that delivered the URL. Null when the send was URL-only (no `to`). */
+    message_id: string | null;
+}

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

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

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

@@ -0,0 +1,28 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Send a form from an RCS agent. `from` must be an `agent_*` id.
+ */
+export interface SendFormViaRcsParams {
+    /** RCS agent id (`agent_*`). */
+    from: string;
+    /** Recipient phone in E.164. When present Pinnacle delivers the form URL via RCS (or the configured fallback) and FORM.SUBMISSION fires with `submission.to` populated. When omitted the call returns a submission URL without dispatching any message and the webhook later fires with `submission.to: null`. */
+    to?: string;
+    /** Existing form id or an inline definition that mints a new form for this send. */
+    form: SendFormViaRcsParams.Form;
+    /** When RCS is unavailable on the recipient's device, fall back to SMS from this number. Requires `to`. */
+    fallback?: SendFormViaRcsParams.Fallback;
+    options?: Pinnacle.SendFormOptions;
+}
+export declare namespace SendFormViaRcsParams {
+    /**
+     * Existing form id or an inline definition that mints a new form for this send.
+     */
+    type Form = Pinnacle.FormIdReference | Pinnacle.FormDefinition;
+    /**
+     * When RCS is unavailable on the recipient's device, fall back to SMS from this number. Requires `to`.
+     */
+    interface Fallback {
+        /** SMS phone in E.164 to deliver from when the recipient can't receive RCS. */
+        from: string;
+    }
+}

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

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

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

@@ -0,0 +1,15 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Send a form from a phone number. `from` must be an E.164 phone.
+ */
+export interface SendFormViaSmsParams {
+    /** Sender phone in E.164. */
+    from: string;
+    /** Recipient phone in E.164. Omit to mint a URL-only form without sending a message. */
+    to?: string;
+    form: SendFormViaSmsParams.Form;
+    options?: Pinnacle.SendFormOptions;
+}
+export declare namespace SendFormViaSmsParams {
+    type Form = Pinnacle.FormIdReference | Pinnacle.FormDefinition;
+}

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

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

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Single-line text input with optional length bounds and regex pattern.
+ */
+export interface TextField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+    /** Regex the value must match. Validated server-side with RE2, so patterns that enable catastrophic backtracking (backreferences, lookarounds) are rejected at form creation. */
+    pattern?: string;
+    /** Minimum number of characters the submitter must enter. */
+    min_length?: number;
+    /** Maximum number of characters the submitter may enter. */
+    max_length?: number;
+}

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

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

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Multi-line text input for longer free-form answers.
+ */
+export interface TextareaField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+    /** Regex the value must match. Same RE2 safety check as `TextField.pattern`. */
+    pattern?: string;
+    /** Minimum number of characters the submitter must enter. */
+    min_length?: number;
+    /** Maximum number of characters the submitter may enter. */
+    max_length?: number;
+}

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

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

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Time picker. `min`/`max` accept `HH:MM` (24-hour).
+ */
+export interface TimeField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+    /** Earliest selectable time as `HH:MM` (24-hour). */
+    min?: string;
+    /** Latest selectable time as `HH:MM` (24-hour). */
+    max?: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * URL input. Server requires a valid absolute URL.
+ */
+export interface UrlField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+}

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

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

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

@@ -14,8 +14,11 @@ export declare namespace UserEvent {
      * Conversation metadata containing the conversation ID, sender, and recipient information.
      */
     interface Conversation {
-        /** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
-        id: number;
+        /**
+         * Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
+         * To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint.
+         */
+        id: string;
         /** Phone number of the user who triggered the event. */
         from: string;
         /** Agent ID that the user is interacting with. */

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

@@ -0,0 +1,12 @@
+/**
+ * Status of an RCS agent's verification with a verifier (AEGIS or Google).
+ *   - `NOT_SENT` — verification email not sent yet
+ *   - `SENT` — sent (awaiting reply on the brand contact email)
+ *   - `VERIFIED` — verified
+ */
+export declare const VerificationStatus: {
+    readonly NotSent: "NOT_SENT";
+    readonly Sent: "SENT";
+    readonly Verified: "VERIFIED";
+};
+export type VerificationStatus = (typeof VerificationStatus)[keyof typeof VerificationStatus];

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

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+/**
+ * Status of an RCS agent's verification with a verifier (AEGIS or Google).
+ *   - `NOT_SENT` — verification email not sent yet
+ *   - `SENT` — sent (awaiting reply on the brand contact email)
+ *   - `VERIFIED` — verified
+ */
+export const VerificationStatus = {
+    NotSent: "NOT_SENT",
+    Sent: "SENT",
+    Verified: "VERIFIED",
+};

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

@@ -7,5 +7,7 @@ export declare const WebhookEventEnum: {
     readonly MessageStatus: "MESSAGE.STATUS";
     readonly MessageReceived: "MESSAGE.RECEIVED";
     readonly UserTyping: "USER.TYPING";
+    readonly FormSubmission: "FORM.SUBMISSION";
+    readonly CampaignStatus: "CAMPAIGN.STATUS";
 };
 export type WebhookEventEnum = (typeof WebhookEventEnum)[keyof typeof WebhookEventEnum];

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

@@ -8,4 +8,6 @@ export const WebhookEventEnum = {
     MessageStatus: "MESSAGE.STATUS",
     MessageReceived: "MESSAGE.RECEIVED",
     UserTyping: "USER.TYPING",
+    FormSubmission: "FORM.SUBMISSION",
+    CampaignStatus: "CAMPAIGN.STATUS",
 };

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

@@ -1,3 +1,4 @@
+export * from "./AddressField.mjs";
 export * from "./AdvancedPhoneInformation.mjs";
 export * from "./AgentEmailEntry.mjs";
 export * from "./AgentPhoneEntry.mjs";
@@ -22,10 +23,17 @@ export * from "./ButtonClicked.mjs";
 export * from "./ButtonClickedData.mjs";
 export * from "./CampaignEnum.mjs";
 export * from "./CampaignQuery.mjs";
+export * from "./CampaignStatusEvent.mjs";
+export * from "./CampaignStatusEventAgent.mjs";
+export * from "./CampaignStatusEventBrand.mjs";
+export * from "./CampaignStatusEventCampaign.mjs";
+export * from "./CampaignStatusEventCarrierLaunches.mjs";
 export * from "./CampaignSubmissionResult.mjs";
 export * from "./CampaignValidationResult.mjs";
 export * from "./CarrierLaunches.mjs";
 export * from "./CarrierLaunchStatus.mjs";
+export * from "./CheckboxField.mjs";
+export * from "./ColorField.mjs";
 export * from "./CompanyEntityTypeEnum.mjs";
 export * from "./CompanySectorEnum.mjs";
 export * from "./CompanyTypeEnum.mjs";
@@ -33,7 +41,10 @@ export * from "./Contact.mjs";
 export * from "./ContactId.mjs";
 export * from "./Conversation.mjs";
 export * from "./ConversationList.mjs";
+export * from "./CreateFormRequest.mjs";
 export * from "./CreateUrlOptions.mjs";
+export * from "./DateField.mjs";
+export * from "./DatetimeField.mjs";
 export * from "./DeleteAudienceResponse.mjs";
 export * from "./DetachedPhoneNumberResult.mjs";
 export * from "./DetachWebhookResult.mjs";
@@ -43,6 +54,7 @@ export * from "./DlcCampaignStatus.mjs";
 export * from "./DlcCampaignSummary.mjs";
 export * from "./DlcCampaignUseCaseEnum.mjs";
 export * from "./DlcCampaignWithExtendedBrandAndStatus.mjs";
+export * from "./EmailField.mjs";
 export * from "./EnhancedContact.mjs";
 export * from "./EnhancedContactItem.mjs";
 export * from "./Error_.mjs";
@@ -51,6 +63,27 @@ export * from "./ExtendedBrandWithVetting.mjs";
 export * from "./ExtendedRcsCampaign.mjs";
 export * from "./FailedSender.mjs";
 export * from "./FallbackMessage.mjs";
+export * from "./FieldBase.mjs";
+export * from "./Form.mjs";
+export * from "./FormBackground.mjs";
+export * from "./FormBackgroundGradient.mjs";
+export * from "./FormBackgroundImage.mjs";
+export * from "./FormBackgroundPattern.mjs";
+export * from "./FormBackgroundSolid.mjs";
+export * from "./FormColorPalette.mjs";
+export * from "./FormDefinition.mjs";
+export * from "./FormField.mjs";
+export * from "./FormFieldOption.mjs";
+export * from "./FormGradient.mjs";
+export * from "./FormIdReference.mjs";
+export * from "./FormSubmission.mjs";
+export * from "./FormSubmissionAnswer.mjs";
+export * from "./FormSubmissionEvent.mjs";
+export * from "./FormSubmissionEventConversation.mjs";
+export * from "./FormSubmissionEventForm.mjs";
+export * from "./FormSubmissionEventSubmission.mjs";
+export * from "./FormSubmittedField.mjs";
+export * from "./FormThemeOverride.mjs";
 export * from "./GetConversationParams.mjs";
 export * from "./LinkClickEvent.mjs";
 export * from "./LinkSummary.mjs";
@@ -60,6 +93,8 @@ export * from "./ListBlastsResponse.mjs";
 export * from "./ListBrandsResponse.mjs";
 export * from "./ListContactsResponse.mjs";
 export * from "./ListDlcCampaignsResponse.mjs";
+export * from "./ListFormSubmissionsResponse.mjs";
+export * from "./ListFormsResponse.mjs";
 export * from "./ListLinksResponse.mjs";
 export * from "./ListMessagesResponse.mjs";
 export * from "./ListPhoneNumbersResponse.mjs";
@@ -92,6 +127,7 @@ export * from "./MessagingProfileEnum.mjs";
 export * from "./MmsContent.mjs";
 export * from "./MmsValidationResult.mjs";
 export * from "./NotFoundErrorBody.mjs";
+export * from "./NumberField.mjs";
 export * from "./NumberFormat.mjs";
 export * from "./OptInMethodEnum.mjs";
 export * from "./OptionalBrandInfo.mjs";
@@ -102,12 +138,16 @@ export * from "./Pagination.mjs";
 export * from "./PhoneCapabilities.mjs";
 export * from "./PhoneEnum.mjs";
 export * from "./PhoneFeatureEnum.mjs";
+export * from "./PhoneField.mjs";
 export * from "./PhoneNumberDetails.mjs";
 export * from "./PhoneNumberEnum.mjs";
 export * from "./PhoneNumberStatus.mjs";
 export * from "./PhoneNumberStatusEnum.mjs";
 export * from "./ProfileStatusEnum.mjs";
 export * from "./PurchasedNumber.mjs";
+export * from "./RadioField.mjs";
+export * from "./RangeField.mjs";
+export * from "./RatingField.mjs";
 export * from "./RcsAgentDetails.mjs";
 export * from "./RcsAgentResponse.mjs";
 export * from "./RcsButtonCall.mjs";
@@ -141,9 +181,16 @@ export * from "./RichText.mjs";
 export * from "./RichTextMessage.mjs";
 export * from "./ScheduleCancelResult.mjs";
 export * from "./ScheduledBlastDetails.mjs";
+export * from "./ScheduledFormSendResult.mjs";
 export * from "./ScheduledMessage.mjs";
 export * from "./ScheduledMessageSummary.mjs";
+export * from "./SelectField.mjs";
 export * from "./Sender.mjs";
+export * from "./SendFormOptions.mjs";
+export * from "./SendFormParams.mjs";
+export * from "./SendFormResult.mjs";
+export * from "./SendFormViaRcsParams.mjs";
+export * from "./SendFormViaSmsParams.mjs";
 export * from "./SendRichMessageOptions4.mjs";
 export * from "./SendTypingIndicatorResponse.mjs";
 export * from "./SentMmsDetails.mjs";
@@ -165,6 +212,9 @@ export * from "./SubUseCaseEnum.mjs";
 export * from "./SuccessfulConversationUpdate.mjs";
 export * from "./TestAgentResponse.mjs";
 export * from "./TestAgentWhitelistResponse.mjs";
+export * from "./TextareaField.mjs";
+export * from "./TextField.mjs";
+export * from "./TimeField.mjs";
 export * from "./TollFreeCampaign.mjs";
 export * from "./TollFreeCampaignStatus.mjs";
 export * from "./TollFreeCampaignSummary.mjs";
@@ -174,6 +224,7 @@ export * from "./TollFreeStatusEnum.mjs";
 export * from "./Tracking.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./UploadResults.mjs";
+export * from "./UrlField.mjs";
 export * from "./UserButtonPress.mjs";
 export * from "./UserButtonPressCall.mjs";
 export * from "./UserButtonPressOpenUrl.mjs";
@@ -192,6 +243,7 @@ export * from "./VcardContent.mjs";
 export * from "./VcardEmail.mjs";
 export * from "./VcardPhone.mjs";
 export * from "./VcardResource.mjs";
+export * from "./VerificationStatus.mjs";
 export * from "./VettingFeedback.mjs";
 export * from "./VettingHistory.mjs";
 export * from "./VettingResults.mjs";