🌿 Fern Regeneration -- November 19, 2024

.mock/definition/accessGroups.yml

@@ -0,0 +1,125 @@
+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: v2-data.yml
+  AccessGroupsListResponseAccessGroupsItem:
+    properties:
+      id:
+        type: optional<string>
+        docs: Unique identifier for the Access Group
+      name:
+        type: optional<string>
+        docs: Name of the the Access Group
+      shortId:
+        type: optional<string>
+        docs: >-
+          Shortened unique identifier based on name, optimized for its use in
+          the user’s JWT
+      slug:
+        type: optional<string>
+        docs: >-
+          Shortened unique identifier based on name, optimized for human
+          readability and public API use
+      createdOn:
+        type: optional<datetime>
+        docs: The date the Access Group was created
+    source:
+      openapi: v2-data.yml
+  AccessGroupsListResponse:
+    docs: The list access groups results
+    properties:
+      count:
+        type: optional<double>
+        docs: Number of access groups returned
+      limit:
+        type: optional<double>
+        docs: The limit specified in the request
+        default: 10
+      offset:
+        type: optional<double>
+        docs: The offset specified for pagination
+        default: 0
+      total:
+        type: optional<double>
+        docs: Total number of access groups in the collection
+      accessGroups:
+        type: optional<list<AccessGroupsListResponseAccessGroupsItem>>
+        docs: List of Site Access Groups
+    source:
+      openapi: v2-data.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: v2-data.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: AccessGroupsListResponse
+      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: v2-data.yml

.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