webflow-api 3.3.0-beta → 3.3.1

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

@@ -1,229 +0,0 @@
-imports:
-  root: ../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    get:
-      path: /sites/{site_id}/robots_txt
-      method: GET
-      auth:
-        - OAuth2:
-            - site_config:read
-      docs: >
-        Retrieve the robots.txt configuration for various user agents.
-
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope: `site_config:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Get robots.txt
-      response:
-        docs: Request was successful
-        type: root.Robots
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          response:
-            body:
-              rules:
-                - userAgent: googlebot
-                  allows:
-                    - /public
-                  disallows:
-                    - /vogon-poetry
-                    - /total-perspective-vortex
-              sitemap: https://heartofgold.ship/sitemap.xml
-    put:
-      path: /sites/{site_id}/robots_txt
-      method: PUT
-      auth:
-        - OAuth2:
-            - site_config:write
-      docs: >
-        Replace the `robots.txt` configuration for various user agents.
-
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope | `site_config:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Replace robots.txt
-      request:
-        body: root.Robots
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.Robots
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            rules:
-              - userAgent: googlebot
-                allows:
-                  - /public
-                disallows:
-                  - /vogon-poetry
-                  - /total-perspective-vortex
-            sitemap: https://heartofgold.ship/sitemap.xml
-          response:
-            body:
-              rules:
-                - userAgent: googlebot
-                  allows:
-                    - /public
-                  disallows:
-                    - /vogon-poetry
-                    - /total-perspective-vortex
-              sitemap: https://heartofgold.ship/sitemap.xml
-    delete:
-      path: /sites/{site_id}/robots_txt
-      method: DELETE
-      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
-        remove the user-agent's entry entirely, leaving it subject to your
-        site's default crawling behavior.
-
-
-        **Note:** Deleting a user-agent with no rules will make the user-agent's
-        access unrestricted unless other directives apply.
-
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope: `site_config:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Delete robots.txt
-      request:
-        body: root.Robots
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.Robots
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            rules:
-              - userAgent: '*'
-                allows:
-                  - /public
-                disallows:
-                  - /bubbles
-          response:
-            body:
-              rules:
-                - userAgent: googlebot
-                  allows:
-                    - /public
-                  disallows:
-                    - /vogon-poetry
-                    - /total-perspective-vortex
-              sitemap: https://heartofgold.ship/sitemap.xml
-    patch:
-      path: /sites/{site_id}/robots_txt
-      method: PATCH
-      auth:
-        - OAuth2:
-            - site_config:write
-      docs: >
-        Update the `robots.txt` configuration for various user agents.
-
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope | `site_config:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Update robots.txt
-      request:
-        body: root.Robots
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.Robots
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            rules:
-              - userAgent: googlebot
-                allows:
-                  - /public
-                disallows:
-                  - /vogon-poetry
-                  - /total-perspective-vortex
-            sitemap: https://heartofgold.ship/sitemap.xml
-          response:
-            body:
-              rules:
-                - userAgent: googlebot
-                  allows:
-                    - /public
-                  disallows:
-                    - /vogon-poetry
-                    - /total-perspective-vortex
-              sitemap: https://heartofgold.ship/sitemap.xml
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -1,243 +0,0 @@
-imports:
-  root: ../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    get-custom-code:
-      path: /sites/{site_id}/custom_code
-      method: GET
-      auth:
-        - OAuth2:
-            - custom_code:read
-      docs: |
-        Get all scripts applied to a site by the App. 
-
-        <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:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Get Custom Code
-      response:
-        docs: Request was successful
-        type: root.ScriptApplyList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          response:
-            body:
-              scripts:
-                - id: cms_slider
-                  location: header
-                  version: 1.0.0
-                  attributes:
-                    my-attribute: some-value
-                - id: alert
-                  location: header
-                  version: 0.0.1
-                  attributes:
-                    key: value
-              lastUpdated: '2022-10-26T00:28:54.191Z'
-              createdOn: '2022-10-26T00:28:54.191Z'
-    upsert-custom-code:
-      path: /sites/{site_id}/custom_code
-      method: PUT
-      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
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Add/Update Custom Code
-      request:
-        body: root.ScriptApplyList
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.ScriptApplyList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            scripts:
-              - id: cms_slider
-                location: header
-                version: 1.0.0
-                attributes:
-                  my-attribute: some-value
-              - id: alert
-                location: header
-                version: 0.0.1
-          response:
-            body:
-              scripts:
-                - id: cms_slider
-                  location: header
-                  version: 1.0.0
-                  attributes:
-                    my-attribute: some-value
-                - id: alert
-                  location: header
-                  version: 0.0.1
-                  attributes:
-                    key: value
-              lastUpdated: lastUpdated
-              createdOn: createdOn
-    delete-custom-code:
-      path: /sites/{site_id}/custom_code
-      method: DELETE
-      auth:
-        - OAuth2:
-            - custom_code:write
-      docs: >
-        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`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Delete Custom Code
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-    list-custom-code-blocks:
-      path: /sites/{site_id}/custom_code/blocks
-      method: GET
-      auth:
-        - OAuth2:
-            - custom_code:read
-      docs: >
-        Get a list of scripts that have been applied to a site and/or individual
-        pages. 
-
-
-        <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:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: List Custom Code Blocks
-      request:
-        name: ScriptsListCustomCodeBlocksRequest
-        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.ListCustomCodeBlocks
-        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:
-              blocks:
-                - siteId: 6258612d1ee792848f805dcf
-                  pageId: pageId
-                  type: site
-                  scripts:
-                    - id: chartjs
-                      location: header
-                      version: 4.4.2
-                      attributes:
-                        key: value
-                  createdOn: '2024-04-03T16:49:15Z'
-                  lastUpdated: '2024-04-03T16:49:15Z'
-                - siteId: 6390c49674a71f84b51a08d8
-                  pageId: 6419db964a9c43f6a3af6348
-                  type: page
-                  scripts:
-                    - id: id
-                      location: header
-                      version: version
-                  createdOn: '2022-10-26T00:28:54Z'
-                  lastUpdated: '2022-10-26T00:28:54Z'
-              pagination:
-                limit: 10
-                offset: 0
-                total: 1
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml

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

@@ -1,130 +0,0 @@
-types:
-  WellKnownFileContentType:
-    enum:
-      - value: application/json
-        name: ApplicationJson
-      - value: text/plain
-        name: TextPlain
-    docs: The content type of the file. Defaults to application/json
-    default: application/json
-    inline: true
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-imports:
-  root: ../__package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    put:
-      path: /sites/{site_id}/well_known
-      method: PUT
-      auth:
-        - OAuth2:
-            - site_config:write
-      docs: >
-        Upload a supported well-known file to a site.
-
-
-        The current restrictions on well-known files are as follows:
-          - Each file must be smaller than 100kb
-          - Less than 30 total files
-          - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` 
-          
-          <Note title=".noext">
-            `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
-          </Note>
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope: `site_config:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Set a well-known file
-      request:
-        name: WellKnownFile
-        body:
-          properties:
-            fileName:
-              type: string
-              docs: The name of the file
-            fileData:
-              type: string
-              docs: The contents of the file
-            contentType:
-              type: optional<WellKnownFileContentType>
-              docs: The content type of the file. Defaults to application/json
-              default: application/json
-        content-type: application/json
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            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:
-        - OAuth2:
-            - site_config:write
-      docs: >
-        Delete existing well-known files from a site.
-
-
-        <Warning title="Enterprise Only">This endpoint requires an Enterprise
-        workspace.</Warning>
-
-
-        Required scope: `site_config:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Delete a well-known file
-      request:
-        name: WellKnownDeleteRequest
-        body:
-          properties:
-            fileNames:
-              type: optional<list<string>>
-              docs: A list of file names to delete
-        content-type: application/json
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request: {}
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml