@wix/auto_sdk_restaurants_item-modifier-groups 1.0.27 → 1.0.29

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { ModifierGroup, ListModifierGroupsOptions, ListModifierGroupResponse, ModifierGroupsQueryBuilder, CountModifierGroupsOptions, CountModifierGroupsResponse, CountModifierGroupsApplicationErrors, UpdateModifierGroup, BulkCreateModifierGroupsOptions, BulkCreateModifierGroupsResponse, MaskedModifierGroup, BulkUpdateModifierGroupsOptions, BulkUpdateModifierGroupsResponse, BulkDeleteModifierGroupsResponse, ItemModifierGroupCreatedEnvelope, ItemModifierGroupDeletedEnvelope, ItemModifierGroupUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, AdditionalChargeInfo, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateModifierGroupsRequest, BulkCreateModifierGroupsResult, BulkDeleteModifierGroupsRequest, BulkDeleteModifierGroupsResult, BulkItemResult, BulkUpdateBusinessLocationIdsPerEntityRequest, BulkUpdateBusinessLocationIdsPerEntityResponse, BulkUpdateBusinessLocationIdsRequest, BulkUpdateBusinessLocationIdsResponse, BulkUpdateBusinessLocationIdsResponseBulkItemResult, BulkUpdateModifierGroupsRequest, BulkUpdateModifierGroupsResult, CloneModifierGroupsRequest, CloneModifierGroupsResponse, CountModifierGroupsRequest, CreateModifierGroupRequest, CreateModifierGroupResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, DeleteLocationIdsFromModifiers, DeleteModifierGroupRequest, DeleteModifierGroupResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, File, GetModifierGroupRequest, GetModifierGroupResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, ListModifierGroupRequest, MessageEnvelope, Modifier, ModifierGroupIdLocationIds, ModifierGroupsQueryResult, Page, QueryModifierGroupsRequest, QueryModifierGroupsResponse, RestoreInfo, Rule, SortOrder, Sorting, URI, UpdateModifierGroupRequest, UpdateModifierGroupResponse, WebhookIdentityType } from './index.typings.js';
 
+type ItemModifierGroupNonNullablePaths = `modifiers` | `modifiers.${number}._id` | `businessLocationIds`;
 declare function createModifierGroup$1(httpClient: HttpClient): CreateModifierGroupSignature;
 interface CreateModifierGroupSignature {
     /**
@@ -13,7 +14,7 @@ interface CreateModifierGroupSignature {
      * @param - Modifier group details.
      * @returns Modifier group.
      */
-    (modifierGroup: ModifierGroup): Promise<ModifierGroup>;
+    (modifierGroup: NonNullablePaths<ModifierGroup, `name`>): Promise<NonNullablePaths<ModifierGroup, ItemModifierGroupNonNullablePaths>>;
 }
 declare function getModifierGroup$1(httpClient: HttpClient): GetModifierGroupSignature;
 interface GetModifierGroupSignature {
@@ -24,7 +25,7 @@ interface GetModifierGroupSignature {
      * @param - Modifier group ID.
      * @returns Modifier group.
      */
-    (modifierGroupId: string): Promise<ModifierGroup>;
+    (modifierGroupId: string): Promise<NonNullablePaths<ModifierGroup, ItemModifierGroupNonNullablePaths>>;
 }
 declare function listModifierGroups$1(httpClient: HttpClient): ListModifierGroupsSignature;
 interface ListModifierGroupsSignature {
@@ -33,7 +34,9 @@ interface ListModifierGroupsSignature {
      *
      * Retrieves a list of up to 500 modifier groups.
      */
-    (options?: ListModifierGroupsOptions | undefined): Promise<ListModifierGroupResponse>;
+    (options?: ListModifierGroupsOptions): Promise<NonNullablePaths<ListModifierGroupResponse, {
+        [P in ItemModifierGroupNonNullablePaths]: `modifierGroups.${number}.${P}`;
+    }[ItemModifierGroupNonNullablePaths]>>;
 }
 declare function queryModifierGroups$1(httpClient: HttpClient): QueryModifierGroupsSignature;
 interface QueryModifierGroupsSignature {
@@ -63,8 +66,8 @@ interface CountModifierGroupsSignature {
      *
      * If a filter isn't passed in the request, the endpoint returns the count of all modifier groups.
      */
-    (options?: CountModifierGroupsOptions | undefined): Promise<CountModifierGroupsResponse & {
-        __applicationErrorsType?: CountModifierGroupsApplicationErrors | undefined;
+    (options?: CountModifierGroupsOptions): Promise<NonNullablePaths<CountModifierGroupsResponse, `count`> & {
+        __applicationErrorsType?: CountModifierGroupsApplicationErrors;
     }>;
 }
 declare function updateModifierGroup$1(httpClient: HttpClient): UpdateModifierGroupSignature;
@@ -78,7 +81,7 @@ interface UpdateModifierGroupSignature {
      * @param - Modifier group ID.
      * @returns Updated modifier group.
      */
-    (_id: string, modifierGroup: UpdateModifierGroup): Promise<ModifierGroup>;
+    (_id: string, modifierGroup: NonNullablePaths<UpdateModifierGroup, `revision`>): Promise<NonNullablePaths<ModifierGroup, ItemModifierGroupNonNullablePaths>>;
 }
 declare function deleteModifierGroup$1(httpClient: HttpClient): DeleteModifierGroupSignature;
 interface DeleteModifierGroupSignature {
@@ -98,7 +101,9 @@ interface BulkCreateModifierGroupsSignature {
      * Creates multiple modifier groups.
      * @param - Modifier groups details.
      */
-    (modifierGroups: ModifierGroup[], options?: BulkCreateModifierGroupsOptions | undefined): Promise<BulkCreateModifierGroupsResponse>;
+    (modifierGroups: ModifierGroup[], options?: BulkCreateModifierGroupsOptions): Promise<NonNullablePaths<BulkCreateModifierGroupsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in ItemModifierGroupNonNullablePaths]: `results.${number}.modifierGroup.${P}`;
+    }[ItemModifierGroupNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function bulkUpdateModifierGroups$1(httpClient: HttpClient): BulkUpdateModifierGroupsSignature;
 interface BulkUpdateModifierGroupsSignature {
@@ -110,12 +115,14 @@ interface BulkUpdateModifierGroupsSignature {
      * Up to 100 modifier groups can be returned per request.
      * @param - Modifier groups to update.
      */
-    (modifierGroups: MaskedModifierGroup[], options?: BulkUpdateModifierGroupsOptions | undefined): Promise<BulkUpdateModifierGroupsResponse>;
+    (modifierGroups: NonNullablePaths<MaskedModifierGroup, `modifierGroup._id` | `modifierGroup.revision`>[], options?: BulkUpdateModifierGroupsOptions): Promise<NonNullablePaths<BulkUpdateModifierGroupsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in ItemModifierGroupNonNullablePaths]: `results.${number}.modifierGroup.${P}`;
+    }[ItemModifierGroupNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function bulkDeleteModifierGroups$1(httpClient: HttpClient): BulkDeleteModifierGroupsSignature;
 interface BulkDeleteModifierGroupsSignature {
     /** @param - Modifier Group IDs. */
-    (ids: string[]): Promise<BulkDeleteModifierGroupsResponse>;
+    (ids: string[]): Promise<NonNullablePaths<BulkDeleteModifierGroupsResponse, `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`>>;
 }
 declare const onItemModifierGroupCreated$1: EventDefinition<ItemModifierGroupCreatedEnvelope, "wix.restaurants.menus.v1.item_modifier_group_created">;
 declare const onItemModifierGroupDeleted$1: EventDefinition<ItemModifierGroupDeletedEnvelope, "wix.restaurants.menus.v1.item_modifier_group_deleted">;