webflow-api 3.0.1 → 3.1.0

package/.mock/definition/orders.yml

@@ -9,15 +9,16 @@ types:
       - disputed
       - unfulfilled
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
   OrdersRefundRequestReason:
     enum:
       - duplicate
       - fraudulent
       - requested
     docs: The reason for the refund
+    inline: true
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
 imports:
   root: __package__.yml
 service:
@@ -33,7 +34,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -423,7 +424,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -647,7 +648,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -887,7 +888,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -1119,7 +1120,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -1342,7 +1343,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -1565,5 +1566,6 @@ service:
                   url: >-
                     https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Orders
+docs: Orders are the orders for your Webflow site.

package/.mock/definition/pages/scripts.yml

@@ -20,15 +20,14 @@ service:
 
         `custom_code` endpoints. 
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>
+
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>
 
 
         Required scope | `custom_code:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -70,17 +69,19 @@ service:
         to a Site via the `registered_scripts` endpoints, and then applied to a
         Site or Page using the appropriate
 
-        `custom_code` endpoints. 
+        `custom_code` endpoints.
+
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>
+        A site can have a maximum of 800 registered scripts.
+
+
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>
 
 
         Required scope | `custom_code:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -96,6 +97,7 @@ service:
         - root.BadRequestError
         - root.UnauthorizedError
         - root.NotFoundError
+        - root.ConflictError
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
@@ -142,15 +144,14 @@ service:
 
         `custom_code` endpoints. 
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>
+
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>
 
 
         Required scope | `custom_code:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -166,4 +167,4 @@ service:
         - path-parameters:
             page_id: 63c720f9347c2139b248e552
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/pages.yml

@@ -13,7 +13,7 @@ service:
 
         Required scope | `pages:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -121,7 +121,7 @@ service:
 
         Required scope | `pages:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -187,7 +187,7 @@ service:
 
         Required scope | `pages:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -276,16 +276,23 @@ service:
       method: GET
       auth: true
       docs: >
-        Get static content from a static page.
+        Get static content from a static page. This includes text nodes, image
+        nodes and component instances.
 
+        To retrieve the contents of components in the page use the [get
+        component
+        content](/data/reference/pages-and-components/components/get-content)
+        endpoint.
 
-        If you do not provide a Locale ID in your request, the response will
-        return any content that can be localized from the Primary locale.
+
+        <Note>If you do not provide a Locale ID in your request, the response
+        will return any content that can be localized from the Primary
+        locale.</Note>
 
 
         Required scope | `pages:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
@@ -318,7 +325,8 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - path-parameters:
+        - name: PageDOM
+          path-parameters:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
             localeId: 65427cf400e02b306eaa04a0
@@ -326,65 +334,86 @@ service:
             body:
               pageId: 658205daa3e8206a523b5ad4
               nodes:
-                - id: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                  type: text
-                  text:
-                    html: <h1>The Hitchhiker's Guide to the Galaxy</h1>
-                    text: The Hitchhiker's Guide to the Galaxy
-                  attributes:
-                    key: value
-                - id: a245c12d-995b-55ee-5ec7-aa36a6cad627
-                  type: text
-                  text:
-                    html: >-
-                      <div><h3>Don't Panic!</h3><p>Always know where your towel
-                      is.</p></div>
-                  attributes:
-                    key: value
-                - id: a245c12d-995b-55ee-5ec7-aa36a6cad629
-                  type: image
-                  image:
-                    alt: Marvin, the Paranoid Android
-                    assetId: 659595234426a9fcbad57043
-                  attributes:
-                    key: value
+                - type: component-instance
+                  id: a245c12d-995b-55ee-5ec7-aa36a6cad623
+                  componentId: nodes
+                  propertyOverrides:
+                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
+                - type: component-instance
+                  id: a245c12d-995b-55ee-5ec7-aa36a6cad627
+                  componentId: nodes
+                  propertyOverrides:
+                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
+                - type: component-instance
+                  id: a245c12d-995b-55ee-5ec7-aa36a6cad629
+                  componentId: nodes
+                  propertyOverrides:
+                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
+                - type: component-instance
+                  id: a245c12d-995b-55ee-5ec7-aa36a6cad631
+                  componentId: 6258612d1ee792848f805dcf
+                  propertyOverrides:
+                    - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad633
+                      type: Plain Text
+                      label: Catchphrase
+                      text:
+                        text: Don't Panic!
+                    - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad635
+                      type: Rich Text
+                      label: Tagline
+                      text:
+                        html: <div><p>Always know where your towel is.</p></div>
               pagination:
-                limit: 3
+                limit: 4
                 offset: 0
-                total: 3
+                total: 4
     update-static-content:
       path: /pages/{page_id}/dom
       method: POST
       auth: true
       docs: >
-        This endpoint allows for updating static content on a static page within
-        a secondary locale. It is designed specifically for localized pages and
-        can handle up to 1000 nodes per request.
+        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:
 
-        <blockquote class="callout callout_info"><p><strong>Note:</strong>This
-        endpoint is specifically for localized pages. Ensure that the locale
-        specified is a valid secondary locale for the site.</p></blockquote>
+        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
+
+
+        <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.
+        </Note>
 
 
         Required scope | `pages:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         page_id:
           type: string
           docs: Unique identifier for a Page
       display-name: Update Page Content
       request:
-        name: DomWrite
+        name: PageDomWrite
         query-parameters:
           localeId:
-            type: optional<string>
-            docs: >-
-              Unique identifier for a specific locale. Applicable, when using
-              localization.
+            type: string
+            docs: The locale identifier.
         body:
           properties:
-            nodes: list<DomWriteNodesItem>
+            nodes:
+              docs: >-
+                List of DOM Nodes with the new content that will be updated in
+                each node.
+              type: list<PageDomWriteNodesItem>
         content-type: application/json
       response:
         docs: Request was successful
@@ -400,39 +429,37 @@ service:
         - path-parameters:
             page_id: 63c720f9347c2139b248e552
           query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
+            localeId: localeId
           request:
             nodes:
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                text: <h1>The Hitchhiker’s Guide to the Galaxy</h1>
+                text: <h1>The Hitchhiker's Guide to the Galaxy</h1>
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad627
                 text: >-
-                  <div><h3>Don’t Panic!</h3><p>Always know where your towel
+                  <div><h3>Don't Panic!</h3><p>Always know where your towel
                   is.</p></div>
               - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629
-                text: >-
-                  <img alt="Marvin, the Paranoid Android"
-                  src="path/to/image/with/assetId/659595234426a9fcbad57043"/>
+                propertyOverrides:
+                  - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
+                    text: <div><h1>Time is an <em>illusion</em></h1></div>
+                  - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f1
+                    text: Life, the Universe and Everything
           response:
             body:
               errors:
                 - errors
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Pages
+docs: Pages are the pages in your Webflow site.
 types:
-  DomWriteNodesItem:
-    properties:
-      nodeId:
-        type: string
-        docs: Node UUID
-      text:
-        type: string
-        docs: >-
-          HTML content of the node, including the HTML tag. The HTML tags must
-          be the same as what's returned from the Get Content endpoint.
+  PageDomWriteNodesItem:
+    discriminated: false
+    union:
+      - root.TextNodeWrite
+      - root.ComponentInstanceNodePropertyOverridesWrite
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true
   UpdateStaticContentResponse:
     properties:
@@ -440,4 +467,4 @@ types:
         docs: A list of error messages, if any.
         type: list<string>
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/products.yml

@@ -21,7 +21,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -112,7 +112,7 @@ service:
           - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`. 
           - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created.
           - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. 
-          - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products-sk-us/create-sku)
+          - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku)
 
         Upon creation, the default product type will be `Advanced`, which
         ensures all Product and SKU fields will be shown to users in the
@@ -121,7 +121,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -202,7 +202,7 @@ service:
 
         Required scope | `ecommerce:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -283,7 +283,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -358,7 +358,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -426,7 +426,7 @@ service:
 
         Required scope | `ecommerce:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -491,10 +491,10 @@ service:
                 track-inventory: true
                 quantity: 10
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
 types:
   ProductsCreateSkuResponse:
     properties:
       skus: optional<list<root.Sku>>
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/scripts.yml

@@ -23,15 +23,14 @@ service:
         Additionally, Scripts can be remotely hosted, or registered as inline
         snippets.
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>    
+
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>    
 
 
         Required scope | `custom_code:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -96,15 +95,14 @@ service:
         Additionally, Scripts can be remotely hosted, or registered as inline
         snippets.  
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>    
+
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>    
 
 
         Required scope | `custom_code:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -183,15 +181,13 @@ service:
         `custom_code` endpoints. 
 
 
-        <blockquote class="callout callout_info" theme="📘">Access to this
-        endpoint requires a bearer token from a <a
-        href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data
-        Client App</a>.</blockquote>    
+        <Note>Access to this endpoint requires a bearer token from a [Data
+        Client App](/data/docs/getting-started-data-clients).</Note>    
 
 
         Required scope | `custom_code:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -254,4 +250,4 @@ service:
               lastUpdated: lastUpdated
               version: 0.0.1
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites/activityLogs.yml

@@ -12,7 +12,7 @@ service:
         Retrieve Activity Logs for a specific Site. Requires Site to be on an
         Enterprise plan. </br></br>  Required scope | `site_activity:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -62,4 +62,4 @@ service:
                 offset: 0
                 total: 1
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites/plans.yml

@@ -0,0 +1,40 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    get-site-plan:
+      path: /sites/{site_id}/plan
+      method: GET
+      auth: true
+      docs: |
+        Get site plan details for the specified Site.
+
+        Required scope | `sites:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get Site Plan
+      response:
+        docs: Request was successful
+        type: root.SitePlan
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              id: hosting-business-v4
+              name: Business Hosting
+              pricingInfo: https://webflow.com/pricing
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml