webflow-api 2.4.2 → 2.5.0

package/.mock/definition/sites.yml

@@ -0,0 +1,299 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list:
+      path: /sites
+      method: GET
+      auth: true
+      docs: |
+        List of all sites the provided access token is able to access.
+
+        Required scope | `sites:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      display-name: List Sites
+      response:
+        docs: Request was successful
+        type: root.Sites
+      errors:
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+      examples:
+        - response:
+            body:
+              sites:
+                - id: 42e63e98c9a982ac9b8b741
+                  workspaceId: 42e63fc8c9a982ac9b8b744
+                  createdOn: '1979-10-12T12:00:00Z'
+                  displayName: Heart of Gold Spaceship
+                  shortName: heart-of-gold
+                  lastPublished: '2023-04-02T12:42:00Z'
+                  lastUpdated: '2016-10-24T19:43:17Z'
+                  previewUrl: >-
+                    https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b741/197910121200.png
+                  timeZone: DeepSpace/InfiniteImprobability
+                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
+                  customDomains:
+                    - id: 589a331aa51e760df7ccb89e
+                      url: heartofgold.galaxy
+                  locales:
+                    primary:
+                      id: 653fd9af6a07fc9cfd7a5e57
+                      cmsLocaleId: 653ad57de882f528b32e810e
+                      enabled: true
+                      displayName: English - Heart of Gold Standard
+                      redirect: false
+                      subdirectory: /en
+                      tag: The Ultimate Answer
+                    secondary:
+                      - id: 653fd9af6a07fc9cfd7a5e58
+                        cmsLocaleId: 653ad57de882f528b32e810g
+                        enabled: true
+                        displayName: Betelgeusian - Vogon Liaison
+                        redirect: true
+                        subdirectory: /bet
+                        tag: Vogon
+                      - id: 653fd9af6a07fc9cfd7a5e59
+                        cmsLocaleId: 653ad57de882f528b32e810h
+                        enabled: false
+                        displayName: Magrathean - Custom Planet Designs
+                        redirect: true
+                        subdirectory: /mg
+                        tag: Magrathean
+                  dataCollectionEnabled: true
+                  dataCollectionType: always
+                - id: 42e63e98c9a982ac9b8b742
+                  workspaceId: 42e63fc8c9a982ac9b8b745
+                  createdOn: '1981-10-12T12:00:00Z'
+                  displayName: Marvin's Personal Blog
+                  shortName: paranoid-android
+                  lastPublished: '2023-04-02T12:45:00Z'
+                  lastUpdated: '2016-10-24T19:43:17Z'
+                  previewUrl: >-
+                    https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b742/198110121200.png
+                  timeZone: DeepSpace/Depression
+                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
+                  customDomains:
+                    - id: 589a331aa51e760df7ccb89f
+                      url: marvin.blog
+                  locales:
+                    primary:
+                      id: 653fd9af6a07fc9cfd7a5e57
+                      cmsLocaleId: 653ad57de882f528b32e810e
+                      enabled: true
+                      displayName: English - Marvin's Musings
+                      redirect: false
+                      subdirectory: /en
+                      tag: English
+                    secondary:
+                      - id: 653fd9af6a07fc9cfd7a5e56
+                        cmsLocaleId: 653ad57de882f528b32e810f
+                        enabled: true
+                        displayName: Squornshellous - Mattress Speak
+                        redirect: true
+                        subdirectory: /sr
+                        tag: Squornshellous
+                  dataCollectionEnabled: true
+                  dataCollectionType: always
+                - id: 42e63e98c9a982ac9b8b743
+                  workspaceId: 42e63fc8c9a982ac9b8b746
+                  createdOn: '1982-10-12T12:00:00Z'
+                  displayName: Vogon Poetry Archive
+                  shortName: vogon-poetry
+                  lastPublished: '2023-04-02T12:50:00Z'
+                  lastUpdated: '2016-10-24T19:43:17Z'
+                  previewUrl: >-
+                    https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b743/198210121200.png
+                  timeZone: Vogsphere/PoetryHall
+                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
+                  customDomains:
+                    - id: 589a331aa51e760df7ccb8a0
+                      url: vogonpoetry.galaxy
+                  locales:
+                    primary:
+                      id: 653fd9af6a07fc9cfd7a5e55
+                      cmsLocaleId: 653ad57de882f528b32e810d
+                      enabled: true
+                      displayName: English - Vogon Verse
+                      redirect: false
+                      subdirectory: /en
+                      tag: Third Worst Poetry
+                    secondary:
+                      - id: 653fd9af6a07fc9cfd7a5e54
+                        cmsLocaleId: 653ad57de882f528b32e810c
+                        enabled: true
+                        displayName: Galactic - Universal Language
+                        redirect: true
+                        subdirectory: /gl
+                        tag: Pan-Galactic Gargle Blaster
+                  dataCollectionEnabled: true
+                  dataCollectionType: always
+    get:
+      path: /sites/{site_id}
+      method: GET
+      auth: true
+      docs: |
+        Get details of a site.
+
+        Required scope | `sites:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get Site
+      response:
+        docs: Request was successful
+        type: root.Site
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              id: 42e98c9a982ac9b8b742
+              workspaceId: 42e63e98c9a982ac9b8b742
+              createdOn: '1979-10-12T12:00:00Z'
+              displayName: The Hitchhiker's Guide to the Galaxy
+              shortName: hitchhikers-guide
+              lastPublished: '2023-04-02T12:42:00Z'
+              lastUpdated: '2023-04-02T12:42:00Z'
+              previewUrl: >-
+                https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png
+              timeZone: Magrathea/FactoryFloor
+              parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
+              customDomains:
+                - id: 589a331aa51e760df7ccb89d
+                  url: hitchhikersguide.galaxy
+                - id: 589a331aa51e760df7ccb89e
+                  url: heartofgold.spaceship
+              locales:
+                primary:
+                  id: 653fd9af6a07fc9cfd7a5e57
+                  cmsLocaleId: 653ad57de882f528b32e810e
+                  enabled: false
+                  displayName: English (United States)
+                  displayImageId: displayImageId
+                  redirect: true
+                  subdirectory: ''
+                  tag: en-US
+                secondary:
+                  - id: 653fd9af6a07fc9cfd7a5e57
+                    cmsLocaleId: 653ad57de882f528b32e810e
+                    enabled: false
+                    displayName: English (United States)
+                    redirect: true
+                    subdirectory: ''
+                    tag: en-US
+              dataCollectionEnabled: true
+              dataCollectionType: always
+    get-custom-domain:
+      path: /sites/{site_id}/custom_domains
+      method: GET
+      auth: true
+      docs: |
+        Get a list of all custom domains related to site.
+
+        Required scope | `sites:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Get Custom Domains
+      response:
+        docs: Request was successful
+        type: root.Domains
+      errors:
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              customDomains:
+                - id: 589a331aa51e760df7ccb89d
+                  url: hitchhikersguide.galaxy
+                - id: 589a331aa51e760df7ccb89e
+                  url: heartofgold.spaceship
+    publish:
+      path: /sites/{site_id}/publish
+      method: POST
+      auth: true
+      docs: >
+        Publishes a site to one or more more domains.
+
+
+        <Note title="Endpoint-specific rate limit">This endpoint has a limit of
+        one successful publish queue per minute.</Note>
+
+
+        Required scope | `sites:write`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: Publish Site
+      request:
+        name: SitesPublishRequest
+        body:
+          properties:
+            customDomains:
+              type: optional<list<string>>
+              docs: Array of Custom Domain IDs to publish
+            publishToWebflowSubdomain:
+              type: optional<boolean>
+              docs: Choice of whether to publish to the default Webflow Subdomain
+              default: false
+        content-type: application/json
+      response:
+        docs: Request accepted
+        type: SitesPublishResponse
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          request: {}
+          response:
+            body:
+              customDomains:
+                - id: 589a331aa51e760df7ccb89d
+                  url: test-api-domain.com
+              publishToWebflowSubdomain: true
+  source:
+    openapi: ../../../referenced-specs/v2.yml
+  display-name: Sites
+types:
+  SitesPublishResponse:
+    properties:
+      customDomains:
+        type: optional<list<root.Domain>>
+        docs: Array of domains objects
+      publishToWebflowSubdomain:
+        type: optional<boolean>
+        docs: Flag for publishing to webflow.io subdomain
+        default: false
+    source:
+      openapi: ../../../referenced-specs/v2.yml

package/.mock/definition/token.yml

@@ -0,0 +1,71 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    authorized-by:
+      path: /token/authorized_by
+      method: GET
+      auth: true
+      docs: |
+        Information about the Authorized User
+
+        Required Scope | `authorized_user:read`
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      display-name: Get Authorization User Info
+      response:
+        docs: Request was successful
+        type: root.AuthorizedUser
+      errors:
+        - root.UnauthorizedError
+        - root.ForbiddenError
+      examples:
+        - response:
+            body:
+              id: 545bbecb7bdd6769632504a7
+              email: some@email.com
+              firstName: Some
+              lastName: One
+    introspect:
+      path: /token/introspect
+      method: GET
+      auth: true
+      docs: >
+        Information about the authorization token
+
+        <Note>Access to this endpoint requires a bearer token from a []>Data
+        Client App](/data/docs/getting-started-data-clients).</Note>
+      source:
+        openapi: ../../../referenced-specs/v2.yml
+      display-name: Get Authorization Info
+      response:
+        docs: Request was successful
+        type: root.Authorization
+      errors:
+        - root.UnauthorizedError
+      examples:
+        - response:
+            body:
+              authorization:
+                id: 55818d58616600637b9a5786
+                createdOn: '2016-10-03T23:12:00Z'
+                lastUsed: '2016-10-10T21:41:12Z'
+                grantType: authorization_code
+                rateLimit: 60
+                scope: assets:read,assets:write
+                authorizedTo:
+                  siteIds:
+                    - 62f3b1f7eafac55d0c64ef91
+                  workspaceIds:
+                    - 52f3b1f7eafac55d0c64ef91
+                  userIds:
+                    - 545bbecb7bdd6769632504a7
+              application:
+                id: 55131cd036c09f7d07883dfc
+                description: My Amazing App
+                homepage: https://webflow.com
+                displayName: My Amazing App
+  source:
+    openapi: ../../../referenced-specs/v2.yml