@aifeatures/backend 0.1.2

package/dist/index.d.cts

@@ -0,0 +1,995 @@
+type AuthToken = string | undefined;
+interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
+    in?: "header" | "query" | "cookie";
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
+    name?: string;
+    scheme?: "basic" | "bearer";
+    type: "apiKey" | "http";
+}
+
+interface SerializerOptions<T> {
+    /**
+     * @default true
+     */
+    explode: boolean;
+    style: T;
+}
+type ArrayStyle = "form" | "spaceDelimited" | "pipeDelimited";
+type ObjectStyle = "form" | "deepObject";
+
+type QuerySerializer = (query: Record<string, unknown>) => string;
+type BodySerializer = (body: any) => any;
+type QuerySerializerOptionsObject = {
+    allowReserved?: boolean;
+    array?: Partial<SerializerOptions<ArrayStyle>>;
+    object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+type QuerySerializerOptions = QuerySerializerOptionsObject & {
+    /**
+     * Per-parameter serialization overrides. When provided, these settings
+     * override the global array/object settings for specific parameter names.
+     */
+    parameters?: Record<string, QuerySerializerOptionsObject>;
+};
+
+type HttpMethod = "connect" | "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
+    /**
+     * Returns the final request URL.
+     */
+    buildUrl: BuildUrlFn;
+    getConfig: () => Config;
+    request: RequestFn;
+    setConfig: (config: Config) => Config;
+} & {
+    [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? {
+    sse?: never;
+} : {
+    sse: {
+        [K in HttpMethod]: SseFn;
+    };
+});
+interface Config$1 {
+    /**
+     * Auth token or a function returning auth token. The resolved value will be
+     * added to the request payload as defined by its `security` array.
+     */
+    auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+    /**
+     * A function for serializing request body parameter. By default,
+     * {@link JSON.stringify()} will be used.
+     */
+    bodySerializer?: BodySerializer | null;
+    /**
+     * An object containing any HTTP headers that you want to pre-populate your
+     * `Headers` object with.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+     */
+    headers?: RequestInit["headers"] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+    /**
+     * The request method.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+     */
+    method?: Uppercase<HttpMethod>;
+    /**
+     * A function for serializing request query parameters. By default, arrays
+     * will be exploded in form style, objects will be exploded in deepObject
+     * style, and reserved characters are percent-encoded.
+     *
+     * This method will have no effect if the native `paramsSerializer()` Axios
+     * API function is used.
+     *
+     * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+     */
+    querySerializer?: QuerySerializer | QuerySerializerOptions;
+    /**
+     * A function validating request data. This is useful if you want to ensure
+     * the request conforms to the desired shape, so it can be safely sent to
+     * the server.
+     */
+    requestValidator?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function transforming response data before it's returned. This is useful
+     * for post-processing data, e.g. converting ISO strings into Date objects.
+     */
+    responseTransformer?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function validating response data. This is useful if you want to ensure
+     * the response conforms to the desired shape, so it can be safely passed to
+     * the transformers and returned to the user.
+     */
+    responseValidator?: (data: unknown) => Promise<unknown>;
+}
+
+type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, "method"> & Pick<Config$1, "method" | "responseTransformer" | "responseValidator"> & {
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Implementing clients can call request interceptors inside this hook.
+     */
+    onRequest?: (url: string, init: RequestInit) => Promise<Request>;
+    /**
+     * Callback invoked when a network or parsing error occurs during streaming.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param error The error that occurred.
+     */
+    onSseError?: (error: unknown) => void;
+    /**
+     * Callback invoked when an event is streamed from the server.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param event Event streamed from the server.
+     * @returns Nothing (void).
+     */
+    onSseEvent?: (event: StreamEvent<TData>) => void;
+    serializedBody?: RequestInit["body"];
+    /**
+     * Default retry delay in milliseconds.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 3000
+     */
+    sseDefaultRetryDelay?: number;
+    /**
+     * Maximum number of retry attempts before giving up.
+     */
+    sseMaxRetryAttempts?: number;
+    /**
+     * Maximum retry delay in milliseconds.
+     *
+     * Applies only when exponential backoff is used.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 30000
+     */
+    sseMaxRetryDelay?: number;
+    /**
+     * Optional sleep function for retry backoff.
+     *
+     * Defaults to using `setTimeout`.
+     */
+    sseSleepFn?: (ms: number) => Promise<void>;
+    url: string;
+};
+interface StreamEvent<TData = unknown> {
+    data: TData;
+    event?: string;
+    id?: string;
+    retry?: number;
+}
+type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
+    stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
+};
+
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+    fns: Array<Interceptor | null>;
+    clear(): void;
+    eject(id: number | Interceptor): void;
+    exists(id: number | Interceptor): boolean;
+    getInterceptorIndex(id: number | Interceptor): number;
+    update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+    use(fn: Interceptor): number;
+}
+interface Middleware<Req, Res, Err, Options> {
+    error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+    request: Interceptors<ReqInterceptor<Req, Options>>;
+    response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+
+type ResponseStyle = "data" | "fields";
+interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, "body" | "headers" | "method">, Config$1 {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T["baseUrl"];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: "arrayBuffer" | "auto" | "blob" | "formData" | "json" | "stream" | "text";
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T["throwOnError"];
+}
+interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = "fields", ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+    responseStyle: TResponseStyle;
+    throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, "onSseError" | "onSseEvent" | "sseDefaultRetryDelay" | "sseMaxRetryAttempts" | "sseMaxRetryDelay"> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    security?: ReadonlyArray<Auth>;
+    url: Url;
+}
+interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = "fields", ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    serializedBody?: string;
+}
+type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = "fields"> = ThrowOnError extends true ? Promise<TResponseStyle extends "data" ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    request: Request;
+    response: Response;
+}> : Promise<TResponseStyle extends "data" ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    request: Request;
+    response: Response;
+}>;
+interface ClientOptions$1 {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = "fields">(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method"> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, "method">) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    url: string;
+}>(options: TData & Options$1<TData>) => string;
+type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = "fields"> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, "body" | "path" | "query" | "url"> & ([TData] extends [never] ? unknown : Omit<TData, "url">);
+
+type ClientOptions = {
+    baseUrl: "https://aifeatures.dev/api/v1" | "http://localhost:8787/api/v1" | (string & {});
+};
+/**
+ * CAPTCHA configuration. CAPTCHA is always enabled when available (managed at site level).
+ */
+type Captcha = {
+    enabled: boolean;
+    provider?: "turnstile";
+    site_key?: string;
+};
+type Form = {
+    id: string;
+    name: string;
+    endpoint_url: string;
+    email_recipients: Array<string>;
+    redirect_url: string;
+    webhook_url: string;
+    captcha: Captcha;
+    created_at: string;
+    updated_at: string;
+};
+type FormsList = {
+    forms: Array<Form>;
+};
+type Error = {
+    error: string;
+};
+type CreateForm = {
+    name: string;
+    /**
+     * Email recipients for form submissions. If not provided, uses the site default.
+     */
+    email_recipients?: Array<string>;
+    redirect_url?: string;
+    webhook_url?: string;
+};
+type Site = {
+    id: string;
+    name: string;
+    /**
+     * External ID from the consumer system
+     */
+    external_id: string;
+    /**
+     * Default email recipients for forms that do not specify their own
+     */
+    default_email_recipients: Array<string>;
+    created_at: string;
+    updated_at: string;
+};
+type SitesList = {
+    sites: Array<Site>;
+};
+type SiteWithToken = Site & {
+    /**
+     * Site-scoped API token. Only returned on creation - store it securely!
+     */
+    api_token: string;
+};
+type CreateSite = {
+    name: string;
+    /**
+     * External ID from your system (e.g., your website ID)
+     */
+    external_id?: string;
+    /**
+     * Default email recipients for forms in this site
+     */
+    default_email_recipients?: Array<string>;
+    /**
+     * Allowed domains for Turnstile CAPTCHA verification
+     */
+    domains?: Array<string>;
+};
+type UpdateSite = {
+    name?: string;
+    default_email_recipients?: Array<string>;
+};
+type SiteDomains = {
+    /**
+     * Current allowed domains for Turnstile CAPTCHA verification
+     */
+    domains: Array<string>;
+};
+type UpdateSiteDomains = {
+    /**
+     * Allowed domains for Turnstile CAPTCHA verification
+     */
+    domains: Array<string>;
+};
+type UpdateForm = {
+    name?: string;
+    email_recipients?: Array<string>;
+    redirect_url?: string;
+    webhook_url?: string;
+};
+type Attachment = {
+    name: string;
+    size: number;
+    r2_key: string;
+    content_type: string;
+};
+type SubmissionMetadata = {
+    ip_address: string;
+    user_agent: string;
+    submitted_at: string;
+};
+type Submission = {
+    id: string;
+    form_id: string;
+    data: {
+        [key: string]: unknown;
+    };
+    attachments: Array<Attachment>;
+    metadata: SubmissionMetadata;
+    /**
+     * Resend email ID for tracking notification delivery
+     */
+    resend_id: string;
+};
+type SubmissionsList = {
+    submissions: Array<Submission>;
+    total: number;
+    limit: number;
+    offset: number;
+};
+type GetApiV1FormsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: "/api/v1/forms";
+};
+type GetApiV1FormsErrors = {
+    /**
+     * Unauthorized - requires site token
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type GetApiV1FormsError = GetApiV1FormsErrors[keyof GetApiV1FormsErrors];
+type GetApiV1FormsResponses = {
+    /**
+     * List of forms
+     */
+    200: FormsList;
+};
+type GetApiV1FormsResponse = GetApiV1FormsResponses[keyof GetApiV1FormsResponses];
+type PostApiV1FormsData = {
+    body: CreateForm;
+    path?: never;
+    query?: never;
+    url: "/api/v1/forms";
+};
+type PostApiV1FormsErrors = {
+    /**
+     * Unauthorized - requires site token
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type PostApiV1FormsError = PostApiV1FormsErrors[keyof PostApiV1FormsErrors];
+type PostApiV1FormsResponses = {
+    /**
+     * Form created successfully
+     */
+    201: Form;
+};
+type PostApiV1FormsResponse = PostApiV1FormsResponses[keyof PostApiV1FormsResponses];
+type GetApiV1SitesData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: "/api/v1/sites";
+};
+type GetApiV1SitesErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+};
+type GetApiV1SitesError = GetApiV1SitesErrors[keyof GetApiV1SitesErrors];
+type GetApiV1SitesResponses = {
+    /**
+     * List of sites
+     */
+    200: SitesList;
+};
+type GetApiV1SitesResponse = GetApiV1SitesResponses[keyof GetApiV1SitesResponses];
+type PostApiV1SitesData = {
+    body: CreateSite;
+    path?: never;
+    query?: never;
+    url: "/api/v1/sites";
+};
+type PostApiV1SitesErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site with this external_id already exists
+     */
+    409: Error;
+};
+type PostApiV1SitesError = PostApiV1SitesErrors[keyof PostApiV1SitesErrors];
+type PostApiV1SitesResponses = {
+    /**
+     * Site created successfully. The api_token is only returned once!
+     */
+    201: SiteWithToken;
+};
+type PostApiV1SitesResponse = PostApiV1SitesResponses[keyof PostApiV1SitesResponses];
+type DeleteApiV1SitesBySiteIdData = {
+    body?: never;
+    path: {
+        siteId: string;
+    };
+    query?: never;
+    url: "/api/v1/sites/{siteId}";
+};
+type DeleteApiV1SitesBySiteIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type DeleteApiV1SitesBySiteIdError = DeleteApiV1SitesBySiteIdErrors[keyof DeleteApiV1SitesBySiteIdErrors];
+type DeleteApiV1SitesBySiteIdResponses = {
+    /**
+     * Site deleted successfully
+     */
+    204: void;
+};
+type DeleteApiV1SitesBySiteIdResponse = DeleteApiV1SitesBySiteIdResponses[keyof DeleteApiV1SitesBySiteIdResponses];
+type GetApiV1SitesBySiteIdData = {
+    body?: never;
+    path: {
+        siteId: string;
+    };
+    query?: never;
+    url: "/api/v1/sites/{siteId}";
+};
+type GetApiV1SitesBySiteIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type GetApiV1SitesBySiteIdError = GetApiV1SitesBySiteIdErrors[keyof GetApiV1SitesBySiteIdErrors];
+type GetApiV1SitesBySiteIdResponses = {
+    /**
+     * Site details
+     */
+    200: Site;
+};
+type GetApiV1SitesBySiteIdResponse = GetApiV1SitesBySiteIdResponses[keyof GetApiV1SitesBySiteIdResponses];
+type PatchApiV1SitesBySiteIdData = {
+    body: UpdateSite;
+    path: {
+        siteId: string;
+    };
+    query?: never;
+    url: "/api/v1/sites/{siteId}";
+};
+type PatchApiV1SitesBySiteIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type PatchApiV1SitesBySiteIdError = PatchApiV1SitesBySiteIdErrors[keyof PatchApiV1SitesBySiteIdErrors];
+type PatchApiV1SitesBySiteIdResponses = {
+    /**
+     * Site updated successfully
+     */
+    200: Site;
+};
+type PatchApiV1SitesBySiteIdResponse = PatchApiV1SitesBySiteIdResponses[keyof PatchApiV1SitesBySiteIdResponses];
+type PatchApiV1SitesBySiteIdDomainsData = {
+    body: UpdateSiteDomains;
+    path: {
+        siteId: string;
+    };
+    query?: never;
+    url: "/api/v1/sites/{siteId}/domains";
+};
+type PatchApiV1SitesBySiteIdDomainsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type PatchApiV1SitesBySiteIdDomainsError = PatchApiV1SitesBySiteIdDomainsErrors[keyof PatchApiV1SitesBySiteIdDomainsErrors];
+type PatchApiV1SitesBySiteIdDomainsResponses = {
+    /**
+     * Site domains updated successfully
+     */
+    200: SiteDomains;
+};
+type PatchApiV1SitesBySiteIdDomainsResponse = PatchApiV1SitesBySiteIdDomainsResponses[keyof PatchApiV1SitesBySiteIdDomainsResponses];
+type GetApiV1SitesBySiteIdFormsData = {
+    body?: never;
+    path: {
+        siteId: string;
+    };
+    query?: never;
+    url: "/api/v1/sites/{siteId}/forms";
+};
+type GetApiV1SitesBySiteIdFormsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type GetApiV1SitesBySiteIdFormsError = GetApiV1SitesBySiteIdFormsErrors[keyof GetApiV1SitesBySiteIdFormsErrors];
+type GetApiV1SitesBySiteIdFormsResponses = {
+    /**
+     * List of forms
+     */
+    200: FormsList;
+};
+type GetApiV1SitesBySiteIdFormsResponse = GetApiV1SitesBySiteIdFormsResponses[keyof GetApiV1SitesBySiteIdFormsResponses];
+type PostApiV1SitesBySiteIdFormsData = {
+    body: CreateForm;
+    path: {
+        siteId: string;
+    };
+    query?: never;
+    url: "/api/v1/sites/{siteId}/forms";
+};
+type PostApiV1SitesBySiteIdFormsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Site not found
+     */
+    404: Error;
+};
+type PostApiV1SitesBySiteIdFormsError = PostApiV1SitesBySiteIdFormsErrors[keyof PostApiV1SitesBySiteIdFormsErrors];
+type PostApiV1SitesBySiteIdFormsResponses = {
+    /**
+     * Form created successfully
+     */
+    201: Form;
+};
+type PostApiV1SitesBySiteIdFormsResponse = PostApiV1SitesBySiteIdFormsResponses[keyof PostApiV1SitesBySiteIdFormsResponses];
+type DeleteApiV1FormsByFormIdData = {
+    body?: never;
+    path: {
+        formId: string;
+    };
+    query?: never;
+    url: "/api/v1/forms/{formId}";
+};
+type DeleteApiV1FormsByFormIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Form not found
+     */
+    404: Error;
+};
+type DeleteApiV1FormsByFormIdError = DeleteApiV1FormsByFormIdErrors[keyof DeleteApiV1FormsByFormIdErrors];
+type DeleteApiV1FormsByFormIdResponses = {
+    /**
+     * Form deleted successfully
+     */
+    204: void;
+};
+type DeleteApiV1FormsByFormIdResponse = DeleteApiV1FormsByFormIdResponses[keyof DeleteApiV1FormsByFormIdResponses];
+type GetApiV1FormsByFormIdData = {
+    body?: never;
+    path: {
+        formId: string;
+    };
+    query?: never;
+    url: "/api/v1/forms/{formId}";
+};
+type GetApiV1FormsByFormIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Form not found
+     */
+    404: Error;
+};
+type GetApiV1FormsByFormIdError = GetApiV1FormsByFormIdErrors[keyof GetApiV1FormsByFormIdErrors];
+type GetApiV1FormsByFormIdResponses = {
+    /**
+     * Form details
+     */
+    200: Form;
+};
+type GetApiV1FormsByFormIdResponse = GetApiV1FormsByFormIdResponses[keyof GetApiV1FormsByFormIdResponses];
+type PatchApiV1FormsByFormIdData = {
+    body: UpdateForm;
+    path: {
+        formId: string;
+    };
+    query?: never;
+    url: "/api/v1/forms/{formId}";
+};
+type PatchApiV1FormsByFormIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Form not found
+     */
+    404: Error;
+};
+type PatchApiV1FormsByFormIdError = PatchApiV1FormsByFormIdErrors[keyof PatchApiV1FormsByFormIdErrors];
+type PatchApiV1FormsByFormIdResponses = {
+    /**
+     * Form updated successfully
+     */
+    200: Form;
+};
+type PatchApiV1FormsByFormIdResponse = PatchApiV1FormsByFormIdResponses[keyof PatchApiV1FormsByFormIdResponses];
+type GetApiV1FormsByFormIdSubmissionsData = {
+    body?: never;
+    path: {
+        formId: string;
+    };
+    query?: {
+        /**
+         * Maximum number of submissions to return (max 100)
+         */
+        limit?: string;
+        /**
+         * Number of submissions to skip
+         */
+        offset?: string;
+        /**
+         * Include spam submissions (default: false)
+         */
+        include_spam?: string;
+    };
+    url: "/api/v1/forms/{formId}/submissions";
+};
+type GetApiV1FormsByFormIdSubmissionsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Form not found
+     */
+    404: Error;
+};
+type GetApiV1FormsByFormIdSubmissionsError = GetApiV1FormsByFormIdSubmissionsErrors[keyof GetApiV1FormsByFormIdSubmissionsErrors];
+type GetApiV1FormsByFormIdSubmissionsResponses = {
+    /**
+     * List of submissions
+     */
+    200: SubmissionsList;
+};
+type GetApiV1FormsByFormIdSubmissionsResponse = GetApiV1FormsByFormIdSubmissionsResponses[keyof GetApiV1FormsByFormIdSubmissionsResponses];
+type DeleteApiV1SubmissionsBySubmissionIdData = {
+    body?: never;
+    path: {
+        submissionId: string;
+    };
+    query?: never;
+    url: "/api/v1/submissions/{submissionId}";
+};
+type DeleteApiV1SubmissionsBySubmissionIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Submission not found
+     */
+    404: Error;
+};
+type DeleteApiV1SubmissionsBySubmissionIdError = DeleteApiV1SubmissionsBySubmissionIdErrors[keyof DeleteApiV1SubmissionsBySubmissionIdErrors];
+type DeleteApiV1SubmissionsBySubmissionIdResponses = {
+    /**
+     * Submission deleted successfully
+     */
+    204: void;
+};
+type DeleteApiV1SubmissionsBySubmissionIdResponse = DeleteApiV1SubmissionsBySubmissionIdResponses[keyof DeleteApiV1SubmissionsBySubmissionIdResponses];
+type GetApiV1SubmissionsBySubmissionIdData = {
+    body?: never;
+    path: {
+        submissionId: string;
+    };
+    query?: never;
+    url: "/api/v1/submissions/{submissionId}";
+};
+type GetApiV1SubmissionsBySubmissionIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Submission not found
+     */
+    404: Error;
+};
+type GetApiV1SubmissionsBySubmissionIdError = GetApiV1SubmissionsBySubmissionIdErrors[keyof GetApiV1SubmissionsBySubmissionIdErrors];
+type GetApiV1SubmissionsBySubmissionIdResponses = {
+    /**
+     * Submission details
+     */
+    200: Submission;
+};
+type GetApiV1SubmissionsBySubmissionIdResponse = GetApiV1SubmissionsBySubmissionIdResponses[keyof GetApiV1SubmissionsBySubmissionIdResponses];
+type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameData = {
+    body?: never;
+    path: {
+        submissionId: string;
+        filename: string;
+    };
+    query?: never;
+    url: "/api/v1/submissions/{submissionId}/attachments/{filename}";
+};
+type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameErrors = {
+    /**
+     * Unauthorized
+     */
+    401: Error;
+    /**
+     * Submission or attachment not found
+     */
+    404: Error;
+};
+type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameError = GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameErrors[keyof GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameErrors];
+type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameResponses = {
+    /**
+     * File content
+     */
+    200: unknown;
+};
+
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * List all forms (site token)
+ *
+ * Returns all forms for the site associated with your site token. Requires a site token (st_xxx), not an org API key.
+ */
+declare const getApiV1Forms: <ThrowOnError extends boolean = false>(options?: Options<GetApiV1FormsData, ThrowOnError>) => RequestResult<GetApiV1FormsResponses, GetApiV1FormsErrors, ThrowOnError, "fields">;
+/**
+ * Create a form (site token)
+ *
+ * Creates a new form endpoint for the site associated with your site token. Requires a site token (st_xxx), not an org API key.
+ */
+declare const postApiV1Forms: <ThrowOnError extends boolean = false>(options: Options<PostApiV1FormsData, ThrowOnError>) => RequestResult<PostApiV1FormsResponses, PostApiV1FormsErrors, ThrowOnError, "fields">;
+/**
+ * List all sites
+ *
+ * Returns all sites belonging to your organization.
+ */
+declare const getApiV1Sites: <ThrowOnError extends boolean = false>(options?: Options<GetApiV1SitesData, ThrowOnError>) => RequestResult<GetApiV1SitesResponses, GetApiV1SitesErrors, ThrowOnError, "fields">;
+/**
+ * Create a site
+ *
+ * Creates a new site to group forms under. Returns a site-scoped API token that is only shown once - store it securely!
+ */
+declare const postApiV1Sites: <ThrowOnError extends boolean = false>(options: Options<PostApiV1SitesData, ThrowOnError>) => RequestResult<PostApiV1SitesResponses, PostApiV1SitesErrors, ThrowOnError, "fields">;
+/**
+ * Delete a site
+ *
+ * Permanently deletes a site and all its forms and submissions.
+ */
+declare const deleteApiV1SitesBySiteId: <ThrowOnError extends boolean = false>(options: Options<DeleteApiV1SitesBySiteIdData, ThrowOnError>) => RequestResult<DeleteApiV1SitesBySiteIdResponses, DeleteApiV1SitesBySiteIdErrors, ThrowOnError, "fields">;
+/**
+ * Get a site
+ *
+ * Returns details of a specific site.
+ */
+declare const getApiV1SitesBySiteId: <ThrowOnError extends boolean = false>(options: Options<GetApiV1SitesBySiteIdData, ThrowOnError>) => RequestResult<GetApiV1SitesBySiteIdResponses, GetApiV1SitesBySiteIdErrors, ThrowOnError, "fields">;
+/**
+ * Update a site
+ *
+ * Updates an existing site.
+ */
+declare const patchApiV1SitesBySiteId: <ThrowOnError extends boolean = false>(options: Options<PatchApiV1SitesBySiteIdData, ThrowOnError>) => RequestResult<PatchApiV1SitesBySiteIdResponses, PatchApiV1SitesBySiteIdErrors, ThrowOnError, "fields">;
+/**
+ * Update site domains
+ *
+ * Updates the allowed domains for Turnstile CAPTCHA verification. This should be called when a custom domain is connected or disconnected from a website.
+ */
+declare const patchApiV1SitesBySiteIdDomains: <ThrowOnError extends boolean = false>(options: Options<PatchApiV1SitesBySiteIdDomainsData, ThrowOnError>) => RequestResult<PatchApiV1SitesBySiteIdDomainsResponses, PatchApiV1SitesBySiteIdDomainsErrors, ThrowOnError, "fields">;
+/**
+ * List all forms for a site
+ *
+ * Returns all forms belonging to a site.
+ */
+declare const getApiV1SitesBySiteIdForms: <ThrowOnError extends boolean = false>(options: Options<GetApiV1SitesBySiteIdFormsData, ThrowOnError>) => RequestResult<GetApiV1SitesBySiteIdFormsResponses, GetApiV1SitesBySiteIdFormsErrors, ThrowOnError, "fields">;
+/**
+ * Create a form
+ *
+ * Creates a new form endpoint under a site. If captcha is enabled, a Cloudflare Turnstile widget will be automatically provisioned.
+ */
+declare const postApiV1SitesBySiteIdForms: <ThrowOnError extends boolean = false>(options: Options<PostApiV1SitesBySiteIdFormsData, ThrowOnError>) => RequestResult<PostApiV1SitesBySiteIdFormsResponses, PostApiV1SitesBySiteIdFormsErrors, ThrowOnError, "fields">;
+/**
+ * Delete a form
+ *
+ * Permanently deletes a form and all its submissions.
+ */
+declare const deleteApiV1FormsByFormId: <ThrowOnError extends boolean = false>(options: Options<DeleteApiV1FormsByFormIdData, ThrowOnError>) => RequestResult<DeleteApiV1FormsByFormIdResponses, DeleteApiV1FormsByFormIdErrors, ThrowOnError, "fields">;
+/**
+ * Get a form
+ *
+ * Returns details of a specific form.
+ */
+declare const getApiV1FormsByFormId: <ThrowOnError extends boolean = false>(options: Options<GetApiV1FormsByFormIdData, ThrowOnError>) => RequestResult<GetApiV1FormsByFormIdResponses, GetApiV1FormsByFormIdErrors, ThrowOnError, "fields">;
+/**
+ * Update a form
+ *
+ * Updates an existing form. Only provided fields will be updated.
+ */
+declare const patchApiV1FormsByFormId: <ThrowOnError extends boolean = false>(options: Options<PatchApiV1FormsByFormIdData, ThrowOnError>) => RequestResult<PatchApiV1FormsByFormIdResponses, PatchApiV1FormsByFormIdErrors, ThrowOnError, "fields">;
+/**
+ * List submissions
+ *
+ * Returns submissions for a form.
+ */
+declare const getApiV1FormsByFormIdSubmissions: <ThrowOnError extends boolean = false>(options: Options<GetApiV1FormsByFormIdSubmissionsData, ThrowOnError>) => RequestResult<GetApiV1FormsByFormIdSubmissionsResponses, GetApiV1FormsByFormIdSubmissionsErrors, ThrowOnError, "fields">;
+/**
+ * Delete a submission
+ *
+ * Permanently deletes a submission and its attachments.
+ */
+declare const deleteApiV1SubmissionsBySubmissionId: <ThrowOnError extends boolean = false>(options: Options<DeleteApiV1SubmissionsBySubmissionIdData, ThrowOnError>) => RequestResult<DeleteApiV1SubmissionsBySubmissionIdResponses, DeleteApiV1SubmissionsBySubmissionIdErrors, ThrowOnError, "fields">;
+/**
+ * Get a submission
+ *
+ * Returns details of a specific submission.
+ */
+declare const getApiV1SubmissionsBySubmissionId: <ThrowOnError extends boolean = false>(options: Options<GetApiV1SubmissionsBySubmissionIdData, ThrowOnError>) => RequestResult<GetApiV1SubmissionsBySubmissionIdResponses, GetApiV1SubmissionsBySubmissionIdErrors, ThrowOnError, "fields">;
+/**
+ * Download an attachment
+ *
+ * Downloads a file attachment from a submission. Returns the file with appropriate Content-Type and Content-Disposition headers.
+ */
+declare const getApiV1SubmissionsBySubmissionIdAttachmentsByFilename: <ThrowOnError extends boolean = false>(options: Options<GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameData, ThrowOnError>) => RequestResult<GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameResponses, GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameErrors, ThrowOnError, "fields">;
+
+export { type Attachment, type Captcha, type ClientOptions, type CreateForm, type CreateSite, type DeleteApiV1FormsByFormIdData, type DeleteApiV1FormsByFormIdError, type DeleteApiV1FormsByFormIdErrors, type DeleteApiV1FormsByFormIdResponse, type DeleteApiV1FormsByFormIdResponses, type DeleteApiV1SitesBySiteIdData, type DeleteApiV1SitesBySiteIdError, type DeleteApiV1SitesBySiteIdErrors, type DeleteApiV1SitesBySiteIdResponse, type DeleteApiV1SitesBySiteIdResponses, type DeleteApiV1SubmissionsBySubmissionIdData, type DeleteApiV1SubmissionsBySubmissionIdError, type DeleteApiV1SubmissionsBySubmissionIdErrors, type DeleteApiV1SubmissionsBySubmissionIdResponse, type DeleteApiV1SubmissionsBySubmissionIdResponses, type Error, type Form, type FormsList, type GetApiV1FormsByFormIdData, type GetApiV1FormsByFormIdError, type GetApiV1FormsByFormIdErrors, type GetApiV1FormsByFormIdResponse, type GetApiV1FormsByFormIdResponses, type GetApiV1FormsByFormIdSubmissionsData, type GetApiV1FormsByFormIdSubmissionsError, type GetApiV1FormsByFormIdSubmissionsErrors, type GetApiV1FormsByFormIdSubmissionsResponse, type GetApiV1FormsByFormIdSubmissionsResponses, type GetApiV1FormsData, type GetApiV1FormsError, type GetApiV1FormsErrors, type GetApiV1FormsResponse, type GetApiV1FormsResponses, type GetApiV1SitesBySiteIdData, type GetApiV1SitesBySiteIdError, type GetApiV1SitesBySiteIdErrors, type GetApiV1SitesBySiteIdFormsData, type GetApiV1SitesBySiteIdFormsError, type GetApiV1SitesBySiteIdFormsErrors, type GetApiV1SitesBySiteIdFormsResponse, type GetApiV1SitesBySiteIdFormsResponses, type GetApiV1SitesBySiteIdResponse, type GetApiV1SitesBySiteIdResponses, type GetApiV1SitesData, type GetApiV1SitesError, type GetApiV1SitesErrors, type GetApiV1SitesResponse, type GetApiV1SitesResponses, type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameData, type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameError, type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameErrors, type GetApiV1SubmissionsBySubmissionIdAttachmentsByFilenameResponses, type GetApiV1SubmissionsBySubmissionIdData, type GetApiV1SubmissionsBySubmissionIdError, type GetApiV1SubmissionsBySubmissionIdErrors, type GetApiV1SubmissionsBySubmissionIdResponse, type GetApiV1SubmissionsBySubmissionIdResponses, type Options, type PatchApiV1FormsByFormIdData, type PatchApiV1FormsByFormIdError, type PatchApiV1FormsByFormIdErrors, type PatchApiV1FormsByFormIdResponse, type PatchApiV1FormsByFormIdResponses, type PatchApiV1SitesBySiteIdData, type PatchApiV1SitesBySiteIdDomainsData, type PatchApiV1SitesBySiteIdDomainsError, type PatchApiV1SitesBySiteIdDomainsErrors, type PatchApiV1SitesBySiteIdDomainsResponse, type PatchApiV1SitesBySiteIdDomainsResponses, type PatchApiV1SitesBySiteIdError, type PatchApiV1SitesBySiteIdErrors, type PatchApiV1SitesBySiteIdResponse, type PatchApiV1SitesBySiteIdResponses, type PostApiV1FormsData, type PostApiV1FormsError, type PostApiV1FormsErrors, type PostApiV1FormsResponse, type PostApiV1FormsResponses, type PostApiV1SitesBySiteIdFormsData, type PostApiV1SitesBySiteIdFormsError, type PostApiV1SitesBySiteIdFormsErrors, type PostApiV1SitesBySiteIdFormsResponse, type PostApiV1SitesBySiteIdFormsResponses, type PostApiV1SitesData, type PostApiV1SitesError, type PostApiV1SitesErrors, type PostApiV1SitesResponse, type PostApiV1SitesResponses, type Site, type SiteDomains, type SiteWithToken, type SitesList, type Submission, type SubmissionMetadata, type SubmissionsList, type UpdateForm, type UpdateSite, type UpdateSiteDomains, deleteApiV1FormsByFormId, deleteApiV1SitesBySiteId, deleteApiV1SubmissionsBySubmissionId, getApiV1Forms, getApiV1FormsByFormId, getApiV1FormsByFormIdSubmissions, getApiV1Sites, getApiV1SitesBySiteId, getApiV1SitesBySiteIdForms, getApiV1SubmissionsBySubmissionId, getApiV1SubmissionsBySubmissionIdAttachmentsByFilename, patchApiV1FormsByFormId, patchApiV1SitesBySiteId, patchApiV1SitesBySiteIdDomains, postApiV1Forms, postApiV1Sites, postApiV1SitesBySiteIdForms };