@wix/auto_sdk_restaurants_item-modifier-groups 1.0.0

package/build/internal/cjs/src/restaurants-menus-v1-item-modifier-group-item-modifier-groups.universal.d.ts

@@ -0,0 +1,903 @@
+export interface ModifierGroup {
+    /**
+     * Modifier group ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the modifier group is updated. To prevent conflicting changes, the current revision must be passed when updating the modifier group. Ignored when creating a modifier group.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the modifier group was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the modifier group was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Modifier group name. */
+    name?: string | null;
+    /** Group of item modifiers. */
+    modifiers?: Modifier[];
+    /** Modifier group details. */
+    rule?: Rule;
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+}
+export interface Modifier {
+    /** Item modifier ID. */
+    _id?: string;
+    /**
+     * Whether the item modifier is pre-selected.
+     * Default: `false`.
+     */
+    preSelected?: boolean | null;
+    /** Item modifier price details. */
+    additionalChargeInfo?: AdditionalChargeInfo;
+}
+export interface AdditionalChargeInfo {
+    /** Additional charge for the item modifier. A value of `0` means the item modifier is free. */
+    additionalCharge?: string | null;
+}
+export interface Rule {
+    /** Whether the items from the modifier group must be selected. */
+    required?: boolean | null;
+    /**
+     * Minimum number of item modifiers a site visitor must select. The value must be lower or equal to the available item modifiers in the group.
+     * Default: `0`.
+     */
+    minSelections?: number | null;
+    /** Maximum number of item modifiers a site visitor may select. Must be greater than or equal to the value of `minSelections`. */
+    maxSelections?: number | null;
+}
+export 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>>;
+}
+export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    hardPurge?: boolean;
+}
+/** @oneof */
+export interface InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+}
+export interface App {
+    /** The AppDefId */
+    appDefId?: string;
+    /** The instance Id */
+    instanceId?: string;
+}
+export interface Page {
+    /** the msid the page is on */
+    metaSiteId?: string;
+    /** Invalidate by Page ID */
+    pageId?: string;
+}
+export interface URI {
+    /** the msid the URI is on */
+    metaSiteId?: string;
+    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    uriPath?: string;
+}
+export interface File {
+    /** the msid the file is related to */
+    metaSiteId?: string;
+    /** Invalidate by filename (for media files such as PDFs) */
+    fileName?: string;
+}
+export interface CreateModifierGroupRequest {
+    /** Modifier group details. */
+    modifierGroup: ModifierGroup;
+}
+export interface CreateModifierGroupResponse {
+    /** Modifier group. */
+    modifierGroup?: ModifierGroup;
+}
+export interface GetModifierGroupRequest {
+    /** Modifier group ID. */
+    modifierGroupId: string;
+}
+export interface GetModifierGroupResponse {
+    /** Modifier group. */
+    modifierGroup?: ModifierGroup;
+}
+export interface ListModifierGroupRequest {
+    /** Modifier group IDs. */
+    modifierGroupIds?: string[];
+    /** The metadata of the paginated results. */
+    paging?: CursorPaging;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    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;
+}
+export interface ListModifierGroupResponse {
+    /** Retrieved modifier groups. */
+    modifierGroups?: ModifierGroup[];
+    /** The metadata of the paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+export 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;
+}
+export 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;
+}
+export interface QueryModifierGroupsRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+export 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 */
+export 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;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface QueryModifierGroupsResponse {
+    /** Retrieved modifier groups. */
+    modifierGroups?: ModifierGroup[];
+    /** Metadata of the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CountModifierGroupsRequest {
+    /** Filter for counting modifier groups. */
+    filter?: Record<string, any> | null;
+}
+export interface CountModifierGroupsResponse {
+    /** Counted modifier groups. */
+    count?: number;
+}
+export interface UpdateModifierGroupRequest {
+    /** Modifier group to update. */
+    modifierGroup: ModifierGroup;
+}
+export interface UpdateModifierGroupResponse {
+    /** Updated modifier group. */
+    modifierGroup?: ModifierGroup;
+}
+export interface DeleteModifierGroupRequest {
+    /** Modifier group ID. */
+    modifierGroupId: string;
+}
+export interface DeleteModifierGroupResponse {
+}
+export interface BulkCreateModifierGroupsRequest {
+    /** Modifier groups details. */
+    modifierGroups: ModifierGroup[];
+    /** Whether to receive the created modifier groups in the response. */
+    returnEntity?: boolean;
+}
+export interface BulkCreateModifierGroupsResponse {
+    /** Information about the created modifier groups. */
+    results?: BulkCreateModifierGroupsResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCreateModifierGroupsResult {
+    /** Metadata for group modifier creation. */
+    itemMetadata?: ItemMetadata;
+    /** Created modifier group. */
+    modifierGroup?: ModifierGroup;
+}
+export 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;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export 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;
+}
+export interface BulkUpdateModifierGroupsRequest {
+    /** Modifier groups to update. */
+    modifierGroups: MaskedModifierGroup[];
+    /** Whether to receive the updated modifier groups in the response. */
+    returnEntity?: boolean;
+}
+export interface MaskedModifierGroup {
+    /** Modifier group to update. */
+    modifierGroup?: ModifierGroup;
+    /** Explicit list of fields to update. */
+    mask?: string[];
+}
+export interface BulkUpdateModifierGroupsResponse {
+    /** Information about the updated modifier groups. */
+    results?: BulkUpdateModifierGroupsResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateModifierGroupsResult {
+    /** Metadata for group modifier update. */
+    itemMetadata?: ItemMetadata;
+    /** Updated modifier group. Only returned if `returnEntity` is set to `true`. */
+    modifierGroup?: ModifierGroup;
+}
+export interface BulkDeleteModifierGroupsRequest {
+    /** Modifier Group IDs. */
+    ids: string[];
+}
+export interface BulkDeleteModifierGroupsResponse {
+    /** Information about the deleted modifier group. */
+    results?: BulkDeleteModifierGroupsResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteModifierGroupsResult {
+    /** Metadata for group modifier deletion. */
+    itemMetadata?: ItemMetadata;
+}
+export interface CloneModifierGroupsRequest {
+    /** The MetaSiteId to clone from. */
+    metaSiteId?: string;
+}
+export interface CloneModifierGroupsResponse {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface ModifierNonNullableFields {
+    _id: string;
+}
+export interface ModifierGroupNonNullableFields {
+    modifiers: ModifierNonNullableFields[];
+    businessLocationIds: string[];
+}
+export interface CreateModifierGroupResponseNonNullableFields {
+    modifierGroup?: ModifierGroupNonNullableFields;
+}
+export interface GetModifierGroupResponseNonNullableFields {
+    modifierGroup?: ModifierGroupNonNullableFields;
+}
+export interface ListModifierGroupResponseNonNullableFields {
+    modifierGroups: ModifierGroupNonNullableFields[];
+}
+export interface QueryModifierGroupsResponseNonNullableFields {
+    modifierGroups: ModifierGroupNonNullableFields[];
+}
+export interface CountModifierGroupsResponseNonNullableFields {
+    count: number;
+}
+export interface UpdateModifierGroupResponseNonNullableFields {
+    modifierGroup?: ModifierGroupNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkCreateModifierGroupsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    modifierGroup?: ModifierGroupNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateModifierGroupsResponseNonNullableFields {
+    results: BulkCreateModifierGroupsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkUpdateModifierGroupsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    modifierGroup?: ModifierGroupNonNullableFields;
+}
+export interface BulkUpdateModifierGroupsResponseNonNullableFields {
+    results: BulkUpdateModifierGroupsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+interface BulkDeleteModifierGroupsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+export interface BulkDeleteModifierGroupsResponseNonNullableFields {
+    results: BulkDeleteModifierGroupsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface ItemModifierGroupCreatedEnvelope {
+    entity: ModifierGroup;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.item_modifier_group_created
+ * @documentationMaturity preview
+ */
+export declare function onItemModifierGroupCreated(handler: (event: ItemModifierGroupCreatedEnvelope) => void | Promise<void>): void;
+export interface ItemModifierGroupDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.item_modifier_group_deleted
+ * @documentationMaturity preview
+ */
+export declare function onItemModifierGroupDeleted(handler: (event: ItemModifierGroupDeletedEnvelope) => void | Promise<void>): void;
+export interface ItemModifierGroupUpdatedEnvelope {
+    entity: ModifierGroup;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @webhook
+ * @eventType wix.restaurants.menus.v1.item_modifier_group_updated
+ * @documentationMaturity preview
+ */
+export declare function onItemModifierGroupUpdated(handler: (event: ItemModifierGroupUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Creates a modifier group.
+ *
+ * To create multiple modifier groups at once, use [Bulk Create Modifiers](https://dev.wix.com/docs/rest/business-solutions/restaurants/menus/item-modifier-groups/bulk-create-modifier-groups).
+ * @param modifierGroup - Modifier group details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField modifierGroup
+ * @requiredField modifierGroup.name
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_CREATE
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Modifier group.
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.CreateModifierGroup
+ */
+export declare function createModifierGroup(modifierGroup: ModifierGroup): Promise<ModifierGroup & ModifierGroupNonNullableFields>;
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Retrieves a modifier group by the ID.
+ * @param modifierGroupId - Modifier group ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField modifierGroupId
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Modifier group.
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.GetModifierGroup
+ */
+export declare function getModifierGroup(modifierGroupId: string): Promise<ModifierGroup & ModifierGroupNonNullableFields>;
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Retrieves a list of up to 100 modifier groups.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.ListModifierGroups
+ */
+export declare function listModifierGroups(options?: ListModifierGroupsOptions): Promise<ListModifierGroupResponse & ListModifierGroupResponseNonNullableFields>;
+export interface ListModifierGroupsOptions {
+    /** Modifier group IDs. */
+    modifierGroupIds?: string[];
+    /** The metadata of the paginated results. */
+    paging?: CursorPaging;
+}
+/**
+ * Creates a query to retrieve a list of item modifier groups.
+ *
+ * The `queryModifierGroups()` function builds a query to retrieve a list of item modifier groups and returns a `ModifierGroupsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/item-modifier-groups/modifier-groups-query-builder/find) function.
+ *
+ * You can refine the query by chaining `ModifierGroupsQueryBuilder` functions onto the query. `ModifierGroupsQueryBuilder` functions enable you to filter, sort, and control the results that `queryModifierGroups()` returns.
+ *
+ * `queryModifierGroups()` runs with the following `ModifierGroupsQueryBuilder` defaults, which you can override:
+ *
+ * * [`limit(100)`](/item-modifier-groups/modifier-groups-query-builder/limit)
+ * * [`ascending('entityId')`](/item-modifier-groups/modifier-groups-query-builder/ascending)
+ *
+ * The following `ModifierGroupsQueryBuilder` functions are supported for `queryModifierGroups()`. For a full description of the item modifier group object, see the object returned for the [`items`](/item-modifier-groups/modifier-groups-query-builder/items) property in `ModifierGroupsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.QueryModifierGroups
+ */
+export declare function queryModifierGroups(): ModifierGroupsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface ModifierGroupsQueryResult extends QueryCursorResult {
+    items: ModifierGroup[];
+    query: ModifierGroupsQueryBuilder;
+    next: () => Promise<ModifierGroupsQueryResult>;
+    prev: () => Promise<ModifierGroupsQueryResult>;
+}
+export interface ModifierGroupsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'modifiers.preSelected' | 'rule.required' | 'rule.minSelections' | 'rule.maxSelections', value: any) => ModifierGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'modifiers.preSelected' | 'rule.required' | 'rule.minSelections' | 'rule.maxSelections', value: any) => ModifierGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ModifierGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ModifierGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ModifierGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ModifierGroupsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'name', value: string) => ModifierGroupsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'name' | 'modifiers.id' | 'modifiers.preSelected' | 'rule.required', value: any) => ModifierGroupsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'modifiers' | 'rule', value: boolean) => ModifierGroupsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ModifierGroupsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ModifierGroupsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ModifierGroupsQueryResult>;
+}
+/**
+ * > **Note:** The Item 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 the number of modifier groups that match a specified filter.
+ *
+ * If a filter isn't passed in the request, the endpoint returns the count of all modifier groups.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_READ
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.CountModifierGroups
+ */
+export declare function countModifierGroups(options?: CountModifierGroupsOptions): Promise<CountModifierGroupsResponse & CountModifierGroupsResponseNonNullableFields>;
+export interface CountModifierGroupsOptions {
+    /** Filter for counting modifier groups. */
+    filter?: Record<string, any> | null;
+}
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates a modifier group.
+ *
+ * Each time a modifier group is updated, its revision increments by 1. The existing revision must be included when updating the modifier group. This ensures you're working with the latest modifier group information, and it prevents unintended overwrites.
+ * @param _id - Modifier group ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField modifierGroup
+ * @requiredField modifierGroup.revision
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_UPDATE
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @returns Updated modifier group.
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.UpdateModifierGroup
+ */
+export declare function updateModifierGroup(_id: string | null, modifierGroup: UpdateModifierGroup): Promise<ModifierGroup & ModifierGroupNonNullableFields>;
+export interface UpdateModifierGroup {
+    /**
+     * Modifier group ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the modifier group is updated. To prevent conflicting changes, the current revision must be passed when updating the modifier group. Ignored when creating a modifier group.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the modifier group was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the modifier group was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Modifier group name. */
+    name?: string | null;
+    /** Group of item modifiers. */
+    modifiers?: Modifier[];
+    /** Modifier group details. */
+    rule?: Rule;
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+}
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Deletes a modifier group.
+ * @param modifierGroupId - Modifier group ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField modifierGroupId
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_DELETE
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.DeleteModifierGroup
+ */
+export declare function deleteModifierGroup(modifierGroupId: string): Promise<void>;
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Creates multiple modifier groups.
+ * @param modifierGroups - Modifier groups details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField modifierGroups
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_CREATE
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.BulkCreateModifierGroups
+ */
+export declare function bulkCreateModifierGroups(modifierGroups: ModifierGroup[], options?: BulkCreateModifierGroupsOptions): Promise<BulkCreateModifierGroupsResponse & BulkCreateModifierGroupsResponseNonNullableFields>;
+export interface BulkCreateModifierGroupsOptions {
+    /** Whether to receive the created modifier groups in the response. */
+    returnEntity?: boolean;
+}
+/**
+ * > **Note:** The Item Modifier Groups API only works with the Wix Restaurants Menus (New) app. Make sure you downloaded this app from [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
+ *
+ * Updates multiple item modifier groups at once. This function supports partial updates.
+ * Each time a modifier group is updated, its revision increments by 1. The existing revision must be included when updating an item modifier group. This ensures you're working with the latest item information, and prevents unintended overwrites.
+ * Up to 100 modifier groups can be returned per request.
+ * @param modifierGroups - Modifier groups to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField modifierGroups
+ * @requiredField modifierGroups.modifierGroup._id
+ * @requiredField modifierGroups.modifierGroup.revision
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_UPDATE
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.BulkUpdateModifierGroups
+ */
+export declare function bulkUpdateModifierGroups(modifierGroups: MaskedModifierGroup[], options?: BulkUpdateModifierGroupsOptions): Promise<BulkUpdateModifierGroupsResponse & BulkUpdateModifierGroupsResponseNonNullableFields>;
+export interface BulkUpdateModifierGroupsOptions {
+    /** Whether to receive the updated modifier groups in the response. */
+    returnEntity?: boolean;
+}
+/** @param ids - Modifier Group IDs.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId RESTAURANTS.MODIFIER_GROUP_DELETE
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.menus.v1.ModifierGroupsService.BulkDeleteModifierGroups
+ */
+export declare function bulkDeleteModifierGroups(ids: string[]): Promise<BulkDeleteModifierGroupsResponse & BulkDeleteModifierGroupsResponseNonNullableFields>;
+export {};