@wix/auto_sdk_calendar_events 1.0.3 → 1.0.5
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 +35 -35
- 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 +829 -661
- 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 +1123 -889
- 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 +35 -35
- 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 +829 -661
- 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 +1123 -889
- 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 +35 -35
- 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 +829 -661
- 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 +1123 -889
- 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 +35 -35
- 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 +829 -661
- 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 +1123 -889
- 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,12 +19,15 @@ export interface Event {
|
|
|
17
19
|
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
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
|
/**
|
|
23
27
|
* ID of the external schedule the event belongs to.
|
|
24
28
|
*
|
|
25
29
|
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
30
|
+
* @format GUID
|
|
26
31
|
* @readonly
|
|
27
32
|
*/
|
|
28
33
|
externalScheduleId?: string | null;
|
|
@@ -42,6 +47,7 @@ export interface Event {
|
|
|
42
47
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
43
48
|
* + `CLASS`: Bookings class event.
|
|
44
49
|
* + `COURSE`: Bookings course event.
|
|
50
|
+
* @immutable
|
|
45
51
|
*/
|
|
46
52
|
type?: string | null;
|
|
47
53
|
/**
|
|
@@ -60,6 +66,8 @@ export interface Event {
|
|
|
60
66
|
*
|
|
61
67
|
* Min: 1 character
|
|
62
68
|
* Max: 200 characters
|
|
69
|
+
* @minLength 1
|
|
70
|
+
* @maxLength 200
|
|
63
71
|
*/
|
|
64
72
|
title?: string | null;
|
|
65
73
|
/** Information about when the event starts. */
|
|
@@ -123,6 +131,8 @@ export interface Event {
|
|
|
123
131
|
/**
|
|
124
132
|
* ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
|
|
125
133
|
* and `EXCEPTION` events.
|
|
134
|
+
* @minLength 64
|
|
135
|
+
* @maxLength 64
|
|
126
136
|
* @readonly
|
|
127
137
|
*/
|
|
128
138
|
recurringEventId?: string | null;
|
|
@@ -149,6 +159,7 @@ export interface Event {
|
|
|
149
159
|
* providing the service or the room where the appointment takes place.
|
|
150
160
|
*
|
|
151
161
|
* Max: 100 resources
|
|
162
|
+
* @maxSize 100
|
|
152
163
|
*/
|
|
153
164
|
resources?: Resource[];
|
|
154
165
|
/**
|
|
@@ -181,6 +192,8 @@ export interface Event {
|
|
|
181
192
|
*
|
|
182
193
|
* Min: 1 character
|
|
183
194
|
* Max: 5000 characters
|
|
195
|
+
* @minLength 1
|
|
196
|
+
* @maxLength 5000
|
|
184
197
|
*/
|
|
185
198
|
notes?: string | null;
|
|
186
199
|
/**
|
|
@@ -194,6 +207,7 @@ export interface Event {
|
|
|
194
207
|
* ID of the app that owns the event. Identical to `appId` of the
|
|
195
208
|
* [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
196
209
|
* to which the event belongs.
|
|
210
|
+
* @format GUID
|
|
197
211
|
* @readonly
|
|
198
212
|
*/
|
|
199
213
|
appId?: string | null;
|
|
@@ -237,6 +251,7 @@ export interface ZonedDate {
|
|
|
237
251
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
238
252
|
* For example, `2024-01-30T13:30:00`.
|
|
239
253
|
* Wix Calendar APIs ignore seconds.
|
|
254
|
+
* @format LOCAL_DATE_TIME
|
|
240
255
|
*/
|
|
241
256
|
localDate?: string | null;
|
|
242
257
|
/**
|
|
@@ -281,6 +296,8 @@ export interface RecurrenceRule {
|
|
|
281
296
|
* Min: `1`
|
|
282
297
|
* Max: `4`
|
|
283
298
|
* Default: `1`
|
|
299
|
+
* @min 1
|
|
300
|
+
* @max 4
|
|
284
301
|
*/
|
|
285
302
|
interval?: number | null;
|
|
286
303
|
/**
|
|
@@ -289,6 +306,8 @@ export interface RecurrenceRule {
|
|
|
289
306
|
*
|
|
290
307
|
* Min: 1 day
|
|
291
308
|
* Max: 1 day
|
|
309
|
+
* @minSize 1
|
|
310
|
+
* @maxSize 1
|
|
292
311
|
*/
|
|
293
312
|
days?: Day[];
|
|
294
313
|
/**
|
|
@@ -337,6 +356,7 @@ export interface Location {
|
|
|
337
356
|
/**
|
|
338
357
|
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
339
358
|
* ID. Available only for `BUSINESS` locations.
|
|
359
|
+
* @format GUID
|
|
340
360
|
*/
|
|
341
361
|
_id?: string | null;
|
|
342
362
|
/**
|
|
@@ -355,12 +375,16 @@ export interface Location {
|
|
|
355
375
|
*
|
|
356
376
|
* Min: 1 character
|
|
357
377
|
* Max: 150 characters
|
|
378
|
+
* @minLength 1
|
|
379
|
+
* @maxLength 150
|
|
358
380
|
*/
|
|
359
381
|
name?: string | null;
|
|
360
382
|
/**
|
|
361
383
|
* Location address. For `BUSINESS` locations, it's identical to the
|
|
362
384
|
* [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
|
|
363
385
|
* `formattedAddress`.
|
|
386
|
+
* @minLength 1
|
|
387
|
+
* @maxLength 300
|
|
364
388
|
*/
|
|
365
389
|
address?: string | null;
|
|
366
390
|
}
|
|
@@ -374,7 +398,10 @@ export declare enum LocationType {
|
|
|
374
398
|
CUSTOM = "CUSTOM"
|
|
375
399
|
}
|
|
376
400
|
export interface Resource {
|
|
377
|
-
/**
|
|
401
|
+
/**
|
|
402
|
+
* Resource ID.
|
|
403
|
+
* @format GUID
|
|
404
|
+
*/
|
|
378
405
|
_id?: string | null;
|
|
379
406
|
/**
|
|
380
407
|
* Resource name.
|
|
@@ -421,6 +448,7 @@ export interface Participants {
|
|
|
421
448
|
* Full or partial list of the participants.
|
|
422
449
|
*
|
|
423
450
|
* Max: 50 participants
|
|
451
|
+
* @maxSize 50
|
|
424
452
|
*/
|
|
425
453
|
list?: Participant[];
|
|
426
454
|
/**
|
|
@@ -445,15 +473,24 @@ export interface Participant {
|
|
|
445
473
|
*
|
|
446
474
|
* Min: 1 character
|
|
447
475
|
* Max: 200 characters
|
|
476
|
+
* @minLength 1
|
|
477
|
+
* @maxLength 200
|
|
448
478
|
*/
|
|
449
479
|
name?: string | null;
|
|
450
|
-
/**
|
|
480
|
+
/**
|
|
481
|
+
* Participant's phone number.
|
|
482
|
+
* @format PHONE
|
|
483
|
+
*/
|
|
451
484
|
phone?: string | null;
|
|
452
|
-
/**
|
|
485
|
+
/**
|
|
486
|
+
* Participant's email address.
|
|
487
|
+
* @format EMAIL
|
|
488
|
+
*/
|
|
453
489
|
email?: string | null;
|
|
454
490
|
/**
|
|
455
491
|
* [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
456
492
|
* ID of the participant.
|
|
493
|
+
* @format GUID
|
|
457
494
|
*/
|
|
458
495
|
contactId?: string | null;
|
|
459
496
|
}
|
|
@@ -472,6 +509,8 @@ export interface ConferencingDetails {
|
|
|
472
509
|
*
|
|
473
510
|
* Min: 1 character
|
|
474
511
|
* Max: 2000 characters
|
|
512
|
+
* @minLength 1
|
|
513
|
+
* @maxLength 2000
|
|
475
514
|
*/
|
|
476
515
|
hostUrl?: string | null;
|
|
477
516
|
/**
|
|
@@ -479,6 +518,8 @@ export interface ConferencingDetails {
|
|
|
479
518
|
*
|
|
480
519
|
* Min: 1 character
|
|
481
520
|
* Max: 2000 characters
|
|
521
|
+
* @minLength 1
|
|
522
|
+
* @maxLength 2000
|
|
482
523
|
*/
|
|
483
524
|
guestUrl?: string | null;
|
|
484
525
|
/**
|
|
@@ -486,6 +527,8 @@ export interface ConferencingDetails {
|
|
|
486
527
|
*
|
|
487
528
|
* Min: 1 character
|
|
488
529
|
* Max: 100 characters
|
|
530
|
+
* @minLength 1
|
|
531
|
+
* @maxLength 100
|
|
489
532
|
*/
|
|
490
533
|
password?: string | null;
|
|
491
534
|
/**
|
|
@@ -493,6 +536,8 @@ export interface ConferencingDetails {
|
|
|
493
536
|
*
|
|
494
537
|
* Min: 1 character
|
|
495
538
|
* Max: 150 characters
|
|
539
|
+
* @minLength 1
|
|
540
|
+
* @maxLength 150
|
|
496
541
|
*/
|
|
497
542
|
externalId?: string | null;
|
|
498
543
|
}
|
|
@@ -539,6 +584,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
539
584
|
/**
|
|
540
585
|
* ID of a Wix user. For example, the site owner or a
|
|
541
586
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
587
|
+
* @format GUID
|
|
542
588
|
*/
|
|
543
589
|
wixUserId?: string;
|
|
544
590
|
}
|
|
@@ -547,6 +593,7 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
547
593
|
/**
|
|
548
594
|
* ID of a Wix user. For example, the site owner or a
|
|
549
595
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
596
|
+
* @format GUID
|
|
550
597
|
*/
|
|
551
598
|
wixUserId?: string;
|
|
552
599
|
}
|
|
@@ -587,6 +634,8 @@ export interface ParticipantNotification {
|
|
|
587
634
|
*
|
|
588
635
|
* Min: 1 character
|
|
589
636
|
* Max: 5000 characters
|
|
637
|
+
* @minLength 1
|
|
638
|
+
* @maxLength 5000
|
|
590
639
|
*/
|
|
591
640
|
message?: string | null;
|
|
592
641
|
}
|
|
@@ -601,6 +650,7 @@ export interface EventUpdatedWithMetadata {
|
|
|
601
650
|
participantNotification?: ParticipantNotification;
|
|
602
651
|
}
|
|
603
652
|
export interface MigrateSiteRequest {
|
|
653
|
+
/** @format GUID */
|
|
604
654
|
metaSiteId?: string;
|
|
605
655
|
/**
|
|
606
656
|
* Whether to run in safe, dry run mode, and only print logs without applying any changes.
|
|
@@ -618,19 +668,31 @@ export interface MigrateSiteResponse {
|
|
|
618
668
|
skipped?: boolean | null;
|
|
619
669
|
}
|
|
620
670
|
export interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
671
|
+
/** @format GUID */
|
|
621
672
|
metaSiteId?: string;
|
|
673
|
+
/** @format GUID */
|
|
622
674
|
currentBusinessResourceId?: string;
|
|
623
675
|
migrateBusinessConferenceId?: boolean;
|
|
624
676
|
}
|
|
625
677
|
export interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
626
678
|
}
|
|
627
679
|
export interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
680
|
+
/** @format GUID */
|
|
628
681
|
metaSiteId?: string;
|
|
682
|
+
/** @format GUID */
|
|
629
683
|
currentBusinessResourceId?: string;
|
|
630
684
|
migrateBusinessConferenceId?: boolean;
|
|
631
685
|
}
|
|
632
686
|
export interface UpdateEventsWithFixedBusinessResourceIdResponse {
|
|
633
687
|
}
|
|
688
|
+
export interface SetEventPermissionsRequest {
|
|
689
|
+
/** @maxLength 1000 */
|
|
690
|
+
eventId?: string;
|
|
691
|
+
/** @format GUID */
|
|
692
|
+
msid?: string;
|
|
693
|
+
}
|
|
694
|
+
export interface SetEventPermissionsResponse {
|
|
695
|
+
}
|
|
634
696
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
635
697
|
createdEvent?: EntityCreatedEvent;
|
|
636
698
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -702,9 +764,15 @@ export interface ActionEvent {
|
|
|
702
764
|
body?: string;
|
|
703
765
|
}
|
|
704
766
|
export interface MessageEnvelope {
|
|
705
|
-
/**
|
|
767
|
+
/**
|
|
768
|
+
* App instance ID.
|
|
769
|
+
* @format GUID
|
|
770
|
+
*/
|
|
706
771
|
instanceId?: string | null;
|
|
707
|
-
/**
|
|
772
|
+
/**
|
|
773
|
+
* Event type.
|
|
774
|
+
* @maxLength 150
|
|
775
|
+
*/
|
|
708
776
|
eventType?: string;
|
|
709
777
|
/** The identification type and identity data. */
|
|
710
778
|
identity?: IdentificationData;
|
|
@@ -712,26 +780,50 @@ export interface MessageEnvelope {
|
|
|
712
780
|
data?: string;
|
|
713
781
|
}
|
|
714
782
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
715
|
-
/**
|
|
783
|
+
/**
|
|
784
|
+
* ID of a site visitor that has not logged in to the site.
|
|
785
|
+
* @format GUID
|
|
786
|
+
*/
|
|
716
787
|
anonymousVisitorId?: string;
|
|
717
|
-
/**
|
|
788
|
+
/**
|
|
789
|
+
* ID of a site visitor that has logged in to the site.
|
|
790
|
+
* @format GUID
|
|
791
|
+
*/
|
|
718
792
|
memberId?: string;
|
|
719
|
-
/**
|
|
793
|
+
/**
|
|
794
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
795
|
+
* @format GUID
|
|
796
|
+
*/
|
|
720
797
|
wixUserId?: string;
|
|
721
|
-
/**
|
|
798
|
+
/**
|
|
799
|
+
* ID of an app.
|
|
800
|
+
* @format GUID
|
|
801
|
+
*/
|
|
722
802
|
appId?: string;
|
|
723
803
|
/** @readonly */
|
|
724
804
|
identityType?: WebhookIdentityType;
|
|
725
805
|
}
|
|
726
806
|
/** @oneof */
|
|
727
807
|
export interface IdentificationDataIdOneOf {
|
|
728
|
-
/**
|
|
808
|
+
/**
|
|
809
|
+
* ID of a site visitor that has not logged in to the site.
|
|
810
|
+
* @format GUID
|
|
811
|
+
*/
|
|
729
812
|
anonymousVisitorId?: string;
|
|
730
|
-
/**
|
|
813
|
+
/**
|
|
814
|
+
* ID of a site visitor that has logged in to the site.
|
|
815
|
+
* @format GUID
|
|
816
|
+
*/
|
|
731
817
|
memberId?: string;
|
|
732
|
-
/**
|
|
818
|
+
/**
|
|
819
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
820
|
+
* @format GUID
|
|
821
|
+
*/
|
|
733
822
|
wixUserId?: string;
|
|
734
|
-
/**
|
|
823
|
+
/**
|
|
824
|
+
* ID of an app.
|
|
825
|
+
* @format GUID
|
|
826
|
+
*/
|
|
735
827
|
appId?: string;
|
|
736
828
|
}
|
|
737
829
|
export declare enum WebhookIdentityType {
|
|
@@ -741,100 +833,32 @@ export declare enum WebhookIdentityType {
|
|
|
741
833
|
WIX_USER = "WIX_USER",
|
|
742
834
|
APP = "APP"
|
|
743
835
|
}
|
|
744
|
-
export interface
|
|
745
|
-
/**
|
|
746
|
-
* ID of the event to retrieve.
|
|
747
|
-
*
|
|
748
|
-
* Min: 36 characters
|
|
749
|
-
* Max: 250 characters
|
|
750
|
-
*/
|
|
751
|
-
eventId: string | null;
|
|
752
|
-
/**
|
|
753
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
754
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
755
|
-
* `America/New_York` or `UTC`.
|
|
756
|
-
*
|
|
757
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
758
|
-
*/
|
|
759
|
-
timeZone?: string | null;
|
|
760
|
-
/**
|
|
761
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
762
|
-
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
763
|
-
* for more information.
|
|
764
|
-
*
|
|
765
|
-
* Supported values:
|
|
766
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
767
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
768
|
-
*
|
|
769
|
-
* Max: 1 field
|
|
770
|
-
* Default: No personal data is returned.
|
|
771
|
-
*/
|
|
772
|
-
fields?: RequestedFields[];
|
|
773
|
-
}
|
|
774
|
-
export declare enum RequestedFields {
|
|
775
|
-
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
776
|
-
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
777
|
-
PI_FIELDS = "PI_FIELDS",
|
|
778
|
-
/** Returns only fields containing your own personal data. */
|
|
779
|
-
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
780
|
-
}
|
|
781
|
-
export interface GetEventResponse {
|
|
782
|
-
/** Retrieved event. */
|
|
783
|
-
event?: Event;
|
|
784
|
-
}
|
|
785
|
-
export interface ListEventsRequest {
|
|
786
|
-
/**
|
|
787
|
-
* IDs of the events to retrieve.
|
|
788
|
-
*
|
|
789
|
-
* Min: 1 event ID
|
|
790
|
-
* Min: 100 event IDs
|
|
791
|
-
*/
|
|
792
|
-
eventIds: string[];
|
|
793
|
-
/**
|
|
794
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
795
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
796
|
-
* `America/New_York` or `UTC`.
|
|
797
|
-
*
|
|
798
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
799
|
-
*/
|
|
800
|
-
timeZone?: string | null;
|
|
836
|
+
export interface ListEventsByContactIdRequest {
|
|
801
837
|
/**
|
|
802
|
-
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
*
|
|
806
|
-
* Supported values:
|
|
807
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
808
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
809
|
-
*
|
|
810
|
-
* Max: 1 field
|
|
811
|
-
* Default: No personal data is returned.
|
|
838
|
+
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
839
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
840
|
+
* @format GUID
|
|
812
841
|
*/
|
|
813
|
-
|
|
814
|
-
}
|
|
815
|
-
export interface ListEventsResponse {
|
|
816
|
-
/** Retrieved events matching the provided IDs. */
|
|
817
|
-
events?: Event[];
|
|
818
|
-
}
|
|
819
|
-
export interface QueryEventsRequest {
|
|
842
|
+
contactId: string | null;
|
|
820
843
|
/**
|
|
821
844
|
* Local start date and time from which events are returned in
|
|
822
845
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
823
|
-
* `2024-01-30T13:30:00`.
|
|
846
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
824
847
|
*
|
|
825
848
|
* Events that start before the `fromLocalDate` but end after it are included in
|
|
826
|
-
* the results. Must be earlier than `toLocalDate
|
|
827
|
-
*
|
|
849
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
850
|
+
* @format LOCAL_DATE_TIME
|
|
828
851
|
*/
|
|
829
852
|
fromLocalDate?: string | null;
|
|
830
853
|
/**
|
|
831
854
|
* Local end date and time up to which events are returned in
|
|
832
855
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
833
|
-
* `2024-01-30T13:30:00`.
|
|
856
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
857
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
834
858
|
*
|
|
835
859
|
* Events that start before `toLocalDate` but end after it are included in the
|
|
836
|
-
* results. Must be later than `fromLocalDate
|
|
837
|
-
*
|
|
860
|
+
* results. Must be later than `fromLocalDate`.
|
|
861
|
+
* @format LOCAL_DATE_TIME
|
|
838
862
|
*/
|
|
839
863
|
toLocalDate?: string | null;
|
|
840
864
|
/**
|
|
@@ -845,74 +869,22 @@ export interface QueryEventsRequest {
|
|
|
845
869
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
846
870
|
*/
|
|
847
871
|
timeZone?: string | null;
|
|
848
|
-
/** Query containing filters and paging. */
|
|
849
|
-
query?: CursorQuery;
|
|
850
|
-
/**
|
|
851
|
-
* Filters events based on their `recurrenceType`.
|
|
852
|
-
*
|
|
853
|
-
* Max: 5 recurrence types can be specified.
|
|
854
|
-
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
855
|
-
*/
|
|
856
|
-
recurrenceType?: RecurrenceType[];
|
|
857
|
-
/**
|
|
858
|
-
* Information about which fields containing personal data to return. Refer to the
|
|
859
|
-
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
860
|
-
* for more information.
|
|
861
|
-
*
|
|
862
|
-
* Supported values:
|
|
863
|
-
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
864
|
-
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
865
|
-
*
|
|
866
|
-
* Max: 1 field
|
|
867
|
-
* Default: No personal data is returned.
|
|
868
|
-
*/
|
|
869
|
-
fields?: RequestedFields[];
|
|
870
|
-
}
|
|
871
|
-
/** TODO Diverge */
|
|
872
|
-
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
873
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
874
|
-
cursorPaging?: CursorPaging;
|
|
875
|
-
/**
|
|
876
|
-
* Filter object.
|
|
877
|
-
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
878
|
-
* for more information.
|
|
879
|
-
*
|
|
880
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
881
|
-
*
|
|
882
|
-
* For a detailed list of supported filters, see Supported Filters.
|
|
883
|
-
*/
|
|
884
|
-
filter?: Record<string, any> | null;
|
|
885
|
-
/**
|
|
886
|
-
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
887
|
-
* Default is start ascending.
|
|
888
|
-
*/
|
|
889
|
-
sort?: Sorting[];
|
|
890
|
-
}
|
|
891
|
-
/** @oneof */
|
|
892
|
-
export interface CursorQueryPagingMethodOneOf {
|
|
893
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
894
|
-
cursorPaging?: CursorPaging;
|
|
895
|
-
}
|
|
896
|
-
/** TODO Diverge */
|
|
897
|
-
export interface Sorting {
|
|
898
872
|
/**
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
*
|
|
873
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
874
|
+
* to filter events by.
|
|
875
|
+
* @format GUID
|
|
902
876
|
*/
|
|
903
|
-
|
|
904
|
-
/**
|
|
905
|
-
|
|
906
|
-
}
|
|
907
|
-
export declare enum SortOrder {
|
|
908
|
-
ASC = "ASC",
|
|
909
|
-
DESC = "DESC"
|
|
877
|
+
appId?: string | null;
|
|
878
|
+
/** Cursor to retrieve the next page of the results. */
|
|
879
|
+
cursorPaging?: CommonCursorPaging;
|
|
910
880
|
}
|
|
911
881
|
/** TODO Diverge */
|
|
912
|
-
export interface
|
|
882
|
+
export interface CommonCursorPaging {
|
|
913
883
|
/**
|
|
914
884
|
* Number of events to return.
|
|
915
|
-
* Defaults to `50`. Maximum `
|
|
885
|
+
* Defaults to `50`. Maximum `100`.
|
|
886
|
+
* @min 1
|
|
887
|
+
* @max 100
|
|
916
888
|
*/
|
|
917
889
|
limit?: number | null;
|
|
918
890
|
/**
|
|
@@ -924,18 +896,18 @@ export interface CursorPaging {
|
|
|
924
896
|
*/
|
|
925
897
|
cursor?: string | null;
|
|
926
898
|
}
|
|
927
|
-
export interface
|
|
928
|
-
/** Retrieved events
|
|
899
|
+
export interface ListEventsByContactIdResponse {
|
|
900
|
+
/** Retrieved events. */
|
|
929
901
|
events?: Event[];
|
|
930
902
|
/** Paging metadata. */
|
|
931
|
-
pagingMetadata?:
|
|
903
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
932
904
|
}
|
|
933
905
|
/** TODO Diverge */
|
|
934
|
-
export interface
|
|
906
|
+
export interface CommonCursorPagingMetadata {
|
|
935
907
|
/** Number of items returned in the response. */
|
|
936
908
|
count?: number | null;
|
|
937
909
|
/** 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). */
|
|
938
|
-
cursors?:
|
|
910
|
+
cursors?: CommonCursors;
|
|
939
911
|
/**
|
|
940
912
|
* Indicates if there are more results after the current page.
|
|
941
913
|
* If `true`, another page of results can be retrieved.
|
|
@@ -943,266 +915,366 @@ export interface CursorPagingMetadata {
|
|
|
943
915
|
*/
|
|
944
916
|
hasNext?: boolean | null;
|
|
945
917
|
}
|
|
946
|
-
export interface
|
|
918
|
+
export interface CommonCursors {
|
|
947
919
|
/** Cursor pointing to next page in the list of results. */
|
|
948
920
|
next?: string | null;
|
|
949
921
|
}
|
|
950
|
-
export interface
|
|
951
|
-
/**
|
|
952
|
-
* The ID of the recurring event.
|
|
953
|
-
* Required, unless `cursorPaging` is provided.
|
|
954
|
-
*/
|
|
955
|
-
recurringEventId?: string | null;
|
|
922
|
+
export interface ListEventsByMemberIdRequest {
|
|
956
923
|
/**
|
|
957
|
-
*
|
|
958
|
-
* Required, unless `cursorPaging
|
|
924
|
+
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
925
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
926
|
+
* Provide `me` to retrieve events for the currently logged-in member.
|
|
927
|
+
* You must have the `Read Calendars - Including PI`
|
|
928
|
+
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
929
|
+
* to retrieve events for members who aren't the currently logged in member.
|
|
930
|
+
* @minLength 2
|
|
931
|
+
* @maxLength 36
|
|
959
932
|
*/
|
|
960
|
-
|
|
933
|
+
memberId: string | null;
|
|
961
934
|
/**
|
|
962
|
-
*
|
|
963
|
-
*
|
|
964
|
-
* Required
|
|
935
|
+
* Local start date and time from which events are returned in
|
|
936
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
937
|
+
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
938
|
+
*
|
|
939
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
940
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
941
|
+
* @format LOCAL_DATE_TIME
|
|
965
942
|
*/
|
|
966
|
-
|
|
943
|
+
fromLocalDate?: string | null;
|
|
967
944
|
/**
|
|
968
|
-
*
|
|
969
|
-
*
|
|
970
|
-
*
|
|
945
|
+
* Local end date and time up to which events are returned in
|
|
946
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
947
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
948
|
+
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
949
|
+
*
|
|
950
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
951
|
+
* results. Must be later than `fromLocalDate`.
|
|
952
|
+
* @format LOCAL_DATE_TIME
|
|
971
953
|
*/
|
|
972
|
-
|
|
973
|
-
/** Optional cursor pointing to the next page of events. */
|
|
974
|
-
cursorPaging?: CursorPaging;
|
|
975
|
-
}
|
|
976
|
-
export interface ListRecurringEventInstancesHistoryResponse {
|
|
977
|
-
/** The recurring event instances. */
|
|
978
|
-
recurringEventInstances?: Event[];
|
|
979
|
-
/** Paging metadata. */
|
|
980
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
981
|
-
}
|
|
982
|
-
export interface CreateEventRequest {
|
|
983
|
-
/** Event to create. */
|
|
984
|
-
event: Event;
|
|
954
|
+
toLocalDate?: string | null;
|
|
985
955
|
/**
|
|
986
956
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
987
|
-
* for calculating `adjustedStart` and
|
|
988
|
-
* `America/New_York` or `UTC`.
|
|
957
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
958
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
989
959
|
*
|
|
990
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
960
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
991
961
|
*/
|
|
992
962
|
timeZone?: string | null;
|
|
993
963
|
/**
|
|
994
|
-
*
|
|
995
|
-
*
|
|
996
|
-
|
|
997
|
-
idempotencyKey?: string | null;
|
|
998
|
-
}
|
|
999
|
-
export interface CreateEventResponse {
|
|
1000
|
-
/** Created event. */
|
|
1001
|
-
event?: Event;
|
|
1002
|
-
}
|
|
1003
|
-
export interface BulkCreateEventRequest {
|
|
1004
|
-
/** Events to create. */
|
|
1005
|
-
events: MaskedEvent[];
|
|
1006
|
-
/**
|
|
1007
|
-
* Whether to return created events.
|
|
1008
|
-
*
|
|
1009
|
-
* Default: `false`.
|
|
964
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
965
|
+
* to filter events by.
|
|
966
|
+
* @format GUID
|
|
1010
967
|
*/
|
|
1011
|
-
|
|
968
|
+
appId?: string | null;
|
|
969
|
+
/** Cursor to retrieve the next page of the results. */
|
|
970
|
+
cursorPaging?: CommonCursorPaging;
|
|
1012
971
|
/**
|
|
1013
|
-
*
|
|
1014
|
-
*
|
|
1015
|
-
* `America/New_York` or `UTC`.
|
|
972
|
+
* IDs of the events to retrieve.
|
|
973
|
+
* If you provide a list of IDs, all other filters are ignored.
|
|
1016
974
|
*
|
|
1017
|
-
*
|
|
975
|
+
* Max: 100 `eventId`s
|
|
976
|
+
* @maxSize 100
|
|
977
|
+
* @minLength 36
|
|
978
|
+
* @maxLength 250
|
|
1018
979
|
*/
|
|
1019
|
-
|
|
1020
|
-
}
|
|
1021
|
-
export interface MaskedEvent {
|
|
1022
|
-
/** Event to create. */
|
|
1023
|
-
event?: Event;
|
|
1024
|
-
}
|
|
1025
|
-
export interface BulkCreateEventResponse {
|
|
1026
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1027
|
-
results?: BulkEventResult[];
|
|
1028
|
-
/** Total successes and failures. */
|
|
1029
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
980
|
+
eventIds?: string[];
|
|
1030
981
|
}
|
|
1031
|
-
export interface
|
|
1032
|
-
/**
|
|
1033
|
-
|
|
1034
|
-
/**
|
|
1035
|
-
|
|
982
|
+
export interface ListEventsByMemberIdResponse {
|
|
983
|
+
/** Retrieved events. */
|
|
984
|
+
events?: Event[];
|
|
985
|
+
/** Paging metadata. */
|
|
986
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1036
987
|
}
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1044
|
-
originalIndex?: number;
|
|
988
|
+
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
989
|
+
export interface SitePropertiesNotification {
|
|
990
|
+
/** The site ID for which this update notification applies. */
|
|
991
|
+
metasiteId?: string;
|
|
992
|
+
/** The actual update event. */
|
|
993
|
+
event?: SitePropertiesEvent;
|
|
1045
994
|
/**
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
995
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
996
|
+
* @maxSize 500
|
|
1048
997
|
*/
|
|
1049
|
-
|
|
1050
|
-
/**
|
|
1051
|
-
|
|
1052
|
-
}
|
|
1053
|
-
export interface ApplicationError {
|
|
1054
|
-
/** Error code. */
|
|
1055
|
-
code?: string;
|
|
1056
|
-
/** Description of the error. */
|
|
1057
|
-
description?: string;
|
|
1058
|
-
/** Data related to the error. */
|
|
1059
|
-
data?: Record<string, any> | null;
|
|
998
|
+
translations?: Translation[];
|
|
999
|
+
/** Context of the notification */
|
|
1000
|
+
changeContext?: ChangeContext;
|
|
1060
1001
|
}
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1002
|
+
/** The actual update event for a particular notification. */
|
|
1003
|
+
export interface SitePropertiesEvent {
|
|
1004
|
+
/** Version of the site's properties represented by this update. */
|
|
1005
|
+
version?: number;
|
|
1006
|
+
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1007
|
+
fields?: string[];
|
|
1008
|
+
/** Updated properties. */
|
|
1009
|
+
properties?: Properties;
|
|
1066
1010
|
}
|
|
1067
|
-
export interface
|
|
1068
|
-
/**
|
|
1069
|
-
|
|
1011
|
+
export interface Properties {
|
|
1012
|
+
/** Site categories. */
|
|
1013
|
+
categories?: Categories;
|
|
1014
|
+
/** Site locale. */
|
|
1015
|
+
locale?: Locale;
|
|
1070
1016
|
/**
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1017
|
+
* Site language.
|
|
1018
|
+
*
|
|
1019
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1073
1020
|
*/
|
|
1074
|
-
|
|
1021
|
+
language?: string | null;
|
|
1075
1022
|
/**
|
|
1076
|
-
*
|
|
1077
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1078
|
-
* `America/New_York` or `UTC`.
|
|
1023
|
+
* Site currency format used to bill customers.
|
|
1079
1024
|
*
|
|
1080
|
-
*
|
|
1025
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1081
1026
|
*/
|
|
1027
|
+
paymentCurrency?: string | null;
|
|
1028
|
+
/** Timezone in `America/New_York` format. */
|
|
1082
1029
|
timeZone?: string | null;
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
/**
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1030
|
+
/** Email address. */
|
|
1031
|
+
email?: string | null;
|
|
1032
|
+
/** Phone number. */
|
|
1033
|
+
phone?: string | null;
|
|
1034
|
+
/** Fax number. */
|
|
1035
|
+
fax?: string | null;
|
|
1036
|
+
/** Address. */
|
|
1037
|
+
address?: Address;
|
|
1038
|
+
/** Site display name. */
|
|
1039
|
+
siteDisplayName?: string | null;
|
|
1040
|
+
/** Business name. */
|
|
1041
|
+
businessName?: string | null;
|
|
1042
|
+
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1043
|
+
logo?: string | null;
|
|
1044
|
+
/** Site description. */
|
|
1045
|
+
description?: string | null;
|
|
1089
1046
|
/**
|
|
1090
|
-
*
|
|
1047
|
+
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1091
1048
|
*
|
|
1092
|
-
*
|
|
1093
|
-
* Max: 50 events
|
|
1049
|
+
* __Note:__ Not supported by Wix Bookings.
|
|
1094
1050
|
*/
|
|
1095
|
-
|
|
1051
|
+
businessSchedule?: BusinessSchedule;
|
|
1052
|
+
/** Supported languages of a site and the primary language. */
|
|
1053
|
+
multilingual?: Multilingual;
|
|
1054
|
+
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1055
|
+
consentPolicy?: ConsentPolicy;
|
|
1096
1056
|
/**
|
|
1097
|
-
*
|
|
1057
|
+
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1098
1058
|
*
|
|
1099
|
-
*
|
|
1100
|
-
*/
|
|
1101
|
-
returnEntity?: boolean | null;
|
|
1102
|
-
/**
|
|
1103
|
-
* Information about whether participants of the updated event are notified and
|
|
1104
|
-
* the message they receive.
|
|
1059
|
+
* Site business type.
|
|
1105
1060
|
*/
|
|
1106
|
-
|
|
1061
|
+
businessConfig?: string | null;
|
|
1062
|
+
/** External site URL that uses Wix as its headless business solution. */
|
|
1063
|
+
externalSiteUrl?: string | null;
|
|
1064
|
+
/** Track clicks analytics. */
|
|
1065
|
+
trackClicksAnalytics?: boolean;
|
|
1066
|
+
}
|
|
1067
|
+
export interface Categories {
|
|
1068
|
+
/** Primary site category. */
|
|
1069
|
+
primary?: string;
|
|
1107
1070
|
/**
|
|
1108
|
-
*
|
|
1109
|
-
*
|
|
1110
|
-
* `America/New_York` or `UTC`.
|
|
1111
|
-
*
|
|
1112
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1071
|
+
* Secondary site category.
|
|
1072
|
+
* @maxSize 50
|
|
1113
1073
|
*/
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
/** Event to update. */
|
|
1118
|
-
event?: Event;
|
|
1074
|
+
secondary?: string[];
|
|
1075
|
+
/** Business Term Id */
|
|
1076
|
+
businessTermId?: string | null;
|
|
1119
1077
|
}
|
|
1120
|
-
export interface
|
|
1121
|
-
/**
|
|
1122
|
-
|
|
1123
|
-
/**
|
|
1124
|
-
|
|
1078
|
+
export interface Locale {
|
|
1079
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1080
|
+
languageCode?: string;
|
|
1081
|
+
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1082
|
+
country?: string;
|
|
1125
1083
|
}
|
|
1126
|
-
export interface
|
|
1084
|
+
export interface Address {
|
|
1085
|
+
/** Street name. */
|
|
1086
|
+
street?: string;
|
|
1087
|
+
/** City name. */
|
|
1088
|
+
city?: string;
|
|
1089
|
+
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1090
|
+
country?: string;
|
|
1091
|
+
/** State. */
|
|
1092
|
+
state?: string;
|
|
1127
1093
|
/**
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1130
|
-
* Min: 36 characters
|
|
1131
|
-
* Max: 250 characters
|
|
1094
|
+
* Zip or postal code.
|
|
1095
|
+
* @maxLength 20
|
|
1132
1096
|
*/
|
|
1133
|
-
|
|
1134
|
-
/**
|
|
1135
|
-
|
|
1097
|
+
zip?: string;
|
|
1098
|
+
/** Extra information to be displayed in the address. */
|
|
1099
|
+
hint?: AddressHint;
|
|
1100
|
+
/** Whether this address represents a physical location. */
|
|
1101
|
+
isPhysical?: boolean;
|
|
1102
|
+
/** Google-formatted version of this address. */
|
|
1103
|
+
googleFormattedAddress?: string;
|
|
1104
|
+
/** Street number. */
|
|
1105
|
+
streetNumber?: string;
|
|
1106
|
+
/** Apartment number. */
|
|
1107
|
+
apartmentNumber?: string;
|
|
1108
|
+
/** Geographic coordinates of location. */
|
|
1109
|
+
coordinates?: GeoCoordinates;
|
|
1136
1110
|
}
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1111
|
+
/**
|
|
1112
|
+
* Extra information on displayed addresses.
|
|
1113
|
+
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1114
|
+
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1115
|
+
*/
|
|
1116
|
+
export interface AddressHint {
|
|
1117
|
+
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1118
|
+
text?: string;
|
|
1119
|
+
/** Where the extra text should be displayed. */
|
|
1120
|
+
placement?: PlacementType;
|
|
1140
1121
|
}
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1122
|
+
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1123
|
+
export declare enum PlacementType {
|
|
1124
|
+
BEFORE = "BEFORE",
|
|
1125
|
+
AFTER = "AFTER",
|
|
1126
|
+
REPLACE = "REPLACE"
|
|
1127
|
+
}
|
|
1128
|
+
/** Geocoordinates for a particular address. */
|
|
1129
|
+
export interface GeoCoordinates {
|
|
1130
|
+
/** Latitude of the location. Must be between -90 and 90. */
|
|
1131
|
+
latitude?: number;
|
|
1132
|
+
/** Longitude of the location. Must be between -180 and 180. */
|
|
1133
|
+
longitude?: number;
|
|
1134
|
+
}
|
|
1135
|
+
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1136
|
+
export interface BusinessSchedule {
|
|
1144
1137
|
/**
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
* `TIME` restores default values for `start` and `end`.
|
|
1148
|
-
*
|
|
1149
|
-
* Min: 1 field
|
|
1138
|
+
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1139
|
+
* @maxSize 100
|
|
1150
1140
|
*/
|
|
1151
|
-
|
|
1141
|
+
periods?: TimePeriod[];
|
|
1152
1142
|
/**
|
|
1153
|
-
*
|
|
1154
|
-
*
|
|
1143
|
+
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1144
|
+
* @maxSize 100
|
|
1155
1145
|
*/
|
|
1156
|
-
|
|
1146
|
+
specialHourPeriod?: SpecialHourPeriod[];
|
|
1147
|
+
}
|
|
1148
|
+
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1149
|
+
export interface TimePeriod {
|
|
1150
|
+
/** Day of the week the period starts on. */
|
|
1151
|
+
openDay?: DayOfWeek;
|
|
1157
1152
|
/**
|
|
1158
|
-
* Time
|
|
1159
|
-
*
|
|
1160
|
-
|
|
1153
|
+
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1154
|
+
* midnight at the end of the specified day.
|
|
1155
|
+
*/
|
|
1156
|
+
openTime?: string;
|
|
1157
|
+
/** Day of the week the period ends on. */
|
|
1158
|
+
closeDay?: DayOfWeek;
|
|
1159
|
+
/**
|
|
1160
|
+
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1161
|
+
* midnight at the end of the specified day.
|
|
1161
1162
|
*
|
|
1162
|
-
*
|
|
1163
|
+
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1163
1164
|
*/
|
|
1164
|
-
|
|
1165
|
+
closeTime?: string;
|
|
1165
1166
|
}
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1167
|
+
/** Enumerates the days of the week. */
|
|
1168
|
+
export declare enum DayOfWeek {
|
|
1169
|
+
MONDAY = "MONDAY",
|
|
1170
|
+
TUESDAY = "TUESDAY",
|
|
1171
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1172
|
+
THURSDAY = "THURSDAY",
|
|
1173
|
+
FRIDAY = "FRIDAY",
|
|
1174
|
+
SATURDAY = "SATURDAY",
|
|
1175
|
+
SUNDAY = "SUNDAY"
|
|
1169
1176
|
}
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1177
|
+
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1178
|
+
export interface SpecialHourPeriod {
|
|
1179
|
+
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1180
|
+
startDate?: string;
|
|
1181
|
+
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1182
|
+
endDate?: string;
|
|
1173
1183
|
/**
|
|
1174
|
-
*
|
|
1175
|
-
*
|
|
1176
|
-
* `
|
|
1177
|
-
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1178
|
-
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1179
|
-
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1180
|
-
* wouldn't affect any event without a subsequent occurrence.
|
|
1184
|
+
* Whether the business is closed (or the service is not available) during the exception.
|
|
1185
|
+
*
|
|
1186
|
+
* Default: `true`.
|
|
1181
1187
|
*/
|
|
1182
|
-
|
|
1188
|
+
isClosed?: boolean;
|
|
1189
|
+
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1190
|
+
comment?: string;
|
|
1191
|
+
}
|
|
1192
|
+
export interface Multilingual {
|
|
1183
1193
|
/**
|
|
1184
|
-
*
|
|
1185
|
-
*
|
|
1186
|
-
* `America/New_York` or `UTC`.
|
|
1187
|
-
*
|
|
1188
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1194
|
+
* Supported languages list.
|
|
1195
|
+
* @maxSize 200
|
|
1189
1196
|
*/
|
|
1190
|
-
|
|
1197
|
+
supportedLanguages?: SupportedLanguage[];
|
|
1198
|
+
/** Whether to redirect to user language. */
|
|
1199
|
+
autoRedirect?: boolean;
|
|
1191
1200
|
}
|
|
1192
|
-
export interface
|
|
1193
|
-
/**
|
|
1194
|
-
|
|
1195
|
-
/**
|
|
1196
|
-
|
|
1201
|
+
export interface SupportedLanguage {
|
|
1202
|
+
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1203
|
+
languageCode?: string;
|
|
1204
|
+
/** Locale. */
|
|
1205
|
+
locale?: Locale;
|
|
1206
|
+
/** Whether the supported language is the primary language for the site. */
|
|
1207
|
+
isPrimary?: boolean;
|
|
1208
|
+
/** Language icon. */
|
|
1209
|
+
countryCode?: string;
|
|
1210
|
+
/** How the language will be resolved. For internal use. */
|
|
1211
|
+
resolutionMethod?: ResolutionMethod;
|
|
1197
1212
|
}
|
|
1198
|
-
export
|
|
1199
|
-
|
|
1200
|
-
|
|
1213
|
+
export declare enum ResolutionMethod {
|
|
1214
|
+
QUERY_PARAM = "QUERY_PARAM",
|
|
1215
|
+
SUBDOMAIN = "SUBDOMAIN",
|
|
1216
|
+
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1217
|
+
}
|
|
1218
|
+
export interface ConsentPolicy {
|
|
1219
|
+
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1220
|
+
essential?: boolean | null;
|
|
1221
|
+
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1222
|
+
functional?: boolean | null;
|
|
1223
|
+
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1224
|
+
analytics?: boolean | null;
|
|
1225
|
+
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1226
|
+
advertising?: boolean | null;
|
|
1227
|
+
/** CCPA compliance flag. */
|
|
1228
|
+
dataToThirdParty?: boolean | null;
|
|
1229
|
+
}
|
|
1230
|
+
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1231
|
+
export interface Translation {
|
|
1232
|
+
/** The service type. */
|
|
1233
|
+
serviceType?: string;
|
|
1234
|
+
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1235
|
+
appDefId?: string;
|
|
1236
|
+
/** The instance ID of the service. */
|
|
1237
|
+
instanceId?: string;
|
|
1238
|
+
}
|
|
1239
|
+
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1240
|
+
/** Properties were updated. */
|
|
1241
|
+
propertiesChange?: PropertiesChange;
|
|
1242
|
+
/** Default properties were created on site creation. */
|
|
1243
|
+
siteCreated?: SiteCreated;
|
|
1244
|
+
/** Properties were cloned on site cloning. */
|
|
1245
|
+
siteCloned?: SiteCloned;
|
|
1246
|
+
}
|
|
1247
|
+
/** @oneof */
|
|
1248
|
+
export interface ChangeContextPayloadOneOf {
|
|
1249
|
+
/** Properties were updated. */
|
|
1250
|
+
propertiesChange?: PropertiesChange;
|
|
1251
|
+
/** Default properties were created on site creation. */
|
|
1252
|
+
siteCreated?: SiteCreated;
|
|
1253
|
+
/** Properties were cloned on site cloning. */
|
|
1254
|
+
siteCloned?: SiteCloned;
|
|
1255
|
+
}
|
|
1256
|
+
export interface PropertiesChange {
|
|
1257
|
+
}
|
|
1258
|
+
export interface SiteCreated {
|
|
1259
|
+
/** Origin template site id. */
|
|
1260
|
+
originTemplateId?: string | null;
|
|
1261
|
+
}
|
|
1262
|
+
export interface SiteCloned {
|
|
1263
|
+
/** Origin site id. */
|
|
1264
|
+
originMetaSiteId?: string;
|
|
1265
|
+
}
|
|
1266
|
+
export interface Empty {
|
|
1267
|
+
}
|
|
1268
|
+
export interface GetEventRequest {
|
|
1201
1269
|
/**
|
|
1202
|
-
*
|
|
1203
|
-
*
|
|
1270
|
+
* ID of the event to retrieve.
|
|
1271
|
+
*
|
|
1272
|
+
* Min: 36 characters
|
|
1273
|
+
* Max: 250 characters
|
|
1274
|
+
* @minLength 36
|
|
1275
|
+
* @maxLength 250
|
|
1204
1276
|
*/
|
|
1205
|
-
|
|
1277
|
+
eventId: string | null;
|
|
1206
1278
|
/**
|
|
1207
1279
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1208
1280
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -1211,439 +1283,535 @@ export interface CancelEventRequest {
|
|
|
1211
1283
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1212
1284
|
*/
|
|
1213
1285
|
timeZone?: string | null;
|
|
1286
|
+
/**
|
|
1287
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
1288
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1289
|
+
* for more information.
|
|
1290
|
+
*
|
|
1291
|
+
* Supported values:
|
|
1292
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1293
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1294
|
+
*
|
|
1295
|
+
* Max: 1 field
|
|
1296
|
+
* Default: No personal data is returned.
|
|
1297
|
+
* @maxSize 1
|
|
1298
|
+
*/
|
|
1299
|
+
fields?: RequestedFields[];
|
|
1214
1300
|
}
|
|
1215
|
-
export
|
|
1216
|
-
|
|
1301
|
+
export declare enum RequestedFields {
|
|
1302
|
+
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1303
|
+
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1304
|
+
PI_FIELDS = "PI_FIELDS",
|
|
1305
|
+
/** Returns only fields containing your own personal data. */
|
|
1306
|
+
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1307
|
+
}
|
|
1308
|
+
export interface GetEventResponse {
|
|
1309
|
+
/** Retrieved event. */
|
|
1217
1310
|
event?: Event;
|
|
1218
1311
|
}
|
|
1219
|
-
export interface
|
|
1220
|
-
/** IDs of the events to cancel. */
|
|
1221
|
-
eventIds: string[];
|
|
1312
|
+
export interface ListEventsRequest {
|
|
1222
1313
|
/**
|
|
1223
|
-
*
|
|
1314
|
+
* IDs of the events to retrieve.
|
|
1224
1315
|
*
|
|
1225
|
-
*
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
*
|
|
1230
|
-
*
|
|
1316
|
+
* Min: 1 event ID
|
|
1317
|
+
* Min: 100 event IDs
|
|
1318
|
+
* @minSize 1
|
|
1319
|
+
* @maxSize 100
|
|
1320
|
+
* @minLength 36
|
|
1321
|
+
* @maxLength 250
|
|
1231
1322
|
*/
|
|
1232
|
-
|
|
1323
|
+
eventIds: string[];
|
|
1233
1324
|
/**
|
|
1234
1325
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1235
1326
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1236
1327
|
* `America/New_York` or `UTC`.
|
|
1237
1328
|
*
|
|
1238
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
1329
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1239
1330
|
*/
|
|
1240
1331
|
timeZone?: string | null;
|
|
1332
|
+
/**
|
|
1333
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
1334
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1335
|
+
* for more information.
|
|
1336
|
+
*
|
|
1337
|
+
* Supported values:
|
|
1338
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1339
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1340
|
+
*
|
|
1341
|
+
* Max: 1 field
|
|
1342
|
+
* Default: No personal data is returned.
|
|
1343
|
+
* @maxSize 1
|
|
1344
|
+
*/
|
|
1345
|
+
fields?: RequestedFields[];
|
|
1241
1346
|
}
|
|
1242
|
-
export interface
|
|
1243
|
-
/**
|
|
1244
|
-
|
|
1245
|
-
/** Total successes and failures. */
|
|
1246
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1247
|
-
}
|
|
1248
|
-
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1249
|
-
export interface SitePropertiesNotification {
|
|
1250
|
-
/** The site ID for which this update notification applies. */
|
|
1251
|
-
metasiteId?: string;
|
|
1252
|
-
/** The actual update event. */
|
|
1253
|
-
event?: SitePropertiesEvent;
|
|
1254
|
-
/** A convenience set of mappings from the MetaSite ID to its constituent services. */
|
|
1255
|
-
translations?: Translation[];
|
|
1256
|
-
/** Context of the notification */
|
|
1257
|
-
changeContext?: ChangeContext;
|
|
1258
|
-
}
|
|
1259
|
-
/** The actual update event for a particular notification. */
|
|
1260
|
-
export interface SitePropertiesEvent {
|
|
1261
|
-
/** Version of the site's properties represented by this update. */
|
|
1262
|
-
version?: number;
|
|
1263
|
-
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1264
|
-
fields?: string[];
|
|
1265
|
-
/** Updated properties. */
|
|
1266
|
-
properties?: Properties;
|
|
1347
|
+
export interface ListEventsResponse {
|
|
1348
|
+
/** Retrieved events matching the provided IDs. */
|
|
1349
|
+
events?: Event[];
|
|
1267
1350
|
}
|
|
1268
|
-
export interface
|
|
1269
|
-
/** Site categories. */
|
|
1270
|
-
categories?: Categories;
|
|
1271
|
-
/** Site locale. */
|
|
1272
|
-
locale?: Locale;
|
|
1351
|
+
export interface QueryEventsRequest {
|
|
1273
1352
|
/**
|
|
1274
|
-
*
|
|
1353
|
+
* Local start date and time from which events are returned in
|
|
1354
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1355
|
+
* `2024-01-30T13:30:00`.
|
|
1275
1356
|
*
|
|
1276
|
-
*
|
|
1357
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
1358
|
+
* the results. Must be earlier than `toLocalDate` unless the sort order is
|
|
1359
|
+
* descending.
|
|
1360
|
+
* @format LOCAL_DATE_TIME
|
|
1277
1361
|
*/
|
|
1278
|
-
|
|
1362
|
+
fromLocalDate?: string | null;
|
|
1279
1363
|
/**
|
|
1280
|
-
*
|
|
1364
|
+
* Local end date and time up to which events are returned in
|
|
1365
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1366
|
+
* `2024-01-30T13:30:00`.
|
|
1281
1367
|
*
|
|
1282
|
-
*
|
|
1368
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
1369
|
+
* results. Must be later than `fromLocalDate` unless the sort order is
|
|
1370
|
+
* descending.
|
|
1371
|
+
* @format LOCAL_DATE_TIME
|
|
1372
|
+
*/
|
|
1373
|
+
toLocalDate?: string | null;
|
|
1374
|
+
/**
|
|
1375
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1376
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
1377
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
1378
|
+
*
|
|
1379
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1283
1380
|
*/
|
|
1284
|
-
paymentCurrency?: string | null;
|
|
1285
|
-
/** Timezone in `America/New_York` format. */
|
|
1286
1381
|
timeZone?: string | null;
|
|
1287
|
-
/**
|
|
1288
|
-
|
|
1289
|
-
/** Phone number. */
|
|
1290
|
-
phone?: string | null;
|
|
1291
|
-
/** Fax number. */
|
|
1292
|
-
fax?: string | null;
|
|
1293
|
-
/** Address. */
|
|
1294
|
-
address?: Address;
|
|
1295
|
-
/** Site display name. */
|
|
1296
|
-
siteDisplayName?: string | null;
|
|
1297
|
-
/** Business name. */
|
|
1298
|
-
businessName?: string | null;
|
|
1299
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1300
|
-
logo?: string | null;
|
|
1301
|
-
/** Site description. */
|
|
1302
|
-
description?: string | null;
|
|
1382
|
+
/** Query containing filters and paging. */
|
|
1383
|
+
query?: CursorQuery;
|
|
1303
1384
|
/**
|
|
1304
|
-
*
|
|
1385
|
+
* Filters events based on their `recurrenceType`.
|
|
1305
1386
|
*
|
|
1306
|
-
*
|
|
1387
|
+
* Max: 5 recurrence types can be specified.
|
|
1388
|
+
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
1389
|
+
* @maxSize 5
|
|
1307
1390
|
*/
|
|
1308
|
-
|
|
1309
|
-
/** Supported languages of a site and the primary language. */
|
|
1310
|
-
multilingual?: Multilingual;
|
|
1311
|
-
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1312
|
-
consentPolicy?: ConsentPolicy;
|
|
1391
|
+
recurrenceType?: RecurrenceType[];
|
|
1313
1392
|
/**
|
|
1314
|
-
*
|
|
1393
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
1394
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1395
|
+
* for more information.
|
|
1315
1396
|
*
|
|
1316
|
-
*
|
|
1397
|
+
* Supported values:
|
|
1398
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
1399
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
1400
|
+
*
|
|
1401
|
+
* Max: 1 field
|
|
1402
|
+
* Default: No personal data is returned.
|
|
1403
|
+
* @maxSize 1
|
|
1317
1404
|
*/
|
|
1318
|
-
|
|
1319
|
-
/** External site URL that uses Wix as its headless business solution. */
|
|
1320
|
-
externalSiteUrl?: string | null;
|
|
1321
|
-
/** Track clicks analytics. */
|
|
1322
|
-
trackClicksAnalytics?: boolean;
|
|
1405
|
+
fields?: RequestedFields[];
|
|
1323
1406
|
}
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1407
|
+
/** TODO Diverge */
|
|
1408
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1409
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1410
|
+
cursorPaging?: CursorPaging;
|
|
1411
|
+
/**
|
|
1412
|
+
* Filter object.
|
|
1413
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
1414
|
+
* for more information.
|
|
1415
|
+
*
|
|
1416
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
1417
|
+
*
|
|
1418
|
+
* For a detailed list of supported filters, see Supported Filters.
|
|
1419
|
+
*/
|
|
1420
|
+
filter?: Record<string, any> | null;
|
|
1421
|
+
/**
|
|
1422
|
+
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
1423
|
+
* Default is start ascending.
|
|
1424
|
+
* @maxSize 1
|
|
1425
|
+
*/
|
|
1426
|
+
sort?: Sorting[];
|
|
1331
1427
|
}
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
country?: string;
|
|
1428
|
+
/** @oneof */
|
|
1429
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1430
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1431
|
+
cursorPaging?: CursorPaging;
|
|
1337
1432
|
}
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
zip?: string;
|
|
1349
|
-
/** Extra information to be displayed in the address. */
|
|
1350
|
-
hint?: AddressHint;
|
|
1351
|
-
/** Whether this address represents a physical location. */
|
|
1352
|
-
isPhysical?: boolean;
|
|
1353
|
-
/** Google-formatted version of this address. */
|
|
1354
|
-
googleFormattedAddress?: string;
|
|
1355
|
-
/** Street number. */
|
|
1356
|
-
streetNumber?: string;
|
|
1357
|
-
/** Apartment number. */
|
|
1358
|
-
apartmentNumber?: string;
|
|
1359
|
-
/** Geographic coordinates of location. */
|
|
1360
|
-
coordinates?: GeoCoordinates;
|
|
1433
|
+
/** TODO Diverge */
|
|
1434
|
+
export interface Sorting {
|
|
1435
|
+
/**
|
|
1436
|
+
* The field to sort by.
|
|
1437
|
+
* Either `start` or `end`.
|
|
1438
|
+
* Default is `start`.
|
|
1439
|
+
*/
|
|
1440
|
+
fieldName?: string;
|
|
1441
|
+
/** Sort order. */
|
|
1442
|
+
order?: SortOrder;
|
|
1361
1443
|
}
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1366
|
-
*/
|
|
1367
|
-
export interface AddressHint {
|
|
1368
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1369
|
-
text?: string;
|
|
1370
|
-
/** Where the extra text should be displayed. */
|
|
1371
|
-
placement?: PlacementType;
|
|
1444
|
+
export declare enum SortOrder {
|
|
1445
|
+
ASC = "ASC",
|
|
1446
|
+
DESC = "DESC"
|
|
1372
1447
|
}
|
|
1373
|
-
/**
|
|
1374
|
-
export
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1448
|
+
/** TODO Diverge */
|
|
1449
|
+
export interface CursorPaging {
|
|
1450
|
+
/**
|
|
1451
|
+
* Number of events to return.
|
|
1452
|
+
* Defaults to `50`. Maximum `1000`.
|
|
1453
|
+
* @min 1
|
|
1454
|
+
* @max 1000
|
|
1455
|
+
*/
|
|
1456
|
+
limit?: number | null;
|
|
1457
|
+
/**
|
|
1458
|
+
* Pointer to the next or previous page in the list of results.
|
|
1459
|
+
*
|
|
1460
|
+
* You can get the relevant cursor token
|
|
1461
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1462
|
+
* Not relevant for the first request.
|
|
1463
|
+
*/
|
|
1464
|
+
cursor?: string | null;
|
|
1378
1465
|
}
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
longitude?: number;
|
|
1466
|
+
export interface QueryEventsResponse {
|
|
1467
|
+
/** Retrieved events matching the provided query. */
|
|
1468
|
+
events?: Event[];
|
|
1469
|
+
/** Paging metadata. */
|
|
1470
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1385
1471
|
}
|
|
1386
|
-
/**
|
|
1387
|
-
export interface
|
|
1388
|
-
/**
|
|
1389
|
-
|
|
1390
|
-
/**
|
|
1391
|
-
|
|
1472
|
+
/** TODO Diverge */
|
|
1473
|
+
export interface CursorPagingMetadata {
|
|
1474
|
+
/** Number of items returned in the response. */
|
|
1475
|
+
count?: number | null;
|
|
1476
|
+
/** 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). */
|
|
1477
|
+
cursors?: Cursors;
|
|
1478
|
+
/**
|
|
1479
|
+
* Indicates if there are more results after the current page.
|
|
1480
|
+
* If `true`, another page of results can be retrieved.
|
|
1481
|
+
* If `false`, this is the last page.
|
|
1482
|
+
*/
|
|
1483
|
+
hasNext?: boolean | null;
|
|
1392
1484
|
}
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1485
|
+
export interface Cursors {
|
|
1486
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1487
|
+
next?: string | null;
|
|
1488
|
+
}
|
|
1489
|
+
export interface ListRecurringEventInstancesHistoryRequest {
|
|
1397
1490
|
/**
|
|
1398
|
-
*
|
|
1399
|
-
*
|
|
1491
|
+
* The ID of the recurring event.
|
|
1492
|
+
* Required, unless `cursorPaging` is provided.
|
|
1493
|
+
* @minLength 64
|
|
1494
|
+
* @maxLength 64
|
|
1400
1495
|
*/
|
|
1401
|
-
|
|
1402
|
-
/** Day of the week the period ends on. */
|
|
1403
|
-
closeDay?: DayOfWeek;
|
|
1496
|
+
recurringEventId?: string | null;
|
|
1404
1497
|
/**
|
|
1405
|
-
*
|
|
1406
|
-
*
|
|
1498
|
+
* The revision of the recurring event.
|
|
1499
|
+
* Required, unless `cursorPaging` is provided.
|
|
1500
|
+
*/
|
|
1501
|
+
revision?: string | null;
|
|
1502
|
+
/**
|
|
1503
|
+
* Inclusive start date for which events are returned, in ISO-8601 format.
|
|
1504
|
+
* Events that begin at or after the `fromDate` are included in the results.
|
|
1505
|
+
* Required, unless `cursorPaging` is provided.
|
|
1506
|
+
*/
|
|
1507
|
+
fromDate?: Date | null;
|
|
1508
|
+
/**
|
|
1509
|
+
* Exclusive end date for which events are returned, in ISO-8601 format.
|
|
1510
|
+
* Events that begin before the `toDate` are included in the results.
|
|
1511
|
+
* Required, unless `cursorPaging` is provided.
|
|
1512
|
+
*/
|
|
1513
|
+
toDate?: Date | null;
|
|
1514
|
+
/** Optional cursor pointing to the next page of events. */
|
|
1515
|
+
cursorPaging?: CursorPaging;
|
|
1516
|
+
}
|
|
1517
|
+
export interface ListRecurringEventInstancesHistoryResponse {
|
|
1518
|
+
/** The recurring event instances. */
|
|
1519
|
+
recurringEventInstances?: Event[];
|
|
1520
|
+
/** Paging metadata. */
|
|
1521
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1522
|
+
}
|
|
1523
|
+
export interface CreateEventRequest {
|
|
1524
|
+
/** Event to create. */
|
|
1525
|
+
event: Event;
|
|
1526
|
+
/**
|
|
1527
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1528
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1529
|
+
* `America/New_York` or `UTC`.
|
|
1407
1530
|
*
|
|
1408
|
-
*
|
|
1531
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1409
1532
|
*/
|
|
1410
|
-
|
|
1533
|
+
timeZone?: string | null;
|
|
1534
|
+
/**
|
|
1535
|
+
* Idempotency key guaranteeing that you don't create the same event more
|
|
1536
|
+
* than once.
|
|
1537
|
+
* @format GUID
|
|
1538
|
+
*/
|
|
1539
|
+
idempotencyKey?: string | null;
|
|
1411
1540
|
}
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
TUESDAY = "TUESDAY",
|
|
1416
|
-
WEDNESDAY = "WEDNESDAY",
|
|
1417
|
-
THURSDAY = "THURSDAY",
|
|
1418
|
-
FRIDAY = "FRIDAY",
|
|
1419
|
-
SATURDAY = "SATURDAY",
|
|
1420
|
-
SUNDAY = "SUNDAY"
|
|
1541
|
+
export interface CreateEventResponse {
|
|
1542
|
+
/** Created event. */
|
|
1543
|
+
event?: Event;
|
|
1421
1544
|
}
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1545
|
+
export interface BulkCreateEventRequest {
|
|
1546
|
+
/**
|
|
1547
|
+
* Events to create.
|
|
1548
|
+
* @minSize 1
|
|
1549
|
+
* @maxSize 50
|
|
1550
|
+
*/
|
|
1551
|
+
events: MaskedEvent[];
|
|
1552
|
+
/**
|
|
1553
|
+
* Whether to return created events.
|
|
1554
|
+
*
|
|
1555
|
+
* Default: `false`.
|
|
1556
|
+
*/
|
|
1557
|
+
returnEntity?: boolean | null;
|
|
1428
1558
|
/**
|
|
1429
|
-
*
|
|
1559
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1560
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1561
|
+
* `America/New_York` or `UTC`.
|
|
1430
1562
|
*
|
|
1431
|
-
* Default: `
|
|
1563
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1432
1564
|
*/
|
|
1433
|
-
|
|
1434
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1435
|
-
comment?: string;
|
|
1436
|
-
}
|
|
1437
|
-
export interface Multilingual {
|
|
1438
|
-
/** Supported languages list. */
|
|
1439
|
-
supportedLanguages?: SupportedLanguage[];
|
|
1440
|
-
/** Whether to redirect to user language. */
|
|
1441
|
-
autoRedirect?: boolean;
|
|
1442
|
-
}
|
|
1443
|
-
export interface SupportedLanguage {
|
|
1444
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1445
|
-
languageCode?: string;
|
|
1446
|
-
/** Locale. */
|
|
1447
|
-
locale?: Locale;
|
|
1448
|
-
/** Whether the supported language is the primary language for the site. */
|
|
1449
|
-
isPrimary?: boolean;
|
|
1450
|
-
/** Language icon. */
|
|
1451
|
-
countryCode?: string;
|
|
1452
|
-
/** How the language will be resolved. For internal use. */
|
|
1453
|
-
resolutionMethod?: ResolutionMethod;
|
|
1454
|
-
}
|
|
1455
|
-
export declare enum ResolutionMethod {
|
|
1456
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
1457
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
1458
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1565
|
+
timeZone?: string | null;
|
|
1459
1566
|
}
|
|
1460
|
-
export interface
|
|
1461
|
-
/**
|
|
1462
|
-
|
|
1463
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1464
|
-
functional?: boolean | null;
|
|
1465
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1466
|
-
analytics?: boolean | null;
|
|
1467
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1468
|
-
advertising?: boolean | null;
|
|
1469
|
-
/** CCPA compliance flag. */
|
|
1470
|
-
dataToThirdParty?: boolean | null;
|
|
1567
|
+
export interface MaskedEvent {
|
|
1568
|
+
/** Event to create. */
|
|
1569
|
+
event?: Event;
|
|
1471
1570
|
}
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
appDefId?: string;
|
|
1478
|
-
/** The instance ID of the service. */
|
|
1479
|
-
instanceId?: string;
|
|
1571
|
+
export interface BulkCreateEventResponse {
|
|
1572
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1573
|
+
results?: BulkEventResult[];
|
|
1574
|
+
/** Total successes and failures. */
|
|
1575
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1480
1576
|
}
|
|
1481
|
-
export interface
|
|
1482
|
-
/**
|
|
1483
|
-
|
|
1484
|
-
/**
|
|
1485
|
-
|
|
1486
|
-
/** Properties were cloned on site cloning. */
|
|
1487
|
-
siteCloned?: SiteCloned;
|
|
1577
|
+
export interface BulkEventResult {
|
|
1578
|
+
/** Whether the requested action was successful. */
|
|
1579
|
+
itemMetadata?: ItemMetadata;
|
|
1580
|
+
/** The event. */
|
|
1581
|
+
item?: Event;
|
|
1488
1582
|
}
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
/**
|
|
1496
|
-
|
|
1583
|
+
export interface ItemMetadata {
|
|
1584
|
+
/**
|
|
1585
|
+
* Event ID.
|
|
1586
|
+
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1587
|
+
*/
|
|
1588
|
+
_id?: string | null;
|
|
1589
|
+
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1590
|
+
originalIndex?: number;
|
|
1591
|
+
/**
|
|
1592
|
+
* Whether the requested action was successful for this event.
|
|
1593
|
+
* When `false`, the `error` field is populated.
|
|
1594
|
+
*/
|
|
1595
|
+
success?: boolean;
|
|
1596
|
+
/** Details about the error in case of failure. */
|
|
1597
|
+
error?: ApplicationError;
|
|
1497
1598
|
}
|
|
1498
|
-
export interface
|
|
1599
|
+
export interface ApplicationError {
|
|
1600
|
+
/** Error code. */
|
|
1601
|
+
code?: string;
|
|
1602
|
+
/** Description of the error. */
|
|
1603
|
+
description?: string;
|
|
1604
|
+
/** Data related to the error. */
|
|
1605
|
+
data?: Record<string, any> | null;
|
|
1499
1606
|
}
|
|
1500
|
-
export interface
|
|
1501
|
-
/**
|
|
1502
|
-
|
|
1607
|
+
export interface BulkActionMetadata {
|
|
1608
|
+
/** Number of events that were successfully processed. */
|
|
1609
|
+
totalSuccesses?: number;
|
|
1610
|
+
/** Number of events that couldn't be processed. */
|
|
1611
|
+
totalFailures?: number;
|
|
1503
1612
|
}
|
|
1504
|
-
export interface
|
|
1505
|
-
/**
|
|
1506
|
-
|
|
1613
|
+
export interface UpdateEventRequest {
|
|
1614
|
+
/** Event to update. */
|
|
1615
|
+
event: Event;
|
|
1616
|
+
/**
|
|
1617
|
+
* Information about whether participants of the updated event are notified and
|
|
1618
|
+
* the message they receive.
|
|
1619
|
+
*/
|
|
1620
|
+
participantNotification?: ParticipantNotification;
|
|
1621
|
+
/**
|
|
1622
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1623
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1624
|
+
* `America/New_York` or `UTC`.
|
|
1625
|
+
*
|
|
1626
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1627
|
+
*/
|
|
1628
|
+
timeZone?: string | null;
|
|
1507
1629
|
}
|
|
1508
|
-
export interface
|
|
1630
|
+
export interface UpdateEventResponse {
|
|
1631
|
+
/** Updated event. */
|
|
1632
|
+
event?: Event;
|
|
1509
1633
|
}
|
|
1510
|
-
export interface
|
|
1634
|
+
export interface BulkUpdateEventRequest {
|
|
1511
1635
|
/**
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1636
|
+
* Events to update.
|
|
1637
|
+
*
|
|
1638
|
+
* Min: 1 event
|
|
1639
|
+
* Max: 50 events
|
|
1640
|
+
* @minSize 1
|
|
1641
|
+
* @maxSize 50
|
|
1514
1642
|
*/
|
|
1515
|
-
|
|
1643
|
+
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1516
1644
|
/**
|
|
1517
|
-
*
|
|
1518
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1519
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
1645
|
+
* Whether to return the updated events.
|
|
1520
1646
|
*
|
|
1521
|
-
*
|
|
1522
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
1647
|
+
* Default: `false`
|
|
1523
1648
|
*/
|
|
1524
|
-
|
|
1649
|
+
returnEntity?: boolean | null;
|
|
1525
1650
|
/**
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1528
|
-
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
1529
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
1530
|
-
*
|
|
1531
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
1532
|
-
* results. Must be later than `fromLocalDate`.
|
|
1651
|
+
* Information about whether participants of the updated event are notified and
|
|
1652
|
+
* the message they receive.
|
|
1533
1653
|
*/
|
|
1534
|
-
|
|
1654
|
+
participantNotification?: ParticipantNotification;
|
|
1535
1655
|
/**
|
|
1536
1656
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1537
|
-
* for
|
|
1538
|
-
* `
|
|
1657
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1658
|
+
* `America/New_York` or `UTC`.
|
|
1539
1659
|
*
|
|
1540
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
1660
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1541
1661
|
*/
|
|
1542
1662
|
timeZone?: string | null;
|
|
1663
|
+
}
|
|
1664
|
+
export interface BulkUpdateEventRequestMaskedEvent {
|
|
1665
|
+
/** Event to update. */
|
|
1666
|
+
event?: Event;
|
|
1667
|
+
}
|
|
1668
|
+
export interface BulkUpdateEventResponse {
|
|
1669
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1670
|
+
results?: BulkEventResult[];
|
|
1671
|
+
/** Total successes and failures. */
|
|
1672
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1673
|
+
}
|
|
1674
|
+
export interface UpdateEventParticipantsRequest {
|
|
1543
1675
|
/**
|
|
1544
|
-
*
|
|
1545
|
-
*
|
|
1676
|
+
* ID of the event to update.
|
|
1677
|
+
*
|
|
1678
|
+
* Min: 36 characters
|
|
1679
|
+
* Max: 250 characters
|
|
1680
|
+
* @minLength 36
|
|
1681
|
+
* @maxLength 250
|
|
1546
1682
|
*/
|
|
1547
|
-
|
|
1548
|
-
/**
|
|
1549
|
-
|
|
1683
|
+
eventId?: string | null;
|
|
1684
|
+
/** The participants to update. */
|
|
1685
|
+
participants?: Participants;
|
|
1550
1686
|
}
|
|
1551
|
-
|
|
1552
|
-
|
|
1687
|
+
export interface UpdateEventParticipantsResponse {
|
|
1688
|
+
/** Updated event. */
|
|
1689
|
+
event?: Event;
|
|
1690
|
+
}
|
|
1691
|
+
export interface RestoreEventDefaultsRequest {
|
|
1553
1692
|
/**
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1693
|
+
* ID of the event for which to restore default values.
|
|
1694
|
+
* @minLength 36
|
|
1695
|
+
* @maxLength 250
|
|
1556
1696
|
*/
|
|
1557
|
-
|
|
1697
|
+
eventId: string | null;
|
|
1558
1698
|
/**
|
|
1559
|
-
*
|
|
1699
|
+
* Fields for which to restore default values.
|
|
1560
1700
|
*
|
|
1561
|
-
*
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
1701
|
+
* `TIME` restores default values for `start` and `end`.
|
|
1702
|
+
*
|
|
1703
|
+
* Min: 1 field
|
|
1704
|
+
* @minSize 1
|
|
1564
1705
|
*/
|
|
1565
|
-
|
|
1706
|
+
fields: Field[];
|
|
1707
|
+
/**
|
|
1708
|
+
* Information about whether participants of the updated event are notified and
|
|
1709
|
+
* the message they receive.
|
|
1710
|
+
*/
|
|
1711
|
+
participantNotification?: ParticipantNotification;
|
|
1712
|
+
/**
|
|
1713
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1714
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1715
|
+
* `America/New_York` or `UTC`.
|
|
1716
|
+
*
|
|
1717
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1718
|
+
*/
|
|
1719
|
+
timeZone?: string | null;
|
|
1566
1720
|
}
|
|
1567
|
-
export interface
|
|
1568
|
-
/**
|
|
1569
|
-
|
|
1570
|
-
/** Paging metadata. */
|
|
1571
|
-
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1721
|
+
export interface RestoreEventDefaultsResponse {
|
|
1722
|
+
/** Updated event. */
|
|
1723
|
+
event?: Event;
|
|
1572
1724
|
}
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1725
|
+
export interface SplitRecurringEventRequest {
|
|
1726
|
+
/**
|
|
1727
|
+
* ID of the `MASTER` event to split.
|
|
1728
|
+
* @minLength 36
|
|
1729
|
+
* @maxLength 250
|
|
1730
|
+
*/
|
|
1731
|
+
recurringEventId: string | null;
|
|
1732
|
+
/**
|
|
1733
|
+
* Local date and time at which the `MASTER` event is split in
|
|
1734
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1735
|
+
* `2025-03-11T09:00:00`.
|
|
1736
|
+
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1737
|
+
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1738
|
+
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1739
|
+
* wouldn't affect any event without a subsequent occurrence.
|
|
1740
|
+
* @format LOCAL_DATE_TIME
|
|
1741
|
+
*/
|
|
1742
|
+
splitLocalDate: string | null;
|
|
1579
1743
|
/**
|
|
1580
|
-
*
|
|
1581
|
-
*
|
|
1582
|
-
*
|
|
1744
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1745
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1746
|
+
* `America/New_York` or `UTC`.
|
|
1747
|
+
*
|
|
1748
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1583
1749
|
*/
|
|
1584
|
-
|
|
1750
|
+
timeZone?: string | null;
|
|
1585
1751
|
}
|
|
1586
|
-
export interface
|
|
1587
|
-
/**
|
|
1588
|
-
|
|
1752
|
+
export interface SplitRecurringEventResponse {
|
|
1753
|
+
/** Original `MASTER` event that was shortened. */
|
|
1754
|
+
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1755
|
+
/** New `MASTER` event starting with the first event after the split date. */
|
|
1756
|
+
newRecurringEventStartingFromSplit?: Event;
|
|
1589
1757
|
}
|
|
1590
|
-
export interface
|
|
1758
|
+
export interface CancelEventRequest {
|
|
1591
1759
|
/**
|
|
1592
|
-
* ID of the
|
|
1593
|
-
*
|
|
1594
|
-
*
|
|
1595
|
-
* You must have the `Read Calendars - Including PI`
|
|
1596
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
1597
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
1760
|
+
* ID of the event to cancel.
|
|
1761
|
+
* @minLength 36
|
|
1762
|
+
* @maxLength 250
|
|
1598
1763
|
*/
|
|
1599
|
-
|
|
1764
|
+
eventId: string | null;
|
|
1600
1765
|
/**
|
|
1601
|
-
*
|
|
1602
|
-
*
|
|
1603
|
-
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
1604
|
-
*
|
|
1605
|
-
* Events that start before the `fromLocalDate` but end after it are included in
|
|
1606
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
1766
|
+
* Information about whether participants of the canceled event are notified and
|
|
1767
|
+
* the message they receive.
|
|
1607
1768
|
*/
|
|
1608
|
-
|
|
1769
|
+
participantNotification?: ParticipantNotification;
|
|
1609
1770
|
/**
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
* `
|
|
1613
|
-
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
1771
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1772
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1773
|
+
* `America/New_York` or `UTC`.
|
|
1614
1774
|
*
|
|
1615
|
-
*
|
|
1616
|
-
* results. Must be later than `fromLocalDate`.
|
|
1775
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1617
1776
|
*/
|
|
1618
|
-
|
|
1777
|
+
timeZone?: string | null;
|
|
1778
|
+
}
|
|
1779
|
+
export interface CancelEventResponse {
|
|
1780
|
+
/** Canceled event. */
|
|
1781
|
+
event?: Event;
|
|
1782
|
+
}
|
|
1783
|
+
export interface BulkCancelEventRequest {
|
|
1619
1784
|
/**
|
|
1620
|
-
*
|
|
1621
|
-
*
|
|
1622
|
-
*
|
|
1785
|
+
* IDs of the events to cancel.
|
|
1786
|
+
* @minSize 1
|
|
1787
|
+
* @maxSize 50
|
|
1788
|
+
*/
|
|
1789
|
+
eventIds: string[];
|
|
1790
|
+
/**
|
|
1791
|
+
* Whether to return the canceled events.
|
|
1623
1792
|
*
|
|
1624
|
-
* Default: `
|
|
1793
|
+
* Default: `false`
|
|
1625
1794
|
*/
|
|
1626
|
-
|
|
1795
|
+
returnEntity?: boolean | null;
|
|
1627
1796
|
/**
|
|
1628
|
-
*
|
|
1629
|
-
*
|
|
1797
|
+
* Information about whether participants of the canceled events are notified and
|
|
1798
|
+
* the message they receive.
|
|
1630
1799
|
*/
|
|
1631
|
-
|
|
1632
|
-
/** Cursor to retrieve the next page of the results. */
|
|
1633
|
-
cursorPaging?: CommonCursorPaging;
|
|
1800
|
+
participantNotification?: ParticipantNotification;
|
|
1634
1801
|
/**
|
|
1635
|
-
*
|
|
1636
|
-
*
|
|
1802
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1803
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1804
|
+
* `America/New_York` or `UTC`.
|
|
1637
1805
|
*
|
|
1638
|
-
*
|
|
1806
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1639
1807
|
*/
|
|
1640
|
-
|
|
1808
|
+
timeZone?: string | null;
|
|
1641
1809
|
}
|
|
1642
|
-
export interface
|
|
1643
|
-
/**
|
|
1644
|
-
|
|
1645
|
-
/**
|
|
1646
|
-
|
|
1810
|
+
export interface BulkCancelEventResponse {
|
|
1811
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1812
|
+
results?: BulkEventResult[];
|
|
1813
|
+
/** Total successes and failures. */
|
|
1814
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1647
1815
|
}
|
|
1648
1816
|
interface RecurrenceRuleNonNullableFields {
|
|
1649
1817
|
frequency: Frequency;
|
|
@@ -1682,6 +1850,12 @@ export interface EventNonNullableFields {
|
|
|
1682
1850
|
inheritedFields: Field[];
|
|
1683
1851
|
permissions: PermissionNonNullableFields[];
|
|
1684
1852
|
}
|
|
1853
|
+
export interface ListEventsByContactIdResponseNonNullableFields {
|
|
1854
|
+
events: EventNonNullableFields[];
|
|
1855
|
+
}
|
|
1856
|
+
export interface ListEventsByMemberIdResponseNonNullableFields {
|
|
1857
|
+
events: EventNonNullableFields[];
|
|
1858
|
+
}
|
|
1685
1859
|
export interface GetEventResponseNonNullableFields {
|
|
1686
1860
|
event?: EventNonNullableFields;
|
|
1687
1861
|
}
|
|
@@ -1736,16 +1910,16 @@ export interface BulkCancelEventResponseNonNullableFields {
|
|
|
1736
1910
|
results: BulkEventResultNonNullableFields[];
|
|
1737
1911
|
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
1738
1912
|
}
|
|
1739
|
-
export interface ListEventsByContactIdResponseNonNullableFields {
|
|
1740
|
-
events: EventNonNullableFields[];
|
|
1741
|
-
}
|
|
1742
|
-
export interface ListEventsByMemberIdResponseNonNullableFields {
|
|
1743
|
-
events: EventNonNullableFields[];
|
|
1744
|
-
}
|
|
1745
1913
|
export interface BaseEventMetadata {
|
|
1746
|
-
/**
|
|
1914
|
+
/**
|
|
1915
|
+
* App instance ID.
|
|
1916
|
+
* @format GUID
|
|
1917
|
+
*/
|
|
1747
1918
|
instanceId?: string | null;
|
|
1748
|
-
/**
|
|
1919
|
+
/**
|
|
1920
|
+
* Event type.
|
|
1921
|
+
* @maxLength 150
|
|
1922
|
+
*/
|
|
1749
1923
|
eventType?: string;
|
|
1750
1924
|
/** The identification type and identity data. */
|
|
1751
1925
|
identity?: IdentificationData;
|
|
@@ -1806,6 +1980,10 @@ export interface EventCancelledEnvelope {
|
|
|
1806
1980
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1807
1981
|
* @permissionScope Read Bookings - Including Participants
|
|
1808
1982
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1983
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1984
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1985
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1986
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1809
1987
|
* @permissionScope Read bookings calendar - including participants
|
|
1810
1988
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1811
1989
|
* @permissionId CALENDAR.EVENT_READ_PI
|
|
@@ -1834,6 +2012,10 @@ export interface EventCreatedEnvelope {
|
|
|
1834
2012
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1835
2013
|
* @permissionScope Read Bookings - Including Participants
|
|
1836
2014
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2015
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2016
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2017
|
+
* @permissionScope Manage Bookings - all permissions
|
|
2018
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1837
2019
|
* @permissionScope Read bookings calendar - including participants
|
|
1838
2020
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1839
2021
|
* @permissionId CALENDAR.EVENT_READ_PI
|
|
@@ -1857,25 +2039,162 @@ export interface EventRecurringSplitEnvelope {
|
|
|
1857
2039
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1858
2040
|
* @permissionScope Read Bookings - Including Participants
|
|
1859
2041
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2042
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2043
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2044
|
+
* @permissionScope Manage Bookings - all permissions
|
|
2045
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2046
|
+
* @permissionScope Read bookings calendar - including participants
|
|
2047
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2048
|
+
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2049
|
+
* @webhook
|
|
2050
|
+
* @eventType wix.calendar.v3.event_recurring_split
|
|
2051
|
+
* @slug recurring_split
|
|
2052
|
+
* @documentationMaturity preview
|
|
2053
|
+
*/
|
|
2054
|
+
export declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
|
|
2055
|
+
export interface EventUpdatedEnvelope {
|
|
2056
|
+
entity: Event;
|
|
2057
|
+
metadata: EventMetadata;
|
|
2058
|
+
}
|
|
2059
|
+
/**
|
|
2060
|
+
* Triggered when an event is updated, including when it's canceled.
|
|
2061
|
+
*
|
|
2062
|
+
* Not triggered when `INSTANCE` events are updated. You can use the
|
|
2063
|
+
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
2064
|
+
* to get notified about `INSTANCE` events.
|
|
2065
|
+
* @permissionScope Read Calendar - Including PI
|
|
2066
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2067
|
+
* @permissionScope Manage Calendars
|
|
2068
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2069
|
+
* @permissionScope Manage Bookings
|
|
2070
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2071
|
+
* @permissionScope Read Bookings - Including Participants
|
|
2072
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2073
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2074
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2075
|
+
* @permissionScope Manage Bookings - all permissions
|
|
2076
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2077
|
+
* @permissionScope Read bookings calendar - including participants
|
|
2078
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2079
|
+
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2080
|
+
* @webhook
|
|
2081
|
+
* @eventType wix.calendar.v3.event_updated
|
|
2082
|
+
* @slug updated
|
|
2083
|
+
* @documentationMaturity preview
|
|
2084
|
+
*/
|
|
2085
|
+
export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
|
|
2086
|
+
/**
|
|
2087
|
+
* Retrieves a list of events filtered by the participant's
|
|
2088
|
+
* [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
2089
|
+
* ID.
|
|
2090
|
+
*
|
|
2091
|
+
*
|
|
2092
|
+
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
2093
|
+
* `fromLocalDate`.
|
|
2094
|
+
* @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
2095
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
2096
|
+
* @public
|
|
2097
|
+
* @documentationMaturity preview
|
|
2098
|
+
* @requiredField contactId
|
|
2099
|
+
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2100
|
+
* @permissionScope Read Calendar - Including PI
|
|
2101
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2102
|
+
* @permissionScope Manage Calendars
|
|
2103
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2104
|
+
* @permissionScope Manage Bookings
|
|
2105
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2106
|
+
* @permissionScope Read Bookings - Including Participants
|
|
2107
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2108
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2109
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2110
|
+
* @permissionScope Manage Bookings - all permissions
|
|
2111
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2112
|
+
* @permissionScope Read bookings calendar - including participants
|
|
2113
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2114
|
+
* @applicableIdentity APP
|
|
2115
|
+
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
|
|
2116
|
+
*/
|
|
2117
|
+
export declare function listEventsByContactId(contactId: string | null, options?: ListEventsByContactIdOptions): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
|
|
2118
|
+
export interface ListEventsByContactIdOptions {
|
|
2119
|
+
/**
|
|
2120
|
+
* Local start date and time from which events are returned in
|
|
2121
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
2122
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
2123
|
+
*
|
|
2124
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
2125
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
2126
|
+
* @format LOCAL_DATE_TIME
|
|
2127
|
+
*/
|
|
2128
|
+
fromLocalDate?: string | null;
|
|
2129
|
+
/**
|
|
2130
|
+
* Local end date and time up to which events are returned in
|
|
2131
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
2132
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
2133
|
+
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
2134
|
+
*
|
|
2135
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
2136
|
+
* results. Must be later than `fromLocalDate`.
|
|
2137
|
+
* @format LOCAL_DATE_TIME
|
|
2138
|
+
*/
|
|
2139
|
+
toLocalDate?: string | null;
|
|
2140
|
+
/**
|
|
2141
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2142
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
2143
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
2144
|
+
*
|
|
2145
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
2146
|
+
*/
|
|
2147
|
+
timeZone?: string | null;
|
|
2148
|
+
/**
|
|
2149
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
2150
|
+
* to filter events by.
|
|
2151
|
+
* @format GUID
|
|
2152
|
+
*/
|
|
2153
|
+
appId?: string | null;
|
|
2154
|
+
/** Cursor to retrieve the next page of the results. */
|
|
2155
|
+
cursorPaging?: CommonCursorPaging;
|
|
2156
|
+
}
|
|
2157
|
+
/**
|
|
2158
|
+
* Retrieves a list of events filtered by the participant's
|
|
2159
|
+
* [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
|
|
2160
|
+
* ID.
|
|
2161
|
+
*
|
|
2162
|
+
*
|
|
2163
|
+
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
2164
|
+
* `fromLocalDate`.
|
|
2165
|
+
* @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
2166
|
+
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
2167
|
+
* Provide `me` to retrieve events for the currently logged-in member.
|
|
2168
|
+
* You must have the `Read Calendars - Including PI`
|
|
2169
|
+
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
2170
|
+
* to retrieve events for members who aren't the currently logged in member.
|
|
2171
|
+
* @public
|
|
2172
|
+
* @documentationMaturity preview
|
|
2173
|
+
* @requiredField memberId
|
|
2174
|
+
* @permissionId CALENDAR.EVENT_READ
|
|
2175
|
+
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2176
|
+
* @permissionScope Read Bookings - Public Data
|
|
2177
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2178
|
+
* @permissionScope Read Calendar - Including PI
|
|
2179
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2180
|
+
* @permissionScope Manage Calendars
|
|
2181
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2182
|
+
* @permissionScope Manage Bookings
|
|
2183
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2184
|
+
* @permissionScope Read Bookings - Including Participants
|
|
2185
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2186
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2187
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2188
|
+
* @permissionScope Read Bookings Calendar Availability
|
|
2189
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2190
|
+
* @permissionScope Read Calendar
|
|
2191
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2192
|
+
* @permissionScope Manage Bookings - all permissions
|
|
2193
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1860
2194
|
* @permissionScope Read bookings calendar - including participants
|
|
1861
2195
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1862
|
-
* @
|
|
1863
|
-
* @
|
|
1864
|
-
* @eventType wix.calendar.v3.event_recurring_split
|
|
1865
|
-
* @slug recurring_split
|
|
1866
|
-
* @documentationMaturity preview
|
|
1867
|
-
*/
|
|
1868
|
-
export declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
|
|
1869
|
-
export interface EventUpdatedEnvelope {
|
|
1870
|
-
entity: Event;
|
|
1871
|
-
metadata: EventMetadata;
|
|
1872
|
-
}
|
|
1873
|
-
/**
|
|
1874
|
-
* Triggered when an event is updated, including when it's canceled.
|
|
1875
|
-
*
|
|
1876
|
-
* Not triggered when `INSTANCE` events are updated. You can use the
|
|
1877
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1878
|
-
* to get notified about `INSTANCE` events.
|
|
2196
|
+
* @permissionScope Read Bookings Calendar
|
|
2197
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
1879
2198
|
* @permissionScope Read Calendar - Including PI
|
|
1880
2199
|
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1881
2200
|
* @permissionScope Manage Calendars
|
|
@@ -1884,15 +2203,66 @@ export interface EventUpdatedEnvelope {
|
|
|
1884
2203
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1885
2204
|
* @permissionScope Read Bookings - Including Participants
|
|
1886
2205
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2206
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2207
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2208
|
+
* @permissionScope Manage Bookings - all permissions
|
|
2209
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1887
2210
|
* @permissionScope Read bookings calendar - including participants
|
|
1888
2211
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1889
|
-
* @
|
|
1890
|
-
* @
|
|
1891
|
-
* @
|
|
1892
|
-
* @slug updated
|
|
1893
|
-
* @documentationMaturity preview
|
|
2212
|
+
* @applicableIdentity APP
|
|
2213
|
+
* @applicableIdentity VISITOR
|
|
2214
|
+
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
|
|
1894
2215
|
*/
|
|
1895
|
-
export declare function
|
|
2216
|
+
export declare function listEventsByMemberId(memberId: string | null, options?: ListEventsByMemberIdOptions): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
|
|
2217
|
+
export interface ListEventsByMemberIdOptions {
|
|
2218
|
+
/**
|
|
2219
|
+
* Local start date and time from which events are returned in
|
|
2220
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
2221
|
+
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
2222
|
+
*
|
|
2223
|
+
* Events that start before the `fromLocalDate` but end after it are included in
|
|
2224
|
+
* the results. Must be earlier than `toLocalDate`.
|
|
2225
|
+
* @format LOCAL_DATE_TIME
|
|
2226
|
+
*/
|
|
2227
|
+
fromLocalDate?: string | null;
|
|
2228
|
+
/**
|
|
2229
|
+
* Local end date and time up to which events are returned in
|
|
2230
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
2231
|
+
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
2232
|
+
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
2233
|
+
*
|
|
2234
|
+
* Events that start before `toLocalDate` but end after it are included in the
|
|
2235
|
+
* results. Must be later than `fromLocalDate`.
|
|
2236
|
+
* @format LOCAL_DATE_TIME
|
|
2237
|
+
*/
|
|
2238
|
+
toLocalDate?: string | null;
|
|
2239
|
+
/**
|
|
2240
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2241
|
+
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
2242
|
+
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
2243
|
+
*
|
|
2244
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
2245
|
+
*/
|
|
2246
|
+
timeZone?: string | null;
|
|
2247
|
+
/**
|
|
2248
|
+
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
2249
|
+
* to filter events by.
|
|
2250
|
+
* @format GUID
|
|
2251
|
+
*/
|
|
2252
|
+
appId?: string | null;
|
|
2253
|
+
/** Cursor to retrieve the next page of the results. */
|
|
2254
|
+
cursorPaging?: CommonCursorPaging;
|
|
2255
|
+
/**
|
|
2256
|
+
* IDs of the events to retrieve.
|
|
2257
|
+
* If you provide a list of IDs, all other filters are ignored.
|
|
2258
|
+
*
|
|
2259
|
+
* Max: 100 `eventId`s
|
|
2260
|
+
* @maxSize 100
|
|
2261
|
+
* @minLength 36
|
|
2262
|
+
* @maxLength 250
|
|
2263
|
+
*/
|
|
2264
|
+
eventIds?: string[];
|
|
2265
|
+
}
|
|
1896
2266
|
/**
|
|
1897
2267
|
* Retrieves an event.
|
|
1898
2268
|
* @param eventId - ID of the event to retrieve.
|
|
@@ -1934,6 +2304,8 @@ export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) =>
|
|
|
1934
2304
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1935
2305
|
* @permissionScope Read Bookings - Including Participants
|
|
1936
2306
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2307
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2308
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1937
2309
|
* @permissionScope Manage Bookings - all permissions
|
|
1938
2310
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1939
2311
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -1964,6 +2336,7 @@ export interface GetEventOptions {
|
|
|
1964
2336
|
*
|
|
1965
2337
|
* Max: 1 field
|
|
1966
2338
|
* Default: No personal data is returned.
|
|
2339
|
+
* @maxSize 1
|
|
1967
2340
|
*/
|
|
1968
2341
|
fields?: RequestedFields[];
|
|
1969
2342
|
}
|
|
@@ -2008,6 +2381,8 @@ export interface GetEventOptions {
|
|
|
2008
2381
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2009
2382
|
* @permissionScope Read Bookings - Including Participants
|
|
2010
2383
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2384
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2385
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2011
2386
|
* @permissionScope Manage Bookings - all permissions
|
|
2012
2387
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2013
2388
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -2037,6 +2412,7 @@ export interface ListEventsOptions {
|
|
|
2037
2412
|
*
|
|
2038
2413
|
* Max: 1 field
|
|
2039
2414
|
* Default: No personal data is returned.
|
|
2415
|
+
* @maxSize 1
|
|
2040
2416
|
*/
|
|
2041
2417
|
fields?: RequestedFields[];
|
|
2042
2418
|
}
|
|
@@ -2090,6 +2466,8 @@ export interface ListEventsOptions {
|
|
|
2090
2466
|
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2091
2467
|
* @permissionScope Read Bookings - Including Participants
|
|
2092
2468
|
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2469
|
+
* @permissionScope Read Bookings - all read permissions
|
|
2470
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2093
2471
|
* @permissionScope Manage Bookings - all permissions
|
|
2094
2472
|
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2095
2473
|
* @permissionScope Read bookings calendar - including participants
|
|
@@ -2110,6 +2488,7 @@ export interface QueryEventsOptions {
|
|
|
2110
2488
|
* Events that start before the `fromLocalDate` but end after it are included in
|
|
2111
2489
|
* the results. Must be earlier than `toLocalDate` unless the sort order is
|
|
2112
2490
|
* descending.
|
|
2491
|
+
* @format LOCAL_DATE_TIME
|
|
2113
2492
|
*/
|
|
2114
2493
|
fromLocalDate?: string | null | undefined;
|
|
2115
2494
|
/**
|
|
@@ -2120,6 +2499,7 @@ export interface QueryEventsOptions {
|
|
|
2120
2499
|
* Events that start before `toLocalDate` but end after it are included in the
|
|
2121
2500
|
* results. Must be later than `fromLocalDate` unless the sort order is
|
|
2122
2501
|
* descending.
|
|
2502
|
+
* @format LOCAL_DATE_TIME
|
|
2123
2503
|
*/
|
|
2124
2504
|
toLocalDate?: string | null | undefined;
|
|
2125
2505
|
/**
|
|
@@ -2135,6 +2515,7 @@ export interface QueryEventsOptions {
|
|
|
2135
2515
|
*
|
|
2136
2516
|
* Max: 5 recurrence types can be specified.
|
|
2137
2517
|
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
2518
|
+
* @maxSize 5
|
|
2138
2519
|
*/
|
|
2139
2520
|
recurrenceType?: RecurrenceType[] | undefined;
|
|
2140
2521
|
/**
|
|
@@ -2148,11 +2529,12 @@ export interface QueryEventsOptions {
|
|
|
2148
2529
|
*
|
|
2149
2530
|
* Max: 1 field
|
|
2150
2531
|
* Default: No personal data is returned.
|
|
2532
|
+
* @maxSize 1
|
|
2151
2533
|
*/
|
|
2152
2534
|
fields?: RequestedFields[] | undefined;
|
|
2153
2535
|
}
|
|
2154
2536
|
interface QueryCursorResult {
|
|
2155
|
-
cursors:
|
|
2537
|
+
cursors: CommonCursors;
|
|
2156
2538
|
hasNext: () => boolean;
|
|
2157
2539
|
hasPrev: () => boolean;
|
|
2158
2540
|
length: number;
|
|
@@ -2266,6 +2648,7 @@ export interface CreateEventOptions {
|
|
|
2266
2648
|
/**
|
|
2267
2649
|
* Idempotency key guaranteeing that you don't create the same event more
|
|
2268
2650
|
* than once.
|
|
2651
|
+
* @format GUID
|
|
2269
2652
|
*/
|
|
2270
2653
|
idempotencyKey?: string | null;
|
|
2271
2654
|
}
|
|
@@ -2387,6 +2770,8 @@ export declare function updateEvent(_id: string | null, event: UpdateEvent, opti
|
|
|
2387
2770
|
export interface UpdateEvent {
|
|
2388
2771
|
/**
|
|
2389
2772
|
* Event ID.
|
|
2773
|
+
* @minLength 36
|
|
2774
|
+
* @maxLength 250
|
|
2390
2775
|
* @readonly
|
|
2391
2776
|
*/
|
|
2392
2777
|
_id?: string | null;
|
|
@@ -2394,12 +2779,15 @@ export interface UpdateEvent {
|
|
|
2394
2779
|
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
2395
2780
|
* the event belongs to.
|
|
2396
2781
|
* After creating an event, you can't assign it to a different schedule.
|
|
2782
|
+
* @format GUID
|
|
2783
|
+
* @immutable
|
|
2397
2784
|
*/
|
|
2398
2785
|
scheduleId?: string | null;
|
|
2399
2786
|
/**
|
|
2400
2787
|
* ID of the external schedule the event belongs to.
|
|
2401
2788
|
*
|
|
2402
2789
|
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
2790
|
+
* @format GUID
|
|
2403
2791
|
* @readonly
|
|
2404
2792
|
*/
|
|
2405
2793
|
externalScheduleId?: string | null;
|
|
@@ -2419,6 +2807,7 @@ export interface UpdateEvent {
|
|
|
2419
2807
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
2420
2808
|
* + `CLASS`: Bookings class event.
|
|
2421
2809
|
* + `COURSE`: Bookings course event.
|
|
2810
|
+
* @immutable
|
|
2422
2811
|
*/
|
|
2423
2812
|
type?: string | null;
|
|
2424
2813
|
/**
|
|
@@ -2437,6 +2826,8 @@ export interface UpdateEvent {
|
|
|
2437
2826
|
*
|
|
2438
2827
|
* Min: 1 character
|
|
2439
2828
|
* Max: 200 characters
|
|
2829
|
+
* @minLength 1
|
|
2830
|
+
* @maxLength 200
|
|
2440
2831
|
*/
|
|
2441
2832
|
title?: string | null;
|
|
2442
2833
|
/** Information about when the event starts. */
|
|
@@ -2500,6 +2891,8 @@ export interface UpdateEvent {
|
|
|
2500
2891
|
/**
|
|
2501
2892
|
* ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
|
|
2502
2893
|
* and `EXCEPTION` events.
|
|
2894
|
+
* @minLength 64
|
|
2895
|
+
* @maxLength 64
|
|
2503
2896
|
* @readonly
|
|
2504
2897
|
*/
|
|
2505
2898
|
recurringEventId?: string | null;
|
|
@@ -2526,6 +2919,7 @@ export interface UpdateEvent {
|
|
|
2526
2919
|
* providing the service or the room where the appointment takes place.
|
|
2527
2920
|
*
|
|
2528
2921
|
* Max: 100 resources
|
|
2922
|
+
* @maxSize 100
|
|
2529
2923
|
*/
|
|
2530
2924
|
resources?: Resource[];
|
|
2531
2925
|
/**
|
|
@@ -2558,6 +2952,8 @@ export interface UpdateEvent {
|
|
|
2558
2952
|
*
|
|
2559
2953
|
* Min: 1 character
|
|
2560
2954
|
* Max: 5000 characters
|
|
2955
|
+
* @minLength 1
|
|
2956
|
+
* @maxLength 5000
|
|
2561
2957
|
*/
|
|
2562
2958
|
notes?: string | null;
|
|
2563
2959
|
/**
|
|
@@ -2571,6 +2967,7 @@ export interface UpdateEvent {
|
|
|
2571
2967
|
* ID of the app that owns the event. Identical to `appId` of the
|
|
2572
2968
|
* [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
2573
2969
|
* to which the event belongs.
|
|
2970
|
+
* @format GUID
|
|
2574
2971
|
* @readonly
|
|
2575
2972
|
*/
|
|
2576
2973
|
appId?: string | null;
|
|
@@ -2893,167 +3290,4 @@ export interface BulkCancelEventOptions {
|
|
|
2893
3290
|
*/
|
|
2894
3291
|
timeZone?: string | null;
|
|
2895
3292
|
}
|
|
2896
|
-
/**
|
|
2897
|
-
* Retrieves a list of events filtered by the participant's
|
|
2898
|
-
* [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
2899
|
-
* ID.
|
|
2900
|
-
*
|
|
2901
|
-
*
|
|
2902
|
-
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
2903
|
-
* `fromLocalDate`.
|
|
2904
|
-
* @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
2905
|
-
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
2906
|
-
* @public
|
|
2907
|
-
* @documentationMaturity preview
|
|
2908
|
-
* @requiredField contactId
|
|
2909
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2910
|
-
* @permissionScope Read Calendar - Including PI
|
|
2911
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2912
|
-
* @permissionScope Manage Calendars
|
|
2913
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2914
|
-
* @permissionScope Manage Bookings
|
|
2915
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2916
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2917
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2918
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2919
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2920
|
-
* @applicableIdentity APP
|
|
2921
|
-
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
|
|
2922
|
-
*/
|
|
2923
|
-
export declare function listEventsByContactId(contactId: string | null, options?: ListEventsByContactIdOptions): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
|
|
2924
|
-
export interface ListEventsByContactIdOptions {
|
|
2925
|
-
/**
|
|
2926
|
-
* Local start date and time from which events are returned in
|
|
2927
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
2928
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
2929
|
-
*
|
|
2930
|
-
* Events that start before the `fromLocalDate` but end after it are included in
|
|
2931
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
2932
|
-
*/
|
|
2933
|
-
fromLocalDate?: string | null;
|
|
2934
|
-
/**
|
|
2935
|
-
* Local end date and time up to which events are returned in
|
|
2936
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
2937
|
-
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
2938
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
2939
|
-
*
|
|
2940
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
2941
|
-
* results. Must be later than `fromLocalDate`.
|
|
2942
|
-
*/
|
|
2943
|
-
toLocalDate?: string | null;
|
|
2944
|
-
/**
|
|
2945
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2946
|
-
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
2947
|
-
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
2948
|
-
*
|
|
2949
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
2950
|
-
*/
|
|
2951
|
-
timeZone?: string | null;
|
|
2952
|
-
/**
|
|
2953
|
-
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
2954
|
-
* to filter events by.
|
|
2955
|
-
*/
|
|
2956
|
-
appId?: string | null;
|
|
2957
|
-
/** Cursor to retrieve the next page of the results. */
|
|
2958
|
-
cursorPaging?: CommonCursorPaging;
|
|
2959
|
-
}
|
|
2960
|
-
/**
|
|
2961
|
-
* Retrieves a list of events filtered by the participant's
|
|
2962
|
-
* [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
|
|
2963
|
-
* ID.
|
|
2964
|
-
*
|
|
2965
|
-
*
|
|
2966
|
-
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
2967
|
-
* `fromLocalDate`.
|
|
2968
|
-
* @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
2969
|
-
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
2970
|
-
* Provide `me` to retrieve events for the currently logged-in member.
|
|
2971
|
-
* You must have the `Read Calendars - Including PI`
|
|
2972
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
2973
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
2974
|
-
* @public
|
|
2975
|
-
* @documentationMaturity preview
|
|
2976
|
-
* @requiredField memberId
|
|
2977
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2978
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2979
|
-
* @permissionScope Read Bookings - Public Data
|
|
2980
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2981
|
-
* @permissionScope Read Calendar - Including PI
|
|
2982
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2983
|
-
* @permissionScope Manage Calendars
|
|
2984
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2985
|
-
* @permissionScope Manage Bookings
|
|
2986
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2987
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2988
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2989
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2990
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2991
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2992
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2993
|
-
* @permissionScope Read Calendar
|
|
2994
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2995
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2996
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2997
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2998
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2999
|
-
* @permissionScope Read Bookings Calendar
|
|
3000
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
3001
|
-
* @permissionScope Read Calendar - Including PI
|
|
3002
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
3003
|
-
* @permissionScope Manage Calendars
|
|
3004
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3005
|
-
* @permissionScope Manage Bookings
|
|
3006
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3007
|
-
* @permissionScope Read Bookings - Including Participants
|
|
3008
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
3009
|
-
* @permissionScope Read bookings calendar - including participants
|
|
3010
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
3011
|
-
* @applicableIdentity APP
|
|
3012
|
-
* @applicableIdentity VISITOR
|
|
3013
|
-
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
|
|
3014
|
-
*/
|
|
3015
|
-
export declare function listEventsByMemberId(memberId: string | null, options?: ListEventsByMemberIdOptions): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
|
|
3016
|
-
export interface ListEventsByMemberIdOptions {
|
|
3017
|
-
/**
|
|
3018
|
-
* Local start date and time from which events are returned in
|
|
3019
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
3020
|
-
* `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
3021
|
-
*
|
|
3022
|
-
* Events that start before the `fromLocalDate` but end after it are included in
|
|
3023
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
3024
|
-
*/
|
|
3025
|
-
fromLocalDate?: string | null;
|
|
3026
|
-
/**
|
|
3027
|
-
* Local end date and time up to which events are returned in
|
|
3028
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
3029
|
-
* `2024-01-30T13:30:00`. Can't be more than a full year after
|
|
3030
|
-
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
3031
|
-
*
|
|
3032
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
3033
|
-
* results. Must be later than `fromLocalDate`.
|
|
3034
|
-
*/
|
|
3035
|
-
toLocalDate?: string | null;
|
|
3036
|
-
/**
|
|
3037
|
-
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
3038
|
-
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
3039
|
-
* `adjustedEnd`. For example, `America/New_York` or `UTC`.
|
|
3040
|
-
*
|
|
3041
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
3042
|
-
*/
|
|
3043
|
-
timeZone?: string | null;
|
|
3044
|
-
/**
|
|
3045
|
-
* [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
|
|
3046
|
-
* to filter events by.
|
|
3047
|
-
*/
|
|
3048
|
-
appId?: string | null;
|
|
3049
|
-
/** Cursor to retrieve the next page of the results. */
|
|
3050
|
-
cursorPaging?: CommonCursorPaging;
|
|
3051
|
-
/**
|
|
3052
|
-
* IDs of the events to retrieve.
|
|
3053
|
-
* If you provide a list of IDs, all other filters are ignored.
|
|
3054
|
-
*
|
|
3055
|
-
* Max: 100 `eventId`s
|
|
3056
|
-
*/
|
|
3057
|
-
eventIds?: string[];
|
|
3058
|
-
}
|
|
3059
3293
|
export {};
|