@wix/auto_sdk_restaurants_sections 1.0.32 → 1.0.34

package/build/cjs/index.d.ts

@@ -1,12 +1,17 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 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, ExternalReferenceInfo, 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';
+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, ExternalReferenceInfo, File, GetSectionRequest, GetSectionResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, ListSectionsRequest, MessageEnvelope, Page, QuerySectionsRequest, QuerySectionsResponse, RestoreInfo, SectionsQueryResult, SortOrder, SortOrderWithLiterals, Sorting, URI, UpdateSectionRequest, UpdateSectionResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
-type SectionNonNullablePaths = `name` | `additionalImages` | `itemIds`;
 declare function duplicateSection$1(httpClient: HttpClient): DuplicateSectionSignature;
 interface DuplicateSectionSignature {
-    /** @param - Section id to be duplicated. */
-    (_id: string, options?: DuplicateSectionOptions): Promise<NonNullablePaths<DuplicateSectionResponse, `sectionId`>>;
+    /**
+     * Duplicates a section.
+     *
+     * You can duplicate a section to the same business location, or to 1 or more different business locations.
+     * You can specify whether to also duplicate the section's sub-entities, such as its items.
+     * @param - ID of the section to be duplicated.
+     */
+    (_id: string, options?: DuplicateSectionOptions): Promise<NonNullablePaths<DuplicateSectionResponse, `sectionId`, 2>>;
 }
 declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
 interface CreateSectionSignature {
@@ -19,7 +24,7 @@ interface CreateSectionSignature {
      * @param - Section details.
      * @returns Section.
      */
-    (section: Section): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
+    (section: Section): Promise<NonNullablePaths<Section, `name` | `additionalImages` | `itemIds`, 2>>;
 }
 declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
 interface BulkCreateSectionsSignature {
@@ -29,9 +34,7 @@ interface BulkCreateSectionsSignature {
      * Creates multiple sections at once.
      * @param - Sections details.
      */
-    (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`>>;
+    (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` | `results.${number}.item.name` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 }
 declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
 interface GetSectionSignature {
@@ -42,7 +45,7 @@ interface GetSectionSignature {
      * @param - Section ID.
      * @returns Section.
      */
-    (sectionId: string): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
+    (sectionId: string): Promise<NonNullablePaths<Section, `name` | `additionalImages` | `itemIds`, 2>>;
 }
 declare function listSections$1(httpClient: HttpClient): ListSectionsSignature;
 interface ListSectionsSignature {
@@ -51,9 +54,7 @@ interface ListSectionsSignature {
      *
      * Retrieves a list of up to 500 sections.
      */
-    (options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, {
-        [P in SectionNonNullablePaths]: `sections.${number}.${P}`;
-    }[SectionNonNullablePaths]>>;
+    (options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, `sections` | `sections.${number}.name`, 4>>;
 }
 declare function querySections$1(httpClient: HttpClient): QuerySectionsSignature;
 interface QuerySectionsSignature {
@@ -85,7 +86,7 @@ interface UpdateSectionSignature {
      * @param - Section ID.
      * @returns Updated section.
      */
-    (_id: string, section: NonNullablePaths<UpdateSection, `revision`>): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
+    (_id: string, section: NonNullablePaths<UpdateSection, `revision`, 2>): Promise<NonNullablePaths<Section, `name` | `additionalImages` | `itemIds`, 2>>;
 }
 declare function bulkUpdateSection$1(httpClient: HttpClient): BulkUpdateSectionSignature;
 interface BulkUpdateSectionSignature {
@@ -97,9 +98,7 @@ interface BulkUpdateSectionSignature {
      * 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 to update.
      */
-    (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`>>;
+    (sections: NonNullablePaths<MaskedSection, `section._id` | `section.revision`, 3>[], options?: BulkUpdateSectionOptions): Promise<NonNullablePaths<BulkUpdateSectionResponse, `results` | `results.${number}.sectionMetadata.originalIndex` | `results.${number}.sectionMetadata.success` | `results.${number}.sectionMetadata.error.code` | `results.${number}.sectionMetadata.error.description` | `results.${number}.section.name` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 }
 declare function deleteSection$1(httpClient: HttpClient): DeleteSectionSignature;
 interface DeleteSectionSignature {
@@ -119,7 +118,7 @@ interface BulkDeleteSectionsSignature {
      * Deletes multiple sections at once.
      * @param - Section IDs.
      */
-    (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`>>;
+    (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`, 6>>;
 }
 declare const onSectionCreated$1: EventDefinition<SectionCreatedEnvelope, "wix.restaurants.menus.v1.section_created">;
 declare const onSectionDeleted$1: EventDefinition<SectionDeletedEnvelope, "wix.restaurants.menus.v1.section_deleted">;