webflow-api 3.1.4 → 3.2.1

package/dist/api/resources/orders/client/index.d.ts

@@ -1 +1,2 @@
+export {};
 export * from "./requests";

package/dist/api/resources/orders/client/requests/OrdersListRequest.d.ts

@@ -4,7 +4,11 @@
 import * as Webflow from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         status: "pending",
+ *         offset: 1.1,
+ *         limit: 1.1
+ *     }
  */
 export interface OrdersListRequest {
     /**

package/dist/api/resources/orders/types/OrdersListRequestStatus.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type OrdersListRequestStatus = "pending" | "refunded" | "dispute-lost" | "fulfilled" | "disputed" | "unfulfilled";
+export type OrdersListRequestStatus = "pending" | "refunded" | "dispute-lost" | "fulfilled" | "disputed" | "unfulfilled";
 export declare const OrdersListRequestStatus: {
     readonly Pending: "pending";
     readonly Refunded: "refunded";

package/dist/api/resources/orders/types/OrdersRefundRequestReason.d.ts

@@ -4,7 +4,7 @@
 /**
  * The reason for the refund
  */
-export declare type OrdersRefundRequestReason = "duplicate" | "fraudulent" | "requested";
+export type OrdersRefundRequestReason = "duplicate" | "fraudulent" | "requested";
 export declare const OrdersRefundRequestReason: {
     readonly Duplicate: "duplicate";
     readonly Fraudulent: "fraudulent";

package/dist/api/resources/pages/client/Client.d.ts

@@ -8,7 +8,11 @@ import { Scripts } from "../resources/scripts/client/Client";
 export declare namespace Pages {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
-        accessToken: core.Supplier<core.BearerToken>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -18,7 +22,7 @@ export declare namespace Pages {
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 /**
@@ -26,7 +30,9 @@ export declare namespace Pages {
  */
 export declare class Pages {
     protected readonly _options: Pages.Options;
-    constructor(_options: Pages.Options);
+    protected _scripts: Scripts | undefined;
+    constructor(_options?: Pages.Options);
+    get scripts(): Scripts;
     /**
      * List of all pages for a site.
      *
@@ -44,10 +50,13 @@ export declare class Pages {
      *
      * @example
      *     await client.pages.list("580e63e98c9a982ac9b8b741", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         limit: 1.1,
+     *         offset: 1.1
      *     })
      */
-    list(siteId: string, request?: Webflow.PagesListRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.PageList>;
+    list(siteId: string, request?: Webflow.PagesListRequest, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.PageList>;
+    private __list;
     /**
      * Get metadata information for a single page.
      *
@@ -68,18 +77,15 @@ export declare class Pages {
      *         localeId: "65427cf400e02b306eaa04a0"
      *     })
      */
-    getMetadata(pageId: string, request?: Webflow.PagesGetMetadataRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Page>;
+    getMetadata(pageId: string, request?: Webflow.PagesGetMetadataRequest, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.Page>;
+    private __getMetadata;
     /**
      * Update Page-level metadata, including SEO and Open Graph fields.
      *
-     * <Note>
-     *   Note: When updating Page Metadata in secondary locales, you may only add `slug` to the request if your Site has the [Advanced or Enterprise Localization](https://webflow.com/localization) add-on.
-     * </Note>
-     *
      * Required scope | `pages:write`
      *
      * @param {string} pageId - Unique identifier for a Page
-     * @param {Webflow.UpdatePageSettingsRequest} request
+     * @param {Webflow.PageMetadataWrite} request
      * @param {Pages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -91,39 +97,26 @@ export declare class Pages {
      * @example
      *     await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
      *         localeId: "65427cf400e02b306eaa04a0",
-     *         body: {
-     *             id: "6596da6045e56dee495bcbba",
-     *             siteId: "6258612d1ee792848f805dcf",
-     *             title: "Guide to the Galaxy",
-     *             slug: "guide-to-the-galaxy",
-     *             createdOn: "2024-03-11T10:42:00Z",
-     *             lastUpdated: "2024-03-11T10:42:42Z",
-     *             archived: false,
-     *             draft: false,
-     *             canBranch: true,
-     *             isBranch: false,
-     *             seo: {
-     *                 title: "The Ultimate Hitchhiker's Guide to the Galaxy",
-     *                 description: "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
-     *             },
-     *             openGraph: {
-     *                 title: "Explore the Cosmos with The Ultimate Guide",
-     *                 titleCopied: false,
-     *                 description: "Dive deep into the mysteries of the universe with your guide to everything galactic.",
-     *                 descriptionCopied: false
-     *             },
-     *             localeId: "653fd9af6a07fc9cfd7a5e57",
-     *             publishedPath: "/en-us/guide-to-the-galaxy"
+     *         title: "Guide to the Galaxy",
+     *         slug: "guide-to-the-galaxy",
+     *         seo: {
+     *             title: "The Ultimate Hitchhiker's Guide to the Galaxy",
+     *             description: "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
+     *         },
+     *         openGraph: {
+     *             title: "Explore the Cosmos with The Ultimate Guide",
+     *             titleCopied: false,
+     *             description: "Dive deep into the mysteries of the universe with your guide to everything galactic.",
+     *             descriptionCopied: false
      *         }
      *     })
      */
-    updatePageSettings(pageId: string, request: Webflow.UpdatePageSettingsRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Page>;
+    updatePageSettings(pageId: string, request?: Webflow.PageMetadataWrite, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.Page>;
+    private __updatePageSettings;
     /**
-     * Get content from a static page. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and component instances with [property overrides](https://help.webflow.com/hc/en-us/articles/33961219350547-Component-properties#how-to-modify-property-values-on-component-instances).
-     *
-     * To retrieve the static content of a component instance, use the [Get Component Content](/data/reference/pages-and-components/components/get-content) endpoint.
+     * Get text and component instance content from a static page.
      *
-     * <Note>If you do not include a `localeId` in your request, the response will return any content that can be localized from the Primary locale.</Note>
+     * <Badge intent="info">Localization</Badge>
      *
      * Required scope | `pages:read`
      *
@@ -140,16 +133,20 @@ export declare class Pages {
      *
      * @example
      *     await client.pages.getContent("63c720f9347c2139b248e552", {
-     *         localeId: "65427cf400e02b306eaa04a0"
+     *         localeId: "65427cf400e02b306eaa04a0",
+     *         limit: 1.1,
+     *         offset: 1.1
      *     })
      */
-    getContent(pageId: string, request?: Webflow.PagesGetContentRequest, requestOptions?: Pages.RequestOptions): Promise<Webflow.Dom>;
+    getContent(pageId: string, request?: Webflow.PagesGetContentRequest, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.Dom>;
+    private __getContent;
     /**
      * This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request.
      *
      * Before making updates:
-     * 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types
-     * 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint
+     * 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types.
+     * 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.
+     * 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.
      *
      * <Note>
      *   This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
@@ -205,8 +202,7 @@ export declare class Pages {
      *             }]
      *     })
      */
-    updateStaticContent(pageId: string, request: Webflow.PageDomWrite, requestOptions?: Pages.RequestOptions): Promise<Webflow.UpdateStaticContentResponse>;
-    protected _scripts: Scripts | undefined;
-    get scripts(): Scripts;
-    protected _getAuthorizationHeader(): Promise<string>;
+    updateStaticContent(pageId: string, request: Webflow.PageDomWrite, requestOptions?: Pages.RequestOptions): core.HttpResponsePromise<Webflow.UpdateStaticContentResponse>;
+    private __updateStaticContent;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }