{"id":"4f50a393-e030-4fdb-bafe-00843a2de339","createdDate":"2025-07-15T13:56:24.165Z","updatedDate":"2025-07-15T13:56:24.165Z","resourceId":"48a4d57c-26e6-46b7-b069-7bb689d08ba0","sdk":{"schema":{"name":"categories_categories","fqn":"","slug":"categories-categories","typesMap":{"ItemReference":{"name":"ItemReference","fqn":"ItemReference","slug":"item-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 36"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 36"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to.\n\nFor example, `product.id` for Wix Stores or `event.id` for Wix Events."}]},"BulkAddItemToCategoriesOptions":{"name":"BulkAddItemToCategoriesOptions","fqn":"BulkAddItemToCategoriesOptions","slug":"bulk-add-item-to-categories-options","actions":[],"properties":[{"name":"categoryIds","slug":"category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of categories to which to add the item."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"TreeReference":{"name":"TreeReference","fqn":"TreeReference","slug":"tree-reference","actions":[],"properties":[{"name":"appNamespace","slug":"app-namespace","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 4","maxLength 150"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Namespace of the app that manages the tree.\n\nFor example, `\"@wix/stores\"`, `\"@bookings/bookingslist\"`, `\"@achievements/quizzes\"`."},{"name":"treeKey","slug":"tree-key","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 44"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Tree key. You must pass this when a single app manages more than one tree."}]},"BulkAddItemToCategoriesResponse":{"name":"BulkAddItemToCategoriesResponse","fqn":"BulkAddItemToCategoriesResponse","slug":"bulk-add-item-to-categories-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkItemToCategoriesResult","referenceFqn":"BulkItemToCategoriesResult"}},"description":"Items added by bulk action."}]},"BulkActionMetadata":{"name":"BulkActionMetadata","fqn":"BulkActionMetadata","slug":"bulk-action-metadata","actions":[],"properties":[{"name":"totalFailures","slug":"total-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that couldn't be processed."},{"name":"totalSuccesses","slug":"total-successes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were successfully processed."},{"name":"undetailedFailures","slug":"undetailed-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of failures without details because detailed failure threshold was exceeded."}]},"BulkItemToCategoriesResult":{"name":"BulkItemToCategoriesResult","fqn":"BulkItemToCategoriesResult","slug":"bulk-item-to-categories-result","actions":[],"properties":[{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Bulk action metadata for category."}]},"ItemMetadata":{"name":"ItemMetadata","fqn":"ItemMetadata","slug":"item-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Details about the error in case of failure."},{"name":"originalIndex","slug":"original-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the item within the request array. Allows for correlation between request and response items."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated."}]},"ApplicationError":{"name":"ApplicationError","fqn":"ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"BulkAddItemsToCategoryOptions":{"name":"BulkAddItemsToCategoryOptions","fqn":"BulkAddItemsToCategoryOptions","slug":"bulk-add-items-to-category-options","actions":[],"properties":[{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"BulkAddItemsToCategoryResponse":{"name":"BulkAddItemsToCategoryResponse","fqn":"BulkAddItemsToCategoryResponse","slug":"bulk-add-items-to-category-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkItemsToCategoryResult","referenceFqn":"BulkItemsToCategoryResult"}},"description":"List of items added to a category by bulk action."}]},"BulkItemsToCategoryResult":{"name":"BulkItemsToCategoryResult","fqn":"BulkItemsToCategoryResult","slug":"bulk-items-to-category-result","actions":[],"properties":[{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReferenceMetadata","referenceFqn":"ItemReferenceMetadata"},"description":"Bulk action metadata for item reference."}]},"ItemReferenceMetadata":{"name":"ItemReferenceMetadata","fqn":"ItemReferenceMetadata","slug":"item-reference-metadata","actions":[],"properties":[{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Error details in the case of an unsuccessful action."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Catalog and item reference info."},{"name":"originalIndex","slug":"original-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Original index of the item within the request array. Allows for correlation between request and response items."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the action was successful.\nWhen `false`, the `error` field is populated."}]},"BulkRemoveItemFromCategoriesOptions":{"name":"BulkRemoveItemFromCategoriesOptions","fqn":"BulkRemoveItemFromCategoriesOptions","slug":"bulk-remove-item-from-categories-options","actions":[],"properties":[{"name":"categoryIds","slug":"category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of categories from which to remove the item."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"BulkRemoveItemFromCategoriesResponse":{"name":"BulkRemoveItemFromCategoriesResponse","fqn":"BulkRemoveItemFromCategoriesResponse","slug":"bulk-remove-item-from-categories-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkItemToCategoriesResult","referenceFqn":"BulkItemToCategoriesResult"}},"description":"Items removed by bulk action."}]},"BulkRemoveItemsFromCategoryOptions":{"name":"BulkRemoveItemsFromCategoryOptions","fqn":"BulkRemoveItemsFromCategoryOptions","slug":"bulk-remove-items-from-category-options","actions":[],"properties":[{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"BulkRemoveItemsFromCategoryResponse":{"name":"BulkRemoveItemsFromCategoryResponse","fqn":"BulkRemoveItemsFromCategoryResponse","slug":"bulk-remove-items-from-category-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkItemsToCategoryResult","referenceFqn":"BulkItemsToCategoryResult"}},"description":"Items removed by bulk action."}]},"BulkShowCategoriesOptions":{"name":"BulkShowCategoriesOptions","fqn":"BulkShowCategoriesOptions","slug":"bulk-show-categories-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RequestedFields","referenceFqn":"RequestedFields"}},"description":"Fields to include in the response."},{"name":"returnEntity","slug":"return-entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to return the category entity in the response.\n\nDefault: `false`"},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"RequestedFields":{"name":"RequestedFields","fqn":"RequestedFields","slug":"requested-fields","actions":[],"enumValues":[{"value":"BREADCRUMBS_INFO"},{"value":"UNKNOWN_REQUESTED_FIELD","description":"Not implemented."}],"properties":[]},"BulkShowCategoriesResponse":{"name":"BulkShowCategoriesResponse","fqn":"BulkShowCategoriesResponse","slug":"bulk-show-categories-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkCategoriesResult","referenceFqn":"BulkCategoriesResult"}},"description":"Categories updated by bulk action."}]},"BulkCategoriesResult":{"name":"BulkCategoriesResult","fqn":"BulkCategoriesResult","slug":"bulk-categories-result","actions":[],"properties":[{"name":"category","slug":"category","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Full category entity.\n\nReturned only if `returnEntity: true` is passed in the request."},{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Bulk action metadata for category."}]},"Category":{"name":"Category","fqn":"Category","slug":"category","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the category was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","immutable"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the category was updated."},{"name":"breadcrumbsInfo","slug":"breadcrumbs-info","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BreadcrumbsInfo","referenceFqn":"BreadcrumbsInfo"},"description":"Category breadcrumbs.\n\n> **Note:** Returned only when you pass `\"BREADCRUMBS_INFO\"` to the `fields` array in Categories API requests."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 600"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category description.\n> **Note:** This field is returned only when you pass `fields: \"DESCRIPTION\"` in the request."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"ExtendedFields"},"description":"Custom extended fields for the category object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category image.\n\n+ Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).\n+ Pass full image URL to upload to Wix Media Manager."},{"name":"itemCounter","slug":"item-counter","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items in this category."},{"name":"managingAppId","slug":"managing-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","immutable"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app responsible for managing the items in this category.\n\nPass your app ID to restrict updating and deleting items in this category to your app only."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 80"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category name."},{"name":"parentCategory","slug":"parent-category","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable"],"type":{"kind":"REFERENCE","name":"ParentCategory","referenceFqn":"ParentCategory"},"description":"Parent category reference data."},{"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 category is updated.\nTo prevent conflicting changes, the current revision must be passed when updating.\n\nIgnored when creating a category."},{"name":"richContentDescription","slug":"rich-content-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RichContent","referenceFqn":"RichContent"},"description":"Category description using rich content.\n> **Note:** Returned only when you pass `\"RICH_CONTENT_DESCRIPTION\"` to the `fields` array in Categories API requests.\n\n\nSee Ricos document reference\n"},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format URL_SLUG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category slug.\n\nIf not provided, the slug is autogenerated based on the category name."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable"],"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the category is visible to site visitors in dynamic pages.\n\n+ If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.\n+ Passing `true` will fail if the visibility of any parent categories is `false`.\n+ Default: `false`."}]},"BreadcrumbsInfo":{"name":"BreadcrumbsInfo","fqn":"BreadcrumbsInfo","slug":"breadcrumbs-info","actions":[],"properties":[{"name":"breadcrumbs","slug":"breadcrumbs","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 5"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Breadcrumb","referenceFqn":"Breadcrumb"}},"description":"List of breadcrumb data. The current category isn't included in the list."}]},"Breadcrumb":{"name":"Breadcrumb","fqn":"Breadcrumb","slug":"breadcrumb","actions":[],"properties":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"categoryName","slug":"category-name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 80"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category name."},{"name":"categorySlug","slug":"category-slug","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category slug."}]},"ExtendedFields":{"name":"ExtendedFields","fqn":"ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"ParentCategory":{"name":"ParentCategory","fqn":"ParentCategory","slug":"parent-category","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Parent category ID.\n\nDefault: root category ID"},{"name":"index","slug":"index","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index position of the category within the parent category."}]},"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":"strikethroughData","slug":"strikethrough-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Data for a strikethrough decoration. Defaults to `true`."},{"name":"subscriptData","slug":"subscript-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Data for a subscript decoration. Defaults to `true`."},{"name":"superscriptData","slug":"superscript-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Data for a superscript decoration. Defaults to `true`."},{"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":"STRIKETHROUGH"},{"value":"SUBSCRIPT"},{"value":"SUPERSCRIPT"},{"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":"buttonStyles","slug":"button-styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ButtonStyles","referenceFqn":"ButtonStyles"},"description":"Button styling options."},{"name":"cardStyles","slug":"card-styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CardStyles","referenceFqn":"CardStyles"},"description":"Card styling options."},{"name":"containerData","slug":"container-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PluginContainerData","referenceFqn":"PluginContainerData"},"description":"Styling for the app embed's container."},{"name":"hideButton","slug":"hide-button","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the button."},{"name":"hideDateTime","slug":"hide-date-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the date and time (Event)."},{"name":"hideDescription","slug":"hide-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the description (Event and Booking)."},{"name":"hideDuration","slug":"hide-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the duration (Booking)."},{"name":"hideImage","slug":"hide-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the image."},{"name":"hideLocation","slug":"hide-location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the location (Event)."},{"name":"hidePrice","slug":"hide-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the price."},{"name":"hideRibbon","slug":"hide-ribbon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the ribbon."},{"name":"hideTitle","slug":"hide-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the title."},{"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":"imageStyles","slug":"image-styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ImageStyles","referenceFqn":"ImageStyles"},"description":"Image styling options."},{"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":"pricingData","slug":"pricing-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PricingData","referenceFqn":"PricingData"},"description":"Pricing data for embedded Wix App content."},{"name":"ribbonStyles","slug":"ribbon-styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RibbonStyles","referenceFqn":"RibbonStyles"},"description":"Ribbon styling options."},{"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."}]},"ButtonStyles":{"name":"ButtonStyles","fqn":"ButtonStyles","slug":"button-styles","actions":[],"properties":[{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Background color as a hexadecimal value."},{"name":"backgroundColorHover","slug":"background-color-hover","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Background color as a hexadecimal value (hover state)."},{"name":"borderColor","slug":"border-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Border color as a hexadecimal value."},{"name":"borderColorHover","slug":"border-color-hover","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Border color as a hexadecimal value (hover state)."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border radius in pixels."},{"name":"borderWidth","slug":"border-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border width in pixels."},{"name":"buttonSize","slug":"button-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`."},{"name":"buttonText","slug":"button-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Text to display on the button."},{"name":"textColor","slug":"text-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Text color as a hexadecimal value."},{"name":"textColorHover","slug":"text-color-hover","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Text color as a hexadecimal value (hover state)."}]},"CardStyles":{"name":"CardStyles","fqn":"CardStyles","slug":"card-styles","actions":[],"properties":[{"name":"alignment","slug":"alignment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Alignment","referenceFqn":"Alignment"},"description":"Content alignment. Defaults to `START`."},{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Card background color as a hexadecimal value."},{"name":"borderColor","slug":"border-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Card border color as a hexadecimal value."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Card border radius in pixels."},{"name":"borderWidth","slug":"border-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Card border width in pixels."},{"name":"textColor","slug":"text-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Text color as a hexadecimal value."},{"name":"titleColor","slug":"title-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Title text color as a hexadecimal value."},{"name":"titlePriceLayout","slug":"title-price-layout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Layout","referenceFqn":"Layout"},"description":"Layout for title and price. Defaults to `STACKED`."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"Card type. Defaults to `CONTAINED`."}]},"Alignment":{"name":"Alignment","fqn":"Alignment","slug":"alignment","actions":[],"enumValues":[{"value":"CENTER","description":"Content centered"},{"value":"END","description":"Content aligned to end (right in LTR layouts, left in RTL layouts)"},{"value":"START","description":"Content aligned to start (left in LTR layouts, right in RTL layouts)"}],"properties":[]},"Layout":{"name":"Layout","fqn":"Layout","slug":"layout","actions":[],"enumValues":[{"value":"SIDE_BY_SIDE","description":"Elements arranged horizontally"},{"value":"STACKED","description":"Elements stacked vertically"}],"properties":[]},"Type":{"name":"Type","fqn":"Type","slug":"type","actions":[],"enumValues":[{"value":"CONTAINED","description":"Card with visible border and background"},{"value":"FRAMELESS","description":"Card without visible border"}],"properties":[]},"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":[]},"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":"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":"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":"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`."}]},"ImageStyles":{"name":"ImageStyles","fqn":"ImageStyles","slug":"image-styles","actions":[],"properties":[{"name":"aspectRatio","slug":"aspect-ratio","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AspectRatio","referenceFqn":"AspectRatio"},"description":"Aspect ratio for the image. Defaults to `SQUARE`."},{"name":"borderColor","slug":"border-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Image border color as a hexadecimal value."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Image border radius in pixels."},{"name":"borderWidth","slug":"border-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Image border width in pixels."},{"name":"hideImage","slug":"hide-image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to hide the image."},{"name":"imagePosition","slug":"image-position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ImageStylesPosition","referenceFqn":"ImageStylesPosition"},"description":"Position of image. Defaults to `START`."},{"name":"resizing","slug":"resizing","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Resizing","referenceFqn":"Resizing"},"description":"How the image should be resized. Defaults to `FILL`."}]},"AspectRatio":{"name":"AspectRatio","fqn":"AspectRatio","slug":"aspect-ratio","actions":[],"enumValues":[{"value":"RECTANGLE","description":"16:9 aspect ratio"},{"value":"SQUARE","description":"1:1 aspect ratio"}],"properties":[]},"ImageStylesPosition":{"name":"ImageStylesPosition","fqn":"ImageStylesPosition","slug":"image-styles-position","actions":[],"enumValues":[{"value":"END","description":"Image positioned at the end (right in LTR layouts, left in RTL layouts)"},{"value":"START","description":"Image positioned at the start (left in LTR layouts, right in RTL layouts)"},{"value":"TOP","description":"Image positioned at the top"}],"properties":[]},"Resizing":{"name":"Resizing","fqn":"Resizing","slug":"resizing","actions":[],"enumValues":[{"value":"FILL","description":"Fill the container, may crop the image"},{"value":"FIT","description":"Fit the image within the container"}],"properties":[]},"PricingData":{"name":"PricingData","fqn":"PricingData","slug":"pricing-data","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format CURRENCY"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency of the value in ISO 4217 format (e.g., \"USD\", \"EUR\")."},{"name":"discountedValue","slug":"discounted-value","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["decimalValue { maxScale:2 }"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Numeric price value as string after discount application (e.g., \"15.99\")."},{"name":"pricingPlanId","slug":"pricing-plan-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Pricing plan ID."},{"name":"valueFrom","slug":"value-from","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["decimalValue { maxScale:2 }"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum numeric price value as string (e.g., \"10.99\")."},{"name":"valueTo","slug":"value-to","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["decimalValue { maxScale:2 }"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Maximum numeric price value as string (e.g., \"19.99\")."}]},"RibbonStyles":{"name":"RibbonStyles","fqn":"RibbonStyles","slug":"ribbon-styles","actions":[],"properties":[{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ribbon background color as a hexadecimal value."},{"name":"borderColor","slug":"border-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ribbon border color as a hexadecimal value."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Ribbon border radius in pixels."},{"name":"borderWidth","slug":"border-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Ribbon border width in pixels."},{"name":"ribbonPlacement","slug":"ribbon-placement","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Placement","referenceFqn":"Placement"},"description":"Placement of the ribbon. Defaults to `IMAGE`."},{"name":"ribbonText","slug":"ribbon-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Text to display on the ribbon."},{"name":"textColor","slug":"text-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Ribbon text color as a hexadecimal value."}]},"Placement":{"name":"Placement","fqn":"Placement","slug":"placement","actions":[],"enumValues":[{"value":"IMAGE","description":"Ribbon placed on the image"},{"value":"PRODUCT_INFO","description":"Ribbon placed on the product information"}],"properties":[]},"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."}]},"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":"ButtonDataType","referenceFqn":"ButtonDataType"},"description":"The button type."}]},"Styles":{"name":"Styles","fqn":"Styles","slug":"styles","actions":[],"properties":[{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Background color as a hexadecimal value."},{"name":"backgroundColorHover","slug":"background-color-hover","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Background color as a hexadecimal value (hover state)."},{"name":"border","slug":"border","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"Border","referenceFqn":"Border"},"description":"Deprecated: Use `borderWidth` and `borderRadius` instead."},{"name":"borderColor","slug":"border-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Border color as a hexadecimal value."},{"name":"borderColorHover","slug":"border-color-hover","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Border color as a hexadecimal value (hover state)."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border radius in pixels."},{"name":"borderWidth","slug":"border-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border width in pixels."},{"name":"borderWidthHover","slug":"border-width-hover","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"number"},"description":"Deprecated: Use `borderWidth` for normal/hover states instead."},{"name":"buttonSize","slug":"button-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`."},{"name":"colors","slug":"colors","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"Colors","referenceFqn":"Colors"},"description":"Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead."},{"name":"textColor","slug":"text-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Text color as a hexadecimal value."},{"name":"textColorHover","slug":"text-color-hover","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Text color as a hexadecimal value (hover state)."}]},"Border":{"name":"Border","fqn":"Border","slug":"border","actions":[],"properties":[{"name":"radius","slug":"radius","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"number"},"description":"Deprecated: Use `borderRadius` in `styles` instead."},{"name":"width","slug":"width","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"number"},"description":"Deprecated: Use `borderWidth` in `styles` instead."}]},"Colors":{"name":"Colors","fqn":"Colors","slug":"colors","actions":[],"properties":[{"name":"background","slug":"background","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Deprecated: Use `backgroundColor` in `styles` instead."},{"name":"border","slug":"border","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Deprecated: Use `borderColor` in `styles` instead."},{"name":"text","slug":"text","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Deprecated: Use `textColor` in `styles` instead."}]},"ButtonDataType":{"name":"ButtonDataType","fqn":"ButtonDataType","slug":"button-data-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":"DividerDataAlignment","referenceFqn":"DividerDataAlignment"},"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."}]},"DividerDataAlignment":{"name":"DividerDataAlignment","fqn":"DividerDataAlignment","slug":"divider-data-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":"GalleryOptionsLayout","referenceFqn":"GalleryOptionsLayout"},"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":[]},"GalleryOptionsLayout":{"name":"GalleryOptionsLayout","fqn":"GalleryOptionsLayout","slug":"gallery-options-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":"gifType","slug":"gif-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GIFType","referenceFqn":"GIFType"},"description":"Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`."},{"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","validations":["format WEB_URL"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"GIF format URL."},{"name":"mp4","slug":"mp4","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format WEB_URL"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"MP4 format URL."},{"name":"still","slug":"still","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format WEB_URL"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Thumbnail URL."}]},"GIFType":{"name":"GIFType","fqn":"GIFType","slug":"giftype","actions":[],"enumValues":[{"value":"NORMAL"},{"value":"STICKER"}],"properties":[]},"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":"autoHeight","slug":"auto-height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If container height is aligned with its content height. Defaults to `true`."},{"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. Height property is irrelevant for HTML embeds when autoHeight is set to `true`."},{"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":"decorative","slug":"decorative","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Sets whether the image is decorative and does not need an explanation. Defaults to `false`."},{"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."},{"name":"styles","slug":"styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ImageDataStyles","referenceFqn":"ImageDataStyles"},"description":"Styling for the image."}]},"ImageDataStyles":{"name":"ImageDataStyles","fqn":"ImageDataStyles","slug":"image-data-styles","actions":[],"properties":[{"name":"border","slug":"border","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StylesBorder","referenceFqn":"StylesBorder"},"description":"Border attributes."}]},"StylesBorder":{"name":"StylesBorder","fqn":"StylesBorder","slug":"styles-border","actions":[],"properties":[{"name":"color","slug":"color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Border color as a hexadecimal value."},{"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."}]},"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":"styles","slug":"styles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LinkPreviewDataStyles","referenceFqn":"LinkPreviewDataStyles"},"description":"Styling for the link preview."},{"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."}]},"LinkPreviewDataStyles":{"name":"LinkPreviewDataStyles","fqn":"LinkPreviewDataStyles","slug":"link-preview-data-styles","actions":[],"properties":[{"name":"backgroundColor","slug":"background-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Background color as a hexadecimal value."},{"name":"borderColor","slug":"border-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Border color as a hexadecimal value."},{"name":"borderRadius","slug":"border-radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border radius in pixels."},{"name":"borderWidth","slug":"border-width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Border width in pixels."},{"name":"linkColor","slug":"link-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Link color as a hexadecimal value."},{"name":"subtitleColor","slug":"subtitle-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Subtitle color as a hexadecimal value."},{"name":"thumbnailPosition","slug":"thumbnail-position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StylesPosition","referenceFqn":"StylesPosition"},"description":"Position of thumbnail. Defaults to `START`."},{"name":"titleColor","slug":"title-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Title color as a hexadecimal value."}]},"StylesPosition":{"name":"StylesPosition","fqn":"StylesPosition","slug":"styles-position","actions":[],"enumValues":[{"value":"END","description":"Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts)"},{"value":"HIDDEN","description":"Thumbnail hidden and not displayed"},{"value":"START","description":"Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts)"},{"value":"TOP","description":"Thumbnail positioned at the top"}],"properties":[]},"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","validations":["format COLOR_HEX"],"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","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"The end color as a hexademical value."},{"name":"startColor","slug":"start-color","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"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":"creatorId","slug":"creator-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Poll creator ID."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Poll 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":"PollSettings","referenceFqn":"PollSettings"},"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."}]},"PollSettings":{"name":"PollSettings","fqn":"PollSettings","slug":"poll-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","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Bottom border color as a hexadecimal value."},{"name":"left","slug":"left","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Left border color as a hexadecimal value."},{"name":"right","slug":"right","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Right border color as a hexadecimal value."},{"name":"top","slug":"top","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format COLOR_HEX"],"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","validations":["format COLOR_HEX"],"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."}]},"MaskedCategory":{"name":"MaskedCategory","fqn":"MaskedCategory","slug":"masked-category","actions":[],"properties":[{"name":"category","slug":"category","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Category to update."}]},"BulkUpdateCategoriesOptions":{"name":"BulkUpdateCategoriesOptions","fqn":"BulkUpdateCategoriesOptions","slug":"bulk-update-categories-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RequestedFields","referenceFqn":"RequestedFields"}},"description":"Fields to include in the response."},{"name":"returnEntity","slug":"return-entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to return the full category entity in the response.\n\nDefault: `false`"},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"BulkUpdateCategoriesResponse":{"name":"BulkUpdateCategoriesResponse","fqn":"BulkUpdateCategoriesResponse","slug":"bulk-update-categories-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 1","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkCategoriesResult","referenceFqn":"BulkCategoriesResult"}},"description":"Categories updated by bulk action."}]},"CountCategoriesOptions":{"name":"CountCategoriesOptions","fqn":"CountCategoriesOptions","slug":"count-categories-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 object.\n\nLearn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section)."},{"name":"returnNonVisibleCategories","slug":"return-non-visible-categories","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to return categories with `visible: false` (hidden categories).\n\nDefault: `false` - only visible categories are returned in the response"},{"name":"search","slug":"search","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SearchDetails","referenceFqn":"SearchDetails"},"description":"Search options."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"SearchDetails":{"name":"SearchDetails","fqn":"SearchDetails","slug":"search-details","actions":[],"properties":[{"name":"expression","slug":"expression","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Search term or expression."},{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 200","maxSize 20"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Fields in which to search for the `expression`. Use dot notation to specify field path.\n\nWhen empty - all searchable fields are looked at."},{"name":"fuzzy","slug":"fuzzy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to use fuzzy search - allowing typos and other minor errors in the search."},{"name":"mode","slug":"mode","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Mode","referenceFqn":"Mode"},"description":"Defines how separate search terms in `expression` are combined."}]},"Mode":{"name":"Mode","fqn":"Mode","slug":"mode","actions":[],"enumValues":[{"value":"AND","description":"All search terms must be present."},{"value":"OR","description":"Any of the search terms must be present."}],"properties":[]},"CountCategoriesResponse":{"name":"CountCategoriesResponse","fqn":"CountCategoriesResponse","slug":"count-categories-response","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total count of categories which satisfy the given filter and/or search."}]},"CreateCategoryOptions":{"name":"CreateCategoryOptions","fqn":"CreateCategoryOptions","slug":"create-category-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SingleEntityOpsRequestedFields","referenceFqn":"SingleEntityOpsRequestedFields"}},"description":"Fields to include in the response."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"SingleEntityOpsRequestedFields":{"name":"SingleEntityOpsRequestedFields","fqn":"SingleEntityOpsRequestedFields","slug":"single-entity-ops-requested-fields","actions":[],"enumValues":[{"value":"BREADCRUMBS_INFO"},{"value":"DESCRIPTION"},{"value":"RICH_CONTENT_DESCRIPTION"},{"value":"UNKNOWN_REQUESTED_FIELD","description":"Not implemented."}],"properties":[]},"GetArrangedItemsResponse":{"name":"GetArrangedItemsResponse","fqn":"GetArrangedItemsResponse","slug":"get-arranged-items-response","actions":[],"properties":[{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of arranged items."}]},"GetCategoryOptions":{"name":"GetCategoryOptions","fqn":"GetCategoryOptions","slug":"get-category-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SingleEntityOpsRequestedFields","referenceFqn":"SingleEntityOpsRequestedFields"}},"description":"Fields to include in the response."}]},"ListCategoriesForItemOptions":{"name":"ListCategoriesForItemOptions","fqn":"ListCategoriesForItemOptions","slug":"list-categories-for-item-options","actions":[],"properties":[{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"ListCategoriesForItemResponse":{"name":"ListCategoriesForItemResponse","fqn":"ListCategoriesForItemResponse","slug":"list-categories-for-item-response","actions":[],"properties":[{"name":"allCategoryIds","slug":"all-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of categories that directly contain this item, and their parent category IDs."},{"name":"directCategoryIds","slug":"direct-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of categories that directly contain this item."}]},"ListCategoriesForItemsOptions":{"name":"ListCategoriesForItemsOptions","fqn":"ListCategoriesForItemsOptions","slug":"list-categories-for-items-options","actions":[],"properties":[{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"ListCategoriesForItemsResponse":{"name":"ListCategoriesForItemsResponse","fqn":"ListCategoriesForItemsResponse","slug":"list-categories-for-items-response","actions":[],"properties":[{"name":"categoriesForItems","slug":"categories-for-items","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"MapItemToCategories","referenceFqn":"MapItemToCategories"}},"description":"Map of item references to lists of direct category IDs and all category IDs, including parent categories and direct ones."}]},"MapItemToCategories":{"name":"MapItemToCategories","fqn":"MapItemToCategories","slug":"map-item-to-categories","actions":[],"properties":[{"name":"directCategoryIds","slug":"direct-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of categories that directly contain this item."},{"name":"indirectCategoryIds","slug":"indirect-category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of categories that indirectly contain this item, including all ancestors of its direct categories in the hierarchy."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Item reference info."}]},"ListItemsInCategoryOptions":{"name":"ListItemsInCategoryOptions","fqn":"ListItemsInCategoryOptions","slug":"list-items-in-category-options","actions":[],"oneofProperties":{"pagingMethod":[{"name":"cursorPaging","slug":"cursor-paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPaging","referenceFqn":"CursorPaging"},"description":"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging)."}]},"properties":[{"name":"includeItemsFromSubcategories","slug":"include-items-from-subcategories","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to include items from subcategories.\n\nDefault: `false` (only direct items of the category will be returned)"},{"name":"useCategoryArrangement","slug":"use-category-arrangement","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to use category arrangement for sorting items.\n\nDefault: `false`"}]},"CursorPaging":{"name":"CursorPaging","fqn":"CursorPaging","slug":"cursor-paging","actions":[],"properties":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 16000"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["max 1000"],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of items to return in the results."}]},"ListItemsInCategoryResponse":{"name":"ListItemsInCategoryResponse","fqn":"ListItemsInCategoryResponse","slug":"list-items-in-category-response","actions":[],"properties":[{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of items in the category."},{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Paging metadata."}]},"PagingMetadataV2":{"name":"PagingMetadataV2","fqn":"PagingMetadataV2","slug":"paging-metadata-v2","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset that was requested."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 16000"],"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","validations":["maxLength 16000"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"ListTreesResponse":{"name":"ListTreesResponse","fqn":"ListTreesResponse","slug":"list-trees-response","actions":[],"properties":[{"name":"trees","slug":"trees","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 20"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"}},"description":"List of trees."}]},"MoveCategoryOptions":{"name":"MoveCategoryOptions","fqn":"MoveCategoryOptions","slug":"move-category-options","actions":[],"properties":[{"name":"moveAfterCategoryId","slug":"move-after-category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Required when passing `position: AFTER`."},{"name":"parentCategoryId","slug":"parent-category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Parent category ID.\n\nDefault: root category ID"},{"name":"position","slug":"position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Position","referenceFqn":"Position"},"description":"Where to place the subcategory.\n\n+ `FIRST`: Position the category as the first subcategory.\n+ `LAST`: Position the category as the last subcategory.\n+ `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`."}]},"Position":{"name":"Position","fqn":"Position","slug":"position","actions":[],"enumValues":[{"value":"AFTER"},{"value":"FIRST"},{"value":"LAST"},{"value":"UNKNOWN_POSITION"}],"properties":[]},"MoveCategoryResponse":{"name":"MoveCategoryResponse","fqn":"MoveCategoryResponse","slug":"move-category-response","actions":[],"properties":[{"name":"categoriesAfterMove","slug":"categories-after-move","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of category IDs in the new order of arrangement."},{"name":"parentCategoryId","slug":"parent-category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Parent category ID."}]},"QueryCategoriesOptions":{"name":"QueryCategoriesOptions","fqn":"QueryCategoriesOptions","slug":"query-categories-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RequestedFields","referenceFqn":"RequestedFields"}},"description":"Fields to include in the response."},{"name":"returnNonVisibleCategories","slug":"return-non-visible-categories","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to return non-visible categories.\n\nDefault: `false` (only visible categories are returned)"},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"CategoriesQueryBuilder":{"name":"CategoriesQueryBuilder","fqn":"CategoriesQueryBuilder","slug":"categories-query-builder","actions":[{"name":"ascending","fqn":"CategoriesQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = categories.queryCategories().ascending('_id');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().ascending('_id').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 `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"descending","fqn":"CategoriesQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = categories.queryCategories().descending('_id');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().descending('_id').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 `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"eq","fqn":"CategoriesQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = categories.queryCategories().eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\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 `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"exists","fqn":"CategoriesQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = categories.queryCategories().exists('description', true);\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\n .exists('description', true)\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":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `CategoriesQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolean parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned.","sdkErrors":[],"kind":"GENERAL"},{"name":"find","fqn":"CategoriesQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CategoriesQueryResult","referenceFqn":"CategoriesQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = categories.queryCategories().find();\n"},{"title":"Perform a `find` on a query","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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":[],"kind":"GENERAL"},{"name":"ge","fqn":"CategoriesQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = categories.queryCategories().ge('_id', 'some-id');\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\n .ge('_id', 'some-id')\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 is greater than or equal to the specified value.\n\nThe `ge()` function refines a `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"gt","fqn":"CategoriesQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = categories.queryCategories().gt('_id', 'some-id');\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\n .gt('_id', 'some-id')\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 is greater than the specified value.\n\nThe `gt()` function refines a `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"hasSome","fqn":"CategoriesQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = categories\n .queryCategories()\n .hasSome('labelIds', ['red', 'blue', 'purple']);\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\n .hasSome('labelIds', ['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"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `CategoriesQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values.","sdkErrors":[],"kind":"GENERAL"},{"name":"in","fqn":"CategoriesQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = categories\n .queryCategories()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple']);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\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 `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"le","fqn":"CategoriesQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = categories.queryCategories().le('_id', 'some-id');\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\n .le('_id', 'some-id')\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 is less than or equal to the specified value.\n\nThe `le()` function refines a `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"limit","fqn":"CategoriesQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = categories.queryCategories().limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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 = categories.queryCategories().limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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":[],"kind":"GENERAL"},{"name":"lt","fqn":"CategoriesQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = categories.queryCategories().lt('_id', 'some-id');\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\n .lt('_id', 'some-id')\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 is less than the specified value.\n\nThe `le()` function refines a `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"ne","fqn":"CategoriesQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = categories\n .queryCategories()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da');\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories\n .queryCategories()\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 `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"skipTo","fqn":"CategoriesQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().find();\n\n const nextCursor = results.cursors.next;\n return categories.queryCategories().skipTo(nextCursor).find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().find();\n\n const prevCursor = results.cursors.prev;\n return categories.queryCategories().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 `CategoriesQueryBuilder` 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":[],"kind":"GENERAL"},{"name":"startsWith","fqn":"CategoriesQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = categories.queryCategories().startsWith('_id', 'L');\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories();\n startsWith('_id', 'L').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 `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `CategoriesQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string.","sdkErrors":[],"kind":"GENERAL"}],"properties":[],"articles":[],"webhooks":[]},"CategoriesQueryResult":{"name":"CategoriesQueryResult","fqn":"CategoriesQueryResult","slug":"categories-query-result","actions":[{"name":"hasNext","fqn":"CategoriesQueryResult.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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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 `categories` to navigate the pages of a query result.","sdkErrors":[],"kind":"GENERAL"},{"name":"hasPrev","fqn":"CategoriesQueryResult.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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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 `categories` to navigate the pages of a query result.","sdkErrors":[],"kind":"GENERAL"},{"name":"next","fqn":"CategoriesQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CategoriesQueryResult","referenceFqn":"CategoriesQueryResult"}},"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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await categories.queryCategories().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()`](/categories-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `categories` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `CategoriesQueryBuilder` may change.","sdkErrors":[],"kind":"GENERAL"},{"name":"prev","fqn":"CategoriesQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CategoriesQueryResult","referenceFqn":"CategoriesQueryResult"}},"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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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()`](/categories-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `categories` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change.","sdkErrors":[],"kind":"GENERAL"}],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's cursors","content":"import { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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":"Category","referenceFqn":"Category"}},"description":"Returns an array of `categories` 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()`](/categories-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `categories` 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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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.\nThe page size is defined by the [`limit()`](/categories-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `categories` 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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().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()`](/categories-query-builder/limit) in `CategoriesQueryBuilder`."},{"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 { categories } from '@wix/categories';\n\nexport async function myQueryFunction() {\n const results = await categories.queryCategories().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"description":"Returns the `CategoriesQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `CategoriesQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `CategoriesQueryBuilder`."}],"articles":[],"webhooks":[]},"CursorSearch":{"name":"CursorSearch","fqn":"CursorSearch","slug":"cursor-search","actions":[],"oneofProperties":{"pagingMethod":[{"name":"cursorPaging","slug":"cursor-paging","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPaging","referenceFqn":"CursorPaging"},"description":"Cursor pointing to page of results.\nWhen requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided."}]},"properties":[{"name":"aggregations","slug":"aggregations","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 10"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Aggregation","referenceFqn":"Aggregation"}},"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition."},{"name":"filter","slug":"filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)."},{"name":"search","slug":"search","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SearchDetails","referenceFqn":"SearchDetails"},"description":"Free text to match in searchable fields"},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 10"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"}},"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]"},{"name":"timeZone","slug":"time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 50"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"UTC offset or IANA time zone. Valid values are\nISO 8601 UTC offsets, such as +02:00 or -06:00,\nand IANA time zone IDs, such as Europe/Rome\n\nAffects all filters and aggregations returned values.\nYou may override this behavior in a specific filter by providing\ntimestamps including time zone. e.g. `\"2023-12-20T10:52:34.795Z\"`"}]},"Aggregation":{"name":"Aggregation","fqn":"Aggregation","slug":"aggregation","actions":[],"oneofProperties":{"kind":[{"name":"dateHistogram","slug":"date-histogram","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DateHistogramAggregation","referenceFqn":"DateHistogramAggregation"},"description":"Date histogram aggregation"},{"name":"nested","slug":"nested","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NestedAggregation","referenceFqn":"NestedAggregation"},"description":"Nested aggregation"},{"name":"range","slug":"range","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RangeAggregation","referenceFqn":"RangeAggregation"},"description":"Range aggregation"},{"name":"scalar","slug":"scalar","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScalarAggregation","referenceFqn":"ScalarAggregation"},"description":"Scalar aggregation"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValueAggregation","referenceFqn":"ValueAggregation"},"description":"Value aggregation"}]},"properties":[{"name":"fieldPath","slug":"field-path","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 200"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field to aggregate by, use dot notation to specify json path"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"User-defined name of aggregation, should be unique, will appear in aggregation results"},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AggregationType","referenceFqn":"AggregationType"},"description":"Type of aggregation, client must provide matching aggregation field below"}]},"DateHistogramAggregation":{"name":"DateHistogramAggregation","fqn":"DateHistogramAggregation","slug":"date-histogram-aggregation","actions":[],"properties":[{"name":"interval","slug":"interval","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Interval","referenceFqn":"Interval"},"description":"Interval for date histogram aggregation"}]},"Interval":{"name":"Interval","fqn":"Interval","slug":"interval","actions":[],"enumValues":[{"value":"DAY","description":"Daily interval"},{"value":"HOUR","description":"Hourly interval"},{"value":"MINUTE","description":"Minute interval"},{"value":"MONTH","description":"Monthly interval"},{"value":"SECOND","description":"Second interval"},{"value":"UNKNOWN_INTERVAL"},{"value":"WEEK","description":"Weekly interval"},{"value":"YEAR","description":"Yearly interval"}],"properties":[]},"NestedAggregation":{"name":"NestedAggregation","fqn":"NestedAggregation","slug":"nested-aggregation","actions":[],"properties":[{"name":"nestedAggregations","slug":"nested-aggregations","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minSize 2","maxSize 3"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"NestedAggregationItem","referenceFqn":"NestedAggregationItem"}},"description":"Flattened list of aggregations, where each next aggregation is nested within previous one"}]},"NestedAggregationItem":{"name":"NestedAggregationItem","fqn":"NestedAggregationItem","slug":"nested-aggregation-item","actions":[],"oneofProperties":{"kind":[{"name":"dateHistogram","slug":"date-histogram","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DateHistogramAggregation","referenceFqn":"DateHistogramAggregation"},"description":"Date histogram aggregation"},{"name":"range","slug":"range","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RangeAggregation","referenceFqn":"RangeAggregation"},"description":"Range aggregation"},{"name":"scalar","slug":"scalar","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScalarAggregation","referenceFqn":"ScalarAggregation"},"description":"Scalar aggregation"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValueAggregation","referenceFqn":"ValueAggregation"},"description":"Value aggregation"}]},"properties":[{"name":"fieldPath","slug":"field-path","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 200"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field to aggregate by, use dont notation to specify json path"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"User-defined name of aggregation, should be unique, will appear in aggregation results"},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NestedAggregationType","referenceFqn":"NestedAggregationType"},"description":"Type of aggregation client must provide matching aggregation field below"}]},"RangeAggregation":{"name":"RangeAggregation","fqn":"RangeAggregation","slug":"range-aggregation","actions":[],"properties":[{"name":"buckets","slug":"buckets","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 50"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RangeBucket","referenceFqn":"RangeBucket"}},"description":"List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds"}]},"RangeBucket":{"name":"RangeBucket","fqn":"RangeBucket","slug":"range-bucket","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Inclusive lower bound of the range. Required if to is not given"},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Exclusive upper bound of the range. Required if from is not given"}]},"ScalarAggregation":{"name":"ScalarAggregation","fqn":"ScalarAggregation","slug":"scalar-aggregation","actions":[],"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScalarType","referenceFqn":"ScalarType"},"description":"Define the operator for the scalar aggregation"}]},"ScalarType":{"name":"ScalarType","fqn":"ScalarType","slug":"scalar-type","actions":[],"enumValues":[{"value":"COUNT_DISTINCT","description":"Count of distinct values."},{"value":"MAX","description":"Maximum value."},{"value":"MIN","description":"Minimum value."},{"value":"UNKNOWN_SCALAR_TYPE"}],"properties":[]},"NestedAggregationType":{"name":"NestedAggregationType","fqn":"NestedAggregationType","slug":"nested-aggregation-type","actions":[],"enumValues":[{"value":"DATE_HISTOGRAM","description":"An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week."},{"value":"RANGE","description":"An aggregation, where user can define set of ranges - each representing a bucket."},{"value":"SCALAR","description":"A single-value metric aggregation - such as min, max, sum, and avg."},{"value":"UNKNOWN_AGGREGATION_TYPE","description":"Unknown aggregation type."},{"value":"VALUE","description":"An aggregation where result buckets are dynamically built - one per unique value."}],"properties":[]},"ValueAggregation":{"name":"ValueAggregation","fqn":"ValueAggregation","slug":"value-aggregation","actions":[],"oneofProperties":{"options":[{"name":"includeOptions","slug":"include-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"IncludeMissingValuesOptions","referenceFqn":"IncludeMissingValuesOptions"},"description":"Options for including missing values"}]},"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"How many aggregations would you like to return? Can be between 1 and 250. 10 is the default."},{"name":"missingValues","slug":"missing-values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MissingValues","referenceFqn":"MissingValues"},"description":"Whether missing values are included in the aggregation results.\nDefault: `EXCLUDE`"},{"name":"sortDirection","slug":"sort-direction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortDirection","referenceFqn":"SortDirection"},"description":"Direction to sort in."},{"name":"sortType","slug":"sort-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortType","referenceFqn":"SortType"},"description":"Type of sort to perform."}]},"IncludeMissingValuesOptions":{"name":"IncludeMissingValuesOptions","fqn":"IncludeMissingValuesOptions","slug":"include-missing-values-options","actions":[],"properties":[{"name":"addToBucket","slug":"add-to-bucket","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 20"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ..."}]},"MissingValues":{"name":"MissingValues","fqn":"MissingValues","slug":"missing-values","actions":[],"enumValues":[{"value":"EXCLUDE","description":"Exclude missing values from the aggregation results."},{"value":"INCLUDE","description":"Included missing values in the aggregation results."}],"properties":[]},"SortDirection":{"name":"SortDirection","fqn":"SortDirection","slug":"sort-direction","actions":[],"enumValues":[{"value":"ASC","description":"Sort in ascending order."},{"value":"DESC","description":"Sort in descending order."}],"properties":[]},"SortType":{"name":"SortType","fqn":"SortType","slug":"sort-type","actions":[],"enumValues":[{"value":"COUNT","description":"Sort by number of matches."},{"value":"VALUE","description":"Sort alphabetically by field value."}],"properties":[]},"AggregationType":{"name":"AggregationType","fqn":"AggregationType","slug":"aggregation-type","actions":[],"enumValues":[{"value":"DATE_HISTOGRAM","description":"An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week."},{"value":"NESTED","description":"Multi-level aggregation, where each next aggregation is nested within the previous one."},{"value":"RANGE","description":"An aggregation, where user can define set of ranges - each representing a bucket."},{"value":"SCALAR","description":"A single-value metric aggregation - such as min, max, sum, and avg."},{"value":"UNKNOWN_AGGREGATION_TYPE"},{"value":"VALUE","description":"An aggregation where result buckets are dynamically built - one per unique value."}],"properties":[]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 512"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Sort order."}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":[{"value":"ASC","description":"Ascending order."},{"value":"DESC","description":"Descending order."}],"properties":[]},"SearchCategoriesOptions":{"name":"SearchCategoriesOptions","fqn":"SearchCategoriesOptions","slug":"search-categories-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RequestedFields","referenceFqn":"RequestedFields"}},"description":"Fields to include in the response."},{"name":"returnNonVisibleCategories","slug":"return-non-visible-categories","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to return the categories with `visible: false`.\n\nDefault: `false` - only visible categories are returned in the response"},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details.\n> **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests."}]},"SearchCategoriesResponse":{"name":"SearchCategoriesResponse","fqn":"SearchCategoriesResponse","slug":"search-categories-response","actions":[],"properties":[{"name":"aggregationData","slug":"aggregation-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AggregationData","referenceFqn":"AggregationData"},"description":"Aggregation data."},{"name":"categories","slug":"categories","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"}},"description":"List of categories."},{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorPagingMetadata","referenceFqn":"CursorPagingMetadata"},"description":"Paging metadata."}]},"AggregationData":{"name":"AggregationData","fqn":"AggregationData","slug":"aggregation-data","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 10000"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AggregationResults","referenceFqn":"AggregationResults"}},"description":"key = aggregation name (as derived from search request)"}]},"AggregationResults":{"name":"AggregationResults","fqn":"AggregationResults","slug":"aggregation-results","actions":[],"oneofProperties":{"result":[{"name":"dateHistogram","slug":"date-histogram","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DateHistogramResults","referenceFqn":"DateHistogramResults"},"description":"Date histogram aggregation results"},{"name":"groupedByValue","slug":"grouped-by-value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GroupByValueResults","referenceFqn":"GroupByValueResults"},"description":"Group by value aggregation results"},{"name":"nested","slug":"nested","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NestedResults","referenceFqn":"NestedResults"},"description":"Nested aggregation results"},{"name":"ranges","slug":"ranges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RangeResults","referenceFqn":"RangeResults"},"description":"Range aggregation results"},{"name":"scalar","slug":"scalar","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AggregationResultsScalarResult","referenceFqn":"AggregationResultsScalarResult"},"description":"Scalar aggregation results"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValueResults","referenceFqn":"ValueResults"},"description":"Value aggregation results"}]},"properties":[{"name":"fieldPath","slug":"field-path","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 200"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field to aggregate by as derived from search request"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"User-defined name of aggregation as derived from search request"},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AggregationType","referenceFqn":"AggregationType"},"description":"Type of aggregation that must match provided kind as derived from search request"}]},"DateHistogramResults":{"name":"DateHistogramResults","fqn":"DateHistogramResults","slug":"date-histogram-results","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 200"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DateHistogramResult","referenceFqn":"DateHistogramResult"}},"description":"List of date histogram aggregations"}]},"DateHistogramResult":{"name":"DateHistogramResult","fqn":"DateHistogramResult","slug":"date-histogram-result","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Count of documents in the bucket"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Date in ISO 8601 format"}]},"GroupByValueResults":{"name":"GroupByValueResults","fqn":"GroupByValueResults","slug":"group-by-value-results","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"NestedValueAggregationResult","referenceFqn":"NestedValueAggregationResult"}},"description":"List of value aggregations"}]},"NestedValueAggregationResult":{"name":"NestedValueAggregationResult","fqn":"NestedValueAggregationResult","slug":"nested-value-aggregation-result","actions":[],"properties":[{"name":"nestedResults","slug":"nested-results","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NestedAggregationResults","referenceFqn":"NestedAggregationResults"},"description":"Nested aggregations"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 1000"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Value of the field"}]},"NestedAggregationResults":{"name":"NestedAggregationResults","fqn":"NestedAggregationResults","slug":"nested-aggregation-results","actions":[],"oneofProperties":{"result":[{"name":"ranges","slug":"ranges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RangeResults","referenceFqn":"RangeResults"},"description":"Range aggregation results"},{"name":"scalar","slug":"scalar","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AggregationResultsScalarResult","referenceFqn":"AggregationResultsScalarResult"},"description":"Scalar aggregation results"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValueResults","referenceFqn":"ValueResults"},"description":"Value aggregation results"}]},"properties":[{"name":"fieldPath","slug":"field-path","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 200"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field to aggregate by, matches the one provided in request"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"User-defined name of aggregation, matches the one provided in request"},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AggregationType","referenceFqn":"AggregationType"},"description":"Type of aggregation that matches result"}]},"RangeResults":{"name":"RangeResults","fqn":"RangeResults","slug":"range-results","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 50"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RangeAggregationResult","referenceFqn":"RangeAggregationResult"}},"description":"List of ranges returned in same order as requested"}]},"RangeAggregationResult":{"name":"RangeAggregationResult","fqn":"RangeAggregationResult","slug":"range-aggregation-result","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Count of entities in this range"},{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Inclusive lower bound of the range"},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Exclusive upper bound of the range"}]},"AggregationResultsScalarResult":{"name":"AggregationResultsScalarResult","fqn":"AggregationResultsScalarResult","slug":"aggregation-results-scalar-result","actions":[],"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScalarType","referenceFqn":"ScalarType"},"description":"Type of scalar aggregation"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Value of the scalar aggregation"}]},"ValueResults":{"name":"ValueResults","fqn":"ValueResults","slug":"value-results","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 250"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ValueAggregationResult","referenceFqn":"ValueAggregationResult"}},"description":"List of value aggregations"}]},"ValueAggregationResult":{"name":"ValueAggregationResult","fqn":"ValueAggregationResult","slug":"value-aggregation-result","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Count of entities with this value"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 100"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Value of the field"}]},"NestedResults":{"name":"NestedResults","fqn":"NestedResults","slug":"nested-results","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 1000"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Results","referenceFqn":"Results"}},"description":"List of nested aggregations"}]},"Results":{"name":"Results","fqn":"Results","slug":"results","actions":[],"properties":[{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"REFERENCE","name":"NestedResultValue","referenceFqn":"NestedResultValue"}},"description":"List of nested aggregations"}]},"NestedResultValue":{"name":"NestedResultValue","fqn":"NestedResultValue","slug":"nested-result-value","actions":[],"oneofProperties":{"result":[{"name":"dateHistogram","slug":"date-histogram","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValueResult","referenceFqn":"ValueResult"},"description":"Date histogram aggregation result"},{"name":"range","slug":"range","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RangeResult","referenceFqn":"RangeResult"},"description":"Range aggregation result"},{"name":"scalar","slug":"scalar","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScalarResult","referenceFqn":"ScalarResult"},"description":"Scalar aggregation result"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValueResult","referenceFqn":"ValueResult"},"description":"Value aggregation result"}]},"properties":[]},"ValueResult":{"name":"ValueResult","fqn":"ValueResult","slug":"value-result","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Count of entities with this value"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 1000"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Value of the field"}]},"RangeResult":{"name":"RangeResult","fqn":"RangeResult","slug":"range-result","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Count of entities in this range"},{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Inclusive lower bound of the range"},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Exclusive upper bound of the range"}]},"ScalarResult":{"name":"ScalarResult","fqn":"ScalarResult","slug":"scalar-result","actions":[],"properties":[{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Value of the scalar aggregation"}]},"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 the response."},{"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."}]},"SetArrangedItemsOptions":{"name":"SetArrangedItemsOptions","fqn":"SetArrangedItemsOptions","slug":"set-arranged-items-options","actions":[],"properties":[{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of items to set."}]},"SetArrangedItemsResponse":{"name":"SetArrangedItemsResponse","fqn":"SetArrangedItemsResponse","slug":"set-arranged-items-response","actions":[],"properties":[{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of arranged items."}]},"UpdateCategory":{"name":"UpdateCategory","fqn":"UpdateCategory","slug":"update-category","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the category was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","immutable"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the category was updated."},{"name":"breadcrumbsInfo","slug":"breadcrumbs-info","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BreadcrumbsInfo","referenceFqn":"BreadcrumbsInfo"},"description":"Category breadcrumbs.\n\n> **Note:** Returned only when you pass `\"BREADCRUMBS_INFO\"` to the `fields` array in Categories API requests."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 600"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category description.\n> **Note:** This field is returned only when you pass `fields: \"DESCRIPTION\"` in the request."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"ExtendedFields"},"description":"Custom extended fields for the category object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category image.\n\n+ Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).\n+ Pass full image URL to upload to Wix Media Manager."},{"name":"itemCounter","slug":"item-counter","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items in this category."},{"name":"managingAppId","slug":"managing-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID","immutable"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app responsible for managing the items in this category.\n\nPass your app ID to restrict updating and deleting items in this category to your app only."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["minLength 1","maxLength 80"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category name."},{"name":"parentCategory","slug":"parent-category","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable"],"type":{"kind":"REFERENCE","name":"ParentCategory","referenceFqn":"ParentCategory"},"description":"Parent category reference data."},{"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 category is updated.\nTo prevent conflicting changes, the current revision must be passed when updating.\n\nIgnored when creating a category."},{"name":"richContentDescription","slug":"rich-content-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RichContent","referenceFqn":"RichContent"},"description":"Category description using rich content.\n> **Note:** Returned only when you pass `\"RICH_CONTENT_DESCRIPTION\"` to the `fields` array in Categories API requests.\n\n\nSee Ricos document reference\n"},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format URL_SLUG"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category slug.\n\nIf not provided, the slug is autogenerated based on the category name."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["immutable"],"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the category is visible to site visitors in dynamic pages.\n\n+ If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.\n+ Passing `true` will fail if the visibility of any parent categories is `false`.\n+ Default: `false`."}]},"UpdateCategoryOptions":{"name":"UpdateCategoryOptions","fqn":"UpdateCategoryOptions","slug":"update-category-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SingleEntityOpsRequestedFields","referenceFqn":"SingleEntityOpsRequestedFields"}},"description":"Fields to include in the response."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"UpdateCategoryVisibilityOptions":{"name":"UpdateCategoryVisibilityOptions","fqn":"UpdateCategoryVisibilityOptions","slug":"update-category-visibility-options","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxSize 100"],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SingleEntityOpsRequestedFields","referenceFqn":"SingleEntityOpsRequestedFields"}},"description":"Fields to include in the response."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Latest revision of the category.\nTo prevent conflicting changes, the current revision must be passed on update."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the category is visible to site visitors in dynamic pages.\n\n+ If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.\n+ Passing `true` will fail if the visibility of any parent categories is `false`."}]},"UpdateCategoryVisibilityResponse":{"name":"UpdateCategoryVisibilityResponse","fqn":"UpdateCategoryVisibilityResponse","slug":"update-category-visibility-response","actions":[],"properties":[{"name":"category","slug":"category","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Updated category."}]},"BulkAddItemToCategoriesApplicationErrors":{"name":"BulkAddItemToCategoriesApplicationErrors","fqn":"BulkAddItemToCategoriesApplicationErrors","slug":"bulk-add-item-to-categories-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"BulkAddItemsToCategoryApplicationErrors":{"name":"BulkAddItemsToCategoryApplicationErrors","fqn":"BulkAddItemsToCategoryApplicationErrors","slug":"bulk-add-items-to-category-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"BulkRemoveItemFromCategoriesApplicationErrors":{"name":"BulkRemoveItemFromCategoriesApplicationErrors","fqn":"BulkRemoveItemFromCategoriesApplicationErrors","slug":"bulk-remove-item-from-categories-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"BulkRemoveItemsFromCategoryApplicationErrors":{"name":"BulkRemoveItemsFromCategoryApplicationErrors","fqn":"BulkRemoveItemsFromCategoryApplicationErrors","slug":"bulk-remove-items-from-category-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"BulkUpdateCategoriesApplicationErrors":{"name":"BulkUpdateCategoriesApplicationErrors","fqn":"BulkUpdateCategoriesApplicationErrors","slug":"bulk-update-categories-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1561":{"name":"CreateCategoryApplicationErrors.union_1561","fqn":"CreateCategoryApplicationErrors.union_1561","slug":"create-category-application-errors-union-1561","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1565":{"name":"CreateCategoryApplicationErrors.union_1565","fqn":"CreateCategoryApplicationErrors.union_1565","slug":"create-category-application-errors-union-1565","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1569":{"name":"CreateCategoryApplicationErrors.union_1569","fqn":"CreateCategoryApplicationErrors.union_1569","slug":"create-category-application-errors-union-1569","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1573":{"name":"CreateCategoryApplicationErrors.union_1573","fqn":"CreateCategoryApplicationErrors.union_1573","slug":"create-category-application-errors-union-1573","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1577":{"name":"CreateCategoryApplicationErrors.union_1577","fqn":"CreateCategoryApplicationErrors.union_1577","slug":"create-category-application-errors-union-1577","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1581":{"name":"CreateCategoryApplicationErrors.union_1581","fqn":"CreateCategoryApplicationErrors.union_1581","slug":"create-category-application-errors-union-1581","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"CreateCategoryApplicationErrors.union_1585":{"name":"CreateCategoryApplicationErrors.union_1585","fqn":"CreateCategoryApplicationErrors.union_1585","slug":"create-category-application-errors-union-1585","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"DeleteCategoryApplicationErrors":{"name":"DeleteCategoryApplicationErrors","fqn":"DeleteCategoryApplicationErrors","slug":"delete-category-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"MoveCategoryApplicationErrors.union_1604":{"name":"MoveCategoryApplicationErrors.union_1604","fqn":"MoveCategoryApplicationErrors.union_1604","slug":"move-category-application-errors-union-1604","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"MoveCategoryApplicationErrors.union_1608":{"name":"MoveCategoryApplicationErrors.union_1608","fqn":"MoveCategoryApplicationErrors.union_1608","slug":"move-category-application-errors-union-1608","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"MoveCategoryApplicationErrors.union_1612":{"name":"MoveCategoryApplicationErrors.union_1612","fqn":"MoveCategoryApplicationErrors.union_1612","slug":"move-category-application-errors-union-1612","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"MoveCategoryApplicationErrors.union_1616":{"name":"MoveCategoryApplicationErrors.union_1616","fqn":"MoveCategoryApplicationErrors.union_1616","slug":"move-category-application-errors-union-1616","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"MoveCategoryApplicationErrors.union_1620":{"name":"MoveCategoryApplicationErrors.union_1620","fqn":"MoveCategoryApplicationErrors.union_1620","slug":"move-category-application-errors-union-1620","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"SetArrangedItemsApplicationErrors":{"name":"SetArrangedItemsApplicationErrors","fqn":"SetArrangedItemsApplicationErrors","slug":"set-arranged-items-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"UpdateCategoryApplicationErrors.union_1590":{"name":"UpdateCategoryApplicationErrors.union_1590","fqn":"UpdateCategoryApplicationErrors.union_1590","slug":"update-category-application-errors-union-1590","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"UpdateCategoryApplicationErrors.union_1594":{"name":"UpdateCategoryApplicationErrors.union_1594","fqn":"UpdateCategoryApplicationErrors.union_1594","slug":"update-category-application-errors-union-1594","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"UpdateCategoryVisibilityApplicationErrors":{"name":"UpdateCategoryVisibilityApplicationErrors","fqn":"UpdateCategoryVisibilityApplicationErrors","slug":"update-category-visibility-application-errors","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"OnCategoryCreatedHandler":{"name":"OnCategoryCreatedHandler","fqn":"OnCategoryCreatedHandler","slug":"on-category-created-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryCreatedEnvelope","referenceFqn":"CategoryCreatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryCreatedEnvelope":{"name":"CategoryCreatedEnvelope","fqn":"CategoryCreatedEnvelope","slug":"category-created-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"EventMetadata":{"name":"EventMetadata","fqn":"EventMetadata","slug":"event-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID. With this ID you can easily spot duplicated events and ignore them."},{"name":"entityEventSequence","slug":"entity-event-sequence","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\nYou can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it."},{"name":"entityFqdn","slug":"entity-fqdn","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\nFor example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`."},{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`."},{"name":"eventType","slug":"event-type","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["maxLength 150"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Event type."},{"name":"identity","slug":"identity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"IdentificationData","referenceFqn":"IdentificationData"},"description":"The identification type and identity data."},{"name":"instanceId","slug":"instance-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"App instance ID."},{"name":"originatedFrom","slug":"originated-from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"If present, indicates the action that triggered the event."},{"name":"slug","slug":"slug","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event action name, placed at the top level to make it easier for users to dispatch messages.\nFor example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR)."}]},"IdentificationData":{"name":"IdentificationData","fqn":"IdentificationData","slug":"identification-data","actions":[],"oneofProperties":{"id":[{"name":"anonymousVisitorId","slug":"anonymous-visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a site visitor that has not logged in to the site."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of an app."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a site visitor that has logged in to the site."},{"name":"wixUserId","slug":"wix-user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of a Wix user (site owner, contributor, etc.)."}]},"properties":[{"name":"identityType","slug":"identity-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WebhookIdentityType","referenceFqn":"WebhookIdentityType"}}]},"WebhookIdentityType":{"name":"WebhookIdentityType","fqn":"WebhookIdentityType","slug":"webhook-identity-type","actions":[],"enumValues":[{"value":"ANONYMOUS_VISITOR"},{"value":"APP"},{"value":"MEMBER"},{"value":"UNKNOWN"},{"value":"WIX_USER"}],"properties":[]},"OnCategoryDeletedHandler":{"name":"OnCategoryDeletedHandler","fqn":"OnCategoryDeletedHandler","slug":"on-category-deleted-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryDeletedEnvelope","referenceFqn":"CategoryDeletedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryDeletedEnvelope":{"name":"CategoryDeletedEnvelope","fqn":"CategoryDeletedEnvelope","slug":"category-deleted-envelope","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"OnCategoryItemAddedToCategoryHandler":{"name":"OnCategoryItemAddedToCategoryHandler","fqn":"OnCategoryItemAddedToCategoryHandler","slug":"on-category-item-added-to-category-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryItemAddedToCategoryEnvelope","referenceFqn":"CategoryItemAddedToCategoryEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryItemAddedToCategoryEnvelope":{"name":"CategoryItemAddedToCategoryEnvelope","fqn":"CategoryItemAddedToCategoryEnvelope","slug":"category-item-added-to-category-envelope","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAddedToCategory","referenceFqn":"ItemAddedToCategory"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"ItemAddedToCategory":{"name":"ItemAddedToCategory","fqn":"ItemAddedToCategory","slug":"item-added-to-category","actions":[],"properties":[{"name":"addedItem","slug":"added-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Details about the added item."},{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"OnCategoryItemRemovedFromCategoryHandler":{"name":"OnCategoryItemRemovedFromCategoryHandler","fqn":"OnCategoryItemRemovedFromCategoryHandler","slug":"on-category-item-removed-from-category-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryItemRemovedFromCategoryEnvelope","referenceFqn":"CategoryItemRemovedFromCategoryEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryItemRemovedFromCategoryEnvelope":{"name":"CategoryItemRemovedFromCategoryEnvelope","fqn":"CategoryItemRemovedFromCategoryEnvelope","slug":"category-item-removed-from-category-envelope","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemRemovedFromCategory","referenceFqn":"ItemRemovedFromCategory"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"ItemRemovedFromCategory":{"name":"ItemRemovedFromCategory","fqn":"ItemRemovedFromCategory","slug":"item-removed-from-category","actions":[],"properties":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"removedItem","slug":"removed-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Details about the removed item."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"OnCategoryItemsArrangedInCategoryHandler":{"name":"OnCategoryItemsArrangedInCategoryHandler","fqn":"OnCategoryItemsArrangedInCategoryHandler","slug":"on-category-items-arranged-in-category-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryItemsArrangedInCategoryEnvelope","referenceFqn":"CategoryItemsArrangedInCategoryEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryItemsArrangedInCategoryEnvelope":{"name":"CategoryItemsArrangedInCategoryEnvelope","fqn":"CategoryItemsArrangedInCategoryEnvelope","slug":"category-items-arranged-in-category-envelope","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemsArrangedInCategory","referenceFqn":"ItemsArrangedInCategory"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"ItemsArrangedInCategory":{"name":"ItemsArrangedInCategory","fqn":"ItemsArrangedInCategory","slug":"items-arranged-in-category","actions":[],"properties":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"OnCategoryMovedHandler":{"name":"OnCategoryMovedHandler","fqn":"OnCategoryMovedHandler","slug":"on-category-moved-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryMovedEnvelope","referenceFqn":"CategoryMovedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryMovedEnvelope":{"name":"CategoryMovedEnvelope","fqn":"CategoryMovedEnvelope","slug":"category-moved-envelope","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryMoved","referenceFqn":"CategoryMoved"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]},"CategoryMoved":{"name":"CategoryMoved","fqn":"CategoryMoved","slug":"category-moved","actions":[],"properties":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","validations":["format GUID"],"type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"parentCategory","slug":"parent-category","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ParentCategory","referenceFqn":"ParentCategory"},"description":"Parent category details."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}]},"OnCategoryUpdatedHandler":{"name":"OnCategoryUpdatedHandler","fqn":"OnCategoryUpdatedHandler","slug":"on-category-updated-handler","properties":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CategoryUpdatedEnvelope","referenceFqn":"CategoryUpdatedEnvelope"}}],"returnType":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"void"},{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}}]}},"CategoryUpdatedEnvelope":{"name":"CategoryUpdatedEnvelope","fqn":"CategoryUpdatedEnvelope","slug":"category-updated-envelope","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"}},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"EventMetadata"}}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.categories.v1.category"},"actions":[{"name":"bulkAddItemToCategories","fqn":"bulkAddItemToCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.BulkAddItemToCategories","slug":"bulk-add-item-to-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","item.appId","item.catalogItemId","options","options.categoryIds","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkAddItemToCategoriesResponse","referenceFqn":"BulkAddItemToCategoriesResponse"}},"examples":[{"title":"bulkAddItemToCategories","content":"import { categories } from '@wix/categories';\n\nasync function bulkAddItemToCategories(item, options) {\n const response = await categories.bulkAddItemToCategories(item, options);\n};"},{"title":"bulkAddItemToCategories (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkAddItemToCategoriesMethod(item, options) {\n const elevatedBulkAddItemToCategories = auth.elevate(categories.bulkAddItemToCategories);\n const response = await elevatedBulkAddItemToCategories(item, options);\n}"},{"title":"bulkAddItemToCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkAddItemToCategories(item, options) {\n const response = await myWixClient.categories.bulkAddItemToCategories(item, options);\n};"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Item to add."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkAddItemToCategoriesOptions","referenceFqn":"BulkAddItemToCategoriesOptions"}}],"description":"Adds a single item to multiple categories.","sdkErrors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED","description":"Operation isn't allowed on a category with `managingAppId`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"bulkAddItemsToCategory","fqn":"bulkAddItemsToCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.BulkAddItemsToCategory","slug":"bulk-add-items-to-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","items","items.appId","items.catalogItemId","options","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_ADD_ITEM"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkAddItemsToCategoryResponse","referenceFqn":"BulkAddItemsToCategoryResponse"}},"examples":[{"title":"bulkAddItemsToCategory","content":"import { categories } from '@wix/categories';\n\nasync function bulkAddItemsToCategory(categoryId, items, options) {\n const response = await categories.bulkAddItemsToCategory(categoryId, items, options);\n};"},{"title":"bulkAddItemsToCategory (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkAddItemsToCategoryMethod(categoryId, items, options) {\n const elevatedBulkAddItemsToCategory = auth.elevate(categories.bulkAddItemsToCategory);\n const response = await elevatedBulkAddItemsToCategory(categoryId, items, options);\n}"},{"title":"bulkAddItemsToCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkAddItemsToCategory(categoryId, items, options) {\n const response = await myWixClient.categories.bulkAddItemsToCategory(categoryId, items, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of items to add."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkAddItemsToCategoryOptions","referenceFqn":"BulkAddItemsToCategoryOptions"}}],"description":"Adds multiple items to a single category.","sdkErrors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED","description":"Operation isn't allowed on a category with `managingAppId`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"bulkRemoveItemFromCategories","fqn":"bulkRemoveItemFromCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.BulkRemoveItemFromCategories","slug":"bulk-remove-item-from-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","item.appId","item.catalogItemId","options","options.categoryIds","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkRemoveItemFromCategoriesResponse","referenceFqn":"BulkRemoveItemFromCategoriesResponse"}},"examples":[{"title":"bulkRemoveItemFromCategories","content":"import { categories } from '@wix/categories';\n\nasync function bulkRemoveItemFromCategories(item, options) {\n const response = await categories.bulkRemoveItemFromCategories(item, options);\n};"},{"title":"bulkRemoveItemFromCategories (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkRemoveItemFromCategoriesMethod(item, options) {\n const elevatedBulkRemoveItemFromCategories = auth.elevate(categories.bulkRemoveItemFromCategories);\n const response = await elevatedBulkRemoveItemFromCategories(item, options);\n}"},{"title":"bulkRemoveItemFromCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkRemoveItemFromCategories(item, options) {\n const response = await myWixClient.categories.bulkRemoveItemFromCategories(item, options);\n};"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Item to remove."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkRemoveItemFromCategoriesOptions","referenceFqn":"BulkRemoveItemFromCategoriesOptions"}}],"description":"Removes a single item from multiple categories.","sdkErrors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED","description":"Operation isn't allowed on a category with `managingAppId`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"bulkRemoveItemsFromCategory","fqn":"bulkRemoveItemsFromCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.BulkRemoveItemsFromCategory","slug":"bulk-remove-items-from-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","items","items.appId","items.catalogItemId","options","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_REMOVE_ITEM"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkRemoveItemsFromCategoryResponse","referenceFqn":"BulkRemoveItemsFromCategoryResponse"}},"examples":[{"title":"bulkRemoveItemsFromCategory","content":"import { categories } from '@wix/categories';\n\nasync function bulkRemoveItemsFromCategory(categoryId, items, options) {\n const response = await categories.bulkRemoveItemsFromCategory(categoryId, items, options);\n};"},{"title":"bulkRemoveItemsFromCategory (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkRemoveItemsFromCategoryMethod(categoryId, items, options) {\n const elevatedBulkRemoveItemsFromCategory = auth.elevate(categories.bulkRemoveItemsFromCategory);\n const response = await elevatedBulkRemoveItemsFromCategory(categoryId, items, options);\n}"},{"title":"bulkRemoveItemsFromCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkRemoveItemsFromCategory(categoryId, items, options) {\n const response = await myWixClient.categories.bulkRemoveItemsFromCategory(categoryId, items, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of items to remove."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkRemoveItemsFromCategoryOptions","referenceFqn":"BulkRemoveItemsFromCategoryOptions"}}],"description":"Removes multiple items from a single category.","sdkErrors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED","description":"Operation isn't allowed on a category with `managingAppId`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"bulkShowCategories","fqn":"bulkShowCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.BulkShowCategories","slug":"bulk-show-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryIds","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkShowCategoriesResponse","referenceFqn":"BulkShowCategoriesResponse"}},"examples":[{"title":"bulkShowCategories","content":"import { categories } from '@wix/categories';\n\nasync function bulkShowCategories(categoryIds, options) {\n const response = await categories.bulkShowCategories(categoryIds, options);\n};"},{"title":"bulkShowCategories (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkShowCategoriesMethod(categoryIds, options) {\n const elevatedBulkShowCategories = auth.elevate(categories.bulkShowCategories);\n const response = await elevatedBulkShowCategories(categoryIds, options);\n}"},{"title":"bulkShowCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkShowCategories(categoryIds, options) {\n const response = await myWixClient.categories.bulkShowCategories(categoryIds, options);\n};"}],"actionParams":[{"name":"categoryIds","slug":"category-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the categories to update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkShowCategoriesOptions","referenceFqn":"BulkShowCategoriesOptions"}}],"description":"Updates the visibility of multiple categories so that they are visible to site visitors in dynamic pages.\n\nCalling this method sets each category's `visible` field to `true`.\n> **Note:** If one of the passed categories has a parent category that is not visible, the passed category will not be updated.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"bulkUpdateCategories","fqn":"bulkUpdateCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories","slug":"bulk-update-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categories","categories.category","categories.category._id","categories.category.revision","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkUpdateCategoriesResponse","referenceFqn":"BulkUpdateCategoriesResponse"}},"examples":[{"title":"bulkUpdateCategories","content":"import { categories } from '@wix/categories';\n\nasync function bulkUpdateCategories(categories, options) {\n const response = await categories.bulkUpdateCategories(categories, options);\n};"},{"title":"bulkUpdateCategories (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myBulkUpdateCategoriesMethod(categories, options) {\n const elevatedBulkUpdateCategories = auth.elevate(categories.bulkUpdateCategories);\n const response = await elevatedBulkUpdateCategories(categories, options);\n}"},{"title":"bulkUpdateCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function bulkUpdateCategories(categories, options) {\n const response = await myWixClient.categories.bulkUpdateCategories(categories, options);\n};"}],"actionParams":[{"name":"categories","slug":"categories","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"MaskedCategory","referenceFqn":"MaskedCategory"}},"description":"List of categories to update."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkUpdateCategoriesOptions","referenceFqn":"BulkUpdateCategoriesOptions"}}],"description":"Updates multiple categories.\n\nEach time a category is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating a category.\nThis ensures you're working with the latest category and prevents unintended overwrites.","sdkErrors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UPDATE_OF_FIELD_NOT_ALLOWED","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"UPDATE_OF_FIELD_NOT_ALLOWED"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"countCategories","fqn":"countCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.CountCategories","slug":"count-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CountCategoriesResponse","referenceFqn":"CountCategoriesResponse"}},"examples":[{"title":"countCategories","content":"import { categories } from '@wix/categories';\n\nasync function countCategories(options) {\n const response = await categories.countCategories(options);\n};"},{"title":"countCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function countCategories(options) {\n const response = await myWixClient.categories.countCategories(options);\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CountCategoriesOptions","referenceFqn":"CountCategoriesOptions"}}],"description":"Counts the number of categories that match the provided filtering.\n\nFor field support for filters and sorting,\nsee [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"createCategory","fqn":"createCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.CreateCategory","slug":"create-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["category","category.name","category.parentCategory._id","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_CREATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Created category."},"examples":[{"title":"createCategory","content":"import { categories } from '@wix/categories';\n\nasync function createCategory(category, options) {\n const response = await categories.createCategory(category, options);\n};"},{"title":"createCategory (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myCreateCategoryMethod(category, options) {\n const elevatedCreateCategory = auth.elevate(categories.createCategory);\n const response = await elevatedCreateCategory(category, options);\n}"},{"title":"createCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function createCategory(category, options) {\n const response = await myWixClient.categories.createCategory(category, options);\n};"}],"actionParams":[{"name":"category","slug":"category","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Category to create."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateCategoryOptions","referenceFqn":"CreateCategoryOptions"}}],"description":"Creates a category.","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"NAMESPACE_NOT_FOUND_IN_DEV_CENTER","description":"App with `treeReference.appNamespace` not found in the [app dashboard](https://dev.wix.com/dc3/my-apps/).","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"NAMESPACE_NOT_FOUND_IN_DEV_CENTER"}},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG","description":"`slug` must be unique.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORIES_LIMIT_PER_TREE_EXCEEDED","description":"Category limit per tree exceeded. Max of 1000 categories per tree.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CATEGORIES_LIMIT_PER_TREE_EXCEEDED"}},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PARENT_CATEGORY_NOT_IN_TREE","description":"Category's parentCategoryId must belong to the same tree as treeReference.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PARENT_CATEGORY_NOT_IN_TREE"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TREES_LIMIT_EXCEEDED","description":"Tree limit per site exceeded.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TREES_LIMIT_EXCEEDED"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED","description":"Tree depth limited to 4 levels.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PARENT_CATEGORY_HIDDEN","description":"Category can't be visible if parent category isn't visible.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PARENT_CATEGORY_HIDDEN"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"deleteCategory","fqn":"deleteCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.DeleteCategory","slug":"delete-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","treeReference","treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_DELETE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"deleteCategory","content":"import { categories } from '@wix/categories';\n\nasync function deleteCategory(categoryId, treeReference) {\n const response = await categories.deleteCategory(categoryId, treeReference);\n};"},{"title":"deleteCategory (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myDeleteCategoryMethod(categoryId, treeReference) {\n const elevatedDeleteCategory = auth.elevate(categories.deleteCategory);\n const response = await elevatedDeleteCategory(categoryId, treeReference);\n}"},{"title":"deleteCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteCategory(categoryId, treeReference) {\n const response = await myWixClient.categories.deleteCategory(categoryId, treeReference);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}],"description":"Deletes a category.","sdkErrors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED","description":"Categories with `managingAppId` can only be deleted by the managing app.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MANAGED_CATEGORY_OPERATION_NOT_ALLOWED"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"getArrangedItems","fqn":"getArrangedItems","fullFqn":"com.wix.categories.api.v1.CategoriesService.GetArrangedItems","slug":"get-arranged-items","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","treeReference","treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetArrangedItemsResponse","referenceFqn":"GetArrangedItemsResponse"}},"examples":[{"title":"getArrangedItems","content":"import { categories } from '@wix/categories';\n\nasync function getArrangedItems(categoryId, treeReference) {\n const response = await categories.getArrangedItems(categoryId, treeReference);\n};"},{"title":"getArrangedItems (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getArrangedItems(categoryId, treeReference) {\n const response = await myWixClient.categories.getArrangedItems(categoryId, treeReference);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."}],"description":"Retrieves a list of arranged items in a category.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"getCategory","fqn":"getCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.GetCategory","slug":"get-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","treeReference","treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Category."},"examples":[{"title":"getCategory","content":"import { categories } from '@wix/categories';\n\nasync function getCategory(categoryId, treeReference, options) {\n const response = await categories.getCategory(categoryId, treeReference, options);\n};"},{"title":"getCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getCategory(categoryId, treeReference, options) {\n const response = await myWixClient.categories.getCategory(categoryId, treeReference, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetCategoryOptions","referenceFqn":"GetCategoryOptions"}}],"description":"Retrieves a category.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"listCategoriesForItem","fqn":"listCategoriesForItem","fullFqn":"com.wix.categories.api.v1.CategoriesService.ListCategoriesForItem","slug":"list-categories-for-item","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["item","options","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListCategoriesForItemResponse","referenceFqn":"ListCategoriesForItemResponse"}},"examples":[{"title":"listCategoriesForItem","content":"import { categories } from '@wix/categories';\n\nasync function listCategoriesForItem(item, options) {\n const response = await categories.listCategoriesForItem(item, options);\n};"},{"title":"listCategoriesForItem (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listCategoriesForItem(item, options) {\n const response = await myWixClient.categories.listCategoriesForItem(item, options);\n};"}],"actionParams":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"},"description":"Item reference info."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListCategoriesForItemOptions","referenceFqn":"ListCategoriesForItemOptions"}}],"description":"Retrieves a list of categories that contain the specified item.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"listCategoriesForItems","fqn":"listCategoriesForItems","fullFqn":"com.wix.categories.api.v1.CategoriesService.ListCategoriesForItems","slug":"list-categories-for-items","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["items","items.appId","items.catalogItemId","options","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListCategoriesForItemsResponse","referenceFqn":"ListCategoriesForItemsResponse"}},"examples":[{"title":"listCategoriesForItems","content":"import { categories } from '@wix/categories';\n\nasync function listCategoriesForItems(items, options) {\n const response = await categories.listCategoriesForItems(items, options);\n};"},{"title":"listCategoriesForItems (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listCategoriesForItems(items, options) {\n const response = await myWixClient.categories.listCategoriesForItems(items, options);\n};"}],"actionParams":[{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemReference","referenceFqn":"ItemReference"}},"description":"List of Item reference info."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListCategoriesForItemsOptions","referenceFqn":"ListCategoriesForItemsOptions"}}],"description":"Retrieves a map where the keys are ItemReferences, and the values are lists of categories that contain the corresponding item.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"listItemsInCategory","fqn":"listItemsInCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.ListItemsInCategory","slug":"list-items-in-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","treeReference","treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListItemsInCategoryResponse","referenceFqn":"ListItemsInCategoryResponse"}},"examples":[{"title":"listItemsInCategory","content":"import { categories } from '@wix/categories';\n\nasync function listItemsInCategory(categoryId, treeReference, options) {\n const response = await categories.listItemsInCategory(categoryId, treeReference, options);\n};"},{"title":"listItemsInCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listItemsInCategory(categoryId, treeReference, options) {\n const response = await myWixClient.categories.listItemsInCategory(categoryId, treeReference, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListItemsInCategoryOptions","referenceFqn":"ListItemsInCategoryOptions"}}],"description":"Retrieves a list of up to 100 items from a single category, given the provided cursor paging.\n\n\nList Items In Categories defaults to sorting by the time the item was added to the category, in descending order.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"listTrees","fqn":"listTrees","fullFqn":"com.wix.categories.api.v1.CategoriesService.ListTrees","slug":"list-trees","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListTreesResponse","referenceFqn":"ListTreesResponse"}},"examples":[{"title":"listTrees","content":"import { categories } from '@wix/categories';\n\nasync function listTrees() {\n const response = await categories.listTrees();\n};"},{"title":"listTrees (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listTrees() {\n const response = await myWixClient.categories.listTrees();\n};"}],"description":"Retrieves a list of all trees installed on the site, sorted by `appNamespace` in ascending order.","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"moveCategory","fqn":"moveCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.MoveCategory","slug":"move-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","options.position","treeReference","treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_MOVE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MoveCategoryResponse","referenceFqn":"MoveCategoryResponse"}},"examples":[{"title":"moveCategory","content":"import { categories } from '@wix/categories';\n\nasync function moveCategory(categoryId, treeReference, options) {\n const response = await categories.moveCategory(categoryId, treeReference, options);\n};"},{"title":"moveCategory (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myMoveCategoryMethod(categoryId, treeReference, options) {\n const elevatedMoveCategory = auth.elevate(categories.moveCategory);\n const response = await elevatedMoveCategory(categoryId, treeReference, options);\n}"},{"title":"moveCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function moveCategory(categoryId, treeReference, options) {\n const response = await myWixClient.categories.moveCategory(categoryId, treeReference, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the category to move."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MoveCategoryOptions","referenceFqn":"MoveCategoryOptions"}}],"description":"Moves a category within its parent category, or to a different parent category.","sdkErrors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"PARENT_CATEGORY_NOT_IN_TREE","description":"Category's parentCategoryId must belong to the same tree as treeReference.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PARENT_CATEGORY_NOT_IN_TREE"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED","description":"Tree depth limited to 4 levels.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CATEGORY_DEPTH_LIMIT_EXCEEDED"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TREE_CYCLE_DETECTED","description":"Cycles are not allowed in the tree.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"TREE_CYCLE_DETECTED"}},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MISSING_AFTER_CATEGORY","description":"`moveAfterCategoryId` must be provided when `position` = `AFTER`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"MISSING_AFTER_CATEGORY"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"AFTER_CATEGORY_NOT_IN_PARENT","description":"Category can only be moved with `moveAfterCategoryId` after a category with the same `parentCategoryId`.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"AFTER_CATEGORY_NOT_IN_PARENT"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"queryCategories","fqn":"queryCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.QueryCategories","slug":"query-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},"examples":[{"title":"queryCategories","content":"import { categories } from '@wix/categories';\n\nasync function queryCategories() {\n const { items } = await categories.queryCategories().find();\n};"},{"title":"queryCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function queryCategories() {\n const { items } = await myWixClient.categories.queryCategories().find();\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QueryCategoriesOptions","referenceFqn":"QueryCategoriesOptions"}}],"description":"Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.\nPass supported values to the `fields` array in the request to include those fields in the response.\n\nFor field support for filters and sorting,\nsee [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge)|\n|`_createdDate`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`gt()`](/categories-query-builder/gt),[`ge()`](/categories-query-builder/ge),[`ascending()`](/categories-query-builder/ascending),[`descending()`](/categories-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`gt()`](/categories-query-builder/gt),[`ge()`](/categories-query-builder/ge),[`ascending()`](/categories-query-builder/ascending),[`descending()`](/categories-query-builder/descending)|\n|`name`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge),[`ascending()`](/categories-query-builder/ascending),[`descending()`](/categories-query-builder/descending)|\n|`description`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge)|\n|`visible`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some)|\n|`parentCategory.id`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge),[`ascending()`](/categories-query-builder/ascending),[`descending()`](/categories-query-builder/descending)|\n|`parentCategory.index`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`gt()`](/categories-query-builder/gt),[`ge()`](/categories-query-builder/ge),[`ascending()`](/categories-query-builder/ascending),[`descending()`](/categories-query-builder/descending)|\n|`slug`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge)|\n|`treeReference.appNamespace`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge)|\n|`treeReference.treeKey`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge)|\n|`managingAppId`|[`eq()`](/categories-query-builder/eq),[`ne()`](/categories-query-builder/ne),[`exists()`](/categories-query-builder/exists),[`in()`](/categories-query-builder/in),[`hasSome()`](/categories-query-builder/has-some),[`startsWith()`](/categories-query-builder/starts-with),[`gt()`](/categories-query-builder/gt),[`lt()`](/categories-query-builder/lt),[`le()`](/categories-query-builder/le),[`ge()`](/categories-query-builder/ge),[`ascending()`](/categories-query-builder/ascending),[`descending()`](/categories-query-builder/descending)|","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"searchCategories","fqn":"searchCategories","fullFqn":"com.wix.categories.api.v1.CategoriesService.SearchCategories","slug":"search-categories","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["options.treeReference","options.treeReference.appNamespace","search"],"permissionIds":["CATEGORIES.CATEGORY_READ"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SearchCategoriesResponse","referenceFqn":"SearchCategoriesResponse"}},"examples":[{"title":"searchCategories","content":"import { categories } from '@wix/categories';\n\nasync function searchCategories(search, options) {\n const response = await categories.searchCategories(search, options);\n};"},{"title":"searchCategories (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function searchCategories(search, options) {\n const response = await myWixClient.categories.searchCategories(search, options);\n};"}],"actionParams":[{"name":"search","slug":"search","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CursorSearch","referenceFqn":"CursorSearch"},"description":"Search options."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SearchCategoriesOptions","referenceFqn":"SearchCategoriesOptions"}}],"description":"Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.\nPass supported values to the `fields` array in the request to include those fields in the response.\n\n\nSearch Categories runs with these defaults, which you can override:\n\n- `createdDate` is sorted in `DESC` order\n- `cursorPaging.limit` is `100`\n\nFor field support for filters and sorting,\nsee [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).\n\nTo learn about working with _Search_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).\n\n| Property | Capabilities | Filters\n|-------|------------|------|\n| `_id` | Search: ✗
Aggregate: ✓
Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `slug` | Search: ✗
Aggregate: ✓
Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `treeReference.appNamespace` | Search: ✗
Aggregate: ✓
Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `treeReference.treeKey` | Search: ✗
Aggregate: ✓
Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `visible` | Search: ✗
Aggregate: ✓
Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |\n| `_createdDate` | Search: ✗
Aggregate: ✓
Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |\n| `_updatedDate` | Search: ✗
Aggregate: ✓
Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |\n| `managingAppId` | Search: ✗
Aggregate: ✓
Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `name` | Search: ✓
Aggregate: ✓
Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `parentCategory._id` | Search: ✗
Aggregate: ✓
Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |\n| `parentCategory.index` | Search: ✗
Aggregate: ✓
Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |\n| `description` | Search: ✓
Aggregate: ✗
Sort: ✗ | |\n","sdkErrors":[],"kind":"GENERAL","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":false},{"name":"setArrangedItems","fqn":"setArrangedItems","fullFqn":"com.wix.categories.api.v1.CategoriesService.SetArrangedItems","slug":"set-arranged-items","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","treeReference","treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_MOVE_ITEM"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"SetArrangedItemsResponse","referenceFqn":"SetArrangedItemsResponse"}},"examples":[{"title":"setArrangedItems","content":"import { categories } from '@wix/categories';\n\nasync function setArrangedItems(categoryId, treeReference, options) {\n const response = await categories.setArrangedItems(categoryId, treeReference, options);\n};"},{"title":"setArrangedItems (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function mySetArrangedItemsMethod(categoryId, treeReference, options) {\n const elevatedSetArrangedItems = auth.elevate(categories.setArrangedItems);\n const response = await elevatedSetArrangedItems(categoryId, treeReference, options);\n}"},{"title":"setArrangedItems (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function setArrangedItems(categoryId, treeReference, options) {\n const response = await myWixClient.categories.setArrangedItems(categoryId, treeReference, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"treeReference","slug":"tree-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TreeReference","referenceFqn":"TreeReference"},"description":"Category tree reference details."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SetArrangedItemsOptions","referenceFqn":"SetArrangedItemsOptions"}}],"description":"Sets arranged items in a category.\n\nThe order of items in the `items` array determines the order of items in the category.\nThe category's existing list of arranged items will be overridden.","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ITEM_NOT_IN_CATEGORY","description":"Item doesn't belong to category with `categoryId`","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"ITEM_NOT_IN_CATEGORY"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category item write","scopeId":"SCOPE.CATEGORIES.CATEGORY_ITEM_WRITE"},{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"updateCategory","fqn":"updateCategory","fullFqn":"com.wix.categories.api.v1.CategoriesService.UpdateCategory","slug":"update-category","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","category","category.revision","options.treeReference","options.treeReference.appNamespace"],"permissionIds":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Category","referenceFqn":"Category"},"description":"Updated category."},"examples":[{"title":"updateCategory","content":"import { categories } from '@wix/categories';\n\nasync function updateCategory(id, category, options) {\n const response = await categories.updateCategory(id, category, options);\n};"},{"title":"updateCategory (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myUpdateCategoryMethod(id, category, options) {\n const elevatedUpdateCategory = auth.elevate(categories.updateCategory);\n const response = await elevatedUpdateCategory(id, category, options);\n}"},{"title":"updateCategory (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateCategory(id, category, options) {\n const response = await myWixClient.categories.updateCategory(id, category, options);\n};"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"category","slug":"category","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateCategory","referenceFqn":"UpdateCategory"}},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateCategoryOptions","referenceFqn":"UpdateCategoryOptions"}}],"description":"Updates a category.\n\nEach time the category is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the category.\nThis ensures you're working with the latest category and prevents unintended overwrites.","sdkErrors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_SLUG","description":"`slug` must be unique.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DUPLICATE_SLUG"}},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"REMOVED_SLUG","description":"`slug` can't be removed.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"REMOVED_SLUG"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true},{"name":"updateCategoryVisibility","fqn":"updateCategoryVisibility","fullFqn":"com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility","slug":"update-category-visibility","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["categoryId","options.revision","options.treeReference","options.treeReference.appNamespace","options.visible"],"permissionIds":["CATEGORIES.CATEGORY_UPDATE"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"UpdateCategoryVisibilityResponse","referenceFqn":"UpdateCategoryVisibilityResponse"}},"examples":[{"title":"updateCategoryVisibility","content":"import { categories } from '@wix/categories';\n\nasync function updateCategoryVisibility(categoryId, options) {\n const response = await categories.updateCategoryVisibility(categoryId, options);\n};"},{"title":"updateCategoryVisibility (with elevated permissions)","content":"import { categories } from '@wix/categories';\nimport { auth } from '@wix/essentials';\n\nasync function myUpdateCategoryVisibilityMethod(categoryId, options) {\n const elevatedUpdateCategoryVisibility = auth.elevate(categories.updateCategoryVisibility);\n const response = await elevatedUpdateCategoryVisibility(categoryId, options);\n}"},{"title":"updateCategoryVisibility (self-hosted)","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { categories },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateCategoryVisibility(categoryId, options) {\n const response = await myWixClient.categories.updateCategoryVisibility(categoryId, options);\n};"}],"actionParams":[{"name":"categoryId","slug":"category-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Category ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateCategoryVisibilityOptions","referenceFqn":"UpdateCategoryVisibilityOptions"}}],"description":"Updates category visibility.\n\n\nEach time a category is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating a category.\nThis ensures you're working with the latest category and prevents unintended overwrites.","sdkErrors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PARENT_CATEGORY_HIDDEN","description":"Category can't be visible if parent category isn't visible.","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PARENT_CATEGORY_HIDDEN"}}],"kind":"GENERAL","permissionScopes":[{"name":"Category write","scopeId":"SCOPE.CATEGORIES.CATEGORY_WRITE"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}],"isAdminMethod":true}],"webhooks":[{"name":"onCategoryCreated","fqn":"onCategoryCreated","eventSlug":"created","slug":"on-category-created","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryCreatedHandler","referenceFqn":"OnCategoryCreatedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","examples":[{"title":"onCategoryCreated","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryCreated((event) => {\n // handle your event here\n});"},{"title":"onCategoryCreated (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryCreated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_created","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]},{"name":"onCategoryDeleted","fqn":"onCategoryDeleted","eventSlug":"deleted","slug":"on-category-deleted","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryDeletedHandler","referenceFqn":"OnCategoryDeletedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","examples":[{"title":"onCategoryDeleted","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryDeleted((event) => {\n // handle your event here\n});"},{"title":"onCategoryDeleted (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryDeleted((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_deleted","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]},{"name":"onCategoryItemAddedToCategory","fqn":"onCategoryItemAddedToCategory","eventSlug":"item_added_to_category","slug":"on-category-item-added-to-category","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryItemAddedToCategoryHandler","referenceFqn":"OnCategoryItemAddedToCategoryHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when an item is added to a category.","examples":[{"title":"onCategoryItemAddedToCategory","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryItemAddedToCategory((event) => {\n // handle your event here\n});"},{"title":"onCategoryItemAddedToCategory (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryItemAddedToCategory((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_item_added_to_category","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]},{"name":"onCategoryItemRemovedFromCategory","fqn":"onCategoryItemRemovedFromCategory","eventSlug":"item_removed_from_category","slug":"on-category-item-removed-from-category","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryItemRemovedFromCategoryHandler","referenceFqn":"OnCategoryItemRemovedFromCategoryHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when an item is removed from a category.","examples":[{"title":"onCategoryItemRemovedFromCategory","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryItemRemovedFromCategory((event) => {\n // handle your event here\n});"},{"title":"onCategoryItemRemovedFromCategory (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryItemRemovedFromCategory((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_item_removed_from_category","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]},{"name":"onCategoryItemsArrangedInCategory","fqn":"onCategoryItemsArrangedInCategory","eventSlug":"items_arranged_in_category","slug":"on-category-items-arranged-in-category","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryItemsArrangedInCategoryHandler","referenceFqn":"OnCategoryItemsArrangedInCategoryHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when items arrangement in category is changed.","examples":[{"title":"onCategoryItemsArrangedInCategory","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryItemsArrangedInCategory((event) => {\n // handle your event here\n});"},{"title":"onCategoryItemsArrangedInCategory (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryItemsArrangedInCategory((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_items_arranged_in_category","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]},{"name":"onCategoryMoved","fqn":"onCategoryMoved","eventSlug":"category_moved","slug":"on-category-moved","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryMovedHandler","referenceFqn":"OnCategoryMovedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","description":"Triggered when a category is moved.","examples":[{"title":"onCategoryMoved","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryMoved((event) => {\n // handle your event here\n});"},{"title":"onCategoryMoved (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryMoved((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_category_moved","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]},{"name":"onCategoryUpdated","fqn":"onCategoryUpdated","eventSlug":"updated","slug":"on-category-updated","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnCategoryUpdatedHandler","referenceFqn":"OnCategoryUpdatedHandler","isFunction":true}}],"isDeveloperPreview":false,"maturity":"GA","examples":[{"title":"onCategoryUpdated","content":"import { categories } from '@wix/categories';\n\ncategories.onCategoryUpdated((event) => {\n // handle your event here\n});"},{"title":"onCategoryUpdated (self-hosted)","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { categories } from '@wix/categories';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n categories,\n },\n});\n\nwixClient.categories.onCategoryUpdated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["CATEGORIES.CATEGORY_READ"],"permissions":["Manage Stores - all permissions","Manage Stores","Read categories","Read v3 catalog","Manage Products","Read Stores - all read permissions","Read Products","Manage Restaurants - all permissions","Manage v3 catalog","Manage Orders"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES","SCOPE.STORES.MANAGE-STORES","SCOPE.CATEGORIES.CATEGORY_READ","SCOPE.STORES.CATALOG_READ","SCOPE.DC-STORES.MANAGE-PRODUCTS","SCOPE.DC-STORES-MEGA.READ-STORES","SCOPE.DC-STORES.READ-PRODUCTS","SCOPE.RESTAURANTS.MEGA-SCOPES","SCOPE.STORES.CATALOG_WRITE","SCOPE.DC-STORES.MANAGE-ORDERS"],"eventType":"wix.categories.v1.category_updated","permissionScopes":[{"name":"Read categories","scopeId":"SCOPE.CATEGORIES.CATEGORY_READ"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Stores","scopeId":"SCOPE.STORES.MANAGE-STORES"}]}],"articles":[{"content":"# About the Wix Categories API\n\nThe Wix Categories API allows you to create and manage a tree of categories on your site.\n\nThis API provides essentials tools to establish hierarchical relationships between categories, helping you organize and classify items assigned to these categories.\n\nWith the Wix Categories API, you can:\n- Manage categories and assign them to parent categories.\n- Add and remove items from categories.\n- Specify the manual arrangement of items within a category.\n- Retrieve information about items assigned to a category, directly or indirectly.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n- The Categories app is currently only available as part of the Wix stores app. Make sure to install the Wix Stores app from the [Wix App Market](https://www.wix.com/app-market/wix-stores).\n- Your app has the necessary permissions to access the Categories API.\n\n## Limitations\nWix Categories is currently limited to:\n1. 1,000 Categories per Tree.\n2. Up to 5 hierarchies levels.\n3. Each category can belong to only one parent category.\n4. Items can be associated with many categories, up to 1,000.\n5. Only the first 100 items within a category can be arranged manually.\n6. Updating visible field to `false` and delete behaviors apply from parent categories to subcategories.\n\n## Sample flows\n* [Create category and subcategory](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/sample-use-cases-and-flows#create-category-and-subcategory)\n* [Add and arrange items in category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/sample-use-cases-and-flows#add-and-arrange-items-in-category)\n* [Move subcategory to a different position within a parent category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/sample-use-cases-and-flows#move-subcategory-to-a-different-position-within-a-parent-category)\n* [Find all subcategories of a category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/sample-use-cases-and-flows#find-all-subcategories-of-a-category)\n\n## Terminology\n1. **Tree**: A hierarchical structure of categories. Each tree can have up to 1,000 categories.\n2. **Tree Reference**: A unique identifier for the tree. Defined by app namespace and optionally tree key. Must be provided in all API requests.\n3. **App Namespace**: A unique identifier for the app that owns the tree. This namespace must be defined in dev-center before using the API.\n4. **Tree Key**: An optional key to differentiate between multiple trees managed by the same app. It can be empty, if an app only manages one tree.\n5. **Parent Category**: Each category can have a single parent category for managing a nested hierarchy. The parent Category can be empty when category is at the top level of the hierarchy or for flat category structures.\n6. **SubCategory**: A category nested under another category. Multiple subcategories can exist under a single parent category.\n7. **Depth**: The maximum nesting level allowed within the tree, limited to 5 levels.\n8. **Breadcrumbs**: A path from top-level category to the current category, helping users understand their location within the hierarchy and navigate back to parent categories.\n9. **Item Reference**: Identifies an item assigned to a category, consisting of an appId and a catalogItemId.\n10. **Manual Arrangement**: Allows merchants to manually set the order of items within a category. Up to 100 items can be rearranged to make them displayed in the beginning, while the rest are displayed in the order they were added to the category.","displayName":"Introduction","slugifyName":"introduction"},{"content":"@package_metadata:@wix/categories\n\nTo use the Categories API, install the `@wix/categories` package.\n\n#### Install the package\n\nFollow the installation instructions for your development environment.\n\n| Development environment | Installation method |\n|--|--|\n| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |\n| Wix sites (local IDE) | Run `wix install @wix/categories` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|\n| Blocks apps | Use the same installation method as Wix sites. |\n| CLI and self-hosted apps | Run `npm install @wix/categories` or `yarn add @wix/categories`. |\n| Headless sites and apps | Run `npm install @wix/categories` or `yarn add @wix/categories`. |\n\n#### Import the package\n\nTo import the package in your code:\n\n```js\nimport { categories } from '@wix/categories'\n```\n ","displayName":"Setup","slugifyName":"setup"},{"content":"# Categories: Sample Use Cases and Flows\n\nThis article shares some possible use cases your app could support, as well as\na sample flow that could support each use case. This can be a helpful jumping\noff point as you plan your app's implementation.\n\n## Create category and subcategory\nHelp merchant organize their hierarchy by creating new categories and subcategories.\n1. To create new category call [Create Category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/create-category) endpoint.\nIn the request body in addition to `category` you need to pass `treeReference` to specify the tree in which the category will be created.\nThe category will be created in the top nesting level of the tree.\n```json\n{\n \"category\": {\n \"name\": \"Drinkware\",\n \"description\": \"The Drinkware category includes a wide range of containers designed for holding beverages\",\n \"visible\": true\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nSave `category.id` from response.\n\n2. To create subcategory within the newly created category call [Create Category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/create-category) endpoint again.\nThis time, include the `parentCategory.id` to specify the parent category that will be assigned.\nThe `treeReference` will be the same as you sent in step 1.\n```json\n{\n \"category\": {\n \"name\": \"Mugs\",\n \"description\": \"The Mugs subcategory includes a wide range of containers designed for holding hot beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nReplace `` with category id from response of step 1.\n\n## Add and arrange items in category\nHelp merchant to organize and classify their items by using categories.\nIn this scenario, you will assign set of items to a category and arrange them in a specific order.\n1. Add selected items to category by calling [Bulk Add Items To Category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/bulk-add-items-to-category) endpoint.\n\nIn the request path, include `category.id` that you received in response of previous scenario. \nIn the request body `treeReference` will also be the same and in `items` you can send all items that you want to add to category, Each item is referenced by pair of `appId` and `catalogItemId`.\n```json\n{\n \"items\": [\n {\n \"catalogItemId\": \"0318a3d8-f31c-4ba3-98c7-387571a2eac4\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"05519a6e-222b-413a-957c-0ef7a32779b5\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n },\n {\n \"catalogItemId\": \"060b9b04-fe14-487d-8336-2d285c50cf98\",\n \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n }\n ],\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\n\n3. After adding the items to the category, you can rearrange them for example to promote some items to be displayed in the beginning. Note that you can arrange up to 100 items, more items can be added, but you cannot control arrangement of them. \nCall [Set Arranged Items](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/set-arranged-items) endpoint. Pass exactly same params as in step 1 but now `items` must be in desired order in which you want to see them.\n4. To display all items that belong to given category in the specified arrangement from previous step, use [List Items In Category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/list-items-in-category) endpoint.\nIn the request path, include same `category.id` from previous steps and in the request body, send the following:\n \n```json\n{\n \"useCategoryArrangement\": true,\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\n\n### Move subcategory to a different position within a parent category\nMerchant may want to change the position of a category in the hierarchy.\n\n1. Use the [Create Category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/create-category) endpoint to create an additional subcategory within the parent category.\n In the request body as part of the `category` you need to also provide `parentCategory.id` to specify the parent category that will be assigned.\n```json\n{\n \"category\": {\n \"name\": \"Bottles\",\n \"description\": \"The Bottles subcategory offers a diverse selection of containers designed for carrying and consuming beverages\",\n \"visible\": true,\n \"parentCategory\": {\n \"id\": \"\"\n }\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nSave `category.id` from response.\n\n2. To move the category to a different position in same parent category call [Move Category](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/move-category) endpoint. \n In the request path, include the `category.id` of the category you want to move.\n In the request, provide the `parentCategoryId` and specify `position` as `FIRST` to move the subcategory to the beginning.\n```json\n{\n \"parentCategoryId\": \"\",\n \"position\": \"FIRST\",\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\",\n \"treeKey\": null\n }\n}\n```\nReplace `` with category id from response of previous scenarios.\n\n### Find all subcategories of a category\n\nIn this scenario, you want to retrieve a list of all subcategories that belong to a specific parent category, in the correct order. This is useful for traversing the category hierarchy.\n\nUse the [Search Categories](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) endpoint.\nIn the request body, include the `parentCategory.id` in the `filter` parameter and sort by `parentCategory.index` in ascending order:\n```json\n{\n \"search\": {\n \"filter\": {\"parentCategory.id\": {\"$eq\": \"\" }},\n \"sort\": [{\"fieldName\": \"parentCategory.index\", \"order\": \"ASC\"}]\n },\n \"treeReference\": {\n \"appNamespace\": \"@wix/stores\"\n },\n \"fields\": [\n \"BREADCRUMBS\"\n ]\n}\n```\nReplace `` with parent category id from previous scenarios.\n","displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows"},{"content":"# Categories: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the category object:\n\n| Field | Supported Filters | Sortable |\n|------------------------------|-------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `name` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `description` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `visible` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome` | |\n| `slug` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `parentCategory.id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n| `parentCategory.index` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `treeReference.appNamespace` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `treeReference.treeKey` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `treeReference.treeValue` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n\n\n__Related content:__\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Search Categories](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories),\n[Query Categories](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/query-categories)\n","displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting"}],"builderTypes":[{"kind":"REFERENCE","name":"CategoriesQueryBuilder","referenceFqn":"CategoriesQueryBuilder"},{"kind":"REFERENCE","name":"CategoriesQueryResult","referenceFqn":"CategoriesQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0","gitCommitHash":""},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"Categories","yamlTitle":"Categories 1 0 0","kind":"PUBLIC_SDK","fqdn":"wix.categories.v1.category"}}

getCategory( )