@wix/auto_sdk_calendar_events 1.0.3 → 1.0.5

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