@wix/auto_sdk_restaurants_fulfillment-methods 1.0.31 → 1.0.32

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 { FulfillmentMethod, BulkCreateFulfillmentMethodsOptions, BulkCreateFulfillmentMethodsResponse, UpdateFulfillmentMethod, FulfillmentMethodsQueryBuilder, ListFulfillmentMethodsOptions, ListFulfillmentMethodsResponse, ListAvailableFulfillmentMethodsForAddressOptions, ListAvailableFulfillmentMethodsForAddressResponse, GetAccumulatedFulfillmentMethodsAvailabilityOptions, GetAccumulatedFulfillmentMethodsAvailabilityResponse, GetCombinedMethodAvailabilityResponse, GetAggregatedMethodAvailabilityResponse, BulkUpdateFulfillmentMethodTagsOptions, BulkUpdateFulfillmentMethodTagsResponse, BulkUpdateFulfillmentMethodTagsApplicationErrors, BulkUpdateFulfillmentMethodTagsByFilterOptions, BulkUpdateFulfillmentMethodTagsByFilterResponse, BulkUpdateFulfillmentMethodTagsByFilterApplicationErrors, FulfillmentMethodCreatedEnvelope, FulfillmentMethodDeletedEnvelope, FulfillmentMethodUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, Address, AddressHint, AddressLocation, App, ApplicationError, Availability, BaseEventMetadata, BulkActionMetadata, BulkCreateFulfillmentMethodResult, BulkCreateFulfillmentMethodsRequest, BulkUpdateFulfillmentMethodTagsByFilterRequest, BulkUpdateFulfillmentMethodTagsRequest, BulkUpdateFulfillmentMethodTagsResult, BusinessSchedule, Categories, ChangeContext, ChangeContextPayloadOneOf, CommonAddress, CommonAddressStreetOneOf, CommonBulkActionMetadata, CommonItemMetadata, ConsentPolicy, CreateFulfillmentMethodRequest, CreateFulfillmentMethodResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomArea, CustomTag, DayOfWeek, DayOfWeekAvailability, DeleteFulfillmentMethodRequest, DeleteFulfillmentMethodResponse, DeliveryArea, DeliveryAreaAreaOptionsOneOf, DeliveryInfo, DomainEvent, DomainEventBodyOneOf, Empty, EntitiesDayOfWeek, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, File, FulfillmentMethodMethodOptionsOneOf, FulfillmentMethodType, FulfillmentMethodsQueryResult, GeoCoordinates, GetAccumulatedFulfillmentMethodsAvailabilityRequest, GetAggregatedMethodAvailabilityRequest, GetCombinedMethodAvailabilityRequest, GetFulfillmentMethodRequest, GetFulfillmentMethodResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, ListActiveFulfillmentMethodsRequest, ListActiveFulfillmentMethodsResponse, ListAvailableFulfillmentMethodsForAddressRequest, ListFulfillmentMethodsRequest, Locale, MessageEnvelope, Multilingual, Page, PickupInfo, PlacementType, PostalCode, Properties, PropertiesChange, QueryFulfillmentMethodsRequest, QueryFulfillmentMethodsResponse, Radius, ResolutionMethod, RestoreInfo, SiteCloned, SiteCreated, SitePropertiesEvent, SitePropertiesNotification, SortOrder, Sorting, SpecialHourPeriod, StreetAddress, Subdivision, SubdivisionType, SupportedLanguage, TagList, Tags, TimeOfDay, TimeOfDayRange, TimePeriod, Translation, Type, URI, Unit, UpdateFulfillmentMethodRequest, UpdateFulfillmentMethodResponse, WebhookIdentityType } from './index.typings.js';
 
+type FulfillmentMethodNonNullablePaths = `pickupOptions.address.streetAddress.number` | `pickupOptions.address.streetAddress.name` | `deliveryOptions.deliveryArea.radiusOptions.centerPointAddress.streetAddress.number` | `deliveryOptions.deliveryArea.radiusOptions.centerPointAddress.streetAddress.name` | `deliveryOptions.deliveryArea.radiusOptions.unit` | `deliveryOptions.deliveryArea.postalCodeOptions.postalCodes` | `deliveryOptions.deliveryArea.customOptions.geocodes` | `deliveryOptions.deliveryArea.type` | `type` | `availability.availableTimes` | `availability.availableTimes.${number}.dayOfWeek` | `tags.privateTags.tagIds`;
 declare function createFulfillmentMethod$1(httpClient: HttpClient): CreateFulfillmentMethodSignature;
 interface CreateFulfillmentMethodSignature {
     /**
@@ -11,14 +12,16 @@ interface CreateFulfillmentMethodSignature {
      * @param - Fulfillment method to create.
      * @returns The created fulfillment method.
      */
-    (fulfillmentMethod: FulfillmentMethod): Promise<FulfillmentMethod>;
+    (fulfillmentMethod: NonNullablePaths<FulfillmentMethod, `deliveryOptions.deliveryArea` | `deliveryOptions.deliveryArea.postalCodeOptions.countryCode` | `deliveryOptions.deliveryArea.radiusOptions.centerPointAddress` | `deliveryOptions.deliveryArea.radiusOptions.maxDistance`>): Promise<NonNullablePaths<FulfillmentMethod, FulfillmentMethodNonNullablePaths>>;
 }
 declare function bulkCreateFulfillmentMethods$1(httpClient: HttpClient): BulkCreateFulfillmentMethodsSignature;
 interface BulkCreateFulfillmentMethodsSignature {
     /**
      * Create multiple fulfillment methods at once.
      */
-    (options?: BulkCreateFulfillmentMethodsOptions | undefined): Promise<BulkCreateFulfillmentMethodsResponse>;
+    (options?: BulkCreateFulfillmentMethodsOptions): Promise<NonNullablePaths<BulkCreateFulfillmentMethodsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in FulfillmentMethodNonNullablePaths]: `results.${number}.fulfillmentMethod.${P}`;
+    }[FulfillmentMethodNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function getFulfillmentMethod$1(httpClient: HttpClient): GetFulfillmentMethodSignature;
 interface GetFulfillmentMethodSignature {
@@ -27,7 +30,7 @@ interface GetFulfillmentMethodSignature {
      * @param - The ID of the fulfillment method to retrieve.
      * @returns The retrieved fulfillment method.
      */
-    (fulfillmentMethodId: string): Promise<FulfillmentMethod>;
+    (fulfillmentMethodId: string): Promise<NonNullablePaths<FulfillmentMethod, FulfillmentMethodNonNullablePaths>>;
 }
 declare function updateFulfillmentMethod$1(httpClient: HttpClient): UpdateFulfillmentMethodSignature;
 interface UpdateFulfillmentMethodSignature {
@@ -39,7 +42,7 @@ interface UpdateFulfillmentMethodSignature {
      * @param - Fulfillment method information to update.
      * @returns The updated fulfillment method.
      */
-    (_id: string, fulfillmentMethod: UpdateFulfillmentMethod): Promise<FulfillmentMethod>;
+    (_id: string, fulfillmentMethod: NonNullablePaths<UpdateFulfillmentMethod, `revision`>): Promise<NonNullablePaths<FulfillmentMethod, FulfillmentMethodNonNullablePaths>>;
 }
 declare function deleteFulfillmentMethod$1(httpClient: HttpClient): DeleteFulfillmentMethodSignature;
 interface DeleteFulfillmentMethodSignature {
@@ -75,7 +78,9 @@ interface ListFulfillmentMethodsSignature {
      * Retrieves a list of up to 100 fulfillment methods.
      * @param - Options for listing the fulfillment methods.
      */
-    (options?: ListFulfillmentMethodsOptions | undefined): Promise<ListFulfillmentMethodsResponse>;
+    (options?: ListFulfillmentMethodsOptions): Promise<NonNullablePaths<ListFulfillmentMethodsResponse, {
+        [P in FulfillmentMethodNonNullablePaths]: `fulfillmentMethods.${number}.${P}`;
+    }[FulfillmentMethodNonNullablePaths]>>;
 }
 declare function listAvailableFulfillmentMethodsForAddress$1(httpClient: HttpClient): ListAvailableFulfillmentMethodsForAddressSignature;
 interface ListAvailableFulfillmentMethodsForAddressSignature {
@@ -87,7 +92,9 @@ interface ListAvailableFulfillmentMethodsForAddressSignature {
      * - Delivery fulfillment methods that are available to the given address according to their delivery areas.
      * @param - Options for listing the available fulfillment methods.
      */
-    (options?: ListAvailableFulfillmentMethodsForAddressOptions | undefined): Promise<ListAvailableFulfillmentMethodsForAddressResponse>;
+    (options?: ListAvailableFulfillmentMethodsForAddressOptions): Promise<NonNullablePaths<ListAvailableFulfillmentMethodsForAddressResponse, {
+        [P in FulfillmentMethodNonNullablePaths]: `fulfillmentMethods.${number}.${P}`;
+    }[FulfillmentMethodNonNullablePaths]>>;
 }
 declare function getAccumulatedFulfillmentMethodsAvailability$1(httpClient: HttpClient): GetAccumulatedFulfillmentMethodsAvailabilitySignature;
 interface GetAccumulatedFulfillmentMethodsAvailabilitySignature {
@@ -95,7 +102,7 @@ interface GetAccumulatedFulfillmentMethodsAvailabilitySignature {
      * Retrieves the accumulated availability of all fulfillment methods.
      * @deprecated
      */
-    (options?: GetAccumulatedFulfillmentMethodsAvailabilityOptions | undefined): Promise<GetAccumulatedFulfillmentMethodsAvailabilityResponse>;
+    (options?: GetAccumulatedFulfillmentMethodsAvailabilityOptions): Promise<NonNullablePaths<GetAccumulatedFulfillmentMethodsAvailabilityResponse, `availability.availableTimes` | `availability.availableTimes.${number}.dayOfWeek` | `types`>>;
 }
 declare function getCombinedMethodAvailability$1(httpClient: HttpClient): GetCombinedMethodAvailabilitySignature;
 interface GetCombinedMethodAvailabilitySignature {
@@ -106,7 +113,7 @@ interface GetCombinedMethodAvailabilitySignature {
      * @param - IDs of fulfillment methods used to determine the combined availability.
      * @deprecated
      */
-    (fulfillmentMethodIds: string[]): Promise<GetCombinedMethodAvailabilityResponse>;
+    (fulfillmentMethodIds: string[]): Promise<NonNullablePaths<GetCombinedMethodAvailabilityResponse, `combinedAvailability.availableTimes` | `combinedAvailability.availableTimes.${number}.dayOfWeek` | `fulfillmentTypes`>>;
 }
 declare function getAggregatedMethodAvailability$1(httpClient: HttpClient): GetAggregatedMethodAvailabilitySignature;
 interface GetAggregatedMethodAvailabilitySignature {
@@ -116,7 +123,7 @@ interface GetAggregatedMethodAvailabilitySignature {
      * The aggregated availability is a list of times during which one or more of the given fulfillment methods is available, and the types of those fulfillment methods.
      * @param - IDs of fulfillment methods used to determine the aggregated availability.
      */
-    (fulfillmentMethodIds: string[]): Promise<GetAggregatedMethodAvailabilityResponse>;
+    (fulfillmentMethodIds: string[]): Promise<NonNullablePaths<GetAggregatedMethodAvailabilityResponse, `aggregatedAvailability.availableTimes` | `aggregatedAvailability.availableTimes.${number}.dayOfWeek` | `fulfillmentTypes`>>;
 }
 declare function bulkUpdateFulfillmentMethodTags$1(httpClient: HttpClient): BulkUpdateFulfillmentMethodTagsSignature;
 interface BulkUpdateFulfillmentMethodTagsSignature {
@@ -125,8 +132,8 @@ interface BulkUpdateFulfillmentMethodTagsSignature {
      * If you specify a tag in both `assignTags` and `unassignTags`, it is assigned.
      * @param - IDs of the fulfillment methods to update tags for.
      */
-    (fulfillmentMethodIds: string[], options?: BulkUpdateFulfillmentMethodTagsOptions | undefined): Promise<BulkUpdateFulfillmentMethodTagsResponse & {
-        __applicationErrorsType?: BulkUpdateFulfillmentMethodTagsApplicationErrors | undefined;
+    (fulfillmentMethodIds: string[], options?: BulkUpdateFulfillmentMethodTagsOptions): Promise<NonNullablePaths<BulkUpdateFulfillmentMethodTagsResponse, `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`> & {
+        __applicationErrorsType?: BulkUpdateFulfillmentMethodTagsApplicationErrors;
     }>;
 }
 declare function bulkUpdateFulfillmentMethodTagsByFilter$1(httpClient: HttpClient): BulkUpdateFulfillmentMethodTagsByFilterSignature;
@@ -137,8 +144,8 @@ interface BulkUpdateFulfillmentMethodTagsByFilterSignature {
      * If you specify a tag in both `assignTags` and `unassignTags`, it is assigned.
      * @param - Filter that determines which fulfillment methods to update tags for.
      */
-    (filter: Record<string, any>, options?: BulkUpdateFulfillmentMethodTagsByFilterOptions | undefined): Promise<BulkUpdateFulfillmentMethodTagsByFilterResponse & {
-        __applicationErrorsType?: BulkUpdateFulfillmentMethodTagsByFilterApplicationErrors | undefined;
+    (filter: Record<string, any>, options?: BulkUpdateFulfillmentMethodTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateFulfillmentMethodTagsByFilterResponse, `jobId`> & {
+        __applicationErrorsType?: BulkUpdateFulfillmentMethodTagsByFilterApplicationErrors;
     }>;
 }
 declare const onFulfillmentMethodCreated$1: EventDefinition<FulfillmentMethodCreatedEnvelope, "wix.restaurants.v1.fulfillment_method_created">;