webflow-api 3.2.1 → 3.2.2

package/dist/api/resources/sites/resources/forms/client/Client.d.ts

@@ -0,0 +1,157 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments";
+import * as core from "../../../../../../core";
+import * as Webflow from "../../../../../index";
+export declare namespace Forms {
+    interface Options {
+        environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Forms {
+    protected readonly _options: Forms.Options;
+    constructor(_options?: Forms.Options);
+    /**
+     * List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`.
+     *
+     * Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response).
+     *
+     * <Note title="Forms in components">
+     * When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components.
+     * </Note>
+     *
+     * Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID.
+     *
+     * Required scope | `forms:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.sites.FormsListSubmissionsBySiteRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.ForbiddenError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
+     *         elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
+     *         offset: 1,
+     *         limit: 1
+     *     })
+     */
+    listSubmissionsBySite(siteId: string, request?: Webflow.sites.FormsListSubmissionsBySiteRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmissionList>;
+    private __listSubmissionsBySite;
+    /**
+     * List form submissions for a given form ID within a specific site.
+     *
+     * Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`.
+     *
+     * Required scope | `forms:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} formId - Unique identifier for a Form
+     * @param {Webflow.sites.FormsListSubmissionsRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.ForbiddenError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.forms.listSubmissions("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
+     *         offset: 1,
+     *         limit: 1
+     *     })
+     */
+    listSubmissions(siteId: string, formId: string, request?: Webflow.sites.FormsListSubmissionsRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmissionList>;
+    private __listSubmissions;
+    /**
+     * Get information about a form submission within a specific site.
+     *
+     * Required scope | `forms:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.ForbiddenError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.forms.getSubmission("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741")
+     */
+    getSubmission(siteId: string, formSubmissionId: string, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmission>;
+    private __getSubmission;
+    /**
+     * Delete a form submission within a specific site.
+     *
+     * Required scope | `forms:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.ForbiddenError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.ConflictError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.forms.deleteSubmission("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741")
+     */
+    deleteSubmission(siteId: string, formSubmissionId: string, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteSubmission;
+    /**
+     * Update hidden fields on a form submission within a specific site.
+     *
+     * Required scope | `forms:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Webflow.sites.FormsUpdateSubmissionRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.ForbiddenError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.ConflictError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.forms.updateSubmission("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741")
+     */
+    updateSubmission(siteId: string, formSubmissionId: string, request?: Webflow.sites.FormsUpdateSubmissionRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmission>;
+    private __updateSubmission;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}