webflow-api 3.1.2 → 3.1.4

package/.mock/definition/__package__.yml

@@ -339,6 +339,276 @@ types:
       openapi: ../../../openapi/referenced-specs/v2.yml
   InvalidScopes: unknown
   NotEnterprisePlanWorkspace: unknown
+  WorkspaceAuditLogItemPayloadUserAccessMethod:
+    enum:
+      - dashboard
+      - sso
+      - api
+      - google
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  User access:
+    properties:
+      method: optional<WorkspaceAuditLogItemPayloadUserAccessMethod>
+      location:
+        type: optional<string>
+        docs: The geolocation based on the logged IP address
+      ipAddress:
+        type: optional<string>
+        docs: The captured IP address of the user
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  UserAccessAuditLogItemEventSubType:
+    enum:
+      - login
+      - logout
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  UserAccessAuditLogItem:
+    properties:
+      eventSubType: optional<UserAccessAuditLogItemEventSubType>
+      payload: optional<User access>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  Custom role:
+    properties:
+      roleName:
+        type: optional<string>
+        docs: The name of the custom role
+      previousRoleName:
+        type: optional<string>
+        docs: The previous name of the custom role
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CustomRoleAuditLogItemEventSubType:
+    enum:
+      - role_created
+      - role_updated
+      - role_deleted
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CustomRoleAuditLogItem:
+    properties:
+      eventSubType: optional<CustomRoleAuditLogItemEventSubType>
+      payload: optional<Custom role>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser:
+    properties:
+      id: optional<string>
+      email: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod:
+    enum:
+      - sso
+      - dashboard
+      - admin
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType:
+    enum:
+      - member
+      - guest
+      - reviewer
+      - client
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  Workspace membership:
+    properties:
+      targetUser: optional<WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser>
+      method: optional<WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod>
+      userType: optional<WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType>
+      roleName:
+        type: optional<string>
+        docs: The name of the role that was assigned to the user
+      previousRoleName:
+        type: optional<string>
+        docs: The previous role that the user had
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceMembershipAuditLogItemEventSubType:
+    enum:
+      - user_added
+      - user_removed
+      - user_role_updated
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceMembershipAuditLogItem:
+    properties:
+      eventSubType: optional<WorkspaceMembershipAuditLogItemEventSubType>
+      payload: optional<Workspace membership>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemPayloadSiteMembershipSite:
+    properties:
+      id: optional<string>
+      slug: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  WorkspaceAuditLogItemPayloadSiteMembershipTargetUser:
+    properties:
+      id: optional<string>
+      email: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  WorkspaceAuditLogItemPayloadSiteMembershipMethod:
+    enum:
+      - sso
+      - invite
+      - scim
+      - dashboard
+      - admin
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemPayloadSiteMembershipUserType:
+    enum:
+      - member
+      - guest
+      - reviewer
+      - client
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  Site membership:
+    properties:
+      site: optional<WorkspaceAuditLogItemPayloadSiteMembershipSite>
+      targetUser: optional<WorkspaceAuditLogItemPayloadSiteMembershipTargetUser>
+      method: optional<WorkspaceAuditLogItemPayloadSiteMembershipMethod>
+      userType: optional<WorkspaceAuditLogItemPayloadSiteMembershipUserType>
+      roleName:
+        type: optional<string>
+        docs: The name of the role that was assigned to the user
+      previousRoleName:
+        type: optional<string>
+        docs: The previous role that the user had
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SiteMembershipAuditLogItemEventSubType:
+    enum:
+      - user_added
+      - user_removed
+      - user_role_updated
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SiteMembershipAuditLogItem:
+    properties:
+      eventSubType: optional<SiteMembershipAuditLogItemEventSubType>
+      payload: optional<Site membership>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser:
+    properties:
+      id: optional<string>
+      email: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod:
+    enum:
+      - sso
+      - dashboard
+      - admin
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType:
+    enum:
+      - member
+      - guest
+      - reviewer
+      - client
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  Workspace invitation:
+    properties:
+      targetUser: optional<WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser>
+      method: optional<WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod>
+      userType: optional<WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType>
+      roleName:
+        type: optional<string>
+        docs: The name of the role that was assigned to the user
+      previousRoleName:
+        type: optional<string>
+        docs: The previous role that the user had
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceInvitationAuditLogItemEventSubType:
+    enum:
+      - invite_sent
+      - invite_accepted
+      - invite_updated
+      - invite_canceled
+      - invite_declined
+    inline: true
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceInvitationAuditLogItem:
+    properties:
+      eventSubType: optional<WorkspaceInvitationAuditLogItemEventSubType>
+      payload: optional<Workspace invitation>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogItemActor:
+    properties:
+      id: optional<string>
+      email: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  WorkspaceAuditLogItemWorkspace:
+    properties:
+      id: optional<string>
+      slug: optional<string>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  WorkspaceAuditLogItem:
+    discriminant: eventType
+    base-properties:
+      timestamp: optional<datetime>
+      actor: optional<WorkspaceAuditLogItemActor>
+      workspace: optional<WorkspaceAuditLogItemWorkspace>
+    union:
+      user_access: UserAccessAuditLogItem
+      custom_role: CustomRoleAuditLogItem
+      workspace_membership: WorkspaceMembershipAuditLogItem
+      site_membership: SiteMembershipAuditLogItem
+      workspace_invitation: WorkspaceInvitationAuditLogItem
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  Pagination:
+    docs: Pagination object
+    properties:
+      limit:
+        type: double
+        docs: The limit used for pagination
+      offset:
+        type: double
+        docs: The offset used for pagination
+      total:
+        type: double
+        docs: The total number of records
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  WorkspaceAuditLogResponse:
+    properties:
+      items: optional<list<WorkspaceAuditLogItem>>
+      pagination: optional<Pagination>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
   Sites:
     properties:
       sites: optional<list<Site>>
@@ -367,20 +637,6 @@ types:
         docs: The target URL path where the user or client will be redirected.
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
-  Pagination:
-    docs: Pagination object
-    properties:
-      limit:
-        type: double
-        docs: The limit used for pagination
-      offset:
-        type: double
-        docs: The offset used for pagination
-      total:
-        type: double
-        docs: The total number of records
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
   Redirects:
     docs: Site redirects response
     properties:
@@ -614,7 +870,7 @@ types:
       - PlainText
       - RichText
       - Switch
-      - Video
+      - VideoLink
     docs: Choose these appropriate field type for your collection data
     inline: true
     source:
@@ -754,17 +1010,19 @@ types:
       - DateTime
       - Email
       - ExtFileRef
+      - File
       - Image
       - Link
       - MultiImage
       - MultiReference
       - Number
+      - Option
       - Phone
       - PlainText
       - Reference
       - RichText
       - Switch
-      - Video
+      - VideoLink
     docs: Choose these appropriate field type for your collection data
     inline: true
     source:
@@ -1132,6 +1390,222 @@ types:
       fieldData: optional<CollectionItemPatchSingleFieldData>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentThreadAuthor:
+    properties:
+      userId:
+        type: string
+        docs: The unique identifier of the author
+      email:
+        type: string
+        docs: Email of the author
+      name:
+        type: string
+        docs: Name of the author
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  CommentThreadMentionedUsersItem:
+    properties:
+      userId:
+        type: string
+        docs: The unique identifier of the mentioned user
+      email:
+        type: string
+        docs: Email of the user
+      name:
+        type: string
+        docs: Name of the  User
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  CommentThread:
+    docs: >
+      A comment thread represents a conversation between users on a specific
+      page. Each comment thread has a unique identifier and can contain multiple
+      comments. Retrieve comment replies using the replies API endpoint.
+    properties:
+      id:
+        type: string
+        docs: Unique identifier for the comment thread
+        access: read-only
+      siteId:
+        type: string
+        docs: The site unique identifier
+        access: read-only
+      pageId:
+        type: string
+        docs: The page unique identifier
+        access: read-only
+      localeId:
+        type: optional<string>
+        docs: The locale unique identifier
+        access: read-only
+      itemId:
+        type: optional<string>
+        docs: The item unique identifier
+        access: read-only
+      breakpoint:
+        type: string
+        docs: The breakpoint the comment was left on
+        access: read-only
+      url:
+        type: string
+        docs: The URL of the page the comment was left on
+        access: read-only
+      content:
+        type: string
+        docs: The content of the comment reply
+      isResolved:
+        type: boolean
+        docs: Boolean determining if the comment thread is resolved
+        default: false
+      author: CommentThreadAuthor
+      mentionedUsers:
+        docs: >-
+          List of mentioned users. This is an empty array until email
+          notifications are sent, which can take up to 5 minutes after the
+          comment is created.
+        type: list<CommentThreadMentionedUsersItem>
+      createdOn:
+        type: string
+        docs: The date the item was created
+        access: read-only
+      lastUpdated:
+        type: string
+        docs: The date the item was last updated
+        access: read-only
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentThreadListPagination:
+    properties:
+      limit:
+        type: double
+        docs: The limit specified in the request (default 100)
+        default: 100
+      offset:
+        type: double
+        docs: The offset specified for pagination
+        default: 0
+      total:
+        type: double
+        docs: Total number of comment threads
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  CommentThreadList:
+    docs: >
+      A list of comment threads on the site. Contains the content of the first
+      reply.
+    properties:
+      comments: list<CommentThread>
+      pagination: CommentThreadListPagination
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentReplyAuthor:
+    properties:
+      id:
+        type: string
+        docs: The unique identifier of the author
+      email:
+        type: string
+        docs: Email of the author
+      name:
+        type: string
+        docs: Name of the author
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  CommentReplyMentionedUsersItem:
+    properties:
+      id:
+        type: string
+        docs: The unique identifier of the mentioned user
+      email:
+        type: string
+        docs: Email of the user
+      name:
+        type: string
+        docs: Name of the  User
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  CommentReply:
+    docs: >
+      A comment thread represents a conversation between users on a specific
+      page. Each comment thread has a unique identifier and can contain multiple
+      comments.
+    properties:
+      id:
+        type: string
+        docs: Unique identifier for the comment thread
+        access: read-only
+      commentId:
+        type: string
+        docs: The comment reply unique identifier
+        access: read-only
+      siteId:
+        type: string
+        docs: The site unique identifier
+        access: read-only
+      pageId:
+        type: string
+        docs: The page unique identifier
+        access: read-only
+      localeId:
+        type: optional<string>
+        docs: The locale unique identifier
+        access: read-only
+      breakpoint:
+        type: string
+        docs: The breakpoint the comment was left on
+        access: read-only
+      content:
+        type: string
+        docs: The content of the comment reply
+      isResolved:
+        type: boolean
+        docs: Boolean determining if the comment thread is resolved
+        default: false
+      author: CommentReplyAuthor
+      mentionedUsers:
+        type: optional<list<CommentReplyMentionedUsersItem>>
+        docs: >-
+          List of mentioned users is an empty array until email notifications
+          are sent.
+      lastUpdated:
+        type: string
+        docs: The date the item was last updated
+        access: read-only
+      createdOn:
+        type: string
+        docs: The date the item was created
+        access: read-only
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  CommentReplyListPagination:
+    properties:
+      limit:
+        type: double
+        docs: The limit specified in the request (default 100)
+        default: 100
+      offset:
+        type: double
+        docs: The offset specified for pagination
+        default: 0
+      total:
+        type: double
+        docs: Total number of comment replies
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  CommentReplyList:
+    docs: |
+      A list of comment replies.
+    properties:
+      comments: list<CommentReply>
+      pagination: CommentReplyListPagination
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
   PageSeo:
     docs: SEO-related fields for the Page
     properties:
@@ -1227,13 +1701,6 @@ types:
           Branching](https://university.webflow.com/lesson/page-branching)
         default: false
         access: read-only
-      isMembersOnly:
-        type: optional<boolean>
-        docs: >-
-          Indicates whether the Page is restricted by [Memberships
-          Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions)
-        default: false
-        access: read-only
       seo:
         type: optional<PageSeo>
         docs: SEO-related fields for the Page
@@ -1377,6 +1844,92 @@ types:
         type: list<ComponentProperty>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
+  TextInputNode:
+    docs: >
+      Represents text input and textarea elements within the DOM. It contains
+      the placeholder text in the input. Additional attributes can be associated
+      with the text for styling or other purposes.
+    properties:
+      id:
+        type: string
+        docs: Node UUID
+        access: read-only
+      placeholder:
+        type: string
+        docs: The placeholder text of the input node
+      attributes:
+        type: optional<map<string, string>>
+        docs: The custom attributes of the node
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SelectNodeChoicesItem:
+    properties:
+      value:
+        type: string
+        docs: The value of the choice when selected.
+      text:
+        type: string
+        docs: The text to display for the choice.
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  SelectNode:
+    docs: >
+      Represents select elements within the DOM. It contains the list of choices
+      in the select. Additional attributes can be associated with the text for
+      styling or other purposes.
+    properties:
+      id:
+        type: string
+        docs: Node UUID
+        access: read-only
+      choices:
+        docs: The list of choices in this select node.
+        type: list<SelectNodeChoicesItem>
+      attributes:
+        type: optional<map<string, string>>
+        docs: The custom attributes of the node
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SubmitButtonNode:
+    docs: >
+      Represents submit button elements within the DOM. It contains the text and
+      waiting text of the button. Additional attributes can be associated with
+      the text for styling or other purposes.
+    properties:
+      id:
+        type: string
+        docs: Node UUID
+        access: read-only
+      value:
+        type: string
+        docs: The text content of the submit button.
+      waitingText:
+        type: string
+        docs: The text to show while the form is submitting.
+      attributes:
+        type: optional<map<string, string>>
+        docs: The custom attributes of the node
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SearchButtonNode:
+    docs: >
+      Represents search button elements within the DOM. It contains the text of
+      the button. Additional attributes can be associated with the text for
+      styling or other purposes.
+    properties:
+      id:
+        type: string
+        docs: Node UUID
+        access: read-only
+      value:
+        type: string
+        docs: The text content of the search button.
+      attributes:
+        type: optional<map<string, string>>
+        docs: The custom attributes of the node
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
   Node:
     discriminant: type
     base-properties: {}
@@ -1388,6 +1941,10 @@ types:
       text: TextNode
       image: ImageNode
       component-instance: ComponentNode
+      text-input: TextInputNode
+      select: SelectNode
+      submit-button: SubmitButtonNode
+      search-button: SearchButtonNode
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
   Dom:
@@ -1457,6 +2014,64 @@ types:
         type: list<ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem>
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
+  SelectNodeWriteChoicesItem:
+    properties:
+      value:
+        type: string
+        docs: The value of the choice when selected.
+      text:
+        type: string
+        docs: The text to display for the choice.
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+    inline: true
+  SelectNodeWrite:
+    docs: Update choices on a select node
+    properties:
+      nodeId:
+        type: string
+        docs: Node UUID
+      choices:
+        docs: The list of choices to set on the select node.
+        type: list<SelectNodeWriteChoicesItem>
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  TextInputNodeWrite:
+    docs: Update placeholder text on a text input node
+    properties:
+      nodeId:
+        type: string
+        docs: Node UUID
+      placeholder:
+        type: string
+        docs: The placeholder text of the input node
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SubmitButtonNodeWrite:
+    docs: Update a submit button node
+    properties:
+      nodeId:
+        type: string
+        docs: Node UUID
+      value:
+        type: optional<string>
+        docs: The text content of the submit button.
+      waitingText:
+        type: optional<string>
+        docs: The text to show while the form is submitting.
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
+  SearchButtonNodeWrite:
+    docs: Update a search button node
+    properties:
+      nodeId:
+        type: string
+        docs: Node UUID
+      value:
+        type: string
+        docs: The text content of the search button.
+    source:
+      openapi: ../../../openapi/referenced-specs/v2.yml
   Component:
     docs: The Component object
     properties:
@@ -1497,8 +2112,8 @@ types:
       The Component DOM schema represents the content structure of a component.
       Similar to Page DOM, it captures various content nodes and their
       associated attributes, but specifically for a component's structure. Each
-      node has a unique identifier and  can contain text, images, or nested
-      component instances.
+      node has a unique identifier and  can contain text, images, select or text
+      inputs, submit buttons, or nested component instances.
     properties:
       componentId:
         type: optional<string>
@@ -1892,6 +2507,7 @@ types:
       - collection_item_changed
       - collection_item_deleted
       - collection_item_unpublished
+      - comment_created
     docs: >
       The type of event that triggered the request. See the the documentation
       for details on [supported events](/data/reference/all-events).
@@ -2432,8 +3048,10 @@ types:
   SkuValueList:
     type: map<string, string>
     docs: >
-      A dictionary that maps a SKU property to a SKU value. The key of the
-      dictionary is the SKU property ID, and the value is the SKU value ID.
+      A mapping between SKU properties and their values, represented as
+      key-value pairs. Each key represents a SKU Property ID (e.g. "color") and
+      maps to its corresponding SKU Value ID (e.g. "blue"). This structure
+      defines the specific variant combination for a SKU.
   SkuFieldDataPrice:
     docs: price of SKU
     properties:
@@ -2443,6 +3061,9 @@ types:
       unit:
         type: optional<string>
         docs: Currency of Item
+      currency:
+        type: optional<string>
+        docs: Currency of Item (alternative representation)
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
     inline: true
@@ -2561,6 +3182,15 @@ types:
       quantity:
         type: optional<double>
         docs: Quantity of SKU that will be tracked as items are ordered.
+      main-image:
+        type: optional<string>
+        docs: The URL for the main image of the SKU
+      sku:
+        type: optional<string>
+        docs: A unique identifier for the SKU
+      sku-properties:
+        type: optional<list<SkuPropertyList>>
+        docs: The properties of the SKU
     source:
       openapi: ../../../openapi/referenced-specs/v2.yml
   Sku: