webflow-api 2.3.6 → 2.4.0

package/dist/wrapper/ItemsClient.d.ts

@@ -26,5 +26,53 @@ export declare class Client extends Items {
      *         }
      *     })
      */
-    createItem(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<void>;
+    createItem(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    /**
+     * 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: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    /**
+     * 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: string, request: Webflow.BulkCollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.BulkCollectionItem>;
 }

package/dist/wrapper/ItemsClient.js

@@ -44,7 +44,7 @@ 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 request.
+// the client.Collections.Items.createItem, createItemLive, and createItemForMultipleLocales request.
 class Client extends Client_1.Items {
     constructor(_options) {
         super(_options);
@@ -77,18 +77,20 @@ class Client extends Client_1.Items {
         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`),
+                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`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "v2.2.1",
+                    "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",
-                body: yield serializers.CollectionItem.jsonOrThrow(request, {
+                requestType: "json",
+                body: serializers.CollectionItem.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -96,9 +98,214 @@ class Client extends Client_1.Items {
                 }),
                 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;
+                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, {
+                            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, {
+                            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) {
@@ -109,7 +316,7 @@ class Client extends Client_1.Items {
                     case 404:
                         throw new Webflow.NotFoundError(_response.error.body);
                     case 429:
-                        throw new Webflow.TooManyRequestsError(yield serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
+                        throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "webflow-api",
-    "version": "2.3.6",
+    "version": "2.4.0",
     "private": false,
     "repository": "https://github.com/webflow/js-webflow-api",
     "main": "./index.js",
@@ -13,16 +13,21 @@
     },
     "dependencies": {
         "url-join": "4.0.1",
-        "form-data": "4.0.0",
+        "form-data": "^4.0.0",
         "formdata-node": "^6.0.3",
         "node-fetch": "2.7.0",
         "qs": "6.11.2",
+        "readable-stream": "^4.5.2",
         "js-base64": "3.7.2"
     },
     "devDependencies": {
         "@types/url-join": "4.0.1",
         "@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",
         "@types/jest": "29.5.5",
         "ts-jest": "29.1.1",