webflow-api 3.2.1 → 3.3.0-beta

package/api/resources/sites/resources/comments/types/CommentsListCommentRepliesRequestSortOrder.js

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

package/api/resources/sites/resources/comments/types/CommentsListCommentThreadsRequestSortBy.d.ts

@@ -1,8 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type CommentsListCommentThreadsRequestSortBy = "createdOn" | "lastUpdated";
 export declare const CommentsListCommentThreadsRequestSortBy: {
     readonly CreatedOn: "createdOn";
     readonly LastUpdated: "lastUpdated";
 };
+export type CommentsListCommentThreadsRequestSortBy = (typeof CommentsListCommentThreadsRequestSortBy)[keyof typeof CommentsListCommentThreadsRequestSortBy];

package/api/resources/sites/resources/comments/types/CommentsListCommentThreadsRequestSortBy.js

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

package/api/resources/sites/resources/comments/types/CommentsListCommentThreadsRequestSortOrder.d.ts

@@ -1,8 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type CommentsListCommentThreadsRequestSortOrder = "asc" | "desc";
 export declare const CommentsListCommentThreadsRequestSortOrder: {
     readonly Asc: "asc";
     readonly Desc: "desc";
 };
+export type CommentsListCommentThreadsRequestSortOrder = (typeof CommentsListCommentThreadsRequestSortOrder)[keyof typeof CommentsListCommentThreadsRequestSortOrder];

package/api/resources/sites/resources/comments/types/CommentsListCommentThreadsRequestSortOrder.js

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

package/api/resources/sites/resources/comments/types/index.d.ts

@@ -1,6 +1,6 @@
-export * from "./CommentsListCommentThreadsRequestSortBy";
-export * from "./CommentsListCommentThreadsRequestSortOrder";
 export * from "./CommentsGetCommentThreadRequestSortBy";
 export * from "./CommentsGetCommentThreadRequestSortOrder";
 export * from "./CommentsListCommentRepliesRequestSortBy";
 export * from "./CommentsListCommentRepliesRequestSortOrder";
+export * from "./CommentsListCommentThreadsRequestSortBy";
+export * from "./CommentsListCommentThreadsRequestSortOrder";

package/api/resources/sites/resources/comments/types/index.js

@@ -14,9 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./CommentsListCommentThreadsRequestSortBy"), exports);
-__exportStar(require("./CommentsListCommentThreadsRequestSortOrder"), exports);
 __exportStar(require("./CommentsGetCommentThreadRequestSortBy"), exports);
 __exportStar(require("./CommentsGetCommentThreadRequestSortOrder"), exports);
 __exportStar(require("./CommentsListCommentRepliesRequestSortBy"), exports);
 __exportStar(require("./CommentsListCommentRepliesRequestSortOrder"), exports);
+__exportStar(require("./CommentsListCommentThreadsRequestSortBy"), exports);
+__exportStar(require("./CommentsListCommentThreadsRequestSortOrder"), exports);

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

@@ -0,0 +1,140 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient";
+import * as core from "../../../../../../core";
+import * as Webflow from "../../../../../index";
+export declare namespace Forms {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+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.1,
+     *         limit: 1.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.1,
+     *         limit: 1.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>;
+}