webflow-api 3.2.0 → 3.3.0-beta

package/.mock/definition/sites/forms.yml

@@ -0,0 +1,316 @@
+imports:
+  root: ../__package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list-submissions-by-site:
+      path: /sites/{site_id}/form_submissions
+      method: GET
+      auth:
+        - OAuth2:
+            - forms:read
+      docs: >
+        List all form submissions for a given site with the ability to filter
+        submissions by a centralized `elementId`.
+
+
+        Add `elementId` when you want to filter form submissions to a specific
+        form in a site. You can get the `elementId` from the [List forms
+        endpoint](/data/reference/forms/forms/list) (displayed as
+        `formElementId` in the response). 
+
+
+        <Note title="Forms in components">
+
+        When a form is used in a Webflow component definition, each instance of
+        the component will yield a unique form. Adding the `elementId` in this
+        request ensures this API response includes all submissions from that
+        core form, wherever that form is used in instantiated components.
+
+        </Note>
+
+
+        Use the [List Form Submissions
+        endpoint](/data/reference/forms/form-submissions/list-submissions) to
+        list form submissions for a given form ID.
+
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+      display-name: List Form Submissions by Site
+      request:
+        name: FormsListSubmissionsBySiteRequest
+        query-parameters:
+          elementId:
+            type: optional<string>
+            docs: Identifier for an element
+          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.FormSubmissionList
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            elementId: 18259716-3e5a-646a-5f41-5dc4b9405aa0
+            offset: 1.1
+            limit: 1.1
+          response:
+            body:
+              formSubmissions:
+                - id: 6321ca84df3949bfc6752327
+                  displayName: Sample Form
+                  siteId: 62749158efef318abc8d5a0f
+                  workspaceId: 62749158efef318abc8d5a0f
+                  dateSubmitted: '2022-09-14T12:35:16Z'
+                  formResponse:
+                    First Name: Arthur
+                    Last Name: Dent
+                - id: 660d64fabf6e0a0d4edab981
+                  displayName: Sample Form
+                  siteId: 62749158efef318abc8d5a0f
+                  workspaceId: 62749158efef318abc8d5a0f
+                  dateSubmitted: '2022-09-14T12:35:16Z'
+                  formResponse:
+                    First Name: Ford
+                    Last Name: Prefect
+              pagination:
+                limit: 25
+                offset: 0
+                total: 2
+    list-submissions:
+      path: /sites/{site_id}/forms/{form_id}/submissions
+      method: GET
+      auth:
+        - OAuth2:
+            - forms:read
+      docs: >
+        List form submissions for a given form ID within a specific site. 
+
+
+        Use the [List Form Submissions by Site
+        endpoint](/data/reference/forms/form-submissions/list-submissions-by-site)
+        to list form submissions for a given site with the ability to filter by
+        a `formElementId`.
+
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        form_id:
+          type: string
+          docs: Unique identifier for a Form
+      display-name: List Form Submissions
+      request:
+        name: FormsListSubmissionsRequest
+        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.FormSubmissionList
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            form_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
+          response:
+            body:
+              formSubmissions:
+                - id: 6321ca84df3949bfc6752327
+                  displayName: Sample Form
+                  siteId: 62749158efef318abc8d5a0f
+                  workspaceId: 62749158efef318abc8d5a0f
+                  dateSubmitted: '2022-09-14T12:35:16Z'
+                  formResponse:
+                    First Name: Arthur
+                    Last Name: Dent
+                - id: 660d64fabf6e0a0d4edab981
+                  displayName: Sample Form
+                  siteId: 62749158efef318abc8d5a0f
+                  workspaceId: 62749158efef318abc8d5a0f
+                  dateSubmitted: '2022-09-14T12:35:16Z'
+                  formResponse:
+                    First Name: Ford
+                    Last Name: Prefect
+              pagination:
+                limit: 25
+                offset: 0
+                total: 2
+    get-submission:
+      path: /sites/{site_id}/form_submissions/{form_submission_id}
+      method: GET
+      auth:
+        - OAuth2:
+            - forms:read
+      docs: |
+        Get information about a form submission within a specific site.
+
+        Required scope | `forms:read`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        form_submission_id:
+          type: string
+          docs: Unique identifier for a Form Submission
+      display-name: Get Form Submission by Site
+      response:
+        docs: Request was successful
+        type: root.FormSubmission
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            form_submission_id: 580e63e98c9a982ac9b8b741
+          response:
+            body:
+              id: 6321ca84df3949bfc6752327
+              displayName: Sample Form
+              siteId: 62749158efef318abc8d5a0f
+              workspaceId: 62749158efef318abc8d5a0f
+              dateSubmitted: '2022-09-14T12:35:16Z'
+              formResponse:
+                First Name: Arthur
+                Last Name: Dent
+    delete-submission:
+      path: /sites/{site_id}/form_submissions/{form_submission_id}
+      method: DELETE
+      auth:
+        - OAuth2:
+            - forms:write
+      docs: |
+        Delete a form submission within a specific site.
+
+        Required scope | `forms:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        form_submission_id:
+          type: string
+          docs: Unique identifier for a Form Submission
+      display-name: Delete Form Submission by Site
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            form_submission_id: 580e63e98c9a982ac9b8b741
+    update-submission:
+      path: /sites/{site_id}/form_submissions/{form_submission_id}
+      method: PATCH
+      auth:
+        - OAuth2:
+            - forms:write
+      docs: |
+        Update hidden fields on a form submission within a specific site.
+
+        Required scope | `forms:write`
+      source:
+        openapi: ../../../openapi/referenced-specs/v2.yml
+      path-parameters:
+        site_id:
+          type: string
+          docs: Unique identifier for a Site
+        form_submission_id:
+          type: string
+          docs: Unique identifier for a Form Submission
+      display-name: Modify Form Submission by Site
+      request:
+        name: FormsUpdateSubmissionRequest
+        body:
+          properties:
+            formSubmissionData:
+              type: optional<map<string, unknown>>
+              docs: >-
+                An existing **hidden field** defined on the form schema, and the
+                corresponding value to set
+        content-type: application/json
+      response:
+        docs: Request was successful
+        type: root.FormSubmission
+        status-code: 200
+      errors:
+        - root.BadRequestError
+        - root.UnauthorizedError
+        - root.ForbiddenError
+        - root.NotFoundError
+        - root.ConflictError
+        - root.TooManyRequestsError
+        - root.InternalServerError
+      examples:
+        - path-parameters:
+            site_id: 580e63e98c9a982ac9b8b741
+            form_submission_id: 580e63e98c9a982ac9b8b741
+          request: {}
+          response:
+            body:
+              id: 6321ca84df3949bfc6752327
+              displayName: Sample Form
+              siteId: 62749158efef318abc8d5a0f
+              workspaceId: 62749158efef318abc8d5a0f
+              dateSubmitted: '2022-09-14T12:35:16Z'
+              formResponse:
+                First Name: Arthur
+                Last Name: Dent
+  source:
+    openapi: ../../../openapi/referenced-specs/v2.yml

package/.mock/definition/sites/plans.yml

@@ -7,7 +7,9 @@ service:
     get-site-plan:
       path: /sites/{site_id}/plan
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: >
         Get site plan details for the specified Site.
 

package/.mock/definition/sites/redirects.yml

@@ -7,7 +7,9 @@ service:
     list:
       path: /sites/{site_id}/redirects
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: >
         Fetch a list of all 301 redirect rules configured for a specific site.
 
@@ -57,7 +59,9 @@ service:
     create:
       path: /sites/{site_id}/redirects
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Add a new 301 redirection rule to a site.
 
@@ -108,7 +112,9 @@ service:
     delete:
       path: /sites/{site_id}/redirects/{redirect_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Remove a 301 redirection rule from a site.
 
@@ -163,7 +169,9 @@ service:
     update:
       path: /sites/{site_id}/redirects/{redirect_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Update a 301 redirection rule from a site.
 

package/.mock/definition/sites/robotsTxt.yml

@@ -7,7 +7,9 @@ service:
     get:
       path: /sites/{site_id}/robots_txt
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:read
       docs: >
         Retrieve the robots.txt configuration for various user agents.
 
@@ -50,7 +52,9 @@ service:
     put:
       path: /sites/{site_id}/robots_txt
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Replace the `robots.txt` configuration for various user agents.
 
@@ -105,7 +109,9 @@ service:
     delete:
       path: /sites/{site_id}/robots_txt
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Remove specific rules for a user-agent in your `robots.txt` file. To
         delete all rules for a user-agent, provide an empty rule set. This will
@@ -165,7 +171,9 @@ service:
     patch:
       path: /sites/{site_id}/robots_txt
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Update the `robots.txt` configuration for various user agents.
 

package/.mock/definition/sites/scripts.yml

@@ -7,7 +7,9 @@ service:
     get-custom-code:
       path: /sites/{site_id}/custom_code
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: |
         Get all scripts applied to a site by the App. 
 
@@ -54,14 +56,22 @@ service:
     upsert-custom-code:
       path: /sites/{site_id}/custom_code
       method: PUT
-      auth: true
-      docs: |
-        Apply registered scripts to a site.
+      auth:
+        - OAuth2:
+            - custom_code:write
+      docs: >
+        Apply registered scripts to a site. If you have multiple scripts your
+        App needs to apply or maintain on a site, ensure they are always
+        included in the request body for this endpoint. To remove individual
+        scripts, simply call this endpoint without the script in the request
+        body.
+
 
         <Note title="Script Registration">
           To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
         </Note>
 
+
         Required scope | `custom_code:write`
       source:
         openapi: ../../../openapi/referenced-specs/v2.yml
@@ -114,10 +124,22 @@ service:
     delete-custom-code:
       path: /sites/{site_id}/custom_code
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:write
       docs: >
-        Remove scripts from a site applied by the App. This endpoint will not
-        remove scripts from the site's registered scripts.
+        Remove all scripts from a site applied by the App. This endpoint will
+        not remove scripts from the site's registered scripts.
+
+
+        To remove individual scripts applied by the App, use the [Add/Update
+        Custom
+        Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code)
+        endpoint.
+
+
+        <Note>Access to this endpoint requires a bearer token obtained from an
+        [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>
 
 
         Required scope | `custom_code:write`
@@ -140,7 +162,9 @@ service:
     list-custom-code-blocks:
       path: /sites/{site_id}/custom_code/blocks
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - custom_code:read
       docs: >
         Get a list of scripts that have been applied to a site and/or individual
         pages. 
@@ -185,10 +209,14 @@ service:
       examples:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
+          query-parameters:
+            offset: 1.1
+            limit: 1.1
           response:
             body:
               blocks:
                 - siteId: 6258612d1ee792848f805dcf
+                  pageId: pageId
                   type: site
                   scripts:
                     - id: chartjs

package/.mock/definition/sites/wellKnown.yml

@@ -19,7 +19,9 @@ service:
     put:
       path: /sites/{site_id}/well_known
       method: PUT
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Upload a supported well-known file to a site.
 
@@ -70,12 +72,26 @@ service:
         - path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
           request:
-            fileName: fileName
-            fileData: fileData
+            fileName: apple-app-site-association.txt
+            fileData: |
+              {
+                "applinks": {
+                  "apps": [],
+                  "details": [
+                {
+                  "appID": "ABCDE12345.com.example.app",
+                  "paths": [ "/*", "/some/path/*" ]
+                    }
+                  ]
+                }
+              }
+            contentType: application/json
     delete:
       path: /sites/{site_id}/well_known
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - site_config:write
       docs: >
         Delete existing well-known files from a site.
 

package/.mock/definition/sites.yml

@@ -7,7 +7,9 @@ service:
     create:
       path: /workspaces/{workspace_id}/sites
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Create a site. 
 
@@ -62,18 +64,42 @@ service:
               createdOn: '2024-10-15T20:24:38Z'
               displayName: The Hitchiker's Guide
               shortName: hitchikers-guide
+              lastPublished: '2016-10-24T19:43:17Z'
               lastUpdated: '2024-10-15T20:24:38Z'
+              previewUrl: >-
+                https://dev-assets.website-files.com/580e63e98c9a982ac9b8b741/201610241243.png
+              timeZone: America/Los_Angeles
               parentFolderId: 670ece123598db72d9648be1
               customDomains:
                 - id: 589a331aa51e760df7ccb89d
                   url: test-api-domain.com
                   lastPublished: '2022-12-07T16:51:37Z'
+              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
     list:
       path: /sites
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: |
         List of all sites the provided access token is able to access.
 
@@ -144,6 +170,7 @@ service:
                   previewUrl: >-
                     https://dev-assets.website-files.com/42e63e98c9a982ac9b8b742/198110121200.png
                   timeZone: DeepSpace/Depression
+                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
                   customDomains:
                     - id: 589a331aa51e760df7ccb89f
                       url: marvin.blog
@@ -177,6 +204,7 @@ service:
                   previewUrl: >-
                     https://dev-assets.website-files.com/42e63e98c9a982ac9b8b743/198210121200.png
                   timeZone: Vogsphere/PoetryHall
+                  parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6
                   customDomains:
                     - id: 589a331aa51e760df7ccb8a0
                       url: vogonpoetry.galaxy
@@ -203,7 +231,9 @@ service:
     get:
       path: /sites/{site_id}
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: |
         Get details of a site.
 
@@ -226,7 +256,8 @@ service:
         - root.TooManyRequestsError
         - root.InternalServerError
       examples:
-        - path-parameters:
+        - name: SiteWithLocales
+          path-parameters:
             site_id: 580e63e98c9a982ac9b8b741
           response:
             body:
@@ -271,7 +302,9 @@ service:
     delete:
       path: /sites/{site_id}
       method: DELETE
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Delete a site. 
 
@@ -301,7 +334,9 @@ service:
     update:
       path: /sites/{site_id}
       method: PATCH
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Update a site. 
 
@@ -387,7 +422,9 @@ service:
     get-custom-domain:
       path: /sites/{site_id}/custom_domains
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:read
       docs: |
         Get a list of all custom domains related to site.
 
@@ -424,7 +461,9 @@ service:
     publish:
       path: /sites/{site_id}/publish
       method: POST
-      auth: true
+      auth:
+        - OAuth2:
+            - sites:write
       docs: >
         Publishes a site to one or more more domains. 
 

package/.mock/definition/token.yml

@@ -7,7 +7,9 @@ service:
     authorized-by:
       path: /token/authorized_by
       method: GET
-      auth: true
+      auth:
+        - OAuth2:
+            - authorized_user:read
       docs: |
         Information about the Authorized User
 
@@ -32,7 +34,6 @@ service:
     introspect:
       path: /token/introspect
       method: GET
-      auth: true
       docs: >
         Information about the authorization token