webflow-api 2.4.0 → 2.5.0

package/dist/wrapper/ItemsClient.js

@@ -43,15 +43,28 @@ const core = __importStar(require("../core"));
 const environments = __importStar(require("../environments"));
 const errors = __importStar(require("../errors"));
 const serializers = __importStar(require("../serialization"));
-// Client adapts the base client to permit extra properties in
-// the client.Collections.Items.createItem, createItemLive, and createItemForMultipleLocales request.
+const version_1 = require("../version");
+// Temporary wrapper for backwards compatibility keeping the createItemForMultipleLocales method
+// a mirror of the createItems API
 class Client extends Client_1.Items {
     constructor(_options) {
         super(_options);
         this._options = _options;
     }
     /**
-     * Create Item in a Collection.</br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use this endpoint.</a> </br></br> Required scope | `CMS:write`
+     * Create an item or multiple items in a CMS Collection across multiple corresponding locales.
+     *
+     * **Notes:**
+     *
+     * - This endpoint can create up to 100 items in a request.
+     * - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale.
+     *
+     * Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.CreateBulkCollectionItemRequestBody} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -59,49 +72,50 @@ class Client extends Client_1.Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.createItem("collection_id", {
-     *         id: "42b720ef280c7a7a3be8cabe",
-     *         cmsLocaleId: "653ad57de882f528b32e810e",
-     *         lastPublished: "2022-11-29T16:22:43.159Z",
-     *         lastUpdated: "2022-11-17T17:19:43.282Z",
-     *         createdOn: "2022-11-17T17:11:57.148Z",
+     *     await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b8b745", {
+     *         cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
      *         isArchived: false,
      *         isDraft: false,
      *         fieldData: {
-     *             name: "Pan Galactic Gargle Blaster Recipe",
-     *             slug: "pan-galactic-gargle-blaster"
+     *             name: "Don\u2019t Panic",
+     *             slug: "dont-panic"
      *         }
      *     })
+     *
+     * @example
+     *     await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b8b745", {
+     *         cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4"],
+     *         isArchived: false,
+     *         isDraft: false,
+     *         fieldData: [{
+     *                 name: "Don\u2019t Panic",
+     *                 slug: "dont-panic"
+     *             }, {
+     *                 name: "So Long and Thanks for All the Fish",
+     *                 slug: "so-long-and-thanks"
+     *             }]
+     *     })
      */
-    createItem(collectionId, request, requestOptions) {
+    createItemForMultipleLocales(collectionId, 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/${encodeURIComponent(collectionId)}/items`),
+                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/bulk`),
                 method: "POST",
-                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": version_1.SDK_VERSION, "User-Agent": `webflow-api/${version_1.SDK_VERSION}`, "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.CollectionItem.jsonOrThrow(request, {
+                body: serializers.collections.CreateBulkCollectionItemRequestBody.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
-                    skipValidation: 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,
             });
             if (_response.ok) {
-                return serializers.CollectionItem.parseOrThrow(_response.body, {
+                return serializers.BulkCollectionItem.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -114,209 +128,23 @@ class Client extends Client_1.Items {
                     case 400:
                         throw new Webflow.BadRequestError(_response.error.body);
                     case 401:
-                        throw new Webflow.UnauthorizedError(_response.error.body);
-                    case 404:
-                        throw new Webflow.NotFoundError(_response.error.body);
-                    case 429:
-                        throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                        throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
                         }));
-                    case 500:
-                        throw new Webflow.InternalServerError(_response.error.body);
-                    default:
-                        throw new errors.WebflowError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.WebflowError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.WebflowTimeoutError();
-                case "unknown":
-                    throw new errors.WebflowError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
-    /**
-     * Create live Item in a Collection. This Item will be published to the live site. </br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use this endpoint.</a> </br></br> Required scope | `CMS:write`
-     *
-     * @param {string} collectionId - Unique identifier for a Collection
-     * @param {Webflow.CollectionItem} request
-     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
-     *         id: "42b720ef280c7a7a3be8cabe",
-     *         cmsLocaleId: "653ad57de882f528b32e810e",
-     *         lastPublished: "2022-11-29T16:22:43.159Z",
-     *         lastUpdated: "2022-11-17T17:19:43.282Z",
-     *         createdOn: "2022-11-17T17:11:57.148Z",
-     *         isArchived: false,
-     *         isDraft: false,
-     *         fieldData: {
-     *             name: "Pan Galactic Gargle Blaster Recipe",
-     *             slug: "pan-galactic-gargle-blaster"
-     *         }
-     *     })
-     */
-    createItemLive(collectionId, 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/${encodeURIComponent(collectionId)}/items/live`),
-                method: "POST",
-                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,
-                },
-                contentType: "application/json",
-                requestType: "json",
-                body: serializers.CollectionItem.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: 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,
-            });
-            if (_response.ok) {
-                return serializers.CollectionItem.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Webflow.BadRequestError(_response.error.body);
-                    case 401:
-                        throw new Webflow.UnauthorizedError(_response.error.body);
                     case 404:
-                        throw new Webflow.NotFoundError(_response.error.body);
-                    case 429:
-                        throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                        throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
                         }));
-                    case 500:
-                        throw new Webflow.InternalServerError(_response.error.body);
-                    default:
-                        throw new errors.WebflowError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.WebflowError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.WebflowTimeoutError();
-                case "unknown":
-                    throw new errors.WebflowError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
-    /**
-     * Create single Item in a Collection with multiple corresponding locales. </br></br> Required scope | `CMS:write`
-     *
-     * @param {string} collectionId - Unique identifier for a Collection
-     * @param {Webflow.BulkCollectionItem} request
-     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b8b745", {
-     *         id: "580e64008c9a982ac9b8b754"
-     *     })
-     */
-    createItemForMultipleLocales(collectionId, 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/${encodeURIComponent(collectionId)}/items/bulk`),
-                method: "POST",
-                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,
-                },
-                contentType: "application/json",
-                requestType: "json",
-                body: serializers.CollectionItem.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: 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,
-            });
-            if (_response.ok) {
-                return serializers.BulkCollectionItem.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Webflow.BadRequestError(_response.error.body);
-                    case 401:
-                        throw new Webflow.UnauthorizedError(_response.error.body);
-                    case 404:
-                        throw new Webflow.NotFoundError(_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,
@@ -324,7 +152,13 @@ class Client extends Client_1.Items {
                             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,
@@ -339,7 +173,7 @@ class Client extends Client_1.Items {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.WebflowTimeoutError();
+                    throw new errors.WebflowTimeoutError("Timeout exceeded when calling POST /collections/{collection_id}/items/bulk.");
                 case "unknown":
                     throw new errors.WebflowError({
                         message: _response.error.errorMessage,

package/dist/wrapper/WebflowClient.d.ts

@@ -1,5 +1,5 @@
 import { WebflowClient as FernClient } from "../Client";
-import { OauthScope } from "../api/types";
+import { OauthScope } from "../api/types/OAuthScope";
 import { Client as Collections } from "./CollectionsClient";
 export declare class WebflowClient extends FernClient {
     protected readonly _options: FernClient.Options;

package/dist/wrapper/WebflowClient.js

@@ -41,6 +41,7 @@ const Client_1 = require("../Client");
 const core = __importStar(require("../core"));
 const errors = __importStar(require("../errors"));
 const CollectionsClient_1 = require("./CollectionsClient");
+const version_1 = require("../version");
 class WebflowClient extends Client_1.WebflowClient {
     constructor(_options) {
         super(_options);
@@ -96,6 +97,15 @@ class WebflowClient extends Client_1.WebflowClient {
                 method: "POST",
                 contentType: "application/json",
                 body,
+                headers: {
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "webflow-api",
+                    "X-Fern-SDK-Version": version_1.SDK_VERSION,
+                    "User-Agent": `webflow-api/${version_1.SDK_VERSION}`,
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                requestType: "json",
             });
             if (response.ok) {
                 return response.body["access_token"];
@@ -112,7 +122,7 @@ class WebflowClient extends Client_1.WebflowClient {
                         body: response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.WebflowTimeoutError();
+                    throw new errors.WebflowTimeoutError("Timeout exceeded when calling POST /oauth/token");
                 case "unknown":
                     throw new errors.WebflowError({
                         message: response.error.errorMessage,

package/errors/WebflowTimeoutError.d.ts

@@ -2,5 +2,5 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare class WebflowTimeoutError extends Error {
-    constructor();
+    constructor(message: string);
 }

package/errors/WebflowTimeoutError.js

@@ -5,8 +5,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebflowTimeoutError = void 0;
 class WebflowTimeoutError extends Error {
-    constructor() {
-        super("Timeout");
+    constructor(message) {
+        super(message);
         Object.setPrototypeOf(this, WebflowTimeoutError.prototype);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "webflow-api",
-    "version": "2.4.0",
+    "version": "2.5.0",
     "private": false,
     "repository": "https://github.com/webflow/js-webflow-api",
     "main": "./index.js",
@@ -25,7 +25,6 @@
         "@types/qs": "6.9.8",
         "@types/node-fetch": "2.6.9",
         "@types/readable-stream": "^4.0.15",
-        "fetch-mock-jest": "^1.5.1",
         "webpack": "^5.94.0",
         "ts-loader": "^9.3.1",
         "jest": "29.7.0",