webflow-api 2.3.2 → 2.3.5

package/api/resources/collections/resources/items/client/requests/BulkCollectionItem.d.ts

@@ -1,17 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "../../../../../..";
+import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {
- *         id: "580e64008c9a982ac9b8b754",
- *         lastUpdated: "2023-03-17T18:47:35.560Z",
- *         createdOn: "2023-03-17T18:47:35.560Z",
- *         fieldData: {
- *             name: "My new item",
- *             slug: "my-new-item"
- *         }
+ *         id: "580e64008c9a982ac9b8b754"
  *     }
  */
 export interface BulkCollectionItem {

package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ItemsDeleteItemLiveRequest {
+    /**
+     * Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+     */
+    cmsLocaleId?: string;
+}

package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemLiveRequest.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/api/resources/collections/resources/items/client/requests/ItemsDeleteItemRequest.d.ts

@@ -7,7 +7,7 @@
  */
 export interface ItemsDeleteItemRequest {
     /**
-     * Unique identifiers for CMS Locales. These UIDs are different from the Site locale identifier and are listed as `cmsLocaleId` in the Sites response. Applicable when using localization.
+     * Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
      */
-    cmsLocaleIds?: string | string[];
+    cmsLocaleId?: string;
 }

package/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ItemsGetItemLiveRequest {
+    /**
+     * Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
+     */
+    cmsLocaleId?: string;
+}

package/api/resources/collections/resources/items/client/requests/ItemsGetItemLiveRequest.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/api/resources/collections/resources/items/client/requests/ItemsGetItemRequest.d.ts

@@ -7,7 +7,7 @@
  */
 export interface ItemsGetItemRequest {
     /**
-     * Unique identifier for a CMS Locale. These UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. Applicable when using localization.
+     * Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
      */
     cmsLocaleId?: string;
 }

package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts

@@ -1,15 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {}
  */
 export interface ItemsListItemsLiveRequest {
     /**
-     * Unique identifiers for CMS Locales. These UIDs are different from the Site locale identifier and are listed as `cmsLocaleId` in the Sites response. Applicable when using localization.
+     * Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
      */
-    cmsLocaleIds?: string | string[];
+    cmsLocaleId?: string;
     /**
      * Offset used for pagination if the results have more than limit records
      */
@@ -18,4 +19,20 @@ export interface ItemsListItemsLiveRequest {
      * Maximum number of records to be returned (max limit: 100)
      */
     limit?: number;
+    /**
+     * The name of the item(s)
+     */
+    name?: string;
+    /**
+     * The slug of the item
+     */
+    slug?: string;
+    /**
+     * Sort results by the provided value
+     */
+    sortBy?: Webflow.collections.ItemsListItemsLiveRequestSortBy;
+    /**
+     * Sorts the results by asc or desc
+     */
+    sortOrder?: Webflow.collections.ItemsListItemsLiveRequestSortOrder;
 }

package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts

@@ -1,15 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Webflow from "../../../../../../index";
 /**
  * @example
  *     {}
  */
 export interface ItemsListItemsRequest {
     /**
-     * Unique identifiers for CMS Locales. These UIDs are different from the Site locale identifier and are listed as `cmsLocaleId` in the Sites response. Applicable when using localization.
+     * Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
      */
-    cmsLocaleIds?: string | string[];
+    cmsLocaleId?: string;
     /**
      * Offset used for pagination if the results have more than limit records
      */
@@ -18,4 +19,20 @@ export interface ItemsListItemsRequest {
      * Maximum number of records to be returned (max limit: 100)
      */
     limit?: number;
+    /**
+     * The name of the item(s)
+     */
+    name?: string;
+    /**
+     * The slug of the item
+     */
+    slug?: string;
+    /**
+     * Sort results by the provided value
+     */
+    sortBy?: Webflow.collections.ItemsListItemsRequestSortBy;
+    /**
+     * Sorts the results by asc or desc
+     */
+    sortOrder?: Webflow.collections.ItemsListItemsRequestSortOrder;
 }

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

@@ -1,6 +1,8 @@
-export { ItemsListItemsRequest } from "./ItemsListItemsRequest";
-export { ItemsListItemsLiveRequest } from "./ItemsListItemsLiveRequest";
-export { BulkCollectionItem } from "./BulkCollectionItem";
-export { ItemsGetItemRequest } from "./ItemsGetItemRequest";
-export { ItemsDeleteItemRequest } from "./ItemsDeleteItemRequest";
-export { ItemsPublishItemRequest } from "./ItemsPublishItemRequest";
+export { type ItemsListItemsRequest } from "./ItemsListItemsRequest";
+export { type ItemsListItemsLiveRequest } from "./ItemsListItemsLiveRequest";
+export { type BulkCollectionItem } from "./BulkCollectionItem";
+export { type ItemsGetItemRequest } from "./ItemsGetItemRequest";
+export { type ItemsDeleteItemRequest } from "./ItemsDeleteItemRequest";
+export { type ItemsGetItemLiveRequest } from "./ItemsGetItemLiveRequest";
+export { type ItemsDeleteItemLiveRequest } from "./ItemsDeleteItemLiveRequest";
+export { type ItemsPublishItemRequest } from "./ItemsPublishItemRequest";

package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ItemsListItemsLiveRequestSortBy = "lastPublished" | "name" | "slug";
+export declare const ItemsListItemsLiveRequestSortBy: {
+    readonly LastPublished: "lastPublished";
+    readonly Name: "name";
+    readonly Slug: "slug";
+};

package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortBy.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemsListItemsLiveRequestSortBy = void 0;
+exports.ItemsListItemsLiveRequestSortBy = {
+    LastPublished: "lastPublished",
+    Name: "name",
+    Slug: "slug",
+};

package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ItemsListItemsLiveRequestSortOrder = "asc" | "desc";
+export declare const ItemsListItemsLiveRequestSortOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};

package/api/resources/collections/resources/items/types/ItemsListItemsLiveRequestSortOrder.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemsListItemsLiveRequestSortOrder = void 0;
+exports.ItemsListItemsLiveRequestSortOrder = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ItemsListItemsRequestSortBy = "lastPublished" | "name" | "slug";
+export declare const ItemsListItemsRequestSortBy: {
+    readonly LastPublished: "lastPublished";
+    readonly Name: "name";
+    readonly Slug: "slug";
+};

package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortBy.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemsListItemsRequestSortBy = void 0;
+exports.ItemsListItemsRequestSortBy = {
+    LastPublished: "lastPublished",
+    Name: "name",
+    Slug: "slug",
+};

package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ItemsListItemsRequestSortOrder = "asc" | "desc";
+export declare const ItemsListItemsRequestSortOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};

package/api/resources/collections/resources/items/types/ItemsListItemsRequestSortOrder.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemsListItemsRequestSortOrder = void 0;
+exports.ItemsListItemsRequestSortOrder = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/api/resources/collections/resources/items/types/index.d.ts

@@ -1 +1,5 @@
+export * from "./ItemsListItemsRequestSortBy";
+export * from "./ItemsListItemsRequestSortOrder";
+export * from "./ItemsListItemsLiveRequestSortBy";
+export * from "./ItemsListItemsLiveRequestSortOrder";
 export * from "./BulkCollectionItemFieldData";

package/api/resources/collections/resources/items/types/index.js

@@ -14,4 +14,8 @@ 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);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ItemsListItemsRequestSortBy"), exports);
+__exportStar(require("./ItemsListItemsRequestSortOrder"), exports);
+__exportStar(require("./ItemsListItemsLiveRequestSortBy"), exports);
+__exportStar(require("./ItemsListItemsLiveRequestSortOrder"), exports);
 __exportStar(require("./BulkCollectionItemFieldData"), exports);

package/api/resources/ecommerce/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 Ecommerce {
     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 Ecommerce {
@@ -21,6 +25,10 @@ export declare class Ecommerce {
      * Retrieve ecommerce settings for a site.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Ecommerce.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -30,7 +38,7 @@ export declare class Ecommerce {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.ecommerce.getSettings("site_id")
+     *     await client.ecommerce.getSettings("site_id")
      */
     getSettings(siteId: string, requestOptions?: Ecommerce.RequestOptions): Promise<Webflow.EcommerceSettings>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -41,10 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Ecommerce = 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"));
 class Ecommerce {
     constructor(_options) {
         this._options = _options;
@@ -53,6 +53,10 @@ class Ecommerce {
      * Retrieve ecommerce settings for a site.
      *
      * Required scope | `ecommerce:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Ecommerce.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -62,25 +66,26 @@ class Ecommerce {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.ecommerce.getSettings("site_id")
+     *     await client.ecommerce.getSettings("site_id")
      */
     getSettings(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}/ecommerce/settings`),
+                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)}/ecommerce/settings`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "webflow-api",
-                    "X-Fern-SDK-Version": "2.3.2",
+                    "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.EcommerceSettings.parseOrThrow(_response.body, {

package/api/resources/forms/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 Forms {
     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 Forms {
@@ -19,6 +23,11 @@ export declare class Forms {
     constructor(_options: Forms.Options);
     /**
      * List forms for a given site </br></br> Required scope | `forms:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.FormsListRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -28,11 +37,15 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.list("site_id", {})
+     *     await client.forms.list("site_id")
      */
     list(siteId: string, request?: Webflow.FormsListRequest, requestOptions?: Forms.RequestOptions): Promise<Webflow.FormList>;
     /**
      * Get information about a given form</br></br> Required scope | `forms:read`
+     *
+     * @param {string} formId - Unique identifier for a Form
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -41,11 +54,15 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.get("form_id")
+     *     await client.forms.get("form_id")
      */
     get(formId: string, requestOptions?: Forms.RequestOptions): Promise<Webflow.Form>;
     /**
      * List form submissions for a given form </br></br> Required scope | `forms:read`
+     *
+     * @param {string} formId - Unique identifier for a Form
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -54,11 +71,15 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.listSubmissions("form_id")
+     *     await client.forms.listSubmissions("form_id")
      */
     listSubmissions(formId: string, requestOptions?: Forms.RequestOptions): Promise<Webflow.FormSubmissionList>;
     /**
      * Get information about a given form submission</br></br> Required scope | `forms:read`
+     *
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -67,11 +88,16 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.getSubmission("form_submission_id")
+     *     await client.forms.getSubmission("form_submission_id")
      */
     getSubmission(formSubmissionId: string, requestOptions?: Forms.RequestOptions): Promise<Webflow.FormSubmission>;
     /**
      * Update hidden fields on a form submission</br></br> Required scope | `forms:write`
+     *
+     * @param {string} formSubmissionId - Unique identifier for a Form Submission
+     * @param {Webflow.FormsUpdateSubmissionRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.ForbiddenError}
@@ -81,7 +107,7 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.forms.updateSubmission("form_submission_id", {})
+     *     await client.forms.updateSubmission("form_submission_id")
      */
     updateSubmission(formSubmissionId: string, request?: Webflow.FormsUpdateSubmissionRequest, requestOptions?: Forms.RequestOptions): Promise<Webflow.FormSubmission>;
     protected _getAuthorizationHeader(): Promise<string>;