@wix/auto_sdk_restaurants_menus 1.0.31 → 1.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,7 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
2
  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';
3
- 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, ExternalReferenceInfo, 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';
3
+ 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, ExternalReferenceInfo, 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, SortOrderWithLiterals, Sorting, Tag, URI, UpdateBusinessLocationIdRequest, UpdateBusinessLocationIdResponse, UpdateExtendedFieldsRequest, UpdateMenuRequest, UpdateMenuResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
4
4
 
5
- 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`;
6
5
  declare function createMenu$1(httpClient: HttpClient): CreateMenuSignature;
7
6
  interface CreateMenuSignature {
8
7
  /**
@@ -14,7 +13,7 @@ interface CreateMenuSignature {
14
13
  * @param - Menu details.
15
14
  * @returns Menu.
16
15
  */
17
- (menu: Menu): Promise<NonNullablePaths<Menu, MenuNonNullablePaths>>;
16
+ (menu: Menu): Promise<NonNullablePaths<Menu, `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`, 6>>;
18
17
  }
19
18
  declare function bulkCreateMenus$1(httpClient: HttpClient): BulkCreateMenusSignature;
20
19
  interface BulkCreateMenusSignature {
@@ -24,9 +23,7 @@ interface BulkCreateMenusSignature {
24
23
  * Creates multiple menus at once.
25
24
  * @param - Menu details.
26
25
  */
27
- (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` | {
28
- [P in MenuNonNullablePaths]: `results.${number}.menu.${P}`;
29
- }[MenuNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
26
+ (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` | `results.${number}.menu.name` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
30
27
  }
31
28
  declare function getMenu$1(httpClient: HttpClient): GetMenuSignature;
32
29
  interface GetMenuSignature {
@@ -37,7 +34,7 @@ interface GetMenuSignature {
37
34
  * @param - Menu ID.
38
35
  * @returns Menu.
39
36
  */
40
- (menuId: string): Promise<NonNullablePaths<Menu, MenuNonNullablePaths>>;
37
+ (menuId: string): Promise<NonNullablePaths<Menu, `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`, 6>>;
41
38
  }
42
39
  declare function listMenus$1(httpClient: HttpClient): ListMenusSignature;
43
40
  interface ListMenusSignature {
@@ -46,9 +43,7 @@ interface ListMenusSignature {
46
43
  *
47
44
  * Retrieves a list of up to 500 menus.
48
45
  */
49
- (options?: ListMenusOptions): Promise<NonNullablePaths<ListMenusResponse, {
50
- [P in MenuNonNullablePaths]: `menus.${number}.${P}`;
51
- }[MenuNonNullablePaths]>>;
46
+ (options?: ListMenusOptions): Promise<NonNullablePaths<ListMenusResponse, `menus` | `menus.${number}.name` | `menus.${number}.seoData.settings.preventAutoRedirect`, 6>>;
52
47
  }
53
48
  declare function queryMenus$1(httpClient: HttpClient): QueryMenusSignature;
54
49
  interface QueryMenusSignature {
@@ -82,7 +77,7 @@ interface UpdateMenuSignature {
82
77
  * @param - Menu ID.
83
78
  * @returns Updated menu.
84
79
  */
85
- (_id: string, menu: NonNullablePaths<UpdateMenu, `revision`>): Promise<NonNullablePaths<Menu, MenuNonNullablePaths>>;
80
+ (_id: string, menu: NonNullablePaths<UpdateMenu, `revision`, 2>): Promise<NonNullablePaths<Menu, `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`, 6>>;
86
81
  }
87
82
  declare function bulkUpdateMenu$1(httpClient: HttpClient): BulkUpdateMenuSignature;
88
83
  interface BulkUpdateMenuSignature {
@@ -94,9 +89,7 @@ interface BulkUpdateMenuSignature {
94
89
  * 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.
95
90
  * @param - Menus to update.
96
91
  */
97
- (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` | {
98
- [P in MenuNonNullablePaths]: `results.${number}.menu.${P}`;
99
- }[MenuNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
92
+ (menus: NonNullablePaths<MaskedMenu, `menu._id` | `menu.revision`, 3>[], options?: BulkUpdateMenuOptions): Promise<NonNullablePaths<BulkUpdateMenuResponse, `results` | `results.${number}.menuMetadata.originalIndex` | `results.${number}.menuMetadata.success` | `results.${number}.menuMetadata.error.code` | `results.${number}.menuMetadata.error.description` | `results.${number}.menu.name` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
100
93
  }
101
94
  declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
102
95
  interface UpdateExtendedFieldsSignature {
@@ -107,7 +100,7 @@ interface UpdateExtendedFieldsSignature {
107
100
  * @param - ID of the entity to update.
108
101
  * @param - Identifier for the app whose extended fields are being updated.
109
102
  */
110
- (_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `namespace`>>;
103
+ (_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 2>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `namespace`, 2>>;
111
104
  }
112
105
  declare function deleteMenu$1(httpClient: HttpClient): DeleteMenuSignature;
113
106
  interface DeleteMenuSignature {
@@ -125,19 +118,19 @@ interface GetMenuSiteUrlSignature {
125
118
  * Get menu details and path URL by menu ID.
126
119
  * @param - Menu ID.
127
120
  */
128
- (_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`>>;
121
+ (_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 3>>;
129
122
  }
130
123
  declare function queryMenusSiteUrl$1(httpClient: HttpClient): QueryMenusSiteUrlSignature;
131
124
  interface QueryMenusSiteUrlSignature {
132
125
  /**
133
126
  * Query menu details and path URL
134
127
  */
135
- (options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`>>;
128
+ (options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 4>>;
136
129
  }
137
130
  declare function duplicateMenu$1(httpClient: HttpClient): DuplicateMenuSignature;
138
131
  interface DuplicateMenuSignature {
139
132
  /** @param - Menu id to be duplicated. */
140
- (_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`>>;
133
+ (_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 2>>;
141
134
  }
142
135
  declare const onMenuCreated$1: EventDefinition<MenuCreatedEnvelope, "wix.restaurants.menus.v1.menu_created">;
143
136
  declare const onMenuDeleted$1: EventDefinition<MenuDeletedEnvelope, "wix.restaurants.menus.v1.menu_deleted">;