webflow-api 2.4.0 → 2.5.0

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

@@ -75,15 +75,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: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.4.0",
-                    "User-Agent": "webflow-api/2.4.0",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "2.5.0", "User-Agent": "webflow-api/2.5.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,
@@ -104,15 +96,27 @@ class Inventory {
                     case 400:
                         throw new Webflow.BadRequestError(_response.error.body);
                     case 401:
-                        throw new Webflow.UnauthorizedError(_response.error.body);
+                        throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 403:
                         throw new Webflow.ForbiddenError(_response.error.body);
                     case 404:
-                        throw new Webflow.NotFoundError(_response.error.body);
+                        throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 409:
                         throw new Webflow.ConflictError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                        throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -120,7 +124,13 @@ class Inventory {
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new Webflow.InternalServerError(_response.error.body);
+                        throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,
@@ -135,7 +145,7 @@ class Inventory {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.WebflowTimeoutError();
+                    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,
@@ -144,7 +154,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.
+     * 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`
      *
@@ -172,18 +187,14 @@ 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: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.4.0",
-                    "User-Agent": "webflow-api/2.4.0",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "2.5.0", "User-Agent": "webflow-api/2.5.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, { unrecognizedObjectKeys: "strip" }),
+                body: serializers.InventoryUpdateRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                }),
                 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,
@@ -202,15 +213,27 @@ class Inventory {
                     case 400:
                         throw new Webflow.BadRequestError(_response.error.body);
                     case 401:
-                        throw new Webflow.UnauthorizedError(_response.error.body);
+                        throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 403:
                         throw new Webflow.ForbiddenError(_response.error.body);
                     case 404:
-                        throw new Webflow.NotFoundError(_response.error.body);
+                        throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 409:
                         throw new Webflow.ConflictError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                        throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -218,7 +241,13 @@ class Inventory {
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new Webflow.InternalServerError(_response.error.body);
+                        throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     default:
                         throw new errors.WebflowError({
                             statusCode: _response.error.statusCode,
@@ -233,7 +262,7 @@ class Inventory {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.WebflowTimeoutError();
+                    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,

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

@@ -16,6 +16,8 @@ export declare namespace Orders {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Orders {
@@ -43,7 +45,8 @@ export declare class Orders {
      */
     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.
+     * Retrieve a single product by its ID. All of its SKUs will also be
+     * retrieved.
      *
      * Required scope | `ecommerce:read`
      *
@@ -64,7 +67,9 @@ export declare class Orders {
      */
     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.
+     * 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`
      *