webflow-api 2.3.2 → 2.3.6

package/dist/api/resources/users/client/Client.d.ts

@@ -3,15 +3,19 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Webflow from "../../..";
+import * as Webflow from "../../../index";
 export declare namespace Users {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | string>;
         accessToken: core.Supplier<core.BearerToken>;
     }
     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;
     }
 }
 export declare class Users {
@@ -19,6 +23,11 @@ export declare class Users {
     constructor(_options: Users.Options);
     /**
      * Get a list of users for a site <br><br> Required scope | `users:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.UsersListRequest} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -27,11 +36,16 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.list("site_id", {})
+     *     await client.users.list("site_id")
      */
     list(siteId: string, request?: Webflow.UsersListRequest, requestOptions?: Users.RequestOptions): Promise<Webflow.UserList>;
     /**
      * Get a User by ID <br><br> Required scope | `users:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} userId - Unique identifier for a User
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -40,11 +54,16 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.get("site_id", "user_id")
+     *     await client.users.get("site_id", "user_id")
      */
     get(siteId: string, userId: string, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
     /**
      * Delete a User by ID <br><br> Required scope | `users:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} userId - Unique identifier for a User
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -53,13 +72,19 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.delete("site_id", "user_id")
+     *     await client.users.delete("site_id", "user_id")
      */
     delete(siteId: string, userId: string, requestOptions?: Users.RequestOptions): Promise<void>;
     /**
      * Update a User by ID <br><br> Required scope | `users:write`
      *
      * <aside class="notice">The <code>email</code> and <code>password</code> fields cannot be updated using this endpoint</aside>
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} userId - Unique identifier for a User
+     * @param {Webflow.UsersUpdateRequest} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -68,18 +93,23 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.update("site_id", "user_id", {
+     *     await client.users.update("site_id", "user_id", {
      *         data: {
      *             name: "Some One",
      *             acceptPrivacy: false,
      *             acceptCommunications: false
      *         },
-     *         accessGroups: ["webflowers", "platinum", "free-tier", "accessGroups"]
+     *         accessGroups: ["webflowers", "platinum", "free-tier"]
      *     })
      */
     update(siteId: string, userId: string, request?: Webflow.UsersUpdateRequest, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
     /**
      * Create and invite a user with an email address. The user will be sent and invite via email, which they will need to accept in order to join paid Access Groups. <br><br> Required scope | `users:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.UsersInviteRequest} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -89,9 +119,9 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.invite("site_id", {
+     *     await client.users.invite("site_id", {
      *         email: "some.one@home.com",
-     *         accessGroups: ["webflowers", "accessGroups"]
+     *         accessGroups: ["webflowers"]
      *     })
      */
     invite(siteId: string, request: Webflow.UsersInviteRequest, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;

package/dist/api/resources/users/client/Client.js

@@ -41,16 +41,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Users = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Webflow = __importStar(require("../../.."));
+const Webflow = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 class Users {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * Get a list of users for a site <br><br> Required scope | `users:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.UsersListRequest} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -59,7 +64,7 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.list("site_id", {})
+     *     await client.users.list("site_id")
      */
     list(siteId, request = {}, requestOptions) {
         var _a;
@@ -76,13 +81,13 @@ class Users {
                 _queryParams["sort"] = sort;
             }
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.2",
+                    "X-Fern-SDK-Version": "2.3.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -90,6 +95,7 @@ class Users {
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.UserList.parseOrThrow(_response.body, {
@@ -111,7 +117,13 @@ class Users {
                     case 404:
                         throw new Webflow.NotFoundError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(_response.error.body);
+                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 500:
                         throw new Webflow.InternalServerError(_response.error.body);
                     default:
@@ -138,6 +150,11 @@ class Users {
     }
     /**
      * Get a User by ID <br><br> Required scope | `users:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} userId - Unique identifier for a User
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -146,25 +163,26 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.get("site_id", "user_id")
+     *     await client.users.get("site_id", "user_id")
      */
     get(siteId, userId, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/${userId}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/${encodeURIComponent(userId)}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.2",
+                    "X-Fern-SDK-Version": "2.3.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.User.parseOrThrow(_response.body, {
@@ -186,7 +204,13 @@ class Users {
                     case 404:
                         throw new Webflow.NotFoundError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(_response.error.body);
+                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 500:
                         throw new Webflow.InternalServerError(_response.error.body);
                     default:
@@ -213,6 +237,11 @@ class Users {
     }
     /**
      * Delete a User by ID <br><br> Required scope | `users:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} userId - Unique identifier for a User
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -221,25 +250,26 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.delete("site_id", "user_id")
+     *     await client.users.delete("site_id", "user_id")
      */
     delete(siteId, userId, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/${userId}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/${encodeURIComponent(userId)}`),
                 method: "DELETE",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.2",
+                    "X-Fern-SDK-Version": "2.3.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return;
@@ -255,7 +285,13 @@ class Users {
                     case 404:
                         throw new Webflow.NotFoundError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(_response.error.body);
+                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 500:
                         throw new Webflow.InternalServerError(_response.error.body);
                     default:
@@ -284,6 +320,12 @@ class Users {
      * Update a User by ID <br><br> Required scope | `users:write`
      *
      * <aside class="notice">The <code>email</code> and <code>password</code> fields cannot be updated using this endpoint</aside>
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} userId - Unique identifier for a User
+     * @param {Webflow.UsersUpdateRequest} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -292,26 +334,26 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.update("site_id", "user_id", {
+     *     await client.users.update("site_id", "user_id", {
      *         data: {
      *             name: "Some One",
      *             acceptPrivacy: false,
      *             acceptCommunications: false
      *         },
-     *         accessGroups: ["webflowers", "platinum", "free-tier", "accessGroups"]
+     *         accessGroups: ["webflowers", "platinum", "free-tier"]
      *     })
      */
     update(siteId, userId, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/${userId}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/${encodeURIComponent(userId)}`),
                 method: "PATCH",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.2",
+                    "X-Fern-SDK-Version": "2.3.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -319,6 +361,7 @@ class Users {
                 body: yield serializers.UsersUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.User.parseOrThrow(_response.body, {
@@ -340,7 +383,13 @@ class Users {
                     case 404:
                         throw new Webflow.NotFoundError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(_response.error.body);
+                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 500:
                         throw new Webflow.InternalServerError(_response.error.body);
                     default:
@@ -367,6 +416,11 @@ class Users {
     }
     /**
      * Create and invite a user with an email address. The user will be sent and invite via email, which they will need to accept in order to join paid Access Groups. <br><br> Required scope | `users:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.UsersInviteRequest} request
+     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -376,22 +430,22 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.invite("site_id", {
+     *     await client.users.invite("site_id", {
      *         email: "some.one@home.com",
-     *         accessGroups: ["webflowers", "accessGroups"]
+     *         accessGroups: ["webflowers"]
      *     })
      */
     invite(siteId, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${siteId}/users/invite`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/users/invite`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.2",
+                    "X-Fern-SDK-Version": "2.3.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -399,6 +453,7 @@ class Users {
                 body: yield serializers.UsersInviteRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.User.parseOrThrow(_response.body, {
@@ -422,7 +477,13 @@ class Users {
                     case 409:
                         throw new Webflow.ConflictError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(_response.error.body);
+                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 500:
                         throw new Webflow.InternalServerError(_response.error.body);
                     default:

package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         email: "some.one@home.com",
- *         accessGroups: ["webflowers", "accessGroups"]
+ *         accessGroups: ["webflowers"]
  *     }
  */
 export interface UsersInviteRequest {

package/dist/api/resources/users/client/requests/UsersListRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "../../../..";
+import * as Webflow from "../../../../index";
 /**
  * @example
  *     {}

package/dist/api/resources/users/client/requests/UsersUpdateRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "../../../..";
+import * as Webflow from "../../../../index";
 /**
  * @example
  *     {
@@ -10,7 +10,7 @@ import * as Webflow from "../../../..";
  *             acceptPrivacy: false,
  *             acceptCommunications: false
  *         },
- *         accessGroups: ["webflowers", "platinum", "free-tier", "accessGroups"]
+ *         accessGroups: ["webflowers", "platinum", "free-tier"]
  *     }
  */
 export interface UsersUpdateRequest {

package/dist/api/resources/users/client/requests/index.d.ts

@@ -1,3 +1,3 @@
-export { UsersListRequest } from "./UsersListRequest";
-export { UsersUpdateRequest } from "./UsersUpdateRequest";
-export { UsersInviteRequest } from "./UsersInviteRequest";
+export { type UsersListRequest } from "./UsersListRequest";
+export { type UsersUpdateRequest } from "./UsersUpdateRequest";
+export { type UsersInviteRequest } from "./UsersInviteRequest";

package/dist/api/resources/webhooks/client/Client.d.ts

@@ -3,15 +3,19 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Webflow from "../../..";
+import * as Webflow from "../../../index";
 export declare namespace Webhooks {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | string>;
         accessToken: core.Supplier<core.BearerToken>;
     }
     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;
     }
 }
 export declare class Webhooks {
@@ -19,6 +23,10 @@ export declare class Webhooks {
     constructor(_options: Webhooks.Options);
     /**
      * List all App-created Webhooks registered for a given site </br></br> Required scope | `sites:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -26,11 +34,16 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.list("site_id")
+     *     await client.webhooks.list("site_id")
      */
     list(siteId: string, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.WebhookList>;
     /**
-     * Create a new Webhook, to be notified when Webflow resources change. Limit of 75 registrations per `triggerType`, per site. </br></br> Access to this endpoint requires a bearer token from a Data Client App. The only exceptions are for creating webhooks with `site_publish` or `form_submission` triggers, which can be done with Site Tokens </br> Required scope | `sites:write`
+     * Create a new Webhook, to be notified when Webflow resources change. Limit of 75 registrations per `triggerType`, per site. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `sites:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.Webhook} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -38,14 +51,23 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.create("site_id", {
+     *     await client.webhooks.create("site_id", {
+     *         id: "582266e0cd48de0f0e3c6d8b",
      *         triggerType: Webflow.TriggerType.FormSubmission,
-     *         url: "https://api.mydomain.com/webhook"
+     *         url: "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f",
+     *         workspaceId: "4f4e46fd476ea8c507000001",
+     *         siteId: "562ac0395358780a1f5e6fbd",
+     *         lastTriggered: new Date("2023-02-08T23:59:28.000Z"),
+     *         createdOn: new Date("2022-11-08T23:59:28.000Z")
      *     })
      */
-    create(siteId: string, request: Webflow.WebhooksCreateRequest, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook>;
+    create(siteId: string, request: Webflow.Webhook, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook>;
     /**
      * Get a specific Webhook instance
+     *
+     * @param {string} webhookId - Unique identifier for a Webhook
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -53,11 +75,15 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.get("webhook_id")
+     *     await client.webhooks.get("webhook_id")
      */
     get(webhookId: string, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook>;
     /**
      * Remove a Webhook
+     *
+     * @param {string} webhookId - Unique identifier for a Webhook
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -65,7 +91,7 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.delete("webhook_id")
+     *     await client.webhooks.delete("webhook_id")
      */
     delete(webhookId: string, requestOptions?: Webhooks.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;