webflow-api 2.3.1 → 2.3.5

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

@@ -41,16 +41,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Forms = 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 Forms {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * List forms for a given site </br></br> Required scope | `forms:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.FormsListRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -60,7 +65,7 @@ class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.list("site_id", {})
+     *     await client.forms.list("site_id")
      */
     list(siteId, request = {}, requestOptions) {
         var _a;
@@ -74,13 +79,13 @@ class Forms {
                 _queryParams["offset"] = offset.toString();
             }
             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}/forms`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -88,6 +93,7 @@ class Forms {
                 queryParameters: _queryParams,
                 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.FormList.parseOrThrow(_response.body, {
@@ -138,6 +144,10 @@ class Forms {
     }
     /**
      * Get information about a given form</br></br> Required scope | `forms:read`
+     *
+     * @param {string} formId - Unique identifier for a Form
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -146,25 +156,26 @@ class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.get("form_id")
+     *     await client.forms.get("form_id")
      */
     get(formId, 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, `forms/${formId}`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "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.Form.parseOrThrow(_response.body, {
@@ -213,6 +224,10 @@ class Forms {
     }
     /**
      * List form submissions for a given form </br></br> Required scope | `forms:read`
+     *
+     * @param {string} formId - Unique identifier for a Form
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -221,25 +236,26 @@ class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.listSubmissions("form_id")
+     *     await client.forms.listSubmissions("form_id")
      */
     listSubmissions(formId, 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, `forms/${formId}/submissions`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "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.FormSubmissionList.parseOrThrow(_response.body, {
@@ -288,6 +304,10 @@ class Forms {
     }
     /**
      * Get information about a given form submission</br></br> Required scope | `forms:read`
+     *
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -296,25 +316,26 @@ class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.getSubmission("form_submission_id")
+     *     await client.forms.getSubmission("form_submission_id")
      */
     getSubmission(formSubmissionId, 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, `form_submissions/${formSubmissionId}`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "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.FormSubmission.parseOrThrow(_response.body, {
@@ -363,6 +384,11 @@ class Forms {
     }
     /**
      * Update hidden fields on a form submission</br></br> Required scope | `forms:write`
+     *
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Webflow.FormsUpdateSubmissionRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -372,19 +398,19 @@ class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.updateSubmission("form_submission_id", {})
+     *     await client.forms.updateSubmission("form_submission_id")
      */
     updateSubmission(formSubmissionId, 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, `form_submissions/${formSubmissionId}`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -394,6 +420,7 @@ class Forms {
                 }),
                 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.FormSubmission.parseOrThrow(_response.body, {

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

@@ -1,2 +1,2 @@
-export { FormsListRequest } from "./FormsListRequest";
-export { FormsUpdateSubmissionRequest } from "./FormsUpdateSubmissionRequest";
+export { type FormsListRequest } from "./FormsListRequest";
+export { type FormsUpdateSubmissionRequest } from "./FormsUpdateSubmissionRequest";

package/api/resources/inventory/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 Inventory {
     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 Inventory {
@@ -21,6 +25,11 @@ export declare class Inventory {
      * List the current inventory levels for a particular SKU item.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Inventory.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -30,13 +39,19 @@ export declare class Inventory {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.inventory.list("collection_id", "item_id")
+     *     await client.inventory.list("collection_id", "item_id")
      */
     list(collectionId: string, itemId: string, requestOptions?: Inventory.RequestOptions): Promise<Webflow.InventoryItem>;
     /**
      * 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.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.InventoryUpdateRequest} request
+     * @param {Inventory.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -46,10 +61,8 @@ export declare class Inventory {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.inventory.update("collection_id", "item_id", {
-     *         inventoryType: Webflow.InventoryUpdateRequestInventoryType.Infinite,
-     *         updateQuantity: 1,
-     *         quantity: 100
+     *     await client.inventory.update("collection_id", "item_id", {
+     *         inventoryType: Webflow.InventoryUpdateRequestInventoryType.Infinite
      *     })
      */
     update(collectionId: string, itemId: string, request: Webflow.InventoryUpdateRequest, requestOptions?: Inventory.RequestOptions): Promise<Webflow.InventoryItem>;

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

@@ -41,10 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Inventory = 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 Inventory {
     constructor(_options) {
         this._options = _options;
@@ -53,6 +53,11 @@ class Inventory {
      * List the current inventory levels for a particular SKU item.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Inventory.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -62,25 +67,26 @@ class Inventory {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.inventory.list("collection_id", "item_id")
+     *     await client.inventory.list("collection_id", "item_id")
      */
     list(collectionId, itemId, 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, `collections/${collectionId}/items/${itemId}/inventory`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "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.InventoryItem.parseOrThrow(_response.body, {
@@ -133,6 +139,12 @@ 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.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.InventoryUpdateRequest} request
+     * @param {Inventory.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -142,23 +154,21 @@ class Inventory {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.inventory.update("collection_id", "item_id", {
-     *         inventoryType: Webflow.InventoryUpdateRequestInventoryType.Infinite,
-     *         updateQuantity: 1,
-     *         quantity: 100
+     *     await client.inventory.update("collection_id", "item_id", {
+     *         inventoryType: Webflow.InventoryUpdateRequestInventoryType.Infinite
      *     })
      */
     update(collectionId, itemId, 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, `collections/${collectionId}/items/${itemId}/inventory`),
+                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: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.1",
+                    "X-Fern-SDK-Version": "2.3.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -166,6 +176,7 @@ class Inventory {
                 body: yield serializers.InventoryUpdateRequest.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.InventoryItem.parseOrThrow(_response.body, {

package/api/resources/inventory/client/requests/InventoryUpdateRequest.d.ts

@@ -1,13 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "../../../..";
+import * as Webflow from "../../../../index";
 /**
  * @example
  *     {
- *         inventoryType: Webflow.InventoryUpdateRequestInventoryType.Infinite,
- *         updateQuantity: 1,
- *         quantity: 100
+ *         inventoryType: Webflow.InventoryUpdateRequestInventoryType.Infinite
  *     }
  */
 export interface InventoryUpdateRequest {

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

@@ -1 +1 @@
-export { InventoryUpdateRequest } from "./InventoryUpdateRequest";
+export { type InventoryUpdateRequest } from "./InventoryUpdateRequest";

package/api/resources/orders/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 Orders {
     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 Orders {
@@ -21,6 +25,11 @@ export declare class Orders {
      * List all orders created for a given site.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.OrdersListRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -30,13 +39,18 @@ export declare class Orders {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.orders.list("site_id", {})
+     *     await client.orders.list("site_id")
      */
     list(siteId: string, request?: Webflow.OrdersListRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.OrderList>;
     /**
      * 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} orderId - Unique identifier for an Order
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -46,13 +60,19 @@ export declare class Orders {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.orders.get("site_id", "order_id")
+     *     await client.orders.get("site_id", "order_id")
      */
     get(siteId: string, orderId: string, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
     /**
      * This API lets you update the fields, `comment`, `shippingProvider`, and/or `shippingTracking` for a given order. All three fields can be updated simultaneously or independently.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} orderId - Unique identifier for an Order
+     * @param {Webflow.OrdersUpdateRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -62,18 +82,19 @@ export declare class Orders {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.orders.update("site_id", "order_id", {
-     *         comment: "Example comment to myself",
-     *         shippingProvider: "Shipping Company, Co.",
-     *         shippingTracking: "tr00000000001",
-     *         shippingTrackingUrl: "https://www.shippingcompany.com/tracking/tr00000000001"
-     *     })
+     *     await client.orders.update("site_id", "order_id")
      */
     update(siteId: string, orderId: string, request?: Webflow.OrdersUpdateRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
     /**
      * Updates an order's status to fulfilled
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} orderId - Unique identifier for an Order
+     * @param {Webflow.OrdersUpdateFulfillRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -83,13 +104,18 @@ export declare class Orders {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.orders.updateFulfill("site_id", "order_id", {})
+     *     await client.orders.updateFulfill("site_id", "order_id")
      */
     updateFulfill(siteId: string, orderId: string, request?: Webflow.OrdersUpdateFulfillRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
     /**
      * Updates an order's status to unfulfilled
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} orderId - Unique identifier for an Order
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -99,7 +125,7 @@ export declare class Orders {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.orders.updateUnfulfill("site_id", "order_id")
+     *     await client.orders.updateUnfulfill("site_id", "order_id")
      */
     updateUnfulfill(siteId: string, orderId: string, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
     /**
@@ -107,6 +133,12 @@ export declare class Orders {
      * customer. It will also set the order's status to `refunded`.
      *
      * Required scope | `ecommerce:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {string} orderId - Unique identifier for an Order
+     * @param {Webflow.OrdersRefundRequest} request
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -116,7 +148,7 @@ export declare class Orders {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.orders.refund("site_id", "order_id", {})
+     *     await client.orders.refund("site_id", "order_id")
      */
     refund(siteId: string, orderId: string, request?: Webflow.OrdersRefundRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
     protected _getAuthorizationHeader(): Promise<string>;