@wix/auto_sdk_calendar_schedules 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/calendar-v3-schedule-schedules.types.d.ts +210 -44
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js +3 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.d.ts +245 -46
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.js +7 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.js.map +1 -1
- package/build/es/src/calendar-v3-schedule-schedules.types.d.ts +210 -44
- package/build/es/src/calendar-v3-schedule-schedules.types.js +3 -0
- package/build/es/src/calendar-v3-schedule-schedules.types.js.map +1 -1
- package/build/es/src/calendar-v3-schedule-schedules.universal.d.ts +245 -46
- package/build/es/src/calendar-v3-schedule-schedules.universal.js +7 -0
- package/build/es/src/calendar-v3-schedule-schedules.universal.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.d.ts +210 -44
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js +3 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.d.ts +245 -46
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js +7 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js.map +1 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.d.ts +210 -44
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.js +3 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.js.map +1 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.d.ts +245 -46
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js +7 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
export interface Schedule {
|
|
10
10
|
/**
|
|
11
11
|
* Schedule ID.
|
|
12
|
+
* @format GUID
|
|
12
13
|
* @readonly
|
|
13
14
|
*/
|
|
14
15
|
_id?: string | null;
|
|
@@ -19,6 +20,8 @@ export interface Schedule {
|
|
|
19
20
|
* the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
|
|
20
21
|
* If the schedule belongs to a Bookings service, identical to the ID of
|
|
21
22
|
* the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
23
|
+
* @format GUID
|
|
24
|
+
* @immutable
|
|
22
25
|
*/
|
|
23
26
|
externalId?: string | null;
|
|
24
27
|
/**
|
|
@@ -26,6 +29,8 @@ export interface Schedule {
|
|
|
26
29
|
*
|
|
27
30
|
* Min: 1 character
|
|
28
31
|
* Max: 200 characters
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 200
|
|
29
34
|
*/
|
|
30
35
|
name?: string | null;
|
|
31
36
|
/**
|
|
@@ -48,6 +53,8 @@ export interface Schedule {
|
|
|
48
53
|
*
|
|
49
54
|
* Min: 1 character
|
|
50
55
|
* Max: 150 characters
|
|
56
|
+
* @minLength 1
|
|
57
|
+
* @maxLength 150
|
|
51
58
|
*/
|
|
52
59
|
timeZone?: string | null;
|
|
53
60
|
/**
|
|
@@ -63,6 +70,8 @@ export interface Schedule {
|
|
|
63
70
|
*
|
|
64
71
|
* Min: 1 character
|
|
65
72
|
* Max: 200 characters
|
|
73
|
+
* @minLength 1
|
|
74
|
+
* @maxLength 200
|
|
66
75
|
*/
|
|
67
76
|
defaultTitle?: string | null;
|
|
68
77
|
/**
|
|
@@ -89,6 +98,8 @@ export interface Schedule {
|
|
|
89
98
|
* in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
90
99
|
* you must provide the Wix Bookings app ID
|
|
91
100
|
* `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
|
|
101
|
+
* @format GUID
|
|
102
|
+
* @immutable
|
|
92
103
|
*/
|
|
93
104
|
appId?: string | null;
|
|
94
105
|
/**
|
|
@@ -97,6 +108,7 @@ export interface Schedule {
|
|
|
97
108
|
* for more information.
|
|
98
109
|
*
|
|
99
110
|
* Max: 1 permission
|
|
111
|
+
* @maxSize 1
|
|
100
112
|
*/
|
|
101
113
|
permissions?: Permission[];
|
|
102
114
|
/** Extensions enabling applications or users to save custom data related to the schedule. */
|
|
@@ -130,6 +142,7 @@ export interface Location {
|
|
|
130
142
|
/**
|
|
131
143
|
* [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
|
|
132
144
|
* ID. Available only for `BUSINESS` locations.
|
|
145
|
+
* @format GUID
|
|
133
146
|
*/
|
|
134
147
|
_id?: string | null;
|
|
135
148
|
/**
|
|
@@ -148,12 +161,16 @@ export interface Location {
|
|
|
148
161
|
*
|
|
149
162
|
* Min: 1 character
|
|
150
163
|
* Max: 150 characters
|
|
164
|
+
* @minLength 1
|
|
165
|
+
* @maxLength 150
|
|
151
166
|
*/
|
|
152
167
|
name?: string | null;
|
|
153
168
|
/**
|
|
154
169
|
* Location address. For `BUSINESS` locations, it's identical to the
|
|
155
170
|
* [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
|
|
156
171
|
* `formattedAddress`.
|
|
172
|
+
* @minLength 1
|
|
173
|
+
* @maxLength 300
|
|
157
174
|
*/
|
|
158
175
|
address?: string | null;
|
|
159
176
|
}
|
|
@@ -174,6 +191,8 @@ export interface ConferencingDetails {
|
|
|
174
191
|
*
|
|
175
192
|
* Min: 1 character
|
|
176
193
|
* Max: 2000 characters
|
|
194
|
+
* @minLength 1
|
|
195
|
+
* @maxLength 2000
|
|
177
196
|
*/
|
|
178
197
|
hostUrl?: string | null;
|
|
179
198
|
/**
|
|
@@ -181,6 +200,8 @@ export interface ConferencingDetails {
|
|
|
181
200
|
*
|
|
182
201
|
* Min: 1 character
|
|
183
202
|
* Max: 2000 characters
|
|
203
|
+
* @minLength 1
|
|
204
|
+
* @maxLength 2000
|
|
184
205
|
*/
|
|
185
206
|
guestUrl?: string | null;
|
|
186
207
|
/**
|
|
@@ -188,6 +209,8 @@ export interface ConferencingDetails {
|
|
|
188
209
|
*
|
|
189
210
|
* Min: 1 character
|
|
190
211
|
* Max: 100 characters
|
|
212
|
+
* @minLength 1
|
|
213
|
+
* @maxLength 100
|
|
191
214
|
*/
|
|
192
215
|
password?: string | null;
|
|
193
216
|
/**
|
|
@@ -195,6 +218,8 @@ export interface ConferencingDetails {
|
|
|
195
218
|
*
|
|
196
219
|
* Min: 1 character
|
|
197
220
|
* Max: 150 characters
|
|
221
|
+
* @minLength 1
|
|
222
|
+
* @maxLength 150
|
|
198
223
|
*/
|
|
199
224
|
externalId?: string | null;
|
|
200
225
|
}
|
|
@@ -222,6 +247,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
222
247
|
/**
|
|
223
248
|
* ID of a Wix user. For example, the site owner or a
|
|
224
249
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
250
|
+
* @format GUID
|
|
225
251
|
*/
|
|
226
252
|
wixUserId?: string;
|
|
227
253
|
}
|
|
@@ -230,6 +256,7 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
230
256
|
/**
|
|
231
257
|
* ID of a Wix user. For example, the site owner or a
|
|
232
258
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
259
|
+
* @format GUID
|
|
233
260
|
*/
|
|
234
261
|
wixUserId?: string;
|
|
235
262
|
}
|
|
@@ -256,7 +283,10 @@ export interface ExtendedFields {
|
|
|
256
283
|
namespaces?: Record<string, Record<string, any>>;
|
|
257
284
|
}
|
|
258
285
|
export interface GetScheduleRequest {
|
|
259
|
-
/**
|
|
286
|
+
/**
|
|
287
|
+
* ID of the schedule to retrieve.
|
|
288
|
+
* @format GUID
|
|
289
|
+
*/
|
|
260
290
|
scheduleId: string | null;
|
|
261
291
|
/**
|
|
262
292
|
* Information about which fields containing personal data to return. Refer to the
|
|
@@ -269,6 +299,7 @@ export interface GetScheduleRequest {
|
|
|
269
299
|
*
|
|
270
300
|
* Max: 1 field
|
|
271
301
|
* Default: No personal data is returned.
|
|
302
|
+
* @maxSize 1
|
|
272
303
|
*/
|
|
273
304
|
fields?: RequestedFields[];
|
|
274
305
|
}
|
|
@@ -297,6 +328,7 @@ export interface QuerySchedulesRequest {
|
|
|
297
328
|
*
|
|
298
329
|
* Max: 1 field
|
|
299
330
|
* Default: No personal data is returned.
|
|
331
|
+
* @maxSize 1
|
|
300
332
|
*/
|
|
301
333
|
fields?: RequestedFields[];
|
|
302
334
|
}
|
|
@@ -328,6 +360,8 @@ export interface CursorPaging {
|
|
|
328
360
|
* Min: `1`
|
|
329
361
|
* Max: `100`
|
|
330
362
|
* Default: `50`
|
|
363
|
+
* @min 1
|
|
364
|
+
* @max 100
|
|
331
365
|
*/
|
|
332
366
|
limit?: number | null;
|
|
333
367
|
/**
|
|
@@ -370,6 +404,7 @@ export interface CreateScheduleRequest {
|
|
|
370
404
|
/**
|
|
371
405
|
* Idempotency key guaranteeing that you don't create the same schedule more
|
|
372
406
|
* than once.
|
|
407
|
+
* @format GUID
|
|
373
408
|
*/
|
|
374
409
|
idempotencyKey?: string | null;
|
|
375
410
|
}
|
|
@@ -398,6 +433,8 @@ export interface ParticipantNotification {
|
|
|
398
433
|
*
|
|
399
434
|
* Min: 1 character
|
|
400
435
|
* Max: 5000 characters
|
|
436
|
+
* @minLength 1
|
|
437
|
+
* @maxLength 5000
|
|
401
438
|
*/
|
|
402
439
|
message?: string | null;
|
|
403
440
|
}
|
|
@@ -413,7 +450,10 @@ export interface ScheduleUpdatedWithMetadata {
|
|
|
413
450
|
participantNotification?: ParticipantNotification;
|
|
414
451
|
}
|
|
415
452
|
export interface CloneScheduleRequest {
|
|
416
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* ID of the schedule to clone.
|
|
455
|
+
* @format GUID
|
|
456
|
+
*/
|
|
417
457
|
scheduleId?: string | null;
|
|
418
458
|
/** Fields to override in the cloned schedule. */
|
|
419
459
|
schedule?: Schedule;
|
|
@@ -427,9 +467,15 @@ export interface ScheduleCloned {
|
|
|
427
467
|
schedule?: Schedule;
|
|
428
468
|
/** The clone trigger. */
|
|
429
469
|
trigger?: Trigger;
|
|
430
|
-
/**
|
|
470
|
+
/**
|
|
471
|
+
* The original Meta Site ID if different.
|
|
472
|
+
* @format GUID
|
|
473
|
+
*/
|
|
431
474
|
originalMetaSiteId?: string | null;
|
|
432
|
-
/**
|
|
475
|
+
/**
|
|
476
|
+
* The original schedule ID if different.
|
|
477
|
+
* @format GUID
|
|
478
|
+
*/
|
|
433
479
|
originalScheduleId?: string | null;
|
|
434
480
|
}
|
|
435
481
|
export declare enum Trigger {
|
|
@@ -445,7 +491,10 @@ export declare enum Trigger {
|
|
|
445
491
|
OTHER = "OTHER"
|
|
446
492
|
}
|
|
447
493
|
export interface CancelScheduleRequest {
|
|
448
|
-
/**
|
|
494
|
+
/**
|
|
495
|
+
* ID of the schedule to cancel.
|
|
496
|
+
* @format GUID
|
|
497
|
+
*/
|
|
449
498
|
scheduleId: string | null;
|
|
450
499
|
/**
|
|
451
500
|
* Whether to preserve future events with participants.
|
|
@@ -499,7 +548,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
499
548
|
studioAssigned?: StudioAssigned;
|
|
500
549
|
/** Emitted when Studio is detached. */
|
|
501
550
|
studioUnassigned?: StudioUnassigned;
|
|
502
|
-
/**
|
|
551
|
+
/**
|
|
552
|
+
* A meta site id.
|
|
553
|
+
* @format GUID
|
|
554
|
+
*/
|
|
503
555
|
metaSiteId?: string;
|
|
504
556
|
/** A meta site version. Monotonically increasing. */
|
|
505
557
|
version?: string;
|
|
@@ -508,6 +560,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
508
560
|
/**
|
|
509
561
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
510
562
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
563
|
+
* @maxSize 4000
|
|
511
564
|
*/
|
|
512
565
|
assets?: Asset[];
|
|
513
566
|
}
|
|
@@ -545,9 +598,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
545
598
|
studioUnassigned?: StudioUnassigned;
|
|
546
599
|
}
|
|
547
600
|
export interface Asset {
|
|
548
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
603
|
+
* @maxLength 36
|
|
604
|
+
*/
|
|
549
605
|
appDefId?: string;
|
|
550
|
-
/**
|
|
606
|
+
/**
|
|
607
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
608
|
+
* @maxLength 200
|
|
609
|
+
*/
|
|
551
610
|
instanceId?: string;
|
|
552
611
|
/** An application state. */
|
|
553
612
|
state?: State;
|
|
@@ -560,9 +619,15 @@ export declare enum State {
|
|
|
560
619
|
DEMO = "DEMO"
|
|
561
620
|
}
|
|
562
621
|
export interface SiteCreated {
|
|
563
|
-
/**
|
|
622
|
+
/**
|
|
623
|
+
* A template identifier (empty if not created from a template).
|
|
624
|
+
* @maxLength 36
|
|
625
|
+
*/
|
|
564
626
|
originTemplateId?: string;
|
|
565
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* An account id of the owner.
|
|
629
|
+
* @format GUID
|
|
630
|
+
*/
|
|
566
631
|
ownerId?: string;
|
|
567
632
|
/** A context in which meta site was created. */
|
|
568
633
|
context?: SiteCreatedContext;
|
|
@@ -571,9 +636,13 @@ export interface SiteCreated {
|
|
|
571
636
|
*
|
|
572
637
|
* In case of a creation from a template it's a template id.
|
|
573
638
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
639
|
+
* @format GUID
|
|
574
640
|
*/
|
|
575
641
|
originMetaSiteId?: string | null;
|
|
576
|
-
/**
|
|
642
|
+
/**
|
|
643
|
+
* A meta site name (URL slug).
|
|
644
|
+
* @maxLength 20
|
|
645
|
+
*/
|
|
577
646
|
siteName?: string;
|
|
578
647
|
/** A namespace. */
|
|
579
648
|
namespace?: Namespace;
|
|
@@ -666,13 +735,21 @@ export declare enum Namespace {
|
|
|
666
735
|
* Shared Blog Site is a unique single site across Enterprise account,
|
|
667
736
|
* This site will hold all Blog posts related to the Marketing product.
|
|
668
737
|
*/
|
|
669
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
|
|
738
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
739
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
740
|
+
STANDALONE_FORMS = "STANDALONE_FORMS"
|
|
670
741
|
}
|
|
671
742
|
/** Site transferred to another user. */
|
|
672
743
|
export interface SiteTransferred {
|
|
673
|
-
/**
|
|
744
|
+
/**
|
|
745
|
+
* A previous owner id (user that transfers meta site).
|
|
746
|
+
* @format GUID
|
|
747
|
+
*/
|
|
674
748
|
oldOwnerId?: string;
|
|
675
|
-
/**
|
|
749
|
+
/**
|
|
750
|
+
* A new owner id (user that accepts meta site).
|
|
751
|
+
* @format GUID
|
|
752
|
+
*/
|
|
676
753
|
newOwnerId?: string;
|
|
677
754
|
}
|
|
678
755
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -685,16 +762,23 @@ export interface DeleteContext {
|
|
|
685
762
|
dateDeleted?: Date | null;
|
|
686
763
|
/** A status. */
|
|
687
764
|
deleteStatus?: DeleteStatus;
|
|
688
|
-
/**
|
|
765
|
+
/**
|
|
766
|
+
* A reason (flow).
|
|
767
|
+
* @maxLength 255
|
|
768
|
+
*/
|
|
689
769
|
deleteOrigin?: string;
|
|
690
|
-
/**
|
|
770
|
+
/**
|
|
771
|
+
* A service that deleted it.
|
|
772
|
+
* @maxLength 255
|
|
773
|
+
*/
|
|
691
774
|
initiatorId?: string | null;
|
|
692
775
|
}
|
|
693
776
|
export declare enum DeleteStatus {
|
|
694
777
|
UNKNOWN = "UNKNOWN",
|
|
695
778
|
TRASH = "TRASH",
|
|
696
779
|
DELETED = "DELETED",
|
|
697
|
-
PENDING_PURGE = "PENDING_PURGE"
|
|
780
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
781
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
698
782
|
}
|
|
699
783
|
/** Restoration of the meta site. */
|
|
700
784
|
export interface SiteUndeleted {
|
|
@@ -703,7 +787,11 @@ export interface SiteUndeleted {
|
|
|
703
787
|
export interface SitePublished {
|
|
704
788
|
}
|
|
705
789
|
export interface SiteUnpublished {
|
|
706
|
-
/**
|
|
790
|
+
/**
|
|
791
|
+
* A list of URLs previously associated with the meta site.
|
|
792
|
+
* @maxLength 4000
|
|
793
|
+
* @maxSize 10000
|
|
794
|
+
*/
|
|
707
795
|
urls?: string[];
|
|
708
796
|
}
|
|
709
797
|
export interface SiteMarkedAsTemplate {
|
|
@@ -726,30 +814,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
726
814
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
727
815
|
*/
|
|
728
816
|
export interface ServiceProvisioned {
|
|
729
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* Either UUID or EmbeddedServiceType.
|
|
819
|
+
* @maxLength 36
|
|
820
|
+
*/
|
|
730
821
|
appDefId?: string;
|
|
731
|
-
/**
|
|
822
|
+
/**
|
|
823
|
+
* Not only UUID. Something here could be something weird.
|
|
824
|
+
* @maxLength 36
|
|
825
|
+
*/
|
|
732
826
|
instanceId?: string;
|
|
733
|
-
/**
|
|
827
|
+
/**
|
|
828
|
+
* An instance id from which this instance is originated.
|
|
829
|
+
* @maxLength 36
|
|
830
|
+
*/
|
|
734
831
|
originInstanceId?: string;
|
|
735
|
-
/**
|
|
832
|
+
/**
|
|
833
|
+
* A version.
|
|
834
|
+
* @maxLength 500
|
|
835
|
+
*/
|
|
736
836
|
version?: string | null;
|
|
737
|
-
/**
|
|
837
|
+
/**
|
|
838
|
+
* The origin meta site id
|
|
839
|
+
* @format GUID
|
|
840
|
+
*/
|
|
738
841
|
originMetaSiteId?: string | null;
|
|
739
842
|
}
|
|
740
843
|
export interface ServiceRemoved {
|
|
741
|
-
/**
|
|
844
|
+
/**
|
|
845
|
+
* Either UUID or EmbeddedServiceType.
|
|
846
|
+
* @maxLength 36
|
|
847
|
+
*/
|
|
742
848
|
appDefId?: string;
|
|
743
|
-
/**
|
|
849
|
+
/**
|
|
850
|
+
* Not only UUID. Something here could be something weird.
|
|
851
|
+
* @maxLength 36
|
|
852
|
+
*/
|
|
744
853
|
instanceId?: string;
|
|
745
|
-
/**
|
|
854
|
+
/**
|
|
855
|
+
* A version.
|
|
856
|
+
* @maxLength 500
|
|
857
|
+
*/
|
|
746
858
|
version?: string | null;
|
|
747
859
|
}
|
|
748
860
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
749
861
|
export interface SiteRenamed {
|
|
750
|
-
/**
|
|
862
|
+
/**
|
|
863
|
+
* A new meta site name (URL slug).
|
|
864
|
+
* @maxLength 20
|
|
865
|
+
*/
|
|
751
866
|
newSiteName?: string;
|
|
752
|
-
/**
|
|
867
|
+
/**
|
|
868
|
+
* A previous meta site name (URL slug).
|
|
869
|
+
* @maxLength 255
|
|
870
|
+
*/
|
|
753
871
|
oldSiteName?: string;
|
|
754
872
|
}
|
|
755
873
|
/**
|
|
@@ -781,7 +899,10 @@ export interface SitePropertiesNotification {
|
|
|
781
899
|
metasiteId?: string;
|
|
782
900
|
/** The actual update event. */
|
|
783
901
|
event?: SitePropertiesEvent;
|
|
784
|
-
/**
|
|
902
|
+
/**
|
|
903
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
904
|
+
* @maxSize 500
|
|
905
|
+
*/
|
|
785
906
|
translations?: Translation[];
|
|
786
907
|
/** Context of the notification */
|
|
787
908
|
changeContext?: ChangeContext;
|
|
@@ -854,7 +975,10 @@ export interface Properties {
|
|
|
854
975
|
export interface Categories {
|
|
855
976
|
/** Primary site category. */
|
|
856
977
|
primary?: string;
|
|
857
|
-
/**
|
|
978
|
+
/**
|
|
979
|
+
* Secondary site category.
|
|
980
|
+
* @maxSize 50
|
|
981
|
+
*/
|
|
858
982
|
secondary?: string[];
|
|
859
983
|
/** Business Term Id */
|
|
860
984
|
businessTermId?: string | null;
|
|
@@ -874,7 +998,10 @@ export interface Address {
|
|
|
874
998
|
country?: string;
|
|
875
999
|
/** State. */
|
|
876
1000
|
state?: string;
|
|
877
|
-
/**
|
|
1001
|
+
/**
|
|
1002
|
+
* Zip or postal code.
|
|
1003
|
+
* @maxLength 20
|
|
1004
|
+
*/
|
|
878
1005
|
zip?: string;
|
|
879
1006
|
/** Extra information to be displayed in the address. */
|
|
880
1007
|
hint?: AddressHint;
|
|
@@ -915,9 +1042,15 @@ export interface GeoCoordinates {
|
|
|
915
1042
|
}
|
|
916
1043
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
917
1044
|
export interface BusinessSchedule {
|
|
918
|
-
/**
|
|
1045
|
+
/**
|
|
1046
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1047
|
+
* @maxSize 100
|
|
1048
|
+
*/
|
|
919
1049
|
periods?: TimePeriod[];
|
|
920
|
-
/**
|
|
1050
|
+
/**
|
|
1051
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1052
|
+
* @maxSize 100
|
|
1053
|
+
*/
|
|
921
1054
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
922
1055
|
}
|
|
923
1056
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
@@ -965,7 +1098,10 @@ export interface SpecialHourPeriod {
|
|
|
965
1098
|
comment?: string;
|
|
966
1099
|
}
|
|
967
1100
|
export interface Multilingual {
|
|
968
|
-
/**
|
|
1101
|
+
/**
|
|
1102
|
+
* Supported languages list.
|
|
1103
|
+
* @maxSize 200
|
|
1104
|
+
*/
|
|
969
1105
|
supportedLanguages?: SupportedLanguage[];
|
|
970
1106
|
/** Whether to redirect to user language. */
|
|
971
1107
|
autoRedirect?: boolean;
|
|
@@ -1106,9 +1242,15 @@ export interface ActionEvent {
|
|
|
1106
1242
|
body?: string;
|
|
1107
1243
|
}
|
|
1108
1244
|
export interface MessageEnvelope {
|
|
1109
|
-
/**
|
|
1245
|
+
/**
|
|
1246
|
+
* App instance ID.
|
|
1247
|
+
* @format GUID
|
|
1248
|
+
*/
|
|
1110
1249
|
instanceId?: string | null;
|
|
1111
|
-
/**
|
|
1250
|
+
/**
|
|
1251
|
+
* Event type.
|
|
1252
|
+
* @maxLength 150
|
|
1253
|
+
*/
|
|
1112
1254
|
eventType?: string;
|
|
1113
1255
|
/** The identification type and identity data. */
|
|
1114
1256
|
identity?: IdentificationData;
|
|
@@ -1116,26 +1258,50 @@ export interface MessageEnvelope {
|
|
|
1116
1258
|
data?: string;
|
|
1117
1259
|
}
|
|
1118
1260
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1119
|
-
/**
|
|
1261
|
+
/**
|
|
1262
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1263
|
+
* @format GUID
|
|
1264
|
+
*/
|
|
1120
1265
|
anonymousVisitorId?: string;
|
|
1121
|
-
/**
|
|
1266
|
+
/**
|
|
1267
|
+
* ID of a site visitor that has logged in to the site.
|
|
1268
|
+
* @format GUID
|
|
1269
|
+
*/
|
|
1122
1270
|
memberId?: string;
|
|
1123
|
-
/**
|
|
1271
|
+
/**
|
|
1272
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1273
|
+
* @format GUID
|
|
1274
|
+
*/
|
|
1124
1275
|
wixUserId?: string;
|
|
1125
|
-
/**
|
|
1276
|
+
/**
|
|
1277
|
+
* ID of an app.
|
|
1278
|
+
* @format GUID
|
|
1279
|
+
*/
|
|
1126
1280
|
appId?: string;
|
|
1127
1281
|
/** @readonly */
|
|
1128
1282
|
identityType?: WebhookIdentityType;
|
|
1129
1283
|
}
|
|
1130
1284
|
/** @oneof */
|
|
1131
1285
|
export interface IdentificationDataIdOneOf {
|
|
1132
|
-
/**
|
|
1286
|
+
/**
|
|
1287
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1288
|
+
* @format GUID
|
|
1289
|
+
*/
|
|
1133
1290
|
anonymousVisitorId?: string;
|
|
1134
|
-
/**
|
|
1291
|
+
/**
|
|
1292
|
+
* ID of a site visitor that has logged in to the site.
|
|
1293
|
+
* @format GUID
|
|
1294
|
+
*/
|
|
1135
1295
|
memberId?: string;
|
|
1136
|
-
/**
|
|
1296
|
+
/**
|
|
1297
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1298
|
+
* @format GUID
|
|
1299
|
+
*/
|
|
1137
1300
|
wixUserId?: string;
|
|
1138
|
-
/**
|
|
1301
|
+
/**
|
|
1302
|
+
* ID of an app.
|
|
1303
|
+
* @format GUID
|
|
1304
|
+
*/
|
|
1139
1305
|
appId?: string;
|
|
1140
1306
|
}
|
|
1141
1307
|
export declare enum WebhookIdentityType {
|
|
@@ -1181,9 +1347,15 @@ export interface CancelScheduleResponseNonNullableFields {
|
|
|
1181
1347
|
schedule?: ScheduleNonNullableFields;
|
|
1182
1348
|
}
|
|
1183
1349
|
export interface BaseEventMetadata {
|
|
1184
|
-
/**
|
|
1350
|
+
/**
|
|
1351
|
+
* App instance ID.
|
|
1352
|
+
* @format GUID
|
|
1353
|
+
*/
|
|
1185
1354
|
instanceId?: string | null;
|
|
1186
|
-
/**
|
|
1355
|
+
/**
|
|
1356
|
+
* Event type.
|
|
1357
|
+
* @maxLength 150
|
|
1358
|
+
*/
|
|
1187
1359
|
eventType?: string;
|
|
1188
1360
|
/** The identification type and identity data. */
|
|
1189
1361
|
identity?: IdentificationData;
|
|
@@ -1240,6 +1412,8 @@ export interface ScheduleCancelledEnvelope {
|
|
|
1240
1412
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1241
1413
|
* @permissionScope Read Bookings - Including Participants
|
|
1242
1414
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1415
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1416
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1243
1417
|
* @permissionScope Manage Bookings - all permissions
|
|
1244
1418
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1245
1419
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1266,6 +1440,8 @@ export interface ScheduleClonedEnvelope {
|
|
|
1266
1440
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1267
1441
|
* @permissionScope Read Bookings - Including Participants
|
|
1268
1442
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1443
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1444
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1269
1445
|
* @permissionScope Manage Bookings - all permissions
|
|
1270
1446
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1271
1447
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1292,6 +1468,8 @@ export interface ScheduleCreatedEnvelope {
|
|
|
1292
1468
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1293
1469
|
* @permissionScope Read Bookings - Including Participants
|
|
1294
1470
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1471
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1472
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1295
1473
|
* @permissionScope Manage Bookings - all permissions
|
|
1296
1474
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1297
1475
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1318,6 +1496,8 @@ export interface ScheduleUpdatedEnvelope {
|
|
|
1318
1496
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1319
1497
|
* @permissionScope Read Bookings - Including Participants
|
|
1320
1498
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1499
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1500
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1321
1501
|
* @permissionScope Manage Bookings - all permissions
|
|
1322
1502
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1323
1503
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1368,6 +1548,8 @@ export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelo
|
|
|
1368
1548
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1369
1549
|
* @permissionScope Read Bookings - Including Participants
|
|
1370
1550
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1551
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1552
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1371
1553
|
* @permissionScope Manage Bookings - all permissions
|
|
1372
1554
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1373
1555
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1390,6 +1572,7 @@ export interface GetScheduleOptions {
|
|
|
1390
1572
|
*
|
|
1391
1573
|
* Max: 1 field
|
|
1392
1574
|
* Default: No personal data is returned.
|
|
1575
|
+
* @maxSize 1
|
|
1393
1576
|
*/
|
|
1394
1577
|
fields?: RequestedFields[];
|
|
1395
1578
|
}
|
|
@@ -1442,6 +1625,8 @@ export interface GetScheduleOptions {
|
|
|
1442
1625
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1443
1626
|
* @permissionScope Read Bookings - Including Participants
|
|
1444
1627
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1628
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1629
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1445
1630
|
* @permissionScope Manage Bookings - all permissions
|
|
1446
1631
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1447
1632
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1465,6 +1650,7 @@ export interface QuerySchedulesOptions {
|
|
|
1465
1650
|
*
|
|
1466
1651
|
* Max: 1 field
|
|
1467
1652
|
* Default: No personal data is returned.
|
|
1653
|
+
* @maxSize 1
|
|
1468
1654
|
*/
|
|
1469
1655
|
fields?: RequestedFields[] | undefined;
|
|
1470
1656
|
}
|
|
@@ -1534,6 +1720,7 @@ export interface CreateScheduleOptions {
|
|
|
1534
1720
|
/**
|
|
1535
1721
|
* Idempotency key guaranteeing that you don't create the same schedule more
|
|
1536
1722
|
* than once.
|
|
1723
|
+
* @format GUID
|
|
1537
1724
|
*/
|
|
1538
1725
|
idempotencyKey?: string | null;
|
|
1539
1726
|
}
|
|
@@ -1569,6 +1756,7 @@ export declare function updateSchedule(_id: string | null, schedule: UpdateSched
|
|
|
1569
1756
|
export interface UpdateSchedule {
|
|
1570
1757
|
/**
|
|
1571
1758
|
* Schedule ID.
|
|
1759
|
+
* @format GUID
|
|
1572
1760
|
* @readonly
|
|
1573
1761
|
*/
|
|
1574
1762
|
_id?: string | null;
|
|
@@ -1579,6 +1767,8 @@ export interface UpdateSchedule {
|
|
|
1579
1767
|
* the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
|
|
1580
1768
|
* If the schedule belongs to a Bookings service, identical to the ID of
|
|
1581
1769
|
* the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
1770
|
+
* @format GUID
|
|
1771
|
+
* @immutable
|
|
1582
1772
|
*/
|
|
1583
1773
|
externalId?: string | null;
|
|
1584
1774
|
/**
|
|
@@ -1586,6 +1776,8 @@ export interface UpdateSchedule {
|
|
|
1586
1776
|
*
|
|
1587
1777
|
* Min: 1 character
|
|
1588
1778
|
* Max: 200 characters
|
|
1779
|
+
* @minLength 1
|
|
1780
|
+
* @maxLength 200
|
|
1589
1781
|
*/
|
|
1590
1782
|
name?: string | null;
|
|
1591
1783
|
/**
|
|
@@ -1608,6 +1800,8 @@ export interface UpdateSchedule {
|
|
|
1608
1800
|
*
|
|
1609
1801
|
* Min: 1 character
|
|
1610
1802
|
* Max: 150 characters
|
|
1803
|
+
* @minLength 1
|
|
1804
|
+
* @maxLength 150
|
|
1611
1805
|
*/
|
|
1612
1806
|
timeZone?: string | null;
|
|
1613
1807
|
/**
|
|
@@ -1623,6 +1817,8 @@ export interface UpdateSchedule {
|
|
|
1623
1817
|
*
|
|
1624
1818
|
* Min: 1 character
|
|
1625
1819
|
* Max: 200 characters
|
|
1820
|
+
* @minLength 1
|
|
1821
|
+
* @maxLength 200
|
|
1626
1822
|
*/
|
|
1627
1823
|
defaultTitle?: string | null;
|
|
1628
1824
|
/**
|
|
@@ -1649,6 +1845,8 @@ export interface UpdateSchedule {
|
|
|
1649
1845
|
* in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
1650
1846
|
* you must provide the Wix Bookings app ID
|
|
1651
1847
|
* `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
|
|
1848
|
+
* @format GUID
|
|
1849
|
+
* @immutable
|
|
1652
1850
|
*/
|
|
1653
1851
|
appId?: string | null;
|
|
1654
1852
|
/**
|
|
@@ -1657,6 +1855,7 @@ export interface UpdateSchedule {
|
|
|
1657
1855
|
* for more information.
|
|
1658
1856
|
*
|
|
1659
1857
|
* Max: 1 permission
|
|
1858
|
+
* @maxSize 1
|
|
1660
1859
|
*/
|
|
1661
1860
|
permissions?: Permission[];
|
|
1662
1861
|
/** Extensions enabling applications or users to save custom data related to the schedule. */
|