webflow-api 3.2.1 → 3.3.0-beta

package/dist/api/resources/collections/resources/items/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 Items {
-    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 | undefined>;
-        /** 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 Items {
@@ -81,7 +64,41 @@ export declare class Items {
      *             isDraft: false,
      *             fieldData: {
      *                 name: "The Hitchhiker's Guide to the Galaxy",
-     *                 slug: "hitchhikers-guide-to-the-galaxy"
+     *                 slug: "hitchhikers-guide-to-the-galaxy",
+     *                 "plain-text": "Don't Panic.",
+     *                 "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don't forget yours!</strong></p>",
+     *                 "main-image": {
+     *                     "fileId": "62b720ef280c7a7a3be8cabe",
+     *                     "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                 },
+     *                 "image-gallery": [
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabd",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
+     *                     },
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabe",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                     }
+     *                 ],
+     *                 "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
+     *                 "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
+     *                 "contact-email": "zaphod.beeblebrox@heartofgold.gov",
+     *                 "support-phone": "424-242-4242",
+     *                 "answer-to-everything": 42,
+     *                 "release-date": "1979-10-12T00:00:00.000Z",
+     *                 "is-featured": true,
+     *                 "brand-color": "#000000",
+     *                 category: "62b720ef280c7a7a3be8cabf",
+     *                 author: "62b720ef280c7a7a3be8cab0",
+     *                 tags: [
+     *                     "62b720ef280c7a7a3be8cab1",
+     *                     "62b720ef280c7a7a3be8cab2"
+     *                 ],
+     *                 "downloadable-asset": {
+     *                     "fileId": "62b720ef280c7a7a3be8cab3",
+     *                     "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
+     *                 }
      *             }
      *         }
      *     })
@@ -95,14 +112,18 @@ export declare class Items {
      *                     isDraft: false,
      *                     fieldData: {
      *                         name: "Senior Data Analyst",
-     *                         slug: "senior-data-analyst"
+     *                         slug: "senior-data-analyst",
+     *                         url: "https://boards.greenhouse.io/webflow/jobs/26567701",
+     *                         department: "Data"
      *                     }
      *                 }, {
      *                     isArchived: false,
      *                     isDraft: false,
      *                     fieldData: {
      *                         name: "Product Manager",
-     *                         slug: "product-manager"
+     *                         slug: "product-manager",
+     *                         url: "https://boards.greenhouse.io/webflow/jobs/31234567",
+     *                         department: "Product"
      *                     }
      *                 }]
      *         }
@@ -164,28 +185,32 @@ export declare class Items {
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
      *                 fieldData: {
      *                     name: "Ne Paniquez Pas",
-     *                     slug: "ne-paniquez-pas"
+     *                     slug: "ne-paniquez-pas",
+     *                     featured: false
      *                 }
      *             }, {
      *                 id: "66f6ed9576ddacf3149d5ea6",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
      *                 fieldData: {
      *                     name: "No Entrar en P\u00E1nico",
-     *                     slug: "no-entrar-en-panico"
+     *                     slug: "no-entrar-en-panico",
+     *                     featured: false
      *                 }
      *             }, {
      *                 id: "66f6ed9576ddacf3149d5eaa",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
      *                 fieldData: {
      *                     name: "Au Revoir et Merci pour Tous les Poissons",
-     *                     slug: "au-revoir-et-merci"
+     *                     slug: "au-revoir-et-merci",
+     *                     featured: false
      *                 }
      *             }, {
      *                 id: "66f6ed9576ddacf3149d5eaa",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
      *                 fieldData: {
      *                     name: "Hasta Luego y Gracias por Todo el Pescado",
-     *                     slug: "hasta-luego-y-gracias"
+     *                     slug: "hasta-luego-y-gracias",
+     *                     featured: false
      *                 }
      *             }]
      *     })
@@ -199,7 +224,9 @@ export declare class Items {
      *                 isDraft: false,
      *                 fieldData: {
      *                     name: "Senior Data Analyst",
-     *                     slug: "senior-data-analyst"
+     *                     slug: "senior-data-analyst",
+     *                     url: "https://boards.greenhouse.io/webflow/jobs/26567701",
+     *                     department: "Data"
      *                 }
      *             }, {
      *                 id: "580e64008c9a982ac9b8b754",
@@ -207,7 +234,9 @@ export declare class Items {
      *                 isDraft: false,
      *                 fieldData: {
      *                     name: "Product Manager",
-     *                     slug: "product-manager"
+     *                     slug: "product-manager",
+     *                     url: "https://boards.greenhouse.io/webflow/jobs/31234567",
+     *                     department: "Product"
      *                 }
      *             }]
      *     })
@@ -217,10 +246,9 @@ export declare class Items {
     /**
      * List all published items in a collection.
      *
-     * <Note title="Serve data with the Content Delivery API">
-     *   To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
-     *
-     * </Note>
+     * <Tip title="Serve data with the Content Delivery API">
+     *   Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+     * </Tip>
      *
      * Required scope | `CMS:read`
      *
@@ -274,7 +302,41 @@ export declare class Items {
      *             isDraft: false,
      *             fieldData: {
      *                 name: "The Hitchhiker's Guide to the Galaxy",
-     *                 slug: "hitchhikers-guide-to-the-galaxy"
+     *                 slug: "hitchhikers-guide-to-the-galaxy",
+     *                 "plain-text": "Don't Panic.",
+     *                 "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don't forget yours!</strong></p>",
+     *                 "main-image": {
+     *                     "fileId": "62b720ef280c7a7a3be8cabe",
+     *                     "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                 },
+     *                 "image-gallery": [
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabd",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
+     *                     },
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabe",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                     }
+     *                 ],
+     *                 "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
+     *                 "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
+     *                 "contact-email": "zaphod.beeblebrox@heartofgold.gov",
+     *                 "support-phone": "424-242-4242",
+     *                 "answer-to-everything": 42,
+     *                 "release-date": "1979-10-12T00:00:00.000Z",
+     *                 "is-featured": true,
+     *                 "brand-color": "#000000",
+     *                 category: "62b720ef280c7a7a3be8cabf",
+     *                 author: "62b720ef280c7a7a3be8cab0",
+     *                 tags: [
+     *                     "62b720ef280c7a7a3be8cab1",
+     *                     "62b720ef280c7a7a3be8cab2"
+     *                 ],
+     *                 "downloadable-asset": {
+     *                     "fileId": "62b720ef280c7a7a3be8cab3",
+     *                     "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
+     *                 }
      *             }
      *         }
      *     })
@@ -288,14 +350,18 @@ export declare class Items {
      *                     isDraft: false,
      *                     fieldData: {
      *                         name: "Senior Data Analyst",
-     *                         slug: "senior-data-analyst"
+     *                         slug: "senior-data-analyst",
+     *                         url: "https://boards.greenhouse.io/webflow/jobs/26567701",
+     *                         department: "Data"
      *                     }
      *                 }, {
      *                     isArchived: false,
      *                     isDraft: false,
      *                     fieldData: {
      *                         name: "Product Manager",
-     *                         slug: "product-manager"
+     *                         slug: "product-manager",
+     *                         url: "https://boards.greenhouse.io/webflow/jobs/31234567",
+     *                         department: "Product"
      *                     }
      *                 }]
      *         }
@@ -355,28 +421,32 @@ export declare class Items {
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
      *                 fieldData: {
      *                     name: "Ne Paniquez Pas",
-     *                     slug: "ne-paniquez-pas"
+     *                     slug: "ne-paniquez-pas",
+     *                     featured: false
      *                 }
      *             }, {
      *                 id: "66f6ed9576ddacf3149d5ea6",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
      *                 fieldData: {
      *                     name: "No Entrar en P\u00E1nico",
-     *                     slug: "no-entrar-en-panico"
+     *                     slug: "no-entrar-en-panico",
+     *                     featured: false
      *                 }
      *             }, {
      *                 id: "66f6ed9576ddacf3149d5eaa",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
      *                 fieldData: {
      *                     name: "Au Revoir et Merci pour Tous les Poissons",
-     *                     slug: "au-revoir-et-merci"
+     *                     slug: "au-revoir-et-merci",
+     *                     featured: false
      *                 }
      *             }, {
      *                 id: "66f6ed9576ddacf3149d5eaa",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
      *                 fieldData: {
      *                     name: "Hasta Luego y Gracias por Todo el Pescado",
-     *                     slug: "hasta-luego-y-gracias"
+     *                     slug: "hasta-luego-y-gracias",
+     *                     featured: false
      *                 }
      *             }]
      *     })
@@ -390,7 +460,9 @@ export declare class Items {
      *                 isDraft: false,
      *                 fieldData: {
      *                     name: "Senior Data Analyst",
-     *                     slug: "senior-data-analyst"
+     *                     slug: "senior-data-analyst",
+     *                     url: "https://boards.greenhouse.io/webflow/jobs/26567701",
+     *                     department: "Data"
      *                 }
      *             }, {
      *                 id: "580e64008c9a982ac9b8b754",
@@ -398,7 +470,9 @@ export declare class Items {
      *                 isDraft: false,
      *                 fieldData: {
      *                     name: "Product Manager",
-     *                     slug: "product-manager"
+     *                     slug: "product-manager",
+     *                     url: "https://boards.greenhouse.io/webflow/jobs/31234567",
+     *                     department: "Product"
      *                 }
      *             }]
      *     })
@@ -524,7 +598,41 @@ export declare class Items {
      *             isDraft: false,
      *             fieldData: {
      *                 name: "The Hitchhiker's Guide to the Galaxy",
-     *                 slug: "hitchhikers-guide-to-the-galaxy"
+     *                 slug: "hitchhikers-guide-to-the-galaxy",
+     *                 "plain-text": "Don't Panic.",
+     *                 "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don't forget yours!</strong></p>",
+     *                 "main-image": {
+     *                     "fileId": "62b720ef280c7a7a3be8cabe",
+     *                     "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                 },
+     *                 "image-gallery": [
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabd",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
+     *                     },
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabe",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                     }
+     *                 ],
+     *                 "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
+     *                 "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
+     *                 "contact-email": "zaphod.beeblebrox@heartofgold.gov",
+     *                 "support-phone": "424-242-4242",
+     *                 "answer-to-everything": 42,
+     *                 "release-date": "1979-10-12T00:00:00.000Z",
+     *                 "is-featured": true,
+     *                 "brand-color": "#000000",
+     *                 category: "62b720ef280c7a7a3be8cabf",
+     *                 author: "62b720ef280c7a7a3be8cab0",
+     *                 tags: [
+     *                     "62b720ef280c7a7a3be8cab1",
+     *                     "62b720ef280c7a7a3be8cab2"
+     *                 ],
+     *                 "downloadable-asset": {
+     *                     "fileId": "62b720ef280c7a7a3be8cab3",
+     *                     "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
+     *                 }
      *             }
      *         }
      *     })
@@ -534,10 +642,9 @@ export declare class Items {
     /**
      * Get details of a selected Collection live Item.
      *
-     * <Note title="Serve data with the Content Delivery API">
-     *   To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
-     *
-     * </Note>
+     * <Tip title="Serve data with the Content Delivery API">
+     *   Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+     * </Tip>
      *
      * Required scope | `CMS:read`
      *
@@ -609,7 +716,41 @@ export declare class Items {
      *             isDraft: false,
      *             fieldData: {
      *                 name: "The Hitchhiker's Guide to the Galaxy",
-     *                 slug: "hitchhikers-guide-to-the-galaxy"
+     *                 slug: "hitchhikers-guide-to-the-galaxy",
+     *                 "plain-text": "Don't Panic.",
+     *                 "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don't forget yours!</strong></p>",
+     *                 "main-image": {
+     *                     "fileId": "62b720ef280c7a7a3be8cabe",
+     *                     "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                 },
+     *                 "image-gallery": [
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabd",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
+     *                     },
+     *                     {
+     *                         "fileId": "62b720ef280c7a7a3be8cabe",
+     *                         "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
+     *                     }
+     *                 ],
+     *                 "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
+     *                 "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
+     *                 "contact-email": "zaphod.beeblebrox@heartofgold.gov",
+     *                 "support-phone": "424-242-4242",
+     *                 "answer-to-everything": 42,
+     *                 "release-date": "1979-10-12T00:00:00.000Z",
+     *                 "is-featured": true,
+     *                 "brand-color": "#000000",
+     *                 category: "62b720ef280c7a7a3be8cabf",
+     *                 author: "62b720ef280c7a7a3be8cab0",
+     *                 tags: [
+     *                     "62b720ef280c7a7a3be8cab1",
+     *                     "62b720ef280c7a7a3be8cab2"
+     *                 ],
+     *                 "downloadable-asset": {
+     *                     "fileId": "62b720ef280c7a7a3be8cab3",
+     *                     "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
+     *                 }
      *             }
      *         }
      *     })