{"id":"f9912ce0-b1ce-4916-8739-bc092900b031","createdDate":"2025-02-20T14:17:13.776Z","updatedDate":"2025-02-20T14:17:13.776Z","resourceId":"82fd4431-cdf0-46dc-85a0-79c820c63b91","sdk":{"schema":{"name":"velo-deps_wix-comments.v2_comments","fqn":"","slug":"velo-deps-wix-comments-v2-comments","typesMap":{"BulkDeleteCommentOptions":{"name":"BulkDeleteCommentOptions","fqn":"BulkDeleteCommentOptions","slug":"bulk-delete-comment-options","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter to identify the comments that need to be deleted. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`\"resourceId\"`: `\"64ad407e0bf87891bba7de3a\"`, `\"parentComment.id\"`: `\"726cb137-a9c3-408b-9cc2-2b64c6be8a95\"`}."}]},"BulkDeleteCommentResponse":{"name":"BulkDeleteCommentResponse","fqn":"BulkDeleteCommentResponse","slug":"bulk-delete-comment-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Job ID.\n\nPass this ID to Get Async Job to retrieve job details and metadata."}]},"BulkHideCommentOptions":{"name":"BulkHideCommentOptions","fqn":"BulkHideCommentOptions","slug":"bulk-hide-comment-options","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter to identify the comments that need to be hidden. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`\"resourceId\"`: `\"64ad407e0bf87891bba7de3a\"`, `\"parentComment.id\"`: `\"726cb137-a9c3-408b-9cc2-2b64c6be8a95\"`}."}]},"BulkHideCommentResponse":{"name":"BulkHideCommentResponse","fqn":"BulkHideCommentResponse","slug":"bulk-hide-comment-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Job ID.\n\nPass this ID to Get Async Job to retrieve job details and metadata."}]},"BulkModerateDraftContentOptions":{"name":"BulkModerateDraftContentOptions","fqn":"BulkModerateDraftContentOptions","slug":"bulk-moderate-draft-content-options","actions":[],"properties":[{"name":"draftContentAction","slug":"draft-content-action","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Action","referenceFqn":"Action"},"description":"Action to do regarding draft content"},{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter to identify the comment content that needs to be moderated. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`\"resourceId\"`: `\"64ad407e0bf87891bba7de3a\"`, `\"parentComment.id\"`: `\"726cb137-a9c3-408b-9cc2-2b64c6be8a95\"`}."}]},"Action":{"name":"Action","fqn":"Action","slug":"action","actions":[],"enumValues":[{"value":"APPROVE","description":"Approve draft content."},{"value":"REJECT","description":"Reject draft content."},{"value":"UNKNOWN","description":"Unknown content."}],"properties":[]},"BulkModerateDraftContentResponse":{"name":"BulkModerateDraftContentResponse","fqn":"BulkModerateDraftContentResponse","slug":"bulk-moderate-draft-content-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Job ID.\n\nPass this ID to Get Async Job to retrieve job details and metadata."}]},"BulkMoveCommentByFilterOptions":{"name":"BulkMoveCommentByFilterOptions","fqn":"BulkMoveCommentByFilterOptions","slug":"bulk-move-comment-by-filter-options","actions":[],"properties":[{"name":"destination","slug":"destination","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Destination","referenceFqn":"Destination"},"description":"Where to move the comment."},{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter to identify the comments that need to be moved. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`\"resourceId\"`: `\"64ad407e0bf87891bba7de3a\"`, `\"parentComment.id\"`: `\"726cb137-a9c3-408b-9cc2-2b64c6be8a95\"`}."}]},"Destination":{"name":"Destination","fqn":"Destination","slug":"destination","actions":[],"properties":[{"name":"contextId","slug":"context-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Context ID of where to move the comment to."},{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource ID of where to move the comment to."}]},"BulkMoveCommentByFilterResponse":{"name":"BulkMoveCommentByFilterResponse","fqn":"BulkMoveCommentByFilterResponse","slug":"bulk-move-comment-by-filter-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Job ID.\n\nPass this ID to Get Async Job to retrieve job details and metadata."}]},"BulkPublishCommentOptions":{"name":"BulkPublishCommentOptions","fqn":"BulkPublishCommentOptions","slug":"bulk-publish-comment-options","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter to identify the comments that need to be published. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`\"resourceId\"`: `\"64ad407e0bf87891bba7de3a\"`, `\"parentComment.id\"`: `\"726cb137-a9c3-408b-9cc2-2b64c6be8a95\"`}."}]},"BulkPublishCommentResponse":{"name":"BulkPublishCommentResponse","fqn":"BulkPublishCommentResponse","slug":"bulk-publish-comment-response","actions":[],"properties":[{"name":"jobId","slug":"job-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Job ID.\n\nPass this ID to Get Async Job to retrieve job details and metadata."}]},"CountCommentsOptions":{"name":"CountCommentsOptions","fqn":"CountCommentsOptions","slug":"count-comments-options","actions":[],"properties":[{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Filter to identify the comments that need to be counted."}]},"CountCommentsResponse":{"name":"CountCommentsResponse","fqn":"CountCommentsResponse","slug":"count-comments-response","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of comments."}]},"Comment":{"name":"Comment","fqn":"Comment","slug":"comment","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the comment was created.\n\n**Note:** This is the date from the system database, not the actual date when the comment was created. For example, if you migrate comments created in 2016, the `createdDate` field will show the current year. For the actual creation date, see the `commentDate` field."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Comment ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the comment was last updated."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that the comment is added to."},{"name":"author","slug":"author","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentAuthor","referenceFqn":"CommentAuthor"},"description":"Comment's author."},{"name":"commentDate","slug":"comment-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the comment was actually created."},{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentContent","referenceFqn":"CommentContent"},"description":"Published comment content."},{"name":"contentEdited","slug":"content-edited","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the comment has the updated content."},{"name":"contextId","slug":"context-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the specific context the comment is in response to.\n\nWithin some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,\nthe `forumPostId` is used as both the `contextId` and the `resourceId`."},{"name":"marked","slug":"marked","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the comment is marked."},{"name":"parentComment","slug":"parent-comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParentComment","referenceFqn":"ParentComment"},"description":"Parent comment information.\n\nOnly present if this comment is in a direct reply to another comment.\nSee **Terminology** in the Comments introduction\nfor more information about parent comments."},{"name":"rating","slug":"rating","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Comment rating."},{"name":"reactionSummary","slug":"reaction-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentReactionSummary","referenceFqn":"CommentReactionSummary"},"description":"Summary of reactions."},{"name":"replyCount","slug":"reply-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of comments that reply to this comment."},{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the specific resource that the comment is in response to.\n\nWithin some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,\nthe `forumPostId` is used as both the `resourceId` and the `contextId`."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the comment is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the comment."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Comment status."},{"name":"voteSummary","slug":"vote-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VoteSummary","referenceFqn":"VoteSummary"},"description":"Summary of votes."}]},"CommentAuthor":{"name":"CommentAuthor","fqn":"CommentAuthor","slug":"comment-author","actions":[],"oneofProperties":{"identity":[{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID. See the Members API for more details."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix user ID."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID."}]},"properties":[]},"CommentContent":{"name":"CommentContent","fqn":"CommentContent","slug":"comment-content","actions":[],"properties":[{"name":"attachments","slug":"attachments","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Attachment","referenceFqn":"Attachment"}},"description":"Content attachments."},{"name":"mentions","slug":"mentions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Mention","referenceFqn":"Mention"}},"description":"People to tag with this comment.\n\nPeople can include users, members, visitors, or groups."},{"name":"richContent","slug":"rich-content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RichContent","referenceFqn":"RichContent"},"description":"Comment rich content.\n\n\nSee Ricos document reference\n"}]},"Attachment":{"name":"Attachment","fqn":"Attachment","slug":"attachment","actions":[],"oneofProperties":{"media":[{"name":"audio","slug":"audio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the audio."},{"name":"document","slug":"document","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the document."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the image."},{"name":"video","slug":"video","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Information about the video."}]},"properties":[{"name":"mimeType","slug":"mime-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Mime type of attachment."}]},"ContentAuthor":{"name":"ContentAuthor","fqn":"ContentAuthor","slug":"content-author","actions":[],"oneofProperties":{"author":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance)."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID. See the Members API for more details."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix user ID."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID."}]},"properties":[]},"Mention":{"name":"Mention","fqn":"Mention","slug":"mention","actions":[],"oneofProperties":{"identity":[{"name":"groupId","slug":"group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Group ID. See the Groups API for more details."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID. See the Members API for more details."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix user ID."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID."}]},"properties":[]},"RichContent":{"name":"RichContent","fqn":"RichContent","slug":"rich-content","actions":[],"properties":[{"name":"documentStyle","slug":"document-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DocumentStyle","referenceFqn":"DocumentStyle"},"description":"Global styling for header, paragraph, block quote, and code block nodes in the object."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Metadata","referenceFqn":"Metadata"},"description":"Object metadata."},{"name":"nodes","slug":"nodes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Node","referenceFqn":"Node"}},"description":"Node objects representing a rich content document."}]},"DocumentStyle":{"name":"DocumentStyle","fqn":"DocumentStyle","slug":"document-style","actions":[],"properties":[{"name":"blockquote","slug":"blockquote","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for block quote nodes."},{"name":"codeBlock","slug":"code-block","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for code block nodes."},{"name":"headerFive","slug":"header-five","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for H5 nodes."},{"name":"headerFour","slug":"header-four","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for H4 nodes."},{"name":"headerOne","slug":"header-one","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for H1 nodes."},{"name":"headerSix","slug":"header-six","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for H6 nodes."},{"name":"headerThree","slug":"header-three","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for H3 nodes."},{"name":"headerTwo","slug":"header-two","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for H2 nodes."},{"name":"paragraph","slug":"paragraph","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextNodeStyle","referenceFqn":"TextNodeStyle"},"description":"Styling for paragraph nodes."}]},"TextNodeStyle":{"name":"TextNodeStyle","fqn":"TextNodeStyle","slug":"text-node-style","actions":[],"properties":[{"name":"decorations","slug":"decorations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Decoration","referenceFqn":"Decoration"}},"description":"The decorations to apply to the node."},{"name":"lineHeight","slug":"line-height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line height for text in the node."},{"name":"nodeStyle","slug":"node-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NodeStyle","referenceFqn":"NodeStyle"},"description":"Padding and background color for the node."}]},"Decoration":{"name":"Decoration","fqn":"Decoration","slug":"decoration","actions":[],"oneofProperties":{"data":[{"name":"anchorData","slug":"anchor-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AnchorData","referenceFqn":"AnchorData"},"description":"Data for an anchor link decoration."},{"name":"colorData","slug":"color-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ColorData","referenceFqn":"ColorData"},"description":"Data for a color decoration."},{"name":"fontSizeData","slug":"font-size-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FontSizeData","referenceFqn":"FontSizeData"},"description":"Data for a font size decoration."},{"name":"fontWeightValue","slug":"font-weight-value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Font weight for a bold decoration."},{"name":"italicData","slug":"italic-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Data for an italic decoration. Defaults to `true`."},{"name":"linkData","slug":"link-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LinkData","referenceFqn":"LinkData"},"description":"Data for an external link decoration."},{"name":"mentionData","slug":"mention-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MentionData","referenceFqn":"MentionData"},"description":"Data for a mention decoration."},{"name":"spoilerData","slug":"spoiler-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SpoilerData","referenceFqn":"SpoilerData"},"description":"Data for a spoiler decoration."},{"name":"underlineData","slug":"underline-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Data for an underline decoration. Defaults to `true`."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DecorationType","referenceFqn":"DecorationType"},"description":"The type of decoration to apply."}]},"AnchorData":{"name":"AnchorData","fqn":"AnchorData","slug":"anchor-data","actions":[],"properties":[{"name":"anchor","slug":"anchor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The target node's ID."}]},"ColorData":{"name":"ColorData","fqn":"ColorData","slug":"color-data","actions":[],"properties":[{"name":"background","slug":"background","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The text's background color as a hexadecimal value."},{"name":"foreground","slug":"foreground","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The text's foreground color as a hexadecimal value."}]},"FontSizeData":{"name":"FontSizeData","fqn":"FontSizeData","slug":"font-size-data","actions":[],"properties":[{"name":"unit","slug":"unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FontType","referenceFqn":"FontType"},"description":"The units used for the font size."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Font size value."}]},"FontType":{"name":"FontType","fqn":"FontType","slug":"font-type","actions":[],"enumValues":[{"value":"EM"},{"value":"PX"}],"properties":[]},"LinkData":{"name":"LinkData","fqn":"LinkData","slug":"link-data","actions":[],"properties":[{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Link","referenceFqn":"Link"},"description":"Link details."}]},"Link":{"name":"Link","fqn":"Link","slug":"link","actions":[],"oneofProperties":{"data":[{"name":"anchor","slug":"anchor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The target node's ID. Used for linking to another node in this object."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The absolute URL for the linked document."}]},"properties":[{"name":"customData","slug":"custom-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A serialized object used for a custom or external link panel."},{"name":"rel","slug":"rel","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Rel","referenceFqn":"Rel"},"description":"The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document."},{"name":"target","slug":"target","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Target","referenceFqn":"Target"},"description":"he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:\n`SELF` - Default. Opens the linked document in the same frame as the link.\n`BLANK` - Opens the linked document in a new browser tab or window.\n`PARENT` - Opens the linked document in the link's parent frame.\n`TOP` - Opens the linked document in the full body of the link's browser tab or window."}]},"Rel":{"name":"Rel","fqn":"Rel","slug":"rel","actions":[],"properties":[{"name":"nofollow","slug":"nofollow","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates to search engine crawlers not to follow the link. Defaults to `false`."},{"name":"noreferrer","slug":"noreferrer","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that this link protect referral information from being passed to the target website."},{"name":"sponsored","slug":"sponsored","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`."},{"name":"ugc","slug":"ugc","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`."}]},"Target":{"name":"Target","fqn":"Target","slug":"target","actions":[],"enumValues":[{"value":"BLANK","description":"Opens the linked document in a new window or tab"},{"value":"PARENT","description":"Opens the linked document in the parent frame"},{"value":"SELF","description":"Opens the linked document in the same frame as it was clicked (this is default)"},{"value":"TOP","description":"Opens the linked document in the full body of the window"}],"properties":[]},"MentionData":{"name":"MentionData","fqn":"MentionData","slug":"mention-data","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Mentioned user's ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The mentioned user's name."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The version of the user's name that appears after the `@` character in the mention."}]},"SpoilerData":{"name":"SpoilerData","fqn":"SpoilerData","slug":"spoiler-data","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Spoiler ID."}]},"DecorationType":{"name":"DecorationType","fqn":"DecorationType","slug":"decoration-type","actions":[],"enumValues":[{"value":"ANCHOR"},{"value":"BOLD"},{"value":"COLOR"},{"value":"EXTERNAL"},{"value":"FONT_SIZE"},{"value":"ITALIC"},{"value":"LINK"},{"value":"MENTION"},{"value":"SPOILER"},{"value":"UNDERLINE"}],"properties":[]},"NodeStyle":{"name":"NodeStyle","fqn":"NodeStyle","slug":"node-style","actions":[],"properties":[{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The background color as a hexadecimal value."},{"name":"paddingBottom","slug":"padding-bottom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The bottom padding value in pixels."},{"name":"paddingTop","slug":"padding-top","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The top padding value in pixels."}]},"Metadata":{"name":"Metadata","fqn":"Metadata","slug":"metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Object ID."},{"name":"createdTimestamp","slug":"created-timestamp","isReadOnly":true,"isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"DATE"},"description":"When the object was created."},{"name":"updatedTimestamp","slug":"updated-timestamp","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"DATE"},"description":"When the object was most recently updated."},{"name":"version","slug":"version","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Schema version."}]},"Node":{"name":"Node","fqn":"Node","slug":"node","actions":[],"oneofProperties":{"data":[{"name":"appEmbedData","slug":"app-embed-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppEmbedData","referenceFqn":"AppEmbedData"},"description":"Data for an app embed node."},{"name":"audioData","slug":"audio-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AudioData","referenceFqn":"AudioData"},"description":"Data for an audio node."},{"name":"blockquoteData","slug":"blockquote-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BlockquoteData","referenceFqn":"BlockquoteData"},"description":"Data for a block quote node."},{"name":"bulletedListData","slug":"bulleted-list-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulletedListData","referenceFqn":"BulletedListData"},"description":"Data for a bulleted list node."},{"name":"buttonData","slug":"button-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ButtonData","referenceFqn":"ButtonData"},"description":"Data for a button node."},{"name":"captionData","slug":"caption-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CaptionData","referenceFqn":"CaptionData"},"description":"Data for a caption node."},{"name":"codeBlockData","slug":"code-block-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CodeBlockData","referenceFqn":"CodeBlockData"},"description":"Data for a code block node."},{"name":"collapsibleListData","slug":"collapsible-list-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CollapsibleListData","referenceFqn":"CollapsibleListData"},"description":"Data for a collapsible list node."},{"name":"dividerData","slug":"divider-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DividerData","referenceFqn":"DividerData"},"description":"Data for a divider node."},{"name":"embedData","slug":"embed-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EmbedData","referenceFqn":"EmbedData"},"description":"Data for an oEmbed node."},{"name":"externalData","slug":"external-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data for a custom external node."},{"name":"fileData","slug":"file-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileData","referenceFqn":"FileData"},"description":"Data for a file node."},{"name":"galleryData","slug":"gallery-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GalleryData","referenceFqn":"GalleryData"},"description":"Data for a gallery node."},{"name":"gifData","slug":"gif-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GIFData","referenceFqn":"GIFData"},"description":"Data for a GIF node."},{"name":"headingData","slug":"heading-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HeadingData","referenceFqn":"HeadingData"},"description":"Data for a heading node."},{"name":"htmlData","slug":"html-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HTMLData","referenceFqn":"HTMLData"},"description":"Data for an embedded HTML node."},{"name":"imageData","slug":"image-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ImageData","referenceFqn":"ImageData"},"description":"Data for an image node."},{"name":"layoutCellData","slug":"layout-cell-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LayoutCellData","referenceFqn":"LayoutCellData"},"description":"LayoutData layout_data = 31; // Data for a layout node. Reserved for future use."},{"name":"linkPreviewData","slug":"link-preview-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LinkPreviewData","referenceFqn":"LinkPreviewData"},"description":"Data for a link preview node."},{"name":"mapData","slug":"map-data","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"MapData","referenceFqn":"MapData"}},{"name":"orderedListData","slug":"ordered-list-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderedListData","referenceFqn":"OrderedListData"},"description":"Data for an ordered list node."},{"name":"paragraphData","slug":"paragraph-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParagraphData","referenceFqn":"ParagraphData"},"description":"Data for a paragraph node."},{"name":"pollData","slug":"poll-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PollData","referenceFqn":"PollData"},"description":"Data for a poll node."},{"name":"tableCellData","slug":"table-cell-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TableCellData","referenceFqn":"TableCellData"},"description":"Data for a table cell node."},{"name":"tableData","slug":"table-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TableData","referenceFqn":"TableData"},"description":"Data for a table node."},{"name":"textData","slug":"text-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextData","referenceFqn":"TextData"},"description":"Data for a text node. Used to apply decorations to text."},{"name":"videoData","slug":"video-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VideoData","referenceFqn":"VideoData"},"description":"Data for a video node."}]},"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Node ID."},{"name":"nodes","slug":"nodes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Node","referenceFqn":"Node"}},"description":"A list of child nodes."},{"name":"style","slug":"style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NodeStyle","referenceFqn":"NodeStyle"},"description":"Padding and background color styling for the node."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NodeType","referenceFqn":"NodeType"},"description":"Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format."}]},"AppEmbedData":{"name":"AppEmbedData","fqn":"AppEmbedData","slug":"app-embed-data","actions":[],"oneofProperties":{"appData":[{"name":"bookingData","slug":"booking-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BookingData","referenceFqn":"BookingData"},"description":"Data for embedded Wix Bookings content."},{"name":"eventData","slug":"event-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventData","referenceFqn":"EventData"},"description":"Data for embedded Wix Events content."}]},"properties":[{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"An image for the embedded content."},{"name":"imageSrc","slug":"image-src","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Deprecated: Use `image` instead."},{"name":"itemId","slug":"item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the embedded content."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the embedded content."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppType","referenceFqn":"AppType"},"description":"The type of Wix App content being embedded."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The URL for the embedded content."}]},"BookingData":{"name":"BookingData","fqn":"BookingData","slug":"booking-data","actions":[],"properties":[{"name":"durations","slug":"durations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Booking duration in minutes."}]},"EventData":{"name":"EventData","fqn":"EventData","slug":"event-data","actions":[],"properties":[{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event location."},{"name":"scheduling","slug":"scheduling","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event schedule."}]},"Media":{"name":"Media","fqn":"Media","slug":"media","actions":[],"properties":[{"name":"duration","slug":"duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Media duration in seconds. Only relevant for audio and video files."},{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Media height in pixels."},{"name":"src","slug":"src","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileSource","referenceFqn":"FileSource"},"description":"The source for the media's data."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Media width in pixels."}]},"FileSource":{"name":"FileSource","fqn":"FileSource","slug":"file-source","actions":[],"oneofProperties":{"data":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"An ID that's resolved to a URL by a resolver function."},{"name":"custom","slug":"custom","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom ID. Use `id` instead."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The absolute URL for the file's source."}]},"properties":[{"name":"private","slug":"private","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the file's source is private. Defaults to `false`."}]},"AppType":{"name":"AppType","fqn":"AppType","slug":"app-type","actions":[],"enumValues":[{"value":"BOOKING"},{"value":"EVENT"},{"value":"PRODUCT"}],"properties":[]},"AudioData":{"name":"AudioData","fqn":"AudioData","slug":"audio-data","actions":[],"properties":[{"name":"audio","slug":"audio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Audio file details."},{"name":"authorName","slug":"author-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Author name."},{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the audio node's container."},{"name":"coverImage","slug":"cover-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Cover image."},{"name":"disableDownload","slug":"disable-download","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the audio node's download button is disabled. Defaults to `false`."},{"name":"html","slug":"html","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"An HTML version of the audio node."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Track name."}]},"PluginContainerData":{"name":"PluginContainerData","fqn":"PluginContainerData","slug":"plugin-container-data","actions":[],"properties":[{"name":"alignment","slug":"alignment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerDataAlignment","referenceFqn":"PluginContainerDataAlignment"},"description":"The node's alignment within its container."},{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Height","referenceFqn":"Height"},"description":"The height of the node when it's displayed."},{"name":"spoiler","slug":"spoiler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Spoiler","referenceFqn":"Spoiler"},"description":"Spoiler cover settings for the node."},{"name":"textWrap","slug":"text-wrap","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerDataWidth","referenceFqn":"PluginContainerDataWidth"},"description":"The width of the node when it's displayed."}]},"PluginContainerDataAlignment":{"name":"PluginContainerDataAlignment","fqn":"PluginContainerDataAlignment","slug":"plugin-container-data-alignment","actions":[],"enumValues":[{"value":"CENTER","description":"Center Alignment"},{"value":"LEFT","description":"Left Alignment"},{"value":"RIGHT","description":"Right Alignment"}],"properties":[]},"Height":{"name":"Height","fqn":"Height","slug":"height","actions":[],"properties":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A custom height value in pixels."}]},"Spoiler":{"name":"Spoiler","fqn":"Spoiler","slug":"spoiler","actions":[],"properties":[{"name":"buttonText","slug":"button-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The text for the button used to remove the spoiler cover."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The description displayed on top of the spoiler cover."},{"name":"enabled","slug":"enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the spoiler cover is enabled for this node. Defaults to `false`."}]},"PluginContainerDataWidth":{"name":"PluginContainerDataWidth","fqn":"PluginContainerDataWidth","slug":"plugin-container-data-width","actions":[],"oneofProperties":{"data":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A custom width value in pixels."},{"name":"size","slug":"size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WidthType","referenceFqn":"WidthType"},"description":"One of the following predefined width options:\n`CONTENT`: The width of the container matches the content width.\n`SMALL`: A small width.\n`ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n`FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen."}]},"properties":[]},"WidthType":{"name":"WidthType","fqn":"WidthType","slug":"width-type","actions":[],"enumValues":[{"value":"CONTENT","description":"Width matches the content width"},{"value":"FULL_WIDTH","description":"coast-to-coast display"},{"value":"ORIGINAL","description":"Width will match the original asset width"},{"value":"SMALL","description":"Small Width"}],"properties":[]},"BlockquoteData":{"name":"BlockquoteData","fqn":"BlockquoteData","slug":"blockquote-data","actions":[],"properties":[{"name":"indentation","slug":"indentation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Indentation level from 1-4."}]},"BulletedListData":{"name":"BulletedListData","fqn":"BulletedListData","slug":"bulleted-list-data","actions":[],"properties":[{"name":"indentation","slug":"indentation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Indentation level from 0-4."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset level from 0-4."}]},"ButtonData":{"name":"ButtonData","fqn":"ButtonData","slug":"button-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the button's container."},{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Link","referenceFqn":"Link"},"description":"Button link details."},{"name":"styles","slug":"styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Styles","referenceFqn":"Styles"},"description":"Styling for the button."},{"name":"text","slug":"text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The text to display on the button."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"The button type."}]},"Styles":{"name":"Styles","fqn":"Styles","slug":"styles","actions":[],"properties":[{"name":"border","slug":"border","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Border","referenceFqn":"Border"},"description":"Border attributes."},{"name":"colors","slug":"colors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Colors","referenceFqn":"Colors"},"description":"Color attributes."}]},"Border":{"name":"Border","fqn":"Border","slug":"border","actions":[],"properties":[{"name":"radius","slug":"radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border radius in pixels."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border width in pixels."}]},"Colors":{"name":"Colors","fqn":"Colors","slug":"colors","actions":[],"properties":[{"name":"background","slug":"background","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The background color as a hexadecimal value."},{"name":"border","slug":"border","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The border color as a hexadecimal value."},{"name":"text","slug":"text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The text color as a hexadecimal value."}]},"Type":{"name":"Type","fqn":"Type","slug":"type","actions":[],"enumValues":[{"value":"ACTION","description":"Triggers custom action that is defined in plugin configuration by the consumer"},{"value":"LINK","description":"Regular link button"}],"properties":[]},"CaptionData":{"name":"CaptionData","fqn":"CaptionData","slug":"caption-data","actions":[],"properties":[{"name":"textStyle","slug":"text-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextStyle","referenceFqn":"TextStyle"}}]},"TextStyle":{"name":"TextStyle","fqn":"TextStyle","slug":"text-style","actions":[],"properties":[{"name":"lineHeight","slug":"line-height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px."},{"name":"textAlignment","slug":"text-alignment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextAlignment","referenceFqn":"TextAlignment"},"description":"Text alignment. Defaults to `AUTO`."}]},"TextAlignment":{"name":"TextAlignment","fqn":"TextAlignment","slug":"text-alignment","actions":[],"enumValues":[{"value":"AUTO","description":"browser default, eqivalent to `initial`"},{"value":"CENTER","description":"Center align"},{"value":"JUSTIFY","description":"Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line"},{"value":"LEFT","description":"Left align"},{"value":"RIGHT","description":"Right align"}],"properties":[]},"CodeBlockData":{"name":"CodeBlockData","fqn":"CodeBlockData","slug":"code-block-data","actions":[],"properties":[{"name":"textStyle","slug":"text-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextStyle","referenceFqn":"TextStyle"},"description":"Styling for the code block's text."}]},"CollapsibleListData":{"name":"CollapsibleListData","fqn":"CollapsibleListData","slug":"collapsible-list-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the collapsible list's container."},{"name":"direction","slug":"direction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Direction","referenceFqn":"Direction"},"description":"The direction of the text in the list. Either left-to-right or right-to-left."},{"name":"expandOnlyOne","slug":"expand-only-one","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If `true`, only one item can be expanded at a time. Defaults to `false`."},{"name":"initialExpandedItems","slug":"initial-expanded-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"InitialExpandedItems","referenceFqn":"InitialExpandedItems"},"description":"Sets which items are expanded when the page loads."},{"name":"isQapageData","slug":"is-qapage-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If `true`, The collapsible item will appear in search results as an FAQ."}]},"Direction":{"name":"Direction","fqn":"Direction","slug":"direction","actions":[],"enumValues":[{"value":"LTR","description":"Left-to-right"},{"value":"RTL","description":"Right-to-left"}],"properties":[]},"InitialExpandedItems":{"name":"InitialExpandedItems","fqn":"InitialExpandedItems","slug":"initial-expanded-items","actions":[],"enumValues":[{"value":"ALL","description":"All items will expended initally"},{"value":"FIRST","description":"First item will be expended initally"},{"value":"NONE","description":"All items collapsed initally"}],"properties":[]},"DividerData":{"name":"DividerData","fqn":"DividerData","slug":"divider-data","actions":[],"properties":[{"name":"alignment","slug":"alignment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Alignment","referenceFqn":"Alignment"},"description":"Divider alignment."},{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the divider's container."},{"name":"lineStyle","slug":"line-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineStyle","referenceFqn":"LineStyle"},"description":"Divider line style."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Width","referenceFqn":"Width"},"description":"Divider width."}]},"Alignment":{"name":"Alignment","fqn":"Alignment","slug":"alignment","actions":[],"enumValues":[{"value":"CENTER","description":"Center alignment"},{"value":"LEFT","description":"Left alignment"},{"value":"RIGHT","description":"Right alignment"}],"properties":[]},"LineStyle":{"name":"LineStyle","fqn":"LineStyle","slug":"line-style","actions":[],"enumValues":[{"value":"DASHED","description":"Dashed Line"},{"value":"DOTTED","description":"Dotted Line"},{"value":"DOUBLE","description":"Double Line"},{"value":"SINGLE","description":"Single Line"}],"properties":[]},"Width":{"name":"Width","fqn":"Width","slug":"width","actions":[],"enumValues":[{"value":"LARGE","description":"Large line"},{"value":"MEDIUM","description":"Medium line"},{"value":"SMALL","description":"Small line"}],"properties":[]},"EmbedData":{"name":"EmbedData","fqn":"EmbedData","slug":"embed-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the oEmbed node's container."},{"name":"oembed","slug":"oembed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Oembed","referenceFqn":"Oembed"},"description":"An [oEmbed](https://www.oembed.com) object."},{"name":"src","slug":"src","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Origin asset source."}]},"Oembed":{"name":"Oembed","fqn":"Oembed","slug":"oembed","actions":[],"properties":[{"name":"authorName","slug":"author-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the author or owner of the resource."},{"name":"authorUrl","slug":"author-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The URL for the author or owner of the resource."},{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The height of the resource specified in the `url` property in pixels."},{"name":"html","slug":"html","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HTML for embedding a video player. The HTML should have no padding or margins."},{"name":"providerName","slug":"provider-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the resource provider."},{"name":"providerUrl","slug":"provider-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The URL for the resource provider."},{"name":"thumbnailHeight","slug":"thumbnail-height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined."},{"name":"thumbnailUrl","slug":"thumbnail-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined."},{"name":"thumbnailWidth","slug":"thumbnail-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Resource title."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The resource type."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The source URL for the resource."},{"name":"version","slug":"version","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The oEmbed version number. This value must be `1.0`."},{"name":"videoUrl","slug":"video-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The URL for an embedded viedo."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The width of the resource specified in the `url` property in pixels."}]},"FileData":{"name":"FileData","fqn":"FileData","slug":"file-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the file's container."},{"name":"mimeType","slug":"mime-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File MIME type."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File name."},{"name":"path","slug":"path","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File path."},{"name":"pdfSettings","slug":"pdf-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PDFSettings","referenceFqn":"PDFSettings"},"description":"Settings for PDF files."},{"name":"size","slug":"size","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"number"},"description":"Use `sizeInKb` instead."},{"name":"sizeInKb","slug":"size-in-kb","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File size in KB."},{"name":"src","slug":"src","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileSource","referenceFqn":"FileSource"},"description":"The source for the file's data."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"File type."}]},"PDFSettings":{"name":"PDFSettings","fqn":"PDFSettings","slug":"pdfsettings","actions":[],"properties":[{"name":"disableDownload","slug":"disable-download","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the PDF download button is disabled. Defaults to `false`."},{"name":"disablePrint","slug":"disable-print","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the PDF print button is disabled. Defaults to `false`."},{"name":"viewMode","slug":"view-mode","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ViewMode","referenceFqn":"ViewMode"},"description":"PDF view mode. One of the following:\n`NONE` : The PDF isn't displayed.\n`FULL` : A full page view of the PDF is displayed.\n`MINI` : A mini view of the PDF is displayed."}]},"ViewMode":{"name":"ViewMode","fqn":"ViewMode","slug":"view-mode","actions":[],"enumValues":[{"value":"FULL","description":"Full PDF view"},{"value":"MINI","description":"Mini PDF view"},{"value":"NONE","description":"No PDF view"}],"properties":[]},"GalleryData":{"name":"GalleryData","fqn":"GalleryData","slug":"gallery-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the gallery's container."},{"name":"disableDownload","slug":"disable-download","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the gallery's download button is disabled. Defaults to `false`."},{"name":"disableExpand","slug":"disable-expand","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the gallery's expand button is disabled. Defaults to `false`."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Item","referenceFqn":"Item"}},"description":"The items in the gallery."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GalleryOptions","referenceFqn":"GalleryOptions"},"description":"Options for defining the gallery's appearance."}]},"Item":{"name":"Item","fqn":"Item","slug":"item","actions":[],"oneofProperties":{"data":[{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Image","referenceFqn":"Image"},"description":"An image item."},{"name":"video","slug":"video","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Video","referenceFqn":"Video"},"description":"A video item."}]},"properties":[{"name":"altText","slug":"alt-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item's alternative text."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item title."}]},"Image":{"name":"Image","fqn":"Image","slug":"image","actions":[],"properties":[{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Link","referenceFqn":"Link"},"description":"Link details for images that are links."},{"name":"media","slug":"media","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Image file details."}]},"Video":{"name":"Video","fqn":"Video","slug":"video","actions":[],"properties":[{"name":"media","slug":"media","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Video file details."},{"name":"thumbnail","slug":"thumbnail","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Video thumbnail file details."}]},"GalleryOptions":{"name":"GalleryOptions","fqn":"GalleryOptions","slug":"gallery-options","actions":[],"properties":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemStyle","referenceFqn":"ItemStyle"},"description":"Styling for gallery items."},{"name":"layout","slug":"layout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Layout","referenceFqn":"Layout"},"description":"Gallery layout."},{"name":"thumbnails","slug":"thumbnails","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Thumbnails","referenceFqn":"Thumbnails"},"description":"Styling for gallery thumbnail images."}]},"ItemStyle":{"name":"ItemStyle","fqn":"ItemStyle","slug":"item-style","actions":[],"properties":[{"name":"crop","slug":"crop","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Crop","referenceFqn":"Crop"},"description":"Sets how item images are cropped."},{"name":"ratio","slug":"ratio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item ratio"},{"name":"spacing","slug":"spacing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The spacing between items in pixels."},{"name":"targetSize","slug":"target-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Desirable dimension for each item in pixels (behvaior changes according to gallery type)"}]},"Crop":{"name":"Crop","fqn":"Crop","slug":"crop","actions":[],"enumValues":[{"value":"FILL","description":"Crop to fill"},{"value":"FIT","description":"Crop to fit"}],"properties":[]},"Layout":{"name":"Layout","fqn":"Layout","slug":"layout","actions":[],"properties":[{"name":"horizontalScroll","slug":"horizontal-scroll","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`."},{"name":"mobileNumberOfColumns","slug":"mobile-number-of-columns","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of columns to display on mobile screens."},{"name":"numberOfColumns","slug":"number-of-columns","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of columns to display on full size screens."},{"name":"orientation","slug":"orientation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Orientation","referenceFqn":"Orientation"},"description":"Gallery orientation."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LayoutType","referenceFqn":"LayoutType"},"description":"Gallery layout type."}]},"Orientation":{"name":"Orientation","fqn":"Orientation","slug":"orientation","actions":[],"enumValues":[{"value":"COLUMNS","description":"Columns Orientation"},{"value":"ROWS","description":"Rows Orientation"}],"properties":[]},"LayoutType":{"name":"LayoutType","fqn":"LayoutType","slug":"layout-type","actions":[],"enumValues":[{"value":"COLLAGE","description":"Collage type"},{"value":"COLUMN","description":"Column type"},{"value":"FULLSIZE","description":"Fullsize images type"},{"value":"GRID","description":"Grid type"},{"value":"MAGIC","description":"Magic type"},{"value":"MASONRY","description":"Masonry type"},{"value":"PANORAMA","description":"Panorama type"},{"value":"SLIDER","description":"Slider type"},{"value":"SLIDESHOW","description":"Slideshow type"},{"value":"THUMBNAIL","description":"Thumbnail type"}],"properties":[]},"Thumbnails":{"name":"Thumbnails","fqn":"Thumbnails","slug":"thumbnails","actions":[],"properties":[{"name":"placement","slug":"placement","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ThumbnailsAlignment","referenceFqn":"ThumbnailsAlignment"},"description":"Thumbnail alignment."},{"name":"spacing","slug":"spacing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Spacing between thumbnails in pixels."}]},"ThumbnailsAlignment":{"name":"ThumbnailsAlignment","fqn":"ThumbnailsAlignment","slug":"thumbnails-alignment","actions":[],"enumValues":[{"value":"BOTTOM","description":"Bottom alignment"},{"value":"LEFT","description":"Left alignment"},{"value":"NONE","description":"No thumbnail"},{"value":"RIGHT","description":"Right alignment"},{"value":"TOP","description":"Top alignment"}],"properties":[]},"GIFData":{"name":"GIFData","fqn":"GIFData","slug":"gifdata","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the GIF's container."},{"name":"downsized","slug":"downsized","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GIF","referenceFqn":"GIF"},"description":"The source of the downsized GIF."},{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Height in pixels."},{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GIF","referenceFqn":"GIF"},"description":"The source of the full size GIF."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Width in pixels."}]},"GIF":{"name":"GIF","fqn":"GIF","slug":"gif","actions":[],"properties":[{"name":"gif","slug":"gif","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"GIF format URL."},{"name":"mp4","slug":"mp4","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"MP4 format URL."},{"name":"still","slug":"still","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Thumbnail URL."}]},"HeadingData":{"name":"HeadingData","fqn":"HeadingData","slug":"heading-data","actions":[],"properties":[{"name":"indentation","slug":"indentation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Indentation level from 1-4."},{"name":"level","slug":"level","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Heading level from 1-6."},{"name":"textStyle","slug":"text-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextStyle","referenceFqn":"TextStyle"},"description":"Styling for the heading text."}]},"HTMLData":{"name":"HTMLData","fqn":"HTMLData","slug":"htmldata","actions":[],"oneofProperties":{"data":[{"name":"html","slug":"html","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The HTML code for the node."},{"name":"isAdsense","slug":"is-adsense","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this is an AdSense element. Use `source` instead."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The URL for the HTML code for the node."}]},"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the HTML node's container."},{"name":"source","slug":"source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Source","referenceFqn":"Source"},"description":"The type of HTML code."}]},"Source":{"name":"Source","fqn":"Source","slug":"source","actions":[],"enumValues":[{"value":"ADSENSE"},{"value":"HTML"}],"properties":[]},"ImageData":{"name":"ImageData","fqn":"ImageData","slug":"image-data","actions":[],"properties":[{"name":"altText","slug":"alt-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Image's alternative text."},{"name":"caption","slug":"caption","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Deprecated: use Caption node instead."},{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the image's container."},{"name":"disableDownload","slug":"disable-download","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the image's download button is disabled. Defaults to `false`."},{"name":"disableExpand","slug":"disable-expand","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the image expands to full screen when clicked. Defaults to `false`."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Image file details."},{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Link","referenceFqn":"Link"},"description":"Link details for images that are links."}]},"LayoutCellData":{"name":"LayoutCellData","fqn":"LayoutCellData","slug":"layout-cell-data","actions":[],"properties":[{"name":"colSpan","slug":"col-span","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Size of the cell in 12 columns grid."}]},"LinkPreviewData":{"name":"LinkPreviewData","fqn":"LinkPreviewData","slug":"link-preview-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the link preview's container."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Preview description."},{"name":"html","slug":"html","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The preview content as HTML."},{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Link","referenceFqn":"Link"},"description":"Link details."},{"name":"thumbnailUrl","slug":"thumbnail-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Preview thumbnail URL."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Preview title."}]},"MapData":{"name":"MapData","fqn":"MapData","slug":"map-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the map's container."},{"name":"mapSettings","slug":"map-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MapSettings","referenceFqn":"MapSettings"},"description":"Map settings."}]},"MapSettings":{"name":"MapSettings","fqn":"MapSettings","slug":"map-settings","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The address to display on the map."},{"name":"draggable","slug":"draggable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the map is draggable."},{"name":"initialZoom","slug":"initial-zoom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Initial zoom value."},{"name":"lat","slug":"lat","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Location latitude."},{"name":"lng","slug":"lng","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Location longitude."},{"name":"locationName","slug":"location-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location name."},{"name":"mapType","slug":"map-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MapType","referenceFqn":"MapType"},"description":"Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types."},{"name":"marker","slug":"marker","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the location marker is visible."},{"name":"streetViewControl","slug":"street-view-control","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether street view control is enabled."},{"name":"viewModeControl","slug":"view-mode-control","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether view mode control is enabled."},{"name":"zoomControl","slug":"zoom-control","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether zoom control is enabled."}]},"MapType":{"name":"MapType","fqn":"MapType","slug":"map-type","actions":[],"enumValues":[{"value":"HYBRID","description":"Hybrid map type"},{"value":"ROADMAP","description":"Roadmap map type"},{"value":"SATELITE","description":"Satellite map type"},{"value":"TERRAIN","description":"Terrain map type"}],"properties":[]},"OrderedListData":{"name":"OrderedListData","fqn":"OrderedListData","slug":"ordered-list-data","actions":[],"properties":[{"name":"indentation","slug":"indentation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Indentation level from 0-4."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset level from 0-4."},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"List start number."}]},"ParagraphData":{"name":"ParagraphData","fqn":"ParagraphData","slug":"paragraph-data","actions":[],"properties":[{"name":"indentation","slug":"indentation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Indentation level from 1-4."},{"name":"level","slug":"level","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Paragraph level"},{"name":"textStyle","slug":"text-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TextStyle","referenceFqn":"TextStyle"},"description":"Styling for the paragraph text."}]},"PollData":{"name":"PollData","fqn":"PollData","slug":"poll-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the poll's container."},{"name":"design","slug":"design","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Design","referenceFqn":"Design"},"description":"Styling for the poll and voting options."},{"name":"layout","slug":"layout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PollDataLayout","referenceFqn":"PollDataLayout"},"description":"Layout settings for the poll and voting options."},{"name":"poll","slug":"poll","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Poll","referenceFqn":"Poll"},"description":"Poll data."}]},"Design":{"name":"Design","fqn":"Design","slug":"design","actions":[],"properties":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OptionDesign","referenceFqn":"OptionDesign"},"description":"Styling for voting options."},{"name":"poll","slug":"poll","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PollDesign","referenceFqn":"PollDesign"},"description":"Styling for the poll."}]},"OptionDesign":{"name":"OptionDesign","fqn":"OptionDesign","slug":"option-design","actions":[],"properties":[{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border radius in pixels."}]},"PollDesign":{"name":"PollDesign","fqn":"PollDesign","slug":"poll-design","actions":[],"properties":[{"name":"background","slug":"background","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Background","referenceFqn":"Background"},"description":"Background styling."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border radius in pixels."}]},"Background":{"name":"Background","fqn":"Background","slug":"background","actions":[],"oneofProperties":{"background":[{"name":"color","slug":"color","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The background color as a hexademical value."},{"name":"gradient","slug":"gradient","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Gradient","referenceFqn":"Gradient"},"description":"Details for a gradient background."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"An image to use for the background."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackgroundType","referenceFqn":"BackgroundType"},"description":"Background type. For each option, include the relevant details."}]},"Gradient":{"name":"Gradient","fqn":"Gradient","slug":"gradient","actions":[],"properties":[{"name":"angle","slug":"angle","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The gradient angle in degrees."},{"name":"lastColor","slug":"last-color","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The end color as a hexademical value."},{"name":"startColor","slug":"start-color","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The start color as a hexademical value."}]},"BackgroundType":{"name":"BackgroundType","fqn":"BackgroundType","slug":"background-type","actions":[],"enumValues":[{"value":"COLOR","description":"Color background type"},{"value":"GRADIENT","description":"Gradiant background type"},{"value":"IMAGE","description":"Image background type"}],"properties":[]},"PollDataLayout":{"name":"PollDataLayout","fqn":"PollDataLayout","slug":"poll-data-layout","actions":[],"properties":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OptionLayout","referenceFqn":"OptionLayout"},"description":"Voting otpions layout settings."},{"name":"poll","slug":"poll","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PollLayout","referenceFqn":"PollLayout"},"description":"Poll layout settings."}]},"OptionLayout":{"name":"OptionLayout","fqn":"OptionLayout","slug":"option-layout","actions":[],"properties":[{"name":"enableImage","slug":"enable-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether to display option images. Defaults to `false`."}]},"PollLayout":{"name":"PollLayout","fqn":"PollLayout","slug":"poll-layout","actions":[],"properties":[{"name":"direction","slug":"direction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PollLayoutDirection","referenceFqn":"PollLayoutDirection"},"description":"The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right."},{"name":"enableImage","slug":"enable-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether to display the main poll image. Defaults to `false`."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PollLayoutType","referenceFqn":"PollLayoutType"},"description":"The layout for displaying the voting options."}]},"PollLayoutDirection":{"name":"PollLayoutDirection","fqn":"PollLayoutDirection","slug":"poll-layout-direction","actions":[],"enumValues":[{"value":"LTR","description":"Left-to-right"},{"value":"RTL","description":"Right-to-left"}],"properties":[]},"PollLayoutType":{"name":"PollLayoutType","fqn":"PollLayoutType","slug":"poll-layout-type","actions":[],"enumValues":[{"value":"GRID","description":"Grid"},{"value":"LIST","description":"List"}],"properties":[]},"Poll":{"name":"Poll","fqn":"Poll","slug":"poll","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Poll ID."},{"name":"creatorId","slug":"creator-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Poll creator ID."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Main poll image."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Option","referenceFqn":"Option"}},"description":"Voting options."},{"name":"settings","slug":"settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Settings","referenceFqn":"Settings"},"description":"The poll's permissions and display settings."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Poll title."}]},"Option":{"name":"Option","fqn":"Option","slug":"option","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Option ID."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"The image displayed with the option."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Option title."}]},"Settings":{"name":"Settings","fqn":"Settings","slug":"settings","actions":[],"properties":[{"name":"permissions","slug":"permissions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Permissions","referenceFqn":"Permissions"},"description":"Permissions settings for voting."},{"name":"showVoters","slug":"show-voters","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether voters are displayed in the vote results. Defaults to `true`."},{"name":"showVotesCount","slug":"show-votes-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the vote count is displayed. Defaults to `true`."}]},"Permissions":{"name":"Permissions","fqn":"Permissions","slug":"permissions","actions":[],"properties":[{"name":"allowMultipleVotes","slug":"allow-multiple-votes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether one voter can vote multiple times. Defaults to `false`."},{"name":"view","slug":"view","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ViewRole","referenceFqn":"ViewRole"},"description":"Sets who can view the poll results."},{"name":"vote","slug":"vote","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VoteRole","referenceFqn":"VoteRole"},"description":"Sets who can vote."}]},"ViewRole":{"name":"ViewRole","fqn":"ViewRole","slug":"view-role","actions":[],"enumValues":[{"value":"CREATOR","description":"Only Poll creator can view the results"},{"value":"EVERYONE","description":"Anyone can see the results, even if one didn't vote"},{"value":"VOTERS","description":"Anyone who voted can see the results"}],"properties":[]},"VoteRole":{"name":"VoteRole","fqn":"VoteRole","slug":"vote-role","actions":[],"enumValues":[{"value":"ALL","description":"Anyone"},{"value":"SITE_MEMBERS","description":"Logged in member"}],"properties":[]},"TableCellData":{"name":"TableCellData","fqn":"TableCellData","slug":"table-cell-data","actions":[],"properties":[{"name":"borderColors","slug":"border-colors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BorderColors","referenceFqn":"BorderColors"},"description":"The cell's border colors."},{"name":"cellStyle","slug":"cell-style","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CellStyle","referenceFqn":"CellStyle"},"description":"Styling for the cell's background color and text alignment."}]},"BorderColors":{"name":"BorderColors","fqn":"BorderColors","slug":"border-colors","actions":[],"properties":[{"name":"bottom","slug":"bottom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Bottom border color as a hexadecimal value."},{"name":"left","slug":"left","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Left border color as a hexadecimal value."},{"name":"right","slug":"right","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Right border color as a hexadecimal value."},{"name":"top","slug":"top","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Top border color as a hexadecimal value."}]},"CellStyle":{"name":"CellStyle","fqn":"CellStyle","slug":"cell-style","actions":[],"properties":[{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cell background color as a hexadecimal value."},{"name":"verticalAlignment","slug":"vertical-alignment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VerticalAlignment","referenceFqn":"VerticalAlignment"},"description":"Vertical alignment for the cell's text."}]},"VerticalAlignment":{"name":"VerticalAlignment","fqn":"VerticalAlignment","slug":"vertical-alignment","actions":[],"enumValues":[{"value":"BOTTOM","description":"Bottom alignment"},{"value":"MIDDLE","description":"Middle alignment"},{"value":"TOP","description":"Top alignment"}],"properties":[]},"TableData":{"name":"TableData","fqn":"TableData","slug":"table-data","actions":[],"properties":[{"name":"columnHeader","slug":"column-header","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the table's first column is a header. Defaults to `false`."},{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the table's container."},{"name":"dimensions","slug":"dimensions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Dimensions","referenceFqn":"Dimensions"},"description":"The table's dimensions."},{"name":"header","slug":"header","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Deprecated: Use `rowHeader` and `columnHeader` instead."},{"name":"rowHeader","slug":"row-header","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the table's first row is a header. Defaults to `false`."}]},"Dimensions":{"name":"Dimensions","fqn":"Dimensions","slug":"dimensions","actions":[],"properties":[{"name":"colsMinWidth","slug":"cols-min-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"number"}},"description":"An array representing the minimum width of each column in pixels."},{"name":"colsWidthRatio","slug":"cols-width-ratio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"number"}},"description":"An array representing relative width of each column in relation to the other columns."},{"name":"rowsHeight","slug":"rows-height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"number"}},"description":"An array representing the height of each row in pixels."}]},"TextData":{"name":"TextData","fqn":"TextData","slug":"text-data","actions":[],"properties":[{"name":"decorations","slug":"decorations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Decoration","referenceFqn":"Decoration"}},"description":"The decorations to apply."},{"name":"text","slug":"text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The text to apply decorations to."}]},"NodeType":{"name":"NodeType","fqn":"NodeType","slug":"node-type","actions":[],"enumValues":[{"value":"APP_EMBED"},{"value":"AUDIO"},{"value":"BLOCKQUOTE"},{"value":"BULLETED_LIST"},{"value":"BUTTON"},{"value":"CAPTION"},{"value":"CODE_BLOCK"},{"value":"COLLAPSIBLE_ITEM"},{"value":"COLLAPSIBLE_ITEM_BODY"},{"value":"COLLAPSIBLE_ITEM_TITLE"},{"value":"COLLAPSIBLE_LIST"},{"value":"DIVIDER"},{"value":"EMBED"},{"value":"EXTERNAL"},{"value":"FILE"},{"value":"GALLERY"},{"value":"GIF"},{"value":"HEADING"},{"value":"HTML"},{"value":"IMAGE"},{"value":"LAYOUT"},{"value":"LAYOUT_CELL"},{"value":"LINK_PREVIEW"},{"value":"LIST_ITEM"},{"value":"MAP"},{"value":"ORDERED_LIST"},{"value":"PARAGRAPH"},{"value":"POLL"},{"value":"TABLE"},{"value":"TABLE_CELL"},{"value":"TABLE_ROW"},{"value":"TEXT"},{"value":"VIDEO"}],"properties":[]},"VideoData":{"name":"VideoData","fqn":"VideoData","slug":"video-data","actions":[],"properties":[{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the video's container."},{"name":"disableDownload","slug":"disable-download","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the video's download button is disabled. Defaults to `false`."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PlaybackOptions","referenceFqn":"PlaybackOptions"},"description":"Video options."},{"name":"thumbnail","slug":"thumbnail","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Video thumbnail details."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Video title."},{"name":"video","slug":"video","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Media","referenceFqn":"Media"},"description":"Video details."}]},"PlaybackOptions":{"name":"PlaybackOptions","fqn":"PlaybackOptions","slug":"playback-options","actions":[],"properties":[{"name":"autoPlay","slug":"auto-play","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the media will automatically start playing."},{"name":"playInLoop","slug":"play-in-loop","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether media's will be looped."},{"name":"showControls","slug":"show-controls","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether media's controls will be shown."}]},"ParentComment":{"name":"ParentComment","fqn":"ParentComment","slug":"parent-comment","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Comment ID of the parent comment."},{"name":"author","slug":"author","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentAuthor","referenceFqn":"CommentAuthor"},"description":"Author of the parent comment."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Parent comment status."}]},"Status":{"name":"Status","fqn":"Status","slug":"status","actions":[],"enumValues":[{"value":"DELETED","description":"This comment is deleted."},{"value":"HIDDEN","description":"This comment has been hidden by a site moderator."},{"value":"PENDING","description":"This comment is pending moderation. Moderation is not currently supported."},{"value":"PUBLISHED","description":"This comment is published and publicly visible."},{"value":"UNKNOWN","description":"Unknown status."}],"properties":[]},"CommentReactionSummary":{"name":"CommentReactionSummary","fqn":"CommentReactionSummary","slug":"comment-reaction-summary","actions":[],"properties":[{"name":"reactionCodeCount","slug":"reaction-code-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"number"}},"description":"Number of each type of reaction. `key` is the code for a reaction type and\n`value` is the amount of that reaction type."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total amount of reactions."}]},"VoteSummary":{"name":"VoteSummary","fqn":"VoteSummary","slug":"vote-summary","actions":[],"properties":[{"name":"downvoteCount","slug":"downvote-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of downvotes on this comment."},{"name":"netVoteCount","slug":"net-vote-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of upvotes less downvotes on this comment."},{"name":"upvoteCount","slug":"upvote-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of upvotes on this comment."}]},"CreateCommentOptions":{"name":"CreateCommentOptions","fqn":"CreateCommentOptions","slug":"create-comment-options","actions":[],"properties":[]},"ContactDetails":{"name":"ContactDetails","fqn":"ContactDetails","slug":"contact-details","actions":[],"properties":[]},"DeleteCommentOptions":{"name":"DeleteCommentOptions","fqn":"DeleteCommentOptions","slug":"delete-comment-options","actions":[],"properties":[]},"GetCommentThreadOptions":{"name":"GetCommentThreadOptions","fqn":"GetCommentThreadOptions","slug":"get-comment-thread-options","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"App ID.","replacedBy":"","targetRemovalDate":"2024-11-01"},"type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID."},{"name":"commentSort","slug":"comment-sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentSort","referenceFqn":"CommentSort"},"description":"Comment sorting."},{"name":"replySort","slug":"reply-sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReplySort","referenceFqn":"ReplySort"},"description":"Reply sorting."}]},"CommentSort":{"name":"CommentSort","fqn":"CommentSort","slug":"comment-sort","actions":[],"properties":[{"name":"keepMarkedInOriginalOrder","slug":"keep-marked-in-original-order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If set to `true`, marked comments appear in the original order, and not at the top of the list.\n\nDefault: `false`. This means that marked comments are prioritized and listed first."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"Order"},"description":"Sort order."}]},"Order":{"name":"Order","fqn":"Order","slug":"order","actions":[],"enumValues":[{"value":"NET_VOTE_COUNT","description":"Comments with the highest vote count appear at the top of the list."},{"value":"NET_VOTE_COUNT_ASC","description":"Comments with the lowest vote count appear at the top of the list."},{"value":"NEWEST_FIRST","description":"Newest comments appear at the top of the list."},{"value":"OLDEST_FIRST","description":"Oldest comments appear at the top of the list."},{"value":"RATING","description":"Comments with the highest rating appear at the top of the list."},{"value":"RATING_ASC","description":"Comments with the lowest rating appear at the top of the list."},{"value":"REACTION_COUNT","description":"Comments with the highest reaction count appear at the top of the list."},{"value":"UNKNOWN_ORDER","description":"Unknown order."}],"properties":[]},"ReplySort":{"name":"ReplySort","fqn":"ReplySort","slug":"reply-sort","actions":[],"properties":[{"name":"keepMarkedInOriginalOrder","slug":"keep-marked-in-original-order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the marked comments are listed in the original order.\n\nIf set to `true`, marked comments appear in the original order, and not at the top of the list.\n\nDefault: `false`. In this case marked comments are prioritized and listed first."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReplySortOrder","referenceFqn":"ReplySortOrder"},"description":"Sort order."}]},"ReplySortOrder":{"name":"ReplySortOrder","fqn":"ReplySortOrder","slug":"reply-sort-order","actions":[],"enumValues":[{"value":"NEWEST_FIRST","description":"Newest comments appear at the top of the list."},{"value":"OLDEST_FIRST","description":"Oldest comments appear at the top of the list."},{"value":"REACTION_COUNT","description":"Comments with the highest reaction count appear at the top of the list."},{"value":"UNKNOWN_ORDER","description":"Unknown order."}],"properties":[]},"GetCommentThreadResponse":{"name":"GetCommentThreadResponse","fqn":"GetCommentThreadResponse","slug":"get-comment-thread-response","actions":[],"properties":[{"name":"commentReplies","slug":"comment-replies","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"REFERENCE","name":"RepliesListResponse","referenceFqn":"RepliesListResponse"}},"description":"Retrieved replies of a reply."},{"name":"comments","slug":"comments","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"}},"description":"Retrieved replies."},{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPagingMetadata","referenceFqn":"CursorPagingMetadata"},"description":"Paging metadata."}]},"RepliesListResponse":{"name":"RepliesListResponse","fqn":"RepliesListResponse","slug":"replies-list-response","actions":[],"properties":[{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPagingMetadata","referenceFqn":"CursorPagingMetadata"},"description":"Paging metadata."},{"name":"replies","slug":"replies","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"}},"description":"Listed comment replies."}]},"CursorPagingMetadata":{"name":"CursorPagingMetadata","fqn":"CursorPagingMetadata","slug":"cursor-paging-metadata","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in current page."},{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Cursor strings that point to the next page, previous page, or both."},{"name":"hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"HideCommentResponse":{"name":"HideCommentResponse","fqn":"HideCommentResponse","slug":"hide-comment-response","actions":[],"properties":[{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Hidden comment."}]},"ListCommentsByResourceOptions":{"name":"ListCommentsByResourceOptions","fqn":"ListCommentsByResourceOptions","slug":"list-comments-by-resource-options","actions":[],"properties":[{"name":"commentSort","slug":"comment-sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentSort","referenceFqn":"CommentSort"},"description":"Comment sort. Is ignored if `cursorPaging.cursor` is defined."},{"name":"contextId","slug":"context-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the specific context the comment is in response to.\n\nWithin some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum, the `forumPostId` is used as both the `contextId` and the `resourceId`."},{"name":"contextType","slug":"context-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reserved for internal use."},{"name":"cursorPaging","slug":"cursor-paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListCommentsByResourceCursorPaging","referenceFqn":"ListCommentsByResourceCursorPaging"},"description":"Cursor paging."},{"name":"replySort","slug":"reply-sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReplySort","referenceFqn":"ReplySort"},"description":"Reply sort. Is ignored if `cursorPaging.cursor` is defined."},{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the specific resource that the comment is in response to.\n\nWithin some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum, the `forumPostId` is used as both the `resourceId` and the `contextId`."}]},"ListCommentsByResourceCursorPaging":{"name":"ListCommentsByResourceCursorPaging","fqn":"ListCommentsByResourceCursorPaging","slug":"list-comments-by-resource-cursor-paging","actions":[],"properties":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Pointer to the next or previous page in the list of results."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return."},{"name":"repliesLimit","slug":"replies-limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of replies in a response. Only applicable to parent comments."}]},"ListCommentsByResourceResponse":{"name":"ListCommentsByResourceResponse","fqn":"ListCommentsByResourceResponse","slug":"list-comments-by-resource-response","actions":[],"properties":[{"name":"commentReplies","slug":"comment-replies","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"REFERENCE","name":"RepliesListResponse","referenceFqn":"RepliesListResponse"}},"description":"Listed comment replies."},{"name":"comments","slug":"comments","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"}},"description":"Listed comments."},{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPagingMetadata","referenceFqn":"CursorPagingMetadata"},"description":"Paging metadata."}]},"MarkCommentOptions":{"name":"MarkCommentOptions","fqn":"MarkCommentOptions","slug":"mark-comment-options","actions":[],"properties":[]},"MarkCommentResponse":{"name":"MarkCommentResponse","fqn":"MarkCommentResponse","slug":"mark-comment-response","actions":[],"properties":[{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Marked comment."}]},"ModerateDraftContentOptions":{"name":"ModerateDraftContentOptions","fqn":"ModerateDraftContentOptions","slug":"moderate-draft-content-options","actions":[],"properties":[{"name":"draftContentAction","slug":"draft-content-action","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Action","referenceFqn":"Action"},"description":"Draft content action."}]},"ModerateDraftContentResponse":{"name":"ModerateDraftContentResponse","fqn":"ModerateDraftContentResponse","slug":"moderate-draft-content-response","actions":[],"properties":[{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Moderated comment."}]},"PublishCommentResponse":{"name":"PublishCommentResponse","fqn":"PublishCommentResponse","slug":"publish-comment-response","actions":[],"properties":[{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Published comment."}]},"CommentsQueryBuilder":{"name":"CommentsQueryBuilder","fqn":"CommentsQueryBuilder","slug":"comments-query-builder","actions":[{"name":"ascending","fqn":"CommentsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = comments.queryComments().ascending('replyCount');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().ascending('replyCount').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `CommentsQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.","sdkErrors":[]},{"name":"descending","fqn":"CommentsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = comments.queryComments().descending('marked');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().descending('marked').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `CommentsQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.","sdkErrors":[]},{"name":"eq","fqn":"CommentsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = comments.queryComments().eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments\n .queryComments()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `CommentsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.","sdkErrors":[]},{"name":"find","fqn":"CommentsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CommentsQueryResult","referenceFqn":"CommentsQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = comments.queryComments().find();\n"},{"title":"Perform a `find` on a query","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.","sdkErrors":[]},{"name":"ge","fqn":"CommentsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = comments.queryComments().ge('total', 1212);\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().ge('total', 1212).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than or equal to the specified value.\n\nThe `ge()` function refines a `CommentsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.","sdkErrors":[]},{"name":"gt","fqn":"CommentsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = comments.queryComments().gt('replyCount', 1212);\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().gt('replyCount', 1212).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than the specified value.\n\nThe `gt()` function refines a `CommentsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.","sdkErrors":[]},{"name":"in","fqn":"CommentsQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = comments\n .queryComments()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple']);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments\n .queryComments()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property contains any of the values in the provided array of values.\n\nThe `in()` function refines a `CommentsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.","sdkErrors":[]},{"name":"le","fqn":"CommentsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = comments.queryComments().le('total', 1212);\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().le('total', 1212).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than or equal to the specified value.\n\nThe `le()` function refines a `CommentsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`.","sdkErrors":[]},{"name":"limit","fqn":"CommentsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = comments.queryComments().limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = comments.queryComments().limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result.","sdkErrors":[]},{"name":"lt","fqn":"CommentsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = comments.queryComments().lt('replyCount', 1212);\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().lt('replyCount', 1212).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than the specified value.\n\nThe `le()` function refines a `CommentsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`.","sdkErrors":[]},{"name":"ne","fqn":"CommentsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = comments\n .queryComments()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da');\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments\n .queryComments()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `CommentsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.","sdkErrors":[]},{"name":"skipTo","fqn":"CommentsQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n const nextCursor = results.cursors.next;\n return comments.queryComments().skipTo(nextCursor).find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n const prevCursor = results.cursors.prev;\n return comments.queryComments().skipTo(prevCursor).find();\n}\n"}],"actionParams":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A pointer to specific record"}],"description":"Refines a query that skips to a specific record.\n\nThe `skipTo()` function refines a `CommentsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.\n \nWhen using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed.","sdkErrors":[]}],"properties":[]},"CommentsQueryResult":{"name":"CommentsQueryResult","fqn":"CommentsQueryResult","slug":"comments-query-result","actions":[{"name":"hasNext","fqn":"CommentsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `comments` to navigate the pages of a query result.","sdkErrors":[]},{"name":"hasPrev","fqn":"CommentsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `comments` to navigate the pages of a query result.","sdkErrors":[]},{"name":"next","fqn":"CommentsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CommentsQueryResult","referenceFqn":"CommentsQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await comments.queryComments().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](/comments-query-builder/limit) function and can be retrieved using the [`pageSize`](/comments-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `comments` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `CommentsQueryBuilder` may change.","sdkErrors":[]},{"name":"prev","fqn":"CommentsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CommentsQueryResult","referenceFqn":"CommentsQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](/comments-query-builder/limit) function and can be retrieved using the [`pageSize`](/comments-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `comments` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change.","sdkErrors":[]}],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's cursors","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n const cursors = results.cursors;\n}\n"}],"type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Returns the query cursors.\n\n`cursors` returns the query's `next` and `prev` cursors."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"}},"description":"Returns an array of `comments` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](/comments-query-builder/limit) function and can be retrieved using the [`pageSize`](/comments-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `comments` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](/comments-query-result/total-count).\nThe page size is defined by the [`limit()`](/comments-query-builder/limit) function and can be retrieved using the [`pageSize`](/comments-query-result/page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `comments` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](/comments-query-builder/limit) in `CommentsQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { comments } from 'wix-comments.v2';\n\nexport async function myQueryFunction() {\n const results = await comments.queryComments().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"description":"Returns the `CommentsQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `CommentsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `CommentsQueryBuilder`."}]},"UnmarkCommentOptions":{"name":"UnmarkCommentOptions","fqn":"UnmarkCommentOptions","slug":"unmark-comment-options","actions":[],"properties":[]},"UnmarkCommentResponse":{"name":"UnmarkCommentResponse","fqn":"UnmarkCommentResponse","slug":"unmark-comment-response","actions":[],"properties":[{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Unmarked comment."}]},"UpdateComment":{"name":"UpdateComment","fqn":"UpdateComment","slug":"update-comment","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the comment was created.\n\n**Note:** This is the date from the system database, not the actual date when the comment was created. For example, if you migrate comments created in 2016, the `createdDate` field will show the current year. For the actual creation date, see the `commentDate` field."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Comment ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the comment was last updated."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that the comment is added to."},{"name":"author","slug":"author","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentAuthor","referenceFqn":"CommentAuthor"},"description":"Comment's author."},{"name":"commentDate","slug":"comment-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when the comment was actually created."},{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentContent","referenceFqn":"CommentContent"},"description":"Published comment content."},{"name":"contentEdited","slug":"content-edited","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the comment has the updated content."},{"name":"contextId","slug":"context-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the specific context the comment is in response to.\n\nWithin some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum,\nthe `forumPostId` is used as both the `contextId` and the `resourceId`."},{"name":"marked","slug":"marked","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the comment is marked."},{"name":"parentComment","slug":"parent-comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParentComment","referenceFqn":"ParentComment"},"description":"Parent comment information.\n\nOnly present if this comment is in a direct reply to another comment.\nSee **Terminology** in the Comments introduction\nfor more information about parent comments."},{"name":"rating","slug":"rating","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Comment rating."},{"name":"reactionSummary","slug":"reaction-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommentReactionSummary","referenceFqn":"CommentReactionSummary"},"description":"Summary of reactions."},{"name":"replyCount","slug":"reply-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of comments that reply to this comment."},{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the specific resource that the comment is in response to.\n\nWithin some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum,\nthe `forumPostId` is used as both the `resourceId` and the `contextId`."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the comment is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the comment."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Comment status."},{"name":"voteSummary","slug":"vote-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VoteSummary","referenceFqn":"VoteSummary"},"description":"Summary of votes."}]},"UpdateCommentOptions":{"name":"UpdateCommentOptions","fqn":"UpdateCommentOptions","slug":"update-comment-options","actions":[],"properties":[]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.comments.v2.comment"},"actions":[{"name":"countComments","fqn":"countComments","fullFqn":"wix.comments.ng.v1.CommentsNg.CountComments","slug":"count-comments","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["appId"],"permissionIds":["WIX_COMMENTS.COMMENT_COUNT"],"permissions":["Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CountCommentsResponse","referenceFqn":"CountCommentsResponse"}},"examples":[{"title":"countComments example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function countComments(appId, options) {\n try {\n const result = await comments.countComments(appId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"countComments example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCountComments = elevate(comments.countComments);\n\nexport const countComments = webMethod(\n Permissions.Anyone,\n async (appId, options) => {\n try {\n const result = await elevatedCountComments(appId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID to count the comments of."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CountCommentsOptions","referenceFqn":"CountCommentsOptions"}}],"description":"Counts comments, given the specified filtering. Comments with the `HIDDEN` status are not included in the response.","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_TO_COUNT","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TOO_MANY_TO_COUNT"}}],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"}],"isAdminMethod":true},{"name":"createComment","fqn":"createComment","fullFqn":"wix.comments.ng.v1.CommentsNg.CreateComment","slug":"create-comment","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["comment","comment.appId","comment.content","comment.contextId","comment.resourceId"],"permissionIds":["WIX_COMMENTS.COMMENT_CREATE","WIX_COMMENTS.COMMENT_OVERRIDE_AUTHOR","WIX_COMMENTS.COMMENT_OVERRIDE_COMMENT_DATE"],"permissions":["Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Created comment."},"examples":[{"title":"createComment example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function createComment(comment, options) {\n try {\n const result = await comments.createComment(comment, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"createComment example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateComment = elevate(comments.createComment);\n\nexport const createComment = webMethod(\n Permissions.Anyone,\n async (comment, options) => {\n try {\n const result = await elevatedCreateComment(comment, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Comment to create."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateCommentOptions","referenceFqn":"CreateCommentOptions"}}],"description":"Creates a new comment and publishes it.\n\nThe `appId`, `contextId`, and `resourceId` are all required and associate the created comment with the specific\nresource it responds to. See **Integrations** in the Comments introduction for a list of integrated scopes for these fields.\n\nIf the created comment is a direct response to another comment, the `commentId` of the parent comment should be passed\nas `parentComment.id` in this comment's request. See **Terminology** in the Comments introduction for additional information on parent comments and replies.","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_CAPTCHA","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_CAPTCHA"}}],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"},{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"},{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"}],"isAdminMethod":true},{"name":"deleteComment","fqn":"deleteComment","fullFqn":"wix.comments.ng.v1.CommentsNg.DeleteComment","slug":"delete-comment","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["commentId"],"permissionIds":["WIX_COMMENTS.COMMENT_DELETE"],"permissions":["Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"deleteComment example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function deleteComment(commentId, options) {\n try {\n const result = await comments.deleteComment(commentId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"deleteComment example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteComment = elevate(comments.deleteComment);\n\nexport const deleteComment = webMethod(\n Permissions.Anyone,\n async (commentId, options) => {\n try {\n const result = await elevatedDeleteComment(commentId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"commentId","slug":"comment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the comment to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeleteCommentOptions","referenceFqn":"DeleteCommentOptions"}}],"description":"Deletes a comment.\n\nThis method deletes the `content` of the comment and sets its `status` to `DELETED`.","sdkErrors":[],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"}],"isAdminMethod":true},{"name":"getComment","fqn":"getComment","fullFqn":"wix.comments.ng.v1.CommentsNg.GetComment","slug":"get-comment","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["commentId"],"permissionIds":["WIX_COMMENTS.COMMENT_READ"],"permissions":["Read Comments","Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.READ.COMMENTS","SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Retrieved comment."},"examples":[{"title":"getComment example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function getComment(commentId) {\n try {\n const result = await comments.getComment(commentId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getComment example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedGetComment = elevate(comments.getComment);\n\nexport const getComment = webMethod(\n Permissions.Anyone,\n async (commentId) => {\n try {\n const result = await elevatedGetComment(commentId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"commentId","slug":"comment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the comment to retrieve."}],"description":"Retrieves a comment.","sdkErrors":[],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"},{"name":"Read Comments","scopeId":"SCOPE.DC_COMMENTS.READ.COMMENTS"}],"isAdminMethod":true},{"name":"markComment","fqn":"markComment","fullFqn":"wix.comments.ng.v1.CommentsNg.MarkComment","slug":"mark-comment","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["commentId"],"permissionIds":["WIX_COMMENTS.COMMENT_MARK"],"permissions":["Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MarkCommentResponse","referenceFqn":"MarkCommentResponse"}},"examples":[{"title":"markComment example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function markComment(commentId, options) {\n try {\n const result = await comments.markComment(commentId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"markComment example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedMarkComment = elevate(comments.markComment);\n\nexport const markComment = webMethod(\n Permissions.Anyone,\n async (commentId, options) => {\n try {\n const result = await elevatedMarkComment(commentId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"commentId","slug":"comment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the comment to mark."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MarkCommentOptions","referenceFqn":"MarkCommentOptions"}}],"description":"Sets `marked` to `TRUE` to mark a comment.\n\nCall Query Comments to filter for marked comments to then apply customization to.\nSee Sample Flows for an example.","sdkErrors":[],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"}],"isAdminMethod":true},{"name":"queryComments","fqn":"queryComments","fullFqn":"wix.comments.ng.v1.CommentsNg.QueryComments","slug":"query-comments","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["appId"],"permissionIds":["WIX_COMMENTS.COMMENT_QUERY"],"permissions":["Read Comments","Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.READ.COMMENTS","SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},"examples":[{"title":"queryComments example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function queryComments() {\n const { items } = comments.queryComments().find();\n}\n"},{"title":"queryComments example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedQueryComments = elevate(comments.queryComments);\n\nexport const queryComments = webMethod(\n Permissions.Anyone,\n async (query, appId) => {\n try {\n const result = await elevatedQueryComments(query, appId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID to query comments for."}],"description":"Creates a query to retrieve a list of comments. \n\nThe `queryComments()` function builds a query to retrieve a list of comments and returns a [`CommentsQueryBuilder`](#commentsquerybuilder) object. \n\nThe returned object contains the query definition, which is typically used to run the query using the [`find()`](#commentsquerybuilder/find) function. \n\nYou can refine the query by chaining `CommentsQueryBuilder` functions onto the query. `CommentsQueryBuilder` functions enable you to sort, filter, and control the results that `queryComments()` returns. \n\n`queryComments()` runs with the following `CommentsQueryBuilder` default that you can override:\n+ `ascending(\"_id\")` \n\nThe functions that are chained to `queryComments()` are applied in the order they are called. For example, if you apply `ascending(\"voteSummary.netVoteCount\")` and then `ascending(\"replyCount\")`, the results are sorted first by the `\"voteSummary.netVoteCount\"`, and then, if there are multiple results with the same `\"voteSummary.netVoteCount\"`, the items are sorted by `\"replyCount\"`. \n\nThe following `CommentsQueryBuilder` functions are supported for the `queryComments()` function. For a full description of the comment object, see the object returned for the [`items`](#commentsqueryresult/items) property in [`CommentsQueryResult`](#commentsqueryresult).\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`contextId`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`resourceId`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`author.userId`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`author.memberId`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`author.visitorId`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`parentComment.id`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`replyCount`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`lt()`](/comments-query-builder/lt),[`le()`](/comments-query-builder/le),[`gt()`](/comments-query-builder/gt),[`ge()`](/comments-query-builder/ge),[`ascending()`](/comments-query-builder/ascending),[`descending()`](/comments-query-builder/descending)|\n|`voteSummary.netVoteCount`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`lt()`](/comments-query-builder/lt),[`le()`](/comments-query-builder/le),[`gt()`](/comments-query-builder/gt),[`ge()`](/comments-query-builder/ge),[`ascending()`](/comments-query-builder/ascending),[`descending()`](/comments-query-builder/descending)|\n|`status`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`in()`](/comments-query-builder/in)|\n|`rating`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`lt()`](/comments-query-builder/lt),[`le()`](/comments-query-builder/le),[`gt()`](/comments-query-builder/gt),[`ge()`](/comments-query-builder/ge),[`ascending()`](/comments-query-builder/ascending),[`descending()`](/comments-query-builder/descending)|\n|`reactionSummary.total`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`lt()`](/comments-query-builder/lt),[`le()`](/comments-query-builder/le),[`gt()`](/comments-query-builder/gt),[`ge()`](/comments-query-builder/ge),[`ascending()`](/comments-query-builder/ascending),[`descending()`](/comments-query-builder/descending)|\n|`marked`|[`eq()`](/comments-query-builder/eq),[`ne()`](/comments-query-builder/ne),[`ascending()`](/comments-query-builder/ascending),[`descending()`](/comments-query-builder/descending)|","sdkErrors":[],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"},{"name":"Read Comments","scopeId":"SCOPE.DC_COMMENTS.READ.COMMENTS"}],"isAdminMethod":true},{"name":"unmarkComment","fqn":"unmarkComment","fullFqn":"wix.comments.ng.v1.CommentsNg.UnmarkComment","slug":"unmark-comment","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["commentId"],"permissionIds":["WIX_COMMENTS.COMMENT_MARK"],"permissions":["Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"UnmarkCommentResponse","referenceFqn":"UnmarkCommentResponse"}},"examples":[{"title":"unmarkComment example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function unmarkComment(commentId, options) {\n try {\n const result = await comments.unmarkComment(commentId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"unmarkComment example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedUnmarkComment = elevate(comments.unmarkComment);\n\nexport const unmarkComment = webMethod(\n Permissions.Anyone,\n async (commentId, options) => {\n try {\n const result = await elevatedUnmarkComment(commentId, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"commentId","slug":"comment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the comment to unmark."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UnmarkCommentOptions","referenceFqn":"UnmarkCommentOptions"}}],"description":"Sets `marked` to `FALSE` to unmark a comment.","sdkErrors":[],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"}],"isAdminMethod":true},{"name":"updateComment","fqn":"updateComment","fullFqn":"wix.comments.ng.v1.CommentsNg.UpdateComment","slug":"update-comment","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","comment","comment.revision"],"permissionIds":["WIX_COMMENTS.COMMENT_UPDATE"],"permissions":["Manage Comments"],"permissionsScopesIds":["SCOPE.DC_COMMENTS.MANAGE.COMMENTS"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Comment","referenceFqn":"Comment"},"description":"Updated comment."},"examples":[{"title":"updateComment example for dashboard page code","content":"import { comments } from 'wix-comments.v2';\n\nasync function updateComment(id, comment, options) {\n try {\n const result = await comments.updateComment(id, comment, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"updateComment example for exporting from backend code","content":"import { comments } from 'wix-comments.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedUpdateComment = elevate(comments.updateComment);\n\nexport const updateComment = webMethod(\n Permissions.Anyone,\n async (id, comment, options) => {\n try {\n const result = await elevatedUpdateComment(id, comment, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Comment ID."},{"name":"comment","slug":"comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateComment","referenceFqn":"UpdateComment"}},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateCommentOptions","referenceFqn":"UpdateCommentOptions"}}],"description":"Updates a comment.\n\nEach time the comment is updated, `revision` increments by 1. The current `revision` must be\npassed when updating the comment. This ensures you're working with the latest comment and\nprevents unintended overwrites.","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"INVALID_CAPTCHA","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"INVALID_CAPTCHA"}}],"permissionScopes":[{"name":"Manage Comments","scopeId":"SCOPE.DC_COMMENTS.MANAGE.COMMENTS"}],"isAdminMethod":true}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction \n\n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n> **Note:** This module is\n> [universal](/api-overview/api-versions#universal-modules).\n> Functions in this module can run on both the backend and frontend,\n> unless specified otherwise. \n\n\nThe Comments API allows you to manage a customized commenting program that lets site visitors share feedback or engage in discussions around different types of resources, including blog posts, forum threads, or other site content.\n\nWith the Wix Comments API, you can:\n+ Allow commenting on any page of your site.\n+ Mark specific comments to highlight and feature to your readers.\n+ Engage with visitors who are not site members through guest commenting. \n\nTo use the Comments API, import { comments } from the `wix-comments.v2` module:\n```javascript\nimport { comments } from `wix-comments.v2`;\n```\n\n## Integrations\nThe Comments API is fully integrated with several Wix solutions. Each integration uses a slightly different configuration to work with Comments. \n\nThe following table details the currently supported integrations:\n| Wix App | `appId` | `contextId` | `resourceId` |\n| --- | --- | --- | --- |\n| Wix Blog | 14bcded7-0066-7c35-14d7-466cb3f09103 | `internalId` | `internalId` |\n| Wix Comments | 91c9d6a7-6667-41fb-b0b4-7d3b3ff0b02e | `contentId` | `contentId` |\n| Wix Forum | 14724f35-6794-cd1a-0244-25fd138f9242 | `forumPostId` | `forumPostId` |\n| Wix Groups | 148c2287-c669-d849-d153-463c7486a694 | `groupId` | `feedItemId` |\n\n## Terminology\n+ **Marked comments:** When a comment's `marked` field is set to `TRUE`, it indicates that the comment has been flagged or marked for special attention. No additional automated behavior or action is taken with the comment. However, you can manually filter for comments marked as such with the [`queryComments()`](/comments/query-comments) function and highlight them to your visitors as needed.\n+ **Parent comments:** Parent comments refer to comments that have subsequent comments directly responding to them. They serve as the original or initial comments in a conversation thread. The parent comment's unique identifier is stored in the `parentComment.id` field of the corresponding reply comment.\n+ **Replies:** Replies are comments that are made in direct response to earlier comments within a discussion. They are specifically intended as responses to a particular parent comment and contribute to the ongoing conversation. Replies help maintain the hierarchical structure of comment threads and enhance the engagement and interactivity among users.\n\n## Permissions information\n\nFunctions in Comments API are restricted and only run if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n\n

\n
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
\n

\n","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[{"kind":"REFERENCE","name":"CommentsQueryBuilder","referenceFqn":"CommentsQueryBuilder"},{"kind":"REFERENCE","name":"CommentsQueryResult","referenceFqn":"CommentsQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.69"},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"Comments","yamlTitle":"Wix Comments V 2","kind":"VELO","fqdn":"wix.comments.v2.comment"}}