webflow-api 3.1.4 → 3.2.0

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

package/dist/api/resources/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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);
 };

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

@@ -7,7 +7,11 @@ import * as Webflow from "../../../index";
 export declare namespace Inventory {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         accessToken: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -17,7 +21,7 @@ export declare namespace Inventory {
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 /**
@@ -46,7 +50,8 @@ export declare class Inventory {
      * @example
      *     await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
      */
-    list(collectionId: string, itemId: string, requestOptions?: Inventory.RequestOptions): Promise<Webflow.InventoryItem>;
+    list(collectionId: string, itemId: string, requestOptions?: Inventory.RequestOptions): core.HttpResponsePromise<Webflow.InventoryItem>;
+    private __list;
     /**
      * Updates the current inventory levels for a particular SKU item.
      *
@@ -74,6 +79,7 @@ export declare class Inventory {
      *         inventoryType: "infinite"
      *     })
      */
-    update(collectionId: string, itemId: string, request: Webflow.InventoryUpdateRequest, requestOptions?: Inventory.RequestOptions): Promise<Webflow.InventoryItem>;
+    update(collectionId: string, itemId: string, request: Webflow.InventoryUpdateRequest, requestOptions?: Inventory.RequestOptions): core.HttpResponsePromise<Webflow.InventoryItem>;
+    private __update;
     protected _getAuthorizationHeader(): Promise<string>;
 }

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

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -42,6 +52,7 @@ exports.Inventory = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const Webflow = __importStar(require("../../../index"));
+const headers_js_1 = require("../../../../core/headers.js");
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
@@ -73,31 +84,36 @@ class Inventory {
      *     await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
      */
     list(collectionId, itemId, requestOptions) {
-        var _a;
+        return core.HttpResponsePromise.fromPromise(this.__list(collectionId, itemId, requestOptions));
+    }
+    __list(collectionId, itemId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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.DataApi).base, `collections/${encodeURIComponent(collectionId)}/items/${encodeURIComponent(itemId)}/inventory`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.WebflowEnvironment.DataApi)
+                    .base, `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.1.4", "User-Agent": "webflow-api/3.1.4", "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",
+                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 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 serializers.InventoryItem.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: true,
-                    breadcrumbsPrefix: ["response"],
-                });
+                return {
+                    data: serializers.InventoryItem.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new Webflow.BadRequestError(_response.error.body);
+                        throw new Webflow.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -105,9 +121,9 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 403:
-                        throw new Webflow.ForbiddenError(_response.error.body);
+                        throw new Webflow.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -115,9 +131,9 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 409:
-                        throw new Webflow.ConflictError(_response.error.body);
+                        throw new Webflow.ConflictError(_response.error.body, _response.rawResponse);
                     case 429:
                         throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -125,7 +141,7 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 500:
                         throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -133,11 +149,12 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -146,12 +163,14 @@ class Inventory {
                     throw new errors.WebflowError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
                     throw new errors.WebflowTimeoutError("Timeout exceeded when calling GET /collections/{collection_id}/items/{item_id}/inventory.");
                 case "unknown":
                     throw new errors.WebflowError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -184,12 +203,16 @@ class Inventory {
      *     })
      */
     update(collectionId, itemId, request, requestOptions) {
-        var _a;
+        return core.HttpResponsePromise.fromPromise(this.__update(collectionId, itemId, request, requestOptions));
+    }
+    __update(collectionId, itemId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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.DataApi).base, `collections/${encodeURIComponent(collectionId)}/items/${encodeURIComponent(itemId)}/inventory`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.WebflowEnvironment.DataApi)
+                    .base, `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.1.4", "User-Agent": "webflow-api/3.1.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.InventoryUpdateRequest.jsonOrThrow(request, {
@@ -202,18 +225,21 @@ class Inventory {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.InventoryItem.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: true,
-                    breadcrumbsPrefix: ["response"],
-                });
+                return {
+                    data: serializers.InventoryItem.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new Webflow.BadRequestError(_response.error.body);
+                        throw new Webflow.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -221,9 +247,9 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 403:
-                        throw new Webflow.ForbiddenError(_response.error.body);
+                        throw new Webflow.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -231,9 +257,9 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 409:
-                        throw new Webflow.ConflictError(_response.error.body);
+                        throw new Webflow.ConflictError(_response.error.body, _response.rawResponse);
                     case 429:
                         throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -241,7 +267,7 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 500:
                         throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -249,11 +275,12 @@ class Inventory {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -262,12 +289,14 @@ class Inventory {
                     throw new errors.WebflowError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
                     throw new errors.WebflowTimeoutError("Timeout exceeded when calling PATCH /collections/{collection_id}/items/{item_id}/inventory.");
                 case "unknown":
                     throw new errors.WebflowError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });

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

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

package/dist/api/resources/inventory/types/EcommInventoryChangedPayload.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../../../index";
+export interface EcommInventoryChangedPayload {
+    triggerType?: "ecomm_inventory_changed";
+    payload?: Webflow.InventoryItem;
+}

package/dist/api/resources/inventory/types/EcommInventoryChangedPayload.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/dist/api/resources/inventory/types/InventoryUpdateRequestInventoryType.d.ts

@@ -4,7 +4,7 @@
 /**
  * infinite or finite
  */
-export declare type InventoryUpdateRequestInventoryType = "infinite" | "finite";
+export type InventoryUpdateRequestInventoryType = "infinite" | "finite";
 export declare const InventoryUpdateRequestInventoryType: {
     readonly Infinite: "infinite";
     readonly Finite: "finite";

package/dist/api/resources/inventory/types/index.d.ts

@@ -1 +1,2 @@
 export * from "./InventoryUpdateRequestInventoryType";
+export * from "./EcommInventoryChangedPayload";

package/dist/api/resources/inventory/types/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./InventoryUpdateRequestInventoryType"), exports);
+__exportStar(require("./EcommInventoryChangedPayload"), exports);

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

@@ -7,7 +7,11 @@ import * as Webflow from "../../../index";
 export declare namespace Orders {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         accessToken: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -17,7 +21,7 @@ export declare namespace Orders {
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 /**
@@ -46,7 +50,8 @@ export declare class Orders {
      * @example
      *     await client.orders.list("580e63e98c9a982ac9b8b741")
      */
-    list(siteId: string, request?: Webflow.OrdersListRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.OrderList>;
+    list(siteId: string, request?: Webflow.OrdersListRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.OrderList>;
+    private __list;
     /**
      * Retrieve a single product by its ID. All of its SKUs will also be
      * retrieved.
@@ -68,7 +73,8 @@ export declare class Orders {
      * @example
      *     await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415")
      */
-    get(siteId: string, orderId: string, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
+    get(siteId: string, orderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.Order>;
+    private __get;
     /**
      * This API lets you update the fields, `comment`, `shippingProvider`,
      * and/or `shippingTracking` for a given order. All three fields can be
@@ -92,7 +98,8 @@ export declare class Orders {
      * @example
      *     await client.orders.update("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415")
      */
-    update(siteId: string, orderId: string, request?: Webflow.OrdersUpdateRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
+    update(siteId: string, orderId: string, request?: Webflow.OrdersUpdateRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.Order>;
+    private __update;
     /**
      * Updates an order's status to fulfilled
      *
@@ -114,7 +121,8 @@ export declare class Orders {
      * @example
      *     await client.orders.updateFulfill("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415")
      */
-    updateFulfill(siteId: string, orderId: string, request?: Webflow.OrdersUpdateFulfillRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
+    updateFulfill(siteId: string, orderId: string, request?: Webflow.OrdersUpdateFulfillRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.Order>;
+    private __updateFulfill;
     /**
      * Updates an order's status to unfulfilled
      *
@@ -135,7 +143,8 @@ export declare class Orders {
      * @example
      *     await client.orders.updateUnfulfill("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415")
      */
-    updateUnfulfill(siteId: string, orderId: string, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
+    updateUnfulfill(siteId: string, orderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.Order>;
+    private __updateUnfulfill;
     /**
      * This API will reverse a Stripe charge and refund an order back to a
      * customer. It will also set the order's status to `refunded`.
@@ -158,6 +167,7 @@ export declare class Orders {
      * @example
      *     await client.orders.refund("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415")
      */
-    refund(siteId: string, orderId: string, request?: Webflow.OrdersRefundRequest, requestOptions?: Orders.RequestOptions): Promise<Webflow.Order>;
+    refund(siteId: string, orderId: string, request?: Webflow.OrdersRefundRequest, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Webflow.Order>;
+    private __refund;
     protected _getAuthorizationHeader(): Promise<string>;
 }