webflow-api 3.3.0-beta → 3.3.1

package/.mock/definition/accessGroups.yml

@@ -1,87 +0,0 @@
-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: ../../../openapi/referenced-specs/v2.yml
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/accessgroups
-      method: GET
-      auth:
-        - OAuth2:
-            - users:read
-      docs: |
-        Get a list of access groups for a site
-
-        Required scope | `users:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            offset: 1.1
-            limit: 1.1
-            sort: CreatedOn
-          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: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/api.yml

@@ -1,18 +0,0 @@
-name: api
-error-discrimination:
-  strategy: status-code
-display-name: Data API
-environments:
-  Data API:
-    urls:
-      Base: https://api.webflow.com/v2
-      Data API: https://api.webflow.com/v2
-      Content Delivery API: https://api-cdn.webflow.com/v2
-default-environment: Data API
-default-url: Base
-auth-schemes:
-  BearerToken:
-    scheme: bearer
-    token:
-      name: accessToken
-auth: BearerToken

package/.mock/definition/assets.yml

@@ -1,487 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/assets
-      method: GET
-      auth:
-        - OAuth2:
-            - assets:read
-      docs: |
-        List of assets uploaded to a site
-
-        Required scope | `assets:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: List Assets
-      request:
-        name: AssetsListRequest
-        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)'
-      response:
-        docs: Request was successful
-        type: root.Assets
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            offset: 1.1
-            limit: 1.1
-          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 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:
-        - OAuth2:
-            - assets:write
-      docs: >
-        The first step in uploading an asset to a site. 
-
-
-
-        This endpoint generates a response with the following information:
-        `uploadUrl` and `uploadDetails`.
-
-
-
-        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: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Upload Asset
-      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
-        status-code: 200
-      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://dev-assets.website-files.com/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:
-        - OAuth2:
-            - assets:read
-      docs: |
-        Get details about an asset
-
-        Required scope | `assets:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            asset_id: 580e63fc8c9a982ac9b8b745
-          response:
-            body:
-              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
-                  error: error
-              altText: A single candy wrapper
-    delete:
-      path: /assets/{asset_id}
-      method: DELETE
-      auth:
-        - OAuth2:
-            - assets:write
-      docs: |
-        Delete an Asset
-
-        Required Scope: `assets: write`
-      source:
-        openapi: ../../../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:
-        - OAuth2:
-            - assets:write
-      docs: |
-        Update details of an Asset.
-
-        Required scope | `assets:write`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            asset_id: 580e63fc8c9a982ac9b8b745
-          request: {}
-          response:
-            body:
-              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
-                  error: error
-              altText: A single candy wrapper
-    list-folders:
-      path: /sites/{site_id}/asset_folders
-      method: GET
-      auth:
-        - OAuth2:
-            - assets:read
-      docs: |
-        List Asset Folders within a given site
-
-        Required scope | `assets:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      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:
-        - OAuth2:
-            - assets:write
-      docs: |
-        Create an Asset Folder within a given site
-
-        Required scope | `assets:write`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      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:
-        - OAuth2:
-            - assets:read
-      docs: |
-        Get details about a specific Asset Folder
-
-        Required scope | `assets:read`
-      source:
-        openapi: ../../../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
-        status-code: 200
-      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: ../../../openapi/referenced-specs/v2.yml
-  display-name: Assets
-docs: Assets are files that are uploaded to your Webflow account.