webflow-api 2.3.1 → 2.3.5

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

@@ -41,10 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Collections = 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"));
 const Client_1 = require("../resources/fields/client/Client");
 const Client_2 = require("../resources/items/client/Client");
 class Collections {
@@ -53,6 +53,10 @@ class Collections {
     }
     /**
      * List of all Collections within a Site. </br></br> Required scope | `cms:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -60,25 +64,26 @@ class Collections {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.list("site_id")
+     *     await client.collections.list("site_id")
      */
     list(siteId, 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, `sites/${siteId}/collections`),
+                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)}/collections`),
                 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.CollectionList.parseOrThrow(_response.body, {
@@ -125,6 +130,11 @@ class Collections {
     }
     /**
      * Create a Collection for a site. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.CollectionsCreateRequest} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -132,7 +142,7 @@ class Collections {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.create("site_id", {
+     *     await client.collections.create("site_id", {
      *         displayName: "Blog Posts",
      *         singularName: "Blog Post",
      *         slug: "posts"
@@ -142,13 +152,13 @@ class Collections {
         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, `sites/${siteId}/collections`),
+                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)}/collections`),
                 method: "POST",
                 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,
                 },
@@ -156,6 +166,7 @@ class Collections {
                 body: yield serializers.CollectionsCreateRequest.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.Collection.parseOrThrow(_response.body, {
@@ -202,6 +213,10 @@ class Collections {
     }
     /**
      * Get the full details of a collection from its ID. </br></br> Required scope | `cms:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -209,25 +224,26 @@ class Collections {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.get("collection_id")
+     *     await client.collections.get("collection_id")
      */
     get(collectionId, 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}`),
+                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)}`),
                 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.Collection.parseOrThrow(_response.body, {
@@ -274,6 +290,10 @@ class Collections {
     }
     /**
      * Delete a collection using its ID. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -281,25 +301,26 @@ class Collections {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.deleteCollection("collection_id")
+     *     await client.collections.deleteCollection("collection_id")
      */
     deleteCollection(collectionId, 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}`),
+                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)}`),
                 method: "DELETE",
                 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;
@@ -340,6 +361,11 @@ class Collections {
     }
     /**
      * Delete a custom field in a collection. This endpoint does not currently support bulk deletion. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} fieldId - Unique identifier for a Field in a collection
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -347,25 +373,26 @@ class Collections {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.delete("collection_id", "field_id")
+     *     await client.collections.delete("collection_id", "field_id")
      */
     delete(collectionId, fieldId, 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}/fields/${fieldId}`),
+                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)}/fields/${encodeURIComponent(fieldId)}`),
                 method: "DELETE",
                 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;

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

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

package/api/resources/collections/resources/fields/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 Fields {
     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 Fields {
@@ -19,6 +23,11 @@ export declare class Fields {
     constructor(_options: Fields.Options);
     /**
      * Create a custom field in a collection. </br></br> Slugs must be all lowercase letters without spaces. If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will convert the slug to lowercase and replace spaces with "-." </br></br> Only some field types can be created through the API. This endpoint does not currently support bulk creation. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.FieldCreate} request
+     * @param {Fields.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -26,7 +35,7 @@ export declare class Fields {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.fields.create("collection_id", {
+     *     await client.collections.fields.create("collection_id", {
      *         isRequired: false,
      *         type: Webflow.collections.FieldCreateType.RichText,
      *         displayName: "Post Body",
@@ -36,6 +45,12 @@ export declare class Fields {
     create(collectionId: string, request: Webflow.collections.FieldCreate, requestOptions?: Fields.RequestOptions): Promise<Webflow.Field>;
     /**
      * Update a custom field in a collection. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} fieldId - Unique identifier for a Field in a collection
+     * @param {Webflow.collections.FieldUpdate} request
+     * @param {Fields.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -43,7 +58,7 @@ export declare class Fields {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.fields.update("collection_id", "field_id", {
+     *     await client.collections.fields.update("collection_id", "field_id", {
      *         isRequired: false,
      *         displayName: "Post Body",
      *         helpText: "Add the body of your post here"

package/api/resources/collections/resources/fields/client/Client.js

@@ -41,16 +41,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Fields = void 0;
 const environments = __importStar(require("../../../../../../environments"));
 const core = __importStar(require("../../../../../../core"));
-const Webflow = __importStar(require("../../../../.."));
-const serializers = __importStar(require("../../../../../../serialization"));
+const Webflow = __importStar(require("../../../../../index"));
+const serializers = __importStar(require("../../../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../../../errors"));
+const errors = __importStar(require("../../../../../../errors/index"));
 class Fields {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * Create a custom field in a collection. </br></br> Slugs must be all lowercase letters without spaces. If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will convert the slug to lowercase and replace spaces with "-." </br></br> Only some field types can be created through the API. This endpoint does not currently support bulk creation. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.FieldCreate} request
+     * @param {Fields.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -58,7 +63,7 @@ class Fields {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.fields.create("collection_id", {
+     *     await client.collections.fields.create("collection_id", {
      *         isRequired: false,
      *         type: Webflow.collections.FieldCreateType.RichText,
      *         displayName: "Post Body",
@@ -69,13 +74,13 @@ class Fields {
         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}/fields`),
+                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)}/fields`),
                 method: "POST",
                 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,
                 },
@@ -83,6 +88,7 @@ class Fields {
                 body: yield serializers.collections.FieldCreate.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.Field.parseOrThrow(_response.body, {
@@ -129,6 +135,12 @@ class Fields {
     }
     /**
      * Update a custom field in a collection. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} fieldId - Unique identifier for a Field in a collection
+     * @param {Webflow.collections.FieldUpdate} request
+     * @param {Fields.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -136,7 +148,7 @@ class Fields {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.fields.update("collection_id", "field_id", {
+     *     await client.collections.fields.update("collection_id", "field_id", {
      *         isRequired: false,
      *         displayName: "Post Body",
      *         helpText: "Add the body of your post here"
@@ -146,13 +158,13 @@ class Fields {
         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}/fields/${fieldId}`),
+                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)}/fields/${encodeURIComponent(fieldId)}`),
                 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,
                 },
@@ -160,6 +172,7 @@ class Fields {
                 body: yield serializers.collections.FieldUpdate.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.Field.parseOrThrow(_response.body, {

package/api/resources/collections/resources/fields/client/requests/FieldCreate.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "../../../../../..";
+import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {

package/api/resources/collections/resources/fields/client/requests/index.d.ts

@@ -1,2 +1,2 @@
-export { FieldCreate } from "./FieldCreate";
-export { FieldUpdate } from "./FieldUpdate";
+export { type FieldCreate } from "./FieldCreate";
+export { type FieldUpdate } from "./FieldUpdate";

package/api/resources/collections/resources/fields/types/FieldCreateType.d.ts

@@ -4,7 +4,7 @@
 /**
  * Choose these appropriate field type for your collection data
  */
-export declare type FieldCreateType = "PlainText" | "RichText" | "Image" | "MultiImage" | "Video" | "Link" | "Email" | "Phone" | "Number" | "DateTime" | "Boolean" | "Color" | "File";
+export declare type FieldCreateType = "PlainText" | "RichText" | "Image" | "MultiImage" | "Video" | "Link" | "Email" | "Phone" | "Number" | "DateTime" | "Switch" | "Color" | "File";
 export declare const FieldCreateType: {
     readonly PlainText: "PlainText";
     readonly RichText: "RichText";
@@ -16,7 +16,7 @@ export declare const FieldCreateType: {
     readonly Phone: "Phone";
     readonly Number: "Number";
     readonly DateTime: "DateTime";
-    readonly Boolean: "Boolean";
+    readonly Switch: "Switch";
     readonly Color: "Color";
     readonly File: "File";
 };

package/api/resources/collections/resources/fields/types/FieldCreateType.js

@@ -15,7 +15,7 @@ exports.FieldCreateType = {
     Phone: "Phone",
     Number: "Number",
     DateTime: "DateTime",
-    Boolean: "Boolean",
+    Switch: "Switch",
     Color: "Color",
     File: "File",
 };