From 4b8b4ef6ff8b9e8e8fac3bb16bb4d8bcfc249181 Mon Sep 17 00:00:00 2001 From: Wix Docs Feds Date: Thu, 20 Jun 2024 09:26:19 +0000 Subject: [PATCH] Auto commit to autodocs-wix-restaurants from WixDocs Server --- .../wix-restaurants/Events.service.json | 517 ++++++++++++++++++ 1 file changed, 517 insertions(+) diff --git a/wix-restaurants/wix-restaurants/Events.service.json b/wix-restaurants/wix-restaurants/Events.service.json index 5fcfd77b1f..2b11400a5d 100644 --- a/wix-restaurants/wix-restaurants/Events.service.json +++ b/wix-restaurants/wix-restaurants/Events.service.json @@ -1224,6 +1224,53 @@ ] } }, + { + "name": "restaurantsMenusV1ItemDeleteByFilterOperation", + "members": [ + { + "name": "filter", + "optional": true, + "type": [ + { + "nativeType": "Object" + } + ], + "doc": "documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering" + } + ], + "docs": { + "description": [ + "" + ] + } + }, + { + "name": "restaurantsMenusV1ItemDeleteByIdsOperation", + "members": [ + { + "name": "documentIds", + "optional": true, + "type": [ + { + "complexType": { + "nativeType": "Array", + "typeParams": [ + { + "nativeType": "string" + } + ] + } + } + ], + "doc": "ids of the documents to delete" + } + ], + "docs": { + "description": [ + "" + ] + } + }, { "name": "restaurantsMenusV1ItemDeleteItemRequest", "members": [ @@ -1252,6 +1299,105 @@ ] } }, + { + "name": "restaurantsMenusV1ItemDocumentImage", + "members": [ + { + "name": "height", + "optional": true, + "type": [ + { + "nativeType": "number" + } + ], + "doc": "the height of the image" + }, + { + "name": "name", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "the name of the image" + }, + { + "name": "width", + "optional": true, + "type": [ + { + "nativeType": "number" + } + ], + "doc": "the width of the image" + } + ], + "docs": { + "description": [ + "" + ] + } + }, + { + "name": "restaurantsMenusV1ItemDocumentPayload", + "members": [ + { + "name": "documentImage", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDocumentImage", + "displayName": "DocumentImage" + } + ], + "doc": "image which represents the document" + }, + { + "name": "url", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "url of the page representing the document" + } + ], + "docs": { + "description": [ + "" + ] + } + }, + { + "name": "restaurantsMenusV1ItemDocumentUpdateOperation", + "members": [ + { + "name": "documents", + "optional": true, + "type": [ + { + "complexType": { + "nativeType": "Array", + "typeParams": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemIndexDocument", + "displayName": "IndexDocument" + } + ] + } + } + ], + "doc": "documents to index or update" + } + ], + "docs": { + "description": [ + "" + ] + } + }, { "name": "restaurantsMenusV1ItemDomainEvent", "members": [ @@ -1746,6 +1892,84 @@ ] } }, + { + "name": "restaurantsMenusV1ItemIndexDocument", + "members": [ + { + "name": "document", + "optional": true, + "type": [ + { + "nativeType": "Object" + } + ], + "doc": "document with mandatory fields (id, title, description) and with fields specific to the type of the document" + }, + { + "name": "exposure", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "what type of users should documents be visible to" + }, + { + "name": "isPopup", + "optional": true, + "type": [ + { + "nativeType": "boolean" + } + ], + "doc": "if true the page is a lightbox popup" + }, + { + "name": "payload", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDocumentPayload", + "displayName": "DocumentPayload" + } + ], + "doc": "data bag with non-searchable fields (url, image)" + }, + { + "name": "permittedMemberGroups", + "optional": true, + "type": [ + { + "complexType": { + "nativeType": "Array", + "typeParams": [ + { + "nativeType": "string" + } + ] + } + } + ], + "doc": "what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure" + }, + { + "name": "seoHidden", + "optional": true, + "type": [ + { + "nativeType": "boolean" + } + ], + "doc": "if true SEO is disabled for this document" + } + ], + "docs": { + "description": [ + "" + ] + } + }, { "name": "restaurantsMenusV1ItemInvalidateCache", "members": [ @@ -2648,6 +2872,56 @@ ] } }, + { + "name": "restaurantsMenusV1ItemSearchIndexingNotification", + "members": [ + { + "name": "documentType", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "type of the document the notification is targeted for. Applies to all types if not provided" + }, + { + "name": "indexState", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "new state of indexing for the site specified in ms_id" + }, + { + "name": "language", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided" + }, + { + "name": "msId", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "site for which notification is targeted" + } + ], + "docs": { + "description": [ + "" + ] + } + }, { "name": "restaurantsMenusV1ItemSorting", "members": [ @@ -2678,6 +2952,249 @@ ] } }, + { + "name": "restaurantsMenusV1ItemUpdateByFilterOperation", + "members": [ + { + "name": "document", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemIndexDocument", + "displayName": "IndexDocument" + } + ], + "doc": "partial document to apply" + }, + { + "name": "filter", + "optional": true, + "type": [ + { + "nativeType": "Object" + } + ], + "doc": "documents matching this filter will be updated" + } + ], + "docs": { + "description": [ + "" + ] + } + }, + { + "name": "restaurantsMenusV1ItemUpdateDocumentsEvent", + "members": [ + { + "name": "appDefId", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "application which owns documents" + }, + { + "name": "deleteByFilter", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDeleteByFilterOperation", + "displayName": "DeleteByFilterOperation" + } + ], + "doc": "delete documents matching filter" + }, + { + "name": "deleteByIds", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDeleteByIdsOperation", + "displayName": "DeleteByIdsOperation" + } + ], + "doc": "delete by document ids" + }, + { + "name": "documentType", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "type of the documents" + }, + { + "name": "language", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "language of the documents" + }, + { + "name": "msId", + "optional": true, + "type": [ + { + "nativeType": "string" + } + ], + "doc": "site documents belong to" + }, + { + "name": "update", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDocumentUpdateOperation", + "displayName": "DocumentUpdateOperation" + } + ], + "doc": "insert/update documents" + }, + { + "name": "updateByFilter", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemUpdateByFilterOperation", + "displayName": "UpdateByFilterOperation" + } + ], + "doc": "update documents matching filter" + }, + { + "name": "updateExisting", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemUpdateExistingOperation", + "displayName": "UpdateExistingOperation" + } + ], + "doc": "update only existing documents" + } + ], + "extra": { + "oneOfGroups": [ + { + "name": "oneOfUpdateDocumentsEventOperationOneOf", + "members": [ + "deleteByFilter", + "deleteByIds", + "update", + "updateByFilter", + "updateExisting" + ] + } + ] + }, + "docs": { + "description": [ + "" + ] + } + }, + { + "name": "restaurantsMenusV1ItemUpdateDocumentsEventOperationOneOf", + "members": [ + { + "name": "deleteByFilter", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDeleteByFilterOperation", + "displayName": "DeleteByFilterOperation" + } + ], + "doc": "delete documents matching filter" + }, + { + "name": "deleteByIds", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDeleteByIdsOperation", + "displayName": "DeleteByIdsOperation" + } + ], + "doc": "delete by document ids" + }, + { + "name": "update", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemDocumentUpdateOperation", + "displayName": "DocumentUpdateOperation" + } + ], + "doc": "insert/update documents" + }, + { + "name": "updateByFilter", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemUpdateByFilterOperation", + "displayName": "UpdateByFilterOperation" + } + ], + "doc": "update documents matching filter" + }, + { + "name": "updateExisting", + "optional": true, + "type": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemUpdateExistingOperation", + "displayName": "UpdateExistingOperation" + } + ], + "doc": "update only existing documents" + } + ], + "docs": { + "description": [ + "" + ] + } + }, + { + "name": "restaurantsMenusV1ItemUpdateExistingOperation", + "members": [ + { + "name": "documents", + "optional": true, + "type": [ + { + "complexType": { + "nativeType": "Array", + "typeParams": [ + { + "referenceType": "wix-restaurants.Events.restaurantsMenusV1ItemIndexDocument", + "displayName": "IndexDocument" + } + ] + } + } + ], + "doc": "documents to update" + } + ], + "docs": { + "description": [ + "" + ] + } + }, { "name": "restaurantsMenusV1ItemUpdateItemRequest", "members": [