webflow-api 2.3.2 → 2.3.6

package/dist/api/resources/pages/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;
     }
     /**
-     * Get all registered scripts that have been applied to a specific Page. </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:read`
+     * Get all registered scripts that have been applied to a specific Page. </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. <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} pageId - Unique identifier for a Page
+     * @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.pages.scripts.getCustomCode("page_id")
+     *     await client.pages.scripts.getCustomCode("page_id")
      */
     getCustomCode(pageId, 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, `pages/${pageId}/custom_code`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `pages/${encodeURIComponent(pageId)}/custom_code`),
                 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.ScriptApplyList.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 registered script to a Page. </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 registered script to a Page. </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. <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} pageId - Unique identifier for a Page
+     * @param {Webflow.ScriptApplyList} 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.pages.scripts.upsertCustomCode("page_id", {
+     *     await client.pages.scripts.upsertCustomCode("page_id", {
      *         scripts: [{
      *                 id: "cms_slider",
      *                 location: Webflow.ScriptApplyLocation.Header,
@@ -142,10 +158,6 @@ class Scripts {
      *                 id: "alert",
      *                 location: Webflow.ScriptApplyLocation.Header,
      *                 version: "0.0.1"
-     *             }, {
-     *                 id: "id",
-     *                 location: Webflow.ScriptApplyLocation.Header,
-     *                 version: "version"
      *             }]
      *     })
      */
@@ -153,13 +165,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, `pages/${pageId}/custom_code`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `pages/${encodeURIComponent(pageId)}/custom_code`),
                 method: "PUT",
                 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,
                 },
@@ -167,6 +179,7 @@ class Scripts {
                 body: yield serializers.ScriptApplyList.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.ScriptApplyList.parseOrThrow(_response.body, {
@@ -186,7 +199,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:
@@ -212,7 +231,11 @@ class Scripts {
         });
     }
     /**
-     * Delete the custom code block that an app has created for a page </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`
+     * Delete the custom code block that an app has created for a page </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. <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} pageId - Unique identifier for a Page
+     * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -220,25 +243,26 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.deleteCustomCode("page_id")
+     *     await client.pages.scripts.deleteCustomCode("page_id")
      */
     deleteCustomCode(pageId, 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, `pages/${pageId}/custom_code`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `pages/${encodeURIComponent(pageId)}/custom_code`),
                 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;
@@ -252,7 +276,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/products/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 Products {
     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 Products {
@@ -21,6 +25,11 @@ export declare class Products {
      * Retrieve all products for a site. Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.ProductsListRequest} request
+     * @param {Products.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -30,7 +39,7 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.list("site_id", {})
+     *     await client.products.list("site_id")
      */
     list(siteId: string, request?: Webflow.ProductsListRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUsList>;
     /**
@@ -43,6 +52,11 @@ export declare class Products {
      * Upon creation, the default product type will be `Advanced`. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.ProductSkuCreate} request
+     * @param {Products.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -52,38 +66,18 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.create("site_id", {
-     *         product: {
-     *             id: "660eb7a486d1d6e0412292d7",
-     *             cmsLocaleId: "653ad57de882f528b32e810e",
-     *             lastPublished: new Date("2024-04-04T14:24:19.000Z"),
-     *             lastUpdated: new Date("2024-04-04T14:30:19.000Z"),
-     *             createdOn: new Date("2024-04-04T14:22:28.000Z"),
-     *             isArchived: false,
-     *             isDraft: false,
-     *             fieldData: {
-     *                 name: "T-Shirt",
-     *                 slug: "t-shirt",
-     *                 description: "A plain cotton t-shirt.",
-     *                 shippable: true,
-     *                 skuProperties: [{
-     *                         id: "Color",
-     *                         name: "Color",
-     *                         enum: [{
-     *                                 id: "id",
-     *                                 name: "name",
-     *                                 slug: "slug"
-     *                             }]
-     *                     }]
-     *             }
-     *         }
-     *     })
+     *     await client.products.create("site_id")
      */
     create(siteId: string, request?: Webflow.ProductSkuCreate, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUs>;
     /**
      * Retrieve a single product by its id. All of its SKUs will also be retrieved.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} productId - Unique identifier for a Product
+     * @param {Products.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -93,13 +87,19 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.get("site_id", "product_id")
+     *     await client.products.get("site_id", "product_id")
      */
     get(siteId: string, productId: string, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUs>;
     /**
      * Updating an existing Product will set the product type to `Advanced`. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} productId - Unique identifier for a Product
+     * @param {Webflow.ProductSkuUpdate} request
+     * @param {Products.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -109,32 +109,7 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.update("site_id", "product_id", {
-     *         product: {
-     *             id: "660eb7a486d1d6e0412292d7",
-     *             cmsLocaleId: "653ad57de882f528b32e810e",
-     *             lastPublished: new Date("2024-04-04T14:24:19.000Z"),
-     *             lastUpdated: new Date("2024-04-04T14:30:19.000Z"),
-     *             createdOn: new Date("2024-04-04T14:22:28.000Z"),
-     *             isArchived: false,
-     *             isDraft: false,
-     *             fieldData: {
-     *                 name: "T-Shirt",
-     *                 slug: "t-shirt",
-     *                 description: "A plain cotton t-shirt.",
-     *                 shippable: true,
-     *                 skuProperties: [{
-     *                         id: "Color",
-     *                         name: "Color",
-     *                         enum: [{
-     *                                 id: "id",
-     *                                 name: "name",
-     *                                 slug: "slug"
-     *                             }]
-     *                     }]
-     *             }
-     *         }
-     *     })
+     *     await client.products.update("site_id", "product_id")
      */
     update(siteId: string, productId: string, request?: Webflow.ProductSkuUpdate, requestOptions?: Products.RequestOptions): Promise<Webflow.Product>;
     /**
@@ -143,6 +118,12 @@ export declare class Products {
      * Creating additional SKUs will set the product type to `Advanced` for the product associated with the SKUs. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} productId - Unique identifier for a Product
+     * @param {Webflow.ProductsCreateSkuRequest} request
+     * @param {Products.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -152,23 +133,8 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.createSku("site_id", "product_id", {
-     *         skus: [{
-     *                 id: "580e63fc8c9a982ac9b8b745",
-     *                 cmsLocaleId: "653ad57de882f528b32e810e",
-     *                 lastPublished: new Date("2023-03-17T18:47:35.000Z"),
-     *                 lastUpdated: new Date("2023-03-17T18:47:35.000Z"),
-     *                 createdOn: new Date("2023-03-17T18:47:35.000Z"),
-     *                 fieldData: {
-     *                     name: "Blue T-shirt",
-     *                     slug: "t-shirt-blue",
-     *                     price: {
-     *                         value: 100,
-     *                         unit: "USD"
-     *                     },
-     *                     quantity: 10
-     *                 }
-     *             }]
+     *     await client.products.createSku("site_id", "product_id", {
+     *         skus: [{}]
      *     })
      */
     createSku(siteId: string, productId: string, request: Webflow.ProductsCreateSkuRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductsCreateSkuResponse>;
@@ -176,6 +142,13 @@ export declare class Products {
      * Updating an existing SKU will set the product type to `Advanced` for the product associated with the SKU. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} productId - Unique identifier for a Product
+     * @param {string} skuId - Unique identifier for a SKU
+     * @param {Webflow.ProductsUpdateSkuRequest} request
+     * @param {Products.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -185,23 +158,8 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.updateSku("site_id", "product_id", "sku_id", {
-     *         sku: {
-     *             id: "580e63fc8c9a982ac9b8b745",
-     *             cmsLocaleId: "653ad57de882f528b32e810e",
-     *             lastPublished: new Date("2023-03-17T18:47:35.000Z"),
-     *             lastUpdated: new Date("2023-03-17T18:47:35.000Z"),
-     *             createdOn: new Date("2023-03-17T18:47:35.000Z"),
-     *             fieldData: {
-     *                 name: "Blue T-shirt",
-     *                 slug: "t-shirt-blue",
-     *                 price: {
-     *                     value: 100,
-     *                     unit: "USD"
-     *                 },
-     *                 quantity: 10
-     *             }
-     *         }
+     *     await client.products.updateSku("site_id", "product_id", "sku_id", {
+     *         sku: {}
      *     })
      */
     updateSku(siteId: string, productId: string, skuId: string, request: Webflow.ProductsUpdateSkuRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.Sku>;