@wix/auto_sdk_restaurants_operations 1.0.0
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.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.context.d.ts +32 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.context.js +54 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.context.js.map +1 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.http.d.ts +72 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.http.js +682 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.http.js.map +1 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.meta.d.ts +40 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.meta.js +256 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.meta.js.map +1 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.public.d.ts +144 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.public.js +148 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.public.js.map +1 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.types.d.ts +1614 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.types.js +190 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.types.js.map +1 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.universal.d.ts +2091 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.universal.js +848 -0
- package/build/cjs/src/restaurants-operations-v1-operation-operations.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.context.d.ts +32 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.context.js +32 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.context.js.map +1 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.http.d.ts +72 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.http.js +667 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.http.js.map +1 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.meta.d.ts +40 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.meta.js +218 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.meta.js.map +1 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.public.d.ts +144 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.public.js +114 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.public.js.map +1 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.types.d.ts +1614 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.types.js +187 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.types.js.map +1 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.universal.d.ts +2091 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.universal.js +810 -0
- package/build/es/src/restaurants-operations-v1-operation-operations.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.context.d.ts +32 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.context.js +54 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.context.js.map +1 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.http.d.ts +72 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.http.js +682 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.http.js.map +1 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.meta.d.ts +40 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.meta.js +256 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.meta.js.map +1 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.public.d.ts +144 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.public.js +148 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.public.js.map +1 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.types.d.ts +1614 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.types.js +190 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.types.js.map +1 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.universal.d.ts +2091 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.universal.js +848 -0
- package/build/internal/cjs/src/restaurants-operations-v1-operation-operations.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.context.d.ts +32 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.context.js +32 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.context.js.map +1 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.http.d.ts +72 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.http.js +667 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.http.js.map +1 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.meta.d.ts +40 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.meta.js +218 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.meta.js.map +1 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.public.d.ts +144 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.public.js +114 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.public.js.map +1 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.types.d.ts +1614 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.types.js +187 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.types.js.map +1 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.universal.d.ts +2091 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.universal.js +810 -0
- package/build/internal/es/src/restaurants-operations-v1-operation-operations.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,2091 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An operation is a service a restaurant offers that includes various aspects of its online ordering.
|
|
3
|
+
* You can define default fulfillments, service fees, and scheduling requirements for each operation.
|
|
4
|
+
*/
|
|
5
|
+
export interface Operation extends OperationOnlineOrderingStatusOptionsOneOf {
|
|
6
|
+
/** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */
|
|
7
|
+
pausedUntilOptions?: OnlineOrderingPausedUntilOptions;
|
|
8
|
+
/**
|
|
9
|
+
* Operation ID.
|
|
10
|
+
* @readonly
|
|
11
|
+
*/
|
|
12
|
+
_id?: string | null;
|
|
13
|
+
/**
|
|
14
|
+
* Revision number. Increments by 1 each time the operation is updated.
|
|
15
|
+
* To prevent conflicting changes,
|
|
16
|
+
* the existing `revision` must be specified when updating an operation.
|
|
17
|
+
* @readonly
|
|
18
|
+
*/
|
|
19
|
+
revision?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* Date and time the operation was created.
|
|
22
|
+
* @readonly
|
|
23
|
+
*/
|
|
24
|
+
_createdDate?: Date | null;
|
|
25
|
+
/**
|
|
26
|
+
* Date and time the operation was updated.
|
|
27
|
+
* @readonly
|
|
28
|
+
*/
|
|
29
|
+
_updatedDate?: Date | null;
|
|
30
|
+
/** Operation name. */
|
|
31
|
+
name?: string | null;
|
|
32
|
+
/**
|
|
33
|
+
* Whether the operation is the default operation. <br />
|
|
34
|
+
* Default: `false`.
|
|
35
|
+
*/
|
|
36
|
+
default?: boolean | null;
|
|
37
|
+
/** IDs of the fulfillment methods ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/fulfillment-methods/introduction) | [REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/fulfillment-methods/introduction)) associated with the operation. */
|
|
38
|
+
fulfillmentIds?: string[] | null;
|
|
39
|
+
/** Online ordering status of the operation. <br /> */
|
|
40
|
+
onlineOrderingStatus?: OnlineOrderingStatusType;
|
|
41
|
+
/**
|
|
42
|
+
* IDs of the service fee rules ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/service-fees/introduction) | [REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/introduction)) associated with the operation.
|
|
43
|
+
* @deprecated
|
|
44
|
+
* @targetRemovalDate 2024-11-30
|
|
45
|
+
*/
|
|
46
|
+
serviceFeeRuleIds?: string[] | null;
|
|
47
|
+
/** Default fulfillment type of the operation. */
|
|
48
|
+
defaultFulfillmentType?: FulfillmentType;
|
|
49
|
+
/** Information about when an order can be placed for. */
|
|
50
|
+
orderScheduling?: OrderScheduling;
|
|
51
|
+
}
|
|
52
|
+
/** @oneof */
|
|
53
|
+
export interface OperationOnlineOrderingStatusOptionsOneOf {
|
|
54
|
+
/** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */
|
|
55
|
+
pausedUntilOptions?: OnlineOrderingPausedUntilOptions;
|
|
56
|
+
}
|
|
57
|
+
/** Information about when an order can be placed for. */
|
|
58
|
+
export interface Scheduling extends SchedulingSchedulingOptionsOneOf {
|
|
59
|
+
/** Options for scheduling. Required when `type` is `ASAP`. */
|
|
60
|
+
asapOptions?: AsapScheduling;
|
|
61
|
+
/** Options for scheduling. Required when `type` is `PREORDER`. */
|
|
62
|
+
preorderOptions?: PreorderScheduling;
|
|
63
|
+
/**
|
|
64
|
+
* Scheduling type. <br />
|
|
65
|
+
* - When `ASAP`, `asapOptions` is a required field.
|
|
66
|
+
* - When `PREORDER`, `preorderOptions` is a required field.
|
|
67
|
+
*/
|
|
68
|
+
type?: SchedulingType;
|
|
69
|
+
}
|
|
70
|
+
/** @oneof */
|
|
71
|
+
export interface SchedulingSchedulingOptionsOneOf {
|
|
72
|
+
/** Options for scheduling. Required when `type` is `ASAP`. */
|
|
73
|
+
asapOptions?: AsapScheduling;
|
|
74
|
+
/** Options for scheduling. Required when `type` is `PREORDER`. */
|
|
75
|
+
preorderOptions?: PreorderScheduling;
|
|
76
|
+
}
|
|
77
|
+
/** Scheduling type enum. */
|
|
78
|
+
export declare enum SchedulingType {
|
|
79
|
+
/** Unknown scheduling type. */
|
|
80
|
+
UNKNOWN_SCHEDULING = "UNKNOWN_SCHEDULING",
|
|
81
|
+
/** Orders can be scheduled for the future and to be handled immediately. */
|
|
82
|
+
ASAP = "ASAP",
|
|
83
|
+
/** Orders can be scheduled only for the future. */
|
|
84
|
+
PREORDER = "PREORDER"
|
|
85
|
+
}
|
|
86
|
+
/** Options for scheduling. Required if `type` is `ASAP`. */
|
|
87
|
+
export interface AsapScheduling extends AsapSchedulingPreparationTimeOneOf, AsapSchedulingAsapPreorderOneOf {
|
|
88
|
+
/** Options for preparation time. Required when `type` is `MAX_TIME`. */
|
|
89
|
+
maxOptions?: TimeDuration;
|
|
90
|
+
/** Options for preparation time. Required when `type` is `TIME_RANGE`. */
|
|
91
|
+
rangeOptions?: TimeDurationRange;
|
|
92
|
+
/** Information for when orders must be made a set number of business days in advance. */
|
|
93
|
+
businessDaysPreorderOptions?: BusinessDaysPreorder;
|
|
94
|
+
/** How to define the time needed to prepare an order. */
|
|
95
|
+
type?: PreparationTimeType;
|
|
96
|
+
/**
|
|
97
|
+
* Indication of whether it is possible to place an order for a later time on the same day.
|
|
98
|
+
* @deprecated Indication of whether it is possible to place an order for a later time on the same day.
|
|
99
|
+
* @replacedBy asap_preorder_type
|
|
100
|
+
* @targetRemovalDate 2023-12-28
|
|
101
|
+
*/
|
|
102
|
+
allowSameDayPreorder?: boolean | null;
|
|
103
|
+
/** The type of preorder allowed for the ASAP scheduling. */
|
|
104
|
+
asapPreorderType?: AsapPreorderType;
|
|
105
|
+
}
|
|
106
|
+
/** @oneof */
|
|
107
|
+
export interface AsapSchedulingPreparationTimeOneOf {
|
|
108
|
+
/** Options for preparation time. Required when `type` is `MAX_TIME`. */
|
|
109
|
+
maxOptions?: TimeDuration;
|
|
110
|
+
/** Options for preparation time. Required when `type` is `TIME_RANGE`. */
|
|
111
|
+
rangeOptions?: TimeDurationRange;
|
|
112
|
+
}
|
|
113
|
+
/** @oneof */
|
|
114
|
+
export interface AsapSchedulingAsapPreorderOneOf {
|
|
115
|
+
/** Information for when orders must be made a set number of business days in advance. */
|
|
116
|
+
businessDaysPreorderOptions?: BusinessDaysPreorder;
|
|
117
|
+
}
|
|
118
|
+
/** Preparation time type enum. */
|
|
119
|
+
export declare enum PreparationTimeType {
|
|
120
|
+
/** Unknown preparation time type. */
|
|
121
|
+
UNKNOWN_PREPARATION_TIME = "UNKNOWN_PREPARATION_TIME",
|
|
122
|
+
/** Preparation time that is bounded by a maximum time. */
|
|
123
|
+
MAX = "MAX",
|
|
124
|
+
/** Preparation time that is bounded by a range of times. */
|
|
125
|
+
RANGE = "RANGE"
|
|
126
|
+
}
|
|
127
|
+
/** Time duration. */
|
|
128
|
+
export interface TimeDuration {
|
|
129
|
+
/** Unit of time for the duration. */
|
|
130
|
+
timeUnit?: TimeUnit;
|
|
131
|
+
/** Duration value. Unit of time specified in `timeUnit`. */
|
|
132
|
+
duration?: number | null;
|
|
133
|
+
}
|
|
134
|
+
/** Time unit enum. */
|
|
135
|
+
export declare enum TimeUnit {
|
|
136
|
+
/** Unknown time unit. */
|
|
137
|
+
UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
|
|
138
|
+
/** Minutes time unit. */
|
|
139
|
+
MINUTES = "MINUTES",
|
|
140
|
+
/** Hours time unit. */
|
|
141
|
+
HOURS = "HOURS",
|
|
142
|
+
/** Days time unit. */
|
|
143
|
+
DAYS = "DAYS"
|
|
144
|
+
}
|
|
145
|
+
/** Time range for preparation. */
|
|
146
|
+
export interface TimeDurationRange {
|
|
147
|
+
/** Time unit for the time range. */
|
|
148
|
+
timeUnit?: TimeUnit;
|
|
149
|
+
/** Minimum duration value. Unit of time specified in `timeUnit`. */
|
|
150
|
+
minDuration?: number | null;
|
|
151
|
+
/** Maximum duration value. Unit of time specified in `timeUnit`. */
|
|
152
|
+
maxDuration?: number | null;
|
|
153
|
+
}
|
|
154
|
+
/** Asap preorder type enum. */
|
|
155
|
+
export declare enum AsapPreorderType {
|
|
156
|
+
/** Unknown ASAP preorder type. */
|
|
157
|
+
UNKNOWN_ASAP_PREORDER = "UNKNOWN_ASAP_PREORDER",
|
|
158
|
+
/** Doesn't allow preorder. */
|
|
159
|
+
NO_PREORDER = "NO_PREORDER",
|
|
160
|
+
/** Allows preorder for a maximum specified number of business days in advance. */
|
|
161
|
+
BUSINESS_DAYS_PREORDER = "BUSINESS_DAYS_PREORDER"
|
|
162
|
+
}
|
|
163
|
+
/** Information for when orders must be made a set number of business days in advance. */
|
|
164
|
+
export interface BusinessDaysPreorder {
|
|
165
|
+
/**
|
|
166
|
+
* Maximum number of business days an order can be scheduled in advance.
|
|
167
|
+
*
|
|
168
|
+
* When `0`, an order can be scheduled only until the end of the current business day.
|
|
169
|
+
* For any other value, the order can be scheduled for the end of the business day in that many days.
|
|
170
|
+
* For example, `5` means the order can be scheduled for any time before the end of the 5th business day from today (where today is "day 0").
|
|
171
|
+
*/
|
|
172
|
+
businessDays?: number | null;
|
|
173
|
+
}
|
|
174
|
+
/** Information about preorders. */
|
|
175
|
+
export interface PreorderScheduling {
|
|
176
|
+
method?: PreorderMethod;
|
|
177
|
+
/**
|
|
178
|
+
* Configuration of the fulfillment times. <br />
|
|
179
|
+
* Currently, only `TIME_WINDOWS` is supported.
|
|
180
|
+
*/
|
|
181
|
+
fulfillmentTimesDisplay?: FulfillmentTimesDisplayConfig;
|
|
182
|
+
}
|
|
183
|
+
/** Method for `PREORDER` scheduling type. */
|
|
184
|
+
export interface PreorderMethod extends PreorderMethodMethodOptionsOneOf {
|
|
185
|
+
/** Options for the method. Required when `type` is `TIME_BOUNDED`. */
|
|
186
|
+
timeBoundedOptions?: TimeBounded;
|
|
187
|
+
/** Options for the method. Required when `type` is `WEEKLY_SCHEDULE`. */
|
|
188
|
+
weeklyScheduleOptions?: WeeklySchedule;
|
|
189
|
+
/**
|
|
190
|
+
* Type of time frame for how long in advance preorders can be made. <br />
|
|
191
|
+
* - When `TIME_BOUNDED`, `timeBoundedOptions` is a required field.
|
|
192
|
+
* - When `WEEKLY_SCHEDULE`, `weeklyScheduleOptions` is a required field.
|
|
193
|
+
*/
|
|
194
|
+
type?: MethodType;
|
|
195
|
+
}
|
|
196
|
+
/** @oneof */
|
|
197
|
+
export interface PreorderMethodMethodOptionsOneOf {
|
|
198
|
+
/** Options for the method. Required when `type` is `TIME_BOUNDED`. */
|
|
199
|
+
timeBoundedOptions?: TimeBounded;
|
|
200
|
+
/** Options for the method. Required when `type` is `WEEKLY_SCHEDULE`. */
|
|
201
|
+
weeklyScheduleOptions?: WeeklySchedule;
|
|
202
|
+
}
|
|
203
|
+
/** Day of the week and time of the day. */
|
|
204
|
+
export interface DayAndTime {
|
|
205
|
+
/** Day of the week. */
|
|
206
|
+
dayOfWeek?: EntitiesDayOfWeek;
|
|
207
|
+
/** Time of the day. */
|
|
208
|
+
timeOfDay?: TimeOfDay;
|
|
209
|
+
}
|
|
210
|
+
export declare enum EntitiesDayOfWeek {
|
|
211
|
+
/** Monday. */
|
|
212
|
+
MON = "MON",
|
|
213
|
+
/** Tuesday. */
|
|
214
|
+
TUE = "TUE",
|
|
215
|
+
/** Wednesday. */
|
|
216
|
+
WED = "WED",
|
|
217
|
+
/** Thursday. */
|
|
218
|
+
THU = "THU",
|
|
219
|
+
/** Friday. */
|
|
220
|
+
FRI = "FRI",
|
|
221
|
+
/** Saturday. */
|
|
222
|
+
SAT = "SAT",
|
|
223
|
+
/** Sunday. */
|
|
224
|
+
SUN = "SUN"
|
|
225
|
+
}
|
|
226
|
+
export interface TimeOfDay {
|
|
227
|
+
/**
|
|
228
|
+
* Hours. <br />
|
|
229
|
+
* Min: `0`. <br />
|
|
230
|
+
* Max: `23`.
|
|
231
|
+
*/
|
|
232
|
+
hours?: number;
|
|
233
|
+
/**
|
|
234
|
+
* Minutes. <br />
|
|
235
|
+
* Min: `0`. <br />
|
|
236
|
+
* Max: `23`.
|
|
237
|
+
*/
|
|
238
|
+
minutes?: number;
|
|
239
|
+
}
|
|
240
|
+
/** Preorder method type enum. */
|
|
241
|
+
export declare enum MethodType {
|
|
242
|
+
/** Unknown preorder method type. */
|
|
243
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
244
|
+
/** Preorder time has a minimum and a maximum. */
|
|
245
|
+
TIME_BOUNDED = "TIME_BOUNDED",
|
|
246
|
+
/** Preorders have a weekly schedule with a weekly cutoff time. */
|
|
247
|
+
WEEKLY_SCHEDULE = "WEEKLY_SCHEDULE"
|
|
248
|
+
}
|
|
249
|
+
/** Information about the time range when preorders are time bounded. */
|
|
250
|
+
export interface TimeBounded {
|
|
251
|
+
/** Minimum time required to schedule the order. */
|
|
252
|
+
minTimeInAdvance?: TimeDuration;
|
|
253
|
+
/** Maximum time allowed to schedule the order. */
|
|
254
|
+
maxTimeInAdvance?: TimeDuration;
|
|
255
|
+
}
|
|
256
|
+
/** Options for the method. Required when `type` is `WEEKLY_SCHEDULE`. */
|
|
257
|
+
export interface WeeklySchedule {
|
|
258
|
+
/**
|
|
259
|
+
* The weekly schedule cutoff time. <br />
|
|
260
|
+
* Orders placed before the cutoff time are scheduled for the current week. <br />
|
|
261
|
+
* Orders placed after the cutoff time are scheduled for the next week.
|
|
262
|
+
*/
|
|
263
|
+
cutOffTime?: DayAndTime;
|
|
264
|
+
}
|
|
265
|
+
/** Way by which fulfillment times should be displayed. */
|
|
266
|
+
export interface FulfillmentTimesDisplayConfig extends FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {
|
|
267
|
+
/** Options for fulfillment time. Required when `fulfillmentTimesType` is `TIME_WINDOWS`. */
|
|
268
|
+
timeWindowsOptions?: TimeDuration;
|
|
269
|
+
/**
|
|
270
|
+
* Type of the fulfillment times. <br />
|
|
271
|
+
* When `TIME_WINDOWS`, `timeWindowsOptions` is a required field.
|
|
272
|
+
*/
|
|
273
|
+
type?: FulfillmentTimesType;
|
|
274
|
+
}
|
|
275
|
+
/** @oneof */
|
|
276
|
+
export interface FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {
|
|
277
|
+
/** Options for fulfillment time. Required when `fulfillmentTimesType` is `TIME_WINDOWS`. */
|
|
278
|
+
timeWindowsOptions?: TimeDuration;
|
|
279
|
+
}
|
|
280
|
+
/** The fulfillment times type enum. */
|
|
281
|
+
export declare enum FulfillmentTimesType {
|
|
282
|
+
/** Unknown fulfillment times type. */
|
|
283
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
284
|
+
/** Display fulfillment times as time windows. */
|
|
285
|
+
TIME_WINDOWS = "TIME_WINDOWS"
|
|
286
|
+
}
|
|
287
|
+
/** Online ordering status enum. */
|
|
288
|
+
export declare enum OnlineOrderingStatusType {
|
|
289
|
+
/** Online ordering status is not defined. */
|
|
290
|
+
UNDEFINED_ONLINE_ORDERING_STATUS = "UNDEFINED_ONLINE_ORDERING_STATUS",
|
|
291
|
+
/** Operation currently accepts online orders. */
|
|
292
|
+
ENABLED = "ENABLED",
|
|
293
|
+
/** Operation currently does not accept online orders. */
|
|
294
|
+
DISABLED = "DISABLED",
|
|
295
|
+
/** Operation currently does not accept online orders, but will accept online orders from a specified time and date. When applied, `pausedUntilOptions` is a required field. */
|
|
296
|
+
PAUSED_UNTIL = "PAUSED_UNTIL"
|
|
297
|
+
}
|
|
298
|
+
/** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */
|
|
299
|
+
export interface OnlineOrderingPausedUntilOptions {
|
|
300
|
+
/**
|
|
301
|
+
* Date and time until which online ordering is paused. <br />
|
|
302
|
+
*
|
|
303
|
+
* Before the specified time, behavior is the same as when `onlineOrderingStatus` is `DISABLED`. <br />
|
|
304
|
+
*
|
|
305
|
+
* After the specified time, behavior is the same as when `onlineOrderingStatus` is `ENABLED`. <br />
|
|
306
|
+
*
|
|
307
|
+
* Passing the time does not trigger any changes to value of any properties.
|
|
308
|
+
*/
|
|
309
|
+
time?: Date | null;
|
|
310
|
+
}
|
|
311
|
+
/** Fulfillment type enum. */
|
|
312
|
+
export declare enum FulfillmentType {
|
|
313
|
+
/** Undefined fulfillment type. */
|
|
314
|
+
UNDEFINED_FULFILLMENT_TYPE = "UNDEFINED_FULFILLMENT_TYPE",
|
|
315
|
+
/** Pickup fulfillment. */
|
|
316
|
+
PICKUP = "PICKUP",
|
|
317
|
+
/** Delivery fulfillment. */
|
|
318
|
+
DELIVERY = "DELIVERY"
|
|
319
|
+
}
|
|
320
|
+
/** Information about when an order can be placed for. */
|
|
321
|
+
export interface OrderScheduling extends OrderSchedulingOrderSchedulingOptionsOneOf {
|
|
322
|
+
/** Options for scheduling. Required if `type` is `ASAP`. */
|
|
323
|
+
asapOptions?: AsapOrderScheduling;
|
|
324
|
+
/** Options for scheduling. Required if `type` is `PREORDER`. */
|
|
325
|
+
preorderOptions?: PreorderScheduling;
|
|
326
|
+
/**
|
|
327
|
+
* Scheduling type. <br />
|
|
328
|
+
* - When `ASAP`, `asapOptions` is a required field.
|
|
329
|
+
* - When `PREORDER`, `preorderOptions` is a required field.
|
|
330
|
+
*/
|
|
331
|
+
type?: SchedulingType;
|
|
332
|
+
}
|
|
333
|
+
/** @oneof */
|
|
334
|
+
export interface OrderSchedulingOrderSchedulingOptionsOneOf {
|
|
335
|
+
/** Options for scheduling. Required if `type` is `ASAP`. */
|
|
336
|
+
asapOptions?: AsapOrderScheduling;
|
|
337
|
+
/** Options for scheduling. Required if `type` is `PREORDER`. */
|
|
338
|
+
preorderOptions?: PreorderScheduling;
|
|
339
|
+
}
|
|
340
|
+
export interface AsapOrderScheduling extends AsapOrderSchedulingAsapFutureHandlingOptionsOneOf {
|
|
341
|
+
/** Options for future handling. Required when `asapFutureHandlingType` is `BUSINESS_DAYS_AHEAD_HANDLING`. */
|
|
342
|
+
businessDaysAheadHandlingOptions?: BusinessDaysAheadHandling;
|
|
343
|
+
/**
|
|
344
|
+
* Amount of time needed to prepare the order. <br />
|
|
345
|
+
* - When `MAX_TIME`, `maxTimeOptions` is a required field.
|
|
346
|
+
* - When `MAX_RANGE`, `timeRangeOptions` is a required field.
|
|
347
|
+
*/
|
|
348
|
+
preparationTime?: PreparationTime;
|
|
349
|
+
/**
|
|
350
|
+
* Defines if and how non-immediate orders should be handled. <br />
|
|
351
|
+
* When this value is `BUSINESS_DAYS_AHEAD_HANDLING`, `businessDaysAheadHandlingOptions` is a required field.
|
|
352
|
+
*/
|
|
353
|
+
asapFutureHandlingType?: AsapFutureHandlingType;
|
|
354
|
+
}
|
|
355
|
+
/** @oneof */
|
|
356
|
+
export interface AsapOrderSchedulingAsapFutureHandlingOptionsOneOf {
|
|
357
|
+
/** Options for future handling. Required when `asapFutureHandlingType` is `BUSINESS_DAYS_AHEAD_HANDLING`. */
|
|
358
|
+
businessDaysAheadHandlingOptions?: BusinessDaysAheadHandling;
|
|
359
|
+
}
|
|
360
|
+
export interface PreparationTime extends PreparationTimeTimeSpecificationOneOf {
|
|
361
|
+
/** Options for preparation time. Required when `type` is `MAX_TIME`. */
|
|
362
|
+
maxTimeOptions?: TimeDuration;
|
|
363
|
+
/** Options for preparation time. Required when `type` is `TIME_RANGE`. */
|
|
364
|
+
timeRangeOptions?: TimeDurationRange;
|
|
365
|
+
/** Preparation time type. */
|
|
366
|
+
type?: PreparationTimePreparationTimeType;
|
|
367
|
+
}
|
|
368
|
+
/** @oneof */
|
|
369
|
+
export interface PreparationTimeTimeSpecificationOneOf {
|
|
370
|
+
/** Options for preparation time. Required when `type` is `MAX_TIME`. */
|
|
371
|
+
maxTimeOptions?: TimeDuration;
|
|
372
|
+
/** Options for preparation time. Required when `type` is `TIME_RANGE`. */
|
|
373
|
+
timeRangeOptions?: TimeDurationRange;
|
|
374
|
+
}
|
|
375
|
+
/** Preparation time type enum. */
|
|
376
|
+
export declare enum PreparationTimePreparationTimeType {
|
|
377
|
+
UNKNOWN_PREPARATION_TIME = "UNKNOWN_PREPARATION_TIME",
|
|
378
|
+
MAX_TIME = "MAX_TIME",
|
|
379
|
+
TIME_RANGE = "TIME_RANGE"
|
|
380
|
+
}
|
|
381
|
+
export declare enum AsapFutureHandlingType {
|
|
382
|
+
/** Unknown asap future handling type. */
|
|
383
|
+
UNKNOWN_ASAP_FUTURE_HANDLING = "UNKNOWN_ASAP_FUTURE_HANDLING",
|
|
384
|
+
/** No future handling. */
|
|
385
|
+
NO_FUTURE_HANDLING = "NO_FUTURE_HANDLING",
|
|
386
|
+
/** Allows future orders for up to a specified number of business days ahead. */
|
|
387
|
+
BUSINESS_DAYS_AHEAD_HANDLING = "BUSINESS_DAYS_AHEAD_HANDLING"
|
|
388
|
+
}
|
|
389
|
+
export interface BusinessDaysAheadHandling {
|
|
390
|
+
/**
|
|
391
|
+
* Number of business days ahead for which orders can be scheduled. <br />
|
|
392
|
+
* Setting the `daysCount` to 0 means that orders can be scheduled until the end of the current business day.
|
|
393
|
+
*/
|
|
394
|
+
daysCount?: number | null;
|
|
395
|
+
}
|
|
396
|
+
export interface BusinessLocationDetails {
|
|
397
|
+
}
|
|
398
|
+
export interface V1Address {
|
|
399
|
+
/** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
400
|
+
country?: string | null;
|
|
401
|
+
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
|
|
402
|
+
subdivision?: string | null;
|
|
403
|
+
/** City name. */
|
|
404
|
+
city?: string | null;
|
|
405
|
+
/** Postal or zip code. */
|
|
406
|
+
postalCode?: string | null;
|
|
407
|
+
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
408
|
+
streetAddress?: V1StreetAddress;
|
|
409
|
+
/** Full address of the location. */
|
|
410
|
+
formatted?: string | null;
|
|
411
|
+
/** Geographic coordinates of location. */
|
|
412
|
+
location?: V1AddressLocation;
|
|
413
|
+
}
|
|
414
|
+
/** Street address. Includes street name, number, and apartment number in separate fields. */
|
|
415
|
+
export interface V1StreetAddress {
|
|
416
|
+
/** Street number. */
|
|
417
|
+
number?: string;
|
|
418
|
+
/** Street name. */
|
|
419
|
+
name?: string;
|
|
420
|
+
/** Apartment number. */
|
|
421
|
+
apt?: string;
|
|
422
|
+
}
|
|
423
|
+
/** Address Geolocation */
|
|
424
|
+
export interface V1AddressLocation {
|
|
425
|
+
/** Latitude of the location. Must be between -90 and 90. */
|
|
426
|
+
latitude?: number | null;
|
|
427
|
+
/** Longitude of the location. Must be between -180 and 180. */
|
|
428
|
+
longitude?: number | null;
|
|
429
|
+
}
|
|
430
|
+
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
431
|
+
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
432
|
+
metaSiteId?: string;
|
|
433
|
+
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
434
|
+
siteId?: string;
|
|
435
|
+
/** Invalidate by App */
|
|
436
|
+
app?: App;
|
|
437
|
+
/** Invalidate by page id */
|
|
438
|
+
page?: Page;
|
|
439
|
+
/** Invalidate by URI path */
|
|
440
|
+
uri?: URI;
|
|
441
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
442
|
+
file?: File;
|
|
443
|
+
/** tell us why you're invalidating the cache. You don't need to add your app name */
|
|
444
|
+
reason?: string | null;
|
|
445
|
+
/** Is local DS */
|
|
446
|
+
localDc?: boolean;
|
|
447
|
+
hardPurge?: boolean;
|
|
448
|
+
}
|
|
449
|
+
/** @oneof */
|
|
450
|
+
export interface InvalidateCacheGetByOneOf {
|
|
451
|
+
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
452
|
+
metaSiteId?: string;
|
|
453
|
+
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
454
|
+
siteId?: string;
|
|
455
|
+
/** Invalidate by App */
|
|
456
|
+
app?: App;
|
|
457
|
+
/** Invalidate by page id */
|
|
458
|
+
page?: Page;
|
|
459
|
+
/** Invalidate by URI path */
|
|
460
|
+
uri?: URI;
|
|
461
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
462
|
+
file?: File;
|
|
463
|
+
}
|
|
464
|
+
export interface App {
|
|
465
|
+
/** The AppDefId */
|
|
466
|
+
appDefId?: string;
|
|
467
|
+
/** The instance Id */
|
|
468
|
+
instanceId?: string;
|
|
469
|
+
}
|
|
470
|
+
export interface Page {
|
|
471
|
+
/** the msid the page is on */
|
|
472
|
+
metaSiteId?: string;
|
|
473
|
+
/** Invalidate by Page ID */
|
|
474
|
+
pageId?: string;
|
|
475
|
+
}
|
|
476
|
+
export interface URI {
|
|
477
|
+
/** the msid the URI is on */
|
|
478
|
+
metaSiteId?: string;
|
|
479
|
+
/** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
|
|
480
|
+
uriPath?: string;
|
|
481
|
+
}
|
|
482
|
+
export interface File {
|
|
483
|
+
/** the msid the file is related to */
|
|
484
|
+
metaSiteId?: string;
|
|
485
|
+
/** Invalidate by filename (for media files such as PDFs) */
|
|
486
|
+
fileName?: string;
|
|
487
|
+
}
|
|
488
|
+
export interface DeliveryProfileConfiguredForOperation {
|
|
489
|
+
/** Operation */
|
|
490
|
+
operation?: Operation;
|
|
491
|
+
}
|
|
492
|
+
export interface OperationsDataCloningCompleted {
|
|
493
|
+
}
|
|
494
|
+
export interface CreateOperationRequest {
|
|
495
|
+
/** Operation to create. */
|
|
496
|
+
operation: Operation;
|
|
497
|
+
}
|
|
498
|
+
export interface CreateOperationResponse {
|
|
499
|
+
/** Created operation. */
|
|
500
|
+
operation?: Operation;
|
|
501
|
+
}
|
|
502
|
+
export interface GetOperationRequest {
|
|
503
|
+
/** ID of the operation to retrieve. */
|
|
504
|
+
operationId: string;
|
|
505
|
+
}
|
|
506
|
+
export interface GetOperationResponse {
|
|
507
|
+
/** Retrieved operation. */
|
|
508
|
+
operation?: Operation;
|
|
509
|
+
}
|
|
510
|
+
export interface UpdateOperationRequest {
|
|
511
|
+
/** Operation to update. */
|
|
512
|
+
operation: Operation;
|
|
513
|
+
}
|
|
514
|
+
export interface UpdateOperationResponse {
|
|
515
|
+
/** Updated operation. */
|
|
516
|
+
operation?: Operation;
|
|
517
|
+
}
|
|
518
|
+
export interface DeleteOperationRequest {
|
|
519
|
+
/** ID of the operation to delete. */
|
|
520
|
+
operationId: string;
|
|
521
|
+
}
|
|
522
|
+
export interface DeleteOperationResponse {
|
|
523
|
+
}
|
|
524
|
+
export interface QueryOperationRequest {
|
|
525
|
+
/** Query options. */
|
|
526
|
+
query: CursorQuery;
|
|
527
|
+
}
|
|
528
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
529
|
+
/** 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`. */
|
|
530
|
+
cursorPaging?: CursorPaging;
|
|
531
|
+
/**
|
|
532
|
+
* Filter object.
|
|
533
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
534
|
+
* for more information.
|
|
535
|
+
*
|
|
536
|
+
* For a detailed list of supported filters, see
|
|
537
|
+
* [Supported Filters](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/operations/operations/supported-filters-and-sorting).
|
|
538
|
+
*/
|
|
539
|
+
filter?: Record<string, any> | null;
|
|
540
|
+
/** Sort object. */
|
|
541
|
+
sort?: Sorting[];
|
|
542
|
+
}
|
|
543
|
+
/** @oneof */
|
|
544
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
545
|
+
/** 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`. */
|
|
546
|
+
cursorPaging?: CursorPaging;
|
|
547
|
+
}
|
|
548
|
+
export interface Sorting {
|
|
549
|
+
/**
|
|
550
|
+
* Supported properties:
|
|
551
|
+
* - `id`
|
|
552
|
+
* - `createdDate`
|
|
553
|
+
* - `updatedDate`
|
|
554
|
+
* - `name`
|
|
555
|
+
*/
|
|
556
|
+
fieldName?: string;
|
|
557
|
+
/**
|
|
558
|
+
* Sort order. Use `ASC` for ascending order or `DESC` for descending order. <br />
|
|
559
|
+
*
|
|
560
|
+
* Default: `ASC`
|
|
561
|
+
*/
|
|
562
|
+
order?: SortOrder;
|
|
563
|
+
}
|
|
564
|
+
export declare enum SortOrder {
|
|
565
|
+
ASC = "ASC",
|
|
566
|
+
DESC = "DESC"
|
|
567
|
+
}
|
|
568
|
+
export interface CursorPaging {
|
|
569
|
+
/** Maximum number of items to return in the results. */
|
|
570
|
+
limit?: number | null;
|
|
571
|
+
/**
|
|
572
|
+
* Pointer to the next or previous page in the list of results.
|
|
573
|
+
*
|
|
574
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
575
|
+
* Not relevant for the first request.
|
|
576
|
+
*/
|
|
577
|
+
cursor?: string | null;
|
|
578
|
+
}
|
|
579
|
+
export interface QueryOperationResponse {
|
|
580
|
+
/** Retrieved operations. */
|
|
581
|
+
operations?: Operation[];
|
|
582
|
+
/** Metadata of the paginated results. */
|
|
583
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
584
|
+
}
|
|
585
|
+
export interface CursorPagingMetadata {
|
|
586
|
+
/** Number of items returned in the response. */
|
|
587
|
+
count?: number | null;
|
|
588
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
589
|
+
cursors?: Cursors;
|
|
590
|
+
/**
|
|
591
|
+
* Whether there are more pages to retrieve following the current page.
|
|
592
|
+
*
|
|
593
|
+
* + `true`: Another page of results can be retrieved.
|
|
594
|
+
* + `false`: This is the last page.
|
|
595
|
+
*/
|
|
596
|
+
hasNext?: boolean | null;
|
|
597
|
+
}
|
|
598
|
+
export interface Cursors {
|
|
599
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
600
|
+
next?: string | null;
|
|
601
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
602
|
+
prev?: string | null;
|
|
603
|
+
}
|
|
604
|
+
export interface ListOperationsRequest {
|
|
605
|
+
}
|
|
606
|
+
export interface ListOperationsResponse {
|
|
607
|
+
/** Retrieved operations. */
|
|
608
|
+
operations?: Operation[];
|
|
609
|
+
}
|
|
610
|
+
export interface ListOperationIdsRequest {
|
|
611
|
+
/** metasite id */
|
|
612
|
+
metasiteId?: string;
|
|
613
|
+
}
|
|
614
|
+
export interface ListOperationIdsResponse {
|
|
615
|
+
/** List of operation ids */
|
|
616
|
+
operationIds?: string[];
|
|
617
|
+
}
|
|
618
|
+
export interface ListOperationsInternalRequest {
|
|
619
|
+
/** metasite id */
|
|
620
|
+
metasiteId?: string;
|
|
621
|
+
}
|
|
622
|
+
export interface ListOperationsInternalResponse {
|
|
623
|
+
/** List of operations */
|
|
624
|
+
operations?: Operation[];
|
|
625
|
+
}
|
|
626
|
+
export interface ListAvailableFulfillmentOptionsRequest {
|
|
627
|
+
/** Operation ID. Returned fulfillment options will belong to this operation. */
|
|
628
|
+
operationId: string;
|
|
629
|
+
/**
|
|
630
|
+
* Delivery address. Optional.
|
|
631
|
+
*
|
|
632
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
633
|
+
*/
|
|
634
|
+
deliveryAddress?: CommonAddress;
|
|
635
|
+
}
|
|
636
|
+
/** Physical address */
|
|
637
|
+
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
638
|
+
/** Street name and number. */
|
|
639
|
+
streetAddress?: StreetAddress;
|
|
640
|
+
/** Main address line, usually street and number as free text. */
|
|
641
|
+
addressLine1?: string | null;
|
|
642
|
+
/** Country code. */
|
|
643
|
+
country?: string | null;
|
|
644
|
+
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
645
|
+
subdivision?: string | null;
|
|
646
|
+
/** City name. */
|
|
647
|
+
city?: string | null;
|
|
648
|
+
/** Zip/postal code. */
|
|
649
|
+
postalCode?: string | null;
|
|
650
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
651
|
+
addressLine2?: string | null;
|
|
652
|
+
}
|
|
653
|
+
/** @oneof */
|
|
654
|
+
export interface CommonAddressStreetOneOf {
|
|
655
|
+
/** Street name and number. */
|
|
656
|
+
streetAddress?: StreetAddress;
|
|
657
|
+
/** Main address line, usually street and number as free text. */
|
|
658
|
+
addressLine?: string | null;
|
|
659
|
+
}
|
|
660
|
+
export interface StreetAddress {
|
|
661
|
+
/** Street number. */
|
|
662
|
+
number?: string;
|
|
663
|
+
/** Street name. */
|
|
664
|
+
name?: string;
|
|
665
|
+
}
|
|
666
|
+
export interface AddressLocation {
|
|
667
|
+
/** Address latitude. */
|
|
668
|
+
latitude?: number | null;
|
|
669
|
+
/** Address longitude. */
|
|
670
|
+
longitude?: number | null;
|
|
671
|
+
}
|
|
672
|
+
export interface Subdivision {
|
|
673
|
+
/** Short subdivision code. */
|
|
674
|
+
code?: string;
|
|
675
|
+
/** Subdivision full name. */
|
|
676
|
+
name?: string;
|
|
677
|
+
}
|
|
678
|
+
export declare enum SubdivisionType {
|
|
679
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
680
|
+
/** State */
|
|
681
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
682
|
+
/** County */
|
|
683
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
684
|
+
/** City/town */
|
|
685
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
686
|
+
/** Neighborhood/quarter */
|
|
687
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
688
|
+
/** Street/block */
|
|
689
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
690
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
691
|
+
COUNTRY = "COUNTRY"
|
|
692
|
+
}
|
|
693
|
+
export interface ListAvailableFulfillmentOptionsResponse {
|
|
694
|
+
/** Whether pickup fulfillment method is configured for the requested operation. */
|
|
695
|
+
pickupConfigured?: boolean;
|
|
696
|
+
/** Whether delivery fulfillment method is configured for the requested operation. */
|
|
697
|
+
deliveryConfigured?: boolean;
|
|
698
|
+
/** List of the available fulfillment options. */
|
|
699
|
+
fulfillmentOptions?: FulfillmentOption[];
|
|
700
|
+
/** Whether availability exceptions block the fulfillment options. */
|
|
701
|
+
blockedByAvailabilityExceptions?: boolean | null;
|
|
702
|
+
}
|
|
703
|
+
/** Fulfillment method that is currently available to fulfill orders, given its availability and the operation's scheduling configurations. */
|
|
704
|
+
export interface FulfillmentOption extends FulfillmentOptionFulfillmentTimeOptionsOneOf, FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf, FulfillmentOptionFulfillmentTypeOptionsOneOf {
|
|
705
|
+
/** Fulfillment time has a maximum time. */
|
|
706
|
+
maxTimeOptions?: number;
|
|
707
|
+
/** Fulfillment time is limited by a range. */
|
|
708
|
+
durationRangeOptions?: DurationRange;
|
|
709
|
+
/** Options for fulfillment time. Required when `type` is `TIME_WINDOWS`. */
|
|
710
|
+
timeWindowsOptions?: TimeWindowDisplayConfig;
|
|
711
|
+
/** Information about pickup fulfillment types. */
|
|
712
|
+
pickupOptions?: PickupDetails;
|
|
713
|
+
/** Information about delivery fulfillment types. */
|
|
714
|
+
deliveryOptions?: DeliveryDetails;
|
|
715
|
+
/** Fulfillment method ID. */
|
|
716
|
+
_id?: string | null;
|
|
717
|
+
/** Fulfillment option type. */
|
|
718
|
+
type?: FulfillmentType;
|
|
719
|
+
/** Minimum order price to qualify for the fulfillment option. */
|
|
720
|
+
minOrderPrice?: string | null;
|
|
721
|
+
/** Fee for using the fulfillment option. */
|
|
722
|
+
fee?: string | null;
|
|
723
|
+
/** Availability of the fulfillment option. */
|
|
724
|
+
availability?: FulfillmentOptionAvailability;
|
|
725
|
+
/**
|
|
726
|
+
* Fulfillment time type.
|
|
727
|
+
* Relevant only to ASAP operations.
|
|
728
|
+
*/
|
|
729
|
+
fulfillmentTimeType?: FulfillmentTimeType;
|
|
730
|
+
/** Fulfillment times display type. Relevant to preorder operations. */
|
|
731
|
+
fulfillmentTimesDisplayType?: FulfillmentTimesDisplayType;
|
|
732
|
+
/**
|
|
733
|
+
* Minimum order price for free fulfillment.
|
|
734
|
+
* If order price exceeds this amount, the given `fee` is waived.
|
|
735
|
+
*/
|
|
736
|
+
freeFulfillmentPriceThreshold?: string | null;
|
|
737
|
+
/** Instructions for the fulfillment. */
|
|
738
|
+
instructions?: string | null;
|
|
739
|
+
businessLocationId?: string | null;
|
|
740
|
+
}
|
|
741
|
+
/** @oneof */
|
|
742
|
+
export interface FulfillmentOptionFulfillmentTimeOptionsOneOf {
|
|
743
|
+
/** Fulfillment time has a maximum time. */
|
|
744
|
+
maxTimeOptions?: number;
|
|
745
|
+
/** Fulfillment time is limited by a range. */
|
|
746
|
+
durationRangeOptions?: DurationRange;
|
|
747
|
+
}
|
|
748
|
+
/** @oneof */
|
|
749
|
+
export interface FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf {
|
|
750
|
+
/** Options for fulfillment time. Required when `type` is `TIME_WINDOWS`. */
|
|
751
|
+
timeWindowsOptions?: TimeWindowDisplayConfig;
|
|
752
|
+
}
|
|
753
|
+
/** @oneof */
|
|
754
|
+
export interface FulfillmentOptionFulfillmentTypeOptionsOneOf {
|
|
755
|
+
/** Information about pickup fulfillment types. */
|
|
756
|
+
pickupOptions?: PickupDetails;
|
|
757
|
+
/** Information about delivery fulfillment types. */
|
|
758
|
+
deliveryOptions?: DeliveryDetails;
|
|
759
|
+
}
|
|
760
|
+
/** Availability of the fulfillment option. */
|
|
761
|
+
export interface FulfillmentOptionAvailability {
|
|
762
|
+
/** Date and time at which the fulfillment option's availability starts. */
|
|
763
|
+
startTime?: Date | null;
|
|
764
|
+
/** Date and time at which the fulfillment option's availability ends. */
|
|
765
|
+
endTime?: Date | null;
|
|
766
|
+
/**
|
|
767
|
+
* List of available times for the days of the week.
|
|
768
|
+
* All the specified times must be within the range between `startTime` and `endTime`.
|
|
769
|
+
*/
|
|
770
|
+
availableTimes?: DayOfWeekAvailability[];
|
|
771
|
+
/** List of availability exceptions that override the availability defined in `availableTimes`. */
|
|
772
|
+
exceptions?: AvailabilityException[];
|
|
773
|
+
/** Timezone for which the available times are given. */
|
|
774
|
+
timeZone?: string | null;
|
|
775
|
+
/** Whether it's possible to submit an order for as soon as possible handling. */
|
|
776
|
+
asapHandlingAvailable?: boolean;
|
|
777
|
+
/** Whether it's possible to submit an order for future handling. */
|
|
778
|
+
futureHandlingAvailable?: boolean | null;
|
|
779
|
+
}
|
|
780
|
+
export interface DayOfWeekAvailability {
|
|
781
|
+
/** The day of week this availability relates to. */
|
|
782
|
+
dayOfWeek?: EntitiesDayOfWeek;
|
|
783
|
+
/** A list of time ranges during which the fulfillment should be available. */
|
|
784
|
+
timeRanges?: TimeOfDayRange[];
|
|
785
|
+
}
|
|
786
|
+
export interface TimeOfDayRange {
|
|
787
|
+
/** The start time in time of day representation. */
|
|
788
|
+
startTime?: TimeOfDay;
|
|
789
|
+
/** The end time in time of day representation. */
|
|
790
|
+
endTime?: TimeOfDay;
|
|
791
|
+
}
|
|
792
|
+
export interface AvailabilityException {
|
|
793
|
+
/** The start time of the availability exception. */
|
|
794
|
+
startTime?: Date | null;
|
|
795
|
+
/** The end time of the availability exception. */
|
|
796
|
+
endTime?: Date | null;
|
|
797
|
+
/** An indication whether the exception makes the [`start_time`, `end_time`] range available. */
|
|
798
|
+
available?: boolean;
|
|
799
|
+
/** The reason for the exception. */
|
|
800
|
+
reason?: string | null;
|
|
801
|
+
}
|
|
802
|
+
/** Fulfillment time type enum. */
|
|
803
|
+
export declare enum FulfillmentTimeType {
|
|
804
|
+
/** Undefined fulfillment time type. */
|
|
805
|
+
UNDEFINED_FULFILLMENT_TIME = "UNDEFINED_FULFILLMENT_TIME",
|
|
806
|
+
/** Fulfillment time has a maximum. */
|
|
807
|
+
MAX_TIME = "MAX_TIME",
|
|
808
|
+
/** Fulfillment time has a minimum and a maximum. */
|
|
809
|
+
DURATION_RANGE = "DURATION_RANGE"
|
|
810
|
+
}
|
|
811
|
+
/** Duration range. */
|
|
812
|
+
export interface DurationRange {
|
|
813
|
+
/** Minimum duration in minutes. */
|
|
814
|
+
minDuration?: number;
|
|
815
|
+
/** Maximum duration in minutes. */
|
|
816
|
+
maxDuration?: number;
|
|
817
|
+
}
|
|
818
|
+
/** Fulfillment times display type enum. */
|
|
819
|
+
export declare enum FulfillmentTimesDisplayType {
|
|
820
|
+
/** Undefined fulfillment times display type. */
|
|
821
|
+
UNDEFINED_FULFILLMENT_TIMES_DISPLAY = "UNDEFINED_FULFILLMENT_TIMES_DISPLAY",
|
|
822
|
+
/** Fulfillment times are displayed as a list of time windows. */
|
|
823
|
+
TIME_WINDOWS = "TIME_WINDOWS"
|
|
824
|
+
}
|
|
825
|
+
/** Time window. */
|
|
826
|
+
export interface TimeWindowDisplayConfig {
|
|
827
|
+
/** Time window duration in minutes. */
|
|
828
|
+
durationInMinutes?: number;
|
|
829
|
+
}
|
|
830
|
+
/** Information about pickup fulfillment types. */
|
|
831
|
+
export interface PickupDetails {
|
|
832
|
+
/** Pickup address. This is the restaurant's address. */
|
|
833
|
+
address?: CommonAddress;
|
|
834
|
+
}
|
|
835
|
+
/** Information about delivery fulfillment types. */
|
|
836
|
+
export interface DeliveryDetails {
|
|
837
|
+
/** Delivery provider app id. */
|
|
838
|
+
deliveryProviderAppId?: string | null;
|
|
839
|
+
/** Pickup instructions for couriers. */
|
|
840
|
+
courierPickupInstructions?: string | null;
|
|
841
|
+
}
|
|
842
|
+
export interface ListFirstAvailableTimeSlotForFulfillmentTypesRequest {
|
|
843
|
+
/**
|
|
844
|
+
* Operation ID.
|
|
845
|
+
* Returned fulfillment options will belong to this operation.
|
|
846
|
+
*/
|
|
847
|
+
operationId: string;
|
|
848
|
+
/**
|
|
849
|
+
* Delivery address. Optional.
|
|
850
|
+
*
|
|
851
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
852
|
+
*/
|
|
853
|
+
deliveryAddress?: CommonAddress;
|
|
854
|
+
}
|
|
855
|
+
export interface ListFirstAvailableTimeSlotForFulfillmentTypesResponse {
|
|
856
|
+
/**
|
|
857
|
+
* List of available time slots for each fulfillment type.
|
|
858
|
+
*
|
|
859
|
+
* Each time slot is the first available time slot for the given fulfillment type.
|
|
860
|
+
* A delivery fulfillment type is returned only if the delivery address is provided.
|
|
861
|
+
*/
|
|
862
|
+
timeSlots?: FulfillmentTimeSlot[];
|
|
863
|
+
}
|
|
864
|
+
export interface FulfillmentTimeSlot {
|
|
865
|
+
/** Start time and date of the time slot. */
|
|
866
|
+
startTime?: Date | null;
|
|
867
|
+
/** End time and date of the time slot. */
|
|
868
|
+
endTime?: Date | null;
|
|
869
|
+
/** Type of the fulfillment. */
|
|
870
|
+
fulfilmentType?: FulfillmentType;
|
|
871
|
+
/** Whether the time slot starts now. */
|
|
872
|
+
startsNow?: boolean;
|
|
873
|
+
/** Details for each fulfillment option of the time slot. */
|
|
874
|
+
fulfillmentDetails?: FulfillmentDetails[];
|
|
875
|
+
/** Address of the fulfillment. */
|
|
876
|
+
fulfillmentAddress?: FulfillmentAddress;
|
|
877
|
+
}
|
|
878
|
+
/** Details about the fulfillment option. */
|
|
879
|
+
export interface FulfillmentDetails extends FulfillmentDetailsFulfillmentTimeOptionsOneOf {
|
|
880
|
+
/** Fulfillment time has a maximum. */
|
|
881
|
+
maxTimeOptions?: number;
|
|
882
|
+
/** Fulfillment time has a minimum and a maximum. */
|
|
883
|
+
durationRangeOptions?: DurationRange;
|
|
884
|
+
/** Fee for using this fulfillment. */
|
|
885
|
+
fee?: string | null;
|
|
886
|
+
/** Minimum order price to qualify for using this fulfillment. */
|
|
887
|
+
minOrderPrice?: string | null;
|
|
888
|
+
/** Fulfillment time type. Only be relevant to ASAP operations. */
|
|
889
|
+
fulfillmentTimeType?: FulfillmentTimeType;
|
|
890
|
+
/**
|
|
891
|
+
* Minimum order price for free fulfillment.
|
|
892
|
+
* If order price exceeds this amount, the given `fee` is waived.
|
|
893
|
+
*/
|
|
894
|
+
freeFulfillmentPriceThreshold?: string | null;
|
|
895
|
+
}
|
|
896
|
+
/** @oneof */
|
|
897
|
+
export interface FulfillmentDetailsFulfillmentTimeOptionsOneOf {
|
|
898
|
+
/** Fulfillment time has a maximum. */
|
|
899
|
+
maxTimeOptions?: number;
|
|
900
|
+
/** Fulfillment time has a minimum and a maximum. */
|
|
901
|
+
durationRangeOptions?: DurationRange;
|
|
902
|
+
}
|
|
903
|
+
/**
|
|
904
|
+
* Details on the address of the fulfillment.
|
|
905
|
+
* For pickup it will the address to take the order from.
|
|
906
|
+
* For delivery it will be the address to deliver the order to.
|
|
907
|
+
*/
|
|
908
|
+
export interface FulfillmentAddress {
|
|
909
|
+
/** Pickup address. This is the address of the restaurant. */
|
|
910
|
+
address?: CommonAddress;
|
|
911
|
+
}
|
|
912
|
+
export interface ListFirstAvailableTimeSlotsForOperationsRequest {
|
|
913
|
+
/**
|
|
914
|
+
* Operation ID.
|
|
915
|
+
* Returned fulfillment options will belong to this operation.
|
|
916
|
+
*/
|
|
917
|
+
operationIds: string[];
|
|
918
|
+
/**
|
|
919
|
+
* Delivery address. Optional.
|
|
920
|
+
*
|
|
921
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
922
|
+
*/
|
|
923
|
+
deliveryAddress?: CommonAddress;
|
|
924
|
+
}
|
|
925
|
+
export interface ListFirstAvailableTimeSlotsForOperationsResponse {
|
|
926
|
+
/** List of available time slots for each operation. */
|
|
927
|
+
timeSlots?: OperationTimeSlot[];
|
|
928
|
+
}
|
|
929
|
+
export interface OperationTimeSlot {
|
|
930
|
+
/** Operation ID. */
|
|
931
|
+
operationId?: string;
|
|
932
|
+
/** List of available time slots for each fulfillment type. */
|
|
933
|
+
timeSlots?: FulfillmentTimeSlot[];
|
|
934
|
+
}
|
|
935
|
+
export interface ListFirstAvailableTimeSlotsForMenusRequest {
|
|
936
|
+
/**
|
|
937
|
+
* Operation ID.
|
|
938
|
+
* Returned timeslots that are belong to this operation.
|
|
939
|
+
*/
|
|
940
|
+
operationId: string | null;
|
|
941
|
+
/**
|
|
942
|
+
* Delivery address. Optional.
|
|
943
|
+
*
|
|
944
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
945
|
+
*/
|
|
946
|
+
deliveryAddress?: CommonAddress;
|
|
947
|
+
/** Cursor paging */
|
|
948
|
+
cursorPaging?: CursorPaging;
|
|
949
|
+
}
|
|
950
|
+
export interface ListFirstAvailableTimeSlotsForMenusResponse {
|
|
951
|
+
/**
|
|
952
|
+
* List of available time slots for each menu.
|
|
953
|
+
* For each menu will be returned the first available time slot for each fulfillment type.
|
|
954
|
+
*/
|
|
955
|
+
timeSlotsPerMenu?: FirstFulfillmentTimeSlotsPerMenu[];
|
|
956
|
+
/** Cursor to next request. */
|
|
957
|
+
cursor?: string | null;
|
|
958
|
+
}
|
|
959
|
+
export interface FirstFulfillmentTimeSlotsPerMenu {
|
|
960
|
+
/** Menu ID. */
|
|
961
|
+
menuId?: string | null;
|
|
962
|
+
/** List of available time slots for each fulfillment type. */
|
|
963
|
+
timeslotsPerFulfillmentType?: FulfillmentTimeSlot[];
|
|
964
|
+
}
|
|
965
|
+
export interface ListAvailableTimeSlotsForDateRequest {
|
|
966
|
+
/**
|
|
967
|
+
* Operation ID.
|
|
968
|
+
* The returned fulfillment options will belong to this operation.
|
|
969
|
+
*/
|
|
970
|
+
operationId: string;
|
|
971
|
+
/**
|
|
972
|
+
* Delivery address. Optional.
|
|
973
|
+
*
|
|
974
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
975
|
+
*/
|
|
976
|
+
deliveryAddress?: CommonAddress;
|
|
977
|
+
/** Date and time to get the available time slots for. */
|
|
978
|
+
date: _Date;
|
|
979
|
+
}
|
|
980
|
+
export interface _Date {
|
|
981
|
+
/** The day of the month. */
|
|
982
|
+
day?: number;
|
|
983
|
+
/** The month of the year. */
|
|
984
|
+
month?: number;
|
|
985
|
+
/** The year of the date. */
|
|
986
|
+
year?: number;
|
|
987
|
+
}
|
|
988
|
+
export interface ListAvailableTimeSlotsForDateResponse {
|
|
989
|
+
/** Lst of the available time slots in the requested date. */
|
|
990
|
+
timeSlots?: FulfillmentTimeSlot[];
|
|
991
|
+
}
|
|
992
|
+
export interface ListAvailableDatesInRangeRequest {
|
|
993
|
+
/**
|
|
994
|
+
* Operation ID.
|
|
995
|
+
* The returned fulfillment options will belong to this operation.
|
|
996
|
+
*/
|
|
997
|
+
operationId: string;
|
|
998
|
+
/**
|
|
999
|
+
* Delivery address. Optional.
|
|
1000
|
+
*
|
|
1001
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
1002
|
+
*/
|
|
1003
|
+
deliveryAddress?: CommonAddress;
|
|
1004
|
+
/** Start date and time of the range. */
|
|
1005
|
+
from: _Date;
|
|
1006
|
+
/** End date and time of the range. */
|
|
1007
|
+
until: _Date;
|
|
1008
|
+
}
|
|
1009
|
+
export interface ListAvailableDatesInRangeResponse {
|
|
1010
|
+
/** List of the available dates in descending order for each fulfillment type. */
|
|
1011
|
+
availableDates?: FulfillmentTypeAvailableDates[];
|
|
1012
|
+
}
|
|
1013
|
+
/** Available dates for a given fulfillment type. */
|
|
1014
|
+
export interface FulfillmentTypeAvailableDates {
|
|
1015
|
+
/** Type of the fulfillment. */
|
|
1016
|
+
fulfilmentType?: FulfillmentType;
|
|
1017
|
+
/** List of the available dates in descending order. */
|
|
1018
|
+
dates?: _Date[];
|
|
1019
|
+
}
|
|
1020
|
+
export interface GetExpectedFulfillmentSelectionRequest {
|
|
1021
|
+
/** Operation ID. The returned fulfillment will belong to this operation. */
|
|
1022
|
+
operationId?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* Delivery address. Optional.
|
|
1025
|
+
*
|
|
1026
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
1027
|
+
*/
|
|
1028
|
+
deliveryAddress?: CommonAddress;
|
|
1029
|
+
/** Start time and date of the time slot. */
|
|
1030
|
+
timeslotStartTime?: Date | null;
|
|
1031
|
+
/** End time and date of the time slot. */
|
|
1032
|
+
timeslotEndTime?: Date | null;
|
|
1033
|
+
/** Type of fulfillment. */
|
|
1034
|
+
fulfilmentType?: FulfillmentType;
|
|
1035
|
+
/** Whether it is possible to submit an order to be prepared asap. */
|
|
1036
|
+
canSubmitOrderForNow?: boolean | null;
|
|
1037
|
+
}
|
|
1038
|
+
export interface GetExpectedFulfillmentSelectionResponse {
|
|
1039
|
+
/** Expected fulfillment option. */
|
|
1040
|
+
expectedFulfillmentSelections?: FulfillmentOption[];
|
|
1041
|
+
}
|
|
1042
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1043
|
+
createdEvent?: EntityCreatedEvent;
|
|
1044
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1045
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1046
|
+
actionEvent?: ActionEvent;
|
|
1047
|
+
/**
|
|
1048
|
+
* Unique event ID.
|
|
1049
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1050
|
+
*/
|
|
1051
|
+
_id?: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* Assumes actions are also always typed to an entity_type
|
|
1054
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1055
|
+
*/
|
|
1056
|
+
entityFqdn?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1059
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1060
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1061
|
+
*/
|
|
1062
|
+
slug?: string;
|
|
1063
|
+
/** ID of the entity associated with the event. */
|
|
1064
|
+
entityId?: string;
|
|
1065
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1066
|
+
eventTime?: Date | null;
|
|
1067
|
+
/**
|
|
1068
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1069
|
+
* (for example, GDPR).
|
|
1070
|
+
*/
|
|
1071
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1072
|
+
/** If present, indicates the action that triggered the event. */
|
|
1073
|
+
originatedFrom?: string | null;
|
|
1074
|
+
/**
|
|
1075
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1076
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1077
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1078
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1079
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1080
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1081
|
+
*/
|
|
1082
|
+
entityEventSequence?: string | null;
|
|
1083
|
+
}
|
|
1084
|
+
/** @oneof */
|
|
1085
|
+
export interface DomainEventBodyOneOf {
|
|
1086
|
+
createdEvent?: EntityCreatedEvent;
|
|
1087
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1088
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1089
|
+
actionEvent?: ActionEvent;
|
|
1090
|
+
}
|
|
1091
|
+
export interface EntityCreatedEvent {
|
|
1092
|
+
entity?: string;
|
|
1093
|
+
}
|
|
1094
|
+
export interface RestoreInfo {
|
|
1095
|
+
deletedDate?: Date | null;
|
|
1096
|
+
}
|
|
1097
|
+
export interface EntityUpdatedEvent {
|
|
1098
|
+
/**
|
|
1099
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1100
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1101
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1102
|
+
*/
|
|
1103
|
+
currentEntity?: string;
|
|
1104
|
+
}
|
|
1105
|
+
export interface EntityDeletedEvent {
|
|
1106
|
+
/** Entity that was deleted */
|
|
1107
|
+
deletedEntity?: string | null;
|
|
1108
|
+
}
|
|
1109
|
+
export interface ActionEvent {
|
|
1110
|
+
body?: string;
|
|
1111
|
+
}
|
|
1112
|
+
export interface Empty {
|
|
1113
|
+
}
|
|
1114
|
+
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1115
|
+
export interface SitePropertiesNotification {
|
|
1116
|
+
/** The site ID for which this update notification applies. */
|
|
1117
|
+
metasiteId?: string;
|
|
1118
|
+
/** The actual update event. */
|
|
1119
|
+
event?: SitePropertiesEvent;
|
|
1120
|
+
/** A convenience set of mappings from the MetaSite ID to its constituent services. */
|
|
1121
|
+
translations?: Translation[];
|
|
1122
|
+
/** Context of the notification */
|
|
1123
|
+
changeContext?: ChangeContext;
|
|
1124
|
+
}
|
|
1125
|
+
/** The actual update event for a particular notification. */
|
|
1126
|
+
export interface SitePropertiesEvent {
|
|
1127
|
+
/** Version of the site's properties represented by this update. */
|
|
1128
|
+
version?: number;
|
|
1129
|
+
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1130
|
+
fields?: string[];
|
|
1131
|
+
/** Updated properties. */
|
|
1132
|
+
properties?: Properties;
|
|
1133
|
+
}
|
|
1134
|
+
export interface Properties {
|
|
1135
|
+
/** Site categories. */
|
|
1136
|
+
categories?: Categories;
|
|
1137
|
+
/** Site locale. */
|
|
1138
|
+
locale?: Locale;
|
|
1139
|
+
/**
|
|
1140
|
+
* Site language.
|
|
1141
|
+
*
|
|
1142
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1143
|
+
*/
|
|
1144
|
+
language?: string | null;
|
|
1145
|
+
/**
|
|
1146
|
+
* Site currency format used to bill customers.
|
|
1147
|
+
*
|
|
1148
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1149
|
+
*/
|
|
1150
|
+
paymentCurrency?: string | null;
|
|
1151
|
+
/** Timezone in `America/New_York` format. */
|
|
1152
|
+
timeZone?: string | null;
|
|
1153
|
+
/** Email address. */
|
|
1154
|
+
email?: string | null;
|
|
1155
|
+
/** Phone number. */
|
|
1156
|
+
phone?: string | null;
|
|
1157
|
+
/** Fax number. */
|
|
1158
|
+
fax?: string | null;
|
|
1159
|
+
/** Address. */
|
|
1160
|
+
address?: Address;
|
|
1161
|
+
/** Site display name. */
|
|
1162
|
+
siteDisplayName?: string | null;
|
|
1163
|
+
/** Business name. */
|
|
1164
|
+
businessName?: string | null;
|
|
1165
|
+
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1166
|
+
logo?: string | null;
|
|
1167
|
+
/** Site description. */
|
|
1168
|
+
description?: string | null;
|
|
1169
|
+
/**
|
|
1170
|
+
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1171
|
+
*
|
|
1172
|
+
* __Note:__ Not supported by Wix Bookings.
|
|
1173
|
+
*/
|
|
1174
|
+
businessSchedule?: BusinessSchedule;
|
|
1175
|
+
/** Supported languages of a site and the primary language. */
|
|
1176
|
+
multilingual?: Multilingual;
|
|
1177
|
+
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1178
|
+
consentPolicy?: ConsentPolicy;
|
|
1179
|
+
/**
|
|
1180
|
+
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1181
|
+
*
|
|
1182
|
+
* Site business type.
|
|
1183
|
+
*/
|
|
1184
|
+
businessConfig?: string | null;
|
|
1185
|
+
/** External site URL that uses Wix as its headless business solution. */
|
|
1186
|
+
externalSiteUrl?: string | null;
|
|
1187
|
+
/** Track clicks analytics. */
|
|
1188
|
+
trackClicksAnalytics?: boolean;
|
|
1189
|
+
}
|
|
1190
|
+
export interface Categories {
|
|
1191
|
+
/** Primary site category. */
|
|
1192
|
+
primary?: string;
|
|
1193
|
+
/** Secondary site category. */
|
|
1194
|
+
secondary?: string[];
|
|
1195
|
+
/** Business Term Id */
|
|
1196
|
+
businessTermId?: string | null;
|
|
1197
|
+
}
|
|
1198
|
+
export interface Locale {
|
|
1199
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1200
|
+
languageCode?: string;
|
|
1201
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1202
|
+
country?: string;
|
|
1203
|
+
}
|
|
1204
|
+
export interface Address {
|
|
1205
|
+
/** Street name. */
|
|
1206
|
+
street?: string;
|
|
1207
|
+
/** City name. */
|
|
1208
|
+
city?: string;
|
|
1209
|
+
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1210
|
+
country?: string;
|
|
1211
|
+
/** State. */
|
|
1212
|
+
state?: string;
|
|
1213
|
+
/** Zip or postal code. */
|
|
1214
|
+
zip?: string;
|
|
1215
|
+
/** Extra information to be displayed in the address. */
|
|
1216
|
+
hint?: AddressHint;
|
|
1217
|
+
/** Whether this address represents a physical location. */
|
|
1218
|
+
isPhysical?: boolean;
|
|
1219
|
+
/** Google-formatted version of this address. */
|
|
1220
|
+
googleFormattedAddress?: string;
|
|
1221
|
+
/** Street number. */
|
|
1222
|
+
streetNumber?: string;
|
|
1223
|
+
/** Apartment number. */
|
|
1224
|
+
apartmentNumber?: string;
|
|
1225
|
+
/** Geographic coordinates of location. */
|
|
1226
|
+
coordinates?: GeoCoordinates;
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
* Extra information on displayed addresses.
|
|
1230
|
+
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1231
|
+
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1232
|
+
*/
|
|
1233
|
+
export interface AddressHint {
|
|
1234
|
+
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1235
|
+
text?: string;
|
|
1236
|
+
/** Where the extra text should be displayed. */
|
|
1237
|
+
placement?: PlacementType;
|
|
1238
|
+
}
|
|
1239
|
+
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1240
|
+
export declare enum PlacementType {
|
|
1241
|
+
BEFORE = "BEFORE",
|
|
1242
|
+
AFTER = "AFTER",
|
|
1243
|
+
REPLACE = "REPLACE"
|
|
1244
|
+
}
|
|
1245
|
+
/** Geocoordinates for a particular address. */
|
|
1246
|
+
export interface GeoCoordinates {
|
|
1247
|
+
/** Latitude of the location. Must be between -90 and 90. */
|
|
1248
|
+
latitude?: number;
|
|
1249
|
+
/** Longitude of the location. Must be between -180 and 180. */
|
|
1250
|
+
longitude?: number;
|
|
1251
|
+
}
|
|
1252
|
+
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1253
|
+
export interface BusinessSchedule {
|
|
1254
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
|
|
1255
|
+
periods?: TimePeriod[];
|
|
1256
|
+
/** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
|
|
1257
|
+
specialHourPeriod?: SpecialHourPeriod[];
|
|
1258
|
+
}
|
|
1259
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1260
|
+
export interface TimePeriod {
|
|
1261
|
+
/** Day of the week the period starts on. */
|
|
1262
|
+
openDay?: DayOfWeek;
|
|
1263
|
+
/**
|
|
1264
|
+
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1265
|
+
* midnight at the end of the specified day.
|
|
1266
|
+
*/
|
|
1267
|
+
openTime?: string;
|
|
1268
|
+
/** Day of the week the period ends on. */
|
|
1269
|
+
closeDay?: DayOfWeek;
|
|
1270
|
+
/**
|
|
1271
|
+
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1272
|
+
* midnight at the end of the specified day.
|
|
1273
|
+
*
|
|
1274
|
+
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1275
|
+
*/
|
|
1276
|
+
closeTime?: string;
|
|
1277
|
+
}
|
|
1278
|
+
/** Enumerates the days of the week. */
|
|
1279
|
+
export declare enum DayOfWeek {
|
|
1280
|
+
MONDAY = "MONDAY",
|
|
1281
|
+
TUESDAY = "TUESDAY",
|
|
1282
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1283
|
+
THURSDAY = "THURSDAY",
|
|
1284
|
+
FRIDAY = "FRIDAY",
|
|
1285
|
+
SATURDAY = "SATURDAY",
|
|
1286
|
+
SUNDAY = "SUNDAY"
|
|
1287
|
+
}
|
|
1288
|
+
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1289
|
+
export interface SpecialHourPeriod {
|
|
1290
|
+
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1291
|
+
startDate?: string;
|
|
1292
|
+
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1293
|
+
endDate?: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* Whether the business is closed (or the service is not available) during the exception.
|
|
1296
|
+
*
|
|
1297
|
+
* Default: `true`.
|
|
1298
|
+
*/
|
|
1299
|
+
isClosed?: boolean;
|
|
1300
|
+
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1301
|
+
comment?: string;
|
|
1302
|
+
}
|
|
1303
|
+
export interface Multilingual {
|
|
1304
|
+
/** Supported languages list. */
|
|
1305
|
+
supportedLanguages?: SupportedLanguage[];
|
|
1306
|
+
/** Whether to redirect to user language. */
|
|
1307
|
+
autoRedirect?: boolean;
|
|
1308
|
+
}
|
|
1309
|
+
export interface SupportedLanguage {
|
|
1310
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1311
|
+
languageCode?: string;
|
|
1312
|
+
/** Locale. */
|
|
1313
|
+
locale?: Locale;
|
|
1314
|
+
/** Whether the supported language is the primary language for the site. */
|
|
1315
|
+
isPrimary?: boolean;
|
|
1316
|
+
/** Language icon. */
|
|
1317
|
+
countryCode?: string;
|
|
1318
|
+
/** How the language will be resolved. For internal use. */
|
|
1319
|
+
resolutionMethod?: ResolutionMethod;
|
|
1320
|
+
}
|
|
1321
|
+
export declare enum ResolutionMethod {
|
|
1322
|
+
QUERY_PARAM = "QUERY_PARAM",
|
|
1323
|
+
SUBDOMAIN = "SUBDOMAIN",
|
|
1324
|
+
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1325
|
+
}
|
|
1326
|
+
export interface ConsentPolicy {
|
|
1327
|
+
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1328
|
+
essential?: boolean | null;
|
|
1329
|
+
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1330
|
+
functional?: boolean | null;
|
|
1331
|
+
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1332
|
+
analytics?: boolean | null;
|
|
1333
|
+
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1334
|
+
advertising?: boolean | null;
|
|
1335
|
+
/** CCPA compliance flag. */
|
|
1336
|
+
dataToThirdParty?: boolean | null;
|
|
1337
|
+
}
|
|
1338
|
+
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1339
|
+
export interface Translation {
|
|
1340
|
+
/** The service type. */
|
|
1341
|
+
serviceType?: string;
|
|
1342
|
+
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1343
|
+
appDefId?: string;
|
|
1344
|
+
/** The instance ID of the service. */
|
|
1345
|
+
instanceId?: string;
|
|
1346
|
+
}
|
|
1347
|
+
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1348
|
+
/** Properties were updated. */
|
|
1349
|
+
propertiesChange?: PropertiesChange;
|
|
1350
|
+
/** Default properties were created on site creation. */
|
|
1351
|
+
siteCreated?: SiteCreated;
|
|
1352
|
+
/** Properties were cloned on site cloning. */
|
|
1353
|
+
siteCloned?: SiteCloned;
|
|
1354
|
+
}
|
|
1355
|
+
/** @oneof */
|
|
1356
|
+
export interface ChangeContextPayloadOneOf {
|
|
1357
|
+
/** Properties were updated. */
|
|
1358
|
+
propertiesChange?: PropertiesChange;
|
|
1359
|
+
/** Default properties were created on site creation. */
|
|
1360
|
+
siteCreated?: SiteCreated;
|
|
1361
|
+
/** Properties were cloned on site cloning. */
|
|
1362
|
+
siteCloned?: SiteCloned;
|
|
1363
|
+
}
|
|
1364
|
+
export interface PropertiesChange {
|
|
1365
|
+
}
|
|
1366
|
+
export interface SiteCreated {
|
|
1367
|
+
/** Origin template site id. */
|
|
1368
|
+
originTemplateId?: string | null;
|
|
1369
|
+
}
|
|
1370
|
+
export interface SiteCloned {
|
|
1371
|
+
/** Origin site id. */
|
|
1372
|
+
originMetaSiteId?: string;
|
|
1373
|
+
}
|
|
1374
|
+
export interface MessageEnvelope {
|
|
1375
|
+
/** App instance ID. */
|
|
1376
|
+
instanceId?: string | null;
|
|
1377
|
+
/** Event type. */
|
|
1378
|
+
eventType?: string;
|
|
1379
|
+
/** The identification type and identity data. */
|
|
1380
|
+
identity?: IdentificationData;
|
|
1381
|
+
/** Stringify payload. */
|
|
1382
|
+
data?: string;
|
|
1383
|
+
}
|
|
1384
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1385
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1386
|
+
anonymousVisitorId?: string;
|
|
1387
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1388
|
+
memberId?: string;
|
|
1389
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1390
|
+
wixUserId?: string;
|
|
1391
|
+
/** ID of an app. */
|
|
1392
|
+
appId?: string;
|
|
1393
|
+
/** @readonly */
|
|
1394
|
+
identityType?: WebhookIdentityType;
|
|
1395
|
+
}
|
|
1396
|
+
/** @oneof */
|
|
1397
|
+
export interface IdentificationDataIdOneOf {
|
|
1398
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1399
|
+
anonymousVisitorId?: string;
|
|
1400
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1401
|
+
memberId?: string;
|
|
1402
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1403
|
+
wixUserId?: string;
|
|
1404
|
+
/** ID of an app. */
|
|
1405
|
+
appId?: string;
|
|
1406
|
+
}
|
|
1407
|
+
export declare enum WebhookIdentityType {
|
|
1408
|
+
UNKNOWN = "UNKNOWN",
|
|
1409
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1410
|
+
MEMBER = "MEMBER",
|
|
1411
|
+
WIX_USER = "WIX_USER",
|
|
1412
|
+
APP = "APP"
|
|
1413
|
+
}
|
|
1414
|
+
interface TimeDurationNonNullableFields {
|
|
1415
|
+
timeUnit: TimeUnit;
|
|
1416
|
+
}
|
|
1417
|
+
interface TimeDurationRangeNonNullableFields {
|
|
1418
|
+
timeUnit: TimeUnit;
|
|
1419
|
+
}
|
|
1420
|
+
interface AsapSchedulingNonNullableFields {
|
|
1421
|
+
maxOptions?: TimeDurationNonNullableFields;
|
|
1422
|
+
rangeOptions?: TimeDurationRangeNonNullableFields;
|
|
1423
|
+
type: PreparationTimeType;
|
|
1424
|
+
asapPreorderType: AsapPreorderType;
|
|
1425
|
+
}
|
|
1426
|
+
interface TimeBoundedNonNullableFields {
|
|
1427
|
+
minimumInAdvanceTime?: TimeDurationNonNullableFields;
|
|
1428
|
+
maximumInAdvanceTime?: TimeDurationNonNullableFields;
|
|
1429
|
+
minTimeInAdvance?: TimeDurationNonNullableFields;
|
|
1430
|
+
maxTimeInAdvance?: TimeDurationNonNullableFields;
|
|
1431
|
+
}
|
|
1432
|
+
interface TimeOfDayNonNullableFields {
|
|
1433
|
+
hours: number;
|
|
1434
|
+
minutes: number;
|
|
1435
|
+
}
|
|
1436
|
+
interface DayAndTimeNonNullableFields {
|
|
1437
|
+
dayOfWeek: EntitiesDayOfWeek;
|
|
1438
|
+
timeOfDay?: TimeOfDayNonNullableFields;
|
|
1439
|
+
}
|
|
1440
|
+
interface WeeklyScheduleNonNullableFields {
|
|
1441
|
+
cutOffTime?: DayAndTimeNonNullableFields;
|
|
1442
|
+
}
|
|
1443
|
+
interface PreorderMethodNonNullableFields {
|
|
1444
|
+
timeBoundedOptions?: TimeBoundedNonNullableFields;
|
|
1445
|
+
weeklyScheduleOptions?: WeeklyScheduleNonNullableFields;
|
|
1446
|
+
type: MethodType;
|
|
1447
|
+
}
|
|
1448
|
+
interface FulfillmentTimesDisplayConfigNonNullableFields {
|
|
1449
|
+
timeWindowsOptions?: TimeDurationNonNullableFields;
|
|
1450
|
+
fulfillmentTimesType: FulfillmentTimesType;
|
|
1451
|
+
type: FulfillmentTimesType;
|
|
1452
|
+
}
|
|
1453
|
+
interface PreorderSchedulingNonNullableFields {
|
|
1454
|
+
method?: PreorderMethodNonNullableFields;
|
|
1455
|
+
fulfillmentTimesDisplayConfig?: FulfillmentTimesDisplayConfigNonNullableFields;
|
|
1456
|
+
fulfillmentTimesDisplay?: FulfillmentTimesDisplayConfigNonNullableFields;
|
|
1457
|
+
}
|
|
1458
|
+
interface SchedulingNonNullableFields {
|
|
1459
|
+
asapOptions?: AsapSchedulingNonNullableFields;
|
|
1460
|
+
preorderOptions?: PreorderSchedulingNonNullableFields;
|
|
1461
|
+
type: SchedulingType;
|
|
1462
|
+
}
|
|
1463
|
+
interface PreparationTimeNonNullableFields {
|
|
1464
|
+
maxTimeOptions?: TimeDurationNonNullableFields;
|
|
1465
|
+
timeRangeOptions?: TimeDurationRangeNonNullableFields;
|
|
1466
|
+
type: PreparationTimePreparationTimeType;
|
|
1467
|
+
}
|
|
1468
|
+
interface AsapOrderSchedulingNonNullableFields {
|
|
1469
|
+
preparationTime?: PreparationTimeNonNullableFields;
|
|
1470
|
+
asapFutureHandlingType: AsapFutureHandlingType;
|
|
1471
|
+
}
|
|
1472
|
+
interface OrderSchedulingNonNullableFields {
|
|
1473
|
+
asapOptions?: AsapOrderSchedulingNonNullableFields;
|
|
1474
|
+
preorderOptions?: PreorderSchedulingNonNullableFields;
|
|
1475
|
+
type: SchedulingType;
|
|
1476
|
+
}
|
|
1477
|
+
interface V1StreetAddressNonNullableFields {
|
|
1478
|
+
number: string;
|
|
1479
|
+
name: string;
|
|
1480
|
+
apt: string;
|
|
1481
|
+
}
|
|
1482
|
+
interface V1AddressNonNullableFields {
|
|
1483
|
+
streetAddress?: V1StreetAddressNonNullableFields;
|
|
1484
|
+
}
|
|
1485
|
+
interface BusinessLocationDetailsNonNullableFields {
|
|
1486
|
+
address?: V1AddressNonNullableFields;
|
|
1487
|
+
}
|
|
1488
|
+
export interface OperationNonNullableFields {
|
|
1489
|
+
scheduling?: SchedulingNonNullableFields;
|
|
1490
|
+
onlineOrderingStatus: OnlineOrderingStatusType;
|
|
1491
|
+
defaultFulfillmentType: FulfillmentType;
|
|
1492
|
+
orderScheduling?: OrderSchedulingNonNullableFields;
|
|
1493
|
+
businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
|
|
1494
|
+
}
|
|
1495
|
+
export interface CreateOperationResponseNonNullableFields {
|
|
1496
|
+
operation?: OperationNonNullableFields;
|
|
1497
|
+
}
|
|
1498
|
+
export interface GetOperationResponseNonNullableFields {
|
|
1499
|
+
operation?: OperationNonNullableFields;
|
|
1500
|
+
}
|
|
1501
|
+
export interface UpdateOperationResponseNonNullableFields {
|
|
1502
|
+
operation?: OperationNonNullableFields;
|
|
1503
|
+
}
|
|
1504
|
+
export interface QueryOperationResponseNonNullableFields {
|
|
1505
|
+
operations: OperationNonNullableFields[];
|
|
1506
|
+
}
|
|
1507
|
+
export interface ListOperationsResponseNonNullableFields {
|
|
1508
|
+
operations: OperationNonNullableFields[];
|
|
1509
|
+
}
|
|
1510
|
+
interface DurationRangeNonNullableFields {
|
|
1511
|
+
minDuration: number;
|
|
1512
|
+
maxDuration: number;
|
|
1513
|
+
}
|
|
1514
|
+
interface TimeWindowDisplayConfigNonNullableFields {
|
|
1515
|
+
durationInMinutes: number;
|
|
1516
|
+
}
|
|
1517
|
+
interface StreetAddressNonNullableFields {
|
|
1518
|
+
number: string;
|
|
1519
|
+
name: string;
|
|
1520
|
+
apt: string;
|
|
1521
|
+
}
|
|
1522
|
+
interface SubdivisionNonNullableFields {
|
|
1523
|
+
name: string;
|
|
1524
|
+
}
|
|
1525
|
+
interface CommonAddressNonNullableFields {
|
|
1526
|
+
streetAddress?: StreetAddressNonNullableFields;
|
|
1527
|
+
subdivisions: SubdivisionNonNullableFields[];
|
|
1528
|
+
}
|
|
1529
|
+
interface PickupDetailsNonNullableFields {
|
|
1530
|
+
address?: CommonAddressNonNullableFields;
|
|
1531
|
+
}
|
|
1532
|
+
interface TimeOfDayRangeNonNullableFields {
|
|
1533
|
+
startTime?: TimeOfDayNonNullableFields;
|
|
1534
|
+
endTime?: TimeOfDayNonNullableFields;
|
|
1535
|
+
}
|
|
1536
|
+
interface DayOfWeekAvailabilityNonNullableFields {
|
|
1537
|
+
dayOfWeek: EntitiesDayOfWeek;
|
|
1538
|
+
timeRanges: TimeOfDayRangeNonNullableFields[];
|
|
1539
|
+
}
|
|
1540
|
+
interface AvailabilityExceptionNonNullableFields {
|
|
1541
|
+
available: boolean;
|
|
1542
|
+
}
|
|
1543
|
+
interface FulfillmentOptionAvailabilityNonNullableFields {
|
|
1544
|
+
availableTimes: DayOfWeekAvailabilityNonNullableFields[];
|
|
1545
|
+
exceptions: AvailabilityExceptionNonNullableFields[];
|
|
1546
|
+
asapHandlingAvailable: boolean;
|
|
1547
|
+
}
|
|
1548
|
+
interface FulfillmentOptionNonNullableFields {
|
|
1549
|
+
maxTimeOptions: number;
|
|
1550
|
+
durationRangeOptions?: DurationRangeNonNullableFields;
|
|
1551
|
+
timeWindowsOptions?: TimeWindowDisplayConfigNonNullableFields;
|
|
1552
|
+
pickupOptions?: PickupDetailsNonNullableFields;
|
|
1553
|
+
type: FulfillmentType;
|
|
1554
|
+
availability?: FulfillmentOptionAvailabilityNonNullableFields;
|
|
1555
|
+
fulfillmentTimeType: FulfillmentTimeType;
|
|
1556
|
+
fulfillmentTimesDisplayType: FulfillmentTimesDisplayType;
|
|
1557
|
+
}
|
|
1558
|
+
export interface ListAvailableFulfillmentOptionsResponseNonNullableFields {
|
|
1559
|
+
pickupConfigured: boolean;
|
|
1560
|
+
deliveryConfigured: boolean;
|
|
1561
|
+
fulfillmentOptions: FulfillmentOptionNonNullableFields[];
|
|
1562
|
+
}
|
|
1563
|
+
interface FulfillmentDetailsNonNullableFields {
|
|
1564
|
+
maxTimeOptions: number;
|
|
1565
|
+
durationRangeOptions?: DurationRangeNonNullableFields;
|
|
1566
|
+
fulfillmentTimeType: FulfillmentTimeType;
|
|
1567
|
+
}
|
|
1568
|
+
interface FulfillmentAddressNonNullableFields {
|
|
1569
|
+
address?: CommonAddressNonNullableFields;
|
|
1570
|
+
}
|
|
1571
|
+
interface FulfillmentTimeSlotNonNullableFields {
|
|
1572
|
+
fulfilmentType: FulfillmentType;
|
|
1573
|
+
startsNow: boolean;
|
|
1574
|
+
fulfillmentDetails: FulfillmentDetailsNonNullableFields[];
|
|
1575
|
+
fulfillmentAddress?: FulfillmentAddressNonNullableFields;
|
|
1576
|
+
}
|
|
1577
|
+
export interface ListFirstAvailableTimeSlotForFulfillmentTypesResponseNonNullableFields {
|
|
1578
|
+
timeSlots: FulfillmentTimeSlotNonNullableFields[];
|
|
1579
|
+
}
|
|
1580
|
+
interface OperationTimeSlotNonNullableFields {
|
|
1581
|
+
operationId: string;
|
|
1582
|
+
timeSlots: FulfillmentTimeSlotNonNullableFields[];
|
|
1583
|
+
}
|
|
1584
|
+
export interface ListFirstAvailableTimeSlotsForOperationsResponseNonNullableFields {
|
|
1585
|
+
timeSlots: OperationTimeSlotNonNullableFields[];
|
|
1586
|
+
}
|
|
1587
|
+
interface FirstFulfillmentTimeSlotsPerMenuNonNullableFields {
|
|
1588
|
+
timeslotsPerFulfillmentType: FulfillmentTimeSlotNonNullableFields[];
|
|
1589
|
+
}
|
|
1590
|
+
export interface ListFirstAvailableTimeSlotsForMenusResponseNonNullableFields {
|
|
1591
|
+
timeSlotsPerMenu: FirstFulfillmentTimeSlotsPerMenuNonNullableFields[];
|
|
1592
|
+
}
|
|
1593
|
+
export interface ListAvailableTimeSlotsForDateResponseNonNullableFields {
|
|
1594
|
+
timeSlots: FulfillmentTimeSlotNonNullableFields[];
|
|
1595
|
+
}
|
|
1596
|
+
interface _DateNonNullableFields {
|
|
1597
|
+
day: number;
|
|
1598
|
+
month: number;
|
|
1599
|
+
year: number;
|
|
1600
|
+
}
|
|
1601
|
+
interface FulfillmentTypeAvailableDatesNonNullableFields {
|
|
1602
|
+
fulfilmentType: FulfillmentType;
|
|
1603
|
+
dates: _DateNonNullableFields[];
|
|
1604
|
+
}
|
|
1605
|
+
export interface ListAvailableDatesInRangeResponseNonNullableFields {
|
|
1606
|
+
availableDates: FulfillmentTypeAvailableDatesNonNullableFields[];
|
|
1607
|
+
}
|
|
1608
|
+
export interface BaseEventMetadata {
|
|
1609
|
+
/** App instance ID. */
|
|
1610
|
+
instanceId?: string | null;
|
|
1611
|
+
/** Event type. */
|
|
1612
|
+
eventType?: string;
|
|
1613
|
+
/** The identification type and identity data. */
|
|
1614
|
+
identity?: IdentificationData;
|
|
1615
|
+
}
|
|
1616
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
1617
|
+
/**
|
|
1618
|
+
* Unique event ID.
|
|
1619
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1620
|
+
*/
|
|
1621
|
+
_id?: string;
|
|
1622
|
+
/**
|
|
1623
|
+
* Assumes actions are also always typed to an entity_type
|
|
1624
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1625
|
+
*/
|
|
1626
|
+
entityFqdn?: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1629
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1630
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1631
|
+
*/
|
|
1632
|
+
slug?: string;
|
|
1633
|
+
/** ID of the entity associated with the event. */
|
|
1634
|
+
entityId?: string;
|
|
1635
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1636
|
+
eventTime?: Date | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1639
|
+
* (for example, GDPR).
|
|
1640
|
+
*/
|
|
1641
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1642
|
+
/** If present, indicates the action that triggered the event. */
|
|
1643
|
+
originatedFrom?: string | null;
|
|
1644
|
+
/**
|
|
1645
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1646
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1647
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1648
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1649
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1650
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1651
|
+
*/
|
|
1652
|
+
entityEventSequence?: string | null;
|
|
1653
|
+
}
|
|
1654
|
+
export interface OperationCreatedEnvelope {
|
|
1655
|
+
entity: Operation;
|
|
1656
|
+
metadata: EventMetadata;
|
|
1657
|
+
}
|
|
1658
|
+
/**
|
|
1659
|
+
* Triggered when an operation is created.
|
|
1660
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1661
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1662
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1663
|
+
* @webhook
|
|
1664
|
+
* @eventType wix.restaurants.operations.v1.operation_created
|
|
1665
|
+
* @documentationMaturity preview
|
|
1666
|
+
*/
|
|
1667
|
+
export declare function onOperationCreated(handler: (event: OperationCreatedEnvelope) => void | Promise<void>): void;
|
|
1668
|
+
export interface OperationDeletedEnvelope {
|
|
1669
|
+
entity: Operation;
|
|
1670
|
+
metadata: EventMetadata;
|
|
1671
|
+
}
|
|
1672
|
+
/**
|
|
1673
|
+
* Triggered when an operation is deleted.
|
|
1674
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1675
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1676
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1677
|
+
* @webhook
|
|
1678
|
+
* @eventType wix.restaurants.operations.v1.operation_deleted
|
|
1679
|
+
* @documentationMaturity preview
|
|
1680
|
+
*/
|
|
1681
|
+
export declare function onOperationDeleted(handler: (event: OperationDeletedEnvelope) => void | Promise<void>): void;
|
|
1682
|
+
export interface OperationUpdatedEnvelope {
|
|
1683
|
+
entity: Operation;
|
|
1684
|
+
metadata: EventMetadata;
|
|
1685
|
+
}
|
|
1686
|
+
/**
|
|
1687
|
+
* Triggered when an operation is updated.
|
|
1688
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1689
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1690
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1691
|
+
* @webhook
|
|
1692
|
+
* @eventType wix.restaurants.operations.v1.operation_updated
|
|
1693
|
+
* @documentationMaturity preview
|
|
1694
|
+
*/
|
|
1695
|
+
export declare function onOperationUpdated(handler: (event: OperationUpdatedEnvelope) => void | Promise<void>): void;
|
|
1696
|
+
/**
|
|
1697
|
+
* Creates a new operation.
|
|
1698
|
+
* @param operation - Operation to create.
|
|
1699
|
+
* @public
|
|
1700
|
+
* @documentationMaturity preview
|
|
1701
|
+
* @requiredField operation
|
|
1702
|
+
* @permissionId RESTAURANTS.OPERATION_CREATE
|
|
1703
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1704
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1705
|
+
* @applicableIdentity APP
|
|
1706
|
+
* @returns Created operation.
|
|
1707
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.CreateOperation
|
|
1708
|
+
*/
|
|
1709
|
+
export declare function createOperation(operation: Operation): Promise<Operation & OperationNonNullableFields>;
|
|
1710
|
+
/**
|
|
1711
|
+
* Retrieves an operation.
|
|
1712
|
+
* @param operationId - ID of the operation to retrieve.
|
|
1713
|
+
* @public
|
|
1714
|
+
* @documentationMaturity preview
|
|
1715
|
+
* @requiredField operationId
|
|
1716
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1717
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1718
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1719
|
+
* @applicableIdentity APP
|
|
1720
|
+
* @applicableIdentity VISITOR
|
|
1721
|
+
* @returns Retrieved operation.
|
|
1722
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.GetOperation
|
|
1723
|
+
*/
|
|
1724
|
+
export declare function getOperation(operationId: string): Promise<Operation & OperationNonNullableFields>;
|
|
1725
|
+
/**
|
|
1726
|
+
* Updates an operation.
|
|
1727
|
+
*
|
|
1728
|
+
* If you update part of the `orderScheduling` property, the whole object is overwritten,
|
|
1729
|
+
* so you must include the entire object unless you are not updating `orderScheduling` at all. <br />
|
|
1730
|
+
*
|
|
1731
|
+
* Each time the operation is updated,
|
|
1732
|
+
* `revision` increments by 1.
|
|
1733
|
+
* The current `revision` must be passed when updating the operation.
|
|
1734
|
+
* This ensures you're working with the latest operation
|
|
1735
|
+
* and prevents unintended overwrites.
|
|
1736
|
+
* @param _id - Operation ID.
|
|
1737
|
+
* @public
|
|
1738
|
+
* @documentationMaturity preview
|
|
1739
|
+
* @requiredField _id
|
|
1740
|
+
* @requiredField operation
|
|
1741
|
+
* @requiredField operation.revision
|
|
1742
|
+
* @permissionId RESTAURANTS.OPERATION_UPDATE
|
|
1743
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1744
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1745
|
+
* @applicableIdentity APP
|
|
1746
|
+
* @returns Updated operation.
|
|
1747
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.UpdateOperation
|
|
1748
|
+
*/
|
|
1749
|
+
export declare function updateOperation(_id: string | null, operation: UpdateOperation): Promise<Operation & OperationNonNullableFields>;
|
|
1750
|
+
export interface UpdateOperation {
|
|
1751
|
+
/** Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`. */
|
|
1752
|
+
pausedUntilOptions?: OnlineOrderingPausedUntilOptions;
|
|
1753
|
+
/**
|
|
1754
|
+
* Operation ID.
|
|
1755
|
+
* @readonly
|
|
1756
|
+
*/
|
|
1757
|
+
_id?: string | null;
|
|
1758
|
+
/**
|
|
1759
|
+
* Revision number. Increments by 1 each time the operation is updated.
|
|
1760
|
+
* To prevent conflicting changes,
|
|
1761
|
+
* the existing `revision` must be specified when updating an operation.
|
|
1762
|
+
* @readonly
|
|
1763
|
+
*/
|
|
1764
|
+
revision?: string | null;
|
|
1765
|
+
/**
|
|
1766
|
+
* Date and time the operation was created.
|
|
1767
|
+
* @readonly
|
|
1768
|
+
*/
|
|
1769
|
+
_createdDate?: Date | null;
|
|
1770
|
+
/**
|
|
1771
|
+
* Date and time the operation was updated.
|
|
1772
|
+
* @readonly
|
|
1773
|
+
*/
|
|
1774
|
+
_updatedDate?: Date | null;
|
|
1775
|
+
/** Operation name. */
|
|
1776
|
+
name?: string | null;
|
|
1777
|
+
/**
|
|
1778
|
+
* Whether the operation is the default operation. <br />
|
|
1779
|
+
* Default: `false`.
|
|
1780
|
+
*/
|
|
1781
|
+
default?: boolean | null;
|
|
1782
|
+
/** IDs of the fulfillment methods ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/fulfillment-methods/introduction) | [REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/fulfillment-methods/introduction)) associated with the operation. */
|
|
1783
|
+
fulfillmentIds?: string[] | null;
|
|
1784
|
+
/** Online ordering status of the operation. <br /> */
|
|
1785
|
+
onlineOrderingStatus?: OnlineOrderingStatusType;
|
|
1786
|
+
/**
|
|
1787
|
+
* IDs of the service fee rules ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/service-fees/introduction) | [REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/introduction)) associated with the operation.
|
|
1788
|
+
* @deprecated
|
|
1789
|
+
* @targetRemovalDate 2024-11-30
|
|
1790
|
+
*/
|
|
1791
|
+
serviceFeeRuleIds?: string[] | null;
|
|
1792
|
+
/** Default fulfillment type of the operation. */
|
|
1793
|
+
defaultFulfillmentType?: FulfillmentType;
|
|
1794
|
+
/** Information about when an order can be placed for. */
|
|
1795
|
+
orderScheduling?: OrderScheduling;
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* Deletes an operation.
|
|
1799
|
+
* @param operationId - ID of the operation to delete.
|
|
1800
|
+
* @public
|
|
1801
|
+
* @documentationMaturity preview
|
|
1802
|
+
* @requiredField operationId
|
|
1803
|
+
* @permissionId RESTAURANTS.OPERATION_DELETE
|
|
1804
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1805
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1806
|
+
* @applicableIdentity APP
|
|
1807
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.DeleteOperation
|
|
1808
|
+
*/
|
|
1809
|
+
export declare function deleteOperation(operationId: string): Promise<void>;
|
|
1810
|
+
/**
|
|
1811
|
+
* Creates a query to retrieve a list of operations.
|
|
1812
|
+
*
|
|
1813
|
+
* The `queryOperations()` function builds a query to retrieve a list of operations and returns an `OperationsQueryBuilder` object.
|
|
1814
|
+
*
|
|
1815
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](/operations/operations-query-builder/find) function.
|
|
1816
|
+
*
|
|
1817
|
+
* You can refine the query by chaining `OperationsQueryBuilder` functions onto the query. `OperationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryOperations()` returns.
|
|
1818
|
+
*
|
|
1819
|
+
* `queryOperations()` runs with the following `OperationsQueryBuilder` defaults, which you can override:
|
|
1820
|
+
*
|
|
1821
|
+
* * [`limit(50)`](/operations/operations-query-builder/limit)
|
|
1822
|
+
* * [`ascending('entityId')`](/operations/operations-methods-query-builder/ascending)
|
|
1823
|
+
*
|
|
1824
|
+
* The following `OperationsQueryBuilder` functions are supported for `queryOperations()`. For a full description of the operations object, see the object returned for the [`items`](/operations/operations-query-result/items) property in `OperationsQueryResult`.
|
|
1825
|
+
* @public
|
|
1826
|
+
* @documentationMaturity preview
|
|
1827
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1828
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1829
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1830
|
+
* @applicableIdentity APP
|
|
1831
|
+
* @applicableIdentity VISITOR
|
|
1832
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.QueryOperation
|
|
1833
|
+
*/
|
|
1834
|
+
export declare function queryOperation(): OperationsQueryBuilder;
|
|
1835
|
+
interface QueryCursorResult {
|
|
1836
|
+
cursors: Cursors;
|
|
1837
|
+
hasNext: () => boolean;
|
|
1838
|
+
hasPrev: () => boolean;
|
|
1839
|
+
length: number;
|
|
1840
|
+
pageSize: number;
|
|
1841
|
+
}
|
|
1842
|
+
export interface OperationsQueryResult extends QueryCursorResult {
|
|
1843
|
+
items: Operation[];
|
|
1844
|
+
query: OperationsQueryBuilder;
|
|
1845
|
+
next: () => Promise<OperationsQueryResult>;
|
|
1846
|
+
prev: () => Promise<OperationsQueryResult>;
|
|
1847
|
+
}
|
|
1848
|
+
export interface OperationsQueryBuilder {
|
|
1849
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1850
|
+
* @param value - Value to compare against.
|
|
1851
|
+
* @documentationMaturity preview
|
|
1852
|
+
*/
|
|
1853
|
+
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType', value: any) => OperationsQueryBuilder;
|
|
1854
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1855
|
+
* @param value - Value to compare against.
|
|
1856
|
+
* @documentationMaturity preview
|
|
1857
|
+
*/
|
|
1858
|
+
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType', value: any) => OperationsQueryBuilder;
|
|
1859
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1860
|
+
* @param value - Value to compare against.
|
|
1861
|
+
* @documentationMaturity preview
|
|
1862
|
+
*/
|
|
1863
|
+
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationsQueryBuilder;
|
|
1864
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1865
|
+
* @param value - Value to compare against.
|
|
1866
|
+
* @documentationMaturity preview
|
|
1867
|
+
*/
|
|
1868
|
+
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationsQueryBuilder;
|
|
1869
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1870
|
+
* @param value - Value to compare against.
|
|
1871
|
+
* @documentationMaturity preview
|
|
1872
|
+
*/
|
|
1873
|
+
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationsQueryBuilder;
|
|
1874
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1875
|
+
* @param value - Value to compare against.
|
|
1876
|
+
* @documentationMaturity preview
|
|
1877
|
+
*/
|
|
1878
|
+
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationsQueryBuilder;
|
|
1879
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
1880
|
+
* @param string - String to compare against. Case-insensitive.
|
|
1881
|
+
* @documentationMaturity preview
|
|
1882
|
+
*/
|
|
1883
|
+
startsWith: (propertyName: '_id' | 'name', value: string) => OperationsQueryBuilder;
|
|
1884
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1885
|
+
* @param values - List of values to compare against.
|
|
1886
|
+
* @documentationMaturity preview
|
|
1887
|
+
*/
|
|
1888
|
+
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType', value: any[]) => OperationsQueryBuilder;
|
|
1889
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1890
|
+
* @param values - List of values to compare against.
|
|
1891
|
+
* @documentationMaturity preview
|
|
1892
|
+
*/
|
|
1893
|
+
hasAll: (propertyName: 'fulfillmentIds' | 'serviceFeeRuleIds', value: any[]) => OperationsQueryBuilder;
|
|
1894
|
+
/** @documentationMaturity preview */
|
|
1895
|
+
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType', value: any) => OperationsQueryBuilder;
|
|
1896
|
+
/** @documentationMaturity preview */
|
|
1897
|
+
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType', value: boolean) => OperationsQueryBuilder;
|
|
1898
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1899
|
+
* @documentationMaturity preview
|
|
1900
|
+
*/
|
|
1901
|
+
ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'profileId' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType'>) => OperationsQueryBuilder;
|
|
1902
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1903
|
+
* @documentationMaturity preview
|
|
1904
|
+
*/
|
|
1905
|
+
descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'profileId' | 'default' | 'fulfillmentIds' | 'onlineOrderingStatus' | 'serviceFeeRuleIds' | 'defaultFulfillmentType'>) => OperationsQueryBuilder;
|
|
1906
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1907
|
+
* @documentationMaturity preview
|
|
1908
|
+
*/
|
|
1909
|
+
limit: (limit: number) => OperationsQueryBuilder;
|
|
1910
|
+
/** @param cursor - A pointer to specific record
|
|
1911
|
+
* @documentationMaturity preview
|
|
1912
|
+
*/
|
|
1913
|
+
skipTo: (cursor: string) => OperationsQueryBuilder;
|
|
1914
|
+
/** @documentationMaturity preview */
|
|
1915
|
+
find: () => Promise<OperationsQueryResult>;
|
|
1916
|
+
}
|
|
1917
|
+
/**
|
|
1918
|
+
* Retrieves a list of operations.
|
|
1919
|
+
* The result will be sorted by created date in ascending order.
|
|
1920
|
+
* @public
|
|
1921
|
+
* @documentationMaturity preview
|
|
1922
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1923
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1924
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1925
|
+
* @applicableIdentity APP
|
|
1926
|
+
* @applicableIdentity VISITOR
|
|
1927
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListOperations
|
|
1928
|
+
*/
|
|
1929
|
+
export declare function listOperations(): Promise<ListOperationsResponse & ListOperationsResponseNonNullableFields>;
|
|
1930
|
+
/**
|
|
1931
|
+
* Retrieves a list of available fulfillment options.
|
|
1932
|
+
*
|
|
1933
|
+
* What makes a fulfillment option available is whether you can submit an order given the scheduling configurations and the fulfillment method's availability.
|
|
1934
|
+
* When a delivery address is not provided in the input, our system retrieves a list encompassing all types of fulfillment methods.
|
|
1935
|
+
* Conversely, if a delivery address` is given, the response may includes non-delivery fulfillment options along with delivery fulfillment methods that are applicable to the given address, ensuring the address falls within the defined delivery area of these methods.
|
|
1936
|
+
* @param operationId - Operation ID. Returned fulfillment options will belong to this operation.
|
|
1937
|
+
* @public
|
|
1938
|
+
* @documentationMaturity preview
|
|
1939
|
+
* @requiredField operationId
|
|
1940
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1941
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1942
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1943
|
+
* @applicableIdentity APP
|
|
1944
|
+
* @applicableIdentity VISITOR
|
|
1945
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListAvailableFulfillmentOptions
|
|
1946
|
+
*/
|
|
1947
|
+
export declare function listAvailableFulfillmentOptions(operationId: string, options?: ListAvailableFulfillmentOptions): Promise<ListAvailableFulfillmentOptionsResponse & ListAvailableFulfillmentOptionsResponseNonNullableFields>;
|
|
1948
|
+
export interface ListAvailableFulfillmentOptions {
|
|
1949
|
+
/**
|
|
1950
|
+
* Delivery address. Optional.
|
|
1951
|
+
*
|
|
1952
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
1953
|
+
*/
|
|
1954
|
+
deliveryAddress?: CommonAddress;
|
|
1955
|
+
}
|
|
1956
|
+
/**
|
|
1957
|
+
* Retrieves a list of available time slots for each fulfillment type.
|
|
1958
|
+
*
|
|
1959
|
+
* Each time slot is the first available time slot for the given fulfillment type.
|
|
1960
|
+
* @param operationId - Operation ID.
|
|
1961
|
+
* Returned fulfillment options will belong to this operation.
|
|
1962
|
+
* @public
|
|
1963
|
+
* @documentationMaturity preview
|
|
1964
|
+
* @requiredField operationId
|
|
1965
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1966
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1967
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1968
|
+
* @applicableIdentity APP
|
|
1969
|
+
* @applicableIdentity VISITOR
|
|
1970
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListFirstAvailableTimeSlotForFulfillmentTypes
|
|
1971
|
+
*/
|
|
1972
|
+
export declare function listFirstAvailableTimeSlotForFulfillmentTypes(operationId: string, options?: ListFirstAvailableTimeSlotForFulfillmentTypesOptions): Promise<ListFirstAvailableTimeSlotForFulfillmentTypesResponse & ListFirstAvailableTimeSlotForFulfillmentTypesResponseNonNullableFields>;
|
|
1973
|
+
export interface ListFirstAvailableTimeSlotForFulfillmentTypesOptions {
|
|
1974
|
+
/**
|
|
1975
|
+
* Delivery address. Optional.
|
|
1976
|
+
*
|
|
1977
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
1978
|
+
*/
|
|
1979
|
+
deliveryAddress?: CommonAddress;
|
|
1980
|
+
}
|
|
1981
|
+
/**
|
|
1982
|
+
* Retrieves a list of available time slots for each fulfillment type.
|
|
1983
|
+
*
|
|
1984
|
+
* Each time slot is the first available time slot for the given fulfillment type.
|
|
1985
|
+
* @param operationIds - Operation ID.
|
|
1986
|
+
* Returned fulfillment options will belong to this operation.
|
|
1987
|
+
* @public
|
|
1988
|
+
* @documentationMaturity preview
|
|
1989
|
+
* @requiredField operationIds
|
|
1990
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
1991
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1992
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1993
|
+
* @applicableIdentity APP
|
|
1994
|
+
* @applicableIdentity VISITOR
|
|
1995
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListFirstAvailableTimeSlotsForOperations
|
|
1996
|
+
*/
|
|
1997
|
+
export declare function listFirstAvailableTimeSlotsForOperations(operationIds: string[], options?: ListFirstAvailableTimeSlotsForOperationsOptions): Promise<ListFirstAvailableTimeSlotsForOperationsResponse & ListFirstAvailableTimeSlotsForOperationsResponseNonNullableFields>;
|
|
1998
|
+
export interface ListFirstAvailableTimeSlotsForOperationsOptions {
|
|
1999
|
+
/**
|
|
2000
|
+
* Delivery address. Optional.
|
|
2001
|
+
*
|
|
2002
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
2003
|
+
*/
|
|
2004
|
+
deliveryAddress?: CommonAddress;
|
|
2005
|
+
}
|
|
2006
|
+
/**
|
|
2007
|
+
* For each menu, retrieves the first available time slots for each fulfillment type.
|
|
2008
|
+
* @param operationId - Operation ID.
|
|
2009
|
+
* Returned timeslots that are belong to this operation.
|
|
2010
|
+
* @public
|
|
2011
|
+
* @documentationMaturity preview
|
|
2012
|
+
* @requiredField operationId
|
|
2013
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
2014
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2015
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2016
|
+
* @applicableIdentity APP
|
|
2017
|
+
* @applicableIdentity VISITOR
|
|
2018
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListFirstAvailableTimeSlotsForMenus
|
|
2019
|
+
*/
|
|
2020
|
+
export declare function listFirstAvailableTimeSlotsForMenus(operationId: string | null, options?: ListFirstAvailableTimeSlotsForMenusOptions): Promise<ListFirstAvailableTimeSlotsForMenusResponse & ListFirstAvailableTimeSlotsForMenusResponseNonNullableFields>;
|
|
2021
|
+
export interface ListFirstAvailableTimeSlotsForMenusOptions {
|
|
2022
|
+
/**
|
|
2023
|
+
* Delivery address. Optional.
|
|
2024
|
+
*
|
|
2025
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
2026
|
+
*/
|
|
2027
|
+
deliveryAddress?: CommonAddress;
|
|
2028
|
+
/** Cursor paging */
|
|
2029
|
+
cursorPaging?: CursorPaging;
|
|
2030
|
+
}
|
|
2031
|
+
/**
|
|
2032
|
+
* Retrieves a list of the available time slots for a given date.
|
|
2033
|
+
* @param operationId - Operation ID.
|
|
2034
|
+
* The returned fulfillment options will belong to this operation.
|
|
2035
|
+
* @public
|
|
2036
|
+
* @documentationMaturity preview
|
|
2037
|
+
* @requiredField operationId
|
|
2038
|
+
* @requiredField options.date
|
|
2039
|
+
* @requiredField options.date.day
|
|
2040
|
+
* @requiredField options.date.month
|
|
2041
|
+
* @requiredField options.date.year
|
|
2042
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
2043
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2044
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2045
|
+
* @applicableIdentity APP
|
|
2046
|
+
* @applicableIdentity VISITOR
|
|
2047
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListAvailableTimeSlotsForDate
|
|
2048
|
+
*/
|
|
2049
|
+
export declare function listAvailableTimeSlotsForDate(operationId: string, options?: ListAvailableTimeSlotsForDateOptions): Promise<ListAvailableTimeSlotsForDateResponse & ListAvailableTimeSlotsForDateResponseNonNullableFields>;
|
|
2050
|
+
export interface ListAvailableTimeSlotsForDateOptions {
|
|
2051
|
+
/**
|
|
2052
|
+
* Delivery address. Optional.
|
|
2053
|
+
*
|
|
2054
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
2055
|
+
*/
|
|
2056
|
+
deliveryAddress?: CommonAddress;
|
|
2057
|
+
/** Date and time to get the available time slots for. */
|
|
2058
|
+
date: _Date;
|
|
2059
|
+
}
|
|
2060
|
+
/**
|
|
2061
|
+
* Retrieves a list of the available dates in a given time range.
|
|
2062
|
+
*
|
|
2063
|
+
* A date is considered available if it has at least one available time slot.
|
|
2064
|
+
* @param operationId - Operation ID.
|
|
2065
|
+
* The returned fulfillment options will belong to this operation.
|
|
2066
|
+
* @public
|
|
2067
|
+
* @documentationMaturity preview
|
|
2068
|
+
* @requiredField operationId
|
|
2069
|
+
* @requiredField options.from
|
|
2070
|
+
* @requiredField options.until
|
|
2071
|
+
* @permissionId RESTAURANTS.OPERATION_READ
|
|
2072
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
2073
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2074
|
+
* @applicableIdentity APP
|
|
2075
|
+
* @applicableIdentity VISITOR
|
|
2076
|
+
* @fqn wix.restaurants.operations.v1.OperationsService.ListAvailableDatesInRange
|
|
2077
|
+
*/
|
|
2078
|
+
export declare function listAvailableDatesInRange(operationId: string, options?: ListAvailableDatesInRangeOptions): Promise<ListAvailableDatesInRangeResponse & ListAvailableDatesInRangeResponseNonNullableFields>;
|
|
2079
|
+
export interface ListAvailableDatesInRangeOptions {
|
|
2080
|
+
/**
|
|
2081
|
+
* Delivery address. Optional.
|
|
2082
|
+
*
|
|
2083
|
+
* If provided, the returned delivery fulfillment options will be able to deliver to this address.
|
|
2084
|
+
*/
|
|
2085
|
+
deliveryAddress?: CommonAddress;
|
|
2086
|
+
/** Start date and time of the range. */
|
|
2087
|
+
from: _Date;
|
|
2088
|
+
/** End date and time of the range. */
|
|
2089
|
+
until: _Date;
|
|
2090
|
+
}
|
|
2091
|
+
export {};
|