@wix/auto_sdk_ecom_local-delivery-options 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/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +24 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +621 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +239 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +79 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +560 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +59 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1011 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +771 -0
- package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.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/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +15 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +607 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +202 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +59 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +560 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +56 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1011 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +734 -0
- package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.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/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +24 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +621 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +239 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +79 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +560 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +59 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1011 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +771 -0
- package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.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/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +15 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +607 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +202 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +59 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +560 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +56 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1011 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +734 -0
- package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts
ADDED
|
@@ -0,0 +1,1011 @@
|
|
|
1
|
+
export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
|
|
2
|
+
zipConfig?: ZipCodeConfig;
|
|
3
|
+
radiusConfig?: RadiusConfig;
|
|
4
|
+
customAreaConfig?: CustomAreaConfig;
|
|
5
|
+
/**
|
|
6
|
+
* LocalDeliveryOptionId - unique identifier of local delivery option
|
|
7
|
+
* @readonly
|
|
8
|
+
*/
|
|
9
|
+
_id?: string | null;
|
|
10
|
+
/** Area name of Local Delivery Option */
|
|
11
|
+
areaName?: string | null;
|
|
12
|
+
/**
|
|
13
|
+
* Flat price of local delivery
|
|
14
|
+
* @deprecated Flat price of local delivery
|
|
15
|
+
* @targetRemovalDate 2025-01-12
|
|
16
|
+
*/
|
|
17
|
+
rate?: string | null;
|
|
18
|
+
/** Estimated delivery time description text */
|
|
19
|
+
estimatedDeliveryTime?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* Minimum order total to be eligible for free delivery
|
|
22
|
+
* @deprecated Minimum order total to be eligible for free delivery
|
|
23
|
+
* @targetRemovalDate 2025-01-12
|
|
24
|
+
*/
|
|
25
|
+
minimumFreeDeliveryOrderAmount?: number | null;
|
|
26
|
+
/** List of countries with subdivisions */
|
|
27
|
+
destinations?: Destination[];
|
|
28
|
+
/**
|
|
29
|
+
* Database revision of LocalDeliveryOption entity. Incremented on each modification
|
|
30
|
+
* @readonly
|
|
31
|
+
*/
|
|
32
|
+
revision?: string | null;
|
|
33
|
+
scheduledDeliveryConfig?: ScheduledDelivery;
|
|
34
|
+
/** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */
|
|
35
|
+
rates?: ConditionalRates[];
|
|
36
|
+
/**
|
|
37
|
+
* Date and time the LocalDeliveryOption was created.
|
|
38
|
+
* @readonly
|
|
39
|
+
*/
|
|
40
|
+
_createdDate?: Date | null;
|
|
41
|
+
/**
|
|
42
|
+
* Date and time the LocalDeliveryOption was last updated.
|
|
43
|
+
* @readonly
|
|
44
|
+
*/
|
|
45
|
+
_updatedDate?: Date | null;
|
|
46
|
+
/** This local delivery is active for the following delivery regions. */
|
|
47
|
+
deliveryRegionIds?: string[];
|
|
48
|
+
}
|
|
49
|
+
/** @oneof */
|
|
50
|
+
export interface LocalDeliveryOptionConfigOneOf {
|
|
51
|
+
zipConfig?: ZipCodeConfig;
|
|
52
|
+
radiusConfig?: RadiusConfig;
|
|
53
|
+
customAreaConfig?: CustomAreaConfig;
|
|
54
|
+
}
|
|
55
|
+
export interface Destination {
|
|
56
|
+
/** Country ISO code */
|
|
57
|
+
code?: string;
|
|
58
|
+
/** List of subdivisions, empty means all */
|
|
59
|
+
subdivisions?: string[];
|
|
60
|
+
}
|
|
61
|
+
export interface ZipCodeConfig {
|
|
62
|
+
/** List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000* */
|
|
63
|
+
zipCodes?: string[];
|
|
64
|
+
}
|
|
65
|
+
export interface RadiusConfig {
|
|
66
|
+
/** Delivery-from address */
|
|
67
|
+
address?: LocalDeliveryAddress;
|
|
68
|
+
/** Delivery circle's radius */
|
|
69
|
+
radius?: number;
|
|
70
|
+
/**
|
|
71
|
+
* Radius' unit, taken from site properties
|
|
72
|
+
* @readonly
|
|
73
|
+
*/
|
|
74
|
+
lengthUnit?: LengthUnit;
|
|
75
|
+
}
|
|
76
|
+
export interface LocalDeliveryAddress {
|
|
77
|
+
/** A string containing the human-readable address of this location */
|
|
78
|
+
formatted?: string | null;
|
|
79
|
+
/** coordinates of the physical address */
|
|
80
|
+
location?: AddressLocation;
|
|
81
|
+
}
|
|
82
|
+
export interface AddressLocation {
|
|
83
|
+
/** Address latitude. */
|
|
84
|
+
latitude?: number | null;
|
|
85
|
+
/** Address longitude. */
|
|
86
|
+
longitude?: number | null;
|
|
87
|
+
}
|
|
88
|
+
export declare enum LengthUnit {
|
|
89
|
+
/** Length unit can't be classified, due to an error */
|
|
90
|
+
UNSPECIFIED_LENGTH_UNIT = "UNSPECIFIED_LENGTH_UNIT",
|
|
91
|
+
/** Kilometers */
|
|
92
|
+
KM = "KM",
|
|
93
|
+
/** Miles */
|
|
94
|
+
MI = "MI"
|
|
95
|
+
}
|
|
96
|
+
export interface CustomAreaConfig {
|
|
97
|
+
/** Geocodes of the polygon defining the delivery area. */
|
|
98
|
+
geocodes?: AddressLocation[];
|
|
99
|
+
}
|
|
100
|
+
export interface ScheduledDelivery {
|
|
101
|
+
/**
|
|
102
|
+
* Days config which contain days when delivery is enabled with it's time slots
|
|
103
|
+
* @deprecated Days config which contain days when delivery is enabled with it's time slots
|
|
104
|
+
* @replacedBy time_windows
|
|
105
|
+
* @targetRemovalDate 2025-01-01
|
|
106
|
+
*/
|
|
107
|
+
days?: Days;
|
|
108
|
+
/** Amount of days before first delivery option date */
|
|
109
|
+
handlingDays?: number | null;
|
|
110
|
+
/** Cut off time after which first delivery option would be for next day */
|
|
111
|
+
cutOffTime?: TimePoint;
|
|
112
|
+
/** availability times configuration. */
|
|
113
|
+
timeWindows?: TimeWindow[];
|
|
114
|
+
}
|
|
115
|
+
export interface Days {
|
|
116
|
+
monday?: DaySlot;
|
|
117
|
+
tuesday?: DaySlot;
|
|
118
|
+
wednesday?: DaySlot;
|
|
119
|
+
thursday?: DaySlot;
|
|
120
|
+
friday?: DaySlot;
|
|
121
|
+
saturday?: DaySlot;
|
|
122
|
+
sunday?: DaySlot;
|
|
123
|
+
}
|
|
124
|
+
export interface DaySlot {
|
|
125
|
+
/** Shows whether this day slot is enabled for delivery */
|
|
126
|
+
enabledForDelivery?: boolean | null;
|
|
127
|
+
/** Time slots for scheduled delivery during day */
|
|
128
|
+
timeSlots?: TimeSlot[];
|
|
129
|
+
}
|
|
130
|
+
export interface TimeSlot {
|
|
131
|
+
/** Starting time point of time slot */
|
|
132
|
+
from?: TimePoint;
|
|
133
|
+
/** End time point of time slot */
|
|
134
|
+
to?: TimePoint;
|
|
135
|
+
}
|
|
136
|
+
export interface TimePoint {
|
|
137
|
+
/** Hours in format 0-23 */
|
|
138
|
+
hours?: number | null;
|
|
139
|
+
/** Minutes 0-59 */
|
|
140
|
+
minutes?: number | null;
|
|
141
|
+
}
|
|
142
|
+
export interface TimeWindow {
|
|
143
|
+
/** The day of week this availability relates to. */
|
|
144
|
+
day?: DayOfWeek;
|
|
145
|
+
/** The start time in time of day representation. */
|
|
146
|
+
start?: TimeOfDay;
|
|
147
|
+
/** The end time in time of day representation. */
|
|
148
|
+
end?: TimeOfDay;
|
|
149
|
+
/** Whether this timeWindow availability is enabled. */
|
|
150
|
+
enabled?: boolean | null;
|
|
151
|
+
}
|
|
152
|
+
export declare enum DayOfWeek {
|
|
153
|
+
/** Monday. */
|
|
154
|
+
MON = "MON",
|
|
155
|
+
/** Tuesday. */
|
|
156
|
+
TUE = "TUE",
|
|
157
|
+
/** Wednesday. */
|
|
158
|
+
WED = "WED",
|
|
159
|
+
/** Thursday. */
|
|
160
|
+
THU = "THU",
|
|
161
|
+
/** Friday. */
|
|
162
|
+
FRI = "FRI",
|
|
163
|
+
/** Saturday. */
|
|
164
|
+
SAT = "SAT",
|
|
165
|
+
/** Sunday. */
|
|
166
|
+
SUN = "SUN"
|
|
167
|
+
}
|
|
168
|
+
export interface TimeOfDay {
|
|
169
|
+
/** Hours */
|
|
170
|
+
hours?: number;
|
|
171
|
+
/** Minutes */
|
|
172
|
+
minutes?: number;
|
|
173
|
+
}
|
|
174
|
+
export interface ConditionalRates {
|
|
175
|
+
/**
|
|
176
|
+
* there is an AND logic between all the conditions. Empty conditions means true.
|
|
177
|
+
* For example: weight > 0 and weight <= 10
|
|
178
|
+
*/
|
|
179
|
+
conditions?: Condition[];
|
|
180
|
+
amount?: string;
|
|
181
|
+
}
|
|
182
|
+
export interface Condition {
|
|
183
|
+
type?: ConditionType;
|
|
184
|
+
/**
|
|
185
|
+
* The value in respective to the condition type
|
|
186
|
+
* Weight values should be in the same weight units of the store: KG / LB
|
|
187
|
+
* Total price is according to the store currency
|
|
188
|
+
* Quantity of items should be integers
|
|
189
|
+
*/
|
|
190
|
+
value?: string;
|
|
191
|
+
operator?: LogicalOperator;
|
|
192
|
+
}
|
|
193
|
+
export declare enum ConditionType {
|
|
194
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
195
|
+
BY_TOTAL_WEIGHT = "BY_TOTAL_WEIGHT",
|
|
196
|
+
BY_TOTAL_PRICE = "BY_TOTAL_PRICE",
|
|
197
|
+
BY_TOTAL_QUANTITY = "BY_TOTAL_QUANTITY"
|
|
198
|
+
}
|
|
199
|
+
export declare enum LogicalOperator {
|
|
200
|
+
UNKNOWN_LOGICAL_OPERATOR_TYPE = "UNKNOWN_LOGICAL_OPERATOR_TYPE",
|
|
201
|
+
EQ = "EQ",
|
|
202
|
+
GT = "GT",
|
|
203
|
+
GTE = "GTE",
|
|
204
|
+
LT = "LT",
|
|
205
|
+
LTE = "LTE"
|
|
206
|
+
}
|
|
207
|
+
export interface CreateLocalDeliveryOptionRequest {
|
|
208
|
+
localDeliveryOption: LocalDeliveryOption;
|
|
209
|
+
}
|
|
210
|
+
export interface CreateLocalDeliveryOptionResponse {
|
|
211
|
+
localDeliveryOption?: LocalDeliveryOption;
|
|
212
|
+
}
|
|
213
|
+
export interface GetLocalDeliveryOptionRequest {
|
|
214
|
+
/**
|
|
215
|
+
* @deprecated
|
|
216
|
+
* @targetRemovalDate 2025-01-12
|
|
217
|
+
*/
|
|
218
|
+
_id?: string;
|
|
219
|
+
localDeliveryOptionId: string;
|
|
220
|
+
}
|
|
221
|
+
export interface GetLocalDeliveryOptionResponse {
|
|
222
|
+
localDeliveryOption?: LocalDeliveryOption;
|
|
223
|
+
}
|
|
224
|
+
export interface ListLocalDeliveryOptionsRequest {
|
|
225
|
+
externalId: string;
|
|
226
|
+
}
|
|
227
|
+
export interface ListLocalDeliveryOptionsResponse {
|
|
228
|
+
localDeliveryOptions?: LocalDeliveryOption[];
|
|
229
|
+
}
|
|
230
|
+
export interface QueryLocalDeliveryOptionsRequest {
|
|
231
|
+
/** WQL expression */
|
|
232
|
+
query: QueryV2;
|
|
233
|
+
}
|
|
234
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
235
|
+
/** Paging options to limit and skip the number of items. */
|
|
236
|
+
paging?: Paging;
|
|
237
|
+
/** 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`. */
|
|
238
|
+
cursorPaging?: CursorPaging;
|
|
239
|
+
/**
|
|
240
|
+
* Filter object.
|
|
241
|
+
*
|
|
242
|
+
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
243
|
+
*/
|
|
244
|
+
filter?: Record<string, any> | null;
|
|
245
|
+
/**
|
|
246
|
+
* Sort object.
|
|
247
|
+
*
|
|
248
|
+
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
249
|
+
*/
|
|
250
|
+
sort?: Sorting[];
|
|
251
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
252
|
+
fields?: string[];
|
|
253
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
254
|
+
fieldsets?: string[];
|
|
255
|
+
}
|
|
256
|
+
/** @oneof */
|
|
257
|
+
export interface QueryV2PagingMethodOneOf {
|
|
258
|
+
/** Paging options to limit and skip the number of items. */
|
|
259
|
+
paging?: Paging;
|
|
260
|
+
/** 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`. */
|
|
261
|
+
cursorPaging?: CursorPaging;
|
|
262
|
+
}
|
|
263
|
+
export interface Sorting {
|
|
264
|
+
/** Name of the field to sort by. */
|
|
265
|
+
fieldName?: string;
|
|
266
|
+
/** Sort order. */
|
|
267
|
+
order?: SortOrder;
|
|
268
|
+
}
|
|
269
|
+
export declare enum SortOrder {
|
|
270
|
+
ASC = "ASC",
|
|
271
|
+
DESC = "DESC"
|
|
272
|
+
}
|
|
273
|
+
export interface Paging {
|
|
274
|
+
/** Number of items to load. */
|
|
275
|
+
limit?: number | null;
|
|
276
|
+
/** Number of items to skip in the current sort order. */
|
|
277
|
+
offset?: number | null;
|
|
278
|
+
}
|
|
279
|
+
export interface CursorPaging {
|
|
280
|
+
/** Maximum number of items to return in the results. */
|
|
281
|
+
limit?: number | null;
|
|
282
|
+
/**
|
|
283
|
+
* Pointer to the next or previous page in the list of results.
|
|
284
|
+
*
|
|
285
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
286
|
+
* Not relevant for the first request.
|
|
287
|
+
*/
|
|
288
|
+
cursor?: string | null;
|
|
289
|
+
}
|
|
290
|
+
export interface QueryLocalDeliveryOptionsResponse {
|
|
291
|
+
/** Retrieved local delivery options. */
|
|
292
|
+
localDeliveryOptions?: LocalDeliveryOption[];
|
|
293
|
+
/** Paging metadata. */
|
|
294
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
295
|
+
}
|
|
296
|
+
export interface CursorPagingMetadata {
|
|
297
|
+
/** Number of items returned in current page. */
|
|
298
|
+
count?: number | null;
|
|
299
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
300
|
+
cursors?: Cursors;
|
|
301
|
+
/**
|
|
302
|
+
* Whether there are more pages to retrieve following the current page.
|
|
303
|
+
*
|
|
304
|
+
* + `true`: Another page of results can be retrieved.
|
|
305
|
+
* + `false`: This is the last page.
|
|
306
|
+
*/
|
|
307
|
+
hasNext?: boolean | null;
|
|
308
|
+
}
|
|
309
|
+
export interface Cursors {
|
|
310
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
311
|
+
next?: string | null;
|
|
312
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
313
|
+
prev?: string | null;
|
|
314
|
+
}
|
|
315
|
+
export interface UpdateLocalDeliveryOptionRequest {
|
|
316
|
+
/** LocalDeliveryOption to be updated, may be partial. */
|
|
317
|
+
localDeliveryOption: LocalDeliveryOption;
|
|
318
|
+
}
|
|
319
|
+
export interface UpdateLocalDeliveryOptionResponse {
|
|
320
|
+
localDeliveryOption?: LocalDeliveryOption;
|
|
321
|
+
}
|
|
322
|
+
export interface DeleteLocalDeliveryOptionRequest {
|
|
323
|
+
/**
|
|
324
|
+
* @deprecated
|
|
325
|
+
* @targetRemovalDate 2025-01-12
|
|
326
|
+
*/
|
|
327
|
+
_id?: string;
|
|
328
|
+
localDeliveryOptionId: string;
|
|
329
|
+
}
|
|
330
|
+
export interface DeleteLocalDeliveryOptionResponse {
|
|
331
|
+
}
|
|
332
|
+
export interface BulkCreateLocalDeliveryOptionRequest {
|
|
333
|
+
localDeliveryOptions: LocalDeliveryOption[];
|
|
334
|
+
}
|
|
335
|
+
export interface BulkCreateLocalDeliveryOptionResponse {
|
|
336
|
+
localDeliveryOptions?: LocalDeliveryOption[];
|
|
337
|
+
errors?: LocalDeliveryOptionError[];
|
|
338
|
+
}
|
|
339
|
+
export interface LocalDeliveryOptionError {
|
|
340
|
+
_id?: string;
|
|
341
|
+
error?: string;
|
|
342
|
+
}
|
|
343
|
+
export interface BulkUpdateLocalDeliveryOptionRequest {
|
|
344
|
+
localDeliveryOptions: LocalDeliveryOption[];
|
|
345
|
+
}
|
|
346
|
+
export interface BulkUpdateLocalDeliveryOptionResponse {
|
|
347
|
+
localDeliveryOptions?: LocalDeliveryOption[];
|
|
348
|
+
errors?: LocalDeliveryOptionError[];
|
|
349
|
+
}
|
|
350
|
+
export interface BulkDeleteLocalDeliveryOptionRequest {
|
|
351
|
+
ids: string[];
|
|
352
|
+
}
|
|
353
|
+
export interface BulkDeleteLocalDeliveryOptionResponse {
|
|
354
|
+
}
|
|
355
|
+
export interface Empty {
|
|
356
|
+
}
|
|
357
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
358
|
+
createdEvent?: EntityCreatedEvent;
|
|
359
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
360
|
+
deletedEvent?: EntityDeletedEvent;
|
|
361
|
+
actionEvent?: ActionEvent;
|
|
362
|
+
/**
|
|
363
|
+
* Unique event ID.
|
|
364
|
+
* Allows clients to ignore duplicate webhooks.
|
|
365
|
+
*/
|
|
366
|
+
_id?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Assumes actions are also always typed to an entity_type
|
|
369
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
370
|
+
*/
|
|
371
|
+
entityFqdn?: string;
|
|
372
|
+
/**
|
|
373
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
374
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
375
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
376
|
+
*/
|
|
377
|
+
slug?: string;
|
|
378
|
+
/** ID of the entity associated with the event. */
|
|
379
|
+
entityId?: string;
|
|
380
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
381
|
+
eventTime?: Date | null;
|
|
382
|
+
/**
|
|
383
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
384
|
+
* (for example, GDPR).
|
|
385
|
+
*/
|
|
386
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
387
|
+
/** If present, indicates the action that triggered the event. */
|
|
388
|
+
originatedFrom?: string | null;
|
|
389
|
+
/**
|
|
390
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
391
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
392
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
393
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
394
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
395
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
396
|
+
*/
|
|
397
|
+
entityEventSequence?: string | null;
|
|
398
|
+
}
|
|
399
|
+
/** @oneof */
|
|
400
|
+
export interface DomainEventBodyOneOf {
|
|
401
|
+
createdEvent?: EntityCreatedEvent;
|
|
402
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
403
|
+
deletedEvent?: EntityDeletedEvent;
|
|
404
|
+
actionEvent?: ActionEvent;
|
|
405
|
+
}
|
|
406
|
+
export interface EntityCreatedEvent {
|
|
407
|
+
entity?: string;
|
|
408
|
+
}
|
|
409
|
+
export interface RestoreInfo {
|
|
410
|
+
deletedDate?: Date | null;
|
|
411
|
+
}
|
|
412
|
+
export interface EntityUpdatedEvent {
|
|
413
|
+
/**
|
|
414
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
415
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
416
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
417
|
+
*/
|
|
418
|
+
currentEntity?: string;
|
|
419
|
+
}
|
|
420
|
+
export interface EntityDeletedEvent {
|
|
421
|
+
/** Entity that was deleted */
|
|
422
|
+
deletedEntity?: string | null;
|
|
423
|
+
}
|
|
424
|
+
export interface ActionEvent {
|
|
425
|
+
body?: string;
|
|
426
|
+
}
|
|
427
|
+
export interface AddDeliveryRegionRequest {
|
|
428
|
+
deliveryRegionId: string;
|
|
429
|
+
localDeliveryOptionId: string;
|
|
430
|
+
/** Revision of the PickupLocation */
|
|
431
|
+
revision?: string | null;
|
|
432
|
+
}
|
|
433
|
+
export interface AddDeliveryRegionResponse {
|
|
434
|
+
localDeliveryOption?: LocalDeliveryOption;
|
|
435
|
+
}
|
|
436
|
+
export interface RemoveDeliveryRegionRequest {
|
|
437
|
+
deliveryRegionId: string;
|
|
438
|
+
localDeliveryOptionId: string;
|
|
439
|
+
/** Revision of the PickupLocation */
|
|
440
|
+
revision?: string | null;
|
|
441
|
+
}
|
|
442
|
+
export interface RemoveDeliveryRegionResponse {
|
|
443
|
+
localDeliveryOption?: LocalDeliveryOption;
|
|
444
|
+
}
|
|
445
|
+
export interface MessageEnvelope {
|
|
446
|
+
/** App instance ID. */
|
|
447
|
+
instanceId?: string | null;
|
|
448
|
+
/** Event type. */
|
|
449
|
+
eventType?: string;
|
|
450
|
+
/** The identification type and identity data. */
|
|
451
|
+
identity?: IdentificationData;
|
|
452
|
+
/** Stringify payload. */
|
|
453
|
+
data?: string;
|
|
454
|
+
}
|
|
455
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
456
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
457
|
+
anonymousVisitorId?: string;
|
|
458
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
459
|
+
memberId?: string;
|
|
460
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
461
|
+
wixUserId?: string;
|
|
462
|
+
/** ID of an app. */
|
|
463
|
+
appId?: string;
|
|
464
|
+
/** @readonly */
|
|
465
|
+
identityType?: WebhookIdentityType;
|
|
466
|
+
}
|
|
467
|
+
/** @oneof */
|
|
468
|
+
export interface IdentificationDataIdOneOf {
|
|
469
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
470
|
+
anonymousVisitorId?: string;
|
|
471
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
472
|
+
memberId?: string;
|
|
473
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
474
|
+
wixUserId?: string;
|
|
475
|
+
/** ID of an app. */
|
|
476
|
+
appId?: string;
|
|
477
|
+
}
|
|
478
|
+
export declare enum WebhookIdentityType {
|
|
479
|
+
UNKNOWN = "UNKNOWN",
|
|
480
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
481
|
+
MEMBER = "MEMBER",
|
|
482
|
+
WIX_USER = "WIX_USER",
|
|
483
|
+
APP = "APP"
|
|
484
|
+
}
|
|
485
|
+
interface ZipCodeConfigNonNullableFields {
|
|
486
|
+
zipCodes: string[];
|
|
487
|
+
}
|
|
488
|
+
interface RadiusConfigNonNullableFields {
|
|
489
|
+
radius: number;
|
|
490
|
+
lengthUnit: LengthUnit;
|
|
491
|
+
}
|
|
492
|
+
interface DestinationNonNullableFields {
|
|
493
|
+
code: string;
|
|
494
|
+
subdivisions: string[];
|
|
495
|
+
}
|
|
496
|
+
interface TimeOfDayNonNullableFields {
|
|
497
|
+
hours: number;
|
|
498
|
+
minutes: number;
|
|
499
|
+
}
|
|
500
|
+
interface TimeWindowNonNullableFields {
|
|
501
|
+
day: DayOfWeek;
|
|
502
|
+
start?: TimeOfDayNonNullableFields;
|
|
503
|
+
end?: TimeOfDayNonNullableFields;
|
|
504
|
+
}
|
|
505
|
+
interface ScheduledDeliveryNonNullableFields {
|
|
506
|
+
timeWindows: TimeWindowNonNullableFields[];
|
|
507
|
+
}
|
|
508
|
+
interface ConditionNonNullableFields {
|
|
509
|
+
type: ConditionType;
|
|
510
|
+
value: string;
|
|
511
|
+
operator: LogicalOperator;
|
|
512
|
+
}
|
|
513
|
+
interface ConditionalRatesNonNullableFields {
|
|
514
|
+
conditions: ConditionNonNullableFields[];
|
|
515
|
+
amount: string;
|
|
516
|
+
}
|
|
517
|
+
export interface LocalDeliveryOptionNonNullableFields {
|
|
518
|
+
zipConfig?: ZipCodeConfigNonNullableFields;
|
|
519
|
+
radiusConfig?: RadiusConfigNonNullableFields;
|
|
520
|
+
destinations: DestinationNonNullableFields[];
|
|
521
|
+
scheduledDeliveryConfig?: ScheduledDeliveryNonNullableFields;
|
|
522
|
+
rates: ConditionalRatesNonNullableFields[];
|
|
523
|
+
deliveryRegionIds: string[];
|
|
524
|
+
}
|
|
525
|
+
export interface CreateLocalDeliveryOptionResponseNonNullableFields {
|
|
526
|
+
localDeliveryOption?: LocalDeliveryOptionNonNullableFields;
|
|
527
|
+
}
|
|
528
|
+
export interface GetLocalDeliveryOptionResponseNonNullableFields {
|
|
529
|
+
localDeliveryOption?: LocalDeliveryOptionNonNullableFields;
|
|
530
|
+
}
|
|
531
|
+
export interface ListLocalDeliveryOptionsResponseNonNullableFields {
|
|
532
|
+
localDeliveryOptions: LocalDeliveryOptionNonNullableFields[];
|
|
533
|
+
}
|
|
534
|
+
export interface QueryLocalDeliveryOptionsResponseNonNullableFields {
|
|
535
|
+
localDeliveryOptions: LocalDeliveryOptionNonNullableFields[];
|
|
536
|
+
}
|
|
537
|
+
export interface UpdateLocalDeliveryOptionResponseNonNullableFields {
|
|
538
|
+
localDeliveryOption?: LocalDeliveryOptionNonNullableFields;
|
|
539
|
+
}
|
|
540
|
+
interface LocalDeliveryOptionErrorNonNullableFields {
|
|
541
|
+
_id: string;
|
|
542
|
+
error: string;
|
|
543
|
+
}
|
|
544
|
+
export interface BulkCreateLocalDeliveryOptionResponseNonNullableFields {
|
|
545
|
+
localDeliveryOptions: LocalDeliveryOptionNonNullableFields[];
|
|
546
|
+
errors: LocalDeliveryOptionErrorNonNullableFields[];
|
|
547
|
+
}
|
|
548
|
+
export interface BulkUpdateLocalDeliveryOptionResponseNonNullableFields {
|
|
549
|
+
localDeliveryOptions: LocalDeliveryOptionNonNullableFields[];
|
|
550
|
+
errors: LocalDeliveryOptionErrorNonNullableFields[];
|
|
551
|
+
}
|
|
552
|
+
export interface AddDeliveryRegionResponseNonNullableFields {
|
|
553
|
+
localDeliveryOption?: LocalDeliveryOptionNonNullableFields;
|
|
554
|
+
}
|
|
555
|
+
export interface RemoveDeliveryRegionResponseNonNullableFields {
|
|
556
|
+
localDeliveryOption?: LocalDeliveryOptionNonNullableFields;
|
|
557
|
+
}
|
|
558
|
+
/** @public
|
|
559
|
+
* @documentationMaturity preview
|
|
560
|
+
* @requiredField localDeliveryOption
|
|
561
|
+
* @requiredField localDeliveryOption.areaName
|
|
562
|
+
* @requiredField localDeliveryOption.radiusConfig.address
|
|
563
|
+
* @requiredField localDeliveryOption.radiusConfig.address.formatted
|
|
564
|
+
* @requiredField localDeliveryOption.radiusConfig.address.location
|
|
565
|
+
* @requiredField localDeliveryOption.rate
|
|
566
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday
|
|
567
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
|
|
568
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from
|
|
569
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
|
|
570
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
|
|
571
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to
|
|
572
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
|
|
573
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
|
|
574
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday
|
|
575
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.enabledForDelivery
|
|
576
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from
|
|
577
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
|
|
578
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
|
|
579
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to
|
|
580
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
|
|
581
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
|
|
582
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday
|
|
583
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.enabledForDelivery
|
|
584
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from
|
|
585
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
|
|
586
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
|
|
587
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to
|
|
588
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
|
|
589
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
|
|
590
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday
|
|
591
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.enabledForDelivery
|
|
592
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from
|
|
593
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
|
|
594
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
|
|
595
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to
|
|
596
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
|
|
597
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
|
|
598
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday
|
|
599
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.enabledForDelivery
|
|
600
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from
|
|
601
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
|
|
602
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
|
|
603
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to
|
|
604
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
|
|
605
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
|
|
606
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday
|
|
607
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
|
|
608
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from
|
|
609
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
|
|
610
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
|
|
611
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to
|
|
612
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
|
|
613
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
|
|
614
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday
|
|
615
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
|
|
616
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from
|
|
617
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
|
|
618
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
|
|
619
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to
|
|
620
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
|
|
621
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
|
|
622
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.handlingDays
|
|
623
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_CREATE
|
|
624
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.CreateLocalDeliveryOption
|
|
625
|
+
*/
|
|
626
|
+
export declare function createLocalDeliveryOption(localDeliveryOption: LocalDeliveryOption): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
|
|
627
|
+
/** @public
|
|
628
|
+
* @documentationMaturity preview
|
|
629
|
+
* @requiredField localDeliveryOptionId
|
|
630
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ
|
|
631
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.GetLocalDeliveryOption
|
|
632
|
+
*/
|
|
633
|
+
export declare function getLocalDeliveryOption(localDeliveryOptionId: string, options?: GetLocalDeliveryOptionOptions): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
|
|
634
|
+
export interface GetLocalDeliveryOptionOptions {
|
|
635
|
+
/**
|
|
636
|
+
* @deprecated
|
|
637
|
+
* @targetRemovalDate 2025-01-12
|
|
638
|
+
*/
|
|
639
|
+
_id?: string;
|
|
640
|
+
}
|
|
641
|
+
/** @public
|
|
642
|
+
* @documentationMaturity preview
|
|
643
|
+
* @requiredField externalId
|
|
644
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ
|
|
645
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.ListLocalDeliveryOptions
|
|
646
|
+
* @deprecated method is deprecated due to the fact that external_id is deprecated
|
|
647
|
+
* @replacedBy ListLocalDeliveryOptionsByDeliveryRegion
|
|
648
|
+
* @targetRemovalDate 2024-11-01
|
|
649
|
+
*/
|
|
650
|
+
export declare function listLocalDeliveryOptions(externalId: string): Promise<ListLocalDeliveryOptionsResponse & ListLocalDeliveryOptionsResponseNonNullableFields>;
|
|
651
|
+
/**
|
|
652
|
+
* Retrieves a list of local delivery options, given the provided paging, filtering, and sorting.
|
|
653
|
+
*
|
|
654
|
+
* For field support for filters and sorting, see [Local Delivery: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-regions/supported-filters-and-sorting).
|
|
655
|
+
*
|
|
656
|
+
* To learn about working with _Query_ endpoints, see
|
|
657
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
658
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),
|
|
659
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
660
|
+
* @public
|
|
661
|
+
* @documentationMaturity preview
|
|
662
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ
|
|
663
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.QueryLocalDeliveryOptions
|
|
664
|
+
*/
|
|
665
|
+
export declare function queryLocalDeliveryOptions(): LocalDeliveryOptionsQueryBuilder;
|
|
666
|
+
interface QueryCursorResult {
|
|
667
|
+
cursors: Cursors;
|
|
668
|
+
hasNext: () => boolean;
|
|
669
|
+
hasPrev: () => boolean;
|
|
670
|
+
length: number;
|
|
671
|
+
pageSize: number;
|
|
672
|
+
}
|
|
673
|
+
export interface LocalDeliveryOptionsQueryResult extends QueryCursorResult {
|
|
674
|
+
items: LocalDeliveryOption[];
|
|
675
|
+
query: LocalDeliveryOptionsQueryBuilder;
|
|
676
|
+
next: () => Promise<LocalDeliveryOptionsQueryResult>;
|
|
677
|
+
prev: () => Promise<LocalDeliveryOptionsQueryResult>;
|
|
678
|
+
}
|
|
679
|
+
export interface LocalDeliveryOptionsQueryBuilder {
|
|
680
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
681
|
+
* @param value - Value to compare against.
|
|
682
|
+
* @documentationMaturity preview
|
|
683
|
+
*/
|
|
684
|
+
eq: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
|
|
685
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
686
|
+
* @param value - Value to compare against.
|
|
687
|
+
* @documentationMaturity preview
|
|
688
|
+
*/
|
|
689
|
+
ne: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
|
|
690
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
691
|
+
* @param string - String to compare against. Case-insensitive.
|
|
692
|
+
* @documentationMaturity preview
|
|
693
|
+
*/
|
|
694
|
+
startsWith: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime', value: string) => LocalDeliveryOptionsQueryBuilder;
|
|
695
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
696
|
+
* @param values - List of values to compare against.
|
|
697
|
+
* @documentationMaturity preview
|
|
698
|
+
*/
|
|
699
|
+
hasSome: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;
|
|
700
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
701
|
+
* @param values - List of values to compare against.
|
|
702
|
+
* @documentationMaturity preview
|
|
703
|
+
*/
|
|
704
|
+
hasAll: (propertyName: 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;
|
|
705
|
+
/** @documentationMaturity preview */
|
|
706
|
+
in: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
|
|
707
|
+
/** @documentationMaturity preview */
|
|
708
|
+
exists: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: boolean) => LocalDeliveryOptionsQueryBuilder;
|
|
709
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
710
|
+
* @documentationMaturity preview
|
|
711
|
+
*/
|
|
712
|
+
limit: (limit: number) => LocalDeliveryOptionsQueryBuilder;
|
|
713
|
+
/** @param cursor - A pointer to specific record
|
|
714
|
+
* @documentationMaturity preview
|
|
715
|
+
*/
|
|
716
|
+
skipTo: (cursor: string) => LocalDeliveryOptionsQueryBuilder;
|
|
717
|
+
/** @documentationMaturity preview */
|
|
718
|
+
find: () => Promise<LocalDeliveryOptionsQueryResult>;
|
|
719
|
+
}
|
|
720
|
+
/** @param _id - LocalDeliveryOptionId - unique identifier of local delivery option
|
|
721
|
+
* @public
|
|
722
|
+
* @documentationMaturity preview
|
|
723
|
+
* @requiredField _id
|
|
724
|
+
* @requiredField localDeliveryOption
|
|
725
|
+
* @requiredField localDeliveryOption.radiusConfig.address
|
|
726
|
+
* @requiredField localDeliveryOption.radiusConfig.address.formatted
|
|
727
|
+
* @requiredField localDeliveryOption.radiusConfig.address.location
|
|
728
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
|
|
729
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from
|
|
730
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
|
|
731
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
|
|
732
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to
|
|
733
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
|
|
734
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
|
|
735
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.enabledForDelivery
|
|
736
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from
|
|
737
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
|
|
738
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
|
|
739
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to
|
|
740
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
|
|
741
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
|
|
742
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.enabledForDelivery
|
|
743
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from
|
|
744
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
|
|
745
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
|
|
746
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to
|
|
747
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
|
|
748
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
|
|
749
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.enabledForDelivery
|
|
750
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from
|
|
751
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
|
|
752
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
|
|
753
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to
|
|
754
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
|
|
755
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
|
|
756
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.enabledForDelivery
|
|
757
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from
|
|
758
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
|
|
759
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
|
|
760
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to
|
|
761
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
|
|
762
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
|
|
763
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
|
|
764
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from
|
|
765
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
|
|
766
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
|
|
767
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to
|
|
768
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
|
|
769
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
|
|
770
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
|
|
771
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from
|
|
772
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
|
|
773
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
|
|
774
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to
|
|
775
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
|
|
776
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
|
|
777
|
+
* @requiredField localDeliveryOption.scheduledDeliveryConfig.handlingDays
|
|
778
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
|
|
779
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.UpdateLocalDeliveryOption
|
|
780
|
+
*/
|
|
781
|
+
export declare function updateLocalDeliveryOption(_id: string | null, localDeliveryOption: UpdateLocalDeliveryOption): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
|
|
782
|
+
export interface UpdateLocalDeliveryOption {
|
|
783
|
+
zipConfig?: ZipCodeConfig;
|
|
784
|
+
radiusConfig?: RadiusConfig;
|
|
785
|
+
customAreaConfig?: CustomAreaConfig;
|
|
786
|
+
/**
|
|
787
|
+
* LocalDeliveryOptionId - unique identifier of local delivery option
|
|
788
|
+
* @readonly
|
|
789
|
+
*/
|
|
790
|
+
_id?: string | null;
|
|
791
|
+
/** Area name of Local Delivery Option */
|
|
792
|
+
areaName?: string | null;
|
|
793
|
+
/**
|
|
794
|
+
* Flat price of local delivery
|
|
795
|
+
* @deprecated Flat price of local delivery
|
|
796
|
+
* @targetRemovalDate 2025-01-12
|
|
797
|
+
*/
|
|
798
|
+
rate?: string | null;
|
|
799
|
+
/** Estimated delivery time description text */
|
|
800
|
+
estimatedDeliveryTime?: string | null;
|
|
801
|
+
/**
|
|
802
|
+
* Minimum order total to be eligible for free delivery
|
|
803
|
+
* @deprecated Minimum order total to be eligible for free delivery
|
|
804
|
+
* @targetRemovalDate 2025-01-12
|
|
805
|
+
*/
|
|
806
|
+
minimumFreeDeliveryOrderAmount?: number | null;
|
|
807
|
+
/** List of countries with subdivisions */
|
|
808
|
+
destinations?: Destination[];
|
|
809
|
+
/**
|
|
810
|
+
* Database revision of LocalDeliveryOption entity. Incremented on each modification
|
|
811
|
+
* @readonly
|
|
812
|
+
*/
|
|
813
|
+
revision?: string | null;
|
|
814
|
+
scheduledDeliveryConfig?: ScheduledDelivery;
|
|
815
|
+
/** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */
|
|
816
|
+
rates?: ConditionalRates[];
|
|
817
|
+
/**
|
|
818
|
+
* Date and time the LocalDeliveryOption was created.
|
|
819
|
+
* @readonly
|
|
820
|
+
*/
|
|
821
|
+
_createdDate?: Date | null;
|
|
822
|
+
/**
|
|
823
|
+
* Date and time the LocalDeliveryOption was last updated.
|
|
824
|
+
* @readonly
|
|
825
|
+
*/
|
|
826
|
+
_updatedDate?: Date | null;
|
|
827
|
+
/** This local delivery is active for the following delivery regions. */
|
|
828
|
+
deliveryRegionIds?: string[];
|
|
829
|
+
}
|
|
830
|
+
/** @public
|
|
831
|
+
* @documentationMaturity preview
|
|
832
|
+
* @requiredField localDeliveryOptionId
|
|
833
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_DELETE
|
|
834
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.DeleteLocalDeliveryOption
|
|
835
|
+
*/
|
|
836
|
+
export declare function deleteLocalDeliveryOption(localDeliveryOptionId: string, options?: DeleteLocalDeliveryOptionOptions): Promise<void>;
|
|
837
|
+
export interface DeleteLocalDeliveryOptionOptions {
|
|
838
|
+
/**
|
|
839
|
+
* @deprecated
|
|
840
|
+
* @targetRemovalDate 2025-01-12
|
|
841
|
+
*/
|
|
842
|
+
_id?: string;
|
|
843
|
+
}
|
|
844
|
+
/** @public
|
|
845
|
+
* @documentationMaturity preview
|
|
846
|
+
* @requiredField localDeliveryOptions
|
|
847
|
+
* @requiredField localDeliveryOptions.radiusConfig.address
|
|
848
|
+
* @requiredField localDeliveryOptions.radiusConfig.address.formatted
|
|
849
|
+
* @requiredField localDeliveryOptions.radiusConfig.address.location
|
|
850
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
|
|
851
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
|
|
852
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
|
|
853
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
|
|
854
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
|
|
855
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to
|
|
856
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
|
|
857
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
|
|
858
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday
|
|
859
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.enabledForDelivery
|
|
860
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from
|
|
861
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
|
|
862
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
|
|
863
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to
|
|
864
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
|
|
865
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
|
|
866
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday
|
|
867
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.enabledForDelivery
|
|
868
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from
|
|
869
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
|
|
870
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
|
|
871
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to
|
|
872
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
|
|
873
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
|
|
874
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday
|
|
875
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.enabledForDelivery
|
|
876
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from
|
|
877
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
|
|
878
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
|
|
879
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to
|
|
880
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
|
|
881
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
|
|
882
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday
|
|
883
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.enabledForDelivery
|
|
884
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from
|
|
885
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
|
|
886
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
|
|
887
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to
|
|
888
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
|
|
889
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
|
|
890
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday
|
|
891
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
|
|
892
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from
|
|
893
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
|
|
894
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
|
|
895
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to
|
|
896
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
|
|
897
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
|
|
898
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday
|
|
899
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
|
|
900
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from
|
|
901
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
|
|
902
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
|
|
903
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to
|
|
904
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
|
|
905
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
|
|
906
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.handlingDays
|
|
907
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_CREATE
|
|
908
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.BulkCreateLocalDeliveryOption
|
|
909
|
+
*/
|
|
910
|
+
export declare function bulkCreateLocalDeliveryOption(localDeliveryOptions: LocalDeliveryOption[]): Promise<BulkCreateLocalDeliveryOptionResponse & BulkCreateLocalDeliveryOptionResponseNonNullableFields>;
|
|
911
|
+
/** @public
|
|
912
|
+
* @documentationMaturity preview
|
|
913
|
+
* @requiredField localDeliveryOptions
|
|
914
|
+
* @requiredField localDeliveryOptions.radiusConfig.address
|
|
915
|
+
* @requiredField localDeliveryOptions.radiusConfig.address.formatted
|
|
916
|
+
* @requiredField localDeliveryOptions.radiusConfig.address.location
|
|
917
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
|
|
918
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
|
|
919
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
|
|
920
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
|
|
921
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
|
|
922
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to
|
|
923
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
|
|
924
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
|
|
925
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday
|
|
926
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.enabledForDelivery
|
|
927
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from
|
|
928
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
|
|
929
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
|
|
930
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to
|
|
931
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
|
|
932
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
|
|
933
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday
|
|
934
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.enabledForDelivery
|
|
935
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from
|
|
936
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
|
|
937
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
|
|
938
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to
|
|
939
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
|
|
940
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
|
|
941
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday
|
|
942
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.enabledForDelivery
|
|
943
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from
|
|
944
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
|
|
945
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
|
|
946
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to
|
|
947
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
|
|
948
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
|
|
949
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday
|
|
950
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.enabledForDelivery
|
|
951
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from
|
|
952
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
|
|
953
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
|
|
954
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to
|
|
955
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
|
|
956
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
|
|
957
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday
|
|
958
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
|
|
959
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from
|
|
960
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
|
|
961
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
|
|
962
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to
|
|
963
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
|
|
964
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
|
|
965
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday
|
|
966
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
|
|
967
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from
|
|
968
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
|
|
969
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
|
|
970
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to
|
|
971
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
|
|
972
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
|
|
973
|
+
* @requiredField localDeliveryOptions.scheduledDeliveryConfig.handlingDays
|
|
974
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
|
|
975
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.BulkUpdateLocalDeliveryOption
|
|
976
|
+
*/
|
|
977
|
+
export declare function bulkUpdateLocalDeliveryOption(localDeliveryOptions: LocalDeliveryOption[]): Promise<BulkUpdateLocalDeliveryOptionResponse & BulkUpdateLocalDeliveryOptionResponseNonNullableFields>;
|
|
978
|
+
/** @public
|
|
979
|
+
* @documentationMaturity preview
|
|
980
|
+
* @requiredField ids
|
|
981
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_DELETE
|
|
982
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.BulkDeleteLocalDeliveryOption
|
|
983
|
+
*/
|
|
984
|
+
export declare function bulkDeleteLocalDeliveryOption(ids: string[]): Promise<void>;
|
|
985
|
+
/** @public
|
|
986
|
+
* @documentationMaturity preview
|
|
987
|
+
* @requiredField deliveryRegionId
|
|
988
|
+
* @requiredField options.localDeliveryOptionId
|
|
989
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
|
|
990
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.AddDeliveryRegion
|
|
991
|
+
*/
|
|
992
|
+
export declare function addDeliveryRegion(deliveryRegionId: string, options?: AddDeliveryRegionOptions): Promise<AddDeliveryRegionResponse & AddDeliveryRegionResponseNonNullableFields>;
|
|
993
|
+
export interface AddDeliveryRegionOptions {
|
|
994
|
+
localDeliveryOptionId: string;
|
|
995
|
+
/** Revision of the PickupLocation */
|
|
996
|
+
revision?: string | null;
|
|
997
|
+
}
|
|
998
|
+
/** @public
|
|
999
|
+
* @documentationMaturity preview
|
|
1000
|
+
* @requiredField deliveryRegionId
|
|
1001
|
+
* @requiredField options.localDeliveryOptionId
|
|
1002
|
+
* @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
|
|
1003
|
+
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.RemoveDeliveryRegion
|
|
1004
|
+
*/
|
|
1005
|
+
export declare function removeDeliveryRegion(deliveryRegionId: string, options?: RemoveDeliveryRegionOptions): Promise<RemoveDeliveryRegionResponse & RemoveDeliveryRegionResponseNonNullableFields>;
|
|
1006
|
+
export interface RemoveDeliveryRegionOptions {
|
|
1007
|
+
localDeliveryOptionId: string;
|
|
1008
|
+
/** Revision of the PickupLocation */
|
|
1009
|
+
revision?: string | null;
|
|
1010
|
+
}
|
|
1011
|
+
export {};
|