webflow-api 2.3.2 → 2.3.6

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

@@ -3,22 +3,30 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Webflow from "../../..";
+import * as Webflow from "../../../index";
 export declare namespace Scripts {
     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 Scripts {
     protected readonly _options: Scripts.Options;
     constructor(_options: Scripts.Options);
     /**
-     * List of scripts registered to a Site. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. Access to this endpoint requires a bearer token from a Data Client App. </br></br> Required scope | `custom_code:read`
+     * List of scripts registered to a Site. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. <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 | `custom_code:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -26,11 +34,16 @@ export declare class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.scripts.list("site_id")
+     *     await client.scripts.list("site_id")
      */
     list(siteId: string, requestOptions?: Scripts.RequestOptions): Promise<Webflow.RegisteredScriptList>;
     /**
-     * Add a script to a Site's Custom Code registry. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. Access to this endpoint requires a bearer token from a Data Client App. </br></br> Required scope | `custom_code:write`
+     * Add a script to a Site's Custom Code registry. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. <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> </br></br> Required scope | `custom_code:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.CustomCodeHostedRequest} request
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -38,7 +51,7 @@ export declare class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.scripts.registerHosted("site_id", {
+     *     await client.scripts.registerHosted("site_id", {
      *         hostedLocation: "hostedLocation",
      *         integrityHash: "integrityHash",
      *         version: "version",
@@ -47,7 +60,12 @@ export declare class Scripts {
      */
     registerHosted(siteId: string, request: Webflow.CustomCodeHostedRequest, requestOptions?: Scripts.RequestOptions): Promise<Webflow.CustomCodeHostedResponse>;
     /**
-     * Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. </br></br> Access to this endpoint requires a bearer token from a Data Client App. Required scope | `custom_code:write`
+     * Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. </br></br> <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 | `custom_code:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.CustomCodeInlineRequest} request
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -55,7 +73,7 @@ export declare class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.scripts.registerInline("site_id", {
+     *     await client.scripts.registerInline("site_id", {
      *         sourceCode: "alert('hello world');",
      *         version: "0.0.1",
      *         displayName: "Alert"

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

@@ -41,16 +41,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Scripts = 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 Scripts {
     constructor(_options) {
         this._options = _options;
     }
     /**
-     * List of scripts registered to a Site. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. Access to this endpoint requires a bearer token from a Data Client App. </br></br> Required scope | `custom_code:read`
+     * List of scripts registered to a Site. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. <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 | `custom_code:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -58,25 +62,26 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.scripts.list("site_id")
+     *     await client.scripts.list("site_id")
      */
     list(siteId, 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}/registered_scripts`),
+                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)}/registered_scripts`),
                 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.RegisteredScriptList.parseOrThrow(_response.body, {
@@ -96,7 +101,13 @@ class Scripts {
                     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:
@@ -122,7 +133,12 @@ class Scripts {
         });
     }
     /**
-     * Add a script to a Site's Custom Code registry. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. Access to this endpoint requires a bearer token from a Data Client App. </br></br> Required scope | `custom_code:write`
+     * Add a script to a Site's Custom Code registry. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. <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> </br></br> Required scope | `custom_code:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.CustomCodeHostedRequest} request
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -130,7 +146,7 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.scripts.registerHosted("site_id", {
+     *     await client.scripts.registerHosted("site_id", {
      *         hostedLocation: "hostedLocation",
      *         integrityHash: "integrityHash",
      *         version: "version",
@@ -141,13 +157,13 @@ class Scripts {
         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}/registered_scripts/hosted`),
+                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)}/registered_scripts/hosted`),
                 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,
                 },
@@ -155,6 +171,7 @@ class Scripts {
                 body: yield serializers.CustomCodeHostedRequest.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.CustomCodeHostedResponse.parseOrThrow(_response.body, {
@@ -174,7 +191,13 @@ class Scripts {
                     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:
@@ -200,7 +223,12 @@ class Scripts {
         });
     }
     /**
-     * Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. </br></br> Access to this endpoint requires a bearer token from a Data Client App. Required scope | `custom_code:write`
+     * Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. </br></br> <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 | `custom_code:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.CustomCodeInlineRequest} request
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -208,7 +236,7 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.scripts.registerInline("site_id", {
+     *     await client.scripts.registerInline("site_id", {
      *         sourceCode: "alert('hello world');",
      *         version: "0.0.1",
      *         displayName: "Alert"
@@ -218,13 +246,13 @@ class Scripts {
         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}/registered_scripts/inline`),
+                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)}/registered_scripts/inline`),
                 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,
                 },
@@ -232,6 +260,7 @@ class Scripts {
                 body: yield serializers.CustomCodeInlineRequest.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.CustomCodeInlineResponse.parseOrThrow(_response.body, {
@@ -251,7 +280,13 @@ class Scripts {
                     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:

package/dist/api/resources/scripts/client/requests/CustomCodeHostedRequest.d.ts

@@ -19,6 +19,6 @@ export interface CustomCodeHostedRequest {
     canCopy?: boolean;
     /** A Semantic Version (SemVer) string, denoting the version of the script */
     version: string;
-    /** User-facing name for the script */
+    /** User-facing name for the script. Must be between 1 and 50 alphanumeric characters */
     displayName: string;
 }

package/dist/api/resources/scripts/client/requests/CustomCodeInlineRequest.d.ts

@@ -18,6 +18,6 @@ export interface CustomCodeInlineRequest {
     canCopy?: boolean;
     /** A Semantic Version (SemVer) string, denoting the version of the script */
     version: string;
-    /** User-facing name for the script */
+    /** User-facing name for the script. Must be between 1 and 50 alphanumeric characters */
     displayName: string;
 }

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

@@ -1,2 +1,2 @@
-export { CustomCodeHostedRequest } from "./CustomCodeHostedRequest";
-export { CustomCodeInlineRequest } from "./CustomCodeInlineRequest";
+export { type CustomCodeHostedRequest } from "./CustomCodeHostedRequest";
+export { type CustomCodeInlineRequest } from "./CustomCodeInlineRequest";

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Webflow from "../../..";
+import * as Webflow from "../../../index";
 import { ActivityLogs } from "../resources/activityLogs/client/Client";
 import { Scripts } from "../resources/scripts/client/Client";
 export declare namespace Sites {
@@ -12,8 +12,12 @@ export declare namespace Sites {
         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 Sites {
@@ -21,18 +25,23 @@ export declare class Sites {
     constructor(_options: Sites.Options);
     /**
      * List of all sites the provided access token is able to access. </br></br> Required scope | `sites:read`
-     * @throws {@link Webflow.BadRequestError}
+     *
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
      * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.list()
+     *     await client.sites.list()
      */
     list(requestOptions?: Sites.RequestOptions): Promise<Webflow.Sites>;
     /**
      * Get a site by site id </br></br> Required scope | `sites:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -40,11 +49,15 @@ export declare class Sites {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.get("site_id")
+     *     await client.sites.get("site_id")
      */
     get(siteId: string, requestOptions?: Sites.RequestOptions): Promise<Webflow.Site>;
     /**
      * Get a list of all custom domains related to site. </br></br> Required scope | `sites:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
      * @throws {@link Webflow.NotFoundError}
@@ -52,11 +65,16 @@ export declare class Sites {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.getCustomDomain("site_id")
+     *     await client.sites.getCustomDomain("site_id")
      */
     getCustomDomain(siteId: string, requestOptions?: Sites.RequestOptions): Promise<Webflow.Domains>;
     /**
-     * Publish a site to one more more domains. </br></br> Required scope | `sites:write`
+     * Publish a site to one more more domains. </br></br> Required scope | `sites:write` <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>Endpoint-specific rate limit</p></h2><p>This endpoint has a limit of one successful publish queue per minute.</p></blockquote>
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.SitesPublishRequest} request
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -64,10 +82,7 @@ export declare class Sites {
      * @throws {@link Webflow.TooManyRequestsError}
      *
      * @example
-     *     await webflow.sites.publish("site_id", {
-     *         customDomains: ["589a331aa51e760df7ccb89d"],
-     *         publishToWebflowSubdomain: false
-     *     })
+     *     await client.sites.publish("site_id")
      */
     publish(siteId: string, request?: Webflow.SitesPublishRequest, requestOptions?: Sites.RequestOptions): Promise<void>;
     protected _activityLogs: ActivityLogs | undefined;

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

@@ -41,10 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sites = 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"));
 const Client_1 = require("../resources/activityLogs/client/Client");
 const Client_2 = require("../resources/scripts/client/Client");
 class Sites {
@@ -53,14 +53,15 @@ class Sites {
     }
     /**
      * List of all sites the provided access token is able to access. </br></br> Required scope | `sites:read`
-     * @throws {@link Webflow.BadRequestError}
+     *
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
      * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.list()
+     *     await client.sites.list()
      */
     list(requestOptions) {
         var _a;
@@ -72,13 +73,14 @@ class Sites {
                     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.Sites.parseOrThrow(_response.body, {
@@ -91,16 +93,18 @@ class Sites {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Webflow.BadRequestError(_response.error.body);
                     case 401:
                         throw new Webflow.UnauthorizedError(_response.error.body);
                     case 404:
                         throw new Webflow.NotFoundError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(_response.error.body);
-                    case 500:
-                        throw new Webflow.InternalServerError(_response.error.body);
+                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,
@@ -125,6 +129,10 @@ class Sites {
     }
     /**
      * Get a site by site id </br></br> Required scope | `sites:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -132,25 +140,26 @@ class Sites {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.get("site_id")
+     *     await client.sites.get("site_id")
      */
     get(siteId, 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}`),
+                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)}`),
                 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.Site.parseOrThrow(_response.body, {
@@ -170,7 +179,13 @@ class Sites {
                     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:
@@ -197,6 +212,10 @@ class Sites {
     }
     /**
      * Get a list of all custom domains related to site. </br></br> Required scope | `sites:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
      * @throws {@link Webflow.NotFoundError}
@@ -204,25 +223,26 @@ class Sites {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.getCustomDomain("site_id")
+     *     await client.sites.getCustomDomain("site_id")
      */
     getCustomDomain(siteId, 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}/custom_domains`),
+                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)}/custom_domains`),
                 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.Domains.parseOrThrow(_response.body, {
@@ -242,7 +262,13 @@ class Sites {
                     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:
@@ -268,7 +294,12 @@ class Sites {
         });
     }
     /**
-     * Publish a site to one more more domains. </br></br> Required scope | `sites:write`
+     * Publish a site to one more more domains. </br></br> Required scope | `sites:write` <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>Endpoint-specific rate limit</p></h2><p>This endpoint has a limit of one successful publish queue per minute.</p></blockquote>
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.SitesPublishRequest} request
+     * @param {Sites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -276,22 +307,19 @@ class Sites {
      * @throws {@link Webflow.TooManyRequestsError}
      *
      * @example
-     *     await webflow.sites.publish("site_id", {
-     *         customDomains: ["589a331aa51e760df7ccb89d"],
-     *         publishToWebflowSubdomain: false
-     *     })
+     *     await client.sites.publish("site_id")
      */
     publish(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}/publish`),
+                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)}/publish`),
                 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,
                 },
@@ -299,6 +327,7 @@ class Sites {
                 body: yield serializers.SitesPublishRequest.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;
@@ -314,7 +343,13 @@ class Sites {
                     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"],
+                        }));
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,