webflow-api 3.2.0 → 3.2.2

package/api/resources/scripts/client/Client.js

@@ -57,7 +57,7 @@ const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
 class Scripts {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -414,7 +414,11 @@ class Scripts {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

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

@@ -11,12 +11,13 @@ import { WellKnown } from "../resources/wellKnown/client/Client";
 import { ActivityLogs } from "../resources/activityLogs/client/Client";
 import { Comments } from "../resources/comments/client/Client";
 import { Scripts } from "../resources/scripts/client/Client";
+import { Forms } from "../resources/forms/client/Client";
 export declare namespace Sites {
     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>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -43,7 +44,8 @@ export declare class Sites {
     protected _activityLogs: ActivityLogs | undefined;
     protected _comments: Comments | undefined;
     protected _scripts: Scripts | undefined;
-    constructor(_options: Sites.Options);
+    protected _forms: Forms | undefined;
+    constructor(_options?: Sites.Options);
     get redirects(): Redirects;
     get plans(): Plans;
     get robotsTxt(): RobotsTxt;
@@ -51,6 +53,7 @@ export declare class Sites {
     get activityLogs(): ActivityLogs;
     get comments(): Comments;
     get scripts(): Scripts;
+    get forms(): Forms;
     /**
      * Create a site.
      *
@@ -202,5 +205,5 @@ export declare class Sites {
      */
     publish(siteId: string, request?: Webflow.SitesPublishRequest, requestOptions?: Sites.RequestOptions): core.HttpResponsePromise<Webflow.SitesPublishResponse>;
     private __publish;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/sites/client/Client.js

@@ -63,11 +63,12 @@ const Client_4 = require("../resources/wellKnown/client/Client");
 const Client_5 = require("../resources/activityLogs/client/Client");
 const Client_6 = require("../resources/comments/client/Client");
 const Client_7 = require("../resources/scripts/client/Client");
+const Client_8 = require("../resources/forms/client/Client");
 /**
  * Sites are the sites in your Webflow workspace.
  */
 class Sites {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get redirects() {
@@ -98,6 +99,10 @@ class Sites {
         var _a;
         return ((_a = this._scripts) !== null && _a !== void 0 ? _a : (this._scripts = new Client_7.Scripts(this._options)));
     }
+    get forms() {
+        var _a;
+        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Client_8.Forms(this._options)));
+    }
     /**
      * Create a site.
      *
@@ -855,7 +860,11 @@ class Sites {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

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

@@ -9,7 +9,7 @@ export declare namespace ActivityLogs {
         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>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -26,7 +26,7 @@ export declare namespace ActivityLogs {
 }
 export declare class ActivityLogs {
     protected readonly _options: ActivityLogs.Options;
-    constructor(_options: ActivityLogs.Options);
+    constructor(_options?: ActivityLogs.Options);
     /**
      * Retrieve Activity Logs for a specific Site.
      *
@@ -44,9 +44,12 @@ export declare class ActivityLogs {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741")
+     *     await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741", {
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     list(siteId: string, request?: Webflow.sites.ActivityLogsListRequest, requestOptions?: ActivityLogs.RequestOptions): core.HttpResponsePromise<Webflow.SiteActivityLogResponse>;
     private __list;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/sites/resources/activityLogs/client/Client.js

@@ -57,7 +57,7 @@ const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../../../serialization/index"));
 const errors = __importStar(require("../../../../../../errors/index"));
 class ActivityLogs {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -77,7 +77,10 @@ class ActivityLogs {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741")
+     *     await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741", {
+     *         limit: 1,
+     *         offset: 1
+     *     })
      */
     list(siteId, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__list(siteId, request, requestOptions));
@@ -170,7 +173,11 @@ class ActivityLogs {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/sites/resources/activityLogs/client/requests/ActivityLogsListRequest.d.ts

@@ -3,7 +3,10 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ActivityLogsListRequest {
     /**

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

@@ -9,7 +9,7 @@ export declare namespace Comments {
         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>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -26,7 +26,7 @@ export declare namespace Comments {
 }
 export declare class Comments {
     protected readonly _options: Comments.Options;
-    constructor(_options: Comments.Options);
+    constructor(_options?: Comments.Options);
     /**
      * List all comment threads for a site.
      *
@@ -48,7 +48,11 @@ export declare class Comments {
      *
      * @example
      *     await client.sites.comments.listCommentThreads("580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         offset: 1,
+     *         limit: 1,
+     *         sortBy: "createdOn",
+     *         sortOrder: "asc"
      *     })
      */
     listCommentThreads(siteId: string, request?: Webflow.sites.CommentsListCommentThreadsRequest, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Webflow.CommentThreadList>;
@@ -75,7 +79,11 @@ export declare class Comments {
      *
      * @example
      *     await client.sites.comments.getCommentThread("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         offset: 1,
+     *         limit: 1,
+     *         sortBy: "createdOn",
+     *         sortOrder: "asc"
      *     })
      */
     getCommentThread(siteId: string, commentThreadId: string, request?: Webflow.sites.CommentsGetCommentThreadRequest, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Webflow.CommentThread>;
@@ -102,10 +110,14 @@ export declare class Comments {
      *
      * @example
      *     await client.sites.comments.listCommentReplies("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         offset: 1,
+     *         limit: 1,
+     *         sortBy: "createdOn",
+     *         sortOrder: "asc"
      *     })
      */
     listCommentReplies(siteId: string, commentThreadId: string, request?: Webflow.sites.CommentsListCommentRepliesRequest, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Webflow.CommentReplyList>;
     private __listCommentReplies;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/sites/resources/comments/client/Client.js

@@ -57,7 +57,7 @@ const headers_js_1 = require("../../../../../../core/headers.js");
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../../../errors/index"));
 class Comments {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -81,7 +81,11 @@ class Comments {
      *
      * @example
      *     await client.sites.comments.listCommentThreads("580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         offset: 1,
+     *         limit: 1,
+     *         sortBy: "createdOn",
+     *         sortOrder: "asc"
      *     })
      */
     listCommentThreads(siteId, request = {}, requestOptions) {
@@ -220,7 +224,11 @@ class Comments {
      *
      * @example
      *     await client.sites.comments.getCommentThread("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         offset: 1,
+     *         limit: 1,
+     *         sortBy: "createdOn",
+     *         sortOrder: "asc"
      *     })
      */
     getCommentThread(siteId, commentThreadId, request = {}, requestOptions) {
@@ -359,7 +367,11 @@ class Comments {
      *
      * @example
      *     await client.sites.comments.listCommentReplies("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         offset: 1,
+     *         limit: 1,
+     *         sortBy: "createdOn",
+     *         sortOrder: "asc"
      *     })
      */
     listCommentReplies(siteId, commentThreadId, request = {}, requestOptions) {
@@ -478,7 +490,11 @@ class Comments {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/sites/resources/comments/client/requests/CommentsGetCommentThreadRequest.d.ts

@@ -5,12 +5,18 @@ import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {
- *         localeId: "65427cf400e02b306eaa04a0"
+ *         localeId: "65427cf400e02b306eaa04a0",
+ *         offset: 1,
+ *         limit: 1,
+ *         sortBy: "createdOn",
+ *         sortOrder: "asc"
  *     }
  */
 export interface CommentsGetCommentThreadRequest {
     /**
-     * Unique identifier for a specific locale. Applicable, when using localization.
+     * Unique identifier for a specific Locale.
+     *
+     * [Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
      */
     localeId?: string;
     /**

package/api/resources/sites/resources/comments/client/requests/CommentsListCommentRepliesRequest.d.ts

@@ -5,12 +5,18 @@ import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {
- *         localeId: "65427cf400e02b306eaa04a0"
+ *         localeId: "65427cf400e02b306eaa04a0",
+ *         offset: 1,
+ *         limit: 1,
+ *         sortBy: "createdOn",
+ *         sortOrder: "asc"
  *     }
  */
 export interface CommentsListCommentRepliesRequest {
     /**
-     * Unique identifier for a specific locale. Applicable, when using localization.
+     * Unique identifier for a specific Locale.
+     *
+     * [Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
      */
     localeId?: string;
     /**

package/api/resources/sites/resources/comments/client/requests/CommentsListCommentThreadsRequest.d.ts

@@ -5,12 +5,18 @@ import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {
- *         localeId: "65427cf400e02b306eaa04a0"
+ *         localeId: "65427cf400e02b306eaa04a0",
+ *         offset: 1,
+ *         limit: 1,
+ *         sortBy: "createdOn",
+ *         sortOrder: "asc"
  *     }
  */
 export interface CommentsListCommentThreadsRequest {
     /**
-     * Unique identifier for a specific locale. Applicable, when using localization.
+     * Unique identifier for a specific Locale.
+     *
+     * [Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
      */
     localeId?: string;
     /**

package/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>;
+}