webflow-api 2.4.0 → 2.5.0

package/.mock/definition/accessGroups.yml

@@ -0,0 +1,80 @@
+types:
+  AccessGroupsListRequestSort:
+    enum:
+      - value: CreatedOn
+        name: CreatedOnAscending
+        docs: Sorts users in ascending order based on their created date
+      - value: '-CreatedOn'
+        name: CreatedOnDescending
+        docs: Sorts users in descending order based on their created date
+    source:
+      openapi: ../../../referenced-specs/v2.yml
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/accessgroups
+      method: GET
+      auth: true
+      docs: |
+        Get a list of access groups for a site
+
+        Required scope | `users:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Access Groups
+      request:
+        name: AccessGroupsListRequest
+        query-parameters:
+          offset:
+            type: optional<double>
+            docs: >-
+              Offset used for pagination if the results have more than limit
+              records
+          limit:
+            type: optional<double>
+            docs: 'Maximum number of records to be returned (max limit: 100)'
+          sort:
+            type: optional<AccessGroupsListRequestSort>
+            docs: |
+              Sort string to use when ordering access groups
+              Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
+      response:
+        docs: Request was successful
+        type: root.AccessGroupList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              count: 1
+              limit: 10
+              offset: 0
+              total: 1
+              accessGroups:
+                - id: 62be58d404be8a6cc900c081
+                  name: Research Team
+                  shortId: rt
+                  slug: hitchhikers-guide-research-team
+                  createdOn: '2022-08-01T19:41:48Z'
+                - id: 65a96161991e77bbb4a6c573
+                  name: Admin
+                  shortId: ad
+                  slug: admin
+                  createdOn: '2022-08-01T19:41:48Z'
+  source:
+    openapi: ../../../referenced-specs/v2.yml

package/.mock/definition/api.yml

@@ -0,0 +1,13 @@
+name: api
+error-discrimination:
+  strategy: status-code
+display-name: Data API
+environments:
+  Default: https://api.webflow.com/v2
+default-environment: Default
+auth-schemes:
+  BearerToken:
+    scheme: bearer
+    token:
+      name: accessToken
+auth: BearerToken

package/.mock/definition/assets.yml

@@ -0,0 +1,414 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites/{site_id}/assets
+      method: GET
+      auth: true
+      docs: |
+        List assets for a given site
+
+        Required scope | `assets:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Assets
+      response:
+        docs: Request was successful
+        type: root.Assets
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              assets:
+                - id: 63e5889e7fe4eafa7384cea4
+                  contentType: image/png
+                  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: >-
+                        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 red chair
+    create:
+      path: /sites/{site_id}/assets
+      method: POST
+      auth: true
+      docs: >
+        Create a new asset entry. 
+
+
+
+        This endpoint generates a response with the following information:
+        `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`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create Asset Metadata
+      request:
+        name: AssetsCreateRequest
+        body:
+          properties:
+            fileName:
+              type: string
+              docs: >-
+                File name including file extension. File names must be less than
+                100 characters.
+            fileHash:
+              type: string
+              docs: MD5 hash of the file
+            parentFolder:
+              type: optional<string>
+              docs: ID of the Asset folder (optional)
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.AssetUpload
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            fileName: file.png
+            fileHash: 3c7d87c9575702bc3b1e991f4d3c638e
+          response:
+            body:
+              uploadDetails:
+                acl: public-read
+                bucket: webflow-bucket-name
+                X-Amz-Algorithm: AWS4-HMAC-SHA256
+                X-Amz-Credential: <credential-key>/<date>/<region-zone>/s3/aws4_request
+                X-Amz-Date: <date-in-iso-like-string>
+                key: <siteId>/<fileId>_<filename-with-extension>
+                Policy: <a-very-long-alphanumeric-token-with-equal-sign-at-the-end>
+                X-Amz-Signature: <one-line-ling-alphanumeric-signature>
+                success_action_status: '201'
+                content-type: image/png
+                Cache-Control: max-age=31536000, must-revalidate
+              contentType: image/png
+              id: 64358b9544249dc43d37d2b7
+              parentFolder: 6436b1ce5281cace05b65aea
+              uploadUrl: >-
+                https://s3.amazonaws.com/webflow-dev-assets/643021114e290e0d3a0602b2/64358b9544249dc43d37d2b7_Screenshot%202023-04-11%20at%209.50.42%20AM.png
+              assetUrl: >-
+                https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d907ab9e91e3e9f56385e_paranoidAndroid-2024.png
+              hostedUrl: >-
+                https://d1otoma47x30pg.cloudfront.net/643021114e290e0d3a0602b2/64358b9544249dc43d37d2b7_Screenshot%202023-04-11%20at%209.50.42%20AM.png
+              originalFileName: file.png
+              createdOn: '2023-04-11T16:32:21Z'
+              lastUpdated: '2023-04-12T20:31:03Z'
+    get:
+      path: /assets/{asset_id}
+      method: GET
+      auth: true
+      docs: |
+        Get an Asset
+
+        Required scope | `assets:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        asset_id:
+          type: string
+          docs: Unique identifier for an Asset on a site
+      display-name: Get Asset
+      response:
+        docs: Request was successful
+        type: root.Asset
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            asset_id: 580e63fc8c9a982ac9b8b745
+          response:
+            body:
+              id: 55131cd036c09f7d07883dfc
+              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'
+              variants:
+                - hostedUrl: example.com/hostedimage.png
+                  originalFileName: image.png
+                  displayName: A brown dog
+                  format: format
+                  width: 1500
+                  height: 900
+                  quality: 1
+                  error: error
+              altText: A red chair
+    delete:
+      path: /assets/{asset_id}
+      method: DELETE
+      auth: true
+      docs: |
+        Delete an Asset
+
+        Required Scope: `assets: write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        asset_id:
+          type: string
+          docs: Unique identifier for an Asset on a site
+      display-name: Delete Asset
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            asset_id: 580e63fc8c9a982ac9b8b745
+    update:
+      path: /assets/{asset_id}
+      method: PATCH
+      auth: true
+      docs: |
+        Update an Asset
+
+        Required scope | `assets:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        asset_id:
+          type: string
+          docs: Unique identifier for an Asset on a site
+      display-name: Update Asset
+      request:
+        name: AssetsUpdateRequest
+        body:
+          properties:
+            localeId:
+              type: optional<string>
+              docs: >-
+                Unique identifier for a specific locale. Applicable, when using
+                localization.
+            displayName:
+              type: optional<string>
+              docs: A human readable name for the asset
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Asset
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            asset_id: 580e63fc8c9a982ac9b8b745
+          request: {}
+          response:
+            body:
+              id: 55131cd036c09f7d07883dfc
+              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'
+              variants:
+                - hostedUrl: example.com/hostedimage.png
+                  originalFileName: image.png
+                  displayName: A brown dog
+                  format: format
+                  width: 1500
+                  height: 900
+                  quality: 1
+                  error: error
+              altText: A red chair
+    list-folders:
+      path: /sites/{site_id}/asset_folders
+      method: GET
+      auth: true
+      docs: |
+        List Asset Folders within a given site
+
+        Required scope | `assets:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Asset Folders
+      response:
+        docs: Request was successful
+        type: root.AssetFolderList
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              assetFolders:
+                - id: 6390c49774a71f0e3c1a08ee
+                  displayName: emoji icons
+                  parentFolder: 6390c49774a71f99f21a08eb
+                  assets:
+                    - 63e5889e7fe4eafa7384cea4
+                    - 659595234426a9fcbad57043
+                  siteId: 6390c49674a71f84b51a08d8
+                  createdOn: '2018-10-14T21:55:49Z'
+                  lastUpdated: '2022-12-07T16:51:37Z'
+              pagination:
+                limit: 1
+                offset: 0
+                total: 1
+    create-folder:
+      path: /sites/{site_id}/asset_folders
+      method: POST
+      auth: true
+      docs: |
+        Create an Asset Folder within a given site
+
+        Required scope | `assets:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Create Asset Folder
+      request:
+        name: AssetsCreateFolderRequest
+        body:
+          properties:
+            displayName:
+              type: string
+              docs: A human readable name for the Asset Folder
+            parentFolder:
+              type: optional<string>
+              docs: >-
+                An (optional) pointer to a parent Asset Folder (or null for
+                root)
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.AssetFolder
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request:
+            displayName: my asset folder
+          response:
+            body:
+              id: 6390c49774a71f0e3c1a08ee
+              displayName: emoji icons
+              parentFolder: 6390c49774a71f99f21a08eb
+              assets:
+                - 63e5889e7fe4eafa7384cea4
+                - 659595234426a9fcbad57043
+              siteId: 6390c49674a71f84b51a08d8
+              createdOn: '2018-10-14T21:55:49Z'
+              lastUpdated: '2022-12-07T16:51:37Z'
+    get-folder:
+      path: /asset_folders/{asset_folder_id}
+      method: GET
+      auth: true
+      docs: |
+        Get details about a specific Asset Folder
+
+        Required scope | `assets:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        asset_folder_id:
+          type: string
+          docs: Unique identifier for an Asset Folder
+      display-name: Get Asset Folder
+      response:
+        docs: Request was successful
+        type: root.AssetFolder
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            asset_folder_id: 6390c49774a71f0e3c1a08ee
+          response:
+            body:
+              id: 6390c49774a71f0e3c1a08ee
+              displayName: emoji icons
+              parentFolder: 6390c49774a71f99f21a08eb
+              assets:
+                - 63e5889e7fe4eafa7384cea4
+                - 659595234426a9fcbad57043
+              siteId: 6390c49674a71f84b51a08d8
+              createdOn: '2018-10-14T21:55:49Z'
+              lastUpdated: '2022-12-07T16:51:37Z'
+  source:
+    openapi: ../../../referenced-specs/v2.yml
+  display-name: Assets

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

@@ -0,0 +1,187 @@
+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:
+  auth: false
+  base-path: ''
+  endpoints:
+    create:
+      path: /collections/{collection_id}/fields
+      method: POST
+      auth: true
+      docs: >
+        Create a custom field in a collection. 
+
+
+        Slugs must be all lowercase letters without spaces.
+
+        If you pass a string with uppercase letters and/or spaces to the "Slug"
+        property, Webflow will
+
+        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. 
+
+
+        Required scope | `cms:write`
+      source:
+        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
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Field
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+          request:
+            isRequired: false
+            type: RichText
+            displayName: Post Body
+            helpText: Add the body of your post here
+          response:
+            body:
+              id: 75821f618da60c18383330bcc0ca488b
+              isRequired: false
+              isEditable: true
+              type: RichText
+              slug: post-body
+              displayName: Post Body
+              helpText: Add the body of your post here
+    delete:
+      path: /collections/{collection_id}/fields/{field_id}
+      method: DELETE
+      auth: true
+      docs: >
+        Delete a custom field in a collection. This endpoint does not currently
+        support bulk deletion.
+
+
+        Required scope | `cms:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        collection_id:
+          type: string
+          docs: Unique identifier for a Collection
+        field_id:
+          type: string
+          docs: Unique identifier for a Field in a collection
+      display-name: Delete Collection Field
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+            field_id: 580e63fc8c9a982ac9b8b745
+    update:
+      path: /collections/{collection_id}/fields/{field_id}
+      method: PATCH
+      auth: true
+      docs: |
+        Update a custom field in a collection.
+
+        Required scope | `cms:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        collection_id:
+          type: string
+          docs: Unique identifier for a Collection
+        field_id:
+          type: string
+          docs: Unique identifier for a Field in a collection
+      display-name: Update Collection Field
+      request:
+        name: FieldUpdate
+        body:
+          properties:
+            isRequired:
+              type: optional<boolean>
+              docs: Define whether a field is required in a collection
+            displayName:
+              type: optional<string>
+              docs: The name of a field
+            helpText:
+              type: optional<string>
+              docs: Additional text to help anyone filling out this field
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.Field
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            collection_id: 580e63fc8c9a982ac9b8b745
+            field_id: 580e63fc8c9a982ac9b8b745
+          request:
+            isRequired: false
+            displayName: Post Body
+            helpText: Add the body of your post here
+          response:
+            body:
+              id: 75821f618da60c18383330bcc0ca488b
+              isRequired: false
+              isEditable: true
+              type: RichText
+              slug: post-body
+              displayName: Post Body
+              helpText: Add the body of your post here
+  source:
+    openapi: ../../../referenced-specs/v2.yml