webflow-api 3.3.0-beta → 3.3.1

package/.mock/definition/collections.yml

@@ -1,350 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/collections
-      method: GET
-      auth:
-        - OAuth2:
-            - cms:read
-      docs: |
-        List of all Collections within a Site.
-
-        Required scope | `cms:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: List Collections
-      response:
-        docs: Request was successful
-        type: root.CollectionList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          response:
-            body:
-              collections:
-                - id: 63692ab61fb2852f582ba8f5
-                  displayName: Products
-                  singularName: Product
-                  slug: product
-                  createdOn: '2019-06-12T13:35:14Z'
-                  lastUpdated: '2022-11-17T15:08:50Z'
-                - id: 63692ab61fb2856e6a2ba8f6
-                  displayName: Categories
-                  singularName: Category
-                  slug: category
-                  createdOn: '2019-06-12T13:35:14Z'
-                  lastUpdated: '2022-11-17T15:08:50Z'
-                - id: 63692ab61fb285a8562ba8f4
-                  displayName: SKUs
-                  singularName: SKU
-                  slug: sku
-                  createdOn: '2019-06-12T13:35:14Z'
-                  lastUpdated: '2022-11-17T15:08:50Z'
-    create:
-      path: /sites/{site_id}/collections
-      method: POST
-      auth:
-        - OAuth2:
-            - cms:write
-      docs: >
-        Create a Collection for a site with collection fields.
-
-
-        Each collection includes the required _name_ and _slug_ fields, which
-        are generated automatically. You can update the `displayName` of these
-        fields, but the slug for them cannot be changed. Fields slugs are
-        automatically converted to lowercase. Spaces in slugs are replaced with
-        hyphens.
-
-
-        Required scope | `cms:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Create Collection
-      request:
-        name: CollectionsCreateRequest
-        body:
-          properties:
-            displayName:
-              type: string
-              docs: Name of the collection. Each collection name must be distinct.
-            singularName:
-              type: string
-              docs: Singular name of each item.
-            slug:
-              type: optional<string>
-              docs: Part of a URL that identifier
-            fields:
-              type: optional<list<root.FieldCreate>>
-              docs: An array of custom fields to add to the collection
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.Collection
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.ConflictError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            displayName: Blog Posts
-            singularName: Blog Post
-            slug: posts
-            fields:
-              - isRequired: true
-                type: PlainText
-                displayName: Title
-                helpText: The title of the blog post
-              - isRequired: true
-                type: RichText
-                displayName: Content
-                helpText: The content of the blog post
-              - isRequired: true
-                type: Reference
-                displayName: Author
-                helpText: The author of the blog post
-                metadata:
-                  collectionId: 23cc2d952d4e4631ffd4345d2743db4e
-          response:
-            body:
-              id: 562ac0395358780a1f5e6fbd
-              displayName: Blog Posts
-              singularName: Blog Post
-              slug: posts
-              createdOn: '2016-10-24T19:41:48Z'
-              lastUpdated: '2016-10-24T19:42:38Z'
-              fields:
-                - id: id
-                  isRequired: true
-                  isEditable: true
-                  type: PlainText
-                  slug: title
-                  displayName: Title
-                  helpText: The title of the blog post
-                - id: id
-                  isRequired: true
-                  isEditable: true
-                  type: RichText
-                  slug: content
-                  displayName: Content
-                  helpText: The content of the blog post
-                - id: id
-                  isRequired: true
-                  isEditable: true
-                  type: Reference
-                  slug: author
-                  displayName: Author
-                  helpText: The author of the blog post
-    get:
-      path: /collections/{collection_id}
-      method: GET
-      auth:
-        - OAuth2:
-            - cms:read
-      docs: |
-        Get the full details of a collection from its ID.
-
-        Required scope | `cms:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        collection_id:
-          type: string
-          docs: Unique identifier for a Collection
-      display-name: Get Collection Details
-      response:
-        docs: Request was successful
-        type: root.Collection
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            collection_id: 580e63fc8c9a982ac9b8b745
-          response:
-            body:
-              id: 7f15043107e2fc95644e93807ee25dd6
-              displayName: Guide Entries
-              singularName: Guide Entry
-              slug: guide-entry
-              createdOn: '2024-04-12T12:42:00Z'
-              lastUpdated: '2024-04-12T12:42:00Z'
-              fields:
-                - id: 5e2a1b3c4d5e6f7890a1b2c3
-                  isRequired: true
-                  isEditable: true
-                  type: PlainText
-                  slug: name
-                  displayName: Entry Title
-                  helpText: Name of the entry.
-                - id: 5e2a1b3c4d5e6f7890a1b2c4
-                  isRequired: true
-                  isEditable: true
-                  type: PlainText
-                  slug: slug
-                  displayName: Slug
-                  helpText: Slug of the entry.
-                - id: 6f7e8d9c0b1a2e3d4c5b6a7f
-                  isRequired: false
-                  isEditable: true
-                  type: PlainText
-                  slug: summary
-                  displayName: Summary
-                  helpText: A short summary of the entry.
-                - id: 1a2b3c4d5e6f7a8b9c0d1e2f
-                  isRequired: false
-                  isEditable: true
-                  type: RichText
-                  slug: entry-html
-                  displayName: Entry HTML
-                  helpText: The HTML content of the entry.
-                - id: 7e8d9c0b1a2e3d4c5b6a7f8e
-                  isRequired: false
-                  isEditable: true
-                  type: Image
-                  slug: illustration-image
-                  displayName: Illustration Image
-                  helpText: An image of the entry.
-                - id: 2f3e4d5c6b7a8e9d0c1b2a3f
-                  isRequired: false
-                  isEditable: true
-                  type: VideoLink
-                  slug: demonstration-video
-                  displayName: Demonstration Video
-                  helpText: A video of the entry.
-                - id: 8e9d0c1b2a3f4e5d6c7b8a9e
-                  isRequired: false
-                  isEditable: true
-                  type: Link
-                  slug: more-info-link
-                  displayName: More Info Link
-                  helpText: A link to more information about the entry.
-                - id: 3f4e5d6c7b8a9e0d1c2b3a4f
-                  isRequired: false
-                  isEditable: true
-                  type: Number
-                  slug: importance-level
-                  displayName: Importance Level
-                  helpText: The importance level of the entry.
-                - id: 9e0d1c2b3a4f5e6d7c8b9a0e
-                  isRequired: false
-                  isEditable: true
-                  type: Switch
-                  slug: is-essential
-                  displayName: Is Essential
-                  helpText: Is this entry essential?
-                - id: 4f5e6d7c8b9a0e1d2c3b4a5f
-                  isRequired: false
-                  isEditable: true
-                  type: Color
-                  slug: first-mentioned
-                  displayName: First Mentioned
-                  helpText: Date of the first mention of the subject.
-                - id: 0e1d2c3b4a5f6e7d8c9b0a1e
-                  isRequired: false
-                  isEditable: true
-                  type: Color
-                  slug: towel-color
-                  displayName: Towel Color
-                  helpText: The color of the towel.
-                - id: 5f6e7d8c9b0a1e2d3c4b5a6f
-                  isRequired: false
-                  isEditable: true
-                  type: Reference
-                  slug: related-entry
-                  displayName: Related Entry
-                  helpText: A related entry.
-                - id: 1e2d3c4b5a6f7e8d9c0b1a2f
-                  isRequired: false
-                  isEditable: true
-                  type: MultiReference
-                  slug: mentioned-in-entries
-                  displayName: Mentioned In Entries
-                  helpText: Entries that mention this subject.
-                - id: 6f7e8d9c0b1a2e3d4c5b6a8f
-                  isRequired: false
-                  isEditable: true
-                  type: Option
-                  slug: item-type
-                  displayName: Item Type
-                  helpText: The type of item.
-                - id: 2e3d4c5b6a7f8e9d0c1b2a4f
-                  isRequired: false
-                  isEditable: true
-                  type: File
-                  slug: guide-file
-                  displayName: Guide File
-                  helpText: helpText
-                - id: 7f8e9d0c1b2a3f4e5d6c8b9e
-                  isRequired: false
-                  isEditable: true
-                  type: Email
-                  slug: contributor-email
-                  displayName: Contributor Email
-                  helpText: helpText
-                - id: 3a4f5e6d7c8b9a0e1d2c4b5f
-                  isRequired: false
-                  isEditable: true
-                  type: Phone
-                  slug: emergency-contact
-                  displayName: Emergency Contact
-                  helpText: helpText
-    delete:
-      path: /collections/{collection_id}
-      method: DELETE
-      auth:
-        - OAuth2:
-            - cms:write
-      docs: |
-        Delete a collection using its ID.
-
-        Required scope | `cms:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        collection_id:
-          type: string
-          docs: Unique identifier for a Collection
-      display-name: Delete Collection
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            collection_id: 580e63fc8c9a982ac9b8b745
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml
-  display-name: Collections
-docs: Collections are CMS collections of items.

package/.mock/definition/comments.yml

@@ -1,41 +0,0 @@
-imports:
-  root: __package__.yml
-webhooks:
-  comment_created:
-    audiences: []
-    method: POST
-    display-name: New Comment Thread
-    headers: {}
-    payload: root.Comment
-    examples:
-      - payload:
-          triggerType: comment_created
-          payload:
-            threadId: 679d2ddb5196117ad04d1ffa
-            commentId: 679d2ddb5196117ad04d1ff8
-            type: new_comment
-            siteId: 679826b3b20b045e176bc4b5
-            pageId: 679826b3b20b045e176bc4bc
-            localeId: 67993753d910db250db64b3e
-            itemId: 580e64008c9a982ac9b8b754
-            breakpoint: main
-            url: >-
-              https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ffa&pageId=679826b3b20b045e176bc4bc
-            content: 'This comment mentions another user [[6287ec36a841b25637c663df]] '
-            isResolved: false
-            author:
-              userId: 6287ec36a841b25637c663df
-              email: ford.prefect@heartofgold.spaceship
-              name: Ford Prefect
-            mentionedUsers:
-              - userId: 6287ec36a841b25637c663df
-                email: arthur.dent@heartofgold.spaceship
-                name: Arthur Dent
-            createdOn: '2025-01-31T20:08:59.759Z'
-            lastUpdated: '2025-01-31T20:08:59.759Z'
-    docs: |
-      Information about a new comment thread or reply
-
-      <Note title="Timing of comment webhooks">
-        There may be a delay of up to 5 minutes before new comments appear in the system and trigger the webhook notification.
-      </Note>