@wix/auto_sdk_restaurants_fulfillment-methods 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.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.d.ts +28 -0
  11. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js +41 -0
  12. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js.map +1 -0
  13. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.d.ts +57 -0
  14. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js +602 -0
  15. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js.map +1 -0
  16. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.d.ts +28 -0
  17. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js +218 -0
  18. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js.map +1 -0
  19. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.d.ts +113 -0
  20. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js +173 -0
  21. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js.map +1 -0
  22. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.d.ts +1004 -0
  23. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js +105 -0
  24. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js.map +1 -0
  25. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.d.ts +1387 -0
  26. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js +655 -0
  27. package/build/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.d.ts +28 -0
  39. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js +28 -0
  40. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js.map +1 -0
  41. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.d.ts +57 -0
  42. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js +589 -0
  43. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js.map +1 -0
  44. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.d.ts +28 -0
  45. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js +182 -0
  46. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js.map +1 -0
  47. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.d.ts +113 -0
  48. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js +150 -0
  49. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js.map +1 -0
  50. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.d.ts +1004 -0
  51. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js +102 -0
  52. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js.map +1 -0
  53. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.d.ts +1387 -0
  54. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js +619 -0
  55. package/build/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.d.ts +28 -0
  66. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js +41 -0
  67. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js.map +1 -0
  68. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.d.ts +57 -0
  69. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js +602 -0
  70. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js.map +1 -0
  71. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.d.ts +28 -0
  72. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js +218 -0
  73. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js.map +1 -0
  74. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.d.ts +113 -0
  75. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js +173 -0
  76. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js.map +1 -0
  77. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.d.ts +1004 -0
  78. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js +105 -0
  79. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js.map +1 -0
  80. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.d.ts +1387 -0
  81. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js +655 -0
  82. package/build/internal/cjs/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.d.ts +28 -0
  93. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js +28 -0
  94. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.context.js.map +1 -0
  95. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.d.ts +57 -0
  96. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js +589 -0
  97. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.http.js.map +1 -0
  98. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.d.ts +28 -0
  99. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js +182 -0
  100. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.meta.js.map +1 -0
  101. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.d.ts +113 -0
  102. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js +150 -0
  103. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.public.js.map +1 -0
  104. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.d.ts +1004 -0
  105. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js +102 -0
  106. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.types.js.map +1 -0
  107. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.d.ts +1387 -0
  108. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js +619 -0
  109. package/build/internal/es/src/restaurants-v1-fulfillment-method-fulfillment-methods.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1387 @@
1
+ /** A Fulfillment Method represents a way in which a restaurant can provide orders to its customers. */
2
+ export interface FulfillmentMethod extends FulfillmentMethodMethodOptionsOneOf {
3
+ /** Data specific for pickup fulfillment method. */
4
+ pickupOptions?: PickupInfo;
5
+ /** Data specific for delivery fulfillment method. */
6
+ deliveryOptions?: DeliveryInfo;
7
+ /**
8
+ * Fulfillment method ID.
9
+ * @readonly
10
+ */
11
+ _id?: string | null;
12
+ /**
13
+ * The current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.
14
+ * @readonly
15
+ */
16
+ revision?: string | null;
17
+ /**
18
+ * Date and time the fulfillment method was created.
19
+ * @readonly
20
+ */
21
+ _createdDate?: Date | null;
22
+ /**
23
+ * Date and time the fulfillment method was last updated.
24
+ * @readonly
25
+ */
26
+ _updatedDate?: Date | null;
27
+ /** Type of fulfillment method. */
28
+ type?: FulfillmentMethodType;
29
+ /** Fulfillment method name. */
30
+ name?: string | null;
31
+ /** Whether the fulfillment method is enabled. */
32
+ enabled?: boolean | null;
33
+ /** Fee for using this fulfillment method. */
34
+ fee?: string | null;
35
+ /** Availability of this fulfillment method. */
36
+ availability?: Availability;
37
+ /** Minimum order price to qualify for using this fulfillment method. */
38
+ minOrderPrice?: string | null;
39
+ }
40
+ /** @oneof */
41
+ export interface FulfillmentMethodMethodOptionsOneOf {
42
+ /** Data specific for pickup fulfillment method. */
43
+ pickupOptions?: PickupInfo;
44
+ /** Data specific for delivery fulfillment method. */
45
+ deliveryOptions?: DeliveryInfo;
46
+ }
47
+ export declare enum FulfillmentMethodType {
48
+ /** Unknown fulfillment type. */
49
+ UNKNOWN_FULFILLMENT_TYPE = "UNKNOWN_FULFILLMENT_TYPE",
50
+ /** The customer must pick up the order from the restaurant. */
51
+ PICKUP = "PICKUP",
52
+ /** The restaurant, or someone on behalf of the restaurant, must deliver the order to the customer. */
53
+ DELIVERY = "DELIVERY"
54
+ }
55
+ export interface PickupInfo {
56
+ /** Instructions for the pickup. */
57
+ instructions?: string | null;
58
+ /**
59
+ * Pickup address.
60
+ *
61
+ * This is set to the address of the restaurant.
62
+ * @readonly
63
+ */
64
+ address?: CommonAddress;
65
+ }
66
+ /** Physical address */
67
+ export interface CommonAddress extends CommonAddressStreetOneOf {
68
+ /** Street name and number. */
69
+ streetAddress?: StreetAddress;
70
+ /** Main address line, usually street and number as free text. */
71
+ addressLine1?: string | null;
72
+ /** Country code. */
73
+ country?: string | null;
74
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
75
+ subdivision?: string | null;
76
+ /** City name. */
77
+ city?: string | null;
78
+ /** Zip/postal code. */
79
+ postalCode?: string | null;
80
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
81
+ addressLine2?: string | null;
82
+ }
83
+ /** @oneof */
84
+ export interface CommonAddressStreetOneOf {
85
+ /** Street name and number. */
86
+ streetAddress?: StreetAddress;
87
+ /** Main address line, usually street and number as free text. */
88
+ addressLine?: string | null;
89
+ }
90
+ export interface StreetAddress {
91
+ /** Street number. */
92
+ number?: string;
93
+ /** Street name. */
94
+ name?: string;
95
+ }
96
+ export interface AddressLocation {
97
+ /** Address latitude. */
98
+ latitude?: number | null;
99
+ /** Address longitude. */
100
+ longitude?: number | null;
101
+ }
102
+ export interface Subdivision {
103
+ /** Short subdivision code. */
104
+ code?: string;
105
+ /** Subdivision full name. */
106
+ name?: string;
107
+ }
108
+ export declare enum SubdivisionType {
109
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
110
+ /** State */
111
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
112
+ /** County */
113
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
114
+ /** City/town */
115
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
116
+ /** Neighborhood/quarter */
117
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
118
+ /** Street/block */
119
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
120
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
121
+ COUNTRY = "COUNTRY"
122
+ }
123
+ export interface DeliveryInfo {
124
+ /** Estimated delivery time in minutes. */
125
+ deliveryTimeInMinutes?: number | null;
126
+ /**
127
+ * Threshold for offering free delivery.
128
+ * If the order price exceeds this threshold, the delivery fee is waived.
129
+ */
130
+ freeDeliveryThreshold?: string | null;
131
+ /** Delivery area supported by this delivery fulfillment method. */
132
+ deliveryArea?: DeliveryArea;
133
+ /**
134
+ * Delivery provider app id.
135
+ * @readonly
136
+ */
137
+ deliveryProviderAppId?: string | null;
138
+ /** Pickup instructions for couriers. */
139
+ courierPickupInstructions?: string | null;
140
+ }
141
+ export interface DeliveryArea extends DeliveryAreaAreaOptionsOneOf {
142
+ /** Settings for a radius delivery area. */
143
+ radiusOptions?: Radius;
144
+ /** Settings for a postal code delivery area. */
145
+ postalCodeOptions?: PostalCode;
146
+ /** Settings for a custom delivery area. */
147
+ customOptions?: CustomArea;
148
+ /** Type of delivery area. */
149
+ type?: Type;
150
+ }
151
+ /** @oneof */
152
+ export interface DeliveryAreaAreaOptionsOneOf {
153
+ /** Settings for a radius delivery area. */
154
+ radiusOptions?: Radius;
155
+ /** Settings for a postal code delivery area. */
156
+ postalCodeOptions?: PostalCode;
157
+ /** Settings for a custom delivery area. */
158
+ customOptions?: CustomArea;
159
+ }
160
+ export declare enum Type {
161
+ /** Unknown delivery area type. */
162
+ UNKNOWN_DELIVERY_AREA = "UNKNOWN_DELIVERY_AREA",
163
+ /** Delivery area defined by a radius around the restaurant's address. */
164
+ RADIUS = "RADIUS",
165
+ /** Delivery area defined by a list of postal codes. */
166
+ POSTAL_CODE = "POSTAL_CODE",
167
+ /** Delivery area defined by a custom polygon. */
168
+ CUSTOM = "CUSTOM",
169
+ /** Delivery area that is determined by the provider. Setting this option, you must also provide `delivery_provider_app_id`. */
170
+ PROVIDER_DEFINED = "PROVIDER_DEFINED"
171
+ }
172
+ export interface Radius {
173
+ /**
174
+ * Radius value.
175
+ * The unit of the radius is specified in the `unit` field.
176
+ * __Deprecated.__ Use `maxDistance` instead.
177
+ * This property will be removed on {{Feb 18}}, {{2025}}.
178
+ * @deprecated
179
+ * @replacedBy max_distance
180
+ * @targetRemovalDate 2025-02-18
181
+ */
182
+ value?: string | null;
183
+ /**
184
+ * Minimum distance value.
185
+ * The unit of the radius is specified in the `unit` field.
186
+ */
187
+ minDistance?: string | null;
188
+ /**
189
+ * Maximum distance value.
190
+ * The unit of the radius is specified in the `unit` field.
191
+ */
192
+ maxDistance?: string | null;
193
+ /**
194
+ * Address at the center of the circle.
195
+ * @readonly
196
+ */
197
+ centerPointAddress?: CommonAddress;
198
+ /** Unit of measurement of the radius. */
199
+ unit?: Unit;
200
+ }
201
+ export declare enum Unit {
202
+ /** Unknown unit. */
203
+ UNKNOWN_UNIT = "UNKNOWN_UNIT",
204
+ /** Miles. */
205
+ MILES = "MILES",
206
+ /** Kilometers. */
207
+ KILOMETERS = "KILOMETERS"
208
+ }
209
+ export interface PostalCode {
210
+ /**
211
+ * Country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
212
+ * @readonly
213
+ */
214
+ countryCode?: string | null;
215
+ /**
216
+ * List of postal codes and postal code regexes. For example, `10001`, `10002` or `1000*`.
217
+ * A postal code regex will enable you to define a range of postal codes using an asterisk (*).
218
+ * For example, to include the postal codes in the range of `10001`-`10009`, use `1000*`.
219
+ */
220
+ postalCodes?: string[] | null;
221
+ }
222
+ export interface CustomArea {
223
+ /** Geocodes of the polygon defining the delivery area. */
224
+ geocodes?: AddressLocation[];
225
+ }
226
+ export interface Availability {
227
+ /** A list of availability times for the days of the week. */
228
+ availableTimes?: DayOfWeekAvailability[];
229
+ /**
230
+ * The timezone in which the availability times are given.
231
+ * @readonly
232
+ */
233
+ timeZone?: string | null;
234
+ }
235
+ export interface DayOfWeekAvailability {
236
+ /** The day of week this availability relates to. */
237
+ dayOfWeek?: EntitiesDayOfWeek;
238
+ /** A list of time ranges during which the fulfillment should be available. */
239
+ timeRanges?: TimeOfDayRange[];
240
+ }
241
+ export declare enum EntitiesDayOfWeek {
242
+ /** Monday. */
243
+ MON = "MON",
244
+ /** Tuesday. */
245
+ TUE = "TUE",
246
+ /** Wednesday. */
247
+ WED = "WED",
248
+ /** Thursday. */
249
+ THU = "THU",
250
+ /** Friday. */
251
+ FRI = "FRI",
252
+ /** Saturday. */
253
+ SAT = "SAT",
254
+ /** Sunday. */
255
+ SUN = "SUN"
256
+ }
257
+ export interface TimeOfDayRange {
258
+ /** The start time in time of day representation. */
259
+ startTime?: TimeOfDay;
260
+ /** The end time in time of day representation. */
261
+ endTime?: TimeOfDay;
262
+ }
263
+ export interface TimeOfDay {
264
+ /**
265
+ * Hours. <br />
266
+ * Min: `0`. <br />
267
+ * Max: `23`.
268
+ */
269
+ hours?: number;
270
+ /**
271
+ * Minutes. <br />
272
+ * Min: `0`. <br />
273
+ * Max: `23`.
274
+ */
275
+ minutes?: number;
276
+ }
277
+ export interface DomainEvent extends DomainEventBodyOneOf {
278
+ createdEvent?: EntityCreatedEvent;
279
+ updatedEvent?: EntityUpdatedEvent;
280
+ deletedEvent?: EntityDeletedEvent;
281
+ actionEvent?: ActionEvent;
282
+ /**
283
+ * Unique event ID.
284
+ * Allows clients to ignore duplicate webhooks.
285
+ */
286
+ _id?: string;
287
+ /**
288
+ * Assumes actions are also always typed to an entity_type
289
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
290
+ */
291
+ entityFqdn?: string;
292
+ /**
293
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
294
+ * This is although the created/updated/deleted notion is duplication of the oneof types
295
+ * Example: created/updated/deleted/started/completed/email_opened
296
+ */
297
+ slug?: string;
298
+ /** ID of the entity associated with the event. */
299
+ entityId?: string;
300
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
301
+ eventTime?: Date | null;
302
+ /**
303
+ * Whether the event was triggered as a result of a privacy regulation application
304
+ * (for example, GDPR).
305
+ */
306
+ triggeredByAnonymizeRequest?: boolean | null;
307
+ /** If present, indicates the action that triggered the event. */
308
+ originatedFrom?: string | null;
309
+ /**
310
+ * A sequence number defining the order of updates to the underlying entity.
311
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
312
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
313
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
314
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
315
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
316
+ */
317
+ entityEventSequence?: string | null;
318
+ }
319
+ /** @oneof */
320
+ export interface DomainEventBodyOneOf {
321
+ createdEvent?: EntityCreatedEvent;
322
+ updatedEvent?: EntityUpdatedEvent;
323
+ deletedEvent?: EntityDeletedEvent;
324
+ actionEvent?: ActionEvent;
325
+ }
326
+ export interface EntityCreatedEvent {
327
+ entity?: string;
328
+ }
329
+ export interface RestoreInfo {
330
+ deletedDate?: Date | null;
331
+ }
332
+ export interface EntityUpdatedEvent {
333
+ /**
334
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
335
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
336
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
337
+ */
338
+ currentEntity?: string;
339
+ }
340
+ export interface EntityDeletedEvent {
341
+ /** Entity that was deleted */
342
+ deletedEntity?: string | null;
343
+ }
344
+ export interface ActionEvent {
345
+ body?: string;
346
+ }
347
+ export interface MessageEnvelope {
348
+ /** App instance ID. */
349
+ instanceId?: string | null;
350
+ /** Event type. */
351
+ eventType?: string;
352
+ /** The identification type and identity data. */
353
+ identity?: IdentificationData;
354
+ /** Stringify payload. */
355
+ data?: string;
356
+ }
357
+ export interface IdentificationData extends IdentificationDataIdOneOf {
358
+ /** ID of a site visitor that has not logged in to the site. */
359
+ anonymousVisitorId?: string;
360
+ /** ID of a site visitor that has logged in to the site. */
361
+ memberId?: string;
362
+ /** ID of a Wix user (site owner, contributor, etc.). */
363
+ wixUserId?: string;
364
+ /** ID of an app. */
365
+ appId?: string;
366
+ /** @readonly */
367
+ identityType?: WebhookIdentityType;
368
+ }
369
+ /** @oneof */
370
+ export interface IdentificationDataIdOneOf {
371
+ /** ID of a site visitor that has not logged in to the site. */
372
+ anonymousVisitorId?: string;
373
+ /** ID of a site visitor that has logged in to the site. */
374
+ memberId?: string;
375
+ /** ID of a Wix user (site owner, contributor, etc.). */
376
+ wixUserId?: string;
377
+ /** ID of an app. */
378
+ appId?: string;
379
+ }
380
+ export declare enum WebhookIdentityType {
381
+ UNKNOWN = "UNKNOWN",
382
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
383
+ MEMBER = "MEMBER",
384
+ WIX_USER = "WIX_USER",
385
+ APP = "APP"
386
+ }
387
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
388
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
389
+ metaSiteId?: string;
390
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
391
+ siteId?: string;
392
+ /** Invalidate by App */
393
+ app?: App;
394
+ /** Invalidate by page id */
395
+ page?: Page;
396
+ /** Invalidate by URI path */
397
+ uri?: URI;
398
+ /** Invalidate by file (for media files such as PDFs) */
399
+ file?: File;
400
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
401
+ reason?: string | null;
402
+ /** Is local DS */
403
+ localDc?: boolean;
404
+ hardPurge?: boolean;
405
+ }
406
+ /** @oneof */
407
+ export interface InvalidateCacheGetByOneOf {
408
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
409
+ metaSiteId?: string;
410
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
411
+ siteId?: string;
412
+ /** Invalidate by App */
413
+ app?: App;
414
+ /** Invalidate by page id */
415
+ page?: Page;
416
+ /** Invalidate by URI path */
417
+ uri?: URI;
418
+ /** Invalidate by file (for media files such as PDFs) */
419
+ file?: File;
420
+ }
421
+ export interface App {
422
+ /** The AppDefId */
423
+ appDefId?: string;
424
+ /** The instance Id */
425
+ instanceId?: string;
426
+ }
427
+ export interface Page {
428
+ /** the msid the page is on */
429
+ metaSiteId?: string;
430
+ /** Invalidate by Page ID */
431
+ pageId?: string;
432
+ }
433
+ export interface URI {
434
+ /** the msid the URI is on */
435
+ metaSiteId?: string;
436
+ /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
437
+ uriPath?: string;
438
+ }
439
+ export interface File {
440
+ /** the msid the file is related to */
441
+ metaSiteId?: string;
442
+ /** Invalidate by filename (for media files such as PDFs) */
443
+ fileName?: string;
444
+ }
445
+ export interface CreateFulfillmentMethodRequest {
446
+ /** Fulfillment method to create. */
447
+ fulfillmentMethod: FulfillmentMethod;
448
+ }
449
+ export interface CreateFulfillmentMethodResponse {
450
+ /** The created fulfillment method. */
451
+ fulfillmentMethod?: FulfillmentMethod;
452
+ }
453
+ export interface BulkCreateFulfillmentMethodsRequest {
454
+ /** Fulfillment methods to create. */
455
+ fulfillmentMethods?: FulfillmentMethod[];
456
+ /** If true, the created entities will be returned. */
457
+ returnEntity?: boolean;
458
+ }
459
+ export interface BulkCreateFulfillmentMethodsResponse {
460
+ /** Information about the created fulfillment method. */
461
+ results?: BulkCreateFulfillmentMethodResult[];
462
+ /** Metadata for the API call. */
463
+ bulkActionMetadata?: BulkActionMetadata;
464
+ }
465
+ export interface BulkCreateFulfillmentMethodResult {
466
+ /** Metadata for fulfillment method creation. */
467
+ itemMetadata?: ItemMetadata;
468
+ /** Created fulfillment method. */
469
+ fulfillmentMethod?: FulfillmentMethod;
470
+ }
471
+ export interface ItemMetadata {
472
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
473
+ _id?: string | null;
474
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
475
+ originalIndex?: number;
476
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
477
+ success?: boolean;
478
+ /** Details about the error in case of failure. */
479
+ error?: ApplicationError;
480
+ }
481
+ export interface ApplicationError {
482
+ /** Error code. */
483
+ code?: string;
484
+ /** Description of the error. */
485
+ description?: string;
486
+ /** Data related to the error. */
487
+ data?: Record<string, any> | null;
488
+ }
489
+ export interface BulkActionMetadata {
490
+ /** Number of items that were successfully processed. */
491
+ totalSuccesses?: number;
492
+ /** Number of items that couldn't be processed. */
493
+ totalFailures?: number;
494
+ /** Number of failures without details because detailed failure threshold was exceeded. */
495
+ undetailedFailures?: number;
496
+ }
497
+ export interface GetFulfillmentMethodRequest {
498
+ /** The ID of the fulfillment method to retrieve. */
499
+ fulfillmentMethodId: string;
500
+ }
501
+ export interface GetFulfillmentMethodResponse {
502
+ /** The retrieved fulfillment method. */
503
+ fulfillmentMethod?: FulfillmentMethod;
504
+ }
505
+ export interface UpdateFulfillmentMethodRequest {
506
+ /**
507
+ * Fulfillment method to update.
508
+ * The fulfillment method update may be partial with the use of `field_mask`.
509
+ */
510
+ fulfillmentMethod: FulfillmentMethod;
511
+ }
512
+ export interface UpdateFulfillmentMethodResponse {
513
+ /** The updated fulfillment method. */
514
+ fulfillmentMethod?: FulfillmentMethod;
515
+ }
516
+ export interface DeleteFulfillmentMethodRequest {
517
+ /** The ID of the fulfillment method to delete. */
518
+ fulfillmentMethodId: string;
519
+ }
520
+ export interface DeleteFulfillmentMethodResponse {
521
+ }
522
+ export interface QueryFulfillmentMethodsRequest {
523
+ /** The query by which to select fulfillment methods. */
524
+ query?: CursorQuery;
525
+ }
526
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
527
+ /** 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`. */
528
+ cursorPaging?: CursorPaging;
529
+ /**
530
+ * Filter object in the following format:
531
+ * `"filter" : {
532
+ * "fieldName1": "value1",
533
+ * "fieldName2":{"$operator":"value2"}
534
+ * }`
535
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
536
+ */
537
+ filter?: Record<string, any> | null;
538
+ /**
539
+ * Sort object in the following format:
540
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
541
+ */
542
+ sort?: Sorting[];
543
+ }
544
+ /** @oneof */
545
+ export interface CursorQueryPagingMethodOneOf {
546
+ /** 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`. */
547
+ cursorPaging?: CursorPaging;
548
+ }
549
+ export interface Sorting {
550
+ /** Name of the field to sort by. */
551
+ fieldName?: string;
552
+ /** Sort order. */
553
+ order?: SortOrder;
554
+ }
555
+ export declare enum SortOrder {
556
+ ASC = "ASC",
557
+ DESC = "DESC"
558
+ }
559
+ export interface CursorPaging {
560
+ /** Maximum number of items to return in the results. */
561
+ limit?: number | null;
562
+ /**
563
+ * Pointer to the next or previous page in the list of results.
564
+ *
565
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
566
+ * Not relevant for the first request.
567
+ */
568
+ cursor?: string | null;
569
+ }
570
+ export interface QueryFulfillmentMethodsResponse {
571
+ /** The retrieved fulfillment methods. */
572
+ fulfillmentMethods?: FulfillmentMethod[];
573
+ /** The metadata of the paginated results. */
574
+ pagingMetadata?: CursorPagingMetadata;
575
+ }
576
+ export interface CursorPagingMetadata {
577
+ /** Number of items returned in the response. */
578
+ count?: number | null;
579
+ /** Cursor strings that point to the next page, previous page, or both. */
580
+ cursors?: Cursors;
581
+ /**
582
+ * Whether there are more pages to retrieve following the current page.
583
+ *
584
+ * + `true`: Another page of results can be retrieved.
585
+ * + `false`: This is the last page.
586
+ */
587
+ hasNext?: boolean | null;
588
+ }
589
+ export interface Cursors {
590
+ /** Cursor string pointing to the next page in the list of results. */
591
+ next?: string | null;
592
+ /** Cursor pointing to the previous page in the list of results. */
593
+ prev?: string | null;
594
+ }
595
+ export interface ListFulfillmentMethodsRequest {
596
+ /** Cursor paging */
597
+ cursorPaging?: CursorPaging;
598
+ }
599
+ export interface ListFulfillmentMethodsResponse {
600
+ /** The retrieved fulfillment methods. */
601
+ fulfillmentMethods?: FulfillmentMethod[];
602
+ /** The metadata of the paginated results. */
603
+ pagingMetadata?: CursorPagingMetadata;
604
+ }
605
+ export interface ListAvailableFulfillmentMethodsForAddressRequest {
606
+ /** The address by which to filter delivery fulfillment methods. */
607
+ address?: CommonAddress;
608
+ /** Cursor paging */
609
+ cursorPaging?: CursorPaging;
610
+ /** If provided, only fulfillment methods with the given IDs will be returned. */
611
+ fulfillmentMethodIds?: string[];
612
+ }
613
+ export interface ListAvailableFulfillmentMethodsForAddressResponse {
614
+ /** The retrieved fulfillment methods. */
615
+ fulfillmentMethods?: FulfillmentMethod[];
616
+ /** The metadata of the paginated results. */
617
+ pagingMetadata?: CursorPagingMetadata;
618
+ }
619
+ export interface ListActiveFulfillmentMethodsRequest {
620
+ /** Only fulfillment methods with the given IDs will be returned. */
621
+ fulfillmentMethodIds?: string[];
622
+ /** Cursor paging */
623
+ cursorPaging?: CursorPaging;
624
+ }
625
+ export interface ListActiveFulfillmentMethodsResponse {
626
+ /** The enabled fulfillment methods. */
627
+ fulfillmentMethods?: FulfillmentMethod[];
628
+ /** The metadata of the paginated results. */
629
+ pagingMetadata?: CursorPagingMetadata;
630
+ }
631
+ export interface GetAccumulatedFulfillmentMethodsAvailabilityRequest {
632
+ /** fulfillment method ids to check availability for. */
633
+ fulfillmentMethodIds?: string[];
634
+ }
635
+ export interface GetAccumulatedFulfillmentMethodsAvailabilityResponse {
636
+ /** The accumulated availability of all fulfillment methods. */
637
+ availability?: Availability;
638
+ /** Fulfillment methods types that accumulate availability. */
639
+ types?: FulfillmentMethodType[];
640
+ }
641
+ export interface GetCombinedMethodAvailabilityRequest {
642
+ /** IDs of fulfillment methods used to determine the combined availability. */
643
+ fulfillmentMethodIds: string[];
644
+ }
645
+ export interface GetCombinedMethodAvailabilityResponse {
646
+ /** The combined availability of the given fulfillment methods. */
647
+ combinedAvailability?: Availability;
648
+ /** Types of fulfillment methods available during at least some the combined availability's `availableTimes`. */
649
+ fulfillmentTypes?: FulfillmentMethodType[];
650
+ }
651
+ export interface GetAggregatedMethodAvailabilityRequest {
652
+ /** IDs of fulfillment methods used to determine the aggregated availability. */
653
+ fulfillmentMethodIds: string[];
654
+ }
655
+ export interface GetAggregatedMethodAvailabilityResponse {
656
+ /** The aggregated availability of the given fulfillment methods. */
657
+ aggregatedAvailability?: Availability;
658
+ /** Types of fulfillment methods available during at least some the aggregated availability's `availableTimes`. */
659
+ fulfillmentTypes?: FulfillmentMethodType[];
660
+ }
661
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
662
+ export interface SitePropertiesNotification {
663
+ /** The site ID for which this update notification applies. */
664
+ metasiteId?: string;
665
+ /** The actual update event. */
666
+ event?: SitePropertiesEvent;
667
+ /** A convenience set of mappings from the MetaSite ID to its constituent services. */
668
+ translations?: Translation[];
669
+ /** Context of the notification */
670
+ changeContext?: ChangeContext;
671
+ }
672
+ /** The actual update event for a particular notification. */
673
+ export interface SitePropertiesEvent {
674
+ /** Version of the site's properties represented by this update. */
675
+ version?: number;
676
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
677
+ fields?: string[];
678
+ /** Updated properties. */
679
+ properties?: Properties;
680
+ }
681
+ export interface Properties {
682
+ /** Site categories. */
683
+ categories?: Categories;
684
+ /** Site locale. */
685
+ locale?: Locale;
686
+ /**
687
+ * Site language.
688
+ *
689
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
690
+ */
691
+ language?: string | null;
692
+ /**
693
+ * Site currency format used to bill customers.
694
+ *
695
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
696
+ */
697
+ paymentCurrency?: string | null;
698
+ /** Timezone in `America/New_York` format. */
699
+ timeZone?: string | null;
700
+ /** Email address. */
701
+ email?: string | null;
702
+ /** Phone number. */
703
+ phone?: string | null;
704
+ /** Fax number. */
705
+ fax?: string | null;
706
+ /** Address. */
707
+ address?: Address;
708
+ /** Site display name. */
709
+ siteDisplayName?: string | null;
710
+ /** Business name. */
711
+ businessName?: string | null;
712
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
713
+ logo?: string | null;
714
+ /** Site description. */
715
+ description?: string | null;
716
+ /**
717
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
718
+ *
719
+ * __Note:__ Not supported by Wix Bookings.
720
+ */
721
+ businessSchedule?: BusinessSchedule;
722
+ /** Supported languages of a site and the primary language. */
723
+ multilingual?: Multilingual;
724
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
725
+ consentPolicy?: ConsentPolicy;
726
+ /**
727
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
728
+ *
729
+ * Site business type.
730
+ */
731
+ businessConfig?: string | null;
732
+ /** External site URL that uses Wix as its headless business solution. */
733
+ externalSiteUrl?: string | null;
734
+ /** Track clicks analytics. */
735
+ trackClicksAnalytics?: boolean;
736
+ }
737
+ export interface Categories {
738
+ /** Primary site category. */
739
+ primary?: string;
740
+ /** Secondary site category. */
741
+ secondary?: string[];
742
+ /** Business Term Id */
743
+ businessTermId?: string | null;
744
+ }
745
+ export interface Locale {
746
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
747
+ languageCode?: string;
748
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
749
+ country?: string;
750
+ }
751
+ export interface Address {
752
+ /** Street name. */
753
+ street?: string;
754
+ /** City name. */
755
+ city?: string;
756
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
757
+ country?: string;
758
+ /** State. */
759
+ state?: string;
760
+ /** Zip or postal code. */
761
+ zip?: string;
762
+ /** Extra information to be displayed in the address. */
763
+ hint?: AddressHint;
764
+ /** Whether this address represents a physical location. */
765
+ isPhysical?: boolean;
766
+ /** Google-formatted version of this address. */
767
+ googleFormattedAddress?: string;
768
+ /** Street number. */
769
+ streetNumber?: string;
770
+ /** Apartment number. */
771
+ apartmentNumber?: string;
772
+ /** Geographic coordinates of location. */
773
+ coordinates?: GeoCoordinates;
774
+ }
775
+ /**
776
+ * Extra information on displayed addresses.
777
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
778
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
779
+ */
780
+ export interface AddressHint {
781
+ /** Extra text displayed next to, or instead of, the actual address. */
782
+ text?: string;
783
+ /** Where the extra text should be displayed. */
784
+ placement?: PlacementType;
785
+ }
786
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
787
+ export declare enum PlacementType {
788
+ BEFORE = "BEFORE",
789
+ AFTER = "AFTER",
790
+ REPLACE = "REPLACE"
791
+ }
792
+ /** Geocoordinates for a particular address. */
793
+ export interface GeoCoordinates {
794
+ /** Latitude of the location. Must be between -90 and 90. */
795
+ latitude?: number;
796
+ /** Longitude of the location. Must be between -180 and 180. */
797
+ longitude?: number;
798
+ }
799
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
800
+ export interface BusinessSchedule {
801
+ /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
802
+ periods?: TimePeriod[];
803
+ /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
804
+ specialHourPeriod?: SpecialHourPeriod[];
805
+ }
806
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
807
+ export interface TimePeriod {
808
+ /** Day of the week the period starts on. */
809
+ openDay?: DayOfWeek;
810
+ /**
811
+ * 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
812
+ * midnight at the end of the specified day.
813
+ */
814
+ openTime?: string;
815
+ /** Day of the week the period ends on. */
816
+ closeDay?: DayOfWeek;
817
+ /**
818
+ * 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
819
+ * midnight at the end of the specified day.
820
+ *
821
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
822
+ */
823
+ closeTime?: string;
824
+ }
825
+ /** Enumerates the days of the week. */
826
+ export declare enum DayOfWeek {
827
+ MONDAY = "MONDAY",
828
+ TUESDAY = "TUESDAY",
829
+ WEDNESDAY = "WEDNESDAY",
830
+ THURSDAY = "THURSDAY",
831
+ FRIDAY = "FRIDAY",
832
+ SATURDAY = "SATURDAY",
833
+ SUNDAY = "SUNDAY"
834
+ }
835
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
836
+ export interface SpecialHourPeriod {
837
+ /** 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). */
838
+ startDate?: string;
839
+ /** 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). */
840
+ endDate?: string;
841
+ /**
842
+ * Whether the business is closed (or the service is not available) during the exception.
843
+ *
844
+ * Default: `true`.
845
+ */
846
+ isClosed?: boolean;
847
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
848
+ comment?: string;
849
+ }
850
+ export interface Multilingual {
851
+ /** Supported languages list. */
852
+ supportedLanguages?: SupportedLanguage[];
853
+ /** Whether to redirect to user language. */
854
+ autoRedirect?: boolean;
855
+ }
856
+ export interface SupportedLanguage {
857
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
858
+ languageCode?: string;
859
+ /** Locale. */
860
+ locale?: Locale;
861
+ /** Whether the supported language is the primary language for the site. */
862
+ isPrimary?: boolean;
863
+ /** Language icon. */
864
+ countryCode?: string;
865
+ /** How the language will be resolved. For internal use. */
866
+ resolutionMethod?: ResolutionMethod;
867
+ }
868
+ export declare enum ResolutionMethod {
869
+ QUERY_PARAM = "QUERY_PARAM",
870
+ SUBDOMAIN = "SUBDOMAIN",
871
+ SUBDIRECTORY = "SUBDIRECTORY"
872
+ }
873
+ export interface ConsentPolicy {
874
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
875
+ essential?: boolean | null;
876
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
877
+ functional?: boolean | null;
878
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
879
+ analytics?: boolean | null;
880
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
881
+ advertising?: boolean | null;
882
+ /** CCPA compliance flag. */
883
+ dataToThirdParty?: boolean | null;
884
+ }
885
+ /** A single mapping from the MetaSite ID to a particular service. */
886
+ export interface Translation {
887
+ /** The service type. */
888
+ serviceType?: string;
889
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
890
+ appDefId?: string;
891
+ /** The instance ID of the service. */
892
+ instanceId?: string;
893
+ }
894
+ export interface ChangeContext extends ChangeContextPayloadOneOf {
895
+ /** Properties were updated. */
896
+ propertiesChange?: PropertiesChange;
897
+ /** Default properties were created on site creation. */
898
+ siteCreated?: SiteCreated;
899
+ /** Properties were cloned on site cloning. */
900
+ siteCloned?: SiteCloned;
901
+ }
902
+ /** @oneof */
903
+ export interface ChangeContextPayloadOneOf {
904
+ /** Properties were updated. */
905
+ propertiesChange?: PropertiesChange;
906
+ /** Default properties were created on site creation. */
907
+ siteCreated?: SiteCreated;
908
+ /** Properties were cloned on site cloning. */
909
+ siteCloned?: SiteCloned;
910
+ }
911
+ export interface PropertiesChange {
912
+ }
913
+ export interface SiteCreated {
914
+ /** Origin template site id. */
915
+ originTemplateId?: string | null;
916
+ }
917
+ export interface SiteCloned {
918
+ /** Origin site id. */
919
+ originMetaSiteId?: string;
920
+ }
921
+ export interface Empty {
922
+ }
923
+ interface StreetAddressNonNullableFields {
924
+ number: string;
925
+ name: string;
926
+ apt: string;
927
+ }
928
+ interface SubdivisionNonNullableFields {
929
+ name: string;
930
+ }
931
+ interface CommonAddressNonNullableFields {
932
+ streetAddress?: StreetAddressNonNullableFields;
933
+ subdivisions: SubdivisionNonNullableFields[];
934
+ }
935
+ interface PickupInfoNonNullableFields {
936
+ address?: CommonAddressNonNullableFields;
937
+ }
938
+ interface RadiusNonNullableFields {
939
+ centerPointAddress?: CommonAddressNonNullableFields;
940
+ unit: Unit;
941
+ }
942
+ interface DeliveryAreaNonNullableFields {
943
+ radiusOptions?: RadiusNonNullableFields;
944
+ type: Type;
945
+ }
946
+ interface DeliveryInfoNonNullableFields {
947
+ deliveryArea?: DeliveryAreaNonNullableFields;
948
+ }
949
+ interface TimeOfDayNonNullableFields {
950
+ hours: number;
951
+ minutes: number;
952
+ }
953
+ interface TimeOfDayRangeNonNullableFields {
954
+ startTime?: TimeOfDayNonNullableFields;
955
+ endTime?: TimeOfDayNonNullableFields;
956
+ }
957
+ interface DayOfWeekAvailabilityNonNullableFields {
958
+ dayOfWeek: EntitiesDayOfWeek;
959
+ timeRanges: TimeOfDayRangeNonNullableFields[];
960
+ }
961
+ interface AvailabilityNonNullableFields {
962
+ availableTimes: DayOfWeekAvailabilityNonNullableFields[];
963
+ }
964
+ export interface FulfillmentMethodNonNullableFields {
965
+ pickupOptions?: PickupInfoNonNullableFields;
966
+ deliveryOptions?: DeliveryInfoNonNullableFields;
967
+ type: FulfillmentMethodType;
968
+ availability?: AvailabilityNonNullableFields;
969
+ }
970
+ export interface CreateFulfillmentMethodResponseNonNullableFields {
971
+ fulfillmentMethod?: FulfillmentMethodNonNullableFields;
972
+ }
973
+ export interface GetFulfillmentMethodResponseNonNullableFields {
974
+ fulfillmentMethod?: FulfillmentMethodNonNullableFields;
975
+ }
976
+ export interface UpdateFulfillmentMethodResponseNonNullableFields {
977
+ fulfillmentMethod?: FulfillmentMethodNonNullableFields;
978
+ }
979
+ export interface QueryFulfillmentMethodsResponseNonNullableFields {
980
+ fulfillmentMethods: FulfillmentMethodNonNullableFields[];
981
+ }
982
+ export interface ListFulfillmentMethodsResponseNonNullableFields {
983
+ fulfillmentMethods: FulfillmentMethodNonNullableFields[];
984
+ }
985
+ export interface ListAvailableFulfillmentMethodsForAddressResponseNonNullableFields {
986
+ fulfillmentMethods: FulfillmentMethodNonNullableFields[];
987
+ }
988
+ export interface GetAccumulatedFulfillmentMethodsAvailabilityResponseNonNullableFields {
989
+ availability?: AvailabilityNonNullableFields;
990
+ types: FulfillmentMethodType[];
991
+ }
992
+ export interface GetCombinedMethodAvailabilityResponseNonNullableFields {
993
+ combinedAvailability?: AvailabilityNonNullableFields;
994
+ fulfillmentTypes: FulfillmentMethodType[];
995
+ }
996
+ export interface GetAggregatedMethodAvailabilityResponseNonNullableFields {
997
+ aggregatedAvailability?: AvailabilityNonNullableFields;
998
+ fulfillmentTypes: FulfillmentMethodType[];
999
+ }
1000
+ export interface BaseEventMetadata {
1001
+ /** App instance ID. */
1002
+ instanceId?: string | null;
1003
+ /** Event type. */
1004
+ eventType?: string;
1005
+ /** The identification type and identity data. */
1006
+ identity?: IdentificationData;
1007
+ }
1008
+ export interface EventMetadata extends BaseEventMetadata {
1009
+ /**
1010
+ * Unique event ID.
1011
+ * Allows clients to ignore duplicate webhooks.
1012
+ */
1013
+ _id?: string;
1014
+ /**
1015
+ * Assumes actions are also always typed to an entity_type
1016
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1017
+ */
1018
+ entityFqdn?: string;
1019
+ /**
1020
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1021
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1022
+ * Example: created/updated/deleted/started/completed/email_opened
1023
+ */
1024
+ slug?: string;
1025
+ /** ID of the entity associated with the event. */
1026
+ entityId?: string;
1027
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1028
+ eventTime?: Date | null;
1029
+ /**
1030
+ * Whether the event was triggered as a result of a privacy regulation application
1031
+ * (for example, GDPR).
1032
+ */
1033
+ triggeredByAnonymizeRequest?: boolean | null;
1034
+ /** If present, indicates the action that triggered the event. */
1035
+ originatedFrom?: string | null;
1036
+ /**
1037
+ * A sequence number defining the order of updates to the underlying entity.
1038
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1039
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1040
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1041
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1042
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1043
+ */
1044
+ entityEventSequence?: string | null;
1045
+ }
1046
+ export interface FulfillmentMethodCreatedEnvelope {
1047
+ entity: FulfillmentMethod;
1048
+ metadata: EventMetadata;
1049
+ }
1050
+ /** @permissionScope Manage Restaurants - all permissions
1051
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1052
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1053
+ * @webhook
1054
+ * @eventType wix.restaurants.v1.fulfillment_method_created
1055
+ * @documentationMaturity preview
1056
+ */
1057
+ export declare function onFulfillmentMethodCreated(handler: (event: FulfillmentMethodCreatedEnvelope) => void | Promise<void>): void;
1058
+ export interface FulfillmentMethodDeletedEnvelope {
1059
+ metadata: EventMetadata;
1060
+ }
1061
+ /**
1062
+ * Triggered when a fulfillment method is deleted.
1063
+ * @permissionScope Manage Restaurants - all permissions
1064
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1065
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1066
+ * @webhook
1067
+ * @eventType wix.restaurants.v1.fulfillment_method_deleted
1068
+ * @documentationMaturity preview
1069
+ */
1070
+ export declare function onFulfillmentMethodDeleted(handler: (event: FulfillmentMethodDeletedEnvelope) => void | Promise<void>): void;
1071
+ export interface FulfillmentMethodUpdatedEnvelope {
1072
+ entity: FulfillmentMethod;
1073
+ metadata: EventMetadata;
1074
+ }
1075
+ /**
1076
+ * Triggered when a fulfillment method is updated.
1077
+ * @permissionScope Manage Restaurants - all permissions
1078
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1079
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1080
+ * @webhook
1081
+ * @eventType wix.restaurants.v1.fulfillment_method_updated
1082
+ * @documentationMaturity preview
1083
+ */
1084
+ export declare function onFulfillmentMethodUpdated(handler: (event: FulfillmentMethodUpdatedEnvelope) => void | Promise<void>): void;
1085
+ /**
1086
+ * Creates a new fulfillment method.
1087
+ *
1088
+ * >**Note:** `fulfillmentMethod.availability.time_zone` uses the time zone specified in the [`language and regions`](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsettings/language-and-region) settings in the dashboard, regardless of the value provided.
1089
+ * @param fulfillmentMethod - Fulfillment method to create.
1090
+ * @public
1091
+ * @documentationMaturity preview
1092
+ * @requiredField fulfillmentMethod
1093
+ * @requiredField fulfillmentMethod.availability.timeZone
1094
+ * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea
1095
+ * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea.postalCodeOptions.countryCode
1096
+ * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea.radiusOptions.centerPointAddress
1097
+ * @requiredField fulfillmentMethod.pickupOptions.address
1098
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_CREATE
1099
+ * @permissionScope Manage Restaurants - all permissions
1100
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1101
+ * @applicableIdentity APP
1102
+ * @returns The created fulfillment method.
1103
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.CreateFulfillmentMethod
1104
+ */
1105
+ export declare function createFulfillmentMethod(fulfillmentMethod: FulfillmentMethod): Promise<FulfillmentMethod & FulfillmentMethodNonNullableFields>;
1106
+ /**
1107
+ * Retrieves a fulfillment method.
1108
+ * @param fulfillmentMethodId - The ID of the fulfillment method to retrieve.
1109
+ * @public
1110
+ * @documentationMaturity preview
1111
+ * @requiredField fulfillmentMethodId
1112
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1113
+ * @permissionScope Manage Restaurants - all permissions
1114
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1115
+ * @applicableIdentity APP
1116
+ * @applicableIdentity VISITOR
1117
+ * @returns The retrieved fulfillment method.
1118
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.GetFulfillmentMethod
1119
+ */
1120
+ export declare function getFulfillmentMethod(fulfillmentMethodId: string): Promise<FulfillmentMethod & FulfillmentMethodNonNullableFields>;
1121
+ /**
1122
+ * Updates a fulfillment method.
1123
+ *
1124
+ * Each time the fulfillment method is updated, its revision increments by 1. The existing revision must be included when updating the fulfillment method. This ensures you're working with the latest fulfillment method information, and it prevents unintended overwrites.
1125
+ * @param _id - Fulfillment method ID.
1126
+ * @public
1127
+ * @documentationMaturity preview
1128
+ * @requiredField _id
1129
+ * @requiredField fulfillmentMethod
1130
+ * @requiredField fulfillmentMethod.revision
1131
+ * @param fulfillmentMethod - Fulfillment method information to update.
1132
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_UPDATE
1133
+ * @permissionScope Manage Restaurants - all permissions
1134
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1135
+ * @applicableIdentity APP
1136
+ * @returns The updated fulfillment method.
1137
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.UpdateFulfillmentMethod
1138
+ */
1139
+ export declare function updateFulfillmentMethod(_id: string | null, fulfillmentMethod: UpdateFulfillmentMethod): Promise<FulfillmentMethod & FulfillmentMethodNonNullableFields>;
1140
+ export interface UpdateFulfillmentMethod {
1141
+ /** Data specific for pickup fulfillment method. */
1142
+ pickupOptions?: PickupInfo;
1143
+ /** Data specific for delivery fulfillment method. */
1144
+ deliveryOptions?: DeliveryInfo;
1145
+ /**
1146
+ * Fulfillment method ID.
1147
+ * @readonly
1148
+ */
1149
+ _id?: string | null;
1150
+ /**
1151
+ * The current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.
1152
+ * @readonly
1153
+ */
1154
+ revision?: string | null;
1155
+ /**
1156
+ * Date and time the fulfillment method was created.
1157
+ * @readonly
1158
+ */
1159
+ _createdDate?: Date | null;
1160
+ /**
1161
+ * Date and time the fulfillment method was last updated.
1162
+ * @readonly
1163
+ */
1164
+ _updatedDate?: Date | null;
1165
+ /** Type of fulfillment method. */
1166
+ type?: FulfillmentMethodType;
1167
+ /** Fulfillment method name. */
1168
+ name?: string | null;
1169
+ /** Whether the fulfillment method is enabled. */
1170
+ enabled?: boolean | null;
1171
+ /** Fee for using this fulfillment method. */
1172
+ fee?: string | null;
1173
+ /** Availability of this fulfillment method. */
1174
+ availability?: Availability;
1175
+ /** Minimum order price to qualify for using this fulfillment method. */
1176
+ minOrderPrice?: string | null;
1177
+ }
1178
+ /**
1179
+ * Deletes a fulfillment method.
1180
+ * @param fulfillmentMethodId - The ID of the fulfillment method to delete.
1181
+ * @public
1182
+ * @documentationMaturity preview
1183
+ * @requiredField fulfillmentMethodId
1184
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_DELETE
1185
+ * @permissionScope Manage Restaurants - all permissions
1186
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1187
+ * @applicableIdentity APP
1188
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.DeleteFulfillmentMethod
1189
+ */
1190
+ export declare function deleteFulfillmentMethod(fulfillmentMethodId: string): Promise<void>;
1191
+ /**
1192
+ * Creates a query to retrieve a list of fulfillment methods.
1193
+ *
1194
+ * The `queryFulfillmentMethods()` function builds a query to retrieve a list of fulfillment methods and returns a `FulfillmentMethodsQueryBuilder` object.
1195
+ *
1196
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/fulfillment-methods/fulfillment-methods-query-builder/find) function.
1197
+ *
1198
+ * You can refine the query by chaining `FulfillmentMethodsQueryBuilder` functions onto the query. `FulfillmentMethodsQueryBuilder` functions enable you to filter, sort, and control the results that `queryFulfillmentMethods()` returns.
1199
+ *
1200
+ * `queryFulfillmentMethods()` runs with the following `FulfillmentMethodsQueryBuilder` defaults, which you can override:
1201
+ *
1202
+ * * [`limit(50)`](/fulfillment-methods/fulfillment-methods-query-builder/limit)
1203
+ * * [`ascending('entityId')`](/fulfillment-methods/fulfillment-methods-query-builder/ascending)
1204
+ *
1205
+ * The following `FulfillmentMethodsQueryBuilder` functions are supported for `queryFulfillmentMethods()`. For a full description of the fulfillment method object, see the object returned for the [`items`](/fulfillment-methods/fulfillment-methods-query-result/items) property in `FulfillmentMethodsQueryResult`.
1206
+ * @public
1207
+ * @documentationMaturity preview
1208
+ * @permissionScope Manage Restaurants - all permissions
1209
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1210
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1211
+ * @applicableIdentity APP
1212
+ * @applicableIdentity VISITOR
1213
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.QueryFulfillmentMethods
1214
+ */
1215
+ export declare function queryFulfillmentMethods(options?: QueryFulfillmentMethodsOptions): FulfillmentMethodsQueryBuilder;
1216
+ export interface QueryFulfillmentMethodsOptions {
1217
+ }
1218
+ interface QueryCursorResult {
1219
+ cursors: Cursors;
1220
+ hasNext: () => boolean;
1221
+ hasPrev: () => boolean;
1222
+ length: number;
1223
+ pageSize: number;
1224
+ }
1225
+ export interface FulfillmentMethodsQueryResult extends QueryCursorResult {
1226
+ items: FulfillmentMethod[];
1227
+ query: FulfillmentMethodsQueryBuilder;
1228
+ next: () => Promise<FulfillmentMethodsQueryResult>;
1229
+ prev: () => Promise<FulfillmentMethodsQueryResult>;
1230
+ }
1231
+ export interface FulfillmentMethodsQueryBuilder {
1232
+ /** @param propertyName - Property whose value is compared with `value`.
1233
+ * @param value - Value to compare against.
1234
+ * @documentationMaturity preview
1235
+ */
1236
+ eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice', value: any) => FulfillmentMethodsQueryBuilder;
1237
+ /** @param propertyName - Property whose value is compared with `value`.
1238
+ * @param value - Value to compare against.
1239
+ * @documentationMaturity preview
1240
+ */
1241
+ ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice', value: any) => FulfillmentMethodsQueryBuilder;
1242
+ /** @param propertyName - Property whose value is compared with `value`.
1243
+ * @param value - Value to compare against.
1244
+ * @documentationMaturity preview
1245
+ */
1246
+ ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => FulfillmentMethodsQueryBuilder;
1247
+ /** @param propertyName - Property whose value is compared with `value`.
1248
+ * @param value - Value to compare against.
1249
+ * @documentationMaturity preview
1250
+ */
1251
+ gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => FulfillmentMethodsQueryBuilder;
1252
+ /** @param propertyName - Property whose value is compared with `value`.
1253
+ * @param value - Value to compare against.
1254
+ * @documentationMaturity preview
1255
+ */
1256
+ le: (propertyName: '_createdDate' | '_updatedDate', value: any) => FulfillmentMethodsQueryBuilder;
1257
+ /** @param propertyName - Property whose value is compared with `value`.
1258
+ * @param value - Value to compare against.
1259
+ * @documentationMaturity preview
1260
+ */
1261
+ lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => FulfillmentMethodsQueryBuilder;
1262
+ /** @param propertyName - Property whose value is compared with `string`.
1263
+ * @param string - String to compare against. Case-insensitive.
1264
+ * @documentationMaturity preview
1265
+ */
1266
+ startsWith: (propertyName: '_id' | 'name' | 'fee' | 'minOrderPrice', value: string) => FulfillmentMethodsQueryBuilder;
1267
+ /** @param propertyName - Property whose value is compared with `values`.
1268
+ * @param values - List of values to compare against.
1269
+ * @documentationMaturity preview
1270
+ */
1271
+ hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice', value: any[]) => FulfillmentMethodsQueryBuilder;
1272
+ /** @documentationMaturity preview */
1273
+ in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice', value: any) => FulfillmentMethodsQueryBuilder;
1274
+ /** @documentationMaturity preview */
1275
+ exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice', value: boolean) => FulfillmentMethodsQueryBuilder;
1276
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1277
+ * @documentationMaturity preview
1278
+ */
1279
+ ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice'>) => FulfillmentMethodsQueryBuilder;
1280
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1281
+ * @documentationMaturity preview
1282
+ */
1283
+ descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'type' | 'name' | 'enabled' | 'fee' | 'minOrderPrice'>) => FulfillmentMethodsQueryBuilder;
1284
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1285
+ * @documentationMaturity preview
1286
+ */
1287
+ limit: (limit: number) => FulfillmentMethodsQueryBuilder;
1288
+ /** @param cursor - A pointer to specific record
1289
+ * @documentationMaturity preview
1290
+ */
1291
+ skipTo: (cursor: string) => FulfillmentMethodsQueryBuilder;
1292
+ /** @documentationMaturity preview */
1293
+ find: () => Promise<FulfillmentMethodsQueryResult>;
1294
+ }
1295
+ /**
1296
+ * Retrieves a list of up to 100 fulfillment methods.
1297
+ * @public
1298
+ * @documentationMaturity preview
1299
+ * @param options - Options for listing the fulfillment methods.
1300
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1301
+ * @permissionScope Manage Restaurants - all permissions
1302
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1303
+ * @applicableIdentity APP
1304
+ * @applicableIdentity VISITOR
1305
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.ListFulfillmentMethods
1306
+ */
1307
+ export declare function listFulfillmentMethods(options?: ListFulfillmentMethodsOptions): Promise<ListFulfillmentMethodsResponse & ListFulfillmentMethodsResponseNonNullableFields>;
1308
+ export interface ListFulfillmentMethodsOptions {
1309
+ /** Cursor paging */
1310
+ cursorPaging?: CursorPaging;
1311
+ }
1312
+ /**
1313
+ * Retrieves a list of up to 100 fulfillment methods available for a given address.
1314
+ *
1315
+ * The response will only include:
1316
+ * - Non-delivery fulfillment methods.
1317
+ * - Delivery fulfillment methods that are available to the given address according to their delivery areas.
1318
+ * @public
1319
+ * @documentationMaturity preview
1320
+ * @param options - Options for listing the available fulfillment methods.
1321
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1322
+ * @permissionScope Manage Restaurants - all permissions
1323
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1324
+ * @applicableIdentity APP
1325
+ * @applicableIdentity VISITOR
1326
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.ListAvailableFulfillmentMethodsForAddress
1327
+ */
1328
+ export declare function listAvailableFulfillmentMethodsForAddress(options?: ListAvailableFulfillmentMethodsForAddressOptions): Promise<ListAvailableFulfillmentMethodsForAddressResponse & ListAvailableFulfillmentMethodsForAddressResponseNonNullableFields>;
1329
+ export interface ListAvailableFulfillmentMethodsForAddressOptions {
1330
+ /** The address by which to filter delivery fulfillment methods. */
1331
+ address?: CommonAddress;
1332
+ /** Cursor paging */
1333
+ cursorPaging?: CursorPaging;
1334
+ /** If provided, only fulfillment methods with the given IDs will be returned. */
1335
+ fulfillmentMethodIds?: string[];
1336
+ }
1337
+ /**
1338
+ * Retrieves the accumulated availability of all fulfillment methods.
1339
+ * @public
1340
+ * @documentationMaturity preview
1341
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1342
+ * @permissionScope Manage Restaurants - all permissions
1343
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1344
+ * @applicableIdentity APP
1345
+ * @applicableIdentity VISITOR
1346
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.GetAccumulatedFulfillmentMethodsAvailability
1347
+ * @deprecated method is deprecated due to...
1348
+ * @replacedBy GetCombinedMethodAvailability
1349
+ * @targetRemovalDate 2024-09-29
1350
+ */
1351
+ export declare function getAccumulatedFulfillmentMethodsAvailability(options?: GetAccumulatedFulfillmentMethodsAvailabilityOptions): Promise<GetAccumulatedFulfillmentMethodsAvailabilityResponse & GetAccumulatedFulfillmentMethodsAvailabilityResponseNonNullableFields>;
1352
+ export interface GetAccumulatedFulfillmentMethodsAvailabilityOptions {
1353
+ /** fulfillment method ids to check availability for. */
1354
+ fulfillmentMethodIds?: string[];
1355
+ }
1356
+ /**
1357
+ * Retrieves the combined availability of a list of fulfillment methods.
1358
+ *
1359
+ * The combined availability is a list of times during which one or more of the given fulfillment methods is available, and the types of those fulfillment methods.
1360
+ * @param fulfillmentMethodIds - IDs of fulfillment methods used to determine the combined availability.
1361
+ * @public
1362
+ * @documentationMaturity preview
1363
+ * @requiredField fulfillmentMethodIds
1364
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1365
+ * @permissionScope Manage Restaurants - all permissions
1366
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1367
+ * @applicableIdentity APP
1368
+ * @applicableIdentity VISITOR
1369
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.GetCombinedMethodAvailability
1370
+ * @deprecated
1371
+ * @replacedBy GetAggregatedMethodAvailability
1372
+ * @targetRemovalDate 2025-02-10
1373
+ */
1374
+ export declare function getCombinedMethodAvailability(fulfillmentMethodIds: string[]): Promise<GetCombinedMethodAvailabilityResponse & GetCombinedMethodAvailabilityResponseNonNullableFields>;
1375
+ /** @param fulfillmentMethodIds - IDs of fulfillment methods used to determine the aggregated availability.
1376
+ * @public
1377
+ * @documentationMaturity preview
1378
+ * @requiredField fulfillmentMethodIds
1379
+ * @permissionId RESTAURANTS.FULFILLMENT_METHOD_READ
1380
+ * @permissionScope Manage Restaurants - all permissions
1381
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1382
+ * @applicableIdentity APP
1383
+ * @applicableIdentity VISITOR
1384
+ * @fqn wix.restaurants.fulfillment.v1.FulfillmentMethodsService.GetAggregatedMethodAvailability
1385
+ */
1386
+ export declare function getAggregatedMethodAvailability(fulfillmentMethodIds: string[]): Promise<GetAggregatedMethodAvailabilityResponse & GetAggregatedMethodAvailabilityResponseNonNullableFields>;
1387
+ export {};