@wix/auto_sdk_restaurants_sections 1.0.28 → 1.0.29

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { D as DuplicateSectionOptions, a as DuplicateSectionResponse, S as Section, B as BulkCreateSectionsOptions, b as BulkCreateSectionsResponse, L as ListSectionsOptions, c as ListSectionsResponse, d as SectionsQueryBuilder, U as UpdateSection, M as MaskedSection, e as BulkUpdateSectionOptions, f as BulkUpdateSectionResponse, g as BulkDeleteSectionsResponse, h as SectionCreatedEnvelope, i as SectionDeletedEnvelope, j as SectionUpdatedEnvelope } from './restaurants-menus-v1-section-sections.universal-DQ9fychQ.js';
-export { a8 as ActionEvent, A as App, u as ApplicationError, ag as BaseEventMetadata, v as BulkActionMetadata, s as BulkCreateSectionResult, r as BulkCreateSectionsRequest, $ as BulkDeleteSectionResult, _ as BulkDeleteSectionsRequest, ac as BulkItemResult, X as BulkSectionResult, aa as BulkUpdateBusinessLocationIdRequest, ab as BulkUpdateBusinessLocationIdResponse, V as BulkUpdateSectionRequest, a0 as CloneSectionsRequest, a1 as CloneSectionsResponse, p as CreateSectionRequest, q as CreateSectionResponse, y as CursorPaging, z as CursorPagingMetadata, J as CursorQuery, K as CursorQueryPagingMethodOneOf, H as Cursors, C as CustomTag, o as DeleteLocationIdFromItems, Y as DeleteSectionRequest, Z as DeleteSectionResponse, a2 as DomainEvent, a3 as DomainEventBodyOneOf, l as DuplicateSectionRequest, a9 as Empty, a4 as EntityCreatedEvent, a7 as EntityDeletedEvent, a6 as EntityUpdatedEvent, ah as EventMetadata, E as ExtendedFields, F as File, G as GetSectionRequest, w as GetSectionResponse, ae as IdentificationData, af as IdentificationDataIdOneOf, I as InvalidateCache, m as InvalidateCacheGetByOneOf, t as ItemMetadata, x as ListSectionsRequest, ad as MessageEnvelope, P as Page, Q as QuerySectionsRequest, O as QuerySectionsResponse, a5 as RestoreInfo, ai as SectionsQueryResult, k as SortOrder, N as Sorting, n as URI, R as UpdateSectionRequest, T as UpdateSectionResponse, W as WebhookIdentityType } from './restaurants-menus-v1-section-sections.universal-DQ9fychQ.js';
+import { DuplicateSectionOptions, DuplicateSectionResponse, Section, BulkCreateSectionsOptions, BulkCreateSectionsResponse, ListSectionsOptions, ListSectionsResponse, SectionsQueryBuilder, UpdateSection, MaskedSection, BulkUpdateSectionOptions, BulkUpdateSectionResponse, BulkDeleteSectionsResponse, SectionCreatedEnvelope, SectionDeletedEnvelope, SectionUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateSectionResult, BulkCreateSectionsRequest, BulkDeleteSectionResult, BulkDeleteSectionsRequest, BulkItemResult, BulkSectionResult, BulkUpdateBusinessLocationIdRequest, BulkUpdateBusinessLocationIdResponse, BulkUpdateSectionRequest, CloneSectionsRequest, CloneSectionsResponse, CreateSectionRequest, CreateSectionResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, DeleteLocationIdFromItems, DeleteSectionRequest, DeleteSectionResponse, DomainEvent, DomainEventBodyOneOf, DuplicateSectionRequest, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, File, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, ListSectionsRequest, MessageEnvelope, Page, QuerySectionsRequest, QuerySectionsResponse, RestoreInfo, SectionsQueryResult, SortOrder, Sorting, URI, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType } from './index.typings.js';
 
 declare function duplicateSection$1(httpClient: HttpClient): DuplicateSectionSignature;
 interface DuplicateSectionSignature {

package/build/cjs/{restaurants-menus-v1-section-sections.universal-DQ9fychQ.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Section {
     /**
      * Section ID.
@@ -659,13 +661,55 @@ interface SectionCreatedEnvelope {
     entity: Section;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.SECTION_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.section_created
+ * @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onSectionCreated(handler: (event: SectionCreatedEnvelope) => void | Promise<void>): void;
 interface SectionDeletedEnvelope {
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.SECTION_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.section_deleted
+ * @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onSectionDeleted(handler: (event: SectionDeletedEnvelope) => void | Promise<void>): void;
 interface SectionUpdatedEnvelope {
     entity: Section;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a section is updated.
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.SECTION_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.section_updated
+ * @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope) => void | Promise<void>): void;
+type SectionNonNullablePaths = `name` | `additionalImages` | `itemIds`;
+/** @param _id - Section id to be duplicated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId RESTAURANTS.SECTION_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_section.v1.restaurants_duplicate_section.RestaurantsDuplicateSection.DuplicateSection
+ */
+declare function duplicateSection(_id: string, options?: DuplicateSectionOptions): Promise<NonNullablePaths<DuplicateSectionResponse, `sectionId`>>;
 interface DuplicateSectionOptions {
     /**
      * Business location ids to duplicate the section to.
@@ -676,10 +720,70 @@ interface DuplicateSectionOptions {
     /** Indicates whether sub-entities (such as items) should be duplicated as well. */
     duplicateSubEntities?: boolean | null;
 }
+/**
+ * > **Note:** The Sections API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Creates a section.
+ *
+ * To create multiple sections at once, use [Bulk Create Sections](/sections/bulk-create-sections).
+ * @param section - Section details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField section
+ * @permissionId RESTAURANTS.SECTION_CREATE
+ * @applicableIdentity APP
+ * @returns Section.
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.CreateSection
+ */
+declare function createSection(section: Section): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Creates multiple sections at once.
+ * @param sections - Sections details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sections
+ * @permissionId RESTAURANTS.SECTION_CREATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.BulkCreateSections
+ */
+declare function bulkCreateSections(sections: Section[], options?: BulkCreateSectionsOptions): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in SectionNonNullablePaths]: `results.${number}.item.${P}`;
+}[SectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkCreateSectionsOptions {
     /** Whether to receive the created sections in the response. */
     returnEntity?: boolean;
 }
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Retrieves a section by ID.
+ * @param sectionId - Section ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sectionId
+ * @permissionId RESTAURANTS.SECTION_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Section.
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.GetSection
+ */
+declare function getSection(sectionId: string): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Retrieves a list of up to 500 sections.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.SECTION_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.ListSections
+ */
+declare function listSections(options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, {
+    [P in SectionNonNullablePaths]: `sections.${number}.${P}`;
+}[SectionNonNullablePaths]>>;
 interface ListSectionsOptions {
     /**
      * Section IDs.
@@ -692,6 +796,28 @@ interface ListSectionsOptions {
     /** Whether to return only sections that are visible to site visitors. */
     onlyVisible?: boolean | null;
 }
+/**
+ * Creates a query to retrieve a list of sections.
+ *
+ * The `querySections()` function builds a query to retrieve a list of sections and returns a `SectionsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/sections/sections-query-builder/find) function.
+ *
+ * You can refine the query by chaining `SectionsQueryBuilder` functions onto the query. `SectionsQueryBuilder` functions enable you to filter, sort, and control the results that `querySections()` returns.
+ *
+ * `querySections()` runs with the following `SectionsQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/sections/sections-query-builder/limit)
+ *
+ * The following `SectionsQueryBuilder` functions are supported for `querySections()`. For a full description of the section object, see the object returned for the [`items`](/sections/sections-query-result/items) property in `SectionsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.SECTION_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.QuerySections
+ */
+declare function querySections(): SectionsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -761,6 +887,24 @@ interface SectionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<SectionsQueryResult>;
 }
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates a section.
+ *
+ * Each time a section is updated, its revision increments by 1. The existing revision must be included when updating a section. This ensures you're working with the latest section information, and it prevents unintended overwrites.
+ * @param _id - Section ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField section
+ * @requiredField section.revision
+ * @permissionId RESTAURANTS.SECTION_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated section.
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.UpdateSection
+ */
+declare function updateSection(_id: string, section: NonNullablePaths<UpdateSection, `revision`>): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
 interface UpdateSection {
     /**
      * Section ID.
@@ -818,9 +962,54 @@ interface UpdateSection {
      */
     businessLocationId?: string | null;
 }
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates multiple sections at once.
+ *
+ * Each time a section is updated, its revision increments by 1. The existing revision must be included when updating a section. This ensures you're working with the latest section information, and it prevents unintended overwrites.
+ * @param sections - Sections to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sections
+ * @requiredField sections.section._id
+ * @requiredField sections.section.revision
+ * @permissionId RESTAURANTS.SECTION_UPDATE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.BulkUpdateSection
+ */
+declare function bulkUpdateSection(sections: NonNullablePaths<MaskedSection, `section._id` | `section.revision`>[], options?: BulkUpdateSectionOptions): Promise<NonNullablePaths<BulkUpdateSectionResponse, `results` | `results.${number}.sectionMetadata.originalIndex` | `results.${number}.sectionMetadata.success` | `results.${number}.sectionMetadata.error.code` | `results.${number}.sectionMetadata.error.description` | {
+    [P in SectionNonNullablePaths]: `results.${number}.section.${P}`;
+}[SectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkUpdateSectionOptions {
     /** Whether to receive the updated sections in the response. */
     returnEntity?: boolean;
 }
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Deletes a section.
+ * @param sectionId - Section ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField sectionId
+ * @permissionId RESTAURANTS.SECTION_DELETE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.DeleteSection
+ */
+declare function deleteSection(sectionId: string): Promise<void>;
+/**
+ * > **Note:** The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Deletes multiple sections at once.
+ * @param ids - Section IDs.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId RESTAURANTS.SECTION_DELETE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.BulkDeleteSections
+ */
+declare function bulkDeleteSections(ids: string[]): Promise<NonNullablePaths<BulkDeleteSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 
-export { type BulkDeleteSectionResult as $, type App as A, type BulkCreateSectionsOptions as B, type CustomTag as C, type DuplicateSectionOptions as D, type ExtendedFields as E, type File as F, type GetSectionRequest as G, type Cursors as H, type InvalidateCache as I, type CursorQuery as J, type CursorQueryPagingMethodOneOf as K, type ListSectionsOptions as L, type MaskedSection as M, type Sorting as N, type QuerySectionsResponse as O, type Page as P, type QuerySectionsRequest as Q, type UpdateSectionRequest as R, type Section as S, type UpdateSectionResponse as T, type UpdateSection as U, type BulkUpdateSectionRequest as V, WebhookIdentityType as W, type BulkSectionResult as X, type DeleteSectionRequest as Y, type DeleteSectionResponse as Z, type BulkDeleteSectionsRequest as _, type DuplicateSectionResponse as a, type CloneSectionsRequest as a0, type CloneSectionsResponse as a1, type DomainEvent as a2, type DomainEventBodyOneOf as a3, type EntityCreatedEvent as a4, type RestoreInfo as a5, type EntityUpdatedEvent as a6, type EntityDeletedEvent as a7, type ActionEvent as a8, type Empty as a9, type BulkUpdateBusinessLocationIdRequest as aa, type BulkUpdateBusinessLocationIdResponse as ab, type BulkItemResult as ac, type MessageEnvelope as ad, type IdentificationData as ae, type IdentificationDataIdOneOf as af, type BaseEventMetadata as ag, type EventMetadata as ah, type SectionsQueryResult as ai, type BulkCreateSectionsResponse as b, type ListSectionsResponse as c, type SectionsQueryBuilder as d, type BulkUpdateSectionOptions as e, type BulkUpdateSectionResponse as f, type BulkDeleteSectionsResponse as g, type SectionCreatedEnvelope as h, type SectionDeletedEnvelope as i, type SectionUpdatedEnvelope as j, SortOrder as k, type DuplicateSectionRequest as l, type InvalidateCacheGetByOneOf as m, type URI as n, type DeleteLocationIdFromItems as o, type CreateSectionRequest as p, type CreateSectionResponse as q, type BulkCreateSectionsRequest as r, type BulkCreateSectionResult as s, type ItemMetadata as t, type ApplicationError as u, type BulkActionMetadata as v, type GetSectionResponse as w, type ListSectionsRequest as x, type CursorPaging as y, type CursorPagingMetadata as z };
+export { type ActionEvent, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateSectionResult, type BulkCreateSectionsOptions, type BulkCreateSectionsRequest, type BulkCreateSectionsResponse, type BulkDeleteSectionResult, type BulkDeleteSectionsRequest, type BulkDeleteSectionsResponse, type BulkItemResult, type BulkSectionResult, type BulkUpdateBusinessLocationIdRequest, type BulkUpdateBusinessLocationIdResponse, type BulkUpdateSectionOptions, type BulkUpdateSectionRequest, type BulkUpdateSectionResponse, type CloneSectionsRequest, type CloneSectionsResponse, type CreateSectionRequest, type CreateSectionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteLocationIdFromItems, type DeleteSectionRequest, type DeleteSectionResponse, type DomainEvent, type DomainEventBodyOneOf, type DuplicateSectionOptions, type DuplicateSectionRequest, type DuplicateSectionResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type File, type GetSectionRequest, type GetSectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type ListSectionsOptions, type ListSectionsRequest, type ListSectionsResponse, type MaskedSection, type MessageEnvelope, type Page, type QuerySectionsRequest, type QuerySectionsResponse, type RestoreInfo, type Section, type SectionCreatedEnvelope, type SectionDeletedEnvelope, type SectionUpdatedEnvelope, type SectionsQueryBuilder, type SectionsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type UpdateSection, type UpdateSectionRequest, type UpdateSectionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateSections, bulkDeleteSections, bulkUpdateSection, createSection, deleteSection, duplicateSection, getSection, listSections, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };