@wix/auto_sdk_calendar_schedules 1.0.1 → 1.0.2
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 +205 -42
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.d.ts +240 -44
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.js +4 -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 +205 -42
- package/build/es/src/calendar-v3-schedule-schedules.types.js.map +1 -1
- package/build/es/src/calendar-v3-schedule-schedules.universal.d.ts +240 -44
- package/build/es/src/calendar-v3-schedule-schedules.universal.js +4 -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 +205 -42
- 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 +240 -44
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js +4 -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 +205 -42
- 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 +240 -44
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js +4 -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;
|
|
@@ -670,9 +739,15 @@ export declare enum Namespace {
|
|
|
670
739
|
}
|
|
671
740
|
/** Site transferred to another user. */
|
|
672
741
|
export interface SiteTransferred {
|
|
673
|
-
/**
|
|
742
|
+
/**
|
|
743
|
+
* A previous owner id (user that transfers meta site).
|
|
744
|
+
* @format GUID
|
|
745
|
+
*/
|
|
674
746
|
oldOwnerId?: string;
|
|
675
|
-
/**
|
|
747
|
+
/**
|
|
748
|
+
* A new owner id (user that accepts meta site).
|
|
749
|
+
* @format GUID
|
|
750
|
+
*/
|
|
676
751
|
newOwnerId?: string;
|
|
677
752
|
}
|
|
678
753
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -685,9 +760,15 @@ export interface DeleteContext {
|
|
|
685
760
|
dateDeleted?: Date | null;
|
|
686
761
|
/** A status. */
|
|
687
762
|
deleteStatus?: DeleteStatus;
|
|
688
|
-
/**
|
|
763
|
+
/**
|
|
764
|
+
* A reason (flow).
|
|
765
|
+
* @maxLength 255
|
|
766
|
+
*/
|
|
689
767
|
deleteOrigin?: string;
|
|
690
|
-
/**
|
|
768
|
+
/**
|
|
769
|
+
* A service that deleted it.
|
|
770
|
+
* @maxLength 255
|
|
771
|
+
*/
|
|
691
772
|
initiatorId?: string | null;
|
|
692
773
|
}
|
|
693
774
|
export declare enum DeleteStatus {
|
|
@@ -703,7 +784,11 @@ export interface SiteUndeleted {
|
|
|
703
784
|
export interface SitePublished {
|
|
704
785
|
}
|
|
705
786
|
export interface SiteUnpublished {
|
|
706
|
-
/**
|
|
787
|
+
/**
|
|
788
|
+
* A list of URLs previously associated with the meta site.
|
|
789
|
+
* @maxLength 4000
|
|
790
|
+
* @maxSize 10000
|
|
791
|
+
*/
|
|
707
792
|
urls?: string[];
|
|
708
793
|
}
|
|
709
794
|
export interface SiteMarkedAsTemplate {
|
|
@@ -726,30 +811,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
726
811
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
727
812
|
*/
|
|
728
813
|
export interface ServiceProvisioned {
|
|
729
|
-
/**
|
|
814
|
+
/**
|
|
815
|
+
* Either UUID or EmbeddedServiceType.
|
|
816
|
+
* @maxLength 36
|
|
817
|
+
*/
|
|
730
818
|
appDefId?: string;
|
|
731
|
-
/**
|
|
819
|
+
/**
|
|
820
|
+
* Not only UUID. Something here could be something weird.
|
|
821
|
+
* @maxLength 36
|
|
822
|
+
*/
|
|
732
823
|
instanceId?: string;
|
|
733
|
-
/**
|
|
824
|
+
/**
|
|
825
|
+
* An instance id from which this instance is originated.
|
|
826
|
+
* @maxLength 36
|
|
827
|
+
*/
|
|
734
828
|
originInstanceId?: string;
|
|
735
|
-
/**
|
|
829
|
+
/**
|
|
830
|
+
* A version.
|
|
831
|
+
* @maxLength 500
|
|
832
|
+
*/
|
|
736
833
|
version?: string | null;
|
|
737
|
-
/**
|
|
834
|
+
/**
|
|
835
|
+
* The origin meta site id
|
|
836
|
+
* @format GUID
|
|
837
|
+
*/
|
|
738
838
|
originMetaSiteId?: string | null;
|
|
739
839
|
}
|
|
740
840
|
export interface ServiceRemoved {
|
|
741
|
-
/**
|
|
841
|
+
/**
|
|
842
|
+
* Either UUID or EmbeddedServiceType.
|
|
843
|
+
* @maxLength 36
|
|
844
|
+
*/
|
|
742
845
|
appDefId?: string;
|
|
743
|
-
/**
|
|
846
|
+
/**
|
|
847
|
+
* Not only UUID. Something here could be something weird.
|
|
848
|
+
* @maxLength 36
|
|
849
|
+
*/
|
|
744
850
|
instanceId?: string;
|
|
745
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* A version.
|
|
853
|
+
* @maxLength 500
|
|
854
|
+
*/
|
|
746
855
|
version?: string | null;
|
|
747
856
|
}
|
|
748
857
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
749
858
|
export interface SiteRenamed {
|
|
750
|
-
/**
|
|
859
|
+
/**
|
|
860
|
+
* A new meta site name (URL slug).
|
|
861
|
+
* @maxLength 20
|
|
862
|
+
*/
|
|
751
863
|
newSiteName?: string;
|
|
752
|
-
/**
|
|
864
|
+
/**
|
|
865
|
+
* A previous meta site name (URL slug).
|
|
866
|
+
* @maxLength 255
|
|
867
|
+
*/
|
|
753
868
|
oldSiteName?: string;
|
|
754
869
|
}
|
|
755
870
|
/**
|
|
@@ -781,7 +896,10 @@ export interface SitePropertiesNotification {
|
|
|
781
896
|
metasiteId?: string;
|
|
782
897
|
/** The actual update event. */
|
|
783
898
|
event?: SitePropertiesEvent;
|
|
784
|
-
/**
|
|
899
|
+
/**
|
|
900
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
901
|
+
* @maxSize 500
|
|
902
|
+
*/
|
|
785
903
|
translations?: Translation[];
|
|
786
904
|
/** Context of the notification */
|
|
787
905
|
changeContext?: ChangeContext;
|
|
@@ -854,7 +972,10 @@ export interface Properties {
|
|
|
854
972
|
export interface Categories {
|
|
855
973
|
/** Primary site category. */
|
|
856
974
|
primary?: string;
|
|
857
|
-
/**
|
|
975
|
+
/**
|
|
976
|
+
* Secondary site category.
|
|
977
|
+
* @maxSize 50
|
|
978
|
+
*/
|
|
858
979
|
secondary?: string[];
|
|
859
980
|
/** Business Term Id */
|
|
860
981
|
businessTermId?: string | null;
|
|
@@ -874,7 +995,10 @@ export interface Address {
|
|
|
874
995
|
country?: string;
|
|
875
996
|
/** State. */
|
|
876
997
|
state?: string;
|
|
877
|
-
/**
|
|
998
|
+
/**
|
|
999
|
+
* Zip or postal code.
|
|
1000
|
+
* @maxLength 20
|
|
1001
|
+
*/
|
|
878
1002
|
zip?: string;
|
|
879
1003
|
/** Extra information to be displayed in the address. */
|
|
880
1004
|
hint?: AddressHint;
|
|
@@ -915,9 +1039,15 @@ export interface GeoCoordinates {
|
|
|
915
1039
|
}
|
|
916
1040
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
917
1041
|
export interface BusinessSchedule {
|
|
918
|
-
/**
|
|
1042
|
+
/**
|
|
1043
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1044
|
+
* @maxSize 100
|
|
1045
|
+
*/
|
|
919
1046
|
periods?: TimePeriod[];
|
|
920
|
-
/**
|
|
1047
|
+
/**
|
|
1048
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1049
|
+
* @maxSize 100
|
|
1050
|
+
*/
|
|
921
1051
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
922
1052
|
}
|
|
923
1053
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
@@ -965,7 +1095,10 @@ export interface SpecialHourPeriod {
|
|
|
965
1095
|
comment?: string;
|
|
966
1096
|
}
|
|
967
1097
|
export interface Multilingual {
|
|
968
|
-
/**
|
|
1098
|
+
/**
|
|
1099
|
+
* Supported languages list.
|
|
1100
|
+
* @maxSize 200
|
|
1101
|
+
*/
|
|
969
1102
|
supportedLanguages?: SupportedLanguage[];
|
|
970
1103
|
/** Whether to redirect to user language. */
|
|
971
1104
|
autoRedirect?: boolean;
|
|
@@ -1106,9 +1239,15 @@ export interface ActionEvent {
|
|
|
1106
1239
|
body?: string;
|
|
1107
1240
|
}
|
|
1108
1241
|
export interface MessageEnvelope {
|
|
1109
|
-
/**
|
|
1242
|
+
/**
|
|
1243
|
+
* App instance ID.
|
|
1244
|
+
* @format GUID
|
|
1245
|
+
*/
|
|
1110
1246
|
instanceId?: string | null;
|
|
1111
|
-
/**
|
|
1247
|
+
/**
|
|
1248
|
+
* Event type.
|
|
1249
|
+
* @maxLength 150
|
|
1250
|
+
*/
|
|
1112
1251
|
eventType?: string;
|
|
1113
1252
|
/** The identification type and identity data. */
|
|
1114
1253
|
identity?: IdentificationData;
|
|
@@ -1116,26 +1255,50 @@ export interface MessageEnvelope {
|
|
|
1116
1255
|
data?: string;
|
|
1117
1256
|
}
|
|
1118
1257
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1119
|
-
/**
|
|
1258
|
+
/**
|
|
1259
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1260
|
+
* @format GUID
|
|
1261
|
+
*/
|
|
1120
1262
|
anonymousVisitorId?: string;
|
|
1121
|
-
/**
|
|
1263
|
+
/**
|
|
1264
|
+
* ID of a site visitor that has logged in to the site.
|
|
1265
|
+
* @format GUID
|
|
1266
|
+
*/
|
|
1122
1267
|
memberId?: string;
|
|
1123
|
-
/**
|
|
1268
|
+
/**
|
|
1269
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1270
|
+
* @format GUID
|
|
1271
|
+
*/
|
|
1124
1272
|
wixUserId?: string;
|
|
1125
|
-
/**
|
|
1273
|
+
/**
|
|
1274
|
+
* ID of an app.
|
|
1275
|
+
* @format GUID
|
|
1276
|
+
*/
|
|
1126
1277
|
appId?: string;
|
|
1127
1278
|
/** @readonly */
|
|
1128
1279
|
identityType?: WebhookIdentityType;
|
|
1129
1280
|
}
|
|
1130
1281
|
/** @oneof */
|
|
1131
1282
|
export interface IdentificationDataIdOneOf {
|
|
1132
|
-
/**
|
|
1283
|
+
/**
|
|
1284
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1285
|
+
* @format GUID
|
|
1286
|
+
*/
|
|
1133
1287
|
anonymousVisitorId?: string;
|
|
1134
|
-
/**
|
|
1288
|
+
/**
|
|
1289
|
+
* ID of a site visitor that has logged in to the site.
|
|
1290
|
+
* @format GUID
|
|
1291
|
+
*/
|
|
1135
1292
|
memberId?: string;
|
|
1136
|
-
/**
|
|
1293
|
+
/**
|
|
1294
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1295
|
+
* @format GUID
|
|
1296
|
+
*/
|
|
1137
1297
|
wixUserId?: string;
|
|
1138
|
-
/**
|
|
1298
|
+
/**
|
|
1299
|
+
* ID of an app.
|
|
1300
|
+
* @format GUID
|
|
1301
|
+
*/
|
|
1139
1302
|
appId?: string;
|
|
1140
1303
|
}
|
|
1141
1304
|
export declare enum WebhookIdentityType {
|
|
@@ -1181,9 +1344,15 @@ export interface CancelScheduleResponseNonNullableFields {
|
|
|
1181
1344
|
schedule?: ScheduleNonNullableFields;
|
|
1182
1345
|
}
|
|
1183
1346
|
export interface BaseEventMetadata {
|
|
1184
|
-
/**
|
|
1347
|
+
/**
|
|
1348
|
+
* App instance ID.
|
|
1349
|
+
* @format GUID
|
|
1350
|
+
*/
|
|
1185
1351
|
instanceId?: string | null;
|
|
1186
|
-
/**
|
|
1352
|
+
/**
|
|
1353
|
+
* Event type.
|
|
1354
|
+
* @maxLength 150
|
|
1355
|
+
*/
|
|
1187
1356
|
eventType?: string;
|
|
1188
1357
|
/** The identification type and identity data. */
|
|
1189
1358
|
identity?: IdentificationData;
|
|
@@ -1240,6 +1409,8 @@ export interface ScheduleCancelledEnvelope {
|
|
|
1240
1409
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1241
1410
|
* @permissionScope Read Bookings - Including Participants
|
|
1242
1411
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1412
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1413
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1243
1414
|
* @permissionScope Manage Bookings - all permissions
|
|
1244
1415
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1245
1416
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1266,6 +1437,8 @@ export interface ScheduleClonedEnvelope {
|
|
|
1266
1437
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1267
1438
|
* @permissionScope Read Bookings - Including Participants
|
|
1268
1439
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1440
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1441
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1269
1442
|
* @permissionScope Manage Bookings - all permissions
|
|
1270
1443
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1271
1444
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1292,6 +1465,8 @@ export interface ScheduleCreatedEnvelope {
|
|
|
1292
1465
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1293
1466
|
* @permissionScope Read Bookings - Including Participants
|
|
1294
1467
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1468
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1469
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1295
1470
|
* @permissionScope Manage Bookings - all permissions
|
|
1296
1471
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1297
1472
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1318,6 +1493,8 @@ export interface ScheduleUpdatedEnvelope {
|
|
|
1318
1493
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1319
1494
|
* @permissionScope Read Bookings - Including Participants
|
|
1320
1495
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1496
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1497
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1321
1498
|
* @permissionScope Manage Bookings - all permissions
|
|
1322
1499
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1323
1500
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1368,6 +1545,8 @@ export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelo
|
|
|
1368
1545
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1369
1546
|
* @permissionScope Read Bookings - Including Participants
|
|
1370
1547
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1548
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1549
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1371
1550
|
* @permissionScope Manage Bookings - all permissions
|
|
1372
1551
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1373
1552
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1390,6 +1569,7 @@ export interface GetScheduleOptions {
|
|
|
1390
1569
|
*
|
|
1391
1570
|
* Max: 1 field
|
|
1392
1571
|
* Default: No personal data is returned.
|
|
1572
|
+
* @maxSize 1
|
|
1393
1573
|
*/
|
|
1394
1574
|
fields?: RequestedFields[];
|
|
1395
1575
|
}
|
|
@@ -1442,6 +1622,8 @@ export interface GetScheduleOptions {
|
|
|
1442
1622
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1443
1623
|
* @permissionScope Read Bookings - Including Participants
|
|
1444
1624
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1625
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1626
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1445
1627
|
* @permissionScope Manage Bookings - all permissions
|
|
1446
1628
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1447
1629
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1465,6 +1647,7 @@ export interface QuerySchedulesOptions {
|
|
|
1465
1647
|
*
|
|
1466
1648
|
* Max: 1 field
|
|
1467
1649
|
* Default: No personal data is returned.
|
|
1650
|
+
* @maxSize 1
|
|
1468
1651
|
*/
|
|
1469
1652
|
fields?: RequestedFields[] | undefined;
|
|
1470
1653
|
}
|
|
@@ -1534,6 +1717,7 @@ export interface CreateScheduleOptions {
|
|
|
1534
1717
|
/**
|
|
1535
1718
|
* Idempotency key guaranteeing that you don't create the same schedule more
|
|
1536
1719
|
* than once.
|
|
1720
|
+
* @format GUID
|
|
1537
1721
|
*/
|
|
1538
1722
|
idempotencyKey?: string | null;
|
|
1539
1723
|
}
|
|
@@ -1569,6 +1753,7 @@ export declare function updateSchedule(_id: string | null, schedule: UpdateSched
|
|
|
1569
1753
|
export interface UpdateSchedule {
|
|
1570
1754
|
/**
|
|
1571
1755
|
* Schedule ID.
|
|
1756
|
+
* @format GUID
|
|
1572
1757
|
* @readonly
|
|
1573
1758
|
*/
|
|
1574
1759
|
_id?: string | null;
|
|
@@ -1579,6 +1764,8 @@ export interface UpdateSchedule {
|
|
|
1579
1764
|
* the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
|
|
1580
1765
|
* If the schedule belongs to a Bookings service, identical to the ID of
|
|
1581
1766
|
* the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
1767
|
+
* @format GUID
|
|
1768
|
+
* @immutable
|
|
1582
1769
|
*/
|
|
1583
1770
|
externalId?: string | null;
|
|
1584
1771
|
/**
|
|
@@ -1586,6 +1773,8 @@ export interface UpdateSchedule {
|
|
|
1586
1773
|
*
|
|
1587
1774
|
* Min: 1 character
|
|
1588
1775
|
* Max: 200 characters
|
|
1776
|
+
* @minLength 1
|
|
1777
|
+
* @maxLength 200
|
|
1589
1778
|
*/
|
|
1590
1779
|
name?: string | null;
|
|
1591
1780
|
/**
|
|
@@ -1608,6 +1797,8 @@ export interface UpdateSchedule {
|
|
|
1608
1797
|
*
|
|
1609
1798
|
* Min: 1 character
|
|
1610
1799
|
* Max: 150 characters
|
|
1800
|
+
* @minLength 1
|
|
1801
|
+
* @maxLength 150
|
|
1611
1802
|
*/
|
|
1612
1803
|
timeZone?: string | null;
|
|
1613
1804
|
/**
|
|
@@ -1623,6 +1814,8 @@ export interface UpdateSchedule {
|
|
|
1623
1814
|
*
|
|
1624
1815
|
* Min: 1 character
|
|
1625
1816
|
* Max: 200 characters
|
|
1817
|
+
* @minLength 1
|
|
1818
|
+
* @maxLength 200
|
|
1626
1819
|
*/
|
|
1627
1820
|
defaultTitle?: string | null;
|
|
1628
1821
|
/**
|
|
@@ -1649,6 +1842,8 @@ export interface UpdateSchedule {
|
|
|
1649
1842
|
* in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
1650
1843
|
* you must provide the Wix Bookings app ID
|
|
1651
1844
|
* `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
|
|
1845
|
+
* @format GUID
|
|
1846
|
+
* @immutable
|
|
1652
1847
|
*/
|
|
1653
1848
|
appId?: string | null;
|
|
1654
1849
|
/**
|
|
@@ -1657,6 +1852,7 @@ export interface UpdateSchedule {
|
|
|
1657
1852
|
* for more information.
|
|
1658
1853
|
*
|
|
1659
1854
|
* Max: 1 permission
|
|
1855
|
+
* @maxSize 1
|
|
1660
1856
|
*/
|
|
1661
1857
|
permissions?: Permission[];
|
|
1662
1858
|
/** Extensions enabling applications or users to save custom data related to the schedule. */
|