webflow-api 2.0.0 → 2.1.2

package/api/resources/pages/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/pages/index.d.ts

@@ -1,2 +1,3 @@
+export * from "./types";
 export * from "./client";
 export * from "./resources";

package/api/resources/pages/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);
 __exportStar(require("./resources"), exports);

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

@@ -26,7 +26,7 @@ export declare class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.getCustomCode("string")
+     *     await webflow.pages.scripts.getCustomCode("page_id")
      */
     getCustomCode(pageId: string, requestOptions?: Scripts.RequestOptions): Promise<Webflow.ScriptApplyList>;
     /**
@@ -38,7 +38,7 @@ export declare class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.upsertCustomCode("string", {
+     *     await webflow.pages.scripts.upsertCustomCode("page_id", {
      *         scripts: [{
      *                 id: "cms_slider",
      *                 location: Webflow.ScriptApplyLocation.Header,
@@ -46,6 +46,14 @@ export declare class Scripts {
      *                 attributes: {
      *                     "my-attribute": "some-value"
      *                 }
+     *             }, {
+     *                 id: "alert",
+     *                 location: Webflow.ScriptApplyLocation.Header,
+     *                 version: "0.0.1"
+     *             }, {
+     *                 id: "id",
+     *                 location: Webflow.ScriptApplyLocation.Header,
+     *                 version: "version"
      *             }]
      *     })
      */
@@ -59,7 +67,7 @@ export declare class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.deleteCustomCode("string")
+     *     await webflow.pages.scripts.deleteCustomCode("page_id")
      */
     deleteCustomCode(pageId: string, requestOptions?: Scripts.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -58,19 +58,21 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.getCustomCode("string")
+     *     await webflow.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, `v2/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/${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.0.0-beta",
+                    "X-Fern-SDK-Version": "2.1.2",
+                    "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,
@@ -128,7 +130,7 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.upsertCustomCode("string", {
+     *     await webflow.pages.scripts.upsertCustomCode("page_id", {
      *         scripts: [{
      *                 id: "cms_slider",
      *                 location: Webflow.ScriptApplyLocation.Header,
@@ -136,6 +138,14 @@ class Scripts {
      *                 attributes: {
      *                     "my-attribute": "some-value"
      *                 }
+     *             }, {
+     *                 id: "alert",
+     *                 location: Webflow.ScriptApplyLocation.Header,
+     *                 version: "0.0.1"
+     *             }, {
+     *                 id: "id",
+     *                 location: Webflow.ScriptApplyLocation.Header,
+     *                 version: "version"
      *             }]
      *     })
      */
@@ -143,13 +153,15 @@ 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, `v2/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/${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.0.0-beta",
+                    "X-Fern-SDK-Version": "2.1.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: yield serializers.ScriptApplyList.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -208,19 +220,21 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.pages.scripts.deleteCustomCode("string")
+     *     await webflow.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, `v2/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/${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.0.0-beta",
+                    "X-Fern-SDK-Version": "2.1.2",
+                    "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,

package/api/resources/pages/types/DomWriteNodesItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DomWriteNodesItem {
+    /** Node UUID */
+    nodeId: string;
+    /** HTML content of the node */
+    text: string;
+}

package/api/resources/pages/types/DomWriteNodesItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/pages/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./DomWriteNodesItem";

package/api/resources/pages/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./DomWriteNodesItem"), exports);

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

@@ -30,21 +30,17 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.list("string", {})
+     *     await webflow.products.list("site_id", {})
      */
     list(siteId: string, request?: Webflow.ProductsListRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUsList>;
     /**
-     * Adding a new Product involves creating both a Product Item and a SKU Item, since a Product Item has to have, at minimum, a SKU Item.
+     * Creating a new Product involves creating both a Product and a SKU, since a Product Item has to have, at minimum, a single SKU.
      *
-     * To create a new Product with multiple SKUs, you must:
+     * In order to create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large - you'll need to create `sku-properties`. In our T-shirt example, a single `sku-property` would be Color. Within that property, we'll need to list out the various colors a T-shirt could be as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`.
      *
-     * - Create the Product and Default SKU using this endpoint, making sure to add `sku-properties` in the product data.
-     * - You can't add `sku-values` to the SKU yet, since there are no enum IDs created yet. When this endpoint returns, it will have IDs filled in for the `sku-properties` enums.
-     * - With those IDs, update the default SKU with valid `sku-values` and create any additional SKUs (if needed), with valid `sku-values`.
-     * - You can also create the Product without `sku-properties` and add them in later.
-     * - If you add any `sku` properties, the default SKU will default to the first value of each option.
+     * Once, you've created a Product and its `sku-properties` with `enum` values, you can create your default SKU, which will automatically be a combination of the first `sku-properties` you've created. In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. After you've created your product, you can create additional SKUs using the <a href="https://developers.webflow.com/reference/create-skus">Create SKU endpoint</a>
      *
-     * 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. The product type can be edited in the `Designer` or the `Editor`.
+     * 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`
      * @throws {@link Webflow.BadRequestError}
@@ -56,46 +52,9 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.create("string", {
-     *         publishStatus: Webflow.PublishStatus.Staging,
-     *         product: {
-     *             id: "580e63fc8c9a982ac9b8b745",
-     *             lastPublished: new Date("2023-03-17T18:47:35.560Z"),
-     *             lastUpdated: new Date("2023-03-17T18:47:35.560Z"),
-     *             createdOn: new Date("2023-03-17T18:47:35.560Z"),
-     *             isArchived: false,
-     *             isDraft: false,
-     *             fieldData: {
-     *                 name: "My new item",
-     *                 slug: "my-new-item",
-     *                 skuProperties: [{
-     *                         id: "ff42fee0113744f693a764e3431a9cc2",
-     *                         name: "Color",
-     *                         enum: [{
-     *                                 id: "64a74715c456e36762fc39a1",
-     *                                 name: "Royal Blue",
-     *                                 slug: "royal-blue"
-     *                             }]
-     *                     }]
-     *             }
-     *         },
-     *         sku: {
-     *             id: "580e63fc8c9a982ac9b8b745",
-     *             lastPublished: new Date("2023-03-17T18:47:35.560Z"),
-     *             lastUpdated: new Date("2023-03-17T18:47:35.560Z"),
-     *             createdOn: new Date("2023-03-17T18:47:35.560Z"),
-     *             fieldData: {
-     *                 name: "My new item",
-     *                 slug: "my-new-item",
-     *                 price: {
-     *                     value: 100,
-     *                     unit: "USD"
-     *                 }
-     *             }
-     *         }
-     *     })
+     *     await webflow.products.create("site_id", {})
      */
-    create(siteId: string, request: Webflow.ProductsCreateRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUs>;
+    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.
      *
@@ -109,7 +68,7 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.get("string", "string")
+     *     await webflow.products.get("site_id", "product_id")
      */
     get(siteId: string, productId: string, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUs>;
     /**
@@ -125,25 +84,46 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.update("string", "string", {
-     *         publishStatus: Webflow.PublishStatus.Staging,
+     *     await webflow.products.update("site_id", "product_id", {
      *         product: {
      *             id: "580e63fc8c9a982ac9b8b745",
-     *             lastPublished: new Date("2023-03-17T18:47:35.560Z"),
-     *             lastUpdated: new Date("2023-03-17T18:47:35.560Z"),
-     *             createdOn: new Date("2023-03-17T18:47:35.560Z"),
+     *             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"),
      *             isArchived: false,
      *             isDraft: false,
      *             fieldData: {
-     *                 name: "My new item",
-     *                 slug: "my-new-item",
+     *                 name: "T-Shirt",
+     *                 slug: "t-shirt",
+     *                 description: "A plain cotton t-shirt.",
+     *                 shippable: true,
      *                 skuProperties: [{
-     *                         id: "ff42fee0113744f693a764e3431a9cc2",
+     *                         id: "color",
      *                         name: "Color",
      *                         enum: [{
-     *                                 id: "64a74715c456e36762fc39a1",
+     *                                 id: "royal-blue",
      *                                 name: "Royal Blue",
      *                                 slug: "royal-blue"
+     *                             }, {
+     *                                 id: "crimson-red",
+     *                                 name: "Crimson Red",
+     *                                 slug: "crimson-red"
+     *                             }, {
+     *                                 id: "forrest-green",
+     *                                 name: "Forrst Green",
+     *                                 slug: "forrest-green"
+     *                             }, {
+     *                                 id: "id",
+     *                                 name: "name",
+     *                                 slug: "slug"
+     *                             }]
+     *                     }, {
+     *                         id: "Color",
+     *                         name: "Color",
+     *                         enum: [{
+     *                                 id: "id",
+     *                                 name: "name",
+     *                                 slug: "slug"
      *                             }]
      *                     }]
      *             }
@@ -166,20 +146,20 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.createSku("string", "string", {
-     *         publishStatus: Webflow.PublishStatus.Staging,
+     *     await webflow.products.createSku("site_id", "product_id", {
      *         skus: [{
      *                 id: "580e63fc8c9a982ac9b8b745",
-     *                 lastPublished: new Date("2023-03-17T18:47:35.560Z"),
-     *                 lastUpdated: new Date("2023-03-17T18:47:35.560Z"),
-     *                 createdOn: new Date("2023-03-17T18:47:35.560Z"),
+     *                 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: "My new item",
-     *                     slug: "my-new-item",
+     *                     name: "Blue T-shirt",
+     *                     slug: "t-shirt-blue",
      *                     price: {
      *                         value: 100,
      *                         unit: "USD"
-     *                     }
+     *                     },
+     *                     quantity: 10
      *                 }
      *             }]
      *     })
@@ -198,20 +178,20 @@ export declare class Products {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.products.updateSku("string", "string", "string", {
-     *         publishStatus: Webflow.PublishStatus.Staging,
+     *     await webflow.products.updateSku("site_id", "product_id", "sku_id", {
      *         sku: {
      *             id: "580e63fc8c9a982ac9b8b745",
-     *             lastPublished: new Date("2023-03-17T18:47:35.560Z"),
-     *             lastUpdated: new Date("2023-03-17T18:47:35.560Z"),
-     *             createdOn: new Date("2023-03-17T18:47:35.560Z"),
+     *             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: "My new item",
-     *                 slug: "my-new-item",
+     *                 name: "Blue T-shirt",
+     *                 slug: "t-shirt-blue",
      *                 price: {
      *                     value: 100,
      *                     unit: "USD"
-     *                 }
+     *                 },
+     *                 quantity: 10
      *             }
      *         }
      *     })