@wix/auto_sdk_restaurants_menus 1.0.27 → 1.0.29

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { M as Menu, B as BulkCreateMenusOptions, a as BulkCreateMenusResponse, L as ListMenusOptions, b as ListMenusResponse, c as MenusQueryBuilder, U as UpdateMenu, d as MaskedMenu, e as BulkUpdateMenuOptions, f as BulkUpdateMenuResponse, g as UpdateExtendedFieldsOptions, h as UpdateExtendedFieldsResponse, G as GetMenuSiteUrlResponse, Q as QueryMenusSiteUrlOptions, i as QueryMenusSiteUrlResponse, D as DuplicateMenuOptions, j as DuplicateMenuResponse, k as MenuCreatedEnvelope, l as MenuDeletedEnvelope, m as MenuUpdatedEnvelope } from './restaurants-menus-v1-menu-menus.universal-B1THG8Sh.js';
-export { ak as ActionEvent, A as App, z as ApplicationError, at as BaseEventMetadata, H as BulkActionMetadata, x as BulkCreateMenuResult, w as BulkCreateMenusRequest, a4 as BulkMenuResult, a3 as BulkUpdateMenuRequest, p as BusinessLocationDetails, ac as CloneMenusRequest, ad as CloneMenusResponse, u as CreateMenuRequest, v as CreateMenuResponse, R as CursorPaging, V as CursorPagingMetadata, Z as CursorQuery, _ as CursorQueryPagingMethodOneOf, X as Cursors, C as CustomTag, a6 as DeleteMenuRequest, a7 as DeleteMenuResponse, s as DeleteOrphanSections, ae as DomainEvent, af as DomainEventBodyOneOf, as as DuplicateMenuRequest, al as Empty, ag as EntityCreatedEvent, aj as EntityDeletedEvent, ai as EntityUpdatedEvent, au as EventMetadata, E as ExtendedFields, F as File, J as GetMenuRequest, N as GetMenuResponse, ap as GetMenuSiteUrlRequest, an as IdentificationData, ao as IdentificationDataIdOneOf, I as InvalidateCache, q as InvalidateCacheGetByOneOf, y as ItemMetadata, K as Keyword, O as ListMenusRequest, aq as MenuSiteUrl, t as MenusDataCloningCompleted, av as MenusQueryResult, am as MessageEnvelope, P as Page, Y as QueryMenusRequest, a0 as QueryMenusResponse, ar as QueryMenusSiteUrlRequest, ah as RestoreInfo, a8 as RunMenusMultiLocationMigrationRequest, a9 as RunMenusMultiLocationMigrationResponse, n as SeoSchema, o as Settings, S as SortOrder, $ as Sorting, T as Tag, r as URI, aa as UpdateBusinessLocationIdRequest, ab as UpdateBusinessLocationIdResponse, a5 as UpdateExtendedFieldsRequest, a1 as UpdateMenuRequest, a2 as UpdateMenuResponse, W as WebhookIdentityType } from './restaurants-menus-v1-menu-menus.universal-B1THG8Sh.js';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Menu, BulkCreateMenusOptions, BulkCreateMenusResponse, ListMenusOptions, ListMenusResponse, MenusQueryBuilder, UpdateMenu, MaskedMenu, BulkUpdateMenuOptions, BulkUpdateMenuResponse, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, GetMenuSiteUrlResponse, QueryMenusSiteUrlOptions, QueryMenusSiteUrlResponse, DuplicateMenuOptions, DuplicateMenuResponse, MenuCreatedEnvelope, MenuDeletedEnvelope, MenuUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateMenuResult, BulkCreateMenusRequest, BulkMenuResult, BulkUpdateMenuRequest, BusinessLocationDetails, CloneMenusRequest, CloneMenusResponse, CreateMenuRequest, CreateMenuResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, DeleteMenuRequest, DeleteMenuResponse, DeleteOrphanSections, DomainEvent, DomainEventBodyOneOf, DuplicateMenuRequest, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, File, GetMenuRequest, GetMenuResponse, GetMenuSiteUrlRequest, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, Keyword, ListMenusRequest, MenuSiteUrl, MenusDataCloningCompleted, MenusQueryResult, MessageEnvelope, Page, QueryMenusRequest, QueryMenusResponse, QueryMenusSiteUrlRequest, RestoreInfo, RunMenusMultiLocationMigrationRequest, RunMenusMultiLocationMigrationResponse, SeoSchema, Settings, SortOrder, Sorting, Tag, URI, UpdateBusinessLocationIdRequest, UpdateBusinessLocationIdResponse, UpdateExtendedFieldsRequest, UpdateMenuRequest, UpdateMenuResponse, WebhookIdentityType } from './index.typings.js';
 
+type MenuNonNullablePaths = `name` | `sectionIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`;
 declare function createMenu$1(httpClient: HttpClient): CreateMenuSignature;
 interface CreateMenuSignature {
     /**
@@ -13,7 +14,7 @@ interface CreateMenuSignature {
      * @param - Menu details.
      * @returns Menu.
      */
-    (menu: Menu): Promise<Menu>;
+    (menu: Menu): Promise<NonNullablePaths<Menu, MenuNonNullablePaths>>;
 }
 declare function bulkCreateMenus$1(httpClient: HttpClient): BulkCreateMenusSignature;
 interface BulkCreateMenusSignature {
@@ -23,7 +24,9 @@ interface BulkCreateMenusSignature {
      * Creates multiple menus at once.
      * @param - Menu details.
      */
-    (menus: Menu[], options?: BulkCreateMenusOptions | undefined): Promise<BulkCreateMenusResponse>;
+    (menus: Menu[], options?: BulkCreateMenusOptions): Promise<NonNullablePaths<BulkCreateMenusResponse, `results` | `results.${number}.menuMetadata.originalIndex` | `results.${number}.menuMetadata.success` | `results.${number}.menuMetadata.error.code` | `results.${number}.menuMetadata.error.description` | {
+        [P in MenuNonNullablePaths]: `results.${number}.menu.${P}`;
+    }[MenuNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function getMenu$1(httpClient: HttpClient): GetMenuSignature;
 interface GetMenuSignature {
@@ -34,7 +37,7 @@ interface GetMenuSignature {
      * @param - Menu ID.
      * @returns Menu.
      */
-    (menuId: string): Promise<Menu>;
+    (menuId: string): Promise<NonNullablePaths<Menu, MenuNonNullablePaths>>;
 }
 declare function listMenus$1(httpClient: HttpClient): ListMenusSignature;
 interface ListMenusSignature {
@@ -43,7 +46,9 @@ interface ListMenusSignature {
      *
      * Retrieves a list of up to 500 menus.
      */
-    (options?: ListMenusOptions | undefined): Promise<ListMenusResponse>;
+    (options?: ListMenusOptions): Promise<NonNullablePaths<ListMenusResponse, {
+        [P in MenuNonNullablePaths]: `menus.${number}.${P}`;
+    }[MenuNonNullablePaths]>>;
 }
 declare function queryMenus$1(httpClient: HttpClient): QueryMenusSignature;
 interface QueryMenusSignature {
@@ -77,7 +82,7 @@ interface UpdateMenuSignature {
      * @param - Menu ID.
      * @returns Updated menu.
      */
-    (_id: string, menu: UpdateMenu): Promise<Menu>;
+    (_id: string, menu: NonNullablePaths<UpdateMenu, `revision`>): Promise<NonNullablePaths<Menu, MenuNonNullablePaths>>;
 }
 declare function bulkUpdateMenu$1(httpClient: HttpClient): BulkUpdateMenuSignature;
 interface BulkUpdateMenuSignature {
@@ -89,7 +94,9 @@ interface BulkUpdateMenuSignature {
      * Each time a menu is updated, its revision increments by 1. The existing revision must be included when updating the menu. This ensures you're working with the latest menu information, and it prevents unintended overwrites.
      * @param - Menus to update.
      */
-    (menus: MaskedMenu[], options?: BulkUpdateMenuOptions | undefined): Promise<BulkUpdateMenuResponse>;
+    (menus: NonNullablePaths<MaskedMenu, `menu._id` | `menu.revision`>[], options?: BulkUpdateMenuOptions): Promise<NonNullablePaths<BulkUpdateMenuResponse, `results` | `results.${number}.menuMetadata.originalIndex` | `results.${number}.menuMetadata.success` | `results.${number}.menuMetadata.error.code` | `results.${number}.menuMetadata.error.description` | {
+        [P in MenuNonNullablePaths]: `results.${number}.menu.${P}`;
+    }[MenuNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
 interface UpdateExtendedFieldsSignature {
@@ -100,7 +107,7 @@ interface UpdateExtendedFieldsSignature {
      * @param - ID of the entity to update.
      * @param - Identifier for the app whose extended fields are being updated.
      */
-    (_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+    (_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `namespace`>>;
 }
 declare function deleteMenu$1(httpClient: HttpClient): DeleteMenuSignature;
 interface DeleteMenuSignature {
@@ -118,19 +125,19 @@ interface GetMenuSiteUrlSignature {
      * Get menu details and path URL by menu ID.
      * @param - Menu ID.
      */
-    (_id: string): Promise<GetMenuSiteUrlResponse>;
+    (_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`>>;
 }
 declare function queryMenusSiteUrl$1(httpClient: HttpClient): QueryMenusSiteUrlSignature;
 interface QueryMenusSiteUrlSignature {
     /**
      * Query menu details and path URL
      */
-    (options?: QueryMenusSiteUrlOptions | undefined): Promise<QueryMenusSiteUrlResponse>;
+    (options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`>>;
 }
 declare function duplicateMenu$1(httpClient: HttpClient): DuplicateMenuSignature;
 interface DuplicateMenuSignature {
     /** @param - Menu id to be duplicated. */
-    (_id: string, options?: DuplicateMenuOptions | undefined): Promise<DuplicateMenuResponse>;
+    (_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`>>;
 }
 declare const onMenuCreated$1: EventDefinition<MenuCreatedEnvelope, "wix.restaurants.menus.v1.menu_created">;
 declare const onMenuDeleted$1: EventDefinition<MenuDeletedEnvelope, "wix.restaurants.menus.v1.menu_deleted">;