@wix/auto_sdk_restaurants_operations 1.0.95 → 1.0.96
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.js +1 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.js +1 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.js +1 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs +1 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.mjs +1 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.mjs +1 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.js +1 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +149 -1
- package/build/internal/cjs/index.typings.js +1 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +166 -1
- package/build/internal/cjs/meta.js +1 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.mjs +1 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +149 -1
- package/build/internal/es/index.typings.mjs +1 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +166 -1
- package/build/internal/es/meta.mjs +1 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -33,6 +33,26 @@ interface Operation extends OperationOnlineOrderingStatusOptionsOneOf {
|
|
|
33
33
|
updatedDate?: Date | null;
|
|
34
34
|
/** Operation name. */
|
|
35
35
|
name?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* Currently INTERNAL. Whether the operation is enabled.
|
|
38
|
+
* @internal
|
|
39
|
+
*/
|
|
40
|
+
enabled?: boolean | null;
|
|
41
|
+
/**
|
|
42
|
+
* The scheduling data for this operation.
|
|
43
|
+
* Scheduling specifies when an order can be placed for.
|
|
44
|
+
* @internal
|
|
45
|
+
* @deprecated
|
|
46
|
+
* @replacedBy order_scheduling
|
|
47
|
+
* @targetRemovalDate 2024-03-04
|
|
48
|
+
*/
|
|
49
|
+
scheduling?: Scheduling;
|
|
50
|
+
/**
|
|
51
|
+
* INTERNAL. Profile ID associated with the operation.
|
|
52
|
+
* @internal
|
|
53
|
+
* @format GUID
|
|
54
|
+
*/
|
|
55
|
+
profileId?: string | null;
|
|
36
56
|
/**
|
|
37
57
|
* Whether the operation is the default operation. <br />
|
|
38
58
|
* Default: `false`.
|
|
@@ -63,6 +83,11 @@ interface Operation extends OperationOnlineOrderingStatusOptionsOneOf {
|
|
|
63
83
|
* @readonly
|
|
64
84
|
*/
|
|
65
85
|
businessLocationId?: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* Information about the business location where this operation is available. This information is taken from the `Location` object ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations)) corresponding with this operation's `businessLocationId`.
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
businessLocationDetails?: BusinessLocationDetails;
|
|
66
91
|
/** Extended fields. */
|
|
67
92
|
extendedFields?: ExtendedFields;
|
|
68
93
|
/** Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction)) used to classify and sort different types of operations. */
|
|
@@ -121,6 +146,11 @@ interface AsapScheduling extends AsapSchedulingPreparationTimeOneOf, AsapSchedul
|
|
|
121
146
|
allowSameDayPreorder?: boolean | null;
|
|
122
147
|
/** The type of preorder allowed for the ASAP scheduling. */
|
|
123
148
|
asapPreorderType?: AsapPreorderTypeWithLiterals;
|
|
149
|
+
/**
|
|
150
|
+
* Asap pacing configuration
|
|
151
|
+
* @internal
|
|
152
|
+
*/
|
|
153
|
+
orderPacing?: AsapOrderPacing;
|
|
124
154
|
}
|
|
125
155
|
/** @oneof */
|
|
126
156
|
interface AsapSchedulingPreparationTimeOneOf {
|
|
@@ -291,11 +321,25 @@ interface TimeOfDay {
|
|
|
291
321
|
/** Information about preorders. */
|
|
292
322
|
interface PreorderScheduling {
|
|
293
323
|
method?: PreorderMethod;
|
|
324
|
+
/**
|
|
325
|
+
* Configuration of the fulfillment times. <br />
|
|
326
|
+
* Currently, only `TIME_WINDOWS` is supported.
|
|
327
|
+
* @internal
|
|
328
|
+
* @deprecated
|
|
329
|
+
* @replacedBy fulfillment_times_display
|
|
330
|
+
* @targetRemovalDate 2023-11-11
|
|
331
|
+
*/
|
|
332
|
+
fulfillmentTimesDisplayConfig?: FulfillmentTimesDisplayConfig;
|
|
294
333
|
/**
|
|
295
334
|
* Configuration of the fulfillment times. <br />
|
|
296
335
|
* Currently, only `TIME_WINDOWS` is supported.
|
|
297
336
|
*/
|
|
298
337
|
fulfillmentTimesDisplay?: FulfillmentTimesDisplayConfig;
|
|
338
|
+
/**
|
|
339
|
+
* Preorder pacing configuration
|
|
340
|
+
* @internal
|
|
341
|
+
*/
|
|
342
|
+
orderPacing?: PreOrderPacing;
|
|
299
343
|
}
|
|
300
344
|
/** Method for `PREORDER` scheduling type. */
|
|
301
345
|
interface PreorderMethod extends PreorderMethodMethodOptionsOneOf {
|
|
@@ -335,6 +379,22 @@ declare enum MethodType {
|
|
|
335
379
|
type MethodTypeWithLiterals = MethodType | 'TIME_BOUNDED' | 'WEEKLY_SCHEDULE';
|
|
336
380
|
/** Information about the time range when preorders are time bounded. */
|
|
337
381
|
interface TimeBounded {
|
|
382
|
+
/**
|
|
383
|
+
* Minimum time required to schedule the order.
|
|
384
|
+
* @internal
|
|
385
|
+
* @deprecated
|
|
386
|
+
* @replacedBy min_time_in_advance
|
|
387
|
+
* @targetRemovalDate 2023-11-11
|
|
388
|
+
*/
|
|
389
|
+
minimumInAdvanceTime?: TimeDuration;
|
|
390
|
+
/**
|
|
391
|
+
* Maximum time allowed to schedule the order.
|
|
392
|
+
* @internal
|
|
393
|
+
* @deprecated
|
|
394
|
+
* @replacedBy max_time_in_advance
|
|
395
|
+
* @targetRemovalDate 2023-11-11
|
|
396
|
+
*/
|
|
397
|
+
maximumInAdvanceTime?: TimeDuration;
|
|
338
398
|
/** Minimum time required to schedule the order. */
|
|
339
399
|
minTimeInAdvance?: TimeDuration;
|
|
340
400
|
/** Maximum time allowed to schedule the order. */
|
|
@@ -353,6 +413,15 @@ interface WeeklySchedule {
|
|
|
353
413
|
interface FulfillmentTimesDisplayConfig extends FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {
|
|
354
414
|
/** Options for fulfillment time. Required when `fulfillmentTimesType` is `TIME_WINDOWS`. */
|
|
355
415
|
timeWindowsOptions?: TimeDuration;
|
|
416
|
+
/**
|
|
417
|
+
* Type of the fulfillment times.<br />
|
|
418
|
+
* When `TIME_WINDOWS`, `timeWindowsOptions` is a required field.
|
|
419
|
+
* @internal
|
|
420
|
+
* @deprecated
|
|
421
|
+
* @replacedBy type
|
|
422
|
+
* @targetRemovalDate 2023-11-11
|
|
423
|
+
*/
|
|
424
|
+
fulfillmentTimesType?: FulfillmentTimesTypeWithLiterals;
|
|
356
425
|
/**
|
|
357
426
|
* Type of the fulfillment times. <br />
|
|
358
427
|
* When `TIME_WINDOWS`, `timeWindowsOptions` is a required field.
|
|
@@ -438,7 +507,12 @@ declare enum FulfillmentType {
|
|
|
438
507
|
/** Pickup fulfillment. The customer picks up the order from the restaurant. */
|
|
439
508
|
PICKUP = "PICKUP",
|
|
440
509
|
/** Delivery fulfillment. The restaurant, or a representative, delivers the order to the customer. */
|
|
441
|
-
DELIVERY = "DELIVERY"
|
|
510
|
+
DELIVERY = "DELIVERY",
|
|
511
|
+
/**
|
|
512
|
+
* Dine-in fulfillment. The customer places an order and enjoys it at the venue.
|
|
513
|
+
* @internal
|
|
514
|
+
*/
|
|
515
|
+
DINE_IN = "DINE_IN"
|
|
442
516
|
}
|
|
443
517
|
/** @enumType */
|
|
444
518
|
type FulfillmentTypeWithLiterals = FulfillmentType | 'PICKUP' | 'DELIVERY';
|
|
@@ -476,6 +550,11 @@ interface AsapOrderScheduling extends AsapOrderSchedulingAsapFutureHandlingOptio
|
|
|
476
550
|
* When this value is `BUSINESS_DAYS_AHEAD_HANDLING`, `businessDaysAheadHandlingOptions` is a required field.
|
|
477
551
|
*/
|
|
478
552
|
asapFutureHandlingType?: AsapFutureHandlingTypeWithLiterals;
|
|
553
|
+
/**
|
|
554
|
+
* ASAP pacing configuration
|
|
555
|
+
* @internal
|
|
556
|
+
*/
|
|
557
|
+
orderPacing?: AsapOrderPacing;
|
|
479
558
|
}
|
|
480
559
|
/** @oneof */
|
|
481
560
|
interface AsapOrderSchedulingAsapFutureHandlingOptionsOneOf {
|
|
@@ -700,8 +779,18 @@ interface DomainEventBodyOneOf {
|
|
|
700
779
|
}
|
|
701
780
|
interface EntityCreatedEvent {
|
|
702
781
|
entityAsJson?: string;
|
|
782
|
+
/**
|
|
783
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
784
|
+
* @internal
|
|
785
|
+
*/
|
|
786
|
+
triggeredByUndelete?: boolean | null;
|
|
703
787
|
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
704
788
|
restoreInfo?: RestoreInfo;
|
|
789
|
+
/**
|
|
790
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
791
|
+
* @internal
|
|
792
|
+
*/
|
|
793
|
+
additionalMetadataAsJson?: string | null;
|
|
705
794
|
}
|
|
706
795
|
interface RestoreInfo {
|
|
707
796
|
deletedDate?: Date | null;
|
|
@@ -713,10 +802,42 @@ interface EntityUpdatedEvent {
|
|
|
713
802
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
714
803
|
*/
|
|
715
804
|
currentEntityAsJson?: string;
|
|
805
|
+
/**
|
|
806
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
807
|
+
* wont populate it / have any reference to it in the API.
|
|
808
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
809
|
+
* the developer should send only the new (current) entity.
|
|
810
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
811
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
812
|
+
* @internal
|
|
813
|
+
* @deprecated
|
|
814
|
+
*/
|
|
815
|
+
previousEntityAsJson?: string | null;
|
|
816
|
+
/**
|
|
817
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
818
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
819
|
+
* @internal
|
|
820
|
+
*/
|
|
821
|
+
modifiedFields?: Record<string, any>;
|
|
822
|
+
/**
|
|
823
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
824
|
+
* @internal
|
|
825
|
+
*/
|
|
826
|
+
additionalMetadataAsJson?: string | null;
|
|
716
827
|
}
|
|
717
828
|
interface EntityDeletedEvent {
|
|
829
|
+
/**
|
|
830
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
831
|
+
* @internal
|
|
832
|
+
*/
|
|
833
|
+
movedToTrash?: boolean | null;
|
|
718
834
|
/** Entity that was deleted. */
|
|
719
835
|
deletedEntityAsJson?: string | null;
|
|
836
|
+
/**
|
|
837
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
838
|
+
* @internal
|
|
839
|
+
*/
|
|
840
|
+
additionalMetadataAsJson?: string | null;
|
|
720
841
|
}
|
|
721
842
|
interface ActionEvent {
|
|
722
843
|
bodyAsJson?: string;
|
|
@@ -1000,6 +1121,11 @@ interface GetOperationResponse {
|
|
|
1000
1121
|
interface UpdateOperationRequest {
|
|
1001
1122
|
/** Operation to update. */
|
|
1002
1123
|
operation: Operation;
|
|
1124
|
+
/**
|
|
1125
|
+
* Field mask of the fields to update.
|
|
1126
|
+
* @internal
|
|
1127
|
+
*/
|
|
1128
|
+
mask?: string[];
|
|
1003
1129
|
}
|
|
1004
1130
|
interface UpdateOperationResponse {
|
|
1005
1131
|
/** Updated operation. */
|
|
@@ -1214,6 +1340,16 @@ interface Subdivision {
|
|
|
1214
1340
|
code?: string;
|
|
1215
1341
|
/** Subdivision full name. */
|
|
1216
1342
|
name?: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Subdivision level
|
|
1345
|
+
* @internal
|
|
1346
|
+
*/
|
|
1347
|
+
type?: SubdivisionTypeWithLiterals;
|
|
1348
|
+
/**
|
|
1349
|
+
* Free text description of subdivision type.
|
|
1350
|
+
* @internal
|
|
1351
|
+
*/
|
|
1352
|
+
typeInfo?: string | null;
|
|
1217
1353
|
}
|
|
1218
1354
|
declare enum SubdivisionType {
|
|
1219
1355
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
@@ -1440,6 +1576,13 @@ interface FulfillmentTimeSlot {
|
|
|
1440
1576
|
startTime?: Date | null;
|
|
1441
1577
|
/** End time and date of the time slot. */
|
|
1442
1578
|
endTime?: Date | null;
|
|
1579
|
+
/**
|
|
1580
|
+
* Status of the time slot.
|
|
1581
|
+
* @internal
|
|
1582
|
+
*/
|
|
1583
|
+
timeSlotStatus?: TimeSlotStatusWithLiterals;
|
|
1584
|
+
/** @internal */
|
|
1585
|
+
includedDelayInMinutes?: number | null;
|
|
1443
1586
|
/** Type of the fulfillment. */
|
|
1444
1587
|
fulfilmentType?: FulfillmentTypeWithLiterals;
|
|
1445
1588
|
/** Whether the time slot starts now. */
|
|
@@ -1526,6 +1669,11 @@ interface CalculateFirstAvailableTimeSlotPerFulfillmentTypeResponse {
|
|
|
1526
1669
|
interface TimeSlotForFulfillment {
|
|
1527
1670
|
/** Time Slot details. */
|
|
1528
1671
|
timeSlot?: TimeSlot;
|
|
1672
|
+
/**
|
|
1673
|
+
* Status of the time slot.
|
|
1674
|
+
* @internal
|
|
1675
|
+
*/
|
|
1676
|
+
timeSlotStatus?: TimeSlotForFulfillmentTimeSlotStatusWithLiterals;
|
|
1529
1677
|
/**
|
|
1530
1678
|
* Details for each available fulfillment option in the time slot.
|
|
1531
1679
|
* @maxSize 500
|
|
@@ -1541,6 +1689,11 @@ interface TimeSlot {
|
|
|
1541
1689
|
endTime?: Date | null;
|
|
1542
1690
|
/** Order scheduling type used by the operation. */
|
|
1543
1691
|
orderSchedulingType?: OrderSchedulingTypeWithLiterals;
|
|
1692
|
+
/**
|
|
1693
|
+
* Delay in minutes from the original time slot. Only applicable for `ASAP` orders.
|
|
1694
|
+
* @internal
|
|
1695
|
+
*/
|
|
1696
|
+
includedDelayInMinutes?: number | null;
|
|
1544
1697
|
}
|
|
1545
1698
|
declare enum OrderSchedulingType {
|
|
1546
1699
|
/** Immediate ordering. */
|
|
@@ -1759,6 +1912,13 @@ interface PagingMetadata {
|
|
|
1759
1912
|
total?: number | null;
|
|
1760
1913
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1761
1914
|
tooManyToCount?: boolean | null;
|
|
1915
|
+
/**
|
|
1916
|
+
* Indicates if there are more results after the current page.
|
|
1917
|
+
* If `true`, another page of results can be retrieved.
|
|
1918
|
+
* If `false`, this is the last page.
|
|
1919
|
+
* @internal
|
|
1920
|
+
*/
|
|
1921
|
+
hasNext?: boolean | null;
|
|
1762
1922
|
}
|
|
1763
1923
|
interface CalculateFirstAvailableTimeSlotsForItemRequest {
|
|
1764
1924
|
/** @format GUID */
|
|
@@ -1849,6 +2009,11 @@ interface CalculateAvailableTimeSlotsForDateRequest {
|
|
|
1849
2009
|
deliveryAddress?: CommonAddress;
|
|
1850
2010
|
/** Date and time to get the available time slots for. */
|
|
1851
2011
|
date: _Date;
|
|
2012
|
+
/**
|
|
2013
|
+
* in include in the response blocked timeslot. applicable for Preorder. default is false.
|
|
2014
|
+
* @internal
|
|
2015
|
+
*/
|
|
2016
|
+
includeBlockedTimeslots?: boolean;
|
|
1852
2017
|
}
|
|
1853
2018
|
interface CalculateAvailableTimeSlotsForDateResponse {
|
|
1854
2019
|
/**
|
|
@@ -1094,6 +1094,7 @@ var OnlineOrderingStatusType = /* @__PURE__ */ ((OnlineOrderingStatusType2) => {
|
|
|
1094
1094
|
var FulfillmentType = /* @__PURE__ */ ((FulfillmentType2) => {
|
|
1095
1095
|
FulfillmentType2["PICKUP"] = "PICKUP";
|
|
1096
1096
|
FulfillmentType2["DELIVERY"] = "DELIVERY";
|
|
1097
|
+
FulfillmentType2["DINE_IN"] = "DINE_IN";
|
|
1097
1098
|
return FulfillmentType2;
|
|
1098
1099
|
})(FulfillmentType || {});
|
|
1099
1100
|
var PreparationTimePreparationTimeType = /* @__PURE__ */ ((PreparationTimePreparationTimeType2) => {
|