webflow-api 3.0.0 → 3.1.0

package/.mock/definition/sites/redirects.yml

@@ -0,0 +1,190 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/redirects
+      method: GET
+      auth: true
+      docs: >
+        Fetch a list of all URL redirect rules configured for a specific site.
+
+
+        Use this endpoint to review, audit, or manage the redirection rules that
+        control how traffic is rerouted on your 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 URL redirects
+      response:
+        docs: Request was successful
+        type: root.Redirects
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              redirects:
+                - id: 42e1a2b7aa1a13f768a0042a
+                  fromUrl: /mostly-harmless
+                  toUrl: /earth
+                - id: 6x9e7f8d9a4b1c2d3e4f5678
+                  fromUrl: /babel-fish
+                  toUrl: /translate
+              pagination:
+                limit: 100
+                offset: 0
+                total: 2
+    create:
+      path: /sites/{site_id}/redirects
+      method: POST
+      auth: true
+      docs: >
+        Add a new URL redirection rule to a site.
+
+
+        This endpoint allows you to define a source path (`fromUrl`) and its
+        corresponding destination path (`toUrl`), which will dictate how traffic
+        is rerouted on your site. This is useful for managing site changes,
+        restructuring URLs, or handling outdated links.
+
+
+        Required scope: `sites:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create a URL redirect
+      request:
+        body: root.Redirect
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Redirect
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            id: 42e1a2b7aa1a13f768a0042a
+            fromUrl: /mostly-harmless
+            toUrl: /earth
+          response:
+            body:
+              id: 42e1a2b7aa1a13f768a0042a
+              fromUrl: /mostly-harmless
+              toUrl: /earth
+    delete:
+      path: /sites/{site_id}/redirects/{redirect_id}
+      method: DELETE
+      auth: true
+      docs: >
+        Remove a URL redirection rule from a site.
+
+        This is useful for cleaning up outdated or unnecessary redirects,
+        ensuring that your site's routing behavior remains efficient and
+        up-to-date.
+
+        Required scope: `sites:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        redirect_id:
+          type: string
+          docs: Unique identifier site rediect
+      display-name: Delete URL redirects
+      response:
+        docs: Request was successful
+        type: root.Redirects
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            redirect_id: 66c4cb9a20cac35ed19500e6
+          response:
+            body:
+              redirects:
+                - id: 42e1a2b7aa1a13f768a0042a
+                  fromUrl: /mostly-harmless
+                  toUrl: /earth
+                - id: 6x9e7f8d9a4b1c2d3e4f5678
+                  fromUrl: /babel-fish
+                  toUrl: /translate
+              pagination:
+                limit: 100
+                offset: 0
+                total: 2
+    update:
+      path: /sites/{site_id}/redirects/{redirect_id}
+      method: PATCH
+      auth: true
+      docs: |
+        Update a URL redirection rule from a site.
+        Required scope: `sites:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        redirect_id:
+          type: string
+          docs: Unique identifier site rediect
+      display-name: Update URL redirect
+      request:
+        body: root.Redirect
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Redirect
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            redirect_id: 66c4cb9a20cac35ed19500e6
+          request:
+            id: 42e1a2b7aa1a13f768a0042a
+            fromUrl: /mostly-harmless
+            toUrl: /earth
+          response:
+            body:
+              id: 42e1a2b7aa1a13f768a0042a
+              fromUrl: /mostly-harmless
+              toUrl: /earth
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites/scripts.yml

@@ -11,15 +11,14 @@ service:
       docs: >
         Get all registered scripts that have been applied to a specific Site. 
 
-        <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
@@ -68,15 +67,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:
         site_id:
           type: string
@@ -130,15 +128,13 @@ service:
         Delete the custom code block that an app created for a Site
 
 
-        <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
@@ -160,15 +156,14 @@ service:
       docs: >
         Get all instances of Custom Code applied to a Site or Pages. 
 
-        <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
@@ -225,4 +220,4 @@ service:
                 offset: 0
                 total: 1
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites.yml

@@ -4,6 +4,88 @@ service:
   auth: false
   base-path: ''
   endpoints:
+    create:
+      path: /workspaces/{workspace_id}/sites
+      method: POST
+      auth: true
+      docs: |
+        Create a site. This endpoint requires an Enterprise workspace.
+
+        Required scope | `workspace:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        workspace_id:
+          type: string
+          docs: Unique identifier for a Workspace
+      display-name: Create Site
+      request:
+        name: SitesCreateRequest
+        body:
+          properties:
+            name:
+              type: string
+              docs: The name of the site
+            templateName:
+              type: optional<string>
+              docs: The workspace or marketplace template to use
+            parentFolderId:
+              type: optional<string>
+              docs: MegaDodo Publications - Potential Book Ideas
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Site
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - name: NewlyCreatedSite
+          path-parameters:
+            workspace_id: 580e63e98c9a982ac9b8b741
+          request:
+            name: The Hitchhiker's Guide to the Galaxy
+          response:
+            body:
+              id: 670ecf86817e3cc7a510eb6a
+              workspaceId: 625860a7a6c16d624927122f
+              createdOn: '2024-10-15T20:24:38Z'
+              displayName: The Hitchiker‘s Guide
+              shortName: hitchikers-guide
+              lastPublished: '2016-10-24T19:43:17Z'
+              lastUpdated: '2024-10-15T20:24:38Z'
+              previewUrl: >-
+                https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png
+              timeZone: America/Los_Angeles
+              parentFolderId: 670ece123598db72d9648be1
+              customDomains:
+                - id: 589a331aa51e760df7ccb89d
+                  url: test-api-domain.com
+                  lastPublished: '2022-12-07T16:51:37Z'
+              locales:
+                primary:
+                  id: 653fd9af6a07fc9cfd7a5e57
+                  cmsLocaleId: 653ad57de882f528b32e810e
+                  enabled: false
+                  displayName: English (United States)
+                  displayImageId: displayImageId
+                  redirect: true
+                  subdirectory: ''
+                  tag: en-US
+                secondary:
+                  - id: 653fd9af6a07fc9cfd7a5e57
+                    cmsLocaleId: 653ad57de882f528b32e810e
+                    enabled: false
+                    displayName: English (United States)
+                    redirect: true
+                    subdirectory: ''
+                    tag: en-US
+              dataCollectionEnabled: false
+              dataCollectionType: always
     list:
       path: /sites
       method: GET
@@ -13,7 +95,7 @@ service:
 
         Required scope | `sites:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       display-name: List Sites
       response:
         docs: Request was successful
@@ -40,6 +122,7 @@ service:
                   customDomains:
                     - id: 589a331aa51e760df7ccb89e
                       url: heartofgold.galaxy
+                      lastPublished: '2022-12-07T16:51:37Z'
                   locales:
                     primary:
                       id: 653fd9af6a07fc9cfd7a5e57
@@ -80,6 +163,7 @@ service:
                   customDomains:
                     - id: 589a331aa51e760df7ccb89f
                       url: marvin.blog
+                      lastPublished: '2022-12-07T16:51:37Z'
                   locales:
                     primary:
                       id: 653fd9af6a07fc9cfd7a5e57
@@ -113,6 +197,7 @@ service:
                   customDomains:
                     - id: 589a331aa51e760df7ccb8a0
                       url: vogonpoetry.galaxy
+                      lastPublished: '2022-12-07T16:51:37Z'
                   locales:
                     primary:
                       id: 653fd9af6a07fc9cfd7a5e55
@@ -141,7 +226,7 @@ service:
 
         Required scope | `sites:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -175,8 +260,115 @@ service:
               customDomains:
                 - id: 589a331aa51e760df7ccb89d
                   url: hitchhikersguide.galaxy
+                  lastPublished: '2022-12-07T16:51:37Z'
+                - id: 589a331aa51e760df7ccb89e
+                  url: heartofgold.spaceship
+                  lastPublished: '2022-12-07T16:51:37Z'
+              locales:
+                primary:
+                  id: 653fd9af6a07fc9cfd7a5e57
+                  cmsLocaleId: 653ad57de882f528b32e810e
+                  enabled: false
+                  displayName: English (United States)
+                  displayImageId: displayImageId
+                  redirect: true
+                  subdirectory: ''
+                  tag: en-US
+                secondary:
+                  - id: 653fd9af6a07fc9cfd7a5e57
+                    cmsLocaleId: 653ad57de882f528b32e810e
+                    enabled: false
+                    displayName: English (United States)
+                    redirect: true
+                    subdirectory: ''
+                    tag: en-US
+              dataCollectionEnabled: true
+              dataCollectionType: always
+    delete:
+      path: /sites/{site_id}
+      method: DELETE
+      auth: true
+      docs: |
+        Delete a site. This endpoint requires an Enterprise workspace.
+
+        Required scope | `sites:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Delete Site
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+    update:
+      path: /sites/{site_id}
+      method: PATCH
+      auth: true
+      docs: |
+        Update a site. This endpoint requires an Enterprise workspace.
+
+        Required scope | `sites:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Update Site
+      request:
+        name: SitesUpdateRequest
+        body:
+          properties:
+            name:
+              type: optional<string>
+              docs: The name of the site
+            parentFolderId:
+              type: optional<string>
+              docs: The parent folder ID of the site
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Site
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request: {}
+          response:
+            body:
+              id: 42e98c9a982ac9b8b742
+              workspaceId: 42e63e98c9a982ac9b8b742
+              createdOn: '1979-10-12T12:00:00Z'
+              displayName: The Hitchhiker's Guide to the Galaxy
+              shortName: hitchhikers-guide
+              lastPublished: '2023-04-02T12:42:00Z'
+              lastUpdated: '2023-04-02T12:42:00Z'
+              previewUrl: >-
+                https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png
+              timeZone: Magrathea/FactoryFloor
+              parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
+              customDomains:
+                - id: 589a331aa51e760df7ccb89d
+                  url: hitchhikersguide.galaxy
+                  lastPublished: '2022-12-07T16:51:37Z'
                 - id: 589a331aa51e760df7ccb89e
                   url: heartofgold.spaceship
+                  lastPublished: '2022-12-07T16:51:37Z'
               locales:
                 primary:
                   id: 653fd9af6a07fc9cfd7a5e57
@@ -206,7 +398,7 @@ service:
 
         Required scope | `sites:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -229,8 +421,10 @@ service:
               customDomains:
                 - id: 589a331aa51e760df7ccb89d
                   url: hitchhikersguide.galaxy
+                  lastPublished: '2022-12-07T16:51:37Z'
                 - id: 589a331aa51e760df7ccb89e
                   url: heartofgold.spaceship
+                  lastPublished: '2022-12-07T16:51:37Z'
     publish:
       path: /sites/{site_id}/publish
       method: POST
@@ -245,7 +439,7 @@ service:
 
         Required scope | `sites:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -281,10 +475,12 @@ service:
               customDomains:
                 - id: 589a331aa51e760df7ccb89d
                   url: test-api-domain.com
+                  lastPublished: '2022-12-07T16:51:37Z'
               publishToWebflowSubdomain: true
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Sites
+docs: Sites are the sites in your Webflow workspace.
 types:
   SitesPublishResponse:
     properties:
@@ -296,4 +492,4 @@ types:
         docs: Flag for publishing to webflow.io subdomain
         default: false
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/token.yml

@@ -13,7 +13,7 @@ service:
 
         Required Scope | `authorized_user:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       display-name: Get Authorization User Info
       response:
         docs: Request was successful
@@ -35,10 +35,11 @@ service:
       docs: >
         Information about the authorization token
 
-        <Note>Access to this endpoint requires a bearer token from a []>Data
+
+        <Note>Access to this endpoint requires a bearer token from a [Data
         Client App](/data/docs/getting-started-data-clients).</Note>
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       display-name: Get Authorization Info
       response:
         docs: Request was successful
@@ -68,4 +69,4 @@ service:
                 homepage: https://webflow.com
                 displayName: My Amazing App
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/users.yml

@@ -32,7 +32,7 @@ types:
         name: UpdatedOnDescending
         docs: Sorts users in descending order based on their update date
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
   UsersUpdateRequestData:
     properties:
       name:
@@ -48,7 +48,7 @@ types:
         docs: |
           Boolean indicating if the user has accepted to receive communications
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true
 imports:
   root: __package__.yml
@@ -65,7 +65,7 @@ service:
 
         Required scope | `users:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -169,7 +169,7 @@ service:
 
         Required scope | `users:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -220,7 +220,7 @@ service:
 
         Required scope | `users:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -252,7 +252,7 @@ service:
         <Note class="notice">The <code>email</code> and <code>password</code>
         fields cannot be updated using this endpoint</Note>
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -329,7 +329,7 @@ service:
 
         Required scope | `users:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -389,4 +389,4 @@ service:
                   accept-communications: true
                   additionalProperties: additionalProperties
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml