@wix/auto_sdk_restaurants_menus 1.0.96 → 1.0.98

package/build/cjs/index.typings.d.ts

@@ -266,29 +266,193 @@ interface ExternalReferenceInfo {
     /** Whether the connection to the external system is currently active. */
     connected?: boolean | null;
 }
-interface DuplicateMenuRequest {
+interface QueryMenuExportRowsRequest {
     /**
-     * Menu id to be duplicated.
-     * @format GUID
+     * Filter: `{"menuId": "<GUID>"}` or `{"menuId": {"$eq": "<GUID>"}}`, required on the first page; a later page may omit
+     * it, and if it sends it, it must name the cursor's menu. Cursor paging only, at most 500 rows
+     * per page (default 100); a sort fails with `INVALID_MENU_EXPORT_QUERY`. This is the same wire format as the fed-infra
+     * export service's `ExportQueryV2`: filter 1, sort 2, cursor paging 6.
      */
-    _id: string;
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
     /**
-     * Business location ids to duplicate the menu to.
-     * @format GUID
-     * @maxSize 100
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
      */
-    businessLocationIds?: string[] | null;
-    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
-    duplicateSubEntities?: boolean | null;
+    filter?: Record<string, any> | null;
     /**
-     * The new name of the duplicated menu.
-     * @maxLength 500
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
      */
-    menuName?: string | null;
+    sort?: Sorting[];
 }
-interface DuplicateMenuResponse {
-    /** @format GUID */
-    menuIds?: string[];
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+    /**
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     */
+    origin?: AddressLocation;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 500
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryMenuExportRowsResponse {
+    /** The page's rows, in file order. */
+    menuExportRows?: MenuExportRow[];
+    /** Paging metadata: `cursors.next` is set while rows remain. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+/**
+ * One CSV row. Every field is text exactly as written to the file (design-log/001 Q5); unused columns are empty.
+ * Free-text limits are the source field's product limit plus one, for the `'` the formula guard can add; `labels` allows
+ * 10 names of 50, each doubled at most by escaping, 9 separators and the guard. The other limits bound fixed values.
+ */
+interface MenuExportRow {
+    /**
+     * `section`, `item`, `variant`, `modifier_group` or `modifier`.
+     * @maxLength 20
+     */
+    type?: string;
+    /**
+     * Name of the row's section.
+     * @maxLength 501
+     */
+    sectionName?: string;
+    /**
+     * Section description, on section rows.
+     * @maxLength 1501
+     */
+    sectionDescription?: string;
+    /**
+     * Item name, on item, variant, modifier group and modifier rows.
+     * @maxLength 201
+     */
+    itemName?: string;
+    /**
+     * Item description, on item rows.
+     * @maxLength 1501
+     */
+    itemDescription?: string;
+    /**
+     * Price with 2 or 3 decimals, for example `8.50` (a legacy price stored with more decimals is written as stored). On item rows: `MARKET_PRICE` for a market-price item, empty for an
+     * item priced by variants, `0.00` for an item without a stored price. On variant and modifier rows: `0.00` without a
+     * price or charge. Empty on section and modifier group rows.
+     * @maxLength 50
+     */
+    price?: string;
+    /**
+     * The site's payment currency on item, variant and modifier rows. The importer doesn't read it: an imported menu takes
+     * the target site's currency.
+     * @maxLength 10
+     */
+    currency?: string;
+    /**
+     * The item's label names, `;`-separated, each exactly as the site names it, with `\` and `;` inside a name escaped
+     * as `\\` and `\;`.
+     * @maxLength 1010
+     */
+    labels?: string;
+    /**
+     * Modifier group name, on modifier group and modifier rows.
+     * @maxLength 101
+     */
+    modifierGroupName?: string;
+    /**
+     * `yes` or `no`, on modifier group rows.
+     * @maxLength 3
+     */
+    modifierRequired?: string;
+    /**
+     * Minimum selections, on modifier group rows.
+     * @maxLength 20
+     */
+    modifierMinSelections?: string;
+    /**
+     * Maximum selections (`0` is unlimited), on modifier group rows.
+     * @maxLength 20
+     */
+    modifierMaxSelections?: string;
+    /**
+     * Modifier name, on modifier rows.
+     * @maxLength 201
+     */
+    modifierName?: string;
+    /**
+     * `yes` or `no`, on modifier rows.
+     * @maxLength 3
+     */
+    modifierPreSelected?: string;
+    /**
+     * Variant name, on variant rows.
+     * @maxLength 201
+     */
+    variantName?: string;
+    /**
+     * `yes` or `no` on section and item rows.
+     * @maxLength 3
+     */
+    visible?: string;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -443,118 +607,6 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
-interface GetMenuSiteUrlRequest {
-    /**
-     * Menu ID.
-     * @format GUID
-     * @readonly
-     */
-    _id: string | null;
-}
-interface GetMenuSiteUrlResponse {
-    /** Retrieved menuInfo with path url. */
-    menuSiteUrl?: MenuSiteUrl;
-}
-interface MenuSiteUrl {
-    /**
-     * Path URL.
-     * @minLength 1
-     * @maxLength 1000
-     */
-    path?: string;
-}
-interface QueryMenusSiteUrlRequest {
-    /** Query options */
-    query?: CursorQuery;
-}
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-interface CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-interface Sorting {
-    /**
-     * Name of the field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
-    /**
-     * Origin point for geo-distance sorting on a GEO field
-     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
-     */
-    origin?: AddressLocation;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/** @enumType */
-type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
-}
-interface CursorPaging {
-    /**
-     * Number of items to load.
-     * @max 500
-     */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * You can get the relevant cursor token
-     * from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     */
-    cursor?: string | null;
-}
-interface QueryMenusSiteUrlResponse {
-    /** Retrieved menuInfos with path urls. */
-    menuSiteUrls?: MenuSiteUrl[];
-    /** The metadata of the paginated results. */
-    pagingMetadata?: CursorPagingMetadata;
-}
-interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    cursors?: Cursors;
-    /**
-     * Indicates if there are more results after the current page.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
-     */
-    hasNext?: boolean | null;
-}
-interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to previous page in the list of results. */
-    prev?: string | null;
-}
 interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /**
      * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
@@ -914,6 +966,60 @@ interface SyncContentToMultilingualRequest {
 }
 interface SyncContentToMultilingualResponse {
 }
+interface DuplicateMenuRequest {
+    /**
+     * Menu id to be duplicated.
+     * @format GUID
+     */
+    _id: string;
+    /**
+     * Business location ids to duplicate the menu to.
+     * @format GUID
+     * @maxSize 100
+     */
+    businessLocationIds?: string[] | null;
+    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
+    duplicateSubEntities?: boolean | null;
+    /**
+     * The new name of the duplicated menu.
+     * @maxLength 500
+     */
+    menuName?: string | null;
+}
+interface DuplicateMenuResponse {
+    /** @format GUID */
+    menuIds?: string[];
+}
+interface GetMenuSiteUrlRequest {
+    /**
+     * Menu ID.
+     * @format GUID
+     * @readonly
+     */
+    _id: string | null;
+}
+interface GetMenuSiteUrlResponse {
+    /** Retrieved menuInfo with path url. */
+    menuSiteUrl?: MenuSiteUrl;
+}
+interface MenuSiteUrl {
+    /**
+     * Path URL.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    path?: string;
+}
+interface QueryMenusSiteUrlRequest {
+    /** Query options */
+    query?: CursorQuery;
+}
+interface QueryMenusSiteUrlResponse {
+    /** Retrieved menuInfos with path urls. */
+    menuSiteUrls?: MenuSiteUrl[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1013,54 +1119,6 @@ interface MenuDeletedEnvelope {
  * @documentationMaturity preview
  */
 declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
-/** @param _id - Menu id to be duplicated.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @permissionId RESTAURANTS.MENU_CREATE
- * @applicableIdentity APP
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
- */
-declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
-interface DuplicateMenuOptions {
-    /**
-     * Business location ids to duplicate the menu to.
-     * @format GUID
-     * @maxSize 100
-     */
-    businessLocationIds?: string[] | null;
-    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
-    duplicateSubEntities?: boolean | null;
-    /**
-     * The new name of the duplicated menu.
-     * @maxLength 500
-     */
-    menuName?: string | null;
-}
-/**
- * Get menu details and path URL by menu ID.
- * @param _id - Menu ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @permissionId RESTAURANTS.MENU_READ
- * @applicableIdentity APP
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
- */
-declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
-/**
- * Query menu details and path URL
- * @public
- * @documentationMaturity preview
- * @permissionId RESTAURANTS.MENU_READ
- * @applicableIdentity APP
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
- */
-declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
-interface QueryMenusSiteUrlOptions {
-    /** Query options */
-    query?: CursorQuery;
-}
 /**
  * > **Note:** The Menus API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
  *
@@ -1447,5 +1505,53 @@ interface UpdateExtendedFieldsOptions {
  * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
  */
 declare function deleteMenu(menuId: string): Promise<void>;
+/** @param _id - Menu id to be duplicated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId RESTAURANTS.MENU_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
+ */
+declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
+interface DuplicateMenuOptions {
+    /**
+     * Business location ids to duplicate the menu to.
+     * @format GUID
+     * @maxSize 100
+     */
+    businessLocationIds?: string[] | null;
+    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
+    duplicateSubEntities?: boolean | null;
+    /**
+     * The new name of the duplicated menu.
+     * @maxLength 500
+     */
+    menuName?: string | null;
+}
+/**
+ * Get menu details and path URL by menu ID.
+ * @param _id - Menu ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId RESTAURANTS.MENU_READ
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
+ */
+declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
+/**
+ * Query menu details and path URL
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.MENU_READ
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
+ */
+declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
+interface QueryMenusSiteUrlOptions {
+    /** Query options */
+    query?: CursorQuery;
+}
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateMenuResult, type BulkCreateMenusOptions, type BulkCreateMenusRequest, type BulkCreateMenusResponse, type BulkMenuResult, type BulkUpdateMenuOptions, type BulkUpdateMenuRequest, type BulkUpdateMenuResponse, type BusinessLocationDetails, type CloneMenusRequest, type CloneMenusResponse, type CommonQueryWithEntityContext, type CreateMenuRequest, type CreateMenuResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteMenuRequest, type DeleteMenuResponse, type DeleteOrphanSections, type DomainEvent, type DomainEventBodyOneOf, type DuplicateMenuOptions, type DuplicateMenuRequest, type DuplicateMenuResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReferenceInfo, type File, type GetMenuRequest, type GetMenuResponse, type GetMenuSiteUrlRequest, type GetMenuSiteUrlResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type Keyword, type ListMenusOptions, type ListMenusRequest, type ListMenusResponse, type MaskedMenu, type Menu, type MenuCreatedEnvelope, type MenuDeletedEnvelope, type MenuQuery, type MenuQuerySpec, type MenuSiteUrl, type MenuUpdatedEnvelope, type MenusDataCloningCompleted, type MenusQueryBuilder, type MenusQueryResult, type MessageEnvelope, type Page, type Pages, type QueryMenusRequest, type QueryMenusResponse, type QueryMenusSiteUrlOptions, type QueryMenusSiteUrlRequest, type QueryMenusSiteUrlResponse, type RestoreInfo, type RunMenusMultiLocationMigrationRequest, type RunMenusMultiLocationMigrationResponse, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncContentToMultilingualRequest, type SyncContentToMultilingualResponse, type Tag, type URI, type URIs, type UpdateBusinessLocationIdRequest, type UpdateBusinessLocationIdResponse, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateMenu, type UpdateMenuRequest, type UpdateMenuResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, onMenuCreated, onMenuDeleted, onMenuUpdated, queryMenus, queryMenusSiteUrl, typedQueryMenus, updateExtendedFields, updateMenu, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateMenuResult, type BulkCreateMenusOptions, type BulkCreateMenusRequest, type BulkCreateMenusResponse, type BulkMenuResult, type BulkUpdateMenuOptions, type BulkUpdateMenuRequest, type BulkUpdateMenuResponse, type BusinessLocationDetails, type CloneMenusRequest, type CloneMenusResponse, type CommonQueryWithEntityContext, type CreateMenuRequest, type CreateMenuResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteMenuRequest, type DeleteMenuResponse, type DeleteOrphanSections, type DomainEvent, type DomainEventBodyOneOf, type DuplicateMenuOptions, type DuplicateMenuRequest, type DuplicateMenuResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReferenceInfo, type File, type GetMenuRequest, type GetMenuResponse, type GetMenuSiteUrlRequest, type GetMenuSiteUrlResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type Keyword, type ListMenusOptions, type ListMenusRequest, type ListMenusResponse, type MaskedMenu, type Menu, type MenuCreatedEnvelope, type MenuDeletedEnvelope, type MenuExportRow, type MenuQuery, type MenuQuerySpec, type MenuSiteUrl, type MenuUpdatedEnvelope, type MenusDataCloningCompleted, type MenusQueryBuilder, type MenusQueryResult, type MessageEnvelope, type Page, type Pages, type QueryMenuExportRowsRequest, type QueryMenuExportRowsResponse, type QueryMenusRequest, type QueryMenusResponse, type QueryMenusSiteUrlOptions, type QueryMenusSiteUrlRequest, type QueryMenusSiteUrlResponse, type RestoreInfo, type RunMenusMultiLocationMigrationRequest, type RunMenusMultiLocationMigrationResponse, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncContentToMultilingualRequest, type SyncContentToMultilingualResponse, type Tag, type URI, type URIs, type UpdateBusinessLocationIdRequest, type UpdateBusinessLocationIdResponse, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateMenu, type UpdateMenuRequest, type UpdateMenuResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, onMenuCreated, onMenuDeleted, onMenuUpdated, queryMenus, queryMenusSiteUrl, typedQueryMenus, updateExtendedFields, updateMenu, utils };