webflow-api 3.3.0-beta → 3.3.1

package/.mock/definition/pages.yml

@@ -1,611 +0,0 @@
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/pages
-      method: GET
-      auth:
-        - OAuth2:
-            - page:read
-      docs: |
-        List of all pages for a site.
-
-        Required scope | `pages:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: List Pages
-      request:
-        name: PagesListRequest
-        query-parameters:
-          localeId:
-            type: optional<string>
-            docs: >
-              Unique identifier for a specific Locale.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-localization)
-          limit:
-            type: optional<double>
-            docs: 'Maximum number of records to be returned (max limit: 100)'
-          offset:
-            type: optional<double>
-            docs: >-
-              Offset used for pagination if the results have more than limit
-              records
-      response:
-        docs: Request was successful
-        type: root.PageList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
-            limit: 1.1
-            offset: 1.1
-          response:
-            body:
-              pages:
-                - id: 6596da6045e56dee495bcbba
-                  siteId: 6258612d1ee792848f805dcf
-                  title: Guide to the Galaxy
-                  slug: guide-to-the-galaxy
-                  parentId: 6419db964a9c435aa3af6251
-                  collectionId: 6390c49774a71f12831a08e3
-                  createdOn: '2024-03-11T10:42:00Z'
-                  lastUpdated: '2024-03-11T10:42:42Z'
-                  archived: false
-                  draft: false
-                  canBranch: false
-                  isBranch: true
-                  branchId: 68026fa68ef6dc744c75b833
-                  seo:
-                    title: The Ultimate Hitchhiker's Guide to the Galaxy
-                    description: >-
-                      Everything you need to know about the galaxy, from
-                      avoiding Vogon poetry to the importance of towels.
-                  openGraph:
-                    title: Explore the Cosmos with The Ultimate Guide
-                    titleCopied: false
-                    description: >-
-                      Dive deep into the mysteries of the universe with your
-                      guide to everything galactic.
-                    descriptionCopied: false
-                  localeId: 653fd9af6a07fc9cfd7a5e57
-                  publishedPath: /en-us/guide-to-the-galaxy
-                - id: 6596da6045e56dee495bcbad
-                  siteId: 6258612d1ee792848f805dcf
-                  title: Towel Day Celebrations
-                  slug: towel-day
-                  parentId: 6419db964a9c435aa3af6251
-                  collectionId: 6390c49774a71f12831a08e3
-                  createdOn: '2024-05-25T09:00:00Z'
-                  lastUpdated: '2024-05-25T09:42:00Z'
-                  archived: false
-                  draft: false
-                  canBranch: true
-                  isBranch: false
-                  branchId: 68026fa68ef6dc744c75b833
-                  seo:
-                    title: Celebrate Towel Day - The Hitchhiker's Guide to the Galaxy
-                    description: >-
-                      A guide to celebrating Towel Day, in honor of the most
-                      massively useful thing an interstellar hitchhiker can
-                      have.
-                  openGraph:
-                    title: Towel Day - Don't Panic
-                    titleCopied: false
-                    description: >-
-                      Join the galaxy in celebrating Towel Day, the day
-                      dedicated to carrying towels everywhere in memory of
-                      Douglas Adams.
-                    descriptionCopied: false
-                  localeId: 653fd9af6a07fc9cfd7a5e57
-                  publishedPath: /en-us/towel-day
-              pagination:
-                limit: 20
-                offset: 0
-                total: 2
-    get-metadata:
-      path: /pages/{page_id}
-      method: GET
-      auth:
-        - OAuth2:
-            - page:read
-      docs: |
-        Get metadata information for a single page.
-
-        Required scope | `pages:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        page_id:
-          type: string
-          docs: Unique identifier for a Page
-      display-name: Get Page Metadata
-      request:
-        name: PagesGetMetadataRequest
-        query-parameters:
-          localeId:
-            type: optional<string>
-            docs: >
-              Unique identifier for a specific Locale.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-localization)
-      response:
-        docs: Request was successful
-        type: root.Page
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            page_id: 63c720f9347c2139b248e552
-          query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
-          response:
-            body:
-              id: 6596da6045e56dee495bcbba
-              siteId: 6258612d1ee792848f805dcf
-              title: Guide to the Galaxy
-              slug: guide-to-the-galaxy
-              parentId: 6419db964a9c435aa3af6251
-              collectionId: 6390c49774a71f12831a08e3
-              createdOn: '2024-03-11T10:42:00Z'
-              lastUpdated: '2024-03-11T10:42:42Z'
-              archived: false
-              draft: false
-              canBranch: false
-              isBranch: true
-              branchId: 68026fa68ef6dc744c75b833
-              seo:
-                title: The Ultimate Hitchhiker's Guide to the Galaxy
-                description: >-
-                  Everything you need to know about the galaxy, from avoiding
-                  Vogon poetry to the importance of towels.
-              openGraph:
-                title: Explore the Cosmos with The Ultimate Guide
-                titleCopied: false
-                description: >-
-                  Dive deep into the mysteries of the universe with your guide
-                  to everything galactic.
-                descriptionCopied: false
-              localeId: 653fd9af6a07fc9cfd7a5e57
-              publishedPath: /en-us/guide-to-the-galaxy
-    update-page-settings:
-      path: /pages/{page_id}
-      method: PUT
-      auth:
-        - OAuth2:
-            - page:write
-      docs: |
-        Update Page-level metadata, including SEO and Open Graph fields.
-
-        Required scope | `pages:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        page_id:
-          type: string
-          docs: Unique identifier for a Page
-      display-name: Update Page Metadata
-      request:
-        name: PageMetadataWrite
-        query-parameters:
-          localeId:
-            type: optional<string>
-            docs: >
-              Unique identifier for a specific Locale.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-localization)
-        body:
-          properties:
-            title:
-              type: optional<string>
-              docs: Title for the page
-            slug:
-              type: optional<string>
-              docs: >
-                Slug for the page. 
-
-
-
-                **Note:** Updating slugs in secondary locales is only supported
-                in <a href="https://webflow.com/localization">Advanced and
-                Enterprise localization add-on plans.</a>
-            seo:
-              type: optional<PageMetadataWriteSeo>
-              docs: SEO-related fields for the Page
-            openGraph:
-              type: optional<PageMetadataWriteOpenGraph>
-              docs: Open Graph fields for the Page
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.Page
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            page_id: 63c720f9347c2139b248e552
-          query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
-          request:
-            title: Guide to the Galaxy
-            slug: guide-to-the-galaxy
-            seo:
-              title: The Ultimate Hitchhiker's Guide to the Galaxy
-              description: >-
-                Everything you need to know about the galaxy, from avoiding
-                Vogon poetry to the importance of towels.
-            openGraph:
-              title: Explore the Cosmos with The Ultimate Guide
-              titleCopied: false
-              description: >-
-                Dive deep into the mysteries of the universe with your guide to
-                everything galactic.
-              descriptionCopied: false
-          response:
-            body:
-              id: 6596da6045e56dee495bcbba
-              siteId: 6258612d1ee792848f805dcf
-              title: Guide to the Galaxy
-              slug: guide-to-the-galaxy
-              parentId: 6419db964a9c435aa3af6251
-              collectionId: 6390c49774a71f12831a08e3
-              createdOn: '2024-03-11T10:42:00Z'
-              lastUpdated: '2024-03-11T10:42:42Z'
-              archived: false
-              draft: false
-              canBranch: false
-              isBranch: true
-              branchId: 68026fa68ef6dc744c75b833
-              seo:
-                title: The Ultimate Hitchhiker's Guide to the Galaxy
-                description: >-
-                  Everything you need to know about the galaxy, from avoiding
-                  Vogon poetry to the importance of towels.
-              openGraph:
-                title: Explore the Cosmos with The Ultimate Guide
-                titleCopied: false
-                description: >-
-                  Dive deep into the mysteries of the universe with your guide
-                  to everything galactic.
-                descriptionCopied: false
-              localeId: 653fd9af6a07fc9cfd7a5e57
-              publishedPath: /en-us/guide-to-the-galaxy
-    get-content:
-      path: /pages/{page_id}/dom
-      method: GET
-      auth:
-        - OAuth2:
-            - page:read
-      docs: |
-        Get text and component instance content from a static page.
-
-        <Badge intent="info">Localization</Badge> 
-
-        Required scope | `pages:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        page_id:
-          type: string
-          docs: Unique identifier for a Page
-      display-name: Get Page Content
-      request:
-        name: PagesGetContentRequest
-        query-parameters:
-          localeId:
-            type: optional<string>
-            docs: >
-              Unique identifier for a specific Locale.
-
-
-              [Lear more about
-              localization.](/data/v2.0.0/docs/working-with-localization)
-          limit:
-            type: optional<double>
-            docs: 'Maximum number of records to be returned (max limit: 100)'
-          offset:
-            type: optional<double>
-            docs: >-
-              Offset used for pagination if the results have more than limit
-              records
-      response:
-        docs: Request was successful
-        type: root.Dom
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            page_id: 63c720f9347c2139b248e552
-          query-parameters:
-            localeId: 65427cf400e02b306eaa04a0
-            limit: 1.1
-            offset: 1.1
-          response:
-            body:
-              pageId: 658205daa3e8206a523b5ad4
-              branchId: 68026fa68ef6dc744c75b833
-              nodes:
-                - id: id
-                  text: {}
-                  attributes:
-                    key: value
-                  type: text
-                - id: id
-                  text: {}
-                  attributes:
-                    key: value
-                  type: text
-                - id: id
-                  image: {}
-                  attributes:
-                    key: value
-                  type: image
-                - id: id
-                  choices:
-                    - value: value
-                      text: text
-                  attributes:
-                    key: value
-                  type: select
-                - id: id
-                  placeholder: placeholder
-                  attributes:
-                    key: value
-                  type: text-input
-                - id: id
-                  text: {}
-                  attributes:
-                    key: value
-                  type: text
-                - id: id
-                  componentId: componentId
-                  propertyOverrides:
-                    - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                  type: component-instance
-              pagination:
-                limit: 4
-                offset: 0
-                total: 4
-              lastUpdated: '2016-10-24T19:42:38Z'
-    update-static-content:
-      path: /pages/{page_id}/dom
-      method: POST
-      auth:
-        - OAuth2:
-            - page:write
-      docs: >
-        This endpoint updates content on a static page in **secondary locales**.
-        It supports updating up to 1000 nodes in a single request.
-
-
-        Before making updates:
-
-        1. Use the [get page
-        content](/data/reference/pages-and-components/pages/get-content)
-        endpoint to identify available content nodes and their types.
-
-        2. If the page has component instances, retrieve the component's
-        properties that you'll override using the [get component
-        properties](/data/reference/pages-and-components/components/get-properties)
-        endpoint.
-
-        3. DOM elements may include a `data-w-id` attribute. This attribute is
-        used by Webflow to maintain custom attributes and links across locales.
-        Always include the original `data-w-id` value in your update requests to
-        ensure consistent behavior across all locales.
-
-
-        <Note>
-          This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
-        </Note>
-
-
-        Required scope | `pages:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        page_id:
-          type: string
-          docs: Unique identifier for a Page
-      display-name: Update Page Content
-      request:
-        name: PageDomWrite
-        query-parameters:
-          localeId:
-            type: string
-            docs: The locale identifier.
-        body:
-          properties:
-            nodes:
-              docs: >-
-                List of DOM Nodes with the new content that will be updated in
-                each node.
-              type: list<PageDomWriteNodesItem>
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: UpdateStaticContentResponse
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            page_id: 63c720f9347c2139b248e552
-          query-parameters:
-            localeId: localeId
-          request:
-            nodes:
-              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623
-                text: <h1>The Hitchhiker's Guide to the Galaxy</h1>
-              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad627
-                text: >-
-                  <div><h3>Don't Panic!</h3><p>Always know where your towel
-                  is.</p></div>
-              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad635
-                choices:
-                  - value: choice-1
-                    text: First choice
-                  - value: choice-2
-                    text: Second choice
-              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad642
-                placeholder: Enter something here...
-              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad671
-                value: Submit
-                waitingText: Submitting...
-              - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629
-                propertyOverrides:
-                  - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0
-                    text: <div><h1>Time is an <em>illusion</em></h1></div>
-                  - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f1
-                    text: Life, the Universe and Everything
-          response:
-            body:
-              errors:
-                - errors
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml
-  display-name: Pages
-docs: Pages are the pages in your Webflow site.
-types:
-  PageMetadataWriteSeo:
-    docs: SEO-related fields for the Page
-    properties:
-      title:
-        type: optional<string>
-        docs: The Page title shown in search engine results
-      description:
-        type: optional<string>
-        docs: The Page description shown in search engine results
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  PageMetadataWriteOpenGraph:
-    docs: Open Graph fields for the Page
-    properties:
-      title:
-        type: optional<string>
-        docs: The title supplied to Open Graph annotations
-      titleCopied:
-        type: optional<boolean>
-        docs: Indicates the Open Graph title was copied from the SEO title
-      description:
-        type: optional<string>
-        docs: The description supplied to Open Graph annotations
-      descriptionCopied:
-        type: optional<boolean>
-        docs: >-
-          Indicates the Open Graph description was copied from the SEO
-          description
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  PageDomWriteNodesItem:
-    discriminated: false
-    union:
-      - type: root.TextNodeWrite
-      - type: root.ComponentInstanceNodePropertyOverridesWrite
-      - type: root.Select
-      - type: root.TextInputNodeWrite
-      - type: root.SubmitButtonNodeWrite
-      - type: root.SearchButtonNodeWrite
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UpdateStaticContentResponse:
-    properties:
-      errors:
-        docs: A list of error messages, if any.
-        type: list<string>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-webhooks:
-  page_created:
-    audiences: []
-    method: POST
-    display-name: Page Created
-    headers: {}
-    payload: root.PageCreatedWebhook
-    examples:
-      - payload:
-          triggerType: page_created
-          payload:
-            siteId: 65427cf400e02b306eaa049c
-            pageId: 66a3cfb276641574f5d58311
-            pageTitle: Heart of Gold Specs
-            createdOn: '2024-07-26T16:32:50Z'
-            publishedPath: /blog/earth
-    docs: Information about a new pages
-  page_metadata_updated:
-    audiences: []
-    method: POST
-    display-name: Page Metadata Updated
-    headers: {}
-    payload: root.PageMetadataUpdatedWebhook
-    examples:
-      - payload:
-          triggerType: page_metadata_updated
-          payload:
-            siteId: 65427cf400e02b306eaa049c
-            pageId: 66a3cfb276641574f5d58311
-            pageTitle: Heart of Gold Specs
-            lastUpdated: '2024-07-26T16:32:50Z'
-            publishedPath: /blog/earth
-    docs: Information about a page's updated metadata and/or settings
-  page_deleted:
-    audiences: []
-    method: POST
-    display-name: Page Deleted
-    headers: {}
-    payload: root.PageDeletedWebhook
-    examples:
-      - payload:
-          triggerType: page_deleted
-          payload:
-            siteId: 65427cf400e02b306eaa049c
-            pageId: 66a3cfb276641574f5d58311
-            pageTitle: Heart of Gold Specs
-            deletedOn: '2024-07-26T16:32:50Z'
-            publishedPath: /blog/earth
-    docs: Information about a page that was deleted