@wix/auto_sdk_calendar_events 1.0.2 → 1.0.4
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-event-events.context.d.ts +5 -5
- package/build/cjs/src/calendar-v3-event-events.context.js +5 -5
- package/build/cjs/src/calendar-v3-event-events.context.js.map +1 -1
- package/build/cjs/src/calendar-v3-event-events.http.d.ts +20 -20
- package/build/cjs/src/calendar-v3-event-events.http.js +123 -123
- package/build/cjs/src/calendar-v3-event-events.http.js.map +1 -1
- package/build/cjs/src/calendar-v3-event-events.meta.d.ts +6 -6
- package/build/cjs/src/calendar-v3-event-events.meta.js +39 -39
- package/build/cjs/src/calendar-v3-event-events.meta.js.map +1 -1
- package/build/cjs/src/calendar-v3-event-events.public.d.ts +34 -34
- package/build/cjs/src/calendar-v3-event-events.public.js +13 -13
- package/build/cjs/src/calendar-v3-event-events.public.js.map +1 -1
- package/build/cjs/src/calendar-v3-event-events.types.d.ts +713 -553
- package/build/cjs/src/calendar-v3-event-events.types.js +14 -14
- package/build/cjs/src/calendar-v3-event-events.types.js.map +1 -1
- package/build/cjs/src/calendar-v3-event-events.universal.d.ts +1117 -891
- package/build/cjs/src/calendar-v3-event-events.universal.js +184 -170
- package/build/cjs/src/calendar-v3-event-events.universal.js.map +1 -1
- package/build/es/src/calendar-v3-event-events.context.d.ts +5 -5
- package/build/es/src/calendar-v3-event-events.context.js +4 -4
- package/build/es/src/calendar-v3-event-events.context.js.map +1 -1
- package/build/es/src/calendar-v3-event-events.http.d.ts +20 -20
- package/build/es/src/calendar-v3-event-events.http.js +120 -120
- package/build/es/src/calendar-v3-event-events.http.js.map +1 -1
- package/build/es/src/calendar-v3-event-events.meta.d.ts +6 -6
- package/build/es/src/calendar-v3-event-events.meta.js +36 -36
- package/build/es/src/calendar-v3-event-events.meta.js.map +1 -1
- package/build/es/src/calendar-v3-event-events.public.d.ts +34 -34
- package/build/es/src/calendar-v3-event-events.public.js +10 -10
- package/build/es/src/calendar-v3-event-events.public.js.map +1 -1
- package/build/es/src/calendar-v3-event-events.types.d.ts +713 -553
- package/build/es/src/calendar-v3-event-events.types.js +13 -13
- package/build/es/src/calendar-v3-event-events.types.js.map +1 -1
- package/build/es/src/calendar-v3-event-events.universal.d.ts +1117 -891
- package/build/es/src/calendar-v3-event-events.universal.js +181 -167
- package/build/es/src/calendar-v3-event-events.universal.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +5 -5
- package/build/internal/cjs/src/calendar-v3-event-events.context.js +5 -5
- package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +20 -20
- package/build/internal/cjs/src/calendar-v3-event-events.http.js +123 -123
- package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +6 -6
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js +39 -39
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-event-events.public.d.ts +34 -34
- package/build/internal/cjs/src/calendar-v3-event-events.public.js +13 -13
- package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-event-events.types.d.ts +713 -553
- package/build/internal/cjs/src/calendar-v3-event-events.types.js +14 -14
- package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +1 -1
- package/build/internal/cjs/src/calendar-v3-event-events.universal.d.ts +1117 -891
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js +184 -170
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +1 -1
- package/build/internal/es/src/calendar-v3-event-events.context.d.ts +5 -5
- package/build/internal/es/src/calendar-v3-event-events.context.js +4 -4
- package/build/internal/es/src/calendar-v3-event-events.context.js.map +1 -1
- package/build/internal/es/src/calendar-v3-event-events.http.d.ts +20 -20
- package/build/internal/es/src/calendar-v3-event-events.http.js +120 -120
- package/build/internal/es/src/calendar-v3-event-events.http.js.map +1 -1
- package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +6 -6
- package/build/internal/es/src/calendar-v3-event-events.meta.js +36 -36
- package/build/internal/es/src/calendar-v3-event-events.meta.js.map +1 -1
- package/build/internal/es/src/calendar-v3-event-events.public.d.ts +34 -34
- package/build/internal/es/src/calendar-v3-event-events.public.js +10 -10
- package/build/internal/es/src/calendar-v3-event-events.public.js.map +1 -1
- package/build/internal/es/src/calendar-v3-event-events.types.d.ts +713 -553
- package/build/internal/es/src/calendar-v3-event-events.types.js +13 -13
- package/build/internal/es/src/calendar-v3-event-events.types.js.map +1 -1
- package/build/internal/es/src/calendar-v3-event-events.universal.d.ts +1117 -891
- package/build/internal/es/src/calendar-v3-event-events.universal.js +181 -167
- package/build/internal/es/src/calendar-v3-event-events.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
export interface Event {
|
|
11
11
|
/**
|
|
12
12
|
* Event ID.
|
|
13
|
+
* @minLength 36
|
|
14
|
+
* @maxLength 250
|
|
13
15
|
* @readonly
|
|
14
16
|
*/
|
|
15
17
|
id?: string | null;
|
|
@@ -17,6 +19,8 @@ export interface Event {
|
|
|
17
19
|
* ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
|
|
18
20
|
* the event belongs to.
|
|
19
21
|
* After creating an event, you can't assign it to a different schedule.
|
|
22
|
+
* @format GUID
|
|
23
|
+
* @immutable
|
|
20
24
|
*/
|
|
21
25
|
scheduleId?: string | null;
|
|
22
26
|
/**
|
|
@@ -26,6 +30,7 @@ export interface Event {
|
|
|
26
30
|
* the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
|
|
27
31
|
* If the schedule belongs to a Bookings service,
|
|
28
32
|
* identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
|
|
33
|
+
* @format GUID
|
|
29
34
|
* @readonly
|
|
30
35
|
*/
|
|
31
36
|
externalScheduleId?: string | null;
|
|
@@ -45,6 +50,7 @@ export interface Event {
|
|
|
45
50
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
46
51
|
* + `CLASS`: Bookings class event.
|
|
47
52
|
* + `COURSE`: Bookings course event.
|
|
53
|
+
* @immutable
|
|
48
54
|
*/
|
|
49
55
|
type?: string | null;
|
|
50
56
|
/**
|
|
@@ -63,6 +69,8 @@ export interface Event {
|
|
|
63
69
|
*
|
|
64
70
|
* Min: 1 character
|
|
65
71
|
* Max: 200 characters
|
|
72
|
+
* @minLength 1
|
|
73
|
+
* @maxLength 200
|
|
66
74
|
*/
|
|
67
75
|
title?: string | null;
|
|
68
76
|
/** Information about when the event starts. */
|
|
@@ -126,6 +134,8 @@ export interface Event {
|
|
|
126
134
|
/**
|
|
127
135
|
* ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
|
|
128
136
|
* and `EXCEPTION` events.
|
|
137
|
+
* @minLength 64
|
|
138
|
+
* @maxLength 64
|
|
129
139
|
* @readonly
|
|
130
140
|
*/
|
|
131
141
|
recurringEventId?: string | null;
|
|
@@ -152,6 +162,7 @@ export interface Event {
|
|
|
152
162
|
* providing the service or the room where the appointment takes place.
|
|
153
163
|
*
|
|
154
164
|
* Max: 100 resources
|
|
165
|
+
* @maxSize 100
|
|
155
166
|
*/
|
|
156
167
|
resources?: Resource[];
|
|
157
168
|
/**
|
|
@@ -184,6 +195,8 @@ export interface Event {
|
|
|
184
195
|
*
|
|
185
196
|
* Min: 1 character
|
|
186
197
|
* Max: 5000 characters
|
|
198
|
+
* @minLength 1
|
|
199
|
+
* @maxLength 5000
|
|
187
200
|
*/
|
|
188
201
|
notes?: string | null;
|
|
189
202
|
/**
|
|
@@ -197,6 +210,7 @@ export interface Event {
|
|
|
197
210
|
* ID of the app that owns the event. Identical to `appId` of the
|
|
198
211
|
* [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
|
|
199
212
|
* to which the event belongs.
|
|
213
|
+
* @format GUID
|
|
200
214
|
* @readonly
|
|
201
215
|
*/
|
|
202
216
|
appId?: string | null;
|
|
@@ -240,6 +254,7 @@ export interface ZonedDate {
|
|
|
240
254
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
241
255
|
* For example, `2024-01-30T13:30:00`.
|
|
242
256
|
* Wix Calendar APIs ignore seconds.
|
|
257
|
+
* @format LOCAL_DATE_TIME
|
|
243
258
|
*/
|
|
244
259
|
localDate?: string | null;
|
|
245
260
|
/**
|
|
@@ -284,6 +299,8 @@ export interface RecurrenceRule {
|
|
|
284
299
|
* Min: `1`
|
|
285
300
|
* Max: `4`
|
|
286
301
|
* Default: `1`
|
|
302
|
+
* @min 1
|
|
303
|
+
* @max 4
|
|
287
304
|
*/
|
|
288
305
|
interval?: number | null;
|
|
289
306
|
/**
|
|
@@ -292,6 +309,8 @@ export interface RecurrenceRule {
|
|
|
292
309
|
*
|
|
293
310
|
* Min: 1 day
|
|
294
311
|
* Max: 1 day
|
|
312
|
+
* @minSize 1
|
|
313
|
+
* @maxSize 1
|
|
295
314
|
*/
|
|
296
315
|
days?: Day[];
|
|
297
316
|
/**
|
|
@@ -340,6 +359,7 @@ export interface Location {
|
|
|
340
359
|
/**
|
|
341
360
|
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
342
361
|
* ID. Available only for `BUSINESS` locations.
|
|
362
|
+
* @format GUID
|
|
343
363
|
*/
|
|
344
364
|
id?: string | null;
|
|
345
365
|
/**
|
|
@@ -358,12 +378,16 @@ export interface Location {
|
|
|
358
378
|
*
|
|
359
379
|
* Min: 1 character
|
|
360
380
|
* Max: 150 characters
|
|
381
|
+
* @minLength 1
|
|
382
|
+
* @maxLength 150
|
|
361
383
|
*/
|
|
362
384
|
name?: string | null;
|
|
363
385
|
/**
|
|
364
386
|
* Location address. For `BUSINESS` locations, it's identical to the
|
|
365
387
|
* [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
|
|
366
388
|
* `formattedAddress`.
|
|
389
|
+
* @minLength 1
|
|
390
|
+
* @maxLength 300
|
|
367
391
|
*/
|
|
368
392
|
address?: string | null;
|
|
369
393
|
}
|
|
@@ -377,7 +401,10 @@ export declare enum LocationType {
|
|
|
377
401
|
CUSTOM = "CUSTOM"
|
|
378
402
|
}
|
|
379
403
|
export interface Resource {
|
|
380
|
-
/**
|
|
404
|
+
/**
|
|
405
|
+
* Resource ID.
|
|
406
|
+
* @format GUID
|
|
407
|
+
*/
|
|
381
408
|
id?: string | null;
|
|
382
409
|
/**
|
|
383
410
|
* Resource name.
|
|
@@ -424,6 +451,7 @@ export interface Participants {
|
|
|
424
451
|
* Full or partial list of the participants.
|
|
425
452
|
*
|
|
426
453
|
* Max: 50 participants
|
|
454
|
+
* @maxSize 50
|
|
427
455
|
*/
|
|
428
456
|
list?: Participant[];
|
|
429
457
|
/**
|
|
@@ -448,15 +476,24 @@ export interface Participant {
|
|
|
448
476
|
*
|
|
449
477
|
* Min: 1 character
|
|
450
478
|
* Max: 200 characters
|
|
479
|
+
* @minLength 1
|
|
480
|
+
* @maxLength 200
|
|
451
481
|
*/
|
|
452
482
|
name?: string | null;
|
|
453
|
-
/**
|
|
483
|
+
/**
|
|
484
|
+
* Participant's phone number.
|
|
485
|
+
* @format PHONE
|
|
486
|
+
*/
|
|
454
487
|
phone?: string | null;
|
|
455
|
-
/**
|
|
488
|
+
/**
|
|
489
|
+
* Participant's email address.
|
|
490
|
+
* @format EMAIL
|
|
491
|
+
*/
|
|
456
492
|
email?: string | null;
|
|
457
493
|
/**
|
|
458
494
|
* [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
459
495
|
* ID of the participant.
|
|
496
|
+
* @format GUID
|
|
460
497
|
*/
|
|
461
498
|
contactId?: string | null;
|
|
462
499
|
}
|
|
@@ -475,6 +512,8 @@ export interface ConferencingDetails {
|
|
|
475
512
|
*
|
|
476
513
|
* Min: 1 character
|
|
477
514
|
* Max: 2000 characters
|
|
515
|
+
* @minLength 1
|
|
516
|
+
* @maxLength 2000
|
|
478
517
|
*/
|
|
479
518
|
hostUrl?: string | null;
|
|
480
519
|
/**
|
|
@@ -482,6 +521,8 @@ export interface ConferencingDetails {
|
|
|
482
521
|
*
|
|
483
522
|
* Min: 1 character
|
|
484
523
|
* Max: 2000 characters
|
|
524
|
+
* @minLength 1
|
|
525
|
+
* @maxLength 2000
|
|
485
526
|
*/
|
|
486
527
|
guestUrl?: string | null;
|
|
487
528
|
/**
|
|
@@ -489,6 +530,8 @@ export interface ConferencingDetails {
|
|
|
489
530
|
*
|
|
490
531
|
* Min: 1 character
|
|
491
532
|
* Max: 100 characters
|
|
533
|
+
* @minLength 1
|
|
534
|
+
* @maxLength 100
|
|
492
535
|
*/
|
|
493
536
|
password?: string | null;
|
|
494
537
|
/**
|
|
@@ -496,6 +539,8 @@ export interface ConferencingDetails {
|
|
|
496
539
|
*
|
|
497
540
|
* Min: 1 character
|
|
498
541
|
* Max: 150 characters
|
|
542
|
+
* @minLength 1
|
|
543
|
+
* @maxLength 150
|
|
499
544
|
*/
|
|
500
545
|
externalId?: string | null;
|
|
501
546
|
}
|
|
@@ -542,6 +587,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
542
587
|
/**
|
|
543
588
|
* ID of a Wix user. For example, the site owner or a
|
|
544
589
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
590
|
+
* @format GUID
|
|
545
591
|
*/
|
|
546
592
|
wixUserId?: string;
|
|
547
593
|
}
|
|
@@ -550,6 +596,7 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
550
596
|
/**
|
|
551
597
|
* ID of a Wix user. For example, the site owner or a
|
|
552
598
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
599
|
+
* @format GUID
|
|
553
600
|
*/
|
|
554
601
|
wixUserId?: string;
|
|
555
602
|
}
|
|
@@ -590,10 +637,12 @@ export interface ParticipantNotification {
|
|
|
590
637
|
*
|
|
591
638
|
* Min: 1 character
|
|
592
639
|
* Max: 5000 characters
|
|
640
|
+
* @minLength 1
|
|
641
|
+
* @maxLength 5000
|
|
593
642
|
*/
|
|
594
643
|
message?: string | null;
|
|
595
644
|
}
|
|
596
|
-
/**
|
|
645
|
+
/** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
|
|
597
646
|
export interface EventUpdatedWithMetadata {
|
|
598
647
|
/** The updated event. */
|
|
599
648
|
event?: Event;
|
|
@@ -604,6 +653,7 @@ export interface EventUpdatedWithMetadata {
|
|
|
604
653
|
participantNotification?: ParticipantNotification;
|
|
605
654
|
}
|
|
606
655
|
export interface MigrateSiteRequest {
|
|
656
|
+
/** @format GUID */
|
|
607
657
|
metaSiteId?: string;
|
|
608
658
|
/**
|
|
609
659
|
* Whether to run in safe, dry run mode, and only print logs without applying any changes.
|
|
@@ -621,14 +671,18 @@ export interface MigrateSiteResponse {
|
|
|
621
671
|
skipped?: boolean | null;
|
|
622
672
|
}
|
|
623
673
|
export interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
674
|
+
/** @format GUID */
|
|
624
675
|
metaSiteId?: string;
|
|
676
|
+
/** @format GUID */
|
|
625
677
|
currentBusinessResourceId?: string;
|
|
626
678
|
migrateBusinessConferenceId?: boolean;
|
|
627
679
|
}
|
|
628
680
|
export interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
629
681
|
}
|
|
630
682
|
export interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
683
|
+
/** @format GUID */
|
|
631
684
|
metaSiteId?: string;
|
|
685
|
+
/** @format GUID */
|
|
632
686
|
currentBusinessResourceId?: string;
|
|
633
687
|
migrateBusinessConferenceId?: boolean;
|
|
634
688
|
}
|
|
@@ -707,9 +761,15 @@ export interface ActionEvent {
|
|
|
707
761
|
bodyAsJson?: string;
|
|
708
762
|
}
|
|
709
763
|
export interface MessageEnvelope {
|
|
710
|
-
/**
|
|
764
|
+
/**
|
|
765
|
+
* App instance ID.
|
|
766
|
+
* @format GUID
|
|
767
|
+
*/
|
|
711
768
|
instanceId?: string | null;
|
|
712
|
-
/**
|
|
769
|
+
/**
|
|
770
|
+
* Event type.
|
|
771
|
+
* @maxLength 150
|
|
772
|
+
*/
|
|
713
773
|
eventType?: string;
|
|
714
774
|
/** The identification type and identity data. */
|
|
715
775
|
identity?: IdentificationData;
|
|
@@ -717,26 +777,50 @@ export interface MessageEnvelope {
|
|
|
717
777
|
data?: string;
|
|
718
778
|
}
|
|
719
779
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
720
|
-
/**
|
|
780
|
+
/**
|
|
781
|
+
* ID of a site visitor that has not logged in to the site.
|
|
782
|
+
* @format GUID
|
|
783
|
+
*/
|
|
721
784
|
anonymousVisitorId?: string;
|
|
722
|
-
/**
|
|
785
|
+
/**
|
|
786
|
+
* ID of a site visitor that has logged in to the site.
|
|
787
|
+
* @format GUID
|
|
788
|
+
*/
|
|
723
789
|
memberId?: string;
|
|
724
|
-
/**
|
|
790
|
+
/**
|
|
791
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
792
|
+
* @format GUID
|
|
793
|
+
*/
|
|
725
794
|
wixUserId?: string;
|
|
726
|
-
/**
|
|
795
|
+
/**
|
|
796
|
+
* ID of an app.
|
|
797
|
+
* @format GUID
|
|
798
|
+
*/
|
|
727
799
|
appId?: string;
|
|
728
800
|
/** @readonly */
|
|
729
801
|
identityType?: WebhookIdentityType;
|
|
730
802
|
}
|
|
731
803
|
/** @oneof */
|
|
732
804
|
export interface IdentificationDataIdOneOf {
|
|
733
|
-
/**
|
|
805
|
+
/**
|
|
806
|
+
* ID of a site visitor that has not logged in to the site.
|
|
807
|
+
* @format GUID
|
|
808
|
+
*/
|
|
734
809
|
anonymousVisitorId?: string;
|
|
735
|
-
/**
|
|
810
|
+
/**
|
|
811
|
+
* ID of a site visitor that has logged in to the site.
|
|
812
|
+
* @format GUID
|
|
813
|
+
*/
|
|
736
814
|
memberId?: string;
|
|
737
|
-
/**
|
|
815
|
+
/**
|
|
816
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
817
|
+
* @format GUID
|
|
818
|
+
*/
|
|
738
819
|
wixUserId?: string;
|
|
739
|
-
/**
|
|
820
|
+
/**
|
|
821
|
+
* ID of an app.
|
|
822
|
+
* @format GUID
|
|
823
|
+
*/
|
|
740
824
|
appId?: string;
|
|
741
825
|
}
|
|
742
826
|
export declare enum WebhookIdentityType {
|
|
@@ -746,100 +830,32 @@ export declare enum WebhookIdentityType {
|
|
|
746
830
|
WIX_USER = "WIX_USER",
|
|
747
831
|
APP = "APP"
|
|
748
832
|
}
|
|
749
|
-
export interface
|
|
750
|
-
/**
|
|
751
|
-
* ID of the event to retrieve.
|
|
752
|
-
*
|
|
753
|
-
* Min: 36 characters
|
|
754
|
-
* Max: 250 characters
|
|
755
|
-
*/
|
|
756
|
-
eventId: string | null;
|
|
757
|
-
/**
|
|
758
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
759
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
760
|
-
* `America/New_York` or `UTC`.
|
|
761
|
-
*
|
|
762
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
763
|
-
*/
|
|
764
|
-
timeZone?: string | null;
|
|
765
|
-
/**
|
|
766
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
767
|
-
* [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
|
|
768
|
-
* for more information.
|
|
769
|
-
*
|
|
770
|
-
* Supported values:
|
|
771
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
772
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
773
|
-
*
|
|
774
|
-
* Max: 1 field
|
|
775
|
-
* Default: No personal data is returned.
|
|
776
|
-
*/
|
|
777
|
-
fields?: RequestedFields[];
|
|
778
|
-
}
|
|
779
|
-
export declare enum RequestedFields {
|
|
780
|
-
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
781
|
-
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
782
|
-
PI_FIELDS = "PI_FIELDS",
|
|
783
|
-
/** Returns only fields containing your own personal data. */
|
|
784
|
-
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
785
|
-
}
|
|
786
|
-
export interface GetEventResponse {
|
|
787
|
-
/** Retrieved event. */
|
|
788
|
-
event?: Event;
|
|
789
|
-
}
|
|
790
|
-
export interface ListEventsRequest {
|
|
791
|
-
/**
|
|
792
|
-
* IDs of the events to retrieve.
|
|
793
|
-
*
|
|
794
|
-
* Min: 1 event ID
|
|
795
|
-
* Min: 100 event IDs
|
|
796
|
-
*/
|
|
797
|
-
eventIds: string[];
|
|
798
|
-
/**
|
|
799
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
800
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
801
|
-
* `America/New_York` or `UTC`.
|
|
802
|
-
*
|
|
803
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
804
|
-
*/
|
|
805
|
-
timeZone?: string | null;
|
|
833
|
+
export interface ListEventsByContactIdRequest {
|
|
806
834
|
/**
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
*
|
|
810
|
-
*
|
|
811
|
-
* Supported values:
|
|
812
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
813
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
814
|
-
*
|
|
815
|
-
* Max: 1 field
|
|
816
|
-
* Default: No personal data is returned.
|
|
835
|
+
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
836
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
837
|
+
* @format GUID
|
|
817
838
|
*/
|
|
818
|
-
|
|
819
|
-
}
|
|
820
|
-
export interface ListEventsResponse {
|
|
821
|
-
/** Retrieved events matching the provided IDs. */
|
|
822
|
-
events?: Event[];
|
|
823
|
-
}
|
|
824
|
-
export interface QueryEventsRequest {
|
|
839
|
+
contactId: string | null;
|
|
825
840
|
/**
|
|
826
841
|
* Local start date and time from which events are returned in
|
|
827
842
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
828
|
-
* `2024-01-30T13:30:00`.
|
|
843
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
829
844
|
*
|
|
830
845
|
* Events that start before the `fromLocalDate` but end after it are included in
|
|
831
|
-
* the results. Must be earlier than `toLocalDate
|
|
832
|
-
*
|
|
846
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
847
|
+
* @format LOCAL_DATE_TIME
|
|
833
848
|
*/
|
|
834
849
|
fromLocalDate?: string | null;
|
|
835
850
|
/**
|
|
836
851
|
* Local end date and time up to which events are returned in
|
|
837
852
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
838
|
-
* `2024-01-30T13:30:00`.
|
|
853
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
854
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
839
855
|
*
|
|
840
856
|
* Events that start before `toLocalDate` but end after it are included in the
|
|
841
|
-
* results. Must be later than `fromLocalDate
|
|
842
|
-
*
|
|
857
|
+
* results. Must be later than `fromLocalDate`.
|
|
858
|
+
* @format LOCAL_DATE_TIME
|
|
843
859
|
*/
|
|
844
860
|
toLocalDate?: string | null;
|
|
845
861
|
/**
|
|
@@ -850,74 +866,22 @@ export interface QueryEventsRequest {
|
|
|
850
866
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
851
867
|
*/
|
|
852
868
|
timeZone?: string | null;
|
|
853
|
-
/** Query containing filters and paging. */
|
|
854
|
-
query?: CursorQuery;
|
|
855
|
-
/**
|
|
856
|
-
* Filters events based on their `recurrenceType`.
|
|
857
|
-
*
|
|
858
|
-
* Max: 5 recurrence types can be specified.
|
|
859
|
-
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
860
|
-
*/
|
|
861
|
-
recurrenceType?: RecurrenceType[];
|
|
862
|
-
/**
|
|
863
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
864
|
-
* [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
|
|
865
|
-
* for more information.
|
|
866
|
-
*
|
|
867
|
-
* Supported values:
|
|
868
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
869
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
870
|
-
*
|
|
871
|
-
* Max: 1 field
|
|
872
|
-
* Default: No personal data is returned.
|
|
873
|
-
*/
|
|
874
|
-
fields?: RequestedFields[];
|
|
875
|
-
}
|
|
876
|
-
/** TODO Diverge */
|
|
877
|
-
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
878
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
879
|
-
cursorPaging?: CursorPaging;
|
|
880
|
-
/**
|
|
881
|
-
* Filter object.
|
|
882
|
-
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
883
|
-
* for more information.
|
|
884
|
-
*
|
|
885
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
886
|
-
*
|
|
887
|
-
* For a detailed list of supported filters, see Supported Filters.
|
|
888
|
-
*/
|
|
889
|
-
filter?: Record<string, any> | null;
|
|
890
|
-
/**
|
|
891
|
-
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
892
|
-
* Default is start ascending.
|
|
893
|
-
*/
|
|
894
|
-
sort?: Sorting[];
|
|
895
|
-
}
|
|
896
|
-
/** @oneof */
|
|
897
|
-
export interface CursorQueryPagingMethodOneOf {
|
|
898
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
899
|
-
cursorPaging?: CursorPaging;
|
|
900
|
-
}
|
|
901
|
-
/** TODO Diverge */
|
|
902
|
-
export interface Sorting {
|
|
903
869
|
/**
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
*
|
|
870
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
871
|
+
* to filter events by.
|
|
872
|
+
* @format GUID
|
|
907
873
|
*/
|
|
908
|
-
|
|
909
|
-
/**
|
|
910
|
-
|
|
911
|
-
}
|
|
912
|
-
export declare enum SortOrder {
|
|
913
|
-
ASC = "ASC",
|
|
914
|
-
DESC = "DESC"
|
|
874
|
+
appId?: string | null;
|
|
875
|
+
/** Cursor to retrieve the next page of the results. */
|
|
876
|
+
cursorPaging?: CommonCursorPaging;
|
|
915
877
|
}
|
|
916
878
|
/** TODO Diverge */
|
|
917
|
-
export interface
|
|
879
|
+
export interface CommonCursorPaging {
|
|
918
880
|
/**
|
|
919
881
|
* Number of events to return.
|
|
920
|
-
* Defaults to `50`. Maximum `
|
|
882
|
+
* Defaults to `50`. Maximum `100`.
|
|
883
|
+
* @min 1
|
|
884
|
+
* @max 100
|
|
921
885
|
*/
|
|
922
886
|
limit?: number | null;
|
|
923
887
|
/**
|
|
@@ -929,18 +893,18 @@ export interface CursorPaging {
|
|
|
929
893
|
*/
|
|
930
894
|
cursor?: string | null;
|
|
931
895
|
}
|
|
932
|
-
export interface
|
|
933
|
-
/** Retrieved events
|
|
896
|
+
export interface ListEventsByContactIdResponse {
|
|
897
|
+
/** Retrieved events. */
|
|
934
898
|
events?: Event[];
|
|
935
899
|
/** Paging metadata. */
|
|
936
|
-
pagingMetadata?:
|
|
900
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
937
901
|
}
|
|
938
902
|
/** TODO Diverge */
|
|
939
|
-
export interface
|
|
903
|
+
export interface CommonCursorPagingMetadata {
|
|
940
904
|
/** Number of items returned in the response. */
|
|
941
905
|
count?: number | null;
|
|
942
906
|
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
943
|
-
cursors?:
|
|
907
|
+
cursors?: CommonCursors;
|
|
944
908
|
/**
|
|
945
909
|
* Indicates if there are more results after the current page.
|
|
946
910
|
* If `true`, another page of results can be retrieved.
|
|
@@ -948,307 +912,75 @@ export interface CursorPagingMetadata {
|
|
|
948
912
|
*/
|
|
949
913
|
hasNext?: boolean | null;
|
|
950
914
|
}
|
|
951
|
-
export interface
|
|
915
|
+
export interface CommonCursors {
|
|
952
916
|
/** Cursor pointing to next page in the list of results. */
|
|
953
917
|
next?: string | null;
|
|
954
918
|
}
|
|
955
|
-
export interface
|
|
956
|
-
/**
|
|
957
|
-
* The ID of the recurring event.
|
|
958
|
-
* Required, unless `cursorPaging` is provided.
|
|
959
|
-
*/
|
|
960
|
-
recurringEventId?: string | null;
|
|
919
|
+
export interface ListEventsByMemberIdRequest {
|
|
961
920
|
/**
|
|
962
|
-
*
|
|
963
|
-
* Required, unless `cursorPaging
|
|
921
|
+
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
922
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
923
|
+
* Provide `me` to retrieve events for the currently logged-in member.
|
|
924
|
+
* You must have the `Read Calendars - Including PI`
|
|
925
|
+
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
926
|
+
* to retrieve events for members who aren't the currently logged in member.
|
|
927
|
+
* @minLength 2
|
|
928
|
+
* @maxLength 36
|
|
964
929
|
*/
|
|
965
|
-
|
|
930
|
+
memberId: string | null;
|
|
966
931
|
/**
|
|
967
|
-
*
|
|
968
|
-
*
|
|
969
|
-
* Required
|
|
932
|
+
* Local start date and time from which events are returned in
|
|
933
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
934
|
+
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
935
|
+
*
|
|
936
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
937
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
938
|
+
* @format LOCAL_DATE_TIME
|
|
970
939
|
*/
|
|
971
|
-
|
|
940
|
+
fromLocalDate?: string | null;
|
|
972
941
|
/**
|
|
973
|
-
*
|
|
974
|
-
*
|
|
975
|
-
*
|
|
942
|
+
* Local end date and time up to which events are returned in
|
|
943
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
944
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
945
|
+
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
946
|
+
*
|
|
947
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
948
|
+
* results. Must be later than `fromLocalDate`.
|
|
949
|
+
* @format LOCAL_DATE_TIME
|
|
976
950
|
*/
|
|
977
|
-
|
|
978
|
-
/** Optional cursor pointing to the next page of events. */
|
|
979
|
-
cursorPaging?: CursorPaging;
|
|
980
|
-
}
|
|
981
|
-
export interface ListRecurringEventInstancesHistoryResponse {
|
|
982
|
-
/** The recurring event instances. */
|
|
983
|
-
recurringEventInstances?: Event[];
|
|
984
|
-
/** Paging metadata. */
|
|
985
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
986
|
-
}
|
|
987
|
-
export interface CreateEventRequest {
|
|
988
|
-
/** Event to create. */
|
|
989
|
-
event: Event;
|
|
951
|
+
toLocalDate?: string | null;
|
|
990
952
|
/**
|
|
991
953
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
992
|
-
* for calculating `adjustedStart` and
|
|
993
|
-
* `America/New_York` or `UTC`.
|
|
954
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
955
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
994
956
|
*
|
|
995
957
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
996
958
|
*/
|
|
997
959
|
timeZone?: string | null;
|
|
998
960
|
/**
|
|
999
|
-
*
|
|
1000
|
-
*
|
|
961
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
962
|
+
* to filter events by.
|
|
963
|
+
* @format GUID
|
|
1001
964
|
*/
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
/** Created event. */
|
|
1006
|
-
event?: Event;
|
|
1007
|
-
}
|
|
1008
|
-
export interface BulkCreateEventRequest {
|
|
1009
|
-
/** Events to create. */
|
|
1010
|
-
events: MaskedEvent[];
|
|
1011
|
-
/**
|
|
1012
|
-
* Whether to return created events.
|
|
1013
|
-
*
|
|
1014
|
-
* Default: `false`.
|
|
1015
|
-
*/
|
|
1016
|
-
returnEntity?: boolean | null;
|
|
1017
|
-
/**
|
|
1018
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1019
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1020
|
-
* `America/New_York` or `UTC`.
|
|
1021
|
-
*
|
|
1022
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1023
|
-
*/
|
|
1024
|
-
timeZone?: string | null;
|
|
1025
|
-
}
|
|
1026
|
-
export interface MaskedEvent {
|
|
1027
|
-
/** Event to create. */
|
|
1028
|
-
event?: Event;
|
|
1029
|
-
}
|
|
1030
|
-
export interface BulkCreateEventResponse {
|
|
1031
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1032
|
-
results?: BulkEventResult[];
|
|
1033
|
-
/** Total successes and failures. */
|
|
1034
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1035
|
-
}
|
|
1036
|
-
export interface BulkEventResult {
|
|
1037
|
-
/** Whether the requested action was successful. */
|
|
1038
|
-
itemMetadata?: ItemMetadata;
|
|
1039
|
-
/** The event. */
|
|
1040
|
-
item?: Event;
|
|
1041
|
-
}
|
|
1042
|
-
export interface ItemMetadata {
|
|
1043
|
-
/**
|
|
1044
|
-
* Event ID.
|
|
1045
|
-
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1046
|
-
*/
|
|
1047
|
-
id?: string | null;
|
|
1048
|
-
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1049
|
-
originalIndex?: number;
|
|
1050
|
-
/**
|
|
1051
|
-
* Whether the requested action was successful for this event.
|
|
1052
|
-
* When `false`, the `error` field is populated.
|
|
1053
|
-
*/
|
|
1054
|
-
success?: boolean;
|
|
1055
|
-
/** Details about the error in case of failure. */
|
|
1056
|
-
error?: ApplicationError;
|
|
1057
|
-
}
|
|
1058
|
-
export interface ApplicationError {
|
|
1059
|
-
/** Error code. */
|
|
1060
|
-
code?: string;
|
|
1061
|
-
/** Description of the error. */
|
|
1062
|
-
description?: string;
|
|
1063
|
-
/** Data related to the error. */
|
|
1064
|
-
data?: Record<string, any> | null;
|
|
1065
|
-
}
|
|
1066
|
-
export interface BulkActionMetadata {
|
|
1067
|
-
/** Number of events that were successfully processed. */
|
|
1068
|
-
totalSuccesses?: number;
|
|
1069
|
-
/** Number of events that couldn't be processed. */
|
|
1070
|
-
totalFailures?: number;
|
|
1071
|
-
}
|
|
1072
|
-
export interface UpdateEventRequest {
|
|
1073
|
-
/** Event to update. */
|
|
1074
|
-
event: Event;
|
|
1075
|
-
/**
|
|
1076
|
-
* Information about whether participants of the updated event are notified and
|
|
1077
|
-
* the message they receive.
|
|
1078
|
-
*/
|
|
1079
|
-
participantNotification?: ParticipantNotification;
|
|
1080
|
-
/**
|
|
1081
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1082
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1083
|
-
* `America/New_York` or `UTC`.
|
|
1084
|
-
*
|
|
1085
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1086
|
-
*/
|
|
1087
|
-
timeZone?: string | null;
|
|
1088
|
-
}
|
|
1089
|
-
export interface UpdateEventResponse {
|
|
1090
|
-
/** Updated event. */
|
|
1091
|
-
event?: Event;
|
|
1092
|
-
}
|
|
1093
|
-
export interface BulkUpdateEventRequest {
|
|
1094
|
-
/**
|
|
1095
|
-
* Events to update.
|
|
1096
|
-
*
|
|
1097
|
-
* Min: 1 event
|
|
1098
|
-
* Max: 50 events
|
|
1099
|
-
*/
|
|
1100
|
-
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1101
|
-
/**
|
|
1102
|
-
* Whether to return the updated events.
|
|
1103
|
-
*
|
|
1104
|
-
* Default: `false`
|
|
1105
|
-
*/
|
|
1106
|
-
returnEntity?: boolean | null;
|
|
1107
|
-
/**
|
|
1108
|
-
* Information about whether participants of the updated event are notified and
|
|
1109
|
-
* the message they receive.
|
|
1110
|
-
*/
|
|
1111
|
-
participantNotification?: ParticipantNotification;
|
|
1112
|
-
/**
|
|
1113
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1114
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1115
|
-
* `America/New_York` or `UTC`.
|
|
1116
|
-
*
|
|
1117
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1118
|
-
*/
|
|
1119
|
-
timeZone?: string | null;
|
|
1120
|
-
}
|
|
1121
|
-
export interface BulkUpdateEventRequestMaskedEvent {
|
|
1122
|
-
/** Event to update. */
|
|
1123
|
-
event?: Event;
|
|
1124
|
-
}
|
|
1125
|
-
export interface BulkUpdateEventResponse {
|
|
1126
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1127
|
-
results?: BulkEventResult[];
|
|
1128
|
-
/** Total successes and failures. */
|
|
1129
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1130
|
-
}
|
|
1131
|
-
export interface UpdateEventParticipantsRequest {
|
|
1132
|
-
/**
|
|
1133
|
-
* ID of the event to update.
|
|
1134
|
-
*
|
|
1135
|
-
* Min: 36 characters
|
|
1136
|
-
* Max: 250 characters
|
|
1137
|
-
*/
|
|
1138
|
-
eventId?: string | null;
|
|
1139
|
-
/** The participants to update. */
|
|
1140
|
-
participants?: Participants;
|
|
1141
|
-
}
|
|
1142
|
-
export interface UpdateEventParticipantsResponse {
|
|
1143
|
-
/** Updated event. */
|
|
1144
|
-
event?: Event;
|
|
1145
|
-
}
|
|
1146
|
-
export interface RestoreEventDefaultsRequest {
|
|
1147
|
-
/** ID of the event for which to restore default values. */
|
|
1148
|
-
eventId: string | null;
|
|
1149
|
-
/**
|
|
1150
|
-
* Fields for which to restore default values.
|
|
1151
|
-
*
|
|
1152
|
-
* `TIME` restores default values for `start` and `end`.
|
|
1153
|
-
*
|
|
1154
|
-
* Min: 1 field
|
|
1155
|
-
*/
|
|
1156
|
-
fields: Field[];
|
|
1157
|
-
/**
|
|
1158
|
-
* Information about whether participants of the updated event are notified and
|
|
1159
|
-
* the message they receive.
|
|
1160
|
-
*/
|
|
1161
|
-
participantNotification?: ParticipantNotification;
|
|
1162
|
-
/**
|
|
1163
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1164
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1165
|
-
* `America/New_York` or `UTC`.
|
|
1166
|
-
*
|
|
1167
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1168
|
-
*/
|
|
1169
|
-
timeZone?: string | null;
|
|
1170
|
-
}
|
|
1171
|
-
export interface RestoreEventDefaultsResponse {
|
|
1172
|
-
/** Updated event. */
|
|
1173
|
-
event?: Event;
|
|
1174
|
-
}
|
|
1175
|
-
export interface SplitRecurringEventRequest {
|
|
1176
|
-
/** ID of the `MASTER` event to split. */
|
|
1177
|
-
recurringEventId: string | null;
|
|
1178
|
-
/**
|
|
1179
|
-
* Local date and time at which the `MASTER` event is split in
|
|
1180
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1181
|
-
* `2025-03-11T09:00:00`.
|
|
1182
|
-
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1183
|
-
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1184
|
-
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1185
|
-
* wouldn't affect any event without a subsequent occurrence.
|
|
1186
|
-
*/
|
|
1187
|
-
splitLocalDate: string | null;
|
|
1188
|
-
/**
|
|
1189
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1190
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1191
|
-
* `America/New_York` or `UTC`.
|
|
1192
|
-
*
|
|
1193
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1194
|
-
*/
|
|
1195
|
-
timeZone?: string | null;
|
|
1196
|
-
}
|
|
1197
|
-
export interface SplitRecurringEventResponse {
|
|
1198
|
-
/** Original `MASTER` event that was shortened. */
|
|
1199
|
-
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1200
|
-
/** New `MASTER` event starting with the first event after the split date. */
|
|
1201
|
-
newRecurringEventStartingFromSplit?: Event;
|
|
1202
|
-
}
|
|
1203
|
-
export interface CancelEventRequest {
|
|
1204
|
-
/** ID of the event to cancel. */
|
|
1205
|
-
eventId: string | null;
|
|
1206
|
-
/**
|
|
1207
|
-
* Information about whether participants of the canceled event are notified and
|
|
1208
|
-
* the message they receive.
|
|
1209
|
-
*/
|
|
1210
|
-
participantNotification?: ParticipantNotification;
|
|
1211
|
-
/**
|
|
1212
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1213
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1214
|
-
* `America/New_York` or `UTC`.
|
|
1215
|
-
*
|
|
1216
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1217
|
-
*/
|
|
1218
|
-
timeZone?: string | null;
|
|
1219
|
-
}
|
|
1220
|
-
export interface CancelEventResponse {
|
|
1221
|
-
/** Canceled event. */
|
|
1222
|
-
event?: Event;
|
|
1223
|
-
}
|
|
1224
|
-
export interface BulkCancelEventRequest {
|
|
1225
|
-
/** IDs of the events to cancel. */
|
|
1226
|
-
eventIds: string[];
|
|
1227
|
-
/**
|
|
1228
|
-
* Whether to return the canceled events.
|
|
1229
|
-
*
|
|
1230
|
-
* Default: `false`
|
|
1231
|
-
*/
|
|
1232
|
-
returnEntity?: boolean | null;
|
|
1233
|
-
/**
|
|
1234
|
-
* Information about whether participants of the canceled events are notified and
|
|
1235
|
-
* the message they receive.
|
|
1236
|
-
*/
|
|
1237
|
-
participantNotification?: ParticipantNotification;
|
|
965
|
+
appId?: string | null;
|
|
966
|
+
/** Cursor to retrieve the next page of the results. */
|
|
967
|
+
cursorPaging?: CommonCursorPaging;
|
|
1238
968
|
/**
|
|
1239
|
-
*
|
|
1240
|
-
*
|
|
1241
|
-
* `America/New_York` or `UTC`.
|
|
969
|
+
* IDs of the events to retrieve.
|
|
970
|
+
* If you provide a list of IDs, all other filters are ignored.
|
|
1242
971
|
*
|
|
1243
|
-
*
|
|
972
|
+
* Max: 100 `eventId`s
|
|
973
|
+
* @maxSize 100
|
|
974
|
+
* @minLength 36
|
|
975
|
+
* @maxLength 250
|
|
1244
976
|
*/
|
|
1245
|
-
|
|
977
|
+
eventIds?: string[];
|
|
1246
978
|
}
|
|
1247
|
-
export interface
|
|
1248
|
-
/**
|
|
1249
|
-
|
|
1250
|
-
/**
|
|
1251
|
-
|
|
979
|
+
export interface ListEventsByMemberIdResponse {
|
|
980
|
+
/** Retrieved events. */
|
|
981
|
+
events?: Event[];
|
|
982
|
+
/** Paging metadata. */
|
|
983
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1252
984
|
}
|
|
1253
985
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1254
986
|
export interface SitePropertiesNotification {
|
|
@@ -1256,7 +988,10 @@ export interface SitePropertiesNotification {
|
|
|
1256
988
|
metasiteId?: string;
|
|
1257
989
|
/** The actual update event. */
|
|
1258
990
|
event?: SitePropertiesEvent;
|
|
1259
|
-
/**
|
|
991
|
+
/**
|
|
992
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
993
|
+
* @maxSize 500
|
|
994
|
+
*/
|
|
1260
995
|
translations?: Translation[];
|
|
1261
996
|
/** Context of the notification */
|
|
1262
997
|
changeContext?: ChangeContext;
|
|
@@ -1329,8 +1064,11 @@ export interface Properties {
|
|
|
1329
1064
|
export interface Categories {
|
|
1330
1065
|
/** Primary site category. */
|
|
1331
1066
|
primary?: string;
|
|
1332
|
-
/**
|
|
1333
|
-
|
|
1067
|
+
/**
|
|
1068
|
+
* Secondary site category.
|
|
1069
|
+
* @maxSize 50
|
|
1070
|
+
*/
|
|
1071
|
+
secondary?: string[];
|
|
1334
1072
|
/** Business Term Id */
|
|
1335
1073
|
businessTermId?: string | null;
|
|
1336
1074
|
}
|
|
@@ -1349,7 +1087,10 @@ export interface Address {
|
|
|
1349
1087
|
country?: string;
|
|
1350
1088
|
/** State. */
|
|
1351
1089
|
state?: string;
|
|
1352
|
-
/**
|
|
1090
|
+
/**
|
|
1091
|
+
* Zip or postal code.
|
|
1092
|
+
* @maxLength 20
|
|
1093
|
+
*/
|
|
1353
1094
|
zip?: string;
|
|
1354
1095
|
/** Extra information to be displayed in the address. */
|
|
1355
1096
|
hint?: AddressHint;
|
|
@@ -1390,9 +1131,15 @@ export interface GeoCoordinates {
|
|
|
1390
1131
|
}
|
|
1391
1132
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1392
1133
|
export interface BusinessSchedule {
|
|
1393
|
-
/**
|
|
1134
|
+
/**
|
|
1135
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1136
|
+
* @maxSize 100
|
|
1137
|
+
*/
|
|
1394
1138
|
periods?: TimePeriod[];
|
|
1395
|
-
/**
|
|
1139
|
+
/**
|
|
1140
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1141
|
+
* @maxSize 100
|
|
1142
|
+
*/
|
|
1396
1143
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1397
1144
|
}
|
|
1398
1145
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
@@ -1440,7 +1187,10 @@ export interface SpecialHourPeriod {
|
|
|
1440
1187
|
comment?: string;
|
|
1441
1188
|
}
|
|
1442
1189
|
export interface Multilingual {
|
|
1443
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* Supported languages list.
|
|
1192
|
+
* @maxSize 200
|
|
1193
|
+
*/
|
|
1444
1194
|
supportedLanguages?: SupportedLanguage[];
|
|
1445
1195
|
/** Whether to redirect to user language. */
|
|
1446
1196
|
autoRedirect?: boolean;
|
|
@@ -1502,153 +1252,563 @@ export interface ChangeContextPayloadOneOf {
|
|
|
1502
1252
|
}
|
|
1503
1253
|
export interface PropertiesChange {
|
|
1504
1254
|
}
|
|
1505
|
-
export interface SiteCreated {
|
|
1506
|
-
/** Origin template site id. */
|
|
1507
|
-
originTemplateId?: string | null;
|
|
1255
|
+
export interface SiteCreated {
|
|
1256
|
+
/** Origin template site id. */
|
|
1257
|
+
originTemplateId?: string | null;
|
|
1258
|
+
}
|
|
1259
|
+
export interface SiteCloned {
|
|
1260
|
+
/** Origin site id. */
|
|
1261
|
+
originMetaSiteId?: string;
|
|
1262
|
+
}
|
|
1263
|
+
export interface Empty {
|
|
1264
|
+
}
|
|
1265
|
+
export interface GetEventRequest {
|
|
1266
|
+
/**
|
|
1267
|
+
* ID of the event to retrieve.
|
|
1268
|
+
*
|
|
1269
|
+
* Min: 36 characters
|
|
1270
|
+
* Max: 250 characters
|
|
1271
|
+
* @minLength 36
|
|
1272
|
+
* @maxLength 250
|
|
1273
|
+
*/
|
|
1274
|
+
eventId: string | null;
|
|
1275
|
+
/**
|
|
1276
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1277
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1278
|
+
* `America/New_York` or `UTC`.
|
|
1279
|
+
*
|
|
1280
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1281
|
+
*/
|
|
1282
|
+
timeZone?: string | null;
|
|
1283
|
+
/**
|
|
1284
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
1285
|
+
* [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
|
|
1286
|
+
* for more information.
|
|
1287
|
+
*
|
|
1288
|
+
* Supported values:
|
|
1289
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1290
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1291
|
+
*
|
|
1292
|
+
* Max: 1 field
|
|
1293
|
+
* Default: No personal data is returned.
|
|
1294
|
+
* @maxSize 1
|
|
1295
|
+
*/
|
|
1296
|
+
fields?: RequestedFields[];
|
|
1297
|
+
}
|
|
1298
|
+
export declare enum RequestedFields {
|
|
1299
|
+
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1300
|
+
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1301
|
+
PI_FIELDS = "PI_FIELDS",
|
|
1302
|
+
/** Returns only fields containing your own personal data. */
|
|
1303
|
+
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1304
|
+
}
|
|
1305
|
+
export interface GetEventResponse {
|
|
1306
|
+
/** Retrieved event. */
|
|
1307
|
+
event?: Event;
|
|
1308
|
+
}
|
|
1309
|
+
export interface ListEventsRequest {
|
|
1310
|
+
/**
|
|
1311
|
+
* IDs of the events to retrieve.
|
|
1312
|
+
*
|
|
1313
|
+
* Min: 1 event ID
|
|
1314
|
+
* Min: 100 event IDs
|
|
1315
|
+
* @minSize 1
|
|
1316
|
+
* @maxSize 100
|
|
1317
|
+
* @minLength 36
|
|
1318
|
+
* @maxLength 250
|
|
1319
|
+
*/
|
|
1320
|
+
eventIds: string[];
|
|
1321
|
+
/**
|
|
1322
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1323
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1324
|
+
* `America/New_York` or `UTC`.
|
|
1325
|
+
*
|
|
1326
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1327
|
+
*/
|
|
1328
|
+
timeZone?: string | null;
|
|
1329
|
+
/**
|
|
1330
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
1331
|
+
* [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
|
|
1332
|
+
* for more information.
|
|
1333
|
+
*
|
|
1334
|
+
* Supported values:
|
|
1335
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1336
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1337
|
+
*
|
|
1338
|
+
* Max: 1 field
|
|
1339
|
+
* Default: No personal data is returned.
|
|
1340
|
+
* @maxSize 1
|
|
1341
|
+
*/
|
|
1342
|
+
fields?: RequestedFields[];
|
|
1343
|
+
}
|
|
1344
|
+
export interface ListEventsResponse {
|
|
1345
|
+
/** Retrieved events matching the provided IDs. */
|
|
1346
|
+
events?: Event[];
|
|
1347
|
+
}
|
|
1348
|
+
export interface QueryEventsRequest {
|
|
1349
|
+
/**
|
|
1350
|
+
* Local start date and time from which events are returned in
|
|
1351
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1352
|
+
* `2024-01-30T13:30:00`.
|
|
1353
|
+
*
|
|
1354
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
1355
|
+
* the results. Must be earlier than `toLocalDate` unless the sort order is
|
|
1356
|
+
* descending.
|
|
1357
|
+
* @format LOCAL_DATE_TIME
|
|
1358
|
+
*/
|
|
1359
|
+
fromLocalDate?: string | null;
|
|
1360
|
+
/**
|
|
1361
|
+
* Local end date and time up to which events are returned in
|
|
1362
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1363
|
+
* `2024-01-30T13:30:00`.
|
|
1364
|
+
*
|
|
1365
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
1366
|
+
* results. Must be later than `fromLocalDate` unless the sort order is
|
|
1367
|
+
* descending.
|
|
1368
|
+
* @format LOCAL_DATE_TIME
|
|
1369
|
+
*/
|
|
1370
|
+
toLocalDate?: string | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1373
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
1374
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
1375
|
+
*
|
|
1376
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1377
|
+
*/
|
|
1378
|
+
timeZone?: string | null;
|
|
1379
|
+
/** Query containing filters and paging. */
|
|
1380
|
+
query?: CursorQuery;
|
|
1381
|
+
/**
|
|
1382
|
+
* Filters events based on their `recurrenceType`.
|
|
1383
|
+
*
|
|
1384
|
+
* Max: 5 recurrence types can be specified.
|
|
1385
|
+
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
1386
|
+
* @maxSize 5
|
|
1387
|
+
*/
|
|
1388
|
+
recurrenceType?: RecurrenceType[];
|
|
1389
|
+
/**
|
|
1390
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
1391
|
+
* [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
|
|
1392
|
+
* for more information.
|
|
1393
|
+
*
|
|
1394
|
+
* Supported values:
|
|
1395
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1396
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1397
|
+
*
|
|
1398
|
+
* Max: 1 field
|
|
1399
|
+
* Default: No personal data is returned.
|
|
1400
|
+
* @maxSize 1
|
|
1401
|
+
*/
|
|
1402
|
+
fields?: RequestedFields[];
|
|
1403
|
+
}
|
|
1404
|
+
/** TODO Diverge */
|
|
1405
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1406
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1407
|
+
cursorPaging?: CursorPaging;
|
|
1408
|
+
/**
|
|
1409
|
+
* Filter object.
|
|
1410
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
1411
|
+
* for more information.
|
|
1412
|
+
*
|
|
1413
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
1414
|
+
*
|
|
1415
|
+
* For a detailed list of supported filters, see Supported Filters.
|
|
1416
|
+
*/
|
|
1417
|
+
filter?: Record<string, any> | null;
|
|
1418
|
+
/**
|
|
1419
|
+
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
1420
|
+
* Default is start ascending.
|
|
1421
|
+
* @maxSize 1
|
|
1422
|
+
*/
|
|
1423
|
+
sort?: Sorting[];
|
|
1424
|
+
}
|
|
1425
|
+
/** @oneof */
|
|
1426
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1427
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1428
|
+
cursorPaging?: CursorPaging;
|
|
1429
|
+
}
|
|
1430
|
+
/** TODO Diverge */
|
|
1431
|
+
export interface Sorting {
|
|
1432
|
+
/**
|
|
1433
|
+
* The field to sort by.
|
|
1434
|
+
* Either `start` or `end`.
|
|
1435
|
+
* Default is `start`.
|
|
1436
|
+
*/
|
|
1437
|
+
fieldName?: string;
|
|
1438
|
+
/** Sort order. */
|
|
1439
|
+
order?: SortOrder;
|
|
1440
|
+
}
|
|
1441
|
+
export declare enum SortOrder {
|
|
1442
|
+
ASC = "ASC",
|
|
1443
|
+
DESC = "DESC"
|
|
1444
|
+
}
|
|
1445
|
+
/** TODO Diverge */
|
|
1446
|
+
export interface CursorPaging {
|
|
1447
|
+
/**
|
|
1448
|
+
* Number of events to return.
|
|
1449
|
+
* Defaults to `50`. Maximum `1000`.
|
|
1450
|
+
* @min 1
|
|
1451
|
+
* @max 1000
|
|
1452
|
+
*/
|
|
1453
|
+
limit?: number | null;
|
|
1454
|
+
/**
|
|
1455
|
+
* Pointer to the next or previous page in the list of results.
|
|
1456
|
+
*
|
|
1457
|
+
* You can get the relevant cursor token
|
|
1458
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1459
|
+
* Not relevant for the first request.
|
|
1460
|
+
*/
|
|
1461
|
+
cursor?: string | null;
|
|
1462
|
+
}
|
|
1463
|
+
export interface QueryEventsResponse {
|
|
1464
|
+
/** Retrieved events matching the provided query. */
|
|
1465
|
+
events?: Event[];
|
|
1466
|
+
/** Paging metadata. */
|
|
1467
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1468
|
+
}
|
|
1469
|
+
/** TODO Diverge */
|
|
1470
|
+
export interface CursorPagingMetadata {
|
|
1471
|
+
/** Number of items returned in the response. */
|
|
1472
|
+
count?: number | null;
|
|
1473
|
+
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
1474
|
+
cursors?: Cursors;
|
|
1475
|
+
/**
|
|
1476
|
+
* Indicates if there are more results after the current page.
|
|
1477
|
+
* If `true`, another page of results can be retrieved.
|
|
1478
|
+
* If `false`, this is the last page.
|
|
1479
|
+
*/
|
|
1480
|
+
hasNext?: boolean | null;
|
|
1481
|
+
}
|
|
1482
|
+
export interface Cursors {
|
|
1483
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1484
|
+
next?: string | null;
|
|
1485
|
+
}
|
|
1486
|
+
export interface ListRecurringEventInstancesHistoryRequest {
|
|
1487
|
+
/**
|
|
1488
|
+
* The ID of the recurring event.
|
|
1489
|
+
* Required, unless `cursorPaging` is provided.
|
|
1490
|
+
* @minLength 64
|
|
1491
|
+
* @maxLength 64
|
|
1492
|
+
*/
|
|
1493
|
+
recurringEventId?: string | null;
|
|
1494
|
+
/**
|
|
1495
|
+
* The revision of the recurring event.
|
|
1496
|
+
* Required, unless `cursorPaging` is provided.
|
|
1497
|
+
*/
|
|
1498
|
+
revision?: string | null;
|
|
1499
|
+
/**
|
|
1500
|
+
* Inclusive start date for which events are returned, in ISO-8601 format.
|
|
1501
|
+
* Events that begin at or after the `fromDate` are included in the results.
|
|
1502
|
+
* Required, unless `cursorPaging` is provided.
|
|
1503
|
+
*/
|
|
1504
|
+
fromDate?: Date | null;
|
|
1505
|
+
/**
|
|
1506
|
+
* Exclusive end date for which events are returned, in ISO-8601 format.
|
|
1507
|
+
* Events that begin before the `toDate` are included in the results.
|
|
1508
|
+
* Required, unless `cursorPaging` is provided.
|
|
1509
|
+
*/
|
|
1510
|
+
toDate?: Date | null;
|
|
1511
|
+
/** Optional cursor pointing to the next page of events. */
|
|
1512
|
+
cursorPaging?: CursorPaging;
|
|
1513
|
+
}
|
|
1514
|
+
export interface ListRecurringEventInstancesHistoryResponse {
|
|
1515
|
+
/** The recurring event instances. */
|
|
1516
|
+
recurringEventInstances?: Event[];
|
|
1517
|
+
/** Paging metadata. */
|
|
1518
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1519
|
+
}
|
|
1520
|
+
export interface CreateEventRequest {
|
|
1521
|
+
/** Event to create. */
|
|
1522
|
+
event: Event;
|
|
1523
|
+
/**
|
|
1524
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1525
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1526
|
+
* `America/New_York` or `UTC`.
|
|
1527
|
+
*
|
|
1528
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1529
|
+
*/
|
|
1530
|
+
timeZone?: string | null;
|
|
1531
|
+
/**
|
|
1532
|
+
* Idempotency key guaranteeing that you don't create the same event more
|
|
1533
|
+
* than once.
|
|
1534
|
+
* @format GUID
|
|
1535
|
+
*/
|
|
1536
|
+
idempotencyKey?: string | null;
|
|
1537
|
+
}
|
|
1538
|
+
export interface CreateEventResponse {
|
|
1539
|
+
/** Created event. */
|
|
1540
|
+
event?: Event;
|
|
1541
|
+
}
|
|
1542
|
+
export interface BulkCreateEventRequest {
|
|
1543
|
+
/**
|
|
1544
|
+
* Events to create.
|
|
1545
|
+
* @minSize 1
|
|
1546
|
+
* @maxSize 50
|
|
1547
|
+
*/
|
|
1548
|
+
events: MaskedEvent[];
|
|
1549
|
+
/**
|
|
1550
|
+
* Whether to return created events.
|
|
1551
|
+
*
|
|
1552
|
+
* Default: `false`.
|
|
1553
|
+
*/
|
|
1554
|
+
returnEntity?: boolean | null;
|
|
1555
|
+
/**
|
|
1556
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1557
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1558
|
+
* `America/New_York` or `UTC`.
|
|
1559
|
+
*
|
|
1560
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1561
|
+
*/
|
|
1562
|
+
timeZone?: string | null;
|
|
1563
|
+
}
|
|
1564
|
+
export interface MaskedEvent {
|
|
1565
|
+
/** Event to create. */
|
|
1566
|
+
event?: Event;
|
|
1567
|
+
}
|
|
1568
|
+
export interface BulkCreateEventResponse {
|
|
1569
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1570
|
+
results?: BulkEventResult[];
|
|
1571
|
+
/** Total successes and failures. */
|
|
1572
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1573
|
+
}
|
|
1574
|
+
export interface BulkEventResult {
|
|
1575
|
+
/** Whether the requested action was successful. */
|
|
1576
|
+
itemMetadata?: ItemMetadata;
|
|
1577
|
+
/** The event. */
|
|
1578
|
+
item?: Event;
|
|
1579
|
+
}
|
|
1580
|
+
export interface ItemMetadata {
|
|
1581
|
+
/**
|
|
1582
|
+
* Event ID.
|
|
1583
|
+
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1584
|
+
*/
|
|
1585
|
+
id?: string | null;
|
|
1586
|
+
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1587
|
+
originalIndex?: number;
|
|
1588
|
+
/**
|
|
1589
|
+
* Whether the requested action was successful for this event.
|
|
1590
|
+
* When `false`, the `error` field is populated.
|
|
1591
|
+
*/
|
|
1592
|
+
success?: boolean;
|
|
1593
|
+
/** Details about the error in case of failure. */
|
|
1594
|
+
error?: ApplicationError;
|
|
1595
|
+
}
|
|
1596
|
+
export interface ApplicationError {
|
|
1597
|
+
/** Error code. */
|
|
1598
|
+
code?: string;
|
|
1599
|
+
/** Description of the error. */
|
|
1600
|
+
description?: string;
|
|
1601
|
+
/** Data related to the error. */
|
|
1602
|
+
data?: Record<string, any> | null;
|
|
1603
|
+
}
|
|
1604
|
+
export interface BulkActionMetadata {
|
|
1605
|
+
/** Number of events that were successfully processed. */
|
|
1606
|
+
totalSuccesses?: number;
|
|
1607
|
+
/** Number of events that couldn't be processed. */
|
|
1608
|
+
totalFailures?: number;
|
|
1508
1609
|
}
|
|
1509
|
-
export interface
|
|
1510
|
-
/**
|
|
1511
|
-
|
|
1610
|
+
export interface UpdateEventRequest {
|
|
1611
|
+
/** Event to update. */
|
|
1612
|
+
event: Event;
|
|
1613
|
+
/**
|
|
1614
|
+
* Information about whether participants of the updated event are notified and
|
|
1615
|
+
* the message they receive.
|
|
1616
|
+
*/
|
|
1617
|
+
participantNotification?: ParticipantNotification;
|
|
1618
|
+
/**
|
|
1619
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1620
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1621
|
+
* `America/New_York` or `UTC`.
|
|
1622
|
+
*
|
|
1623
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1624
|
+
*/
|
|
1625
|
+
timeZone?: string | null;
|
|
1512
1626
|
}
|
|
1513
|
-
export interface
|
|
1627
|
+
export interface UpdateEventResponse {
|
|
1628
|
+
/** Updated event. */
|
|
1629
|
+
event?: Event;
|
|
1514
1630
|
}
|
|
1515
|
-
export interface
|
|
1631
|
+
export interface BulkUpdateEventRequest {
|
|
1516
1632
|
/**
|
|
1517
|
-
*
|
|
1518
|
-
*
|
|
1633
|
+
* Events to update.
|
|
1634
|
+
*
|
|
1635
|
+
* Min: 1 event
|
|
1636
|
+
* Max: 50 events
|
|
1637
|
+
* @minSize 1
|
|
1638
|
+
* @maxSize 50
|
|
1519
1639
|
*/
|
|
1520
|
-
|
|
1640
|
+
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1521
1641
|
/**
|
|
1522
|
-
*
|
|
1523
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1524
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
1642
|
+
* Whether to return the updated events.
|
|
1525
1643
|
*
|
|
1526
|
-
*
|
|
1527
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
1644
|
+
* Default: `false`
|
|
1528
1645
|
*/
|
|
1529
|
-
|
|
1646
|
+
returnEntity?: boolean | null;
|
|
1530
1647
|
/**
|
|
1531
|
-
*
|
|
1532
|
-
*
|
|
1533
|
-
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
1534
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
1535
|
-
*
|
|
1536
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
1537
|
-
* results. Must be later than `fromLocalDate`.
|
|
1648
|
+
* Information about whether participants of the updated event are notified and
|
|
1649
|
+
* the message they receive.
|
|
1538
1650
|
*/
|
|
1539
|
-
|
|
1651
|
+
participantNotification?: ParticipantNotification;
|
|
1540
1652
|
/**
|
|
1541
1653
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1542
|
-
* for
|
|
1543
|
-
* `
|
|
1654
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1655
|
+
* `America/New_York` or `UTC`.
|
|
1544
1656
|
*
|
|
1545
1657
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1546
1658
|
*/
|
|
1547
1659
|
timeZone?: string | null;
|
|
1660
|
+
}
|
|
1661
|
+
export interface BulkUpdateEventRequestMaskedEvent {
|
|
1662
|
+
/** Event to update. */
|
|
1663
|
+
event?: Event;
|
|
1664
|
+
}
|
|
1665
|
+
export interface BulkUpdateEventResponse {
|
|
1666
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1667
|
+
results?: BulkEventResult[];
|
|
1668
|
+
/** Total successes and failures. */
|
|
1669
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1670
|
+
}
|
|
1671
|
+
export interface UpdateEventParticipantsRequest {
|
|
1548
1672
|
/**
|
|
1549
|
-
*
|
|
1550
|
-
*
|
|
1673
|
+
* ID of the event to update.
|
|
1674
|
+
*
|
|
1675
|
+
* Min: 36 characters
|
|
1676
|
+
* Max: 250 characters
|
|
1677
|
+
* @minLength 36
|
|
1678
|
+
* @maxLength 250
|
|
1551
1679
|
*/
|
|
1552
|
-
|
|
1553
|
-
/**
|
|
1554
|
-
|
|
1680
|
+
eventId?: string | null;
|
|
1681
|
+
/** The participants to update. */
|
|
1682
|
+
participants?: Participants;
|
|
1555
1683
|
}
|
|
1556
|
-
|
|
1557
|
-
|
|
1684
|
+
export interface UpdateEventParticipantsResponse {
|
|
1685
|
+
/** Updated event. */
|
|
1686
|
+
event?: Event;
|
|
1687
|
+
}
|
|
1688
|
+
export interface RestoreEventDefaultsRequest {
|
|
1558
1689
|
/**
|
|
1559
|
-
*
|
|
1560
|
-
*
|
|
1690
|
+
* ID of the event for which to restore default values.
|
|
1691
|
+
* @minLength 36
|
|
1692
|
+
* @maxLength 250
|
|
1561
1693
|
*/
|
|
1562
|
-
|
|
1694
|
+
eventId: string | null;
|
|
1563
1695
|
/**
|
|
1564
|
-
*
|
|
1696
|
+
* Fields for which to restore default values.
|
|
1565
1697
|
*
|
|
1566
|
-
*
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1698
|
+
* `TIME` restores default values for `start` and `end`.
|
|
1699
|
+
*
|
|
1700
|
+
* Min: 1 field
|
|
1701
|
+
* @minSize 1
|
|
1569
1702
|
*/
|
|
1570
|
-
|
|
1571
|
-
}
|
|
1572
|
-
export interface ListEventsByContactIdResponse {
|
|
1573
|
-
/** Retrieved events. */
|
|
1574
|
-
events?: Event[];
|
|
1575
|
-
/** Paging metadata. */
|
|
1576
|
-
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1577
|
-
}
|
|
1578
|
-
/** TODO Diverge */
|
|
1579
|
-
export interface CommonCursorPagingMetadata {
|
|
1580
|
-
/** Number of items returned in the response. */
|
|
1581
|
-
count?: number | null;
|
|
1582
|
-
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
1583
|
-
cursors?: CommonCursors;
|
|
1703
|
+
fields: Field[];
|
|
1584
1704
|
/**
|
|
1585
|
-
*
|
|
1586
|
-
*
|
|
1587
|
-
* If `false`, this is the last page.
|
|
1705
|
+
* Information about whether participants of the updated event are notified and
|
|
1706
|
+
* the message they receive.
|
|
1588
1707
|
*/
|
|
1589
|
-
|
|
1708
|
+
participantNotification?: ParticipantNotification;
|
|
1709
|
+
/**
|
|
1710
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1711
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1712
|
+
* `America/New_York` or `UTC`.
|
|
1713
|
+
*
|
|
1714
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1715
|
+
*/
|
|
1716
|
+
timeZone?: string | null;
|
|
1590
1717
|
}
|
|
1591
|
-
export interface
|
|
1592
|
-
/**
|
|
1593
|
-
|
|
1718
|
+
export interface RestoreEventDefaultsResponse {
|
|
1719
|
+
/** Updated event. */
|
|
1720
|
+
event?: Event;
|
|
1594
1721
|
}
|
|
1595
|
-
export interface
|
|
1722
|
+
export interface SplitRecurringEventRequest {
|
|
1596
1723
|
/**
|
|
1597
|
-
* ID of the
|
|
1598
|
-
*
|
|
1599
|
-
*
|
|
1600
|
-
* You must have the `Read Calendars - Including PI`
|
|
1601
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
1602
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
1724
|
+
* ID of the `MASTER` event to split.
|
|
1725
|
+
* @minLength 36
|
|
1726
|
+
* @maxLength 250
|
|
1603
1727
|
*/
|
|
1604
|
-
|
|
1728
|
+
recurringEventId: string | null;
|
|
1605
1729
|
/**
|
|
1606
|
-
* Local
|
|
1730
|
+
* Local date and time at which the `MASTER` event is split in
|
|
1607
1731
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1608
|
-
* `
|
|
1609
|
-
*
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1732
|
+
* `2025-03-11T09:00:00`.
|
|
1733
|
+
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1734
|
+
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1735
|
+
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1736
|
+
* wouldn't affect any event without a subsequent occurrence.
|
|
1737
|
+
* @format LOCAL_DATE_TIME
|
|
1612
1738
|
*/
|
|
1613
|
-
|
|
1739
|
+
splitLocalDate: string | null;
|
|
1614
1740
|
/**
|
|
1615
|
-
*
|
|
1616
|
-
*
|
|
1617
|
-
* `
|
|
1618
|
-
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
1741
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1742
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1743
|
+
* `America/New_York` or `UTC`.
|
|
1619
1744
|
*
|
|
1620
|
-
*
|
|
1621
|
-
* results. Must be later than `fromLocalDate`.
|
|
1745
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1622
1746
|
*/
|
|
1623
|
-
|
|
1747
|
+
timeZone?: string | null;
|
|
1748
|
+
}
|
|
1749
|
+
export interface SplitRecurringEventResponse {
|
|
1750
|
+
/** Original `MASTER` event that was shortened. */
|
|
1751
|
+
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1752
|
+
/** New `MASTER` event starting with the first event after the split date. */
|
|
1753
|
+
newRecurringEventStartingFromSplit?: Event;
|
|
1754
|
+
}
|
|
1755
|
+
export interface CancelEventRequest {
|
|
1756
|
+
/**
|
|
1757
|
+
* ID of the event to cancel.
|
|
1758
|
+
* @minLength 36
|
|
1759
|
+
* @maxLength 250
|
|
1760
|
+
*/
|
|
1761
|
+
eventId: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* Information about whether participants of the canceled event are notified and
|
|
1764
|
+
* the message they receive.
|
|
1765
|
+
*/
|
|
1766
|
+
participantNotification?: ParticipantNotification;
|
|
1624
1767
|
/**
|
|
1625
1768
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1626
|
-
* for
|
|
1627
|
-
* `
|
|
1769
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1770
|
+
* `America/New_York` or `UTC`.
|
|
1628
1771
|
*
|
|
1629
1772
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1630
1773
|
*/
|
|
1631
1774
|
timeZone?: string | null;
|
|
1775
|
+
}
|
|
1776
|
+
export interface CancelEventResponse {
|
|
1777
|
+
/** Canceled event. */
|
|
1778
|
+
event?: Event;
|
|
1779
|
+
}
|
|
1780
|
+
export interface BulkCancelEventRequest {
|
|
1632
1781
|
/**
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1782
|
+
* IDs of the events to cancel.
|
|
1783
|
+
* @minSize 1
|
|
1784
|
+
* @maxSize 50
|
|
1635
1785
|
*/
|
|
1636
|
-
|
|
1637
|
-
/** Cursor to retrieve the next page of the results. */
|
|
1638
|
-
cursorPaging?: CommonCursorPaging;
|
|
1786
|
+
eventIds: string[];
|
|
1639
1787
|
/**
|
|
1640
|
-
*
|
|
1641
|
-
* If you provide a list of IDs, all other filters are ignored.
|
|
1788
|
+
* Whether to return the canceled events.
|
|
1642
1789
|
*
|
|
1643
|
-
*
|
|
1790
|
+
* Default: `false`
|
|
1644
1791
|
*/
|
|
1645
|
-
|
|
1792
|
+
returnEntity?: boolean | null;
|
|
1793
|
+
/**
|
|
1794
|
+
* Information about whether participants of the canceled events are notified and
|
|
1795
|
+
* the message they receive.
|
|
1796
|
+
*/
|
|
1797
|
+
participantNotification?: ParticipantNotification;
|
|
1798
|
+
/**
|
|
1799
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1800
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1801
|
+
* `America/New_York` or `UTC`.
|
|
1802
|
+
*
|
|
1803
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1804
|
+
*/
|
|
1805
|
+
timeZone?: string | null;
|
|
1646
1806
|
}
|
|
1647
|
-
export interface
|
|
1648
|
-
/**
|
|
1649
|
-
|
|
1650
|
-
/**
|
|
1651
|
-
|
|
1807
|
+
export interface BulkCancelEventResponse {
|
|
1808
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1809
|
+
results?: BulkEventResult[];
|
|
1810
|
+
/** Total successes and failures. */
|
|
1811
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1652
1812
|
}
|
|
1653
1813
|
interface RecurrenceRuleNonNullableFields {
|
|
1654
1814
|
frequency: Frequency;
|
|
@@ -1687,6 +1847,12 @@ interface EventNonNullableFields {
|
|
|
1687
1847
|
inheritedFields: Field[];
|
|
1688
1848
|
permissions: PermissionNonNullableFields[];
|
|
1689
1849
|
}
|
|
1850
|
+
export interface ListEventsByContactIdResponseNonNullableFields {
|
|
1851
|
+
events: EventNonNullableFields[];
|
|
1852
|
+
}
|
|
1853
|
+
export interface ListEventsByMemberIdResponseNonNullableFields {
|
|
1854
|
+
events: EventNonNullableFields[];
|
|
1855
|
+
}
|
|
1690
1856
|
export interface GetEventResponseNonNullableFields {
|
|
1691
1857
|
event?: EventNonNullableFields;
|
|
1692
1858
|
}
|
|
@@ -1741,10 +1907,4 @@ export interface BulkCancelEventResponseNonNullableFields {
|
|
|
1741
1907
|
results: BulkEventResultNonNullableFields[];
|
|
1742
1908
|
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
1743
1909
|
}
|
|
1744
|
-
export interface ListEventsByContactIdResponseNonNullableFields {
|
|
1745
|
-
events: EventNonNullableFields[];
|
|
1746
|
-
}
|
|
1747
|
-
export interface ListEventsByMemberIdResponseNonNullableFields {
|
|
1748
|
-
events: EventNonNullableFields[];
|
|
1749
|
-
}
|
|
1750
1910
|
export {};
|