@wix/auto_sdk_restaurants_sections 1.0.12 → 1.0.14

package/build/index.d.mts

@@ -0,0 +1,138 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } 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 } from './restaurants-menus-v1-section-sections.universal-BZUvATJu.mjs';
+export { a4 as ActionEvent, A as App, q as ApplicationError, ac as BaseEventMetadata, r as BulkActionMetadata, o as BulkCreateSectionResult, n as BulkCreateSectionsRequest, X as BulkDeleteSectionResult, V as BulkDeleteSectionsRequest, a8 as BulkItemResult, O as BulkSectionResult, a6 as BulkUpdateBusinessLocationIdRequest, a7 as BulkUpdateBusinessLocationIdResponse, N as BulkUpdateSectionRequest, Y as CloneSectionsRequest, Z as CloneSectionsResponse, C as CreateSectionRequest, m as CreateSectionResponse, u as CursorPaging, v as CursorPagingMetadata, x as CursorQuery, y as CursorQueryPagingMethodOneOf, w as Cursors, l as DeleteLocationIdFromItems, R as DeleteSectionRequest, T as DeleteSectionResponse, _ as DomainEvent, $ as DomainEventBodyOneOf, i as DuplicateSectionRequest, a5 as Empty, a0 as EntityCreatedEvent, a3 as EntityDeletedEvent, a2 as EntityUpdatedEvent, ad as EventMetadata, E as ExtendedFields, F as File, G as GetSectionRequest, s as GetSectionResponse, aa as IdentificationData, ab as IdentificationDataIdOneOf, I as InvalidateCache, j as InvalidateCacheGetByOneOf, p as ItemMetadata, t as ListSectionsRequest, a9 as MessageEnvelope, P as Page, Q as QuerySectionsRequest, H as QuerySectionsResponse, a1 as RestoreInfo, ae as SectionCreatedEnvelope, af as SectionDeletedEnvelope, ag as SectionUpdatedEnvelope, ah as SectionsQueryResult, h as SortOrder, z as Sorting, k as URI, J as UpdateSectionRequest, K as UpdateSectionResponse, W as WebhookIdentityType } from './restaurants-menus-v1-section-sections.universal-BZUvATJu.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function duplicateSection$1(httpClient: HttpClient): DuplicateSectionSignature;
+interface DuplicateSectionSignature {
+    /** @param - Section id to be duplicated. */
+    (_id: string, options?: DuplicateSectionOptions | undefined): Promise<DuplicateSectionResponse>;
+}
+declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
+interface CreateSectionSignature {
+    /**
+     * > **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 details.
+     * @returns Section.
+     */
+    (section: Section): Promise<Section>;
+}
+declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
+interface BulkCreateSectionsSignature {
+    /**
+     * > **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 details.
+     */
+    (sections: Section[], options?: BulkCreateSectionsOptions | undefined): Promise<BulkCreateSectionsResponse>;
+}
+declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
+interface GetSectionSignature {
+    /**
+     * > **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 - Section ID.
+     * @returns Section.
+     */
+    (sectionId: string): Promise<Section>;
+}
+declare function listSections$1(httpClient: HttpClient): ListSectionsSignature;
+interface ListSectionsSignature {
+    /**
+     * > **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.
+     */
+    (options?: ListSectionsOptions | undefined): Promise<ListSectionsResponse>;
+}
+declare function querySections$1(httpClient: HttpClient): QuerySectionsSignature;
+interface QuerySectionsSignature {
+    /**
+     * 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`.
+     */
+    (): SectionsQueryBuilder;
+}
+declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
+interface UpdateSectionSignature {
+    /**
+     * > **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 - Section ID.
+     * @returns Updated section.
+     */
+    (_id: string, section: UpdateSection): Promise<Section>;
+}
+declare function bulkUpdateSection$1(httpClient: HttpClient): BulkUpdateSectionSignature;
+interface BulkUpdateSectionSignature {
+    /**
+     * > **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 to update.
+     */
+    (sections: MaskedSection[], options?: BulkUpdateSectionOptions | undefined): Promise<BulkUpdateSectionResponse>;
+}
+declare function deleteSection$1(httpClient: HttpClient): DeleteSectionSignature;
+interface DeleteSectionSignature {
+    /**
+     * > **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 - Section ID.
+     */
+    (sectionId: string): Promise<void>;
+}
+declare function bulkDeleteSections$1(httpClient: HttpClient): BulkDeleteSectionsSignature;
+interface BulkDeleteSectionsSignature {
+    /**
+     * > **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 - Section IDs.
+     */
+    (ids: string[]): Promise<BulkDeleteSectionsResponse>;
+}
+
+declare const duplicateSection: MaybeContext<BuildRESTFunction<typeof duplicateSection$1> & typeof duplicateSection$1>;
+declare const createSection: MaybeContext<BuildRESTFunction<typeof createSection$1> & typeof createSection$1>;
+declare const bulkCreateSections: MaybeContext<BuildRESTFunction<typeof bulkCreateSections$1> & typeof bulkCreateSections$1>;
+declare const getSection: MaybeContext<BuildRESTFunction<typeof getSection$1> & typeof getSection$1>;
+declare const listSections: MaybeContext<BuildRESTFunction<typeof listSections$1> & typeof listSections$1>;
+declare const querySections: MaybeContext<BuildRESTFunction<typeof querySections$1> & typeof querySections$1>;
+declare const updateSection: MaybeContext<BuildRESTFunction<typeof updateSection$1> & typeof updateSection$1>;
+declare const bulkUpdateSection: MaybeContext<BuildRESTFunction<typeof bulkUpdateSection$1> & typeof bulkUpdateSection$1>;
+declare const deleteSection: MaybeContext<BuildRESTFunction<typeof deleteSection$1> & typeof deleteSection$1>;
+declare const bulkDeleteSections: MaybeContext<BuildRESTFunction<typeof bulkDeleteSections$1> & typeof bulkDeleteSections$1>;
+/** */
+declare const onSectionCreated: ReturnType<typeof createEventModule<typeof publicOnSectionCreated>>;
+/** */
+declare const onSectionDeleted: ReturnType<typeof createEventModule<typeof publicOnSectionDeleted>>;
+/**
+ * Triggered when a section is updated.
+ */
+declare const onSectionUpdated: ReturnType<typeof createEventModule<typeof publicOnSectionUpdated>>;
+
+export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, BulkDeleteSectionsResponse, BulkUpdateSectionOptions, BulkUpdateSectionResponse, DuplicateSectionOptions, DuplicateSectionResponse, ListSectionsOptions, ListSectionsResponse, MaskedSection, Section, SectionsQueryBuilder, UpdateSection, bulkCreateSections, bulkDeleteSections, bulkUpdateSection, createSection, deleteSection, duplicateSection, getSection, listSections, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };

package/build/index.d.ts

@@ -0,0 +1,138 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } 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 } from './restaurants-menus-v1-section-sections.universal-BZUvATJu.js';
+export { a4 as ActionEvent, A as App, q as ApplicationError, ac as BaseEventMetadata, r as BulkActionMetadata, o as BulkCreateSectionResult, n as BulkCreateSectionsRequest, X as BulkDeleteSectionResult, V as BulkDeleteSectionsRequest, a8 as BulkItemResult, O as BulkSectionResult, a6 as BulkUpdateBusinessLocationIdRequest, a7 as BulkUpdateBusinessLocationIdResponse, N as BulkUpdateSectionRequest, Y as CloneSectionsRequest, Z as CloneSectionsResponse, C as CreateSectionRequest, m as CreateSectionResponse, u as CursorPaging, v as CursorPagingMetadata, x as CursorQuery, y as CursorQueryPagingMethodOneOf, w as Cursors, l as DeleteLocationIdFromItems, R as DeleteSectionRequest, T as DeleteSectionResponse, _ as DomainEvent, $ as DomainEventBodyOneOf, i as DuplicateSectionRequest, a5 as Empty, a0 as EntityCreatedEvent, a3 as EntityDeletedEvent, a2 as EntityUpdatedEvent, ad as EventMetadata, E as ExtendedFields, F as File, G as GetSectionRequest, s as GetSectionResponse, aa as IdentificationData, ab as IdentificationDataIdOneOf, I as InvalidateCache, j as InvalidateCacheGetByOneOf, p as ItemMetadata, t as ListSectionsRequest, a9 as MessageEnvelope, P as Page, Q as QuerySectionsRequest, H as QuerySectionsResponse, a1 as RestoreInfo, ae as SectionCreatedEnvelope, af as SectionDeletedEnvelope, ag as SectionUpdatedEnvelope, ah as SectionsQueryResult, h as SortOrder, z as Sorting, k as URI, J as UpdateSectionRequest, K as UpdateSectionResponse, W as WebhookIdentityType } from './restaurants-menus-v1-section-sections.universal-BZUvATJu.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function duplicateSection$1(httpClient: HttpClient): DuplicateSectionSignature;
+interface DuplicateSectionSignature {
+    /** @param - Section id to be duplicated. */
+    (_id: string, options?: DuplicateSectionOptions | undefined): Promise<DuplicateSectionResponse>;
+}
+declare function createSection$1(httpClient: HttpClient): CreateSectionSignature;
+interface CreateSectionSignature {
+    /**
+     * > **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 details.
+     * @returns Section.
+     */
+    (section: Section): Promise<Section>;
+}
+declare function bulkCreateSections$1(httpClient: HttpClient): BulkCreateSectionsSignature;
+interface BulkCreateSectionsSignature {
+    /**
+     * > **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 details.
+     */
+    (sections: Section[], options?: BulkCreateSectionsOptions | undefined): Promise<BulkCreateSectionsResponse>;
+}
+declare function getSection$1(httpClient: HttpClient): GetSectionSignature;
+interface GetSectionSignature {
+    /**
+     * > **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 - Section ID.
+     * @returns Section.
+     */
+    (sectionId: string): Promise<Section>;
+}
+declare function listSections$1(httpClient: HttpClient): ListSectionsSignature;
+interface ListSectionsSignature {
+    /**
+     * > **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.
+     */
+    (options?: ListSectionsOptions | undefined): Promise<ListSectionsResponse>;
+}
+declare function querySections$1(httpClient: HttpClient): QuerySectionsSignature;
+interface QuerySectionsSignature {
+    /**
+     * 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`.
+     */
+    (): SectionsQueryBuilder;
+}
+declare function updateSection$1(httpClient: HttpClient): UpdateSectionSignature;
+interface UpdateSectionSignature {
+    /**
+     * > **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 - Section ID.
+     * @returns Updated section.
+     */
+    (_id: string, section: UpdateSection): Promise<Section>;
+}
+declare function bulkUpdateSection$1(httpClient: HttpClient): BulkUpdateSectionSignature;
+interface BulkUpdateSectionSignature {
+    /**
+     * > **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 to update.
+     */
+    (sections: MaskedSection[], options?: BulkUpdateSectionOptions | undefined): Promise<BulkUpdateSectionResponse>;
+}
+declare function deleteSection$1(httpClient: HttpClient): DeleteSectionSignature;
+interface DeleteSectionSignature {
+    /**
+     * > **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 - Section ID.
+     */
+    (sectionId: string): Promise<void>;
+}
+declare function bulkDeleteSections$1(httpClient: HttpClient): BulkDeleteSectionsSignature;
+interface BulkDeleteSectionsSignature {
+    /**
+     * > **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 - Section IDs.
+     */
+    (ids: string[]): Promise<BulkDeleteSectionsResponse>;
+}
+
+declare const duplicateSection: MaybeContext<BuildRESTFunction<typeof duplicateSection$1> & typeof duplicateSection$1>;
+declare const createSection: MaybeContext<BuildRESTFunction<typeof createSection$1> & typeof createSection$1>;
+declare const bulkCreateSections: MaybeContext<BuildRESTFunction<typeof bulkCreateSections$1> & typeof bulkCreateSections$1>;
+declare const getSection: MaybeContext<BuildRESTFunction<typeof getSection$1> & typeof getSection$1>;
+declare const listSections: MaybeContext<BuildRESTFunction<typeof listSections$1> & typeof listSections$1>;
+declare const querySections: MaybeContext<BuildRESTFunction<typeof querySections$1> & typeof querySections$1>;
+declare const updateSection: MaybeContext<BuildRESTFunction<typeof updateSection$1> & typeof updateSection$1>;
+declare const bulkUpdateSection: MaybeContext<BuildRESTFunction<typeof bulkUpdateSection$1> & typeof bulkUpdateSection$1>;
+declare const deleteSection: MaybeContext<BuildRESTFunction<typeof deleteSection$1> & typeof deleteSection$1>;
+declare const bulkDeleteSections: MaybeContext<BuildRESTFunction<typeof bulkDeleteSections$1> & typeof bulkDeleteSections$1>;
+/** */
+declare const onSectionCreated: ReturnType<typeof createEventModule<typeof publicOnSectionCreated>>;
+/** */
+declare const onSectionDeleted: ReturnType<typeof createEventModule<typeof publicOnSectionDeleted>>;
+/**
+ * Triggered when a section is updated.
+ */
+declare const onSectionUpdated: ReturnType<typeof createEventModule<typeof publicOnSectionUpdated>>;
+
+export { BulkCreateSectionsOptions, BulkCreateSectionsResponse, BulkDeleteSectionsResponse, BulkUpdateSectionOptions, BulkUpdateSectionResponse, DuplicateSectionOptions, DuplicateSectionResponse, ListSectionsOptions, ListSectionsResponse, MaskedSection, Section, SectionsQueryBuilder, UpdateSection, bulkCreateSections, bulkDeleteSections, bulkUpdateSection, createSection, deleteSection, duplicateSection, getSection, listSections, onSectionCreated, onSectionDeleted, onSectionUpdated, querySections, updateSection };