webflow-api 3.0.0 → 3.1.0

package/api/resources/components/client/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("./requests"), exports);

package/api/resources/components/client/requests/ComponentDomWrite.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../../../../index";
+/**
+ * @example
+ *     {
+ *         localeId: "65427cf400e02b306eaa04a0",
+ *         nodes: [{
+ *                 nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
+ *                 text: "<h1>The Hitchhiker's Guide to the Galaxy</h1>"
+ *             }, {
+ *                 nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
+ *                 text: "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
+ *             }, {
+ *                 nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
+ *                 propertyOverrides: [{
+ *                         propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0",
+ *                         text: "<div><h1>Time is an <em>illusion</em></h1></div>"
+ *                     }, {
+ *                         propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f1",
+ *                         text: "Life, the Universe and Everything"
+ *                     }]
+ *             }]
+ *     }
+ */
+export interface ComponentDomWrite {
+    /**
+     * Unique identifier for a specific locale. Applicable, when using localization.
+     */
+    localeId?: string;
+    /** List of DOM Nodes with the new content that will be updated in each node. */
+    nodes: Webflow.ComponentDomWriteNodesItem[];
+}

package/api/resources/components/client/requests/ComponentPropertiesWrite.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../../../../index";
+/**
+ * @example
+ *     {
+ *         localeId: "65427cf400e02b306eaa04a0",
+ *         properties: [{
+ *                 propertyId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
+ *                 text: "The Hitchhiker\u2019s Guide to the Galaxy"
+ *             }, {
+ *                 propertyId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
+ *                 text: "<div><h3>Dont Panic!</h3><p>Always know where your towel is.</p></div>"
+ *             }]
+ *     }
+ */
+export interface ComponentPropertiesWrite {
+    /**
+     * Unique identifier for a specific locale. Applicable, when using localization.
+     */
+    localeId?: string;
+    /** A list of component properties to update within the specified secondary locale. */
+    properties: Webflow.ComponentPropertiesWritePropertiesItem[];
+}

package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         localeId: "65427cf400e02b306eaa04a0"
+ *     }
+ *
+ * @example
+ *     {
+ *         localeId: "65427cf400e02b306eaa04a0"
+ *     }
+ */
+export interface ComponentsGetContentRequest {
+    /**
+     * Unique identifier for a specific locale. Applicable, when using localization.
+     */
+    localeId?: string;
+    /**
+     * Maximum number of records to be returned (max limit: 100)
+     */
+    limit?: number;
+    /**
+     * Offset used for pagination if the results have more than limit records
+     */
+    offset?: number;
+}

package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         localeId: "65427cf400e02b306eaa04a0"
+ *     }
+ */
+export interface ComponentsGetPropertiesRequest {
+    /**
+     * Unique identifier for a specific locale. Applicable, when using localization.
+     */
+    localeId?: string;
+    /**
+     * Maximum number of records to be returned (max limit: 100)
+     */
+    limit?: number;
+    /**
+     * Offset used for pagination if the results have more than limit records
+     */
+    offset?: number;
+}

package/api/resources/components/client/requests/ComponentsListRequest.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ComponentsListRequest {
+    /**
+     * Maximum number of records to be returned (max limit: 100)
+     */
+    limit?: number;
+    /**
+     * Offset used for pagination if the results have more than limit records
+     */
+    offset?: number;
+}

package/api/resources/components/client/requests/index.d.ts

@@ -0,0 +1,5 @@
+export { type ComponentsListRequest } from "./ComponentsListRequest";
+export { type ComponentsGetContentRequest } from "./ComponentsGetContentRequest";
+export { type ComponentDomWrite } from "./ComponentDomWrite";
+export { type ComponentsGetPropertiesRequest } from "./ComponentsGetPropertiesRequest";
+export { type ComponentPropertiesWrite } from "./ComponentPropertiesWrite";

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

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

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

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

package/api/resources/components/index.js

@@ -0,0 +1,18 @@
+"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("./types"), exports);
+__exportStar(require("./client"), exports);

package/api/resources/components/types/ComponentDomWriteNodesItem.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../../../index";
+export declare type ComponentDomWriteNodesItem = Webflow.TextNodeWrite | Webflow.ComponentInstanceNodePropertyOverridesWrite;

package/api/resources/components/types/ComponentPropertiesWritePropertiesItem.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ComponentPropertiesWritePropertiesItem {
+    /** The ID of the property. */
+    propertyId: string;
+    /**
+     * The new string or HTML value used to update the component property in the secondary locale.
+     *
+     * The provided value must be compatible with the type of the component property.
+     *
+     * For example, attempting to update a single-line plain-text property with a multi-line
+     * value will result in an error.
+     */
+    text: string;
+}

package/api/resources/components/types/ComponentsUpdateContentResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ComponentsUpdateContentResponse {
+    /** A list of error messages, if any. */
+    errors: string[];
+}

package/api/resources/components/types/ComponentsUpdatePropertiesResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ComponentsUpdatePropertiesResponse {
+    /** A list of error messages, if any. */
+    errors: string[];
+}

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

@@ -0,0 +1,4 @@
+export * from "./ComponentDomWriteNodesItem";
+export * from "./ComponentsUpdateContentResponse";
+export * from "./ComponentPropertiesWritePropertiesItem";
+export * from "./ComponentsUpdatePropertiesResponse";

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

@@ -0,0 +1,20 @@
+"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("./ComponentDomWriteNodesItem"), exports);
+__exportStar(require("./ComponentsUpdateContentResponse"), exports);
+__exportStar(require("./ComponentPropertiesWritePropertiesItem"), exports);
+__exportStar(require("./ComponentsUpdatePropertiesResponse"), exports);

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

@@ -74,7 +74,7 @@ class Ecommerce {
             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)}/ecommerce/settings`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -20,6 +20,9 @@ export declare namespace Forms {
         headers?: Record<string, string>;
     }
 }
+/**
+ * Forms are forms that are created on your Webflow site.
+ */
 export declare class Forms {
     protected readonly _options: Forms.Options;
     constructor(_options: Forms.Options);

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

@@ -45,6 +45,9 @@ const Webflow = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
+/**
+ * Forms are forms that are created on your Webflow site.
+ */
 class Forms {
     constructor(_options) {
         this._options = _options;
@@ -83,7 +86,7 @@ class Forms {
             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)}/forms`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
@@ -186,7 +189,7 @@ class Forms {
             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, `forms/${encodeURIComponent(formId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -295,7 +298,7 @@ class Forms {
             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, `forms/${encodeURIComponent(formId)}/submissions`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
@@ -396,7 +399,7 @@ class Forms {
             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, `form_submissions/${encodeURIComponent(formSubmissionId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -498,7 +501,7 @@ class Forms {
             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, `form_submissions/${encodeURIComponent(formSubmissionId)}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 body: serializers.FormsUpdateSubmissionRequest.jsonOrThrow(request, {

package/api/resources/index.d.ts

@@ -2,6 +2,8 @@ export * as sites from "./sites";
 export * from "./sites/types";
 export * as pages from "./pages";
 export * from "./pages/types";
+export * as components from "./components";
+export * from "./components/types";
 export * as users from "./users";
 export * from "./users/types";
 export * as accessGroups from "./accessGroups";
@@ -22,6 +24,7 @@ export * as ecommerce from "./ecommerce";
 export * from "./sites/client/requests";
 export * from "./collections/client/requests";
 export * from "./pages/client/requests";
+export * from "./components/client/requests";
 export * from "./scripts/client/requests";
 export * from "./assets/client/requests";
 export * from "./forms/client/requests";

package/api/resources/index.js

@@ -26,11 +26,13 @@ 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 });
-exports.ecommerce = exports.forms = exports.webhooks = exports.assets = exports.scripts = exports.token = exports.collections = exports.inventory = exports.orders = exports.products = exports.accessGroups = exports.users = exports.pages = exports.sites = void 0;
+exports.ecommerce = exports.forms = exports.webhooks = exports.assets = exports.scripts = exports.token = exports.collections = exports.inventory = exports.orders = exports.products = exports.accessGroups = exports.users = exports.components = exports.pages = exports.sites = void 0;
 exports.sites = __importStar(require("./sites"));
 __exportStar(require("./sites/types"), exports);
 exports.pages = __importStar(require("./pages"));
 __exportStar(require("./pages/types"), exports);
+exports.components = __importStar(require("./components"));
+__exportStar(require("./components/types"), exports);
 exports.users = __importStar(require("./users"));
 __exportStar(require("./users/types"), exports);
 exports.accessGroups = __importStar(require("./accessGroups"));
@@ -51,6 +53,7 @@ exports.ecommerce = __importStar(require("./ecommerce"));
 __exportStar(require("./sites/client/requests"), exports);
 __exportStar(require("./collections/client/requests"), exports);
 __exportStar(require("./pages/client/requests"), exports);
+__exportStar(require("./components/client/requests"), exports);
 __exportStar(require("./scripts/client/requests"), exports);
 __exportStar(require("./assets/client/requests"), exports);
 __exportStar(require("./forms/client/requests"), exports);

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

@@ -20,6 +20,9 @@ export declare namespace Inventory {
         headers?: Record<string, string>;
     }
 }
+/**
+ * Inventory is the stock of e-commerce items in your Webflow site.
+ */
 export declare class Inventory {
     protected readonly _options: Inventory.Options;
     constructor(_options: Inventory.Options);
@@ -48,7 +51,6 @@ export declare class Inventory {
      * Updates the current inventory levels for a particular SKU item.
      *
      * Updates may be given in one or two methods, absolutely or incrementally.
-     *
      * - Absolute updates are done by setting `quantity` directly.
      * - Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
      *

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

@@ -45,6 +45,9 @@ const Webflow = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
+/**
+ * Inventory is the stock of e-commerce items in your Webflow site.
+ */
 class Inventory {
     constructor(_options) {
         this._options = _options;
@@ -75,7 +78,7 @@ class Inventory {
             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, `collections/${encodeURIComponent(collectionId)}/items/${encodeURIComponent(itemId)}/inventory`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -157,7 +160,6 @@ class Inventory {
      * Updates the current inventory levels for a particular SKU item.
      *
      * Updates may be given in one or two methods, absolutely or incrementally.
-     *
      * - Absolute updates are done by setting `quantity` directly.
      * - Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
      *
@@ -187,7 +189,7 @@ class Inventory {
             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, `collections/${encodeURIComponent(collectionId)}/items/${encodeURIComponent(itemId)}/inventory`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 body: serializers.InventoryUpdateRequest.jsonOrThrow(request, {

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

@@ -20,6 +20,9 @@ export declare namespace Orders {
         headers?: Record<string, string>;
     }
 }
+/**
+ * Orders are the orders for your Webflow site.
+ */
 export declare class Orders {
     protected readonly _options: Orders.Options;
     constructor(_options: Orders.Options);

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

@@ -45,6 +45,9 @@ const Webflow = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
+/**
+ * Orders are the orders for your Webflow site.
+ */
 class Orders {
     constructor(_options) {
         this._options = _options;
@@ -86,7 +89,7 @@ class Orders {
             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)}/orders`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
@@ -192,7 +195,7 @@ class Orders {
             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)}/orders/${encodeURIComponent(orderId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -299,7 +302,7 @@ class Orders {
             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)}/orders/${encodeURIComponent(orderId)}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 body: serializers.OrdersUpdateRequest.jsonOrThrow(request, {
@@ -409,7 +412,7 @@ class Orders {
             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)}/orders/${encodeURIComponent(orderId)}/fulfill`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 body: serializers.OrdersUpdateFulfillRequest.jsonOrThrow(request, {
@@ -518,7 +521,7 @@ class Orders {
             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)}/orders/${encodeURIComponent(orderId)}/unfulfill`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -624,7 +627,7 @@ class Orders {
             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)}/orders/${encodeURIComponent(orderId)}/refund`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.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",
                 requestType: "json",
                 body: serializers.OrdersRefundRequest.jsonOrThrow(request, {

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

@@ -21,6 +21,9 @@ export declare namespace Pages {
         headers?: Record<string, string>;
     }
 }
+/**
+ * Pages are the pages in your Webflow site.
+ */
 export declare class Pages {
     protected readonly _options: Pages.Options;
     constructor(_options: Pages.Options);
@@ -112,9 +115,10 @@ export declare class Pages {
      */
     updatePageSettings(pageId: string, request: Webflow.UpdatePageSettingsRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Page>;
     /**
-     * Get static content from a static page.
+     * Get static content from a static page. This includes text nodes, image nodes and component instances.
+     * To retrieve the contents of components in the page use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint.
      *
-     * If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.
+     * <Note>If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.</Note>
      *
      * Required scope | `pages:read`
      *
@@ -136,14 +140,20 @@ export declare class Pages {
      */
     getContent(pageId: string, request?: Webflow.PagesGetContentRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Dom>;
     /**
-     * This endpoint allows for updating static content on a static page within a secondary locale. It is designed specifically for localized pages and can handle up to 1000 nodes per request.
+     * This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request.
      *
-     * <blockquote class="callout callout_info"><p><strong>Note:</strong>This endpoint is specifically for localized pages. Ensure that the locale specified is a valid secondary locale for the site.</p></blockquote>
+     * Before making updates:
+     * 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types
+     * 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint
+     *
+     * <Note>
+     *   This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
+     * </Note>
      *
      * Required scope | `pages:write`
      *
      * @param {string} pageId - Unique identifier for a Page
-     * @param {Webflow.DomWrite} request
+     * @param {Webflow.PageDomWrite} request
      * @param {Pages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -155,20 +165,26 @@ export declare class Pages {
      *
      * @example
      *     await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
-     *         localeId: "65427cf400e02b306eaa04a0",
+     *         localeId: "localeId",
      *         nodes: [{
      *                 nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
-     *                 text: "<h1>The Hitchhiker\u2019s Guide to the Galaxy</h1>"
+     *                 text: "<h1>The Hitchhiker's Guide to the Galaxy</h1>"
      *             }, {
      *                 nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
-     *                 text: "<div><h3>Don\u2019t Panic!</h3><p>Always know where your towel is.</p></div>"
+     *                 text: "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
      *             }, {
      *                 nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
-     *                 text: "<img alt=\"Marvin, the Paranoid Android\" src=\"path/to/image/with/assetId/659595234426a9fcbad57043\"/>"
+     *                 propertyOverrides: [{
+     *                         propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0",
+     *                         text: "<div><h1>Time is an <em>illusion</em></h1></div>"
+     *                     }, {
+     *                         propertyId: "7dd14c08-2e96-8d3d-2b19-b5c03642a0f1",
+     *                         text: "Life, the Universe and Everything"
+     *                     }]
      *             }]
      *     })
      */
-    updateStaticContent(pageId: string, request: Webflow.DomWrite, requestOptions?: Pages.RequestOptions): Promise<Webflow.UpdateStaticContentResponse>;
+    updateStaticContent(pageId: string, request: Webflow.PageDomWrite, requestOptions?: Pages.RequestOptions): Promise<Webflow.UpdateStaticContentResponse>;
     protected _scripts: Scripts | undefined;
     get scripts(): Scripts;
     protected _getAuthorizationHeader(): Promise<string>;