@wix/auto_sdk_bookings_add-ons 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 (39) hide show
  1. package/build/cjs/index.d.ts +103 -0
  2. package/build/cjs/index.js +775 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1172 -0
  5. package/build/cjs/index.typings.js +640 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +874 -0
  8. package/build/cjs/meta.js +561 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/es/index.d.mts +103 -0
  11. package/build/es/index.mjs +736 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/index.typings.d.mts +1172 -0
  14. package/build/es/index.typings.mjs +604 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +874 -0
  17. package/build/es/meta.mjs +522 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/es/package.json +3 -0
  20. package/build/internal/cjs/index.d.ts +103 -0
  21. package/build/internal/cjs/index.js +775 -0
  22. package/build/internal/cjs/index.js.map +1 -0
  23. package/build/internal/cjs/index.typings.d.ts +1172 -0
  24. package/build/internal/cjs/index.typings.js +640 -0
  25. package/build/internal/cjs/index.typings.js.map +1 -0
  26. package/build/internal/cjs/meta.d.ts +874 -0
  27. package/build/internal/cjs/meta.js +561 -0
  28. package/build/internal/cjs/meta.js.map +1 -0
  29. package/build/internal/es/index.d.mts +103 -0
  30. package/build/internal/es/index.mjs +736 -0
  31. package/build/internal/es/index.mjs.map +1 -0
  32. package/build/internal/es/index.typings.d.mts +1172 -0
  33. package/build/internal/es/index.typings.mjs +604 -0
  34. package/build/internal/es/index.typings.mjs.map +1 -0
  35. package/build/internal/es/meta.d.mts +874 -0
  36. package/build/internal/es/meta.mjs +522 -0
  37. package/build/internal/es/meta.mjs.map +1 -0
  38. package/meta/package.json +3 -0
  39. package/package.json +54 -0
@@ -0,0 +1,874 @@
1
+ import { CreateAddOnRequest as CreateAddOnRequest$1, CreateAddOnResponse as CreateAddOnResponse$1, GetAddOnRequest as GetAddOnRequest$1, GetAddOnResponse as GetAddOnResponse$1, UpdateAddOnRequest as UpdateAddOnRequest$1, UpdateAddOnResponse as UpdateAddOnResponse$1, DeleteAddOnRequest as DeleteAddOnRequest$1, DeleteAddOnResponse as DeleteAddOnResponse$1, QueryAddOnsRequest as QueryAddOnsRequest$1, QueryAddOnsResponse as QueryAddOnsResponse$1, BulkCreateAddOnsRequest as BulkCreateAddOnsRequest$1, BulkCreateAddOnsResponse as BulkCreateAddOnsResponse$1, BulkUpdateAddOnsRequest as BulkUpdateAddOnsRequest$1, BulkUpdateAddOnsResponse as BulkUpdateAddOnsResponse$1, BulkDeleteAddOnsRequest as BulkDeleteAddOnsRequest$1, BulkDeleteAddOnsResponse as BulkDeleteAddOnsResponse$1 } from './index.typings.mjs';
2
+ import '@wix/sdk-types';
3
+
4
+ /** Add-ons are optional extras that extend business offerings (such as booking services) with additional features, time, or products for an extra cost. */
5
+ interface AddOn extends AddOnAddOnInfoOneOf {
6
+ /**
7
+ * Duration in minutes for duration-based add-ons that extend offering time.
8
+ * @min 1
9
+ * @max 1440
10
+ */
11
+ durationInMinutes?: number;
12
+ /**
13
+ * Maximum quantity customers can purchase for quantity-based add-ons.
14
+ * @min 1
15
+ * @max 9999
16
+ */
17
+ maxQuantity?: number;
18
+ /**
19
+ * Add-on ID.
20
+ * @format GUID
21
+ * @readonly
22
+ */
23
+ id?: string | null;
24
+ /**
25
+ * Revision number, which increments by 1 each time the add-on is updated.
26
+ * To prevent conflicting changes, the current revision must be passed when updating the add-on.
27
+ *
28
+ * Ignored when creating an add-on.
29
+ * @readonly
30
+ */
31
+ revision?: string | null;
32
+ /**
33
+ * Date and time the add-on was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
34
+ * @readonly
35
+ */
36
+ createdDate?: Date | null;
37
+ /**
38
+ * Date and time the add-on was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
39
+ * @readonly
40
+ */
41
+ updatedDate?: Date | null;
42
+ /**
43
+ * Display name of the add-on shown to customers.
44
+ * @minLength 1
45
+ * @maxLength 100
46
+ */
47
+ name?: string | null;
48
+ /** Pricing information for the add-on. */
49
+ price?: Money;
50
+ /**
51
+ * ID of the [tax group](https://dev.wix.com/docs/rest/business-solutions/e-commerce/extensions/tax/tax-groups/introduction) to categorize the add-on for tax calculation in [Wix eCommerce](https://dev.wix.com/docs/rest/business-solutions/e-commerce/introduction).
52
+ * Learn more about [how Wix eCommerce implements tax calculation](https://dev.wix.com/docs/rest/business-solutions/e-commerce/extensions/tax/introduction).
53
+ *
54
+ * This field doesn't apply to custom checkout/billing implementations.
55
+ * @format GUID
56
+ */
57
+ taxGroup?: string | null;
58
+ /** Data extensions enabling users to save custom data related to the add-on. */
59
+ extendedFields?: ExtendedFields;
60
+ /** [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) assigned to add-ons for categorization and filtering purposes. */
61
+ tags?: Tags;
62
+ }
63
+ /** @oneof */
64
+ interface AddOnAddOnInfoOneOf {
65
+ /**
66
+ * Duration in minutes for duration-based add-ons that extend offering time.
67
+ * @min 1
68
+ * @max 1440
69
+ */
70
+ durationInMinutes?: number;
71
+ /**
72
+ * Maximum quantity customers can purchase for quantity-based add-ons.
73
+ * @min 1
74
+ * @max 9999
75
+ */
76
+ maxQuantity?: number;
77
+ }
78
+ /**
79
+ * Money.
80
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
81
+ */
82
+ interface Money {
83
+ /**
84
+ * Add-on price amount as a decimal string with period as decimal separator. For example, `3.99` for a $3.99 add-on or `15.00` for a $15.00 add-on.
85
+ * @format DECIMAL_VALUE
86
+ * @decimalValue options { gte:0, lte:1000000000000000, maxScale:2 }
87
+ */
88
+ value?: string;
89
+ /**
90
+ * Currency code for the add-on price. Must be a valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. For example, `USD` for US dollars or `EUR` for euros.
91
+ * @format CURRENCY
92
+ */
93
+ currency?: string;
94
+ /**
95
+ * Add-on price amount as a decimal string in local format for display purposes. For example, `$3.99` for US format or `3,99 €` for European format.
96
+ * @maxLength 50
97
+ */
98
+ formattedValue?: string | null;
99
+ }
100
+ interface ExtendedFields {
101
+ /**
102
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
103
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
104
+ *
105
+ * You can only access fields for which you have the appropriate permissions.
106
+ *
107
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
108
+ */
109
+ namespaces?: Record<string, Record<string, any>>;
110
+ }
111
+ /**
112
+ * Common object for tags.
113
+ * Should be use as in this example:
114
+ * message Foo {
115
+ * string id = 1;
116
+ * ...
117
+ * Tags tags = 5
118
+ * }
119
+ *
120
+ * example of taggable entity
121
+ * {
122
+ * id: "123"
123
+ * tags: {
124
+ * tags: {
125
+ * tag_ids:["11","22"]
126
+ * },
127
+ * private_tags: {
128
+ * tag_ids: ["33", "44"]
129
+ * }
130
+ * }
131
+ * }
132
+ */
133
+ interface Tags {
134
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
135
+ privateTags?: TagList;
136
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
137
+ tags?: TagList;
138
+ }
139
+ interface TagList {
140
+ /**
141
+ * List of tag IDs
142
+ * @maxSize 100
143
+ * @maxLength 5
144
+ */
145
+ tagIds?: string[];
146
+ }
147
+ interface CreateAddOnRequest {
148
+ /** Add-on to create. */
149
+ addOn: AddOn;
150
+ }
151
+ interface CreateAddOnResponse {
152
+ /** Created add-on. */
153
+ addOn?: AddOn;
154
+ }
155
+ interface GetAddOnRequest {
156
+ /**
157
+ * ID of the add-on to retrieve.
158
+ * @format GUID
159
+ */
160
+ addOnId: string;
161
+ }
162
+ interface GetAddOnResponse {
163
+ /** Retrieved add-on. */
164
+ addOn?: AddOn;
165
+ }
166
+ interface UpdateAddOnRequest {
167
+ /** Add-on to update. */
168
+ addOn: AddOn;
169
+ }
170
+ interface UpdateAddOnResponse {
171
+ /** Updated add-on. */
172
+ addOn?: AddOn;
173
+ }
174
+ interface DeleteAddOnRequest {
175
+ /**
176
+ * ID of the add-on to delete.
177
+ * @format GUID
178
+ */
179
+ addOnId: string;
180
+ }
181
+ interface DeleteAddOnResponse {
182
+ }
183
+ interface QueryAddOnsRequest {
184
+ /** Filtering, sorting, and paging details. */
185
+ query?: CursorQuery;
186
+ }
187
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
188
+ /** 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`. */
189
+ cursorPaging?: CursorPaging;
190
+ /**
191
+ * Filter object in the following format:
192
+ * `"filter" : {
193
+ * "fieldName1": "value1",
194
+ * "fieldName2":{"$operator":"value2"}
195
+ * }`
196
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
197
+ *
198
+ * Refer to [supported filters](https://dev.wix.com/docs/rest/business-solutions/bookings/services/add-ons/supported-filters) for a complete list of supported fields.
199
+ */
200
+ filter?: Record<string, any> | null;
201
+ /**
202
+ * Sort object in the following format:
203
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
204
+ * @maxSize 5
205
+ */
206
+ sort?: Sorting[];
207
+ }
208
+ /** @oneof */
209
+ interface CursorQueryPagingMethodOneOf {
210
+ /** 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`. */
211
+ cursorPaging?: CursorPaging;
212
+ }
213
+ interface Sorting {
214
+ /**
215
+ * Name of the field to sort by.
216
+ * @maxLength 512
217
+ */
218
+ fieldName?: string;
219
+ /** Sort order. */
220
+ order?: SortOrderWithLiterals;
221
+ }
222
+ declare enum SortOrder {
223
+ ASC = "ASC",
224
+ DESC = "DESC"
225
+ }
226
+ /** @enumType */
227
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
228
+ interface CursorPaging {
229
+ /**
230
+ * Maximum number of items to return in the results.
231
+ * @max 100
232
+ */
233
+ limit?: number | null;
234
+ /**
235
+ * Pointer to the next or previous page in the list of results.
236
+ *
237
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
238
+ * Not relevant for the first request.
239
+ * @maxLength 16000
240
+ */
241
+ cursor?: string | null;
242
+ }
243
+ interface QueryAddOnsResponse {
244
+ /** List of add-ons matching the query. */
245
+ addOns?: AddOn[];
246
+ /** Paging metadata for the query results. */
247
+ pagingMetadata?: CursorPagingMetadata;
248
+ }
249
+ interface CursorPagingMetadata {
250
+ /** Number of items returned in the response. */
251
+ count?: number | null;
252
+ /** Cursor strings that point to the next page, previous page, or both. */
253
+ cursors?: Cursors;
254
+ /**
255
+ * Whether there are more pages to retrieve following the current page.
256
+ *
257
+ * + `true`: Another page of results can be retrieved.
258
+ * + `false`: This is the last page.
259
+ */
260
+ hasNext?: boolean | null;
261
+ }
262
+ interface Cursors {
263
+ /**
264
+ * Cursor string pointing to the next page in the list of results.
265
+ * @maxLength 16000
266
+ */
267
+ next?: string | null;
268
+ /**
269
+ * Cursor pointing to the previous page in the list of results.
270
+ * @maxLength 16000
271
+ */
272
+ prev?: string | null;
273
+ }
274
+ interface BulkCreateAddOnsRequest {
275
+ /**
276
+ * List of add-ons to create.
277
+ * @minSize 1
278
+ * @maxSize 100
279
+ */
280
+ addOns: AddOn[];
281
+ /** Whether to return the created add-ons in the response. */
282
+ returnEntity?: boolean;
283
+ }
284
+ interface BulkCreateAddOnsResponse {
285
+ /**
286
+ * Results of the bulk create operation including add-ons and metadata.
287
+ * @minSize 1
288
+ * @maxSize 100
289
+ */
290
+ results?: BulkAddOnResult[];
291
+ /** Metadata for the bulk create operation. */
292
+ bulkActionMetadata?: BulkActionMetadata;
293
+ }
294
+ interface ItemMetadata {
295
+ /**
296
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
297
+ * @format GUID
298
+ */
299
+ id?: string | null;
300
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
301
+ originalIndex?: number;
302
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
303
+ success?: boolean;
304
+ /** Details about the error in case of failure. */
305
+ error?: ApplicationError;
306
+ }
307
+ interface ApplicationError {
308
+ /** Error code. */
309
+ code?: string;
310
+ /** Description of the error. */
311
+ description?: string;
312
+ /** Data related to the error. */
313
+ data?: Record<string, any> | null;
314
+ }
315
+ interface BulkAddOnResult {
316
+ /** Metadata for the individual create operation. */
317
+ itemMetadata?: ItemMetadata;
318
+ /** Created add-on. Only present if `return_entity` was set to true in the request. */
319
+ item?: AddOn;
320
+ }
321
+ interface BulkActionMetadata {
322
+ /** Number of items that were successfully processed. */
323
+ totalSuccesses?: number;
324
+ /** Number of items that couldn't be processed. */
325
+ totalFailures?: number;
326
+ /** Number of failures without details because detailed failure threshold was exceeded. */
327
+ undetailedFailures?: number;
328
+ }
329
+ interface BulkUpdateAddOnsRequest {
330
+ /**
331
+ * List of add-ons to update.
332
+ * @minSize 1
333
+ * @maxSize 100
334
+ */
335
+ addOns: MaskedAddOn[];
336
+ /** Whether to return the updated add-ons in the response. */
337
+ returnEntity?: boolean;
338
+ }
339
+ interface MaskedAddOn {
340
+ /** Add-on to update. May be partial. */
341
+ addOn?: AddOn;
342
+ }
343
+ interface BulkUpdateAddOnsResponse {
344
+ /**
345
+ * Results of the bulk update operation.
346
+ * @minSize 1
347
+ * @maxSize 100
348
+ */
349
+ results?: BulkUpdateAddOnsResponseBulkAddOnResult[];
350
+ /** Metadata for the bulk update operation. */
351
+ bulkActionMetadata?: BulkActionMetadata;
352
+ }
353
+ interface BulkUpdateAddOnsResponseBulkAddOnResult {
354
+ /** Metadata for the individual update operation. */
355
+ itemMetadata?: ItemMetadata;
356
+ /** Updated add-on. Only present if `return_entity` was set to true in the request. */
357
+ item?: AddOn;
358
+ }
359
+ interface BulkDeleteAddOnsRequest {
360
+ /**
361
+ * IDs of add-ons to delete.
362
+ * @minSize 1
363
+ * @maxSize 100
364
+ * @format GUID
365
+ */
366
+ addOnIds: string[];
367
+ }
368
+ interface BulkDeleteAddOnsResponse {
369
+ /**
370
+ * Results of the bulk delete operation.
371
+ * @minSize 1
372
+ * @maxSize 100
373
+ */
374
+ results?: BulkDeleteAddOnsResponseBulkAddOnResult[];
375
+ /** Metadata for the bulk delete operation. */
376
+ bulkActionMetadata?: BulkActionMetadata;
377
+ }
378
+ interface BulkDeleteAddOnsResponseBulkAddOnResult {
379
+ /** Metadata for the individual delete operation. */
380
+ itemMetadata?: ItemMetadata;
381
+ }
382
+ interface BulkUpdateAddOnTagsRequest {
383
+ /**
384
+ * IDs of add-ons to update tags for.
385
+ * @minSize 1
386
+ * @maxSize 100
387
+ * @format GUID
388
+ */
389
+ addOnIds?: string[];
390
+ /** Tags to assign to the add-ons. */
391
+ assignTags?: Tags;
392
+ /** Tags to remove from the add-ons. */
393
+ unassignTags?: Tags;
394
+ }
395
+ interface BulkUpdateAddOnTagsResponse {
396
+ /**
397
+ * Results of the bulk tag update operation.
398
+ * @minSize 1
399
+ * @maxSize 100
400
+ */
401
+ results?: BulkUpdateAddOnTagsResult[];
402
+ /** Metadata for the bulk tag update operation. */
403
+ bulkActionMetadata?: BulkActionMetadata;
404
+ }
405
+ interface BulkUpdateAddOnTagsResult {
406
+ /** Metadata for the individual tag update operation. */
407
+ itemMetadata?: ItemMetadata;
408
+ }
409
+ interface BulkUpdateAddOnTagsByFilterRequest {
410
+ /** Filter to select add-ons for tag updates. */
411
+ filter?: Record<string, any> | null;
412
+ /** Tags to assign to the filtered add-ons. */
413
+ assignTags?: Tags;
414
+ /** Tags to remove from the filtered add-ons. */
415
+ unassignTags?: Tags;
416
+ }
417
+ interface BulkUpdateAddOnTagsByFilterResponse {
418
+ /**
419
+ * Job ID for tracking the asynchronous operation.
420
+ * @format GUID
421
+ */
422
+ jobId?: string;
423
+ }
424
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
425
+ interface SitePropertiesNotification {
426
+ /** The site ID for which this update notification applies. */
427
+ metasiteId?: string;
428
+ /** The actual update event. */
429
+ event?: SitePropertiesEvent;
430
+ /**
431
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
432
+ * @maxSize 500
433
+ */
434
+ translations?: Translation[];
435
+ /** Context of the notification */
436
+ changeContext?: ChangeContext;
437
+ }
438
+ /** The actual update event for a particular notification. */
439
+ interface SitePropertiesEvent {
440
+ /** Version of the site's properties represented by this update. */
441
+ version?: number;
442
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
443
+ fields?: string[];
444
+ /** Updated properties. */
445
+ properties?: Properties;
446
+ }
447
+ interface Properties {
448
+ /** Site categories. */
449
+ categories?: Categories;
450
+ /** Site locale. */
451
+ locale?: Locale;
452
+ /**
453
+ * Site language.
454
+ *
455
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
456
+ */
457
+ language?: string | null;
458
+ /**
459
+ * Site currency format used to bill customers.
460
+ *
461
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
462
+ */
463
+ paymentCurrency?: string | null;
464
+ /** Timezone in `America/New_York` format. */
465
+ timeZone?: string | null;
466
+ /** Email address. */
467
+ email?: string | null;
468
+ /** Phone number. */
469
+ phone?: string | null;
470
+ /** Fax number. */
471
+ fax?: string | null;
472
+ /** Address. */
473
+ address?: Address;
474
+ /** Site display name. */
475
+ siteDisplayName?: string | null;
476
+ /** Business name. */
477
+ businessName?: string | null;
478
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
479
+ logo?: string | null;
480
+ /** Site description. */
481
+ description?: string | null;
482
+ /**
483
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
484
+ *
485
+ * __Note:__ Not supported by Wix Bookings.
486
+ */
487
+ businessSchedule?: BusinessSchedule;
488
+ /** Supported languages of a site and the primary language. */
489
+ multilingual?: Multilingual;
490
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
491
+ consentPolicy?: ConsentPolicy;
492
+ /**
493
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
494
+ *
495
+ * Site business type.
496
+ */
497
+ businessConfig?: string | null;
498
+ /** External site URL that uses Wix as its headless business solution. */
499
+ externalSiteUrl?: string | null;
500
+ /** Track clicks analytics. */
501
+ trackClicksAnalytics?: boolean;
502
+ }
503
+ interface Categories {
504
+ /** Primary site category. */
505
+ primary?: string;
506
+ /**
507
+ * Secondary site category.
508
+ * @maxSize 50
509
+ */
510
+ secondary?: string[];
511
+ /** Business Term Id */
512
+ businessTermId?: string | null;
513
+ }
514
+ interface Locale {
515
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
516
+ languageCode?: string;
517
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
518
+ country?: string;
519
+ }
520
+ interface Address {
521
+ /** Street name. */
522
+ street?: string;
523
+ /** City name. */
524
+ city?: string;
525
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
526
+ country?: string;
527
+ /** State. */
528
+ state?: string;
529
+ /**
530
+ * Zip or postal code.
531
+ * @maxLength 20
532
+ */
533
+ zip?: string;
534
+ /** Extra information to be displayed in the address. */
535
+ hint?: AddressHint;
536
+ /** Whether this address represents a physical location. */
537
+ isPhysical?: boolean;
538
+ /** Google-formatted version of this address. */
539
+ googleFormattedAddress?: string;
540
+ /** Street number. */
541
+ streetNumber?: string;
542
+ /** Apartment number. */
543
+ apartmentNumber?: string;
544
+ /** Geographic coordinates of location. */
545
+ coordinates?: GeoCoordinates;
546
+ }
547
+ /**
548
+ * Extra information on displayed addresses.
549
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
550
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
551
+ */
552
+ interface AddressHint {
553
+ /** Extra text displayed next to, or instead of, the actual address. */
554
+ text?: string;
555
+ /** Where the extra text should be displayed. */
556
+ placement?: PlacementTypeWithLiterals;
557
+ }
558
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
559
+ declare enum PlacementType {
560
+ BEFORE = "BEFORE",
561
+ AFTER = "AFTER",
562
+ REPLACE = "REPLACE"
563
+ }
564
+ /** @enumType */
565
+ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
566
+ /** Geocoordinates for a particular address. */
567
+ interface GeoCoordinates {
568
+ /** Latitude of the location. Must be between -90 and 90. */
569
+ latitude?: number;
570
+ /** Longitude of the location. Must be between -180 and 180. */
571
+ longitude?: number;
572
+ }
573
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
574
+ interface BusinessSchedule {
575
+ /**
576
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
577
+ * @maxSize 100
578
+ */
579
+ periods?: TimePeriod[];
580
+ /**
581
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
582
+ * @maxSize 100
583
+ */
584
+ specialHourPeriod?: SpecialHourPeriod[];
585
+ }
586
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
587
+ interface TimePeriod {
588
+ /** Day of the week the period starts on. */
589
+ openDay?: DayOfWeekWithLiterals;
590
+ /**
591
+ * 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
592
+ * midnight at the end of the specified day.
593
+ */
594
+ openTime?: string;
595
+ /** Day of the week the period ends on. */
596
+ closeDay?: DayOfWeekWithLiterals;
597
+ /**
598
+ * 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
599
+ * midnight at the end of the specified day.
600
+ *
601
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
602
+ */
603
+ closeTime?: string;
604
+ }
605
+ /** Enumerates the days of the week. */
606
+ declare enum DayOfWeek {
607
+ MONDAY = "MONDAY",
608
+ TUESDAY = "TUESDAY",
609
+ WEDNESDAY = "WEDNESDAY",
610
+ THURSDAY = "THURSDAY",
611
+ FRIDAY = "FRIDAY",
612
+ SATURDAY = "SATURDAY",
613
+ SUNDAY = "SUNDAY"
614
+ }
615
+ /** @enumType */
616
+ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
617
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
618
+ interface SpecialHourPeriod {
619
+ /** 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). */
620
+ startDate?: string;
621
+ /** 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). */
622
+ endDate?: string;
623
+ /**
624
+ * Whether the business is closed (or the service is not available) during the exception.
625
+ *
626
+ * Default: `true`.
627
+ */
628
+ isClosed?: boolean;
629
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
630
+ comment?: string;
631
+ }
632
+ interface Multilingual {
633
+ /**
634
+ * Supported languages list.
635
+ * @maxSize 200
636
+ */
637
+ supportedLanguages?: SupportedLanguage[];
638
+ /** Whether to redirect to user language. */
639
+ autoRedirect?: boolean;
640
+ }
641
+ interface SupportedLanguage {
642
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
643
+ languageCode?: string;
644
+ /** Locale. */
645
+ locale?: Locale;
646
+ /** Whether the supported language is the primary language for the site. */
647
+ isPrimary?: boolean;
648
+ /** Language icon. */
649
+ countryCode?: string;
650
+ /** How the language will be resolved. For internal use. */
651
+ resolutionMethod?: ResolutionMethodWithLiterals;
652
+ /** Whether the supported language is the primary language for site visitors. */
653
+ isVisitorPrimary?: boolean | null;
654
+ }
655
+ declare enum ResolutionMethod {
656
+ QUERY_PARAM = "QUERY_PARAM",
657
+ SUBDOMAIN = "SUBDOMAIN",
658
+ SUBDIRECTORY = "SUBDIRECTORY"
659
+ }
660
+ /** @enumType */
661
+ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
662
+ interface ConsentPolicy {
663
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
664
+ essential?: boolean | null;
665
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
666
+ functional?: boolean | null;
667
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
668
+ analytics?: boolean | null;
669
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
670
+ advertising?: boolean | null;
671
+ /** CCPA compliance flag. */
672
+ dataToThirdParty?: boolean | null;
673
+ }
674
+ /** A single mapping from the MetaSite ID to a particular service. */
675
+ interface Translation {
676
+ /** The service type. */
677
+ serviceType?: string;
678
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
679
+ appDefId?: string;
680
+ /** The instance ID of the service. */
681
+ instanceId?: string;
682
+ }
683
+ interface ChangeContext extends ChangeContextPayloadOneOf {
684
+ /** Properties were updated. */
685
+ propertiesChange?: PropertiesChange;
686
+ /** Default properties were created on site creation. */
687
+ siteCreated?: SiteCreated;
688
+ /** Properties were cloned on site cloning. */
689
+ siteCloned?: SiteCloned;
690
+ }
691
+ /** @oneof */
692
+ interface ChangeContextPayloadOneOf {
693
+ /** Properties were updated. */
694
+ propertiesChange?: PropertiesChange;
695
+ /** Default properties were created on site creation. */
696
+ siteCreated?: SiteCreated;
697
+ /** Properties were cloned on site cloning. */
698
+ siteCloned?: SiteCloned;
699
+ }
700
+ interface PropertiesChange {
701
+ }
702
+ interface SiteCreated {
703
+ /** Origin template site id. */
704
+ originTemplateId?: string | null;
705
+ }
706
+ interface SiteCloned {
707
+ /** Origin site id. */
708
+ originMetaSiteId?: string;
709
+ }
710
+ interface Empty {
711
+ }
712
+ interface DomainEvent extends DomainEventBodyOneOf {
713
+ createdEvent?: EntityCreatedEvent;
714
+ updatedEvent?: EntityUpdatedEvent;
715
+ deletedEvent?: EntityDeletedEvent;
716
+ actionEvent?: ActionEvent;
717
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
718
+ id?: string;
719
+ /**
720
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
721
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
722
+ */
723
+ entityFqdn?: string;
724
+ /**
725
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
726
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
727
+ */
728
+ slug?: string;
729
+ /** ID of the entity associated with the event. */
730
+ entityId?: string;
731
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
732
+ eventTime?: Date | null;
733
+ /**
734
+ * Whether the event was triggered as a result of a privacy regulation application
735
+ * (for example, GDPR).
736
+ */
737
+ triggeredByAnonymizeRequest?: boolean | null;
738
+ /** If present, indicates the action that triggered the event. */
739
+ originatedFrom?: string | null;
740
+ /**
741
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
742
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
743
+ */
744
+ entityEventSequence?: string | null;
745
+ }
746
+ /** @oneof */
747
+ interface DomainEventBodyOneOf {
748
+ createdEvent?: EntityCreatedEvent;
749
+ updatedEvent?: EntityUpdatedEvent;
750
+ deletedEvent?: EntityDeletedEvent;
751
+ actionEvent?: ActionEvent;
752
+ }
753
+ interface EntityCreatedEvent {
754
+ entityAsJson?: string;
755
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
756
+ restoreInfo?: RestoreInfo;
757
+ }
758
+ interface RestoreInfo {
759
+ deletedDate?: Date | null;
760
+ }
761
+ interface EntityUpdatedEvent {
762
+ /**
763
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
764
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
765
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
766
+ */
767
+ currentEntityAsJson?: string;
768
+ }
769
+ interface EntityDeletedEvent {
770
+ /** Entity that was deleted. */
771
+ deletedEntityAsJson?: string | null;
772
+ }
773
+ interface ActionEvent {
774
+ bodyAsJson?: string;
775
+ }
776
+ interface MessageEnvelope {
777
+ /**
778
+ * App instance ID.
779
+ * @format GUID
780
+ */
781
+ instanceId?: string | null;
782
+ /**
783
+ * Event type.
784
+ * @maxLength 150
785
+ */
786
+ eventType?: string;
787
+ /** The identification type and identity data. */
788
+ identity?: IdentificationData;
789
+ /** Stringify payload. */
790
+ data?: string;
791
+ }
792
+ interface IdentificationData extends IdentificationDataIdOneOf {
793
+ /**
794
+ * ID of a site visitor that has not logged in to the site.
795
+ * @format GUID
796
+ */
797
+ anonymousVisitorId?: string;
798
+ /**
799
+ * ID of a site visitor that has logged in to the site.
800
+ * @format GUID
801
+ */
802
+ memberId?: string;
803
+ /**
804
+ * ID of a Wix user (site owner, contributor, etc.).
805
+ * @format GUID
806
+ */
807
+ wixUserId?: string;
808
+ /**
809
+ * ID of an app.
810
+ * @format GUID
811
+ */
812
+ appId?: string;
813
+ /** @readonly */
814
+ identityType?: WebhookIdentityTypeWithLiterals;
815
+ }
816
+ /** @oneof */
817
+ interface IdentificationDataIdOneOf {
818
+ /**
819
+ * ID of a site visitor that has not logged in to the site.
820
+ * @format GUID
821
+ */
822
+ anonymousVisitorId?: string;
823
+ /**
824
+ * ID of a site visitor that has logged in to the site.
825
+ * @format GUID
826
+ */
827
+ memberId?: string;
828
+ /**
829
+ * ID of a Wix user (site owner, contributor, etc.).
830
+ * @format GUID
831
+ */
832
+ wixUserId?: string;
833
+ /**
834
+ * ID of an app.
835
+ * @format GUID
836
+ */
837
+ appId?: string;
838
+ }
839
+ declare enum WebhookIdentityType {
840
+ UNKNOWN = "UNKNOWN",
841
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
842
+ MEMBER = "MEMBER",
843
+ WIX_USER = "WIX_USER",
844
+ APP = "APP"
845
+ }
846
+ /** @enumType */
847
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
848
+
849
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
850
+ getUrl: (context: any) => string;
851
+ httpMethod: K;
852
+ path: string;
853
+ pathParams: M;
854
+ __requestType: T;
855
+ __originalRequestType: S;
856
+ __responseType: Q;
857
+ __originalResponseType: R;
858
+ };
859
+ declare function createAddOn(): __PublicMethodMetaInfo<'POST', {}, CreateAddOnRequest$1, CreateAddOnRequest, CreateAddOnResponse$1, CreateAddOnResponse>;
860
+ declare function getAddOn(): __PublicMethodMetaInfo<'GET', {
861
+ addOnId: string;
862
+ }, GetAddOnRequest$1, GetAddOnRequest, GetAddOnResponse$1, GetAddOnResponse>;
863
+ declare function updateAddOn(): __PublicMethodMetaInfo<'PATCH', {
864
+ addOnId: string;
865
+ }, UpdateAddOnRequest$1, UpdateAddOnRequest, UpdateAddOnResponse$1, UpdateAddOnResponse>;
866
+ declare function deleteAddOn(): __PublicMethodMetaInfo<'DELETE', {
867
+ addOnId: string;
868
+ }, DeleteAddOnRequest$1, DeleteAddOnRequest, DeleteAddOnResponse$1, DeleteAddOnResponse>;
869
+ declare function queryAddOns(): __PublicMethodMetaInfo<'GET', {}, QueryAddOnsRequest$1, QueryAddOnsRequest, QueryAddOnsResponse$1, QueryAddOnsResponse>;
870
+ declare function bulkCreateAddOns(): __PublicMethodMetaInfo<'POST', {}, BulkCreateAddOnsRequest$1, BulkCreateAddOnsRequest, BulkCreateAddOnsResponse$1, BulkCreateAddOnsResponse>;
871
+ declare function bulkUpdateAddOns(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateAddOnsRequest$1, BulkUpdateAddOnsRequest, BulkUpdateAddOnsResponse$1, BulkUpdateAddOnsResponse>;
872
+ declare function bulkDeleteAddOns(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteAddOnsRequest$1, BulkDeleteAddOnsRequest, BulkDeleteAddOnsResponse$1, BulkDeleteAddOnsResponse>;
873
+
874
+ export { type ActionEvent as ActionEventOriginal, type AddOnAddOnInfoOneOf as AddOnAddOnInfoOneOfOriginal, type AddOn as AddOnOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddOnResult as BulkAddOnResultOriginal, type BulkCreateAddOnsRequest as BulkCreateAddOnsRequestOriginal, type BulkCreateAddOnsResponse as BulkCreateAddOnsResponseOriginal, type BulkDeleteAddOnsRequest as BulkDeleteAddOnsRequestOriginal, type BulkDeleteAddOnsResponseBulkAddOnResult as BulkDeleteAddOnsResponseBulkAddOnResultOriginal, type BulkDeleteAddOnsResponse as BulkDeleteAddOnsResponseOriginal, type BulkUpdateAddOnTagsByFilterRequest as BulkUpdateAddOnTagsByFilterRequestOriginal, type BulkUpdateAddOnTagsByFilterResponse as BulkUpdateAddOnTagsByFilterResponseOriginal, type BulkUpdateAddOnTagsRequest as BulkUpdateAddOnTagsRequestOriginal, type BulkUpdateAddOnTagsResponse as BulkUpdateAddOnTagsResponseOriginal, type BulkUpdateAddOnTagsResult as BulkUpdateAddOnTagsResultOriginal, type BulkUpdateAddOnsRequest as BulkUpdateAddOnsRequestOriginal, type BulkUpdateAddOnsResponseBulkAddOnResult as BulkUpdateAddOnsResponseBulkAddOnResultOriginal, type BulkUpdateAddOnsResponse as BulkUpdateAddOnsResponseOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type ChangeContext as ChangeContextOriginal, type ChangeContextPayloadOneOf as ChangeContextPayloadOneOfOriginal, type ConsentPolicy as ConsentPolicyOriginal, type CreateAddOnRequest as CreateAddOnRequestOriginal, type CreateAddOnResponse as CreateAddOnResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteAddOnRequest as DeleteAddOnRequestOriginal, type DeleteAddOnResponse as DeleteAddOnResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetAddOnRequest as GetAddOnRequestOriginal, type GetAddOnResponse as GetAddOnResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type Locale as LocaleOriginal, type MaskedAddOn as MaskedAddOnOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Money as MoneyOriginal, type Multilingual as MultilingualOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type PropertiesChange as PropertiesChangeOriginal, type Properties as PropertiesOriginal, type QueryAddOnsRequest as QueryAddOnsRequestOriginal, type QueryAddOnsResponse as QueryAddOnsResponseOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SiteCloned as SiteClonedOriginal, type SiteCreated as SiteCreatedOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesNotification as SitePropertiesNotificationOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, type SupportedLanguage as SupportedLanguageOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TimePeriod as TimePeriodOriginal, type Translation as TranslationOriginal, type UpdateAddOnRequest as UpdateAddOnRequestOriginal, type UpdateAddOnResponse as UpdateAddOnResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateAddOns, bulkDeleteAddOns, bulkUpdateAddOns, createAddOn, deleteAddOn, getAddOn, queryAddOns, updateAddOn };