rcs-js 2.0.19 → 2.0.21

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

@@ -0,0 +1,19 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Background layer for the form page. Discriminated by `type`.
+ */
+export type FormBackground = Pinnacle.FormBackground.Solid | Pinnacle.FormBackground.Gradient | Pinnacle.FormBackground.Image | Pinnacle.FormBackground.Pattern;
+export declare namespace FormBackground {
+    interface Solid extends Pinnacle.FormBackgroundSolid {
+        type: "solid";
+    }
+    interface Gradient extends Pinnacle.FormBackgroundGradient {
+        type: "gradient";
+    }
+    interface Image extends Pinnacle.FormBackgroundImage {
+        type: "image";
+    }
+    interface Pattern extends Pinnacle.FormBackgroundPattern {
+        type: "pattern";
+    }
+}

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

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

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

@@ -0,0 +1,10 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Two-stop linear gradient. Supply separate light- and dark-mode gradients; the renderer picks based on `theme_mode`.
+ */
+export interface FormBackgroundGradient {
+    /** Gradient used when the form renders in light mode. */
+    light: Pinnacle.FormGradient;
+    /** Gradient used when the form renders in dark mode. */
+    dark: Pinnacle.FormGradient;
+}

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * Image background. The image is tiled or scaled across the page with optional blur and dark tint overlay.
+ */
+export interface FormBackgroundImage {
+    /** HTTPS URL of the background image. Must start with `https://`. */
+    url: string;
+    /** Darkening overlay intensity from 0 (no overlay) to 80 (heavy). Helps preserve text contrast over busy images. */
+    tint_opacity: number;
+    /** When true, blurs the background image. */
+    blur: boolean;
+    /** Scale percentage. 100 is native size; higher values crop the image tighter. */
+    zoom: number;
+}

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * Subtle repeating SVG pattern tinted by the palette's foreground color.
+ */
+export interface FormBackgroundPattern {
+    /** Which built-in pattern to render. */
+    preset: FormBackgroundPattern.Preset;
+}
+export declare namespace FormBackgroundPattern {
+    /** Which built-in pattern to render. */
+    const Preset: {
+        readonly Noise: "noise";
+        readonly Dots: "dots";
+        readonly Mesh: "mesh";
+        readonly Grid: "grid";
+        readonly Waves: "waves";
+        readonly Topo: "topo";
+    };
+    type Preset = (typeof Preset)[keyof typeof Preset];
+}

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

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+export var FormBackgroundPattern;
+(function (FormBackgroundPattern) {
+    /** Which built-in pattern to render. */
+    FormBackgroundPattern.Preset = {
+        Noise: "noise",
+        Dots: "dots",
+        Mesh: "mesh",
+        Grid: "grid",
+        Waves: "waves",
+        Topo: "topo",
+    };
+})(FormBackgroundPattern || (FormBackgroundPattern = {}));

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

@@ -0,0 +1,24 @@
+/**
+ * No background effect — the form page is filled with a single flat color. The color itself isn't specified on this object; it's read from the sibling `colors` field on the same `theme_override` object (i.e. `theme_override.colors.light.background` in light mode, `theme_override.colors.dark.background` in dark mode). If you don't override `colors`, the color falls back to the one your team has configured in the [Pinnacle Dashboard](https://app.pinnacle.sh/dashboard/forms).
+ *
+ * Complete example — a POST `/forms` body that sets a white form in light mode and near-black in dark mode with no background effect:
+ *
+ * ```json
+ * {
+ *   "name": "Contact request",
+ *   "fields": [
+ *     { "type": "text", "key": "full_name", "label": "Full name", "required": true }
+ *   ],
+ *   "theme_override": {
+ *     "background": { "type": "solid" },
+ *     "colors": {
+ *       "light": { "background": "#ffffff" },
+ *       "dark":  { "background": "#0a0a0a" }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * Pick `solid` when you want a clean one-color page with no gradient / image / pattern overlay. Use `gradient`, `image`, or `pattern` instead when you want something layered on top of the base color.
+ */
+export type FormBackgroundSolid = {};

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Per-mode palette. All three colors are optional; any you omit fall back to the team default for that mode.
+ */
+export interface FormColorPalette {
+    /** Accent color used for the submit button, focus rings, filled checkboxes, and other interactive surfaces. */
+    primary?: string;
+    /** Page background color. Fallback solid color used by Safari chrome tinting and safe-area regions. */
+    background?: string;
+    /** Body text and label color. */
+    text?: string;
+}

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

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

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

@@ -0,0 +1,18 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * The minimum shape needed to create a form. Used by `POST /forms` and inline by `POST /forms/send`.
+ */
+export interface FormDefinition {
+    /** Human-readable name for the form. Rendered as the form's title. */
+    name?: string;
+    /** Longer description rendered below the title. */
+    description?: string;
+    /** Ordered list of fields the recipient will fill out. At least one field is required. */
+    fields: Pinnacle.FormField[];
+    /** If true, the recipient can reopen the submission URL and edit their answers. When false (default), the submission URL becomes read-only (`Already submitted`) after the first submit. */
+    can_update?: boolean;
+    /** After this timestamp the form stops accepting submissions. Omit for no expiration. */
+    expires_at?: string;
+    /** Per-form theme tweaks layered on top of your team's default theme. Omit or set to null to use team defaults. */
+    theme_override?: Pinnacle.FormThemeOverride | null;
+}

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

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

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

@@ -0,0 +1,55 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * A single field definition inside a form. Discriminated by `type`.
+ */
+export type FormField = Pinnacle.FormField.Text | Pinnacle.FormField.Textarea | Pinnacle.FormField.Address | Pinnacle.FormField.Email | Pinnacle.FormField.Url | Pinnacle.FormField.Phone | Pinnacle.FormField.Number | Pinnacle.FormField.Range | Pinnacle.FormField.Rating | Pinnacle.FormField.Date_ | Pinnacle.FormField.Time | Pinnacle.FormField.Datetime | Pinnacle.FormField.Color | Pinnacle.FormField.Select | Pinnacle.FormField.Radio | Pinnacle.FormField.Checkbox;
+export declare namespace FormField {
+    interface Text extends Pinnacle.TextField {
+        type: "text";
+    }
+    interface Textarea extends Pinnacle.TextareaField {
+        type: "textarea";
+    }
+    interface Address extends Pinnacle.AddressField {
+        type: "address";
+    }
+    interface Email extends Pinnacle.EmailField {
+        type: "email";
+    }
+    interface Url extends Pinnacle.UrlField {
+        type: "url";
+    }
+    interface Phone extends Pinnacle.PhoneField {
+        type: "phone";
+    }
+    interface Number extends Pinnacle.NumberField {
+        type: "number";
+    }
+    interface Range extends Pinnacle.RangeField {
+        type: "range";
+    }
+    interface Rating extends Pinnacle.RatingField {
+        type: "rating";
+    }
+    interface Date_ extends Pinnacle.DateField {
+        type: "date";
+    }
+    interface Time extends Pinnacle.TimeField {
+        type: "time";
+    }
+    interface Datetime extends Pinnacle.DatetimeField {
+        type: "datetime";
+    }
+    interface Color extends Pinnacle.ColorField {
+        type: "color";
+    }
+    interface Select extends Pinnacle.SelectField {
+        type: "select";
+    }
+    interface Radio extends Pinnacle.RadioField {
+        type: "radio";
+    }
+    interface Checkbox extends Pinnacle.CheckboxField {
+        type: "checkbox";
+    }
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * A single choice inside a `select`, `radio`, or `checkbox` field.
+ */
+export interface FormFieldOption {
+    /** Machine value sent back in the submission payload. */
+    value: string;
+    /** Human label rendered in the form. */
+    label: string;
+}

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * A single light- or dark-mode gradient stop pair.
+ */
+export interface FormGradient {
+    /** Starting color of the gradient. */
+    from: string;
+    /** Ending color of the gradient. */
+    to: string;
+    /** Direction the gradient runs. `top-bottom` is vertical; `diagonal` runs top-left → bottom-right. */
+    angle: FormGradient.Angle;
+}
+export declare namespace FormGradient {
+    /** Direction the gradient runs. `top-bottom` is vertical; `diagonal` runs top-left → bottom-right. */
+    const Angle: {
+        readonly TopBottom: "top-bottom";
+        readonly Diagonal: "diagonal";
+    };
+    type Angle = (typeof Angle)[keyof typeof Angle];
+}

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var FormGradient;
+(function (FormGradient) {
+    /** Direction the gradient runs. `top-bottom` is vertical; `diagonal` runs top-left → bottom-right. */
+    FormGradient.Angle = {
+        TopBottom: "top-bottom",
+        Diagonal: "diagonal",
+    };
+})(FormGradient || (FormGradient = {}));

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

@@ -0,0 +1,4 @@
+/**
+ * Existing form id (`form_*`) to reuse.
+ */
+export type FormIdReference = string;

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

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

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

@@ -0,0 +1,34 @@
+/**
+ * A single submission against a form.
+ */
+export interface FormSubmission {
+    /** Submission id (starts with `fsub_`). */
+    id: string;
+    /** Public submission URL (`https://forms.pinnacle.sh/{submission_id}`) — the unguessable credential used by the recipient to fill out the form. */
+    url: string;
+    /** Id of the form this submission belongs to (starts with `form_`). */
+    form_id: string;
+    /** Sender identifier — E.164 phone number or RCS agent id. Null if the sender could no longer be resolved (e.g. the phone number or agent was deleted after the submission). */
+    from: string | null;
+    /** Recipient phone number (E.164). Null for URL-only sends (`to` was omitted at send time). */
+    to: string | null;
+    /**
+     * Submitted answers keyed by field `key`. Null if the submission has not been completed yet.
+     *
+     * Each value's shape depends on the field type:
+     * - `text`, `email`, `phone`, `url`, `textarea`, `select`, `radio` → string
+     * - `number` → number
+     * - `checkbox` (single) → boolean
+     * - `checkbox` (multi), `multiselect` → array of strings
+     * - Skipped optional field → null
+     */
+    data: Record<string, unknown> | null;
+    /** IP address the submission was POSTed from. Null for pending submissions. */
+    ip_address: string | null;
+    /** User-Agent header of the browser that submitted the form. Null for pending submissions. */
+    user_agent: string | null;
+    /** Timestamp of completion. Null for pending submissions; updated on each edit of a `can_update=true` submission. */
+    submitted_at: string | null;
+    /** Timestamp of when the submission URL was minted. */
+    created_at: string;
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * The value submitted for a single form field. Shape depends on the field type:
+ * - `text`, `email`, `phone`, `url`, `textarea`, `select`, `radio` → string
+ * - `number` → number
+ * - `checkbox` (single) → boolean
+ * - `checkbox` (multi), `multiselect` → array of strings
+ * - Skipped optional field → null
+ */
+export type FormSubmissionAnswer = string | number | boolean | string[];

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

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

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Webhook body delivered to subscribers of `FORM.SUBMISSION` after a recipient completes a form. Verify the `PINNACLE-SIGNING-SECRET` header matches your webhook's signing secret before trusting the payload.
+ */
+export interface FormSubmissionEvent {
+    type: "FORM.SUBMISSION";
+    /** Top-level sender identifier — same value as `submission.from`. Exposed at the event root so you can route on it without digging into the submission object. */
+    sender: string;
+    conversation: Pinnacle.FormSubmissionEventConversation | null;
+    form: Pinnacle.FormSubmissionEventForm;
+    submission: Pinnacle.FormSubmissionEventSubmission;
+}

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * Conversation between the sender and the recipient the form was delivered to. Only populated when the form was dispatched via `POST /forms/send` with a `to` recipient — that's the only call that opens a conversation tied to a form submission.
+ *
+ * Null in every other case, including:
+ * - `POST /forms/send` without a `to` (URL-only mints — no message is sent, so no conversation exists).
+ * - Submissions to a form whose URL was shared by any other means (e.g. an RCS card built with `POST /send`, a chat message, a marketing email, or a link on your site). The recipient isn't tied to a Pinnacle conversation in those flows.
+ */
+export interface FormSubmissionEventConversation {
+    /** Conversation public id (`convo_*`). */
+    id: string;
+    /** Sender identifier on the conversation — the RCS agent id (`agent_*`) or E.164 phone number that sent the form. */
+    from: string;
+    /** Recipient phone number (E.164) the form was delivered to. */
+    to: string;
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Form summary carried on the FORM.SUBMISSION event.
+ */
+export interface FormSubmissionEventForm {
+    /** Form id the submission belongs to (starts with `form_`). */
+    id: string;
+    /** Public shareable URL of the form (`https://forms.pinnacle.sh/{form_id}`). */
+    url: string;
+    /** Human-readable name of the form. Null if the form was created without a name. */
+    name: string | null;
+}

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

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

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

@@ -0,0 +1,31 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * The submitted answers plus a resolved snapshot of each form field.
+ */
+export interface FormSubmissionEventSubmission {
+    /** Submission id (starts with `fsub_`). Uniquely identifies this submission. */
+    id: string;
+    /** Sender identifier that originally sent this form — RCS agent id (`agent_*`) or E.164 phone number. */
+    from: string;
+    /** Recipient phone number (E.164) the form was delivered to. Null for URL-only sends where `to` was omitted at send time. */
+    to: string | null;
+    /**
+     * Submitted answers keyed by field `key`.
+     *
+     * Each value's shape depends on the field type:
+     * - `text`, `email`, `phone`, `url`, `textarea`, `select`, `radio` → string
+     * - `number` → number
+     * - `checkbox` (single) → boolean
+     * - `checkbox` (multi), `multiselect` → array of strings
+     * - Skipped optional field → null
+     */
+    data: Record<string, unknown>;
+    /** Resolved snapshot of the form definition paired with the submitted value — ready to render without a separate `get_form` call. */
+    fields: Pinnacle.FormSubmittedField[];
+    /** IP address the submission was POSTed from. Null if unavailable. */
+    ip_address: string | null;
+    /** User-Agent header of the browser that submitted the form. Null if unavailable. */
+    user_agent: string | null;
+    /** ISO 8601 timestamp of when the submission was completed. Updated on each edit for `can_update: true` forms. */
+    submitted_at: string;
+}

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

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

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Snapshot of a single form field paired with the value the recipient submitted.
+ */
+export interface FormSubmittedField {
+    /** Programmatic key of the field from the form definition. */
+    key: string;
+    /** Label as shown to the recipient when they filled out the form. */
+    label: string;
+    /** The field type from the form definition (e.g. `text`, `select`, `checkbox`). */
+    type: string;
+    /** The value submitted for this field. */
+    value: Pinnacle.FormSubmissionAnswer | null;
+}

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

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

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

@@ -0,0 +1,77 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Sparse override layered on top of your team's theme. Every field is optional; provided fields replace the corresponding team defaults at render time. URL fields must use `https://`.
+ */
+export interface FormThemeOverride {
+    /** Logo displayed at the top of the form. Square images render as an inline mark; wide landscape images render as a full-width banner. */
+    logo_url?: string | null;
+    /** Favicon shown in the browser tab when the form page loads. */
+    favicon_url?: string | null;
+    /** Rendering mode. `light` forces the light palette, `dark` forces dark, and `auto` follows the respondent's OS-level appearance setting. */
+    theme_mode?: FormThemeOverride.ThemeMode;
+    /** Per-mode palette overrides. Each mode is an object with optional `primary`, `background`, and `text` hex colors. Omit a mode to inherit the team default for it. */
+    colors?: FormThemeOverride.Colors;
+    /** Typeface stack. `system` uses the respondent's OS default sans-serif. */
+    font_family?: FormThemeOverride.FontFamily;
+    /** Border-radius preset for cards, inputs, and buttons. */
+    corner_radius?: FormThemeOverride.CornerRadius;
+    /** Horizontal alignment for the form header (title, description, logo). */
+    content_alignment?: FormThemeOverride.ContentAlignment;
+    /** Background layer for the page. Choose solid, gradient, image, or a built-in pattern. */
+    background?: Pinnacle.FormBackground;
+    /** Text shown on the submit button. Defaults to `Submit`. */
+    submit_button_label?: string;
+    /** Message shown on the success panel after a successful submit (unless `redirect_url` is set, in which case the respondent is redirected). */
+    success_message?: string;
+    /** When set, the submitter is redirected here after a successful submit instead of seeing the success panel. */
+    redirect_url?: string | null;
+    /** Link target for the `Privacy` footer link. Omit or set to null to hide the link. */
+    privacy_url?: string | null;
+    /** Link target for the `Terms` footer link. Omit or set to null to hide the link. */
+    terms_url?: string | null;
+    /** Image shown when the form URL is shared in social / messaging link previews (Open Graph). */
+    og_image_url?: string | null;
+    /** Open Graph description used in link previews. Falls back to the form's `description` when unset. */
+    og_description?: string | null;
+}
+export declare namespace FormThemeOverride {
+    /** Rendering mode. `light` forces the light palette, `dark` forces dark, and `auto` follows the respondent's OS-level appearance setting. */
+    const ThemeMode: {
+        readonly Light: "light";
+        readonly Dark: "dark";
+        readonly Auto: "auto";
+    };
+    type ThemeMode = (typeof ThemeMode)[keyof typeof ThemeMode];
+    /**
+     * Per-mode palette overrides. Each mode is an object with optional `primary`, `background`, and `text` hex colors. Omit a mode to inherit the team default for it.
+     */
+    interface Colors {
+        /** Palette used when the form renders in light mode. */
+        light?: Pinnacle.FormColorPalette;
+        /** Palette used when the form renders in dark mode. */
+        dark?: Pinnacle.FormColorPalette;
+    }
+    /** Typeface stack. `system` uses the respondent's OS default sans-serif. */
+    const FontFamily: {
+        readonly Inter: "inter";
+        readonly System: "system";
+        readonly Serif: "serif";
+        readonly Mono: "mono";
+        readonly Rounded: "rounded";
+    };
+    type FontFamily = (typeof FontFamily)[keyof typeof FontFamily];
+    /** Border-radius preset for cards, inputs, and buttons. */
+    const CornerRadius: {
+        readonly Sharp: "sharp";
+        readonly Rounded: "rounded";
+        readonly Pill: "pill";
+    };
+    type CornerRadius = (typeof CornerRadius)[keyof typeof CornerRadius];
+    /** Horizontal alignment for the form header (title, description, logo). */
+    const ContentAlignment: {
+        readonly Left: "left";
+        readonly Center: "center";
+        readonly Right: "right";
+    };
+    type ContentAlignment = (typeof ContentAlignment)[keyof typeof ContentAlignment];
+}

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

@@ -0,0 +1,30 @@
+// This file was auto-generated by Fern from our API Definition.
+export var FormThemeOverride;
+(function (FormThemeOverride) {
+    /** Rendering mode. `light` forces the light palette, `dark` forces dark, and `auto` follows the respondent's OS-level appearance setting. */
+    FormThemeOverride.ThemeMode = {
+        Light: "light",
+        Dark: "dark",
+        Auto: "auto",
+    };
+    /** Typeface stack. `system` uses the respondent's OS default sans-serif. */
+    FormThemeOverride.FontFamily = {
+        Inter: "inter",
+        System: "system",
+        Serif: "serif",
+        Mono: "mono",
+        Rounded: "rounded",
+    };
+    /** Border-radius preset for cards, inputs, and buttons. */
+    FormThemeOverride.CornerRadius = {
+        Sharp: "sharp",
+        Rounded: "rounded",
+        Pill: "pill",
+    };
+    /** Horizontal alignment for the form header (title, description, logo). */
+    FormThemeOverride.ContentAlignment = {
+        Left: "left",
+        Center: "center",
+        Right: "right",
+    };
+})(FormThemeOverride || (FormThemeOverride = {}));

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Paginated page of submissions for a form.
+ */
+export interface ListFormSubmissionsResponse {
+    /** Submissions on this page, newest first. */
+    data: Pinnacle.FormSubmission[];
+    /** True if there are more pages after this one. Fetch the next page by incrementing `pageIndex`. */
+    hasMore: boolean;
+    /** Number of submissions returned in `data`. */
+    count: number;
+}

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

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

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Paginated page of forms.
+ */
+export interface ListFormsResponse {
+    /** Forms on this page, newest first. */
+    data: Pinnacle.Form[];
+    /** True if there are more pages after this one. Fetch the next page by incrementing `pageIndex`. */
+    hasMore: boolean;
+    /** Number of forms returned in `data`. Always equals `data.length`. */
+    count: number;
+}

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

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

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

@@ -3,8 +3,8 @@ import type * as Pinnacle from "../index.mjs";
  * Represents an incoming message or message status update received via webhook.
  */
 export interface MessageEvent {
-    /** Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages. */
-    type: Pinnacle.WebhookEventEnum;
+    /** Type of webhook event. `MESSAGE.STATUS` for message status updates, `MESSAGE.RECEIVED` for inbound messages. */
+    type: MessageEvent.Type;
     /** Conversation metadata containing the conversation ID, sender, and recipient information. */
     conversation: MessageEvent.Conversation;
     status: Pinnacle.MessageStatusEnum;
@@ -39,6 +39,12 @@ export interface MessageEvent {
     fallbackMessage?: MessageEvent.FallbackMessage | null;
 }
 export declare namespace MessageEvent {
+    /** Type of webhook event. `MESSAGE.STATUS` for message status updates, `MESSAGE.RECEIVED` for inbound messages. */
+    const Type: {
+        readonly MessageStatus: "MESSAGE.STATUS";
+        readonly MessageReceived: "MESSAGE.RECEIVED";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
     /**
      * Conversation metadata containing the conversation ID, sender, and recipient information.
      */

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

@@ -1,6 +1,11 @@
 // This file was auto-generated by Fern from our API Definition.
 export var MessageEvent;
 (function (MessageEvent) {
+    /** Type of webhook event. `MESSAGE.STATUS` for message status updates, `MESSAGE.RECEIVED` for inbound messages. */
+    MessageEvent.Type = {
+        MessageStatus: "MESSAGE.STATUS",
+        MessageReceived: "MESSAGE.RECEIVED",
+    };
     /** Direction of the message flow. */
     MessageEvent.Direction = {
         Inbound: "INBOUND",