@wix/auto_sdk_calendar_events 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/build/cjs/src/calendar-v3-event-events.context.d.ts +5 -5
  2. package/build/cjs/src/calendar-v3-event-events.context.js +5 -5
  3. package/build/cjs/src/calendar-v3-event-events.context.js.map +1 -1
  4. package/build/cjs/src/calendar-v3-event-events.http.d.ts +20 -20
  5. package/build/cjs/src/calendar-v3-event-events.http.js +123 -123
  6. package/build/cjs/src/calendar-v3-event-events.http.js.map +1 -1
  7. package/build/cjs/src/calendar-v3-event-events.meta.d.ts +6 -6
  8. package/build/cjs/src/calendar-v3-event-events.meta.js +39 -39
  9. package/build/cjs/src/calendar-v3-event-events.meta.js.map +1 -1
  10. package/build/cjs/src/calendar-v3-event-events.public.d.ts +34 -34
  11. package/build/cjs/src/calendar-v3-event-events.public.js +13 -13
  12. package/build/cjs/src/calendar-v3-event-events.public.js.map +1 -1
  13. package/build/cjs/src/calendar-v3-event-events.types.d.ts +713 -553
  14. package/build/cjs/src/calendar-v3-event-events.types.js +14 -14
  15. package/build/cjs/src/calendar-v3-event-events.types.js.map +1 -1
  16. package/build/cjs/src/calendar-v3-event-events.universal.d.ts +1117 -891
  17. package/build/cjs/src/calendar-v3-event-events.universal.js +184 -170
  18. package/build/cjs/src/calendar-v3-event-events.universal.js.map +1 -1
  19. package/build/es/src/calendar-v3-event-events.context.d.ts +5 -5
  20. package/build/es/src/calendar-v3-event-events.context.js +4 -4
  21. package/build/es/src/calendar-v3-event-events.context.js.map +1 -1
  22. package/build/es/src/calendar-v3-event-events.http.d.ts +20 -20
  23. package/build/es/src/calendar-v3-event-events.http.js +120 -120
  24. package/build/es/src/calendar-v3-event-events.http.js.map +1 -1
  25. package/build/es/src/calendar-v3-event-events.meta.d.ts +6 -6
  26. package/build/es/src/calendar-v3-event-events.meta.js +36 -36
  27. package/build/es/src/calendar-v3-event-events.meta.js.map +1 -1
  28. package/build/es/src/calendar-v3-event-events.public.d.ts +34 -34
  29. package/build/es/src/calendar-v3-event-events.public.js +10 -10
  30. package/build/es/src/calendar-v3-event-events.public.js.map +1 -1
  31. package/build/es/src/calendar-v3-event-events.types.d.ts +713 -553
  32. package/build/es/src/calendar-v3-event-events.types.js +13 -13
  33. package/build/es/src/calendar-v3-event-events.types.js.map +1 -1
  34. package/build/es/src/calendar-v3-event-events.universal.d.ts +1117 -891
  35. package/build/es/src/calendar-v3-event-events.universal.js +181 -167
  36. package/build/es/src/calendar-v3-event-events.universal.js.map +1 -1
  37. package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +5 -5
  38. package/build/internal/cjs/src/calendar-v3-event-events.context.js +5 -5
  39. package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +1 -1
  40. package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +20 -20
  41. package/build/internal/cjs/src/calendar-v3-event-events.http.js +123 -123
  42. package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +1 -1
  43. package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +6 -6
  44. package/build/internal/cjs/src/calendar-v3-event-events.meta.js +39 -39
  45. package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +1 -1
  46. package/build/internal/cjs/src/calendar-v3-event-events.public.d.ts +34 -34
  47. package/build/internal/cjs/src/calendar-v3-event-events.public.js +13 -13
  48. package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +1 -1
  49. package/build/internal/cjs/src/calendar-v3-event-events.types.d.ts +713 -553
  50. package/build/internal/cjs/src/calendar-v3-event-events.types.js +14 -14
  51. package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +1 -1
  52. package/build/internal/cjs/src/calendar-v3-event-events.universal.d.ts +1117 -891
  53. package/build/internal/cjs/src/calendar-v3-event-events.universal.js +184 -170
  54. package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +1 -1
  55. package/build/internal/es/src/calendar-v3-event-events.context.d.ts +5 -5
  56. package/build/internal/es/src/calendar-v3-event-events.context.js +4 -4
  57. package/build/internal/es/src/calendar-v3-event-events.context.js.map +1 -1
  58. package/build/internal/es/src/calendar-v3-event-events.http.d.ts +20 -20
  59. package/build/internal/es/src/calendar-v3-event-events.http.js +120 -120
  60. package/build/internal/es/src/calendar-v3-event-events.http.js.map +1 -1
  61. package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +6 -6
  62. package/build/internal/es/src/calendar-v3-event-events.meta.js +36 -36
  63. package/build/internal/es/src/calendar-v3-event-events.meta.js.map +1 -1
  64. package/build/internal/es/src/calendar-v3-event-events.public.d.ts +34 -34
  65. package/build/internal/es/src/calendar-v3-event-events.public.js +10 -10
  66. package/build/internal/es/src/calendar-v3-event-events.public.js.map +1 -1
  67. package/build/internal/es/src/calendar-v3-event-events.types.d.ts +713 -553
  68. package/build/internal/es/src/calendar-v3-event-events.types.js +13 -13
  69. package/build/internal/es/src/calendar-v3-event-events.types.js.map +1 -1
  70. package/build/internal/es/src/calendar-v3-event-events.universal.d.ts +1117 -891
  71. package/build/internal/es/src/calendar-v3-event-events.universal.js +181 -167
  72. package/build/internal/es/src/calendar-v3-event-events.universal.js.map +1 -1
  73. 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
- /** Resource ID. */
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
- /** Participant's phone number. */
480
+ /**
481
+ * Participant's phone number.
482
+ * @format PHONE
483
+ */
451
484
  phone?: string | null;
452
- /** Participant's email address. */
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,10 +634,12 @@ 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
  }
593
- /** `PRIVATE` until we'll have standard events metadata from Infra. */
642
+ /** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
594
643
  export interface EventUpdatedWithMetadata {
595
644
  /** The updated event. */
596
645
  event?: Event;
@@ -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,14 +668,18 @@ 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
  }
@@ -702,9 +756,15 @@ export interface ActionEvent {
702
756
  body?: string;
703
757
  }
704
758
  export interface MessageEnvelope {
705
- /** App instance ID. */
759
+ /**
760
+ * App instance ID.
761
+ * @format GUID
762
+ */
706
763
  instanceId?: string | null;
707
- /** Event type. */
764
+ /**
765
+ * Event type.
766
+ * @maxLength 150
767
+ */
708
768
  eventType?: string;
709
769
  /** The identification type and identity data. */
710
770
  identity?: IdentificationData;
@@ -712,26 +772,50 @@ export interface MessageEnvelope {
712
772
  data?: string;
713
773
  }
714
774
  export interface IdentificationData extends IdentificationDataIdOneOf {
715
- /** ID of a site visitor that has not logged in to the site. */
775
+ /**
776
+ * ID of a site visitor that has not logged in to the site.
777
+ * @format GUID
778
+ */
716
779
  anonymousVisitorId?: string;
717
- /** ID of a site visitor that has logged in to the site. */
780
+ /**
781
+ * ID of a site visitor that has logged in to the site.
782
+ * @format GUID
783
+ */
718
784
  memberId?: string;
719
- /** ID of a Wix user (site owner, contributor, etc.). */
785
+ /**
786
+ * ID of a Wix user (site owner, contributor, etc.).
787
+ * @format GUID
788
+ */
720
789
  wixUserId?: string;
721
- /** ID of an app. */
790
+ /**
791
+ * ID of an app.
792
+ * @format GUID
793
+ */
722
794
  appId?: string;
723
795
  /** @readonly */
724
796
  identityType?: WebhookIdentityType;
725
797
  }
726
798
  /** @oneof */
727
799
  export interface IdentificationDataIdOneOf {
728
- /** ID of a site visitor that has not logged in to the site. */
800
+ /**
801
+ * ID of a site visitor that has not logged in to the site.
802
+ * @format GUID
803
+ */
729
804
  anonymousVisitorId?: string;
730
- /** ID of a site visitor that has logged in to the site. */
805
+ /**
806
+ * ID of a site visitor that has logged in to the site.
807
+ * @format GUID
808
+ */
731
809
  memberId?: string;
732
- /** ID of a Wix user (site owner, contributor, etc.). */
810
+ /**
811
+ * ID of a Wix user (site owner, contributor, etc.).
812
+ * @format GUID
813
+ */
733
814
  wixUserId?: string;
734
- /** ID of an app. */
815
+ /**
816
+ * ID of an app.
817
+ * @format GUID
818
+ */
735
819
  appId?: string;
736
820
  }
737
821
  export declare enum WebhookIdentityType {
@@ -741,100 +825,32 @@ export declare enum WebhookIdentityType {
741
825
  WIX_USER = "WIX_USER",
742
826
  APP = "APP"
743
827
  }
744
- export interface GetEventRequest {
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;
828
+ export interface ListEventsByContactIdRequest {
801
829
  /**
802
- * Information about which fields containing personal data to return. Refer to the
803
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
804
- * for more information.
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.
830
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
831
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
832
+ * @format GUID
812
833
  */
813
- fields?: RequestedFields[];
814
- }
815
- export interface ListEventsResponse {
816
- /** Retrieved events matching the provided IDs. */
817
- events?: Event[];
818
- }
819
- export interface QueryEventsRequest {
834
+ contactId: string | null;
820
835
  /**
821
836
  * Local start date and time from which events are returned in
822
837
  * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
823
- * `2024-01-30T13:30:00`.
838
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
824
839
  *
825
840
  * Events that start before the `fromLocalDate` but end after it are included in
826
- * the results. Must be earlier than `toLocalDate` unless the sort order is
827
- * descending.
841
+ * the results. Must be earlier than `toLocalDate`.
842
+ * @format LOCAL_DATE_TIME
828
843
  */
829
844
  fromLocalDate?: string | null;
830
845
  /**
831
846
  * Local end date and time up to which events are returned in
832
847
  * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
833
- * `2024-01-30T13:30:00`.
848
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
849
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
834
850
  *
835
851
  * Events that start before `toLocalDate` but end after it are included in the
836
- * results. Must be later than `fromLocalDate` unless the sort order is
837
- * descending.
852
+ * results. Must be later than `fromLocalDate`.
853
+ * @format LOCAL_DATE_TIME
838
854
  */
839
855
  toLocalDate?: string | null;
840
856
  /**
@@ -845,74 +861,22 @@ export interface QueryEventsRequest {
845
861
  * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
846
862
  */
847
863
  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
864
  /**
899
- * The field to sort by.
900
- * Either `start` or `end`.
901
- * Default is `start`.
865
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
866
+ * to filter events by.
867
+ * @format GUID
902
868
  */
903
- fieldName?: string;
904
- /** Sort order. */
905
- order?: SortOrder;
906
- }
907
- export declare enum SortOrder {
908
- ASC = "ASC",
909
- DESC = "DESC"
869
+ appId?: string | null;
870
+ /** Cursor to retrieve the next page of the results. */
871
+ cursorPaging?: CommonCursorPaging;
910
872
  }
911
873
  /** TODO Diverge */
912
- export interface CursorPaging {
874
+ export interface CommonCursorPaging {
913
875
  /**
914
876
  * Number of events to return.
915
- * Defaults to `50`. Maximum `1000`.
877
+ * Defaults to `50`. Maximum `100`.
878
+ * @min 1
879
+ * @max 100
916
880
  */
917
881
  limit?: number | null;
918
882
  /**
@@ -924,18 +888,18 @@ export interface CursorPaging {
924
888
  */
925
889
  cursor?: string | null;
926
890
  }
927
- export interface QueryEventsResponse {
928
- /** Retrieved events matching the provided query. */
891
+ export interface ListEventsByContactIdResponse {
892
+ /** Retrieved events. */
929
893
  events?: Event[];
930
894
  /** Paging metadata. */
931
- pagingMetadata?: CursorPagingMetadata;
895
+ pagingMetadata?: CommonCursorPagingMetadata;
932
896
  }
933
897
  /** TODO Diverge */
934
- export interface CursorPagingMetadata {
898
+ export interface CommonCursorPagingMetadata {
935
899
  /** Number of items returned in the response. */
936
900
  count?: number | null;
937
901
  /** 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?: Cursors;
902
+ cursors?: CommonCursors;
939
903
  /**
940
904
  * Indicates if there are more results after the current page.
941
905
  * If `true`, another page of results can be retrieved.
@@ -943,266 +907,366 @@ export interface CursorPagingMetadata {
943
907
  */
944
908
  hasNext?: boolean | null;
945
909
  }
946
- export interface Cursors {
910
+ export interface CommonCursors {
947
911
  /** Cursor pointing to next page in the list of results. */
948
912
  next?: string | null;
949
913
  }
950
- export interface ListRecurringEventInstancesHistoryRequest {
951
- /**
952
- * The ID of the recurring event.
953
- * Required, unless `cursorPaging` is provided.
954
- */
955
- recurringEventId?: string | null;
914
+ export interface ListEventsByMemberIdRequest {
956
915
  /**
957
- * The revision of the recurring event.
958
- * Required, unless `cursorPaging` is provided.
916
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
917
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
918
+ * Provide `me` to retrieve events for the currently logged-in member.
919
+ * You must have the `Read Calendars - Including PI`
920
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
921
+ * to retrieve events for members who aren't the currently logged in member.
922
+ * @minLength 2
923
+ * @maxLength 36
959
924
  */
960
- revision?: string | null;
925
+ memberId: string | null;
961
926
  /**
962
- * Inclusive start date for which events are returned, in ISO-8601 format.
963
- * Events that begin at or after the `fromDate` are included in the results.
964
- * Required, unless `cursorPaging` is provided.
927
+ * Local start date and time from which events are returned in
928
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
929
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
930
+ *
931
+ * Events that start before the `fromLocalDate` but end after it are included in
932
+ * the results. Must be earlier than `toLocalDate`.
933
+ * @format LOCAL_DATE_TIME
965
934
  */
966
- fromDate?: Date | null;
935
+ fromLocalDate?: string | null;
967
936
  /**
968
- * Exclusive end date for which events are returned, in ISO-8601 format.
969
- * Events that begin before the `toDate` are included in the results.
970
- * Required, unless `cursorPaging` is provided.
937
+ * Local end date and time up to which events are returned in
938
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
939
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
940
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
941
+ *
942
+ * Events that start before `toLocalDate` but end after it are included in the
943
+ * results. Must be later than `fromLocalDate`.
944
+ * @format LOCAL_DATE_TIME
971
945
  */
972
- toDate?: Date | null;
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;
946
+ toLocalDate?: string | null;
985
947
  /**
986
948
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
987
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
988
- * `America/New_York` or `UTC`.
949
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
950
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
989
951
  *
990
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
952
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
991
953
  */
992
954
  timeZone?: string | null;
993
955
  /**
994
- * Idempotency key guaranteeing that you don't create the same event more
995
- * than once.
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`.
956
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
957
+ * to filter events by.
958
+ * @format GUID
1010
959
  */
1011
- returnEntity?: boolean | null;
960
+ appId?: string | null;
961
+ /** Cursor to retrieve the next page of the results. */
962
+ cursorPaging?: CommonCursorPaging;
1012
963
  /**
1013
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1014
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1015
- * `America/New_York` or `UTC`.
964
+ * IDs of the events to retrieve.
965
+ * If you provide a list of IDs, all other filters are ignored.
1016
966
  *
1017
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
967
+ * Max: 100 `eventId`s
968
+ * @maxSize 100
969
+ * @minLength 36
970
+ * @maxLength 250
1018
971
  */
1019
- timeZone?: string | null;
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;
972
+ eventIds?: string[];
1030
973
  }
1031
- export interface BulkEventResult {
1032
- /** Whether the requested action was successful. */
1033
- itemMetadata?: ItemMetadata;
1034
- /** The event. */
1035
- item?: Event;
974
+ export interface ListEventsByMemberIdResponse {
975
+ /** Retrieved events. */
976
+ events?: Event[];
977
+ /** Paging metadata. */
978
+ pagingMetadata?: CommonCursorPagingMetadata;
1036
979
  }
1037
- export interface ItemMetadata {
1038
- /**
1039
- * Event ID.
1040
- * Should always be available, unless it's impossible (for example, when failing to create an event).
1041
- */
1042
- _id?: string | null;
1043
- /** Index of the item within the request array, for correlation between request and response items. */
1044
- originalIndex?: number;
980
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
981
+ export interface SitePropertiesNotification {
982
+ /** The site ID for which this update notification applies. */
983
+ metasiteId?: string;
984
+ /** The actual update event. */
985
+ event?: SitePropertiesEvent;
1045
986
  /**
1046
- * Whether the requested action was successful for this event.
1047
- * When `false`, the `error` field is populated.
987
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
988
+ * @maxSize 500
1048
989
  */
1049
- success?: boolean;
1050
- /** Details about the error in case of failure. */
1051
- error?: ApplicationError;
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;
990
+ translations?: Translation[];
991
+ /** Context of the notification */
992
+ changeContext?: ChangeContext;
1060
993
  }
1061
- export interface BulkActionMetadata {
1062
- /** Number of events that were successfully processed. */
1063
- totalSuccesses?: number;
1064
- /** Number of events that couldn't be processed. */
1065
- totalFailures?: number;
994
+ /** The actual update event for a particular notification. */
995
+ export interface SitePropertiesEvent {
996
+ /** Version of the site's properties represented by this update. */
997
+ version?: number;
998
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
999
+ fields?: string[];
1000
+ /** Updated properties. */
1001
+ properties?: Properties;
1066
1002
  }
1067
- export interface UpdateEventRequest {
1068
- /** Event to update. */
1069
- event: Event;
1003
+ export interface Properties {
1004
+ /** Site categories. */
1005
+ categories?: Categories;
1006
+ /** Site locale. */
1007
+ locale?: Locale;
1070
1008
  /**
1071
- * Information about whether participants of the updated event are notified and
1072
- * the message they receive.
1009
+ * Site language.
1010
+ *
1011
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1073
1012
  */
1074
- participantNotification?: ParticipantNotification;
1013
+ language?: string | null;
1075
1014
  /**
1076
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1077
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1078
- * `America/New_York` or `UTC`.
1015
+ * Site currency format used to bill customers.
1079
1016
  *
1080
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1017
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1081
1018
  */
1019
+ paymentCurrency?: string | null;
1020
+ /** Timezone in `America/New_York` format. */
1082
1021
  timeZone?: string | null;
1083
- }
1084
- export interface UpdateEventResponse {
1085
- /** Updated event. */
1086
- event?: Event;
1087
- }
1088
- export interface BulkUpdateEventRequest {
1022
+ /** Email address. */
1023
+ email?: string | null;
1024
+ /** Phone number. */
1025
+ phone?: string | null;
1026
+ /** Fax number. */
1027
+ fax?: string | null;
1028
+ /** Address. */
1029
+ address?: Address;
1030
+ /** Site display name. */
1031
+ siteDisplayName?: string | null;
1032
+ /** Business name. */
1033
+ businessName?: string | null;
1034
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
1035
+ logo?: string | null;
1036
+ /** Site description. */
1037
+ description?: string | null;
1089
1038
  /**
1090
- * Events to update.
1039
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
1091
1040
  *
1092
- * Min: 1 event
1093
- * Max: 50 events
1041
+ * __Note:__ Not supported by Wix Bookings.
1094
1042
  */
1095
- events: BulkUpdateEventRequestMaskedEvent[];
1043
+ businessSchedule?: BusinessSchedule;
1044
+ /** Supported languages of a site and the primary language. */
1045
+ multilingual?: Multilingual;
1046
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
1047
+ consentPolicy?: ConsentPolicy;
1096
1048
  /**
1097
- * Whether to return the updated events.
1049
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
1098
1050
  *
1099
- * Default: `false`
1100
- */
1101
- returnEntity?: boolean | null;
1102
- /**
1103
- * Information about whether participants of the updated event are notified and
1104
- * the message they receive.
1051
+ * Site business type.
1105
1052
  */
1106
- participantNotification?: ParticipantNotification;
1053
+ businessConfig?: string | null;
1054
+ /** External site URL that uses Wix as its headless business solution. */
1055
+ externalSiteUrl?: string | null;
1056
+ /** Track clicks analytics. */
1057
+ trackClicksAnalytics?: boolean;
1058
+ }
1059
+ export interface Categories {
1060
+ /** Primary site category. */
1061
+ primary?: string;
1107
1062
  /**
1108
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1109
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
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).
1063
+ * Secondary site category.
1064
+ * @maxSize 50
1113
1065
  */
1114
- timeZone?: string | null;
1115
- }
1116
- export interface BulkUpdateEventRequestMaskedEvent {
1117
- /** Event to update. */
1118
- event?: Event;
1066
+ secondary?: string[];
1067
+ /** Business Term Id */
1068
+ businessTermId?: string | null;
1119
1069
  }
1120
- export interface BulkUpdateEventResponse {
1121
- /** The result for each event, containing the event and whether the action was successful. */
1122
- results?: BulkEventResult[];
1123
- /** Total successes and failures. */
1124
- bulkActionMetadata?: BulkActionMetadata;
1070
+ export interface Locale {
1071
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1072
+ languageCode?: string;
1073
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1074
+ country?: string;
1125
1075
  }
1126
- export interface UpdateEventParticipantsRequest {
1076
+ export interface Address {
1077
+ /** Street name. */
1078
+ street?: string;
1079
+ /** City name. */
1080
+ city?: string;
1081
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1082
+ country?: string;
1083
+ /** State. */
1084
+ state?: string;
1127
1085
  /**
1128
- * ID of the event to update.
1129
- *
1130
- * Min: 36 characters
1131
- * Max: 250 characters
1086
+ * Zip or postal code.
1087
+ * @maxLength 20
1132
1088
  */
1133
- eventId?: string | null;
1134
- /** The participants to update. */
1135
- participants?: Participants;
1089
+ zip?: string;
1090
+ /** Extra information to be displayed in the address. */
1091
+ hint?: AddressHint;
1092
+ /** Whether this address represents a physical location. */
1093
+ isPhysical?: boolean;
1094
+ /** Google-formatted version of this address. */
1095
+ googleFormattedAddress?: string;
1096
+ /** Street number. */
1097
+ streetNumber?: string;
1098
+ /** Apartment number. */
1099
+ apartmentNumber?: string;
1100
+ /** Geographic coordinates of location. */
1101
+ coordinates?: GeoCoordinates;
1136
1102
  }
1137
- export interface UpdateEventParticipantsResponse {
1138
- /** Updated event. */
1139
- event?: Event;
1103
+ /**
1104
+ * Extra information on displayed addresses.
1105
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
1106
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
1107
+ */
1108
+ export interface AddressHint {
1109
+ /** Extra text displayed next to, or instead of, the actual address. */
1110
+ text?: string;
1111
+ /** Where the extra text should be displayed. */
1112
+ placement?: PlacementType;
1140
1113
  }
1141
- export interface RestoreEventDefaultsRequest {
1142
- /** ID of the event for which to restore default values. */
1143
- eventId: string | null;
1114
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
1115
+ export declare enum PlacementType {
1116
+ BEFORE = "BEFORE",
1117
+ AFTER = "AFTER",
1118
+ REPLACE = "REPLACE"
1119
+ }
1120
+ /** Geocoordinates for a particular address. */
1121
+ export interface GeoCoordinates {
1122
+ /** Latitude of the location. Must be between -90 and 90. */
1123
+ latitude?: number;
1124
+ /** Longitude of the location. Must be between -180 and 180. */
1125
+ longitude?: number;
1126
+ }
1127
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1128
+ export interface BusinessSchedule {
1144
1129
  /**
1145
- * Fields for which to restore default values.
1146
- *
1147
- * `TIME` restores default values for `start` and `end`.
1148
- *
1149
- * Min: 1 field
1130
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
1131
+ * @maxSize 100
1150
1132
  */
1151
- fields: Field[];
1133
+ periods?: TimePeriod[];
1152
1134
  /**
1153
- * Information about whether participants of the updated event are notified and
1154
- * the message they receive.
1135
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
1136
+ * @maxSize 100
1155
1137
  */
1156
- participantNotification?: ParticipantNotification;
1138
+ specialHourPeriod?: SpecialHourPeriod[];
1139
+ }
1140
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
1141
+ export interface TimePeriod {
1142
+ /** Day of the week the period starts on. */
1143
+ openDay?: DayOfWeek;
1157
1144
  /**
1158
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1159
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1160
- * `America/New_York` or `UTC`.
1145
+ * 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
1146
+ * midnight at the end of the specified day.
1147
+ */
1148
+ openTime?: string;
1149
+ /** Day of the week the period ends on. */
1150
+ closeDay?: DayOfWeek;
1151
+ /**
1152
+ * 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
1153
+ * midnight at the end of the specified day.
1161
1154
  *
1162
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1155
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
1163
1156
  */
1164
- timeZone?: string | null;
1157
+ closeTime?: string;
1165
1158
  }
1166
- export interface RestoreEventDefaultsResponse {
1167
- /** Updated event. */
1168
- event?: Event;
1159
+ /** Enumerates the days of the week. */
1160
+ export declare enum DayOfWeek {
1161
+ MONDAY = "MONDAY",
1162
+ TUESDAY = "TUESDAY",
1163
+ WEDNESDAY = "WEDNESDAY",
1164
+ THURSDAY = "THURSDAY",
1165
+ FRIDAY = "FRIDAY",
1166
+ SATURDAY = "SATURDAY",
1167
+ SUNDAY = "SUNDAY"
1169
1168
  }
1170
- export interface SplitRecurringEventRequest {
1171
- /** ID of the `MASTER` event to split. */
1172
- recurringEventId: string | null;
1169
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1170
+ export interface SpecialHourPeriod {
1171
+ /** 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). */
1172
+ startDate?: string;
1173
+ /** 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). */
1174
+ endDate?: string;
1173
1175
  /**
1174
- * Local date and time at which the `MASTER` event is split in
1175
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1176
- * `2025-03-11T09:00:00`.
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.
1176
+ * Whether the business is closed (or the service is not available) during the exception.
1177
+ *
1178
+ * Default: `true`.
1181
1179
  */
1182
- splitLocalDate: string | null;
1180
+ isClosed?: boolean;
1181
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
1182
+ comment?: string;
1183
+ }
1184
+ export interface Multilingual {
1183
1185
  /**
1184
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1185
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
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).
1186
+ * Supported languages list.
1187
+ * @maxSize 200
1189
1188
  */
1190
- timeZone?: string | null;
1189
+ supportedLanguages?: SupportedLanguage[];
1190
+ /** Whether to redirect to user language. */
1191
+ autoRedirect?: boolean;
1191
1192
  }
1192
- export interface SplitRecurringEventResponse {
1193
- /** Original `MASTER` event that was shortened. */
1194
- updatedRecurringEventEndingBeforeSplit?: Event;
1195
- /** New `MASTER` event starting with the first event after the split date. */
1196
- newRecurringEventStartingFromSplit?: Event;
1193
+ export interface SupportedLanguage {
1194
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1195
+ languageCode?: string;
1196
+ /** Locale. */
1197
+ locale?: Locale;
1198
+ /** Whether the supported language is the primary language for the site. */
1199
+ isPrimary?: boolean;
1200
+ /** Language icon. */
1201
+ countryCode?: string;
1202
+ /** How the language will be resolved. For internal use. */
1203
+ resolutionMethod?: ResolutionMethod;
1197
1204
  }
1198
- export interface CancelEventRequest {
1199
- /** ID of the event to cancel. */
1200
- eventId: string | null;
1205
+ export declare enum ResolutionMethod {
1206
+ QUERY_PARAM = "QUERY_PARAM",
1207
+ SUBDOMAIN = "SUBDOMAIN",
1208
+ SUBDIRECTORY = "SUBDIRECTORY"
1209
+ }
1210
+ export interface ConsentPolicy {
1211
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
1212
+ essential?: boolean | null;
1213
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
1214
+ functional?: boolean | null;
1215
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
1216
+ analytics?: boolean | null;
1217
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
1218
+ advertising?: boolean | null;
1219
+ /** CCPA compliance flag. */
1220
+ dataToThirdParty?: boolean | null;
1221
+ }
1222
+ /** A single mapping from the MetaSite ID to a particular service. */
1223
+ export interface Translation {
1224
+ /** The service type. */
1225
+ serviceType?: string;
1226
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
1227
+ appDefId?: string;
1228
+ /** The instance ID of the service. */
1229
+ instanceId?: string;
1230
+ }
1231
+ export interface ChangeContext extends ChangeContextPayloadOneOf {
1232
+ /** Properties were updated. */
1233
+ propertiesChange?: PropertiesChange;
1234
+ /** Default properties were created on site creation. */
1235
+ siteCreated?: SiteCreated;
1236
+ /** Properties were cloned on site cloning. */
1237
+ siteCloned?: SiteCloned;
1238
+ }
1239
+ /** @oneof */
1240
+ export interface ChangeContextPayloadOneOf {
1241
+ /** Properties were updated. */
1242
+ propertiesChange?: PropertiesChange;
1243
+ /** Default properties were created on site creation. */
1244
+ siteCreated?: SiteCreated;
1245
+ /** Properties were cloned on site cloning. */
1246
+ siteCloned?: SiteCloned;
1247
+ }
1248
+ export interface PropertiesChange {
1249
+ }
1250
+ export interface SiteCreated {
1251
+ /** Origin template site id. */
1252
+ originTemplateId?: string | null;
1253
+ }
1254
+ export interface SiteCloned {
1255
+ /** Origin site id. */
1256
+ originMetaSiteId?: string;
1257
+ }
1258
+ export interface Empty {
1259
+ }
1260
+ export interface GetEventRequest {
1201
1261
  /**
1202
- * Information about whether participants of the canceled event are notified and
1203
- * the message they receive.
1262
+ * ID of the event to retrieve.
1263
+ *
1264
+ * Min: 36 characters
1265
+ * Max: 250 characters
1266
+ * @minLength 36
1267
+ * @maxLength 250
1204
1268
  */
1205
- participantNotification?: ParticipantNotification;
1269
+ eventId: string | null;
1206
1270
  /**
1207
1271
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1208
1272
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
@@ -1211,439 +1275,535 @@ export interface CancelEventRequest {
1211
1275
  * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1212
1276
  */
1213
1277
  timeZone?: string | null;
1278
+ /**
1279
+ * Information about which fields containing personal data to return. Refer to the
1280
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1281
+ * for more information.
1282
+ *
1283
+ * Supported values:
1284
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1285
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1286
+ *
1287
+ * Max: 1 field
1288
+ * Default: No personal data is returned.
1289
+ * @maxSize 1
1290
+ */
1291
+ fields?: RequestedFields[];
1214
1292
  }
1215
- export interface CancelEventResponse {
1216
- /** Canceled event. */
1293
+ export declare enum RequestedFields {
1294
+ UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
1295
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
1296
+ PI_FIELDS = "PI_FIELDS",
1297
+ /** Returns only fields containing your own personal data. */
1298
+ OWN_PI_FIELDS = "OWN_PI_FIELDS"
1299
+ }
1300
+ export interface GetEventResponse {
1301
+ /** Retrieved event. */
1217
1302
  event?: Event;
1218
1303
  }
1219
- export interface BulkCancelEventRequest {
1220
- /** IDs of the events to cancel. */
1221
- eventIds: string[];
1304
+ export interface ListEventsRequest {
1222
1305
  /**
1223
- * Whether to return the canceled events.
1306
+ * IDs of the events to retrieve.
1224
1307
  *
1225
- * Default: `false`
1226
- */
1227
- returnEntity?: boolean | null;
1228
- /**
1229
- * Information about whether participants of the canceled events are notified and
1230
- * the message they receive.
1308
+ * Min: 1 event ID
1309
+ * Min: 100 event IDs
1310
+ * @minSize 1
1311
+ * @maxSize 100
1312
+ * @minLength 36
1313
+ * @maxLength 250
1231
1314
  */
1232
- participantNotification?: ParticipantNotification;
1315
+ eventIds: string[];
1233
1316
  /**
1234
1317
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1235
1318
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1236
1319
  * `America/New_York` or `UTC`.
1237
1320
  *
1238
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1321
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1239
1322
  */
1240
1323
  timeZone?: string | null;
1324
+ /**
1325
+ * Information about which fields containing personal data to return. Refer to the
1326
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1327
+ * for more information.
1328
+ *
1329
+ * Supported values:
1330
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1331
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1332
+ *
1333
+ * Max: 1 field
1334
+ * Default: No personal data is returned.
1335
+ * @maxSize 1
1336
+ */
1337
+ fields?: RequestedFields[];
1241
1338
  }
1242
- export interface BulkCancelEventResponse {
1243
- /** The result for each event, containing the event and whether the action was successful. */
1244
- results?: BulkEventResult[];
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;
1339
+ export interface ListEventsResponse {
1340
+ /** Retrieved events matching the provided IDs. */
1341
+ events?: Event[];
1267
1342
  }
1268
- export interface Properties {
1269
- /** Site categories. */
1270
- categories?: Categories;
1271
- /** Site locale. */
1272
- locale?: Locale;
1343
+ export interface QueryEventsRequest {
1273
1344
  /**
1274
- * Site language.
1345
+ * Local start date and time from which events are returned in
1346
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1347
+ * `2024-01-30T13:30:00`.
1275
1348
  *
1276
- * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1349
+ * Events that start before the `fromLocalDate` but end after it are included in
1350
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
1351
+ * descending.
1352
+ * @format LOCAL_DATE_TIME
1277
1353
  */
1278
- language?: string | null;
1354
+ fromLocalDate?: string | null;
1279
1355
  /**
1280
- * Site currency format used to bill customers.
1356
+ * Local end date and time up to which events are returned in
1357
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1358
+ * `2024-01-30T13:30:00`.
1281
1359
  *
1282
- * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1283
- */
1284
- paymentCurrency?: string | null;
1285
- /** Timezone in `America/New_York` format. */
1360
+ * Events that start before `toLocalDate` but end after it are included in the
1361
+ * results. Must be later than `fromLocalDate` unless the sort order is
1362
+ * descending.
1363
+ * @format LOCAL_DATE_TIME
1364
+ */
1365
+ toLocalDate?: string | null;
1366
+ /**
1367
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1368
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1369
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1370
+ *
1371
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1372
+ */
1286
1373
  timeZone?: string | null;
1287
- /** Email address. */
1288
- email?: string | null;
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;
1374
+ /** Query containing filters and paging. */
1375
+ query?: CursorQuery;
1303
1376
  /**
1304
- * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
1377
+ * Filters events based on their `recurrenceType`.
1305
1378
  *
1306
- * __Note:__ Not supported by Wix Bookings.
1379
+ * Max: 5 recurrence types can be specified.
1380
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
1381
+ * @maxSize 5
1307
1382
  */
1308
- businessSchedule?: BusinessSchedule;
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;
1383
+ recurrenceType?: RecurrenceType[];
1313
1384
  /**
1314
- * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
1385
+ * Information about which fields containing personal data to return. Refer to the
1386
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1387
+ * for more information.
1315
1388
  *
1316
- * Site business type.
1389
+ * Supported values:
1390
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1391
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1392
+ *
1393
+ * Max: 1 field
1394
+ * Default: No personal data is returned.
1395
+ * @maxSize 1
1317
1396
  */
1318
- businessConfig?: string | null;
1319
- /** External site URL that uses Wix as its headless business solution. */
1320
- externalSiteUrl?: string | null;
1321
- /** Track clicks analytics. */
1322
- trackClicksAnalytics?: boolean;
1397
+ fields?: RequestedFields[];
1323
1398
  }
1324
- export interface Categories {
1325
- /** Primary site category. */
1326
- primary?: string;
1327
- /** Secondary site category. */
1328
- secondary?: string[];
1329
- /** Business Term Id */
1330
- businessTermId?: string | null;
1399
+ /** TODO Diverge */
1400
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1401
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1402
+ cursorPaging?: CursorPaging;
1403
+ /**
1404
+ * Filter object.
1405
+ * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
1406
+ * for more information.
1407
+ *
1408
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
1409
+ *
1410
+ * For a detailed list of supported filters, see Supported Filters.
1411
+ */
1412
+ filter?: Record<string, any> | null;
1413
+ /**
1414
+ * Whether to sort events by their start date in ascending order or by their end date in descending order.
1415
+ * Default is start ascending.
1416
+ * @maxSize 1
1417
+ */
1418
+ sort?: Sorting[];
1331
1419
  }
1332
- export interface Locale {
1333
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1334
- languageCode?: string;
1335
- /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1336
- country?: string;
1420
+ /** @oneof */
1421
+ export interface CursorQueryPagingMethodOneOf {
1422
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1423
+ cursorPaging?: CursorPaging;
1337
1424
  }
1338
- export interface Address {
1339
- /** Street name. */
1340
- street?: string;
1341
- /** City name. */
1342
- city?: string;
1343
- /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1344
- country?: string;
1345
- /** State. */
1346
- state?: string;
1347
- /** Zip or postal code. */
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;
1425
+ /** TODO Diverge */
1426
+ export interface Sorting {
1427
+ /**
1428
+ * The field to sort by.
1429
+ * Either `start` or `end`.
1430
+ * Default is `start`.
1431
+ */
1432
+ fieldName?: string;
1433
+ /** Sort order. */
1434
+ order?: SortOrder;
1361
1435
  }
1362
- /**
1363
- * Extra information on displayed addresses.
1364
- * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
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;
1436
+ export declare enum SortOrder {
1437
+ ASC = "ASC",
1438
+ DESC = "DESC"
1372
1439
  }
1373
- /** Where the extra text should be displayed: before, after or instead of the actual address. */
1374
- export declare enum PlacementType {
1375
- BEFORE = "BEFORE",
1376
- AFTER = "AFTER",
1377
- REPLACE = "REPLACE"
1440
+ /** TODO Diverge */
1441
+ export interface CursorPaging {
1442
+ /**
1443
+ * Number of events to return.
1444
+ * Defaults to `50`. Maximum `1000`.
1445
+ * @min 1
1446
+ * @max 1000
1447
+ */
1448
+ limit?: number | null;
1449
+ /**
1450
+ * Pointer to the next or previous page in the list of results.
1451
+ *
1452
+ * You can get the relevant cursor token
1453
+ * from the `pagingMetadata` object in the previous call's response.
1454
+ * Not relevant for the first request.
1455
+ */
1456
+ cursor?: string | null;
1378
1457
  }
1379
- /** Geocoordinates for a particular address. */
1380
- export interface GeoCoordinates {
1381
- /** Latitude of the location. Must be between -90 and 90. */
1382
- latitude?: number;
1383
- /** Longitude of the location. Must be between -180 and 180. */
1384
- longitude?: number;
1458
+ export interface QueryEventsResponse {
1459
+ /** Retrieved events matching the provided query. */
1460
+ events?: Event[];
1461
+ /** Paging metadata. */
1462
+ pagingMetadata?: CursorPagingMetadata;
1385
1463
  }
1386
- /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1387
- export interface BusinessSchedule {
1388
- /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
1389
- periods?: TimePeriod[];
1390
- /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
1391
- specialHourPeriod?: SpecialHourPeriod[];
1464
+ /** TODO Diverge */
1465
+ export interface CursorPagingMetadata {
1466
+ /** Number of items returned in the response. */
1467
+ count?: number | null;
1468
+ /** 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). */
1469
+ cursors?: Cursors;
1470
+ /**
1471
+ * Indicates if there are more results after the current page.
1472
+ * If `true`, another page of results can be retrieved.
1473
+ * If `false`, this is the last page.
1474
+ */
1475
+ hasNext?: boolean | null;
1392
1476
  }
1393
- /** Weekly recurring time periods when the business is regularly open or the service is available. */
1394
- export interface TimePeriod {
1395
- /** Day of the week the period starts on. */
1396
- openDay?: DayOfWeek;
1477
+ export interface Cursors {
1478
+ /** Cursor pointing to next page in the list of results. */
1479
+ next?: string | null;
1480
+ }
1481
+ export interface ListRecurringEventInstancesHistoryRequest {
1397
1482
  /**
1398
- * 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
1399
- * midnight at the end of the specified day.
1483
+ * The ID of the recurring event.
1484
+ * Required, unless `cursorPaging` is provided.
1485
+ * @minLength 64
1486
+ * @maxLength 64
1400
1487
  */
1401
- openTime?: string;
1402
- /** Day of the week the period ends on. */
1403
- closeDay?: DayOfWeek;
1488
+ recurringEventId?: string | null;
1404
1489
  /**
1405
- * 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
1406
- * midnight at the end of the specified day.
1490
+ * The revision of the recurring event.
1491
+ * Required, unless `cursorPaging` is provided.
1492
+ */
1493
+ revision?: string | null;
1494
+ /**
1495
+ * Inclusive start date for which events are returned, in ISO-8601 format.
1496
+ * Events that begin at or after the `fromDate` are included in the results.
1497
+ * Required, unless `cursorPaging` is provided.
1498
+ */
1499
+ fromDate?: Date | null;
1500
+ /**
1501
+ * Exclusive end date for which events are returned, in ISO-8601 format.
1502
+ * Events that begin before the `toDate` are included in the results.
1503
+ * Required, unless `cursorPaging` is provided.
1504
+ */
1505
+ toDate?: Date | null;
1506
+ /** Optional cursor pointing to the next page of events. */
1507
+ cursorPaging?: CursorPaging;
1508
+ }
1509
+ export interface ListRecurringEventInstancesHistoryResponse {
1510
+ /** The recurring event instances. */
1511
+ recurringEventInstances?: Event[];
1512
+ /** Paging metadata. */
1513
+ pagingMetadata?: CursorPagingMetadata;
1514
+ }
1515
+ export interface CreateEventRequest {
1516
+ /** Event to create. */
1517
+ event: Event;
1518
+ /**
1519
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1520
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1521
+ * `America/New_York` or `UTC`.
1407
1522
  *
1408
- * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
1523
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1409
1524
  */
1410
- closeTime?: string;
1525
+ timeZone?: string | null;
1526
+ /**
1527
+ * Idempotency key guaranteeing that you don't create the same event more
1528
+ * than once.
1529
+ * @format GUID
1530
+ */
1531
+ idempotencyKey?: string | null;
1411
1532
  }
1412
- /** Enumerates the days of the week. */
1413
- export declare enum DayOfWeek {
1414
- MONDAY = "MONDAY",
1415
- TUESDAY = "TUESDAY",
1416
- WEDNESDAY = "WEDNESDAY",
1417
- THURSDAY = "THURSDAY",
1418
- FRIDAY = "FRIDAY",
1419
- SATURDAY = "SATURDAY",
1420
- SUNDAY = "SUNDAY"
1533
+ export interface CreateEventResponse {
1534
+ /** Created event. */
1535
+ event?: Event;
1421
1536
  }
1422
- /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1423
- export interface SpecialHourPeriod {
1424
- /** 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). */
1425
- startDate?: string;
1426
- /** 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). */
1427
- endDate?: string;
1537
+ export interface BulkCreateEventRequest {
1538
+ /**
1539
+ * Events to create.
1540
+ * @minSize 1
1541
+ * @maxSize 50
1542
+ */
1543
+ events: MaskedEvent[];
1544
+ /**
1545
+ * Whether to return created events.
1546
+ *
1547
+ * Default: `false`.
1548
+ */
1549
+ returnEntity?: boolean | null;
1428
1550
  /**
1429
- * Whether the business is closed (or the service is not available) during the exception.
1551
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1552
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1553
+ * `America/New_York` or `UTC`.
1430
1554
  *
1431
- * Default: `true`.
1555
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1432
1556
  */
1433
- isClosed?: boolean;
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"
1557
+ timeZone?: string | null;
1459
1558
  }
1460
- export interface ConsentPolicy {
1461
- /** Whether the site uses cookies that are essential to site operation. Always `true`. */
1462
- essential?: boolean | null;
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;
1559
+ export interface MaskedEvent {
1560
+ /** Event to create. */
1561
+ event?: Event;
1471
1562
  }
1472
- /** A single mapping from the MetaSite ID to a particular service. */
1473
- export interface Translation {
1474
- /** The service type. */
1475
- serviceType?: string;
1476
- /** The application definition ID; this only applies to services of type ThirdPartyApps. */
1477
- appDefId?: string;
1478
- /** The instance ID of the service. */
1479
- instanceId?: string;
1563
+ export interface BulkCreateEventResponse {
1564
+ /** The result for each event, containing the event and whether the action was successful. */
1565
+ results?: BulkEventResult[];
1566
+ /** Total successes and failures. */
1567
+ bulkActionMetadata?: BulkActionMetadata;
1480
1568
  }
1481
- export interface ChangeContext extends ChangeContextPayloadOneOf {
1482
- /** Properties were updated. */
1483
- propertiesChange?: PropertiesChange;
1484
- /** Default properties were created on site creation. */
1485
- siteCreated?: SiteCreated;
1486
- /** Properties were cloned on site cloning. */
1487
- siteCloned?: SiteCloned;
1569
+ export interface BulkEventResult {
1570
+ /** Whether the requested action was successful. */
1571
+ itemMetadata?: ItemMetadata;
1572
+ /** The event. */
1573
+ item?: Event;
1488
1574
  }
1489
- /** @oneof */
1490
- export interface ChangeContextPayloadOneOf {
1491
- /** Properties were updated. */
1492
- propertiesChange?: PropertiesChange;
1493
- /** Default properties were created on site creation. */
1494
- siteCreated?: SiteCreated;
1495
- /** Properties were cloned on site cloning. */
1496
- siteCloned?: SiteCloned;
1575
+ export interface ItemMetadata {
1576
+ /**
1577
+ * Event ID.
1578
+ * Should always be available, unless it's impossible (for example, when failing to create an event).
1579
+ */
1580
+ _id?: string | null;
1581
+ /** Index of the item within the request array, for correlation between request and response items. */
1582
+ originalIndex?: number;
1583
+ /**
1584
+ * Whether the requested action was successful for this event.
1585
+ * When `false`, the `error` field is populated.
1586
+ */
1587
+ success?: boolean;
1588
+ /** Details about the error in case of failure. */
1589
+ error?: ApplicationError;
1497
1590
  }
1498
- export interface PropertiesChange {
1591
+ export interface ApplicationError {
1592
+ /** Error code. */
1593
+ code?: string;
1594
+ /** Description of the error. */
1595
+ description?: string;
1596
+ /** Data related to the error. */
1597
+ data?: Record<string, any> | null;
1499
1598
  }
1500
- export interface SiteCreated {
1501
- /** Origin template site id. */
1502
- originTemplateId?: string | null;
1599
+ export interface BulkActionMetadata {
1600
+ /** Number of events that were successfully processed. */
1601
+ totalSuccesses?: number;
1602
+ /** Number of events that couldn't be processed. */
1603
+ totalFailures?: number;
1503
1604
  }
1504
- export interface SiteCloned {
1505
- /** Origin site id. */
1506
- originMetaSiteId?: string;
1605
+ export interface UpdateEventRequest {
1606
+ /** Event to update. */
1607
+ event: Event;
1608
+ /**
1609
+ * Information about whether participants of the updated event are notified and
1610
+ * the message they receive.
1611
+ */
1612
+ participantNotification?: ParticipantNotification;
1613
+ /**
1614
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1615
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1616
+ * `America/New_York` or `UTC`.
1617
+ *
1618
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1619
+ */
1620
+ timeZone?: string | null;
1507
1621
  }
1508
- export interface Empty {
1622
+ export interface UpdateEventResponse {
1623
+ /** Updated event. */
1624
+ event?: Event;
1509
1625
  }
1510
- export interface ListEventsByContactIdRequest {
1626
+ export interface BulkUpdateEventRequest {
1511
1627
  /**
1512
- * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1513
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1628
+ * Events to update.
1629
+ *
1630
+ * Min: 1 event
1631
+ * Max: 50 events
1632
+ * @minSize 1
1633
+ * @maxSize 50
1514
1634
  */
1515
- contactId: string | null;
1635
+ events: BulkUpdateEventRequestMaskedEvent[];
1516
1636
  /**
1517
- * Local start date and time from which events are returned in
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.
1637
+ * Whether to return the updated events.
1520
1638
  *
1521
- * Events that start before the `fromLocalDate` but end after it are included in
1522
- * the results. Must be earlier than `toLocalDate`.
1639
+ * Default: `false`
1523
1640
  */
1524
- fromLocalDate?: string | null;
1641
+ returnEntity?: boolean | null;
1525
1642
  /**
1526
- * Local end date and time up to which events are returned in
1527
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
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`.
1643
+ * Information about whether participants of the updated event are notified and
1644
+ * the message they receive.
1533
1645
  */
1534
- toLocalDate?: string | null;
1646
+ participantNotification?: ParticipantNotification;
1535
1647
  /**
1536
1648
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1537
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1538
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1649
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1650
+ * `America/New_York` or `UTC`.
1539
1651
  *
1540
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1652
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1541
1653
  */
1542
1654
  timeZone?: string | null;
1655
+ }
1656
+ export interface BulkUpdateEventRequestMaskedEvent {
1657
+ /** Event to update. */
1658
+ event?: Event;
1659
+ }
1660
+ export interface BulkUpdateEventResponse {
1661
+ /** The result for each event, containing the event and whether the action was successful. */
1662
+ results?: BulkEventResult[];
1663
+ /** Total successes and failures. */
1664
+ bulkActionMetadata?: BulkActionMetadata;
1665
+ }
1666
+ export interface UpdateEventParticipantsRequest {
1543
1667
  /**
1544
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1545
- * to filter events by.
1668
+ * ID of the event to update.
1669
+ *
1670
+ * Min: 36 characters
1671
+ * Max: 250 characters
1672
+ * @minLength 36
1673
+ * @maxLength 250
1546
1674
  */
1547
- appId?: string | null;
1548
- /** Cursor to retrieve the next page of the results. */
1549
- cursorPaging?: CommonCursorPaging;
1675
+ eventId?: string | null;
1676
+ /** The participants to update. */
1677
+ participants?: Participants;
1550
1678
  }
1551
- /** TODO Diverge */
1552
- export interface CommonCursorPaging {
1679
+ export interface UpdateEventParticipantsResponse {
1680
+ /** Updated event. */
1681
+ event?: Event;
1682
+ }
1683
+ export interface RestoreEventDefaultsRequest {
1553
1684
  /**
1554
- * Number of events to return.
1555
- * Defaults to `50`. Maximum `100`.
1685
+ * ID of the event for which to restore default values.
1686
+ * @minLength 36
1687
+ * @maxLength 250
1556
1688
  */
1557
- limit?: number | null;
1689
+ eventId: string | null;
1558
1690
  /**
1559
- * Pointer to the next or previous page in the list of results.
1691
+ * Fields for which to restore default values.
1560
1692
  *
1561
- * You can get the relevant cursor token
1562
- * from the `pagingMetadata` object in the previous call's response.
1563
- * Not relevant for the first request.
1693
+ * `TIME` restores default values for `start` and `end`.
1694
+ *
1695
+ * Min: 1 field
1696
+ * @minSize 1
1564
1697
  */
1565
- cursor?: string | null;
1698
+ fields: Field[];
1699
+ /**
1700
+ * Information about whether participants of the updated event are notified and
1701
+ * the message they receive.
1702
+ */
1703
+ participantNotification?: ParticipantNotification;
1704
+ /**
1705
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1706
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1707
+ * `America/New_York` or `UTC`.
1708
+ *
1709
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1710
+ */
1711
+ timeZone?: string | null;
1566
1712
  }
1567
- export interface ListEventsByContactIdResponse {
1568
- /** Retrieved events. */
1569
- events?: Event[];
1570
- /** Paging metadata. */
1571
- pagingMetadata?: CommonCursorPagingMetadata;
1713
+ export interface RestoreEventDefaultsResponse {
1714
+ /** Updated event. */
1715
+ event?: Event;
1572
1716
  }
1573
- /** TODO Diverge */
1574
- export interface CommonCursorPagingMetadata {
1575
- /** Number of items returned in the response. */
1576
- count?: number | null;
1577
- /** 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). */
1578
- cursors?: CommonCursors;
1717
+ export interface SplitRecurringEventRequest {
1718
+ /**
1719
+ * ID of the `MASTER` event to split.
1720
+ * @minLength 36
1721
+ * @maxLength 250
1722
+ */
1723
+ recurringEventId: string | null;
1724
+ /**
1725
+ * Local date and time at which the `MASTER` event is split in
1726
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1727
+ * `2025-03-11T09:00:00`.
1728
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
1729
+ * `EXCEPTION` event in the series. Additionally, there must be another
1730
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
1731
+ * wouldn't affect any event without a subsequent occurrence.
1732
+ * @format LOCAL_DATE_TIME
1733
+ */
1734
+ splitLocalDate: string | null;
1579
1735
  /**
1580
- * Indicates if there are more results after the current page.
1581
- * If `true`, another page of results can be retrieved.
1582
- * If `false`, this is the last page.
1736
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1737
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1738
+ * `America/New_York` or `UTC`.
1739
+ *
1740
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1583
1741
  */
1584
- hasNext?: boolean | null;
1742
+ timeZone?: string | null;
1585
1743
  }
1586
- export interface CommonCursors {
1587
- /** Cursor pointing to next page in the list of results. */
1588
- next?: string | null;
1744
+ export interface SplitRecurringEventResponse {
1745
+ /** Original `MASTER` event that was shortened. */
1746
+ updatedRecurringEventEndingBeforeSplit?: Event;
1747
+ /** New `MASTER` event starting with the first event after the split date. */
1748
+ newRecurringEventStartingFromSplit?: Event;
1589
1749
  }
1590
- export interface ListEventsByMemberIdRequest {
1750
+ export interface CancelEventRequest {
1591
1751
  /**
1592
- * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1593
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1594
- * Provide `me` to retrieve events for the currently logged-in member.
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.
1752
+ * ID of the event to cancel.
1753
+ * @minLength 36
1754
+ * @maxLength 250
1598
1755
  */
1599
- memberId: string | null;
1756
+ eventId: string | null;
1600
1757
  /**
1601
- * Local start date and time from which events are returned in
1602
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
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`.
1758
+ * Information about whether participants of the canceled event are notified and
1759
+ * the message they receive.
1607
1760
  */
1608
- fromLocalDate?: string | null;
1761
+ participantNotification?: ParticipantNotification;
1609
1762
  /**
1610
- * Local end date and time up to which events are returned in
1611
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1612
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1613
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1763
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1764
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1765
+ * `America/New_York` or `UTC`.
1614
1766
  *
1615
- * Events that start before `toLocalDate` but end after it are included in the
1616
- * results. Must be later than `fromLocalDate`.
1767
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1617
1768
  */
1618
- toLocalDate?: string | null;
1769
+ timeZone?: string | null;
1770
+ }
1771
+ export interface CancelEventResponse {
1772
+ /** Canceled event. */
1773
+ event?: Event;
1774
+ }
1775
+ export interface BulkCancelEventRequest {
1619
1776
  /**
1620
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1621
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1622
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1777
+ * IDs of the events to cancel.
1778
+ * @minSize 1
1779
+ * @maxSize 50
1780
+ */
1781
+ eventIds: string[];
1782
+ /**
1783
+ * Whether to return the canceled events.
1623
1784
  *
1624
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1785
+ * Default: `false`
1625
1786
  */
1626
- timeZone?: string | null;
1787
+ returnEntity?: boolean | null;
1627
1788
  /**
1628
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1629
- * to filter events by.
1789
+ * Information about whether participants of the canceled events are notified and
1790
+ * the message they receive.
1630
1791
  */
1631
- appId?: string | null;
1632
- /** Cursor to retrieve the next page of the results. */
1633
- cursorPaging?: CommonCursorPaging;
1792
+ participantNotification?: ParticipantNotification;
1634
1793
  /**
1635
- * IDs of the events to retrieve.
1636
- * If you provide a list of IDs, all other filters are ignored.
1794
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1795
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1796
+ * `America/New_York` or `UTC`.
1637
1797
  *
1638
- * Max: 100 `eventId`s
1798
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1639
1799
  */
1640
- eventIds?: string[];
1800
+ timeZone?: string | null;
1641
1801
  }
1642
- export interface ListEventsByMemberIdResponse {
1643
- /** Retrieved events. */
1644
- events?: Event[];
1645
- /** Paging metadata. */
1646
- pagingMetadata?: CommonCursorPagingMetadata;
1802
+ export interface BulkCancelEventResponse {
1803
+ /** The result for each event, containing the event and whether the action was successful. */
1804
+ results?: BulkEventResult[];
1805
+ /** Total successes and failures. */
1806
+ bulkActionMetadata?: BulkActionMetadata;
1647
1807
  }
1648
1808
  interface RecurrenceRuleNonNullableFields {
1649
1809
  frequency: Frequency;
@@ -1682,6 +1842,12 @@ export interface EventNonNullableFields {
1682
1842
  inheritedFields: Field[];
1683
1843
  permissions: PermissionNonNullableFields[];
1684
1844
  }
1845
+ export interface ListEventsByContactIdResponseNonNullableFields {
1846
+ events: EventNonNullableFields[];
1847
+ }
1848
+ export interface ListEventsByMemberIdResponseNonNullableFields {
1849
+ events: EventNonNullableFields[];
1850
+ }
1685
1851
  export interface GetEventResponseNonNullableFields {
1686
1852
  event?: EventNonNullableFields;
1687
1853
  }
@@ -1736,16 +1902,16 @@ export interface BulkCancelEventResponseNonNullableFields {
1736
1902
  results: BulkEventResultNonNullableFields[];
1737
1903
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1738
1904
  }
1739
- export interface ListEventsByContactIdResponseNonNullableFields {
1740
- events: EventNonNullableFields[];
1741
- }
1742
- export interface ListEventsByMemberIdResponseNonNullableFields {
1743
- events: EventNonNullableFields[];
1744
- }
1745
1905
  export interface BaseEventMetadata {
1746
- /** App instance ID. */
1906
+ /**
1907
+ * App instance ID.
1908
+ * @format GUID
1909
+ */
1747
1910
  instanceId?: string | null;
1748
- /** Event type. */
1911
+ /**
1912
+ * Event type.
1913
+ * @maxLength 150
1914
+ */
1749
1915
  eventType?: string;
1750
1916
  /** The identification type and identity data. */
1751
1917
  identity?: IdentificationData;
@@ -1806,6 +1972,10 @@ export interface EventCancelledEnvelope {
1806
1972
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1807
1973
  * @permissionScope Read Bookings - Including Participants
1808
1974
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1975
+ * @permissionScope Read Bookings - all read permissions
1976
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1977
+ * @permissionScope Manage Bookings - all permissions
1978
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1809
1979
  * @permissionScope Read bookings calendar - including participants
1810
1980
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1811
1981
  * @permissionId CALENDAR.EVENT_READ_PI
@@ -1834,6 +2004,10 @@ export interface EventCreatedEnvelope {
1834
2004
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1835
2005
  * @permissionScope Read Bookings - Including Participants
1836
2006
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2007
+ * @permissionScope Read Bookings - all read permissions
2008
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2009
+ * @permissionScope Manage Bookings - all permissions
2010
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1837
2011
  * @permissionScope Read bookings calendar - including participants
1838
2012
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1839
2013
  * @permissionId CALENDAR.EVENT_READ_PI
@@ -1857,25 +2031,162 @@ export interface EventRecurringSplitEnvelope {
1857
2031
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1858
2032
  * @permissionScope Read Bookings - Including Participants
1859
2033
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2034
+ * @permissionScope Read Bookings - all read permissions
2035
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2036
+ * @permissionScope Manage Bookings - all permissions
2037
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2038
+ * @permissionScope Read bookings calendar - including participants
2039
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2040
+ * @permissionId CALENDAR.EVENT_READ_PI
2041
+ * @webhook
2042
+ * @eventType wix.calendar.v3.event_recurring_split
2043
+ * @slug recurring_split
2044
+ * @documentationMaturity preview
2045
+ */
2046
+ export declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
2047
+ export interface EventUpdatedEnvelope {
2048
+ entity: Event;
2049
+ metadata: EventMetadata;
2050
+ }
2051
+ /**
2052
+ * Triggered when an event is updated, including when it's canceled.
2053
+ *
2054
+ * Not triggered when `INSTANCE` events are updated. You can use the
2055
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
2056
+ * to get notified about `INSTANCE` events.
2057
+ * @permissionScope Read Calendar - Including PI
2058
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2059
+ * @permissionScope Manage Calendars
2060
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2061
+ * @permissionScope Manage Bookings
2062
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2063
+ * @permissionScope Read Bookings - Including Participants
2064
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2065
+ * @permissionScope Read Bookings - all read permissions
2066
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2067
+ * @permissionScope Manage Bookings - all permissions
2068
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2069
+ * @permissionScope Read bookings calendar - including participants
2070
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2071
+ * @permissionId CALENDAR.EVENT_READ_PI
2072
+ * @webhook
2073
+ * @eventType wix.calendar.v3.event_updated
2074
+ * @slug updated
2075
+ * @documentationMaturity preview
2076
+ */
2077
+ export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
2078
+ /**
2079
+ * Retrieves a list of events filtered by the participant's
2080
+ * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
2081
+ * ID.
2082
+ *
2083
+ *
2084
+ * You can't set `toLocalDate` to a value that's more than a full year after
2085
+ * `fromLocalDate`.
2086
+ * @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2087
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2088
+ * @public
2089
+ * @documentationMaturity preview
2090
+ * @requiredField contactId
2091
+ * @permissionId CALENDAR.EVENT_READ_PI
2092
+ * @permissionScope Read Calendar - Including PI
2093
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2094
+ * @permissionScope Manage Calendars
2095
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2096
+ * @permissionScope Manage Bookings
2097
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2098
+ * @permissionScope Read Bookings - Including Participants
2099
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2100
+ * @permissionScope Read Bookings - all read permissions
2101
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2102
+ * @permissionScope Manage Bookings - all permissions
2103
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2104
+ * @permissionScope Read bookings calendar - including participants
2105
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2106
+ * @applicableIdentity APP
2107
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
2108
+ */
2109
+ export declare function listEventsByContactId(contactId: string | null, options?: ListEventsByContactIdOptions): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
2110
+ export interface ListEventsByContactIdOptions {
2111
+ /**
2112
+ * Local start date and time from which events are returned in
2113
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2114
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2115
+ *
2116
+ * Events that start before the `fromLocalDate` but end after it are included in
2117
+ * the results. Must be earlier than `toLocalDate`.
2118
+ * @format LOCAL_DATE_TIME
2119
+ */
2120
+ fromLocalDate?: string | null;
2121
+ /**
2122
+ * Local end date and time up to which events are returned in
2123
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2124
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2125
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2126
+ *
2127
+ * Events that start before `toLocalDate` but end after it are included in the
2128
+ * results. Must be later than `fromLocalDate`.
2129
+ * @format LOCAL_DATE_TIME
2130
+ */
2131
+ toLocalDate?: string | null;
2132
+ /**
2133
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2134
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2135
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2136
+ *
2137
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2138
+ */
2139
+ timeZone?: string | null;
2140
+ /**
2141
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2142
+ * to filter events by.
2143
+ * @format GUID
2144
+ */
2145
+ appId?: string | null;
2146
+ /** Cursor to retrieve the next page of the results. */
2147
+ cursorPaging?: CommonCursorPaging;
2148
+ }
2149
+ /**
2150
+ * Retrieves a list of events filtered by the participant's
2151
+ * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
2152
+ * ID.
2153
+ *
2154
+ *
2155
+ * You can't set `toLocalDate` to a value that's more than a full year after
2156
+ * `fromLocalDate`.
2157
+ * @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2158
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2159
+ * Provide `me` to retrieve events for the currently logged-in member.
2160
+ * You must have the `Read Calendars - Including PI`
2161
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2162
+ * to retrieve events for members who aren't the currently logged in member.
2163
+ * @public
2164
+ * @documentationMaturity preview
2165
+ * @requiredField memberId
2166
+ * @permissionId CALENDAR.EVENT_READ
2167
+ * @permissionId CALENDAR.EVENT_READ_PI
2168
+ * @permissionScope Read Bookings - Public Data
2169
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
2170
+ * @permissionScope Read Calendar - Including PI
2171
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2172
+ * @permissionScope Manage Calendars
2173
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2174
+ * @permissionScope Manage Bookings
2175
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2176
+ * @permissionScope Read Bookings - Including Participants
2177
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2178
+ * @permissionScope Read Bookings - all read permissions
2179
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2180
+ * @permissionScope Read Bookings Calendar Availability
2181
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
2182
+ * @permissionScope Read Calendar
2183
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
2184
+ * @permissionScope Manage Bookings - all permissions
2185
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1860
2186
  * @permissionScope Read bookings calendar - including participants
1861
2187
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1862
- * @permissionId CALENDAR.EVENT_READ_PI
1863
- * @webhook
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.
2188
+ * @permissionScope Read Bookings Calendar
2189
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
1879
2190
  * @permissionScope Read Calendar - Including PI
1880
2191
  * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1881
2192
  * @permissionScope Manage Calendars
@@ -1884,15 +2195,66 @@ export interface EventUpdatedEnvelope {
1884
2195
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1885
2196
  * @permissionScope Read Bookings - Including Participants
1886
2197
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2198
+ * @permissionScope Read Bookings - all read permissions
2199
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2200
+ * @permissionScope Manage Bookings - all permissions
2201
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1887
2202
  * @permissionScope Read bookings calendar - including participants
1888
2203
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1889
- * @permissionId CALENDAR.EVENT_READ_PI
1890
- * @webhook
1891
- * @eventType wix.calendar.v3.event_updated
1892
- * @slug updated
1893
- * @documentationMaturity preview
2204
+ * @applicableIdentity APP
2205
+ * @applicableIdentity VISITOR
2206
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
1894
2207
  */
1895
- export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
2208
+ export declare function listEventsByMemberId(memberId: string | null, options?: ListEventsByMemberIdOptions): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
2209
+ export interface ListEventsByMemberIdOptions {
2210
+ /**
2211
+ * Local start date and time from which events are returned in
2212
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2213
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2214
+ *
2215
+ * Events that start before the `fromLocalDate` but end after it are included in
2216
+ * the results. Must be earlier than `toLocalDate`.
2217
+ * @format LOCAL_DATE_TIME
2218
+ */
2219
+ fromLocalDate?: string | null;
2220
+ /**
2221
+ * Local end date and time up to which events are returned in
2222
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2223
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2224
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2225
+ *
2226
+ * Events that start before `toLocalDate` but end after it are included in the
2227
+ * results. Must be later than `fromLocalDate`.
2228
+ * @format LOCAL_DATE_TIME
2229
+ */
2230
+ toLocalDate?: string | null;
2231
+ /**
2232
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2233
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2234
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2235
+ *
2236
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2237
+ */
2238
+ timeZone?: string | null;
2239
+ /**
2240
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2241
+ * to filter events by.
2242
+ * @format GUID
2243
+ */
2244
+ appId?: string | null;
2245
+ /** Cursor to retrieve the next page of the results. */
2246
+ cursorPaging?: CommonCursorPaging;
2247
+ /**
2248
+ * IDs of the events to retrieve.
2249
+ * If you provide a list of IDs, all other filters are ignored.
2250
+ *
2251
+ * Max: 100 `eventId`s
2252
+ * @maxSize 100
2253
+ * @minLength 36
2254
+ * @maxLength 250
2255
+ */
2256
+ eventIds?: string[];
2257
+ }
1896
2258
  /**
1897
2259
  * Retrieves an event.
1898
2260
  * @param eventId - ID of the event to retrieve.
@@ -1934,6 +2296,8 @@ export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) =>
1934
2296
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1935
2297
  * @permissionScope Read Bookings - Including Participants
1936
2298
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2299
+ * @permissionScope Read Bookings - all read permissions
2300
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1937
2301
  * @permissionScope Manage Bookings - all permissions
1938
2302
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1939
2303
  * @permissionScope Read bookings calendar - including participants
@@ -1964,6 +2328,7 @@ export interface GetEventOptions {
1964
2328
  *
1965
2329
  * Max: 1 field
1966
2330
  * Default: No personal data is returned.
2331
+ * @maxSize 1
1967
2332
  */
1968
2333
  fields?: RequestedFields[];
1969
2334
  }
@@ -2008,6 +2373,8 @@ export interface GetEventOptions {
2008
2373
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2009
2374
  * @permissionScope Read Bookings - Including Participants
2010
2375
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2376
+ * @permissionScope Read Bookings - all read permissions
2377
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2011
2378
  * @permissionScope Manage Bookings - all permissions
2012
2379
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2013
2380
  * @permissionScope Read bookings calendar - including participants
@@ -2037,6 +2404,7 @@ export interface ListEventsOptions {
2037
2404
  *
2038
2405
  * Max: 1 field
2039
2406
  * Default: No personal data is returned.
2407
+ * @maxSize 1
2040
2408
  */
2041
2409
  fields?: RequestedFields[];
2042
2410
  }
@@ -2090,6 +2458,8 @@ export interface ListEventsOptions {
2090
2458
  * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2091
2459
  * @permissionScope Read Bookings - Including Participants
2092
2460
  * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2461
+ * @permissionScope Read Bookings - all read permissions
2462
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2093
2463
  * @permissionScope Manage Bookings - all permissions
2094
2464
  * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2095
2465
  * @permissionScope Read bookings calendar - including participants
@@ -2110,6 +2480,7 @@ export interface QueryEventsOptions {
2110
2480
  * Events that start before the `fromLocalDate` but end after it are included in
2111
2481
  * the results. Must be earlier than `toLocalDate` unless the sort order is
2112
2482
  * descending.
2483
+ * @format LOCAL_DATE_TIME
2113
2484
  */
2114
2485
  fromLocalDate?: string | null | undefined;
2115
2486
  /**
@@ -2120,6 +2491,7 @@ export interface QueryEventsOptions {
2120
2491
  * Events that start before `toLocalDate` but end after it are included in the
2121
2492
  * results. Must be later than `fromLocalDate` unless the sort order is
2122
2493
  * descending.
2494
+ * @format LOCAL_DATE_TIME
2123
2495
  */
2124
2496
  toLocalDate?: string | null | undefined;
2125
2497
  /**
@@ -2135,6 +2507,7 @@ export interface QueryEventsOptions {
2135
2507
  *
2136
2508
  * Max: 5 recurrence types can be specified.
2137
2509
  * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
2510
+ * @maxSize 5
2138
2511
  */
2139
2512
  recurrenceType?: RecurrenceType[] | undefined;
2140
2513
  /**
@@ -2148,11 +2521,12 @@ export interface QueryEventsOptions {
2148
2521
  *
2149
2522
  * Max: 1 field
2150
2523
  * Default: No personal data is returned.
2524
+ * @maxSize 1
2151
2525
  */
2152
2526
  fields?: RequestedFields[] | undefined;
2153
2527
  }
2154
2528
  interface QueryCursorResult {
2155
- cursors: Cursors;
2529
+ cursors: CommonCursors;
2156
2530
  hasNext: () => boolean;
2157
2531
  hasPrev: () => boolean;
2158
2532
  length: number;
@@ -2266,6 +2640,7 @@ export interface CreateEventOptions {
2266
2640
  /**
2267
2641
  * Idempotency key guaranteeing that you don't create the same event more
2268
2642
  * than once.
2643
+ * @format GUID
2269
2644
  */
2270
2645
  idempotencyKey?: string | null;
2271
2646
  }
@@ -2387,6 +2762,8 @@ export declare function updateEvent(_id: string | null, event: UpdateEvent, opti
2387
2762
  export interface UpdateEvent {
2388
2763
  /**
2389
2764
  * Event ID.
2765
+ * @minLength 36
2766
+ * @maxLength 250
2390
2767
  * @readonly
2391
2768
  */
2392
2769
  _id?: string | null;
@@ -2394,12 +2771,15 @@ export interface UpdateEvent {
2394
2771
  * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
2395
2772
  * the event belongs to.
2396
2773
  * After creating an event, you can't assign it to a different schedule.
2774
+ * @format GUID
2775
+ * @immutable
2397
2776
  */
2398
2777
  scheduleId?: string | null;
2399
2778
  /**
2400
2779
  * ID of the external schedule the event belongs to.
2401
2780
  *
2402
2781
  * 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).
2782
+ * @format GUID
2403
2783
  * @readonly
2404
2784
  */
2405
2785
  externalScheduleId?: string | null;
@@ -2419,6 +2799,7 @@ export interface UpdateEvent {
2419
2799
  * + `APPOINTMENT`: Bookings appointment event.
2420
2800
  * + `CLASS`: Bookings class event.
2421
2801
  * + `COURSE`: Bookings course event.
2802
+ * @immutable
2422
2803
  */
2423
2804
  type?: string | null;
2424
2805
  /**
@@ -2437,6 +2818,8 @@ export interface UpdateEvent {
2437
2818
  *
2438
2819
  * Min: 1 character
2439
2820
  * Max: 200 characters
2821
+ * @minLength 1
2822
+ * @maxLength 200
2440
2823
  */
2441
2824
  title?: string | null;
2442
2825
  /** Information about when the event starts. */
@@ -2500,6 +2883,8 @@ export interface UpdateEvent {
2500
2883
  /**
2501
2884
  * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
2502
2885
  * and `EXCEPTION` events.
2886
+ * @minLength 64
2887
+ * @maxLength 64
2503
2888
  * @readonly
2504
2889
  */
2505
2890
  recurringEventId?: string | null;
@@ -2526,6 +2911,7 @@ export interface UpdateEvent {
2526
2911
  * providing the service or the room where the appointment takes place.
2527
2912
  *
2528
2913
  * Max: 100 resources
2914
+ * @maxSize 100
2529
2915
  */
2530
2916
  resources?: Resource[];
2531
2917
  /**
@@ -2558,6 +2944,8 @@ export interface UpdateEvent {
2558
2944
  *
2559
2945
  * Min: 1 character
2560
2946
  * Max: 5000 characters
2947
+ * @minLength 1
2948
+ * @maxLength 5000
2561
2949
  */
2562
2950
  notes?: string | null;
2563
2951
  /**
@@ -2571,6 +2959,7 @@ export interface UpdateEvent {
2571
2959
  * ID of the app that owns the event. Identical to `appId` of the
2572
2960
  * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
2573
2961
  * to which the event belongs.
2962
+ * @format GUID
2574
2963
  * @readonly
2575
2964
  */
2576
2965
  appId?: string | null;
@@ -2893,167 +3282,4 @@ export interface BulkCancelEventOptions {
2893
3282
  */
2894
3283
  timeZone?: string | null;
2895
3284
  }
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
3285
  export {};