webflow-api 3.0.1 → 3.1.1

package/.mock/definition/accessGroups.yml

@@ -8,7 +8,7 @@ types:
         name: CreatedOnDescending
         docs: Sorts users in descending order based on their created date
     source:
-      openapi: ../../../referenced-specs/v2.yml
+      openapi: ../../../openapi/referenced-specs/v2.yml
 imports:
   root: __package__.yml
 service:
@@ -24,7 +24,7 @@ service:
 
         Required scope | `users:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -49,6 +49,7 @@ service:
       response:
         docs: Request was successful
         type: root.AccessGroupList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -77,4 +78,4 @@ service:
                   slug: admin
                   createdOn: '2022-08-01T19:41:48Z'
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/assets.yml

@@ -9,11 +9,11 @@ service:
       method: GET
       auth: true
       docs: |
-        List assets for a given site
+        List of assets uploaded to a site
 
         Required scope | `assets:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -22,6 +22,7 @@ service:
       response:
         docs: Request was successful
         type: root.Assets
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -55,35 +56,64 @@ service:
                       width: 500
                       height: 900
                       quality: 100
-                  altText: A red chair
+                  altText: A single candy wrapper
+                - id: 63e5889e7fe4eafa7384cea5
+                  contentType: image/png
+                  size: 2212772
+                  siteId: 63938b302ea6b0aa6f3d8745
+                  hostedUrl: >-
+                    https://s3.amazonaws.com/webflow-prod-assets/63938b302ea6b0aa6f3d8745/63e5889e7fe4eafa7384cea4_Vectors-Wrapper.svg
+                  originalFileName: Gum-Wrapper.svg
+                  displayName: 63e5889e7fe4eafa7384cea5_Gum-Wrapper.png
+                  lastUpdated: '2023-03-01T23:42:57Z'
+                  createdOn: '2023-02-09T23:58:22Z'
+                  variants:
+                    - hostedUrl: >-
+                        https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                      originalFileName: >-
+                        Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                      displayName: >-
+                        660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                      format: png
+                      width: 500
+                      height: 900
+                      quality: 100
+                  altText: A single gum wrapper
+              pagination:
+                limit: 2
+                offset: 0
+                total: 2
     create:
       path: /sites/{site_id}/assets
       method: POST
       auth: true
       docs: >
-        Create a new asset entry. 
+        The first step in uploading an asset to a site. 
 
 
 
         This endpoint generates a response with the following information:
-        `uploadUrl` and `uploadDetails`. 
+        `uploadUrl` and `uploadDetails`.
 
-        You can use these two properties to [upload the file to Amazon s3 by
-        making a
-        POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
 
-        request to the `uploadUrl` with the `uploadDetails` object as your
-        header information in the request.
 
-         
-        Required scope | `assets:write`
+        Use these properties in the header of a [POST request to Amazson
+        s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
+        to complete the upload.
+
+
+
+        To learn more about how to upload assets to Webflow, see our [assets
+        guide](/data/docs/working-with-assets).
+          
+         Required scope | `assets:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
           docs: Unique identifier for a Site
-      display-name: Create Asset Metadata
+      display-name: Upload Asset
       request:
         name: AssetsCreateRequest
         body:
@@ -103,6 +133,7 @@ service:
       response:
         docs: Request was successful
         type: root.AssetUpload
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -146,11 +177,11 @@ service:
       method: GET
       auth: true
       docs: |
-        Get an Asset
+        Get details about an asset
 
         Required scope | `assets:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         asset_id:
           type: string
@@ -159,6 +190,7 @@ service:
       response:
         docs: Request was successful
         type: root.Asset
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -170,25 +202,27 @@ service:
             asset_id: 580e63fc8c9a982ac9b8b745
           response:
             body:
-              id: 55131cd036c09f7d07883dfc
+              id: 63e5889e7fe4eafa7384cea4
               contentType: image/png
-              size: 1500
-              siteId: 62749158efef318abc8d5a0f
-              hostedUrl: example.com/hostedimage.png
-              originalFileName: image.png
-              displayName: example-image-123.png
-              lastUpdated: '2016-09-06T21:12:22Z'
-              createdOn: '2016-09-02T23:26:22Z'
+              size: 2212772
+              siteId: 63938b302ea6b0aa6f3d8745
+              hostedUrl: >-
+                https://s3.amazonaws.com/webflow-prod-assets/63938b302ea6b0aa6f3d8745/63e5889e7fe4eafa7384cea4_Vectors-Wrapper.svg
+              originalFileName: Candy-Wrapper.svg
+              displayName: 63e5889e7fe4eafa7384cea4_Candy-Wrapper.png
+              lastUpdated: '2023-03-01T23:42:57Z'
+              createdOn: '2023-02-09T23:58:22Z'
               variants:
-                - hostedUrl: example.com/hostedimage.png
-                  originalFileName: image.png
-                  displayName: A brown dog
-                  format: format
-                  width: 1500
+                - hostedUrl: >-
+                    https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                  originalFileName: Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                  displayName: >-
+                    660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                  format: png
+                  width: 500
                   height: 900
-                  quality: 1
-                  error: error
-              altText: A red chair
+                  quality: 100
+              altText: A single candy wrapper
     delete:
       path: /assets/{asset_id}
       method: DELETE
@@ -198,7 +232,7 @@ service:
 
         Required Scope: `assets: write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         asset_id:
           type: string
@@ -218,11 +252,11 @@ service:
       method: PATCH
       auth: true
       docs: |
-        Update an Asset
+        Update details of an Asset.
 
         Required scope | `assets:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         asset_id:
           type: string
@@ -244,6 +278,7 @@ service:
       response:
         docs: Request was successful
         type: root.Asset
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -256,25 +291,27 @@ service:
           request: {}
           response:
             body:
-              id: 55131cd036c09f7d07883dfc
+              id: 63e5889e7fe4eafa7384cea4
               contentType: image/png
-              size: 1500
-              siteId: 62749158efef318abc8d5a0f
-              hostedUrl: example.com/hostedimage.png
-              originalFileName: image.png
-              displayName: example-image-123.png
-              lastUpdated: '2016-09-06T21:12:22Z'
-              createdOn: '2016-09-02T23:26:22Z'
+              size: 2212772
+              siteId: 63938b302ea6b0aa6f3d8745
+              hostedUrl: >-
+                https://s3.amazonaws.com/webflow-prod-assets/63938b302ea6b0aa6f3d8745/63e5889e7fe4eafa7384cea4_Vectors-Wrapper.svg
+              originalFileName: Candy-Wrapper.svg
+              displayName: 63e5889e7fe4eafa7384cea4_Candy-Wrapper.png
+              lastUpdated: '2023-03-01T23:42:57Z'
+              createdOn: '2023-02-09T23:58:22Z'
               variants:
-                - hostedUrl: example.com/hostedimage.png
-                  originalFileName: image.png
-                  displayName: A brown dog
-                  format: format
-                  width: 1500
+                - hostedUrl: >-
+                    https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                  originalFileName: Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                  displayName: >-
+                    660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png
+                  format: png
+                  width: 500
                   height: 900
-                  quality: 1
-                  error: error
-              altText: A red chair
+                  quality: 100
+              altText: A single candy wrapper
     list-folders:
       path: /sites/{site_id}/asset_folders
       method: GET
@@ -284,7 +321,7 @@ service:
 
         Required scope | `assets:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -293,6 +330,7 @@ service:
       response:
         docs: Request was successful
         type: root.AssetFolderList
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -307,7 +345,6 @@ service:
               assetFolders:
                 - id: 6390c49774a71f0e3c1a08ee
                   displayName: emoji icons
-                  parentFolder: 6390c49774a71f99f21a08eb
                   assets:
                     - 63e5889e7fe4eafa7384cea4
                     - 659595234426a9fcbad57043
@@ -327,7 +364,7 @@ service:
 
         Required scope | `assets:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         site_id:
           type: string
@@ -349,6 +386,7 @@ service:
       response:
         docs: Request was successful
         type: root.AssetFolder
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -380,7 +418,7 @@ service:
 
         Required scope | `assets:read`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         asset_folder_id:
           type: string
@@ -389,6 +427,7 @@ service:
       response:
         docs: Request was successful
         type: root.AssetFolder
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -410,5 +449,6 @@ service:
               createdOn: '2018-10-14T21:55:49Z'
               lastUpdated: '2022-12-07T16:51:37Z'
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml
   display-name: Assets
+docs: Assets are files that are uploaded to your Webflow account.

package/.mock/definition/collections/fields.yml

@@ -1,22 +1,3 @@
-types:
-  FieldCreateType:
-    enum:
-      - PlainText
-      - RichText
-      - Image
-      - MultiImage
-      - Video
-      - Link
-      - Email
-      - Phone
-      - Number
-      - DateTime
-      - Switch
-      - Color
-      - File
-    docs: Choose these appropriate field type for your collection data
-    source:
-      openapi: ../../../referenced-specs/v2.yml
 imports:
   root: ../__package__.yml
 service:
@@ -28,7 +9,7 @@ service:
       method: POST
       auth: true
       docs: >
-        Create a custom field in a collection. 
+        Create a custom field in a collection.
 
 
         Slugs must be all lowercase letters without spaces.
@@ -38,63 +19,100 @@ service:
 
         convert the slug to lowercase and replace spaces with "-."
 
-
-        Only some field types can be created through the API. 
-
-        This endpoint does not currently support bulk creation. 
+        This endpoint does not currently support bulk creation.
 
 
         Required scope | `cms:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         collection_id:
           type: string
           docs: Unique identifier for a Collection
       display-name: Create Collection Field
       request:
-        name: FieldCreate
-        body:
-          properties:
-            isRequired:
-              type: optional<boolean>
-              docs: define whether a field is required in a collection
-            type:
-              type: FieldCreateType
-              docs: Choose these appropriate field type for your collection data
-            displayName:
-              type: string
-              docs: The name of a field
-            helpText:
-              type: optional<string>
-              docs: Additional text to help anyone filling out this field
+        body: root.FieldCreate
         content-type: application/json
       response:
         docs: Request was successful
-        type: root.Field
+        type: root.FieldCreate
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
         - root.NotFoundError
+        - root.ConflictError
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - path-parameters:
+        - name: StaticField
+          path-parameters:
             collection_id: 580e63fc8c9a982ac9b8b745
           request:
+            id: 562ac0395358780a1f5e6fbc
+            isEditable: true
             isRequired: false
             type: RichText
             displayName: Post Body
             helpText: Add the body of your post here
           response:
             body:
-              id: 75821f618da60c18383330bcc0ca488b
-              isRequired: false
+              id: 562ac0395358780a1f5e6fbc
               isEditable: true
+              isRequired: false
               type: RichText
-              slug: post-body
               displayName: Post Body
               helpText: Add the body of your post here
+        - name: OptionField
+          path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+          request:
+            id: 562ac0395358780a1f5e6fbc
+            isEditable: true
+            isRequired: false
+            type: Option
+            displayName: Post Type
+            helpText: Add the body of your post here
+            metadata:
+              options:
+                - name: Feature
+                - name: News
+                - name: Product Highlight
+          response:
+            body:
+              id: 562ac0395358780a1f5e6fbc
+              isEditable: true
+              isRequired: false
+              type: Option
+              displayName: Post Type
+              helpText: Add the body of your post here
+              metadata:
+                options:
+                  - name: Feature
+                  - name: News
+                  - name: Product Highlight
+        - name: ReferenceField
+          path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+          request:
+            id: 562ac0395358780a1f5e6fbd
+            isEditable: true
+            isRequired: false
+            type: Reference
+            displayName: Author
+            helpText: Add the post author here
+            metadata:
+              collectionId: 63692ab61fb2852f582ba8f5
+          response:
+            body:
+              id: 562ac0395358780a1f5e6fbd
+              isEditable: true
+              isRequired: false
+              type: Reference
+              displayName: Author
+              helpText: Add the post author here
+              metadata:
+                collectionId: 63692ab61fb2852f582ba8f5
     delete:
       path: /collections/{collection_id}/fields/{field_id}
       method: DELETE
@@ -106,7 +124,7 @@ service:
 
         Required scope | `cms:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         collection_id:
           type: string
@@ -134,7 +152,7 @@ service:
 
         Required scope | `cms:write`
       source:
-        openapi: ../../../referenced-specs/v2.yml
+        openapi: ../../../openapi/referenced-specs/v2.yml
       path-parameters:
         collection_id:
           type: string
@@ -160,6 +178,7 @@ service:
       response:
         docs: Request was successful
         type: root.Field
+        status-code: 200
       errors:
         - root.BadRequestError
         - root.UnauthorizedError
@@ -184,4 +203,4 @@ service:
               displayName: Post Body
               helpText: Add the body of your post here
   source:
-    openapi: ../../../referenced-specs/v2.yml
+    openapi: ../../../openapi/referenced-specs/v2.yml