rcs-js 2.0.19 → 2.0.21

package/dist/esm/api/resources/forms/resources/submissions/client/Client.mjs

@@ -0,0 +1,104 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as environments from "../../../../../../environments.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+import * as Pinnacle from "../../../../../index.mjs";
+export class Submissions {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Paginated list of completed submissions for a form, newest first. Each row includes the submitted `data` keyed by field `key`, the sender/recipient, IP, user-agent, and timestamps.
+     *
+     * @param {string} id - The unique identifier of the form whose submissions you want to list.
+     *                      <br><br> This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
+     * @param {Pinnacle.forms.ListFormSubmissionsParams} request
+     * @param {Submissions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.forms.submissions.list("form_Oy2n7iUoi9CJwUU6", {
+     *         pageIndex: 0,
+     *         pageSize: 20
+     *     })
+     */
+    list(id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(id, request, requestOptions));
+    }
+    __list(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, `forms/${core.url.encodePathParam(id)}/submissions/list`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /forms/{id}/submissions/list.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "PINNACLE-API-KEY": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/forms/resources/submissions/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/forms/resources/submissions/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/forms/resources/submissions/client/requests/ListFormSubmissionsParams.d.mts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         pageIndex: 0,
+ *         pageSize: 20
+ *     }
+ */
+export interface ListFormSubmissionsParams {
+    /** Zero-based page index. */
+    pageIndex?: number;
+    /** Number of submissions to return in a single page. Max 100. */
+    pageSize?: number;
+}

package/dist/esm/api/resources/forms/resources/submissions/client/requests/ListFormSubmissionsParams.mjs

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

package/dist/esm/api/resources/forms/resources/submissions/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { ListFormSubmissionsParams } from "./ListFormSubmissionsParams.mjs";

package/dist/esm/api/resources/forms/resources/submissions/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/forms/resources/submissions/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/forms/resources/submissions/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/forms/types/FormsSendResponse.d.mts

@@ -0,0 +1,2 @@
+import type * as Pinnacle from "../../../index.mjs";
+export type FormsSendResponse = Pinnacle.SendFormResult | Pinnacle.ScheduledFormSendResult;

package/dist/esm/api/resources/forms/types/FormsSendResponse.mjs

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

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

@@ -0,0 +1 @@
+export * from "./FormsSendResponse.mjs";

package/dist/esm/api/resources/forms/types/index.mjs

@@ -0,0 +1 @@
+export * from "./FormsSendResponse.mjs";

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

@@ -9,6 +9,9 @@ export * as contacts from "./contacts/index.mjs";
 export * from "./conversations/client/requests/index.mjs";
 export * as conversations from "./conversations/index.mjs";
 export * from "./conversations/types/index.mjs";
+export * from "./forms/client/requests/index.mjs";
+export * as forms from "./forms/index.mjs";
+export * from "./forms/types/index.mjs";
 export * from "./messages/client/requests/index.mjs";
 export * as messages from "./messages/index.mjs";
 export * from "./phoneNumbers/client/requests/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -9,6 +9,9 @@ export * as contacts from "./contacts/index.mjs";
 export * from "./conversations/client/requests/index.mjs";
 export * as conversations from "./conversations/index.mjs";
 export * from "./conversations/types/index.mjs";
+export * from "./forms/client/requests/index.mjs";
+export * as forms from "./forms/index.mjs";
+export * from "./forms/types/index.mjs";
 export * from "./messages/client/requests/index.mjs";
 export * as messages from "./messages/index.mjs";
 export * from "./phoneNumbers/client/requests/index.mjs";

package/dist/esm/api/resources/webhooks/client/requests/AttachWebhookParams.d.mts

@@ -21,7 +21,7 @@ export interface AttachWebhookParams {
     /**
      * Event type filter for the subscription. Set to `null` to receive all events. <br>
      *
-     * `USER.TYPING` is only supported for RCS agent senders, not phone numbers.
+     * `USER.TYPING` and `CAMPAIGN.STATUS` are only supported for RCS agent senders, not phone numbers — attempting to attach either of these events to a phone number returns `400 Bad Request`.
      */
     event?: Pinnacle.WebhookEventEnum | null;
     /**

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

@@ -0,0 +1,14 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Free-form text input backed by a client-side Google Places autocomplete. Shares text-field validation (length / pattern); the place lookup happens entirely in the browser and is purely for suggestion UX.
+ */
+export interface AddressField 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`. Rarely needed for addresses — usually left off. */
+    pattern?: string;
+    /** Minimum number of characters in the selected address. */
+    min_length?: number;
+    /** Maximum number of characters in the selected address. */
+    max_length?: number;
+}

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

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

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

@@ -5,7 +5,13 @@ export interface AgentSummary {
     agentType: AgentSummary.AgentType;
     /** Service ID associated with the agent. */
     serviceId?: string | null;
-    /** Per-carrier launch status for the agent. */
+    /**
+     * Raw per-carrier launch + verification state for the agent. Each
+     * value is tri-state — `null` means "no launch requested" or "not
+     * sent yet"; `false` means "pending" / "sent"; `true` means
+     * "launched" / "verified". Use the [GET /rcs/{agentId}](/api-reference/rcs-agents/get)
+     * endpoint for the resolved enum representation.
+     */
     carrierLaunches?: AgentSummary.CarrierLaunches | null;
     /** Agent configuration details. */
     config?: AgentSummary.Config | null;
@@ -22,7 +28,11 @@ export declare namespace AgentSummary {
     };
     type AgentType = (typeof AgentType)[keyof typeof AgentType];
     /**
-     * Per-carrier launch status for the agent.
+     * Raw per-carrier launch + verification state for the agent. Each
+     * value is tri-state — `null` means "no launch requested" or "not
+     * sent yet"; `false` means "pending" / "sent"; `true` means
+     * "launched" / "verified". Use the [GET /rcs/{agentId}](/api-reference/rcs-agents/get)
+     * endpoint for the resolved enum representation.
      */
     interface CarrierLaunches {
         /** Launch status for AT&T. null = not requested, false = pending, true = launched. */
@@ -33,6 +43,10 @@ export declare namespace AgentSummary {
         TMOBILE?: boolean | null;
         /** Launch status for Verizon. null = not requested, false = pending, true = launched. */
         VERIZON?: boolean | null;
+        /** AEGIS verification status. null = not sent, false = sent, true = verified. */
+        AEGIS?: boolean | null;
+        /** Google verification status. null = not sent, false = sent, true = verified. */
+        GOOGLE?: boolean | null;
     }
     /**
      * Agent configuration details.

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

@@ -0,0 +1,19 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Webhook body delivered to subscribers of `CAMPAIGN.STATUS` whenever
+ * an RCS campaign's per-carrier launch status or verification status
+ * (AEGIS / Google) changes. `CAMPAIGN.STATUS` is only supported for
+ * RCS agent senders — the attach call rejects phone-number senders
+ * with `400 Bad Request`. Verify the `PINNACLE-SIGNING-SECRET` header
+ * matches the signing secret of the webhook this event was delivered
+ * to before trusting the payload.
+ */
+export interface CampaignStatusEvent {
+    type: "CAMPAIGN.STATUS";
+    agent: Pinnacle.CampaignStatusEventAgent;
+    campaign: Pinnacle.CampaignStatusEventCampaign;
+    brand: Pinnacle.CampaignStatusEventBrand;
+    carrierLaunches: Pinnacle.CampaignStatusEventCarrierLaunches;
+    /** ISO 8601 timestamp of when the change was applied. */
+    updatedAt: string;
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * The RCS agent the campaign-status update is for.
+ */
+export interface CampaignStatusEventAgent {
+    /** RCS agent id (`agent_*`). */
+    id: string;
+    /** Display name configured on the agent. Null if unset. */
+    name: string | null;
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Reference to the brand owning the agent's connected campaign.
+ */
+export interface CampaignStatusEventBrand {
+    /** Brand public id (`b_*`). Null if no brand is linked. */
+    publicId: string | null;
+    /** Brand display name. Null if unset. */
+    name: string | null;
+}

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

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

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

@@ -0,0 +1,18 @@
+/**
+ * Reference to the connected campaign.
+ */
+export interface CampaignStatusEventCampaign {
+    /** Campaign public id (`rcs_*` for RCS campaigns). Null if the agent isn't yet linked to a campaign. */
+    publicId: string | null;
+    /** Campaign protocol — currently always `RCS` for `CAMPAIGN.STATUS` events. Future event variants may carry `TOLL_FREE` or `10DLC`. */
+    type: CampaignStatusEventCampaign.Type;
+}
+export declare namespace CampaignStatusEventCampaign {
+    /** Campaign protocol — currently always `RCS` for `CAMPAIGN.STATUS` events. Future event variants may carry `TOLL_FREE` or `10DLC`. */
+    const Type: {
+        readonly Rcs: "RCS";
+        readonly TollFree: "TOLL_FREE";
+        readonly TenDlc: "10DLC";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

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

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CampaignStatusEventCampaign;
+(function (CampaignStatusEventCampaign) {
+    /** Campaign protocol — currently always `RCS` for `CAMPAIGN.STATUS` events. Future event variants may carry `TOLL_FREE` or `10DLC`. */
+    CampaignStatusEventCampaign.Type = {
+        Rcs: "RCS",
+        TollFree: "TOLL_FREE",
+        TenDlc: "10DLC",
+    };
+})(CampaignStatusEventCampaign || (CampaignStatusEventCampaign = {}));

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

@@ -0,0 +1,48 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Resolved per-key launch status for the campaign's agent. Carrier
+ * statuses live under `carriers` and verifier statuses under
+ * `verification`.
+ */
+export interface CampaignStatusEventCarrierLaunches {
+    /**
+     * Per-carrier launch status. Each carrier moves through
+     * `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
+     * agent for review and the carrier accepts it. The agent is only
+     * deliverable on a carrier once that carrier reports `LAUNCHED`.
+     */
+    carriers: CampaignStatusEventCarrierLaunches.Carriers;
+    /**
+     * External verifier status. AEGIS (the U.S. carrier vetting
+     * authority used by AT&T, T-Mobile, and Verizon) and Google each
+     * send a verification email to the brand's contact address. Each
+     * verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
+     * the brand replies and the verifier confirms ownership.
+     */
+    verification: CampaignStatusEventCarrierLaunches.Verification;
+}
+export declare namespace CampaignStatusEventCarrierLaunches {
+    /**
+     * Per-carrier launch status. Each carrier moves through
+     * `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
+     * agent for review and the carrier accepts it. The agent is only
+     * deliverable on a carrier once that carrier reports `LAUNCHED`.
+     */
+    interface Carriers {
+        ATT: Pinnacle.CarrierLaunchStatus;
+        TMOBILE: Pinnacle.CarrierLaunchStatus;
+        VERIZON: Pinnacle.CarrierLaunchStatus;
+        OTHERS: Pinnacle.CarrierLaunchStatus;
+    }
+    /**
+     * External verifier status. AEGIS (the U.S. carrier vetting
+     * authority used by AT&T, T-Mobile, and Verizon) and Google each
+     * send a verification email to the brand's contact address. Each
+     * verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
+     * the brand replies and the verifier confirms ownership.
+     */
+    interface Verification {
+        AEGIS: Pinnacle.VerificationStatus;
+        GOOGLE: Pinnacle.VerificationStatus;
+    }
+}

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

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

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

@@ -1,8 +1,8 @@
 /**
- * Launch status for a carrier.
- * - `NOT_LAUNCHED` — No launch requested.
- * - `PENDING` — Launch pending.
- * - `LAUNCHED` — Launched.
+ * Status of an RCS agent's launch on a specific carrier.
+ *   - `NOT_LAUNCHED` — no launch requested yet
+ *   - `PENDING` — submitted to the carrier, review in progress
+ *   - `LAUNCHED` — live on the carrier
  */
 export declare const CarrierLaunchStatus: {
     readonly NotLaunched: "NOT_LAUNCHED";

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

@@ -1,9 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
 /**
- * Launch status for a carrier.
- * - `NOT_LAUNCHED` — No launch requested.
- * - `PENDING` — Launch pending.
- * - `LAUNCHED` — Launched.
+ * Status of an RCS agent's launch on a specific carrier.
+ *   - `NOT_LAUNCHED` — no launch requested yet
+ *   - `PENDING` — submitted to the carrier, review in progress
+ *   - `LAUNCHED` — live on the carrier
  */
 export const CarrierLaunchStatus = {
     NotLaunched: "NOT_LAUNCHED",

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

@@ -1,14 +1,54 @@
 import type * as Pinnacle from "../index.mjs";
 /**
- * Per-carrier launch status.
+ * Per-carrier launch status grouped by category. `carriers` covers
+ * AT&T / T-Mobile / Verizon / other carriers; `verification` covers
+ * the AEGIS and Google verification flows.
  */
 export interface CarrierLaunches {
-    /** AT&T launch status. */
-    ATT: Pinnacle.CarrierLaunchStatus;
-    /** T-Mobile launch status. */
-    TMOBILE: Pinnacle.CarrierLaunchStatus;
-    /** Verizon launch status. */
-    VERIZON: Pinnacle.CarrierLaunchStatus;
-    /** Other carriers launch status. */
-    OTHERS: Pinnacle.CarrierLaunchStatus;
+    /**
+     * Per-carrier launch status. Each carrier moves through
+     * `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
+     * agent for review and the carrier accepts it. The agent is only
+     * deliverable on a carrier once that carrier reports `LAUNCHED`.
+     */
+    carriers: CarrierLaunches.Carriers;
+    /**
+     * External verifier status. AEGIS (the U.S. carrier vetting
+     * authority used by AT&T, T-Mobile, and Verizon) and Google each
+     * send a verification email to the brand's contact address. Each
+     * verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
+     * the brand replies and the verifier confirms ownership.
+     */
+    verification: CarrierLaunches.Verification;
+}
+export declare namespace CarrierLaunches {
+    /**
+     * Per-carrier launch status. Each carrier moves through
+     * `NOT_LAUNCHED` → `PENDING` → `LAUNCHED` as Pinnacle submits the
+     * agent for review and the carrier accepts it. The agent is only
+     * deliverable on a carrier once that carrier reports `LAUNCHED`.
+     */
+    interface Carriers {
+        /** AT&T launch status. */
+        ATT: Pinnacle.CarrierLaunchStatus;
+        /** T-Mobile launch status. */
+        TMOBILE: Pinnacle.CarrierLaunchStatus;
+        /** Verizon launch status. */
+        VERIZON: Pinnacle.CarrierLaunchStatus;
+        /** Other carriers launch status. */
+        OTHERS: Pinnacle.CarrierLaunchStatus;
+    }
+    /**
+     * External verifier status. AEGIS (the U.S. carrier vetting
+     * authority used by AT&T, T-Mobile, and Verizon) and Google each
+     * send a verification email to the brand's contact address. Each
+     * verifier moves through `NOT_SENT` → `SENT` → `VERIFIED` once
+     * the brand replies and the verifier confirms ownership.
+     */
+    interface Verification {
+        /** AEGIS verification status. */
+        AEGIS: Pinnacle.VerificationStatus;
+        /** Google verification status. */
+        GOOGLE: Pinnacle.VerificationStatus;
+    }
 }

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

@@ -0,0 +1,12 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * Multi-select checkbox group when `options` is provided. If `options` is omitted the field renders as a single boolean checkbox.
+ */
+export interface CheckboxField extends Pinnacle.FieldBase {
+    /** Choices shown as checkboxes. Omit to render a single boolean checkbox. */
+    options?: Pinnacle.FormFieldOption[];
+    /** Minimum number of boxes the submitter must check. */
+    min_selected?: number;
+    /** Maximum number of boxes the submitter may check. Extra boxes become uninteractive once the cap is reached. */
+    max_selected?: number;
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * 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/esm/api/types/EmailField.mjs

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

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

@@ -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/esm/api/types/FieldBase.mjs

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

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

@@ -0,0 +1,32 @@
+import type * as Pinnacle from "../index.mjs";
+/**
+ * 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/esm/api/types/Form.mjs

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