webflow-api 2.4.0 → 2.5.0

package/api/errors/UnauthorizedError.d.ts

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
+import * as Webflow from "../index";
 export declare class UnauthorizedError extends errors.WebflowError {
-    constructor(body?: unknown);
+    constructor(body: Webflow.Error_);
 }

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

@@ -16,13 +16,17 @@ export declare namespace AccessGroups {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class AccessGroups {
     protected readonly _options: AccessGroups.Options;
     constructor(_options: AccessGroups.Options);
     /**
-     * Get a list of access groups for a site <br><br> Required scope | `users:read`
+     * Get a list of access groups for a site
+     *
+     * Required scope | `users:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AccessGroupsListRequest} request

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

@@ -50,7 +50,9 @@ class AccessGroups {
         this._options = _options;
     }
     /**
-     * Get a list of access groups for a site <br><br> Required scope | `users:read`
+     * Get a list of access groups for a site
+     *
+     * Required scope | `users:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AccessGroupsListRequest} request
@@ -83,15 +85,7 @@ class AccessGroups {
             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/${encodeURIComponent(siteId)}/accessgroups`),
                 method: "GET",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.4.0",
-                    "User-Agent": "webflow-api/2.4.0",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "2.5.0", "User-Agent": "webflow-api/2.5.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -113,13 +107,25 @@ class AccessGroups {
                     case 400:
                         throw new Webflow.BadRequestError(_response.error.body);
                     case 401:
-                        throw new Webflow.UnauthorizedError(_response.error.body);
+                        throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 403:
                         throw new Webflow.ForbiddenError(_response.error.body);
                     case 404:
-                        throw new Webflow.NotFoundError(_response.error.body);
+                        throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 429:
-                        throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                        throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -127,7 +133,13 @@ class AccessGroups {
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new Webflow.InternalServerError(_response.error.body);
+                        throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,
@@ -142,7 +154,7 @@ class AccessGroups {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.WebflowTimeoutError();
+                    throw new errors.WebflowTimeoutError("Timeout exceeded when calling GET /sites/{site_id}/accessgroups.");
                 case "unknown":
                     throw new errors.WebflowError({
                         message: _response.error.errorMessage,

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

@@ -16,13 +16,17 @@ export declare namespace Assets {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Assets {
     protected readonly _options: Assets.Options;
     constructor(_options: Assets.Options);
     /**
-     * List assets for a given site </br></br> Required scope | `assets:read`
+     * List assets for a given site
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,7 +42,13 @@ export declare class Assets {
      */
     list(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.Assets>;
     /**
-     * Create a new asset entry. </br></br> This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) request to the `uploadUrl` with the `uploadDetails` object as your header information in the request. </br></br> Required scope | `assets:write`
+     * Create a new asset entry.
+     *
+     * This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
+     * You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
+     * request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
+     *
+     * Required scope | `assets:write`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AssetsCreateRequest} request
@@ -58,7 +68,9 @@ export declare class Assets {
      */
     create(siteId: string, request: Webflow.AssetsCreateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetUpload>;
     /**
-     * Get an Asset </br></br> Required scope | `assets:read`
+     * Get an Asset
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} assetId - Unique identifier for an Asset on a site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -76,6 +88,8 @@ export declare class Assets {
     /**
      * Delete an Asset
      *
+     * Required Scope: `assets: write`
+     *
      * @param {string} assetId - Unique identifier for an Asset on a site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,7 +104,9 @@ export declare class Assets {
      */
     delete(assetId: string, requestOptions?: Assets.RequestOptions): Promise<void>;
     /**
-     * Update an Asset </br></br> Required scope | `assets:write`
+     * Update an Asset
+     *
+     * Required scope | `assets:write`
      *
      * @param {string} assetId - Unique identifier for an Asset on a site
      * @param {Webflow.AssetsUpdateRequest} request
@@ -103,13 +119,13 @@ export declare class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.update("580e63fc8c9a982ac9b8b745", {
-     *         displayName: "bulldoze.png"
-     *     })
+     *     await client.assets.update("580e63fc8c9a982ac9b8b745")
      */
-    update(assetId: string, request: Webflow.AssetsUpdateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.Asset>;
+    update(assetId: string, request?: Webflow.AssetsUpdateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.Asset>;
     /**
-     * List Asset Folders within a given site <br><br> Required scope | `assets:read`
+     * List Asset Folders within a given site
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -125,7 +141,9 @@ export declare class Assets {
      */
     listFolders(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolderList>;
     /**
-     * Create an Asset Folder within a given site <br><br> Required scope | `assets:write`
+     * Create an Asset Folder within a given site
+     *
+     * Required scope | `assets:write`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AssetsCreateFolderRequest} request
@@ -144,7 +162,9 @@ export declare class Assets {
      */
     createFolder(siteId: string, request: Webflow.AssetsCreateFolderRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolder>;
     /**
-     * Get details about a specific Asset Folder <br><br> Required scope | `assets:read`
+     * Get details about a specific Asset Folder
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} assetFolderId - Unique identifier for an Asset Folder
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.