@wix/auto_sdk_restaurants_sections 1.0.13 → 1.0.14

package/build/meta.d.ts

@@ -0,0 +1,357 @@
+import { i as DuplicateSectionRequest$1, a as DuplicateSectionResponse$1, C as CreateSectionRequest$1, m as CreateSectionResponse$1, n as BulkCreateSectionsRequest$1, b as BulkCreateSectionsResponse$1, G as GetSectionRequest$1, s as GetSectionResponse$1, t as ListSectionsRequest$1, c as ListSectionsResponse$1, Q as QuerySectionsRequest$1, H as QuerySectionsResponse$1, J as UpdateSectionRequest$1, K as UpdateSectionResponse$1, N as BulkUpdateSectionRequest$1, f as BulkUpdateSectionResponse$1, R as DeleteSectionRequest$1, T as DeleteSectionResponse$1, V as BulkDeleteSectionsRequest$1, g as BulkDeleteSectionsResponse$1 } from './restaurants-menus-v1-section-sections.universal-BZUvATJu.js';
+
+interface Section {
+    /**
+     * Section ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the section is updated. To prevent conflicting changes, the current revision must be passed when updating the section. Ignored when creating a section.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the section was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the section was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Section name.
+     * @minLength 1
+     * @maxLength 500
+     */
+    name?: string;
+    /**
+     * Section description.
+     * @maxLength 1500
+     */
+    description?: string | null;
+    /** Main section image. */
+    image?: Image;
+    /**
+     * Additional section images.
+     * @maxSize 100
+     */
+    additionalImages?: Image[];
+    /**
+     * Item IDs.
+     * @format GUID
+     * @maxSize 300
+     */
+    itemIds?: string[];
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+    /** Whether the section is visible in the menu for site visitors. */
+    visible?: boolean | null;
+}
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /** Original image height. */
+    height?: number;
+    /** Original image width. */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /** Image filename. */
+    filename?: string | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface DuplicateSectionRequest {
+    /**
+     * Section id to be duplicated.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * Business location ids to duplicate the section to.
+     * @format GUID
+     * @maxSize 100
+     */
+    businessLocationIds?: string[] | null;
+    /** Indicates whether sub-entities (such as items) should be duplicated as well. */
+    duplicateSubEntities?: boolean | null;
+}
+interface DuplicateSectionResponse {
+    /** @format GUID */
+    sectionId?: string[];
+}
+interface CreateSectionRequest {
+    /** Section details. */
+    section: Section;
+}
+interface CreateSectionResponse {
+    /** Section. */
+    section?: Section;
+}
+interface BulkCreateSectionsRequest {
+    /**
+     * Sections details.
+     * @maxSize 100
+     */
+    sections: Section[];
+    /** Whether to receive the created sections in the response. */
+    returnEntity?: boolean;
+}
+interface BulkCreateSectionsResponse {
+    /** Information about the created sections. */
+    results?: BulkCreateSectionResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkCreateSectionResult {
+    /** Metadata for created sections. */
+    itemMetadata?: ItemMetadata;
+    /** Created section. Only returned if `returnEntity` is set to `true`. */
+    item?: Section;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface GetSectionRequest {
+    /**
+     * Section ID.
+     * @format GUID
+     */
+    sectionId: string;
+}
+interface GetSectionResponse {
+    /** Section. */
+    section?: Section;
+}
+interface ListSectionsRequest {
+    /**
+     * Section IDs.
+     * @format GUID
+     * @maxSize 500
+     */
+    sectionIds?: string[];
+    /** The metadata of the paginated results. */
+    paging?: CursorPaging;
+    /** Whether to return only sections that are visible to site visitors. */
+    onlyVisible?: boolean | 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 ListSectionsResponse {
+    /** Retrieved sections. */
+    sections?: Section[];
+    /** 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 QuerySectionsRequest {
+    /** 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?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface QuerySectionsResponse {
+    /** Retrieved sections. */
+    sections?: Section[];
+    /** The metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface UpdateSectionRequest {
+    /** Section update. */
+    section: Section;
+}
+interface UpdateSectionResponse {
+    /** Updated section. */
+    section?: Section;
+}
+interface BulkUpdateSectionRequest {
+    /**
+     * Sections to update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    sections: MaskedSection[];
+    /** Whether to receive the updated sections in the response. */
+    returnEntity?: boolean;
+}
+interface MaskedSection {
+    /** Section update. */
+    section?: Section;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+interface BulkUpdateSectionResponse {
+    /**
+     * Information about the updated sections.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkSectionResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkSectionResult {
+    /** Whether to receive the updated sections in the response. */
+    sectionMetadata?: ItemMetadata;
+    /** Updated section. Only returned if `returnEntity` is set to `true`. */
+    section?: Section;
+}
+interface DeleteSectionRequest {
+    /**
+     * Section ID.
+     * @format GUID
+     */
+    sectionId: string;
+}
+interface DeleteSectionResponse {
+}
+interface BulkDeleteSectionsRequest {
+    /**
+     * Section IDs.
+     * @format GUID
+     */
+    ids: string[];
+}
+interface BulkDeleteSectionsResponse {
+    /** Information about the deleted sections. */
+    results?: BulkDeleteSectionResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteSectionResult {
+    /** Metadata for deleted sections. */
+    itemMetadata?: ItemMetadata;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function duplicateSection(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, DuplicateSectionRequest$1, DuplicateSectionRequest, DuplicateSectionResponse$1, DuplicateSectionResponse>;
+declare function createSection(): __PublicMethodMetaInfo<'POST', {}, CreateSectionRequest$1, CreateSectionRequest, CreateSectionResponse$1, CreateSectionResponse>;
+declare function bulkCreateSections(): __PublicMethodMetaInfo<'POST', {}, BulkCreateSectionsRequest$1, BulkCreateSectionsRequest, BulkCreateSectionsResponse$1, BulkCreateSectionsResponse>;
+declare function getSection(): __PublicMethodMetaInfo<'GET', {
+    sectionId: string;
+}, GetSectionRequest$1, GetSectionRequest, GetSectionResponse$1, GetSectionResponse>;
+declare function listSections(): __PublicMethodMetaInfo<'GET', {}, ListSectionsRequest$1, ListSectionsRequest, ListSectionsResponse$1, ListSectionsResponse>;
+declare function querySections(): __PublicMethodMetaInfo<'POST', {}, QuerySectionsRequest$1, QuerySectionsRequest, QuerySectionsResponse$1, QuerySectionsResponse>;
+declare function updateSection(): __PublicMethodMetaInfo<'PATCH', {
+    sectionId: string;
+}, UpdateSectionRequest$1, UpdateSectionRequest, UpdateSectionResponse$1, UpdateSectionResponse>;
+declare function bulkUpdateSection(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateSectionRequest$1, BulkUpdateSectionRequest, BulkUpdateSectionResponse$1, BulkUpdateSectionResponse>;
+declare function deleteSection(): __PublicMethodMetaInfo<'DELETE', {
+    sectionId: string;
+}, DeleteSectionRequest$1, DeleteSectionRequest, DeleteSectionResponse$1, DeleteSectionResponse>;
+declare function bulkDeleteSections(): __PublicMethodMetaInfo<'DELETE', {}, BulkDeleteSectionsRequest$1, BulkDeleteSectionsRequest, BulkDeleteSectionsResponse$1, BulkDeleteSectionsResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCreateSections, bulkDeleteSections, bulkUpdateSection, createSection, deleteSection, duplicateSection, getSection, listSections, querySections, updateSection };