rcs-js 2.0.19 → 2.0.21

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Native color picker. Submitted value is a 6-digit hex string like `#ff6b35`.
+ */
+export interface ColorField extends Pinnacle.FieldBase {
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,5 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Body of `POST /forms`. Same shape as `FormDefinition`.
+ */
+export type CreateFormRequest = Pinnacle.FormDefinition;

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Date picker. `min`/`max` accept `YYYY-MM-DD`.
+ */
+export interface DateField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+    /** Earliest selectable date as `YYYY-MM-DD`. */
+    min?: string;
+    /** Latest selectable date as `YYYY-MM-DD`. */
+    max?: string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Local-datetime picker. `min`/`max` accept ISO 8601 timestamps.
+ */
+export interface DatetimeField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+    /** Earliest selectable instant as an ISO 8601 timestamp. */
+    min?: string;
+    /** Latest selectable instant as an ISO 8601 timestamp. */
+    max?: string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * Email input. Server rejects values that fail RFC 5322 validation.
+ */
+export interface EmailField extends Pinnacle.FieldBase {
+    /** Ghost text shown inside the input while it's empty. */
+    placeholder?: string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+/**
+ * Properties shared by every field variant. Not intended to be referenced directly — use a specific field type from `FormField`.
+ */
+export interface FieldBase {
+    /** Programmatic key used as the property name in the submission payload. Must start with a letter or underscore; letters, digits, and underscores only. */
+    key: string;
+    /** Text shown above the input. */
+    label: string;
+    /** When true, the submitter must provide a value. Default false. */
+    required?: boolean;
+    /** Small caption rendered under the input to give the submitter extra context. */
+    help_text?: string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,32 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * A hosted form definition.
+ */
+export interface Form {
+    /** Form id (starts with `form_`). */
+    id: string;
+    /** Public shareable URL of the form (`https://forms.pinnacle.sh/{form_id}`). */
+    url: string;
+    /** Human-readable name for the form. Rendered as the form's title. */
+    name: string | null;
+    /** Longer description rendered below the title. */
+    description: string | null;
+    /** Ordered list of fields the recipient fills out. */
+    fields: Pinnacle.FormField[];
+    /** When true, the recipient can reopen the submission URL and edit their answers. When false, the URL becomes read-only after the first submit. */
+    can_update: boolean;
+    /** After this timestamp the form stops accepting submissions. Null means no expiration. */
+    expires_at: string | null;
+    /** Per-form theme tweaks layered on top of your team's default theme. Null means the team defaults are used as-is. */
+    theme_override: Pinnacle.FormThemeOverride | null;
+    /** Count of distinct completed submissions for this form. Does not increment on edits to an existing `can_update=true` submission. */
+    submission_count: number;
+    /** Timestamp of the most recent submission event. Updated on each new submit and on each edit of a `can_update=true` submission. */
+    last_submitted_at: string | null;
+    /** When set, the form is archived (soft-deleted) and cannot accept new submissions or be updated. Restore by PATCHing `archived_at` back to null. */
+    archived_at: string | null;
+    /** ISO 8601 timestamp of when the form was created. */
+    created_at: string;
+    /** ISO 8601 timestamp of the most recent form mutation. */
+    updated_at: string;
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,19 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormBackground.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormBackgroundGradient.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormBackgroundImage.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormBackgroundPattern.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormBackgroundPattern = void 0;
+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 || (exports.FormBackgroundPattern = FormBackgroundPattern = {}));

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

@@ -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/cjs/api/types/FormBackgroundSolid.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormColorPalette.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,18 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormDefinition.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,55 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormField.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormFieldOption.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormGradient.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormGradient = void 0;
+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 || (exports.FormGradient = FormGradient = {}));

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

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

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormSubmission.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormSubmissionAnswer.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormSubmissionEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormSubmissionEventConversation.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/types/FormSubmissionEventForm.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,31 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormSubmissionEventSubmission.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.js";
+/**
+ * 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/cjs/api/types/FormSubmittedField.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });