webflow-api 3.2.0 → 3.3.0-beta

package/api/resources/components/client/requests/ComponentPropertiesWrite.d.ts

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Webflow from "../../../../index";
+import type * as Webflow from "../../../../index";
 /**
  * @example
  *     {
@@ -18,12 +15,12 @@ import * as Webflow from "../../../../index";
  */
 export interface ComponentPropertiesWrite {
     /**
-     * Unique identifier for a specific locale. Applicable, when using localization.
+     * Unique identifier for a specific Locale.
+     *
+     * [Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
      */
     localeId?: string;
-    /**
-     * Scope the operation to work on a specific branch.
-     */
+    /** Scope the operation to work on a specific branch. */
     branchId?: string;
     /** A list of component properties to update within the specified secondary locale. */
     properties: Webflow.ComponentPropertiesWritePropertiesItem[];

package/api/resources/components/client/requests/ComponentPropertiesWrite.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/client/requests/ComponentsGetContentRequest.d.ts

@@ -1,28 +1,23 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
  *         localeId: "65427cf400e02b306eaa04a0",
- *         branchId: "68026fa68ef6dc744c75b833"
+ *         branchId: "68026fa68ef6dc744c75b833",
+ *         limit: 1.1,
+ *         offset: 1.1
  *     }
  */
 export interface ComponentsGetContentRequest {
     /**
-     * Unique identifier for a specific locale. Applicable, when using localization.
+     * Unique identifier for a specific Locale.
+     *
+     * [Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
      */
     localeId?: string;
-    /**
-     * Scope the operation to work on a specific branch.
-     */
+    /** Scope the operation to work on a specific branch. */
     branchId?: string;
-    /**
-     * Maximum number of records to be returned (max limit: 100)
-     */
+    /** Maximum number of records to be returned (max limit: 100) */
     limit?: number;
-    /**
-     * Offset used for pagination if the results have more than limit records
-     */
+    /** Offset used for pagination if the results have more than limit records */
     offset?: number;
 }

package/api/resources/components/client/requests/ComponentsGetContentRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.d.ts

@@ -1,28 +1,23 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
  *         localeId: "65427cf400e02b306eaa04a0",
- *         branchId: "68026fa68ef6dc744c75b833"
+ *         branchId: "68026fa68ef6dc744c75b833",
+ *         limit: 1.1,
+ *         offset: 1.1
  *     }
  */
 export interface ComponentsGetPropertiesRequest {
     /**
-     * Unique identifier for a specific locale. Applicable, when using localization.
+     * Unique identifier for a specific Locale.
+     *
+     * [Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
      */
     localeId?: string;
-    /**
-     * Scope the operation to work on a specific branch.
-     */
+    /** Scope the operation to work on a specific branch. */
     branchId?: string;
-    /**
-     * Maximum number of records to be returned (max limit: 100)
-     */
+    /** Maximum number of records to be returned (max limit: 100) */
     limit?: number;
-    /**
-     * Offset used for pagination if the results have more than limit records
-     */
+    /** Offset used for pagination if the results have more than limit records */
     offset?: number;
 }

package/api/resources/components/client/requests/ComponentsGetPropertiesRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/client/requests/ComponentsListRequest.d.ts

@@ -1,23 +1,16 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * @example
  *     {
- *         branchId: "68026fa68ef6dc744c75b833"
+ *         branchId: "68026fa68ef6dc744c75b833",
+ *         limit: 1.1,
+ *         offset: 1.1
  *     }
  */
 export interface ComponentsListRequest {
-    /**
-     * Scope the operation to work on a specific branch.
-     */
+    /** Scope the operation to work on a specific branch. */
     branchId?: string;
-    /**
-     * Maximum number of records to be returned (max limit: 100)
-     */
+    /** Maximum number of records to be returned (max limit: 100) */
     limit?: number;
-    /**
-     * Offset used for pagination if the results have more than limit records
-     */
+    /** Offset used for pagination if the results have more than limit records */
     offset?: number;
 }

package/api/resources/components/client/requests/ComponentsListRequest.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,5 +1,5 @@
-export { type ComponentsListRequest } from "./ComponentsListRequest";
-export { type ComponentsGetContentRequest } from "./ComponentsGetContentRequest";
-export { type ComponentDomWrite } from "./ComponentDomWrite";
-export { type ComponentsGetPropertiesRequest } from "./ComponentsGetPropertiesRequest";
-export { type ComponentPropertiesWrite } from "./ComponentPropertiesWrite";
+export type { ComponentDomWrite } from "./ComponentDomWrite";
+export type { ComponentPropertiesWrite } from "./ComponentPropertiesWrite";
+export type { ComponentsGetContentRequest } from "./ComponentsGetContentRequest";
+export type { ComponentsGetPropertiesRequest } from "./ComponentsGetPropertiesRequest";
+export type { ComponentsListRequest } from "./ComponentsListRequest";

package/api/resources/components/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./types";
 export * from "./client";
+export * from "./types";

package/api/resources/components/index.js

@@ -14,5 +14,5 @@ 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("./types"), exports);
 __exportStar(require("./client"), exports);
+__exportStar(require("./types"), exports);

package/api/resources/components/types/ComponentDomWriteNodesItem.d.ts

@@ -1,5 +1,2 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Webflow from "../../../index";
-export type ComponentDomWriteNodesItem = Webflow.TextNode | Webflow.ComponentInstance | Webflow.Select | Webflow.TextInput | Webflow.SubmitButton | Webflow.SearchButton;
+import type * as Webflow from "../../../index";
+export type ComponentDomWriteNodesItem = Webflow.TextNodeWrite | Webflow.ComponentInstanceNodePropertyOverridesWrite | Webflow.Select | Webflow.TextInputNodeWrite | Webflow.SubmitButtonNodeWrite | Webflow.SearchButtonNodeWrite;

package/api/resources/components/types/ComponentDomWriteNodesItem.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/types/ComponentPropertiesWritePropertiesItem.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface ComponentPropertiesWritePropertiesItem {
     /** The ID of the property. */
     propertyId: string;

package/api/resources/components/types/ComponentPropertiesWritePropertiesItem.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/types/ComponentsUpdateContentResponse.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface ComponentsUpdateContentResponse {
     /** A list of error messages, if any. */
     errors: string[];

package/api/resources/components/types/ComponentsUpdateContentResponse.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/types/ComponentsUpdatePropertiesResponse.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface ComponentsUpdatePropertiesResponse {
     /** A list of error messages, if any. */
     errors: string[];

package/api/resources/components/types/ComponentsUpdatePropertiesResponse.js

@@ -1,5 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/components/types/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./ComponentDomWriteNodesItem";
-export * from "./ComponentsUpdateContentResponse";
 export * from "./ComponentPropertiesWritePropertiesItem";
+export * from "./ComponentsUpdateContentResponse";
 export * from "./ComponentsUpdatePropertiesResponse";

package/api/resources/components/types/index.js

@@ -15,6 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ComponentDomWriteNodesItem"), exports);
-__exportStar(require("./ComponentsUpdateContentResponse"), exports);
 __exportStar(require("./ComponentPropertiesWritePropertiesItem"), exports);
+__exportStar(require("./ComponentsUpdateContentResponse"), exports);
 __exportStar(require("./ComponentsUpdatePropertiesResponse"), exports);

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

@@ -1,32 +1,15 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
 import * as core from "../../../../core";
 import * as Webflow from "../../../index";
 export declare namespace Ecommerce {
-    interface Options {
-        environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    interface Options extends BaseClientOptions {
     }
-    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;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 export declare class Ecommerce {
     protected readonly _options: Ecommerce.Options;
-    constructor(_options: Ecommerce.Options);
+    constructor(_options?: Ecommerce.Options);
     /**
      * Retrieve ecommerce settings for a site.
      *
@@ -48,5 +31,5 @@ export declare class Ecommerce {
      */
     getSettings(siteId: string, requestOptions?: Ecommerce.RequestOptions): core.HttpResponsePromise<Webflow.EcommerceSettings>;
     private __getSettings;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -44,20 +42,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Ecommerce = void 0;
-const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Webflow = __importStar(require("../../../index"));
-const headers_js_1 = require("../../../../core/headers.js");
-const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization/index"));
+const headers_1 = require("../../../../core/headers");
+const environments = __importStar(require("../../../../environments"));
 const errors = __importStar(require("../../../../errors/index"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const Webflow = __importStar(require("../../../index"));
 class Ecommerce {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -84,14 +78,16 @@ class Ecommerce {
     }
     __getSettings(siteId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.WebflowEnvironment.DataApi)
-                    .base, `sites/${encodeURIComponent(siteId)}/ecommerce/settings`),
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.WebflowEnvironment.DataApi)
+                    .base, `sites/${core.url.encodePathParam(siteId)}/ecommerce/settings`),
                 method: "GET",
-                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                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,
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
@@ -173,7 +169,11 @@ class Ecommerce {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

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

@@ -1,27 +1,10 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
 import * as core from "../../../../core";
 import * as Webflow from "../../../index";
 export declare namespace Forms {
-    interface Options {
-        environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    interface Options extends BaseClientOptions {
     }
-    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;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 /**
@@ -29,7 +12,7 @@ export declare namespace Forms {
  */
 export declare class Forms {
     protected readonly _options: Forms.Options;
-    constructor(_options: Forms.Options);
+    constructor(_options?: Forms.Options);
     /**
      * List forms for a given site.
      *
@@ -48,7 +31,10 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.forms.list("580e63e98c9a982ac9b8b741")
+     *     await client.forms.list("580e63e98c9a982ac9b8b741", {
+     *         limit: 1.1,
+     *         offset: 1.1
+     *     })
      */
     list(siteId: string, request?: Webflow.FormsListRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormList>;
     private __list;
@@ -95,7 +81,10 @@ export declare class Forms {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.forms.listSubmissions("580e63e98c9a982ac9b8b741")
+     *     await client.forms.listSubmissions("580e63e98c9a982ac9b8b741", {
+     *         offset: 1.1,
+     *         limit: 1.1
+     *     })
      */
     listSubmissions(formId: string, request?: Webflow.FormsListSubmissionsRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmissionList>;
     private __listSubmissions;
@@ -163,30 +152,5 @@ export declare class Forms {
      */
     updateSubmission(formSubmissionId: string, request?: Webflow.FormsUpdateSubmissionRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmission>;
     private __updateSubmission;
-    /**
-     * List form submissions for a given site. This endpoint differs from the existing [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) by accepting `siteId` as a path parameter and `elementId` as a query parameter. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list).
-     *
-     *
-     *
-     * Required scope | `forms:read`
-     *
-     * @param {string} siteId - Unique identifier for a Site
-     * @param {Webflow.FormsListSubmissionsBySiteRequest} request
-     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.ForbiddenError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
-     *         elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0"
-     *     })
-     */
-    listSubmissionsBySite(siteId: string, request?: Webflow.FormsListSubmissionsBySiteRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Webflow.FormSubmissionList>;
-    private __listSubmissionsBySite;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }