@wix/auto_sdk_calendar_events 1.0.31 → 1.0.33

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 (44) hide show
  1. package/build/{internal → cjs}/index.d.ts +41 -16
  2. package/build/{internal → cjs}/index.js +8 -8
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/{calendar-v3-event-events.universal-oZbWDSxX.d.mts → cjs/index.typings.d.ts} +624 -153
  5. package/build/cjs/index.typings.js +1294 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/{internal → cjs}/meta.d.ts +2 -1
  8. package/build/{internal → es}/index.d.mts +41 -16
  9. package/build/{index.mjs → es/index.mjs} +8 -8
  10. package/build/es/index.mjs.map +1 -0
  11. package/build/{calendar-v3-event-events.universal-oZbWDSxX.d.ts → es/index.typings.d.mts} +624 -153
  12. package/build/es/index.typings.mjs +1241 -0
  13. package/build/es/index.typings.mjs.map +1 -0
  14. package/build/{internal → es}/meta.d.mts +2 -1
  15. package/build/es/package.json +3 -0
  16. package/build/{index.d.ts → internal/cjs/index.d.ts} +41 -16
  17. package/build/{index.js → internal/cjs/index.js} +8 -8
  18. package/build/internal/cjs/index.js.map +1 -0
  19. package/build/internal/{calendar-v3-event-events.universal-oZbWDSxX.d.mts → cjs/index.typings.d.ts} +624 -153
  20. package/build/internal/cjs/index.typings.js +1294 -0
  21. package/build/internal/cjs/index.typings.js.map +1 -0
  22. package/build/{meta.d.ts → internal/cjs/meta.d.ts} +2 -1
  23. package/build/internal/cjs/meta.js.map +1 -0
  24. package/build/{index.d.mts → internal/es/index.d.mts} +41 -16
  25. package/build/internal/{index.mjs → es/index.mjs} +8 -8
  26. package/build/internal/es/index.mjs.map +1 -0
  27. package/build/internal/{calendar-v3-event-events.universal-oZbWDSxX.d.ts → es/index.typings.d.mts} +624 -153
  28. package/build/internal/es/index.typings.mjs +1241 -0
  29. package/build/internal/es/index.typings.mjs.map +1 -0
  30. package/build/{meta.d.mts → internal/es/meta.d.mts} +2 -1
  31. package/build/internal/es/meta.mjs.map +1 -0
  32. package/package.json +11 -11
  33. package/build/index.js.map +0 -1
  34. package/build/index.mjs.map +0 -1
  35. package/build/internal/index.js.map +0 -1
  36. package/build/internal/index.mjs.map +0 -1
  37. package/build/meta.js.map +0 -1
  38. package/build/meta.mjs.map +0 -1
  39. /package/build/{internal → cjs}/meta.js +0 -0
  40. /package/build/{internal → cjs}/meta.js.map +0 -0
  41. /package/build/{internal → es}/meta.mjs +0 -0
  42. /package/build/{internal → es}/meta.mjs.map +0 -0
  43. /package/build/{meta.js → internal/cjs/meta.js} +0 -0
  44. /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  /**
2
4
  * An event is a scheduled entry on a calendar that includes details like timing,
3
5
  * location, and participants. Each event is associated with
@@ -621,6 +623,8 @@ declare enum IdentityType {
621
623
  UNKNOWN = "UNKNOWN",
622
624
  WIX_USER = "WIX_USER"
623
625
  }
626
+ /** @enumType */
627
+ type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
624
628
  interface ExtendedFields {
625
629
  /**
626
630
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -669,6 +673,158 @@ interface EventUpdatedWithMetadata {
669
673
  */
670
674
  participantNotification?: ParticipantNotification;
671
675
  }
676
+ interface UpdateScheduleWithFixedBusinessResourceIdRequest {
677
+ /** @format GUID */
678
+ metaSiteId?: string;
679
+ /** @format GUID */
680
+ currentBusinessResourceId?: string;
681
+ migrateBusinessConferenceId?: boolean;
682
+ }
683
+ interface UpdateScheduleWithFixedBusinessResourceIdResponse {
684
+ }
685
+ interface UpdateEventsWithFixedBusinessResourceIdRequest {
686
+ /** @format GUID */
687
+ metaSiteId?: string;
688
+ /** @format GUID */
689
+ currentBusinessResourceId?: string;
690
+ migrateBusinessConferenceId?: boolean;
691
+ }
692
+ interface UpdateEventsWithFixedBusinessResourceIdResponse {
693
+ }
694
+ interface DomainEvent extends DomainEventBodyOneOf {
695
+ createdEvent?: EntityCreatedEvent;
696
+ updatedEvent?: EntityUpdatedEvent;
697
+ deletedEvent?: EntityDeletedEvent;
698
+ actionEvent?: ActionEvent;
699
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
700
+ _id?: string;
701
+ /**
702
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
703
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
704
+ */
705
+ entityFqdn?: string;
706
+ /**
707
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
708
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
709
+ */
710
+ slug?: string;
711
+ /** ID of the entity associated with the event. */
712
+ entityId?: string;
713
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
714
+ eventTime?: Date | null;
715
+ /**
716
+ * Whether the event was triggered as a result of a privacy regulation application
717
+ * (for example, GDPR).
718
+ */
719
+ triggeredByAnonymizeRequest?: boolean | null;
720
+ /** If present, indicates the action that triggered the event. */
721
+ originatedFrom?: string | null;
722
+ /**
723
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
724
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
725
+ */
726
+ entityEventSequence?: string | null;
727
+ }
728
+ /** @oneof */
729
+ interface DomainEventBodyOneOf {
730
+ createdEvent?: EntityCreatedEvent;
731
+ updatedEvent?: EntityUpdatedEvent;
732
+ deletedEvent?: EntityDeletedEvent;
733
+ actionEvent?: ActionEvent;
734
+ }
735
+ interface EntityCreatedEvent {
736
+ entity?: string;
737
+ }
738
+ interface RestoreInfo {
739
+ deletedDate?: Date | null;
740
+ }
741
+ interface EntityUpdatedEvent {
742
+ /**
743
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
744
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
745
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
746
+ */
747
+ currentEntity?: string;
748
+ }
749
+ interface EntityDeletedEvent {
750
+ /** Entity that was deleted. */
751
+ deletedEntity?: string | null;
752
+ }
753
+ interface ActionEvent {
754
+ body?: string;
755
+ }
756
+ interface MessageEnvelope {
757
+ /**
758
+ * App instance ID.
759
+ * @format GUID
760
+ */
761
+ instanceId?: string | null;
762
+ /**
763
+ * Event type.
764
+ * @maxLength 150
765
+ */
766
+ eventType?: string;
767
+ /** The identification type and identity data. */
768
+ identity?: IdentificationData;
769
+ /** Stringify payload. */
770
+ data?: string;
771
+ }
772
+ interface IdentificationData extends IdentificationDataIdOneOf {
773
+ /**
774
+ * ID of a site visitor that has not logged in to the site.
775
+ * @format GUID
776
+ */
777
+ anonymousVisitorId?: string;
778
+ /**
779
+ * ID of a site visitor that has logged in to the site.
780
+ * @format GUID
781
+ */
782
+ memberId?: string;
783
+ /**
784
+ * ID of a Wix user (site owner, contributor, etc.).
785
+ * @format GUID
786
+ */
787
+ wixUserId?: string;
788
+ /**
789
+ * ID of an app.
790
+ * @format GUID
791
+ */
792
+ appId?: string;
793
+ /** @readonly */
794
+ identityType?: WebhookIdentityTypeWithLiterals;
795
+ }
796
+ /** @oneof */
797
+ interface IdentificationDataIdOneOf {
798
+ /**
799
+ * ID of a site visitor that has not logged in to the site.
800
+ * @format GUID
801
+ */
802
+ anonymousVisitorId?: string;
803
+ /**
804
+ * ID of a site visitor that has logged in to the site.
805
+ * @format GUID
806
+ */
807
+ memberId?: string;
808
+ /**
809
+ * ID of a Wix user (site owner, contributor, etc.).
810
+ * @format GUID
811
+ */
812
+ wixUserId?: string;
813
+ /**
814
+ * ID of an app.
815
+ * @format GUID
816
+ */
817
+ appId?: string;
818
+ }
819
+ declare enum WebhookIdentityType {
820
+ UNKNOWN = "UNKNOWN",
821
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
822
+ MEMBER = "MEMBER",
823
+ WIX_USER = "WIX_USER",
824
+ APP = "APP"
825
+ }
826
+ /** @enumType */
827
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
672
828
  interface ListEventsByContactIdRequest {
673
829
  /**
674
830
  * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
@@ -1109,158 +1265,6 @@ interface SiteCloned {
1109
1265
  }
1110
1266
  interface Empty {
1111
1267
  }
1112
- interface DomainEvent extends DomainEventBodyOneOf {
1113
- createdEvent?: EntityCreatedEvent;
1114
- updatedEvent?: EntityUpdatedEvent;
1115
- deletedEvent?: EntityDeletedEvent;
1116
- actionEvent?: ActionEvent;
1117
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1118
- _id?: string;
1119
- /**
1120
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1121
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1122
- */
1123
- entityFqdn?: string;
1124
- /**
1125
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1126
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1127
- */
1128
- slug?: string;
1129
- /** ID of the entity associated with the event. */
1130
- entityId?: string;
1131
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1132
- eventTime?: Date | null;
1133
- /**
1134
- * Whether the event was triggered as a result of a privacy regulation application
1135
- * (for example, GDPR).
1136
- */
1137
- triggeredByAnonymizeRequest?: boolean | null;
1138
- /** If present, indicates the action that triggered the event. */
1139
- originatedFrom?: string | null;
1140
- /**
1141
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1142
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1143
- */
1144
- entityEventSequence?: string | null;
1145
- }
1146
- /** @oneof */
1147
- interface DomainEventBodyOneOf {
1148
- createdEvent?: EntityCreatedEvent;
1149
- updatedEvent?: EntityUpdatedEvent;
1150
- deletedEvent?: EntityDeletedEvent;
1151
- actionEvent?: ActionEvent;
1152
- }
1153
- interface EntityCreatedEvent {
1154
- entity?: string;
1155
- }
1156
- interface RestoreInfo {
1157
- deletedDate?: Date | null;
1158
- }
1159
- interface EntityUpdatedEvent {
1160
- /**
1161
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1162
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1163
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1164
- */
1165
- currentEntity?: string;
1166
- }
1167
- interface EntityDeletedEvent {
1168
- /** Entity that was deleted. */
1169
- deletedEntity?: string | null;
1170
- }
1171
- interface ActionEvent {
1172
- body?: string;
1173
- }
1174
- interface MessageEnvelope {
1175
- /**
1176
- * App instance ID.
1177
- * @format GUID
1178
- */
1179
- instanceId?: string | null;
1180
- /**
1181
- * Event type.
1182
- * @maxLength 150
1183
- */
1184
- eventType?: string;
1185
- /** The identification type and identity data. */
1186
- identity?: IdentificationData;
1187
- /** Stringify payload. */
1188
- data?: string;
1189
- }
1190
- interface IdentificationData extends IdentificationDataIdOneOf {
1191
- /**
1192
- * ID of a site visitor that has not logged in to the site.
1193
- * @format GUID
1194
- */
1195
- anonymousVisitorId?: string;
1196
- /**
1197
- * ID of a site visitor that has logged in to the site.
1198
- * @format GUID
1199
- */
1200
- memberId?: string;
1201
- /**
1202
- * ID of a Wix user (site owner, contributor, etc.).
1203
- * @format GUID
1204
- */
1205
- wixUserId?: string;
1206
- /**
1207
- * ID of an app.
1208
- * @format GUID
1209
- */
1210
- appId?: string;
1211
- /** @readonly */
1212
- identityType?: WebhookIdentityTypeWithLiterals;
1213
- }
1214
- /** @oneof */
1215
- interface IdentificationDataIdOneOf {
1216
- /**
1217
- * ID of a site visitor that has not logged in to the site.
1218
- * @format GUID
1219
- */
1220
- anonymousVisitorId?: string;
1221
- /**
1222
- * ID of a site visitor that has logged in to the site.
1223
- * @format GUID
1224
- */
1225
- memberId?: string;
1226
- /**
1227
- * ID of a Wix user (site owner, contributor, etc.).
1228
- * @format GUID
1229
- */
1230
- wixUserId?: string;
1231
- /**
1232
- * ID of an app.
1233
- * @format GUID
1234
- */
1235
- appId?: string;
1236
- }
1237
- declare enum WebhookIdentityType {
1238
- UNKNOWN = "UNKNOWN",
1239
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1240
- MEMBER = "MEMBER",
1241
- WIX_USER = "WIX_USER",
1242
- APP = "APP"
1243
- }
1244
- /** @enumType */
1245
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1246
- interface UpdateScheduleWithFixedBusinessResourceIdRequest {
1247
- /** @format GUID */
1248
- metaSiteId?: string;
1249
- /** @format GUID */
1250
- currentBusinessResourceId?: string;
1251
- migrateBusinessConferenceId?: boolean;
1252
- }
1253
- interface UpdateScheduleWithFixedBusinessResourceIdResponse {
1254
- }
1255
- interface UpdateEventsWithFixedBusinessResourceIdRequest {
1256
- /** @format GUID */
1257
- metaSiteId?: string;
1258
- /** @format GUID */
1259
- currentBusinessResourceId?: string;
1260
- migrateBusinessConferenceId?: boolean;
1261
- }
1262
- interface UpdateEventsWithFixedBusinessResourceIdResponse {
1263
- }
1264
1268
  interface GetEventRequest {
1265
1269
  /**
1266
1270
  * ID of the event to retrieve.
@@ -1821,6 +1825,16 @@ interface BulkCancelEventResponse {
1821
1825
  /** Total successes and failures. */
1822
1826
  bulkActionMetadata?: BulkActionMetadata;
1823
1827
  }
1828
+ type CancelEventApplicationErrors = {
1829
+ code?: 'EVENT_ALREADY_CANCELLED';
1830
+ description?: string;
1831
+ data?: Record<string, any>;
1832
+ };
1833
+ type BulkCancelEventApplicationErrors = {
1834
+ code?: 'EVENT_ALREADY_CANCELLED';
1835
+ description?: string;
1836
+ data?: Record<string, any>;
1837
+ };
1824
1838
  interface BaseEventMetadata {
1825
1839
  /**
1826
1840
  * App instance ID.
@@ -1869,18 +1883,139 @@ interface EventCancelledEnvelope {
1869
1883
  data: EventCancelled;
1870
1884
  metadata: EventMetadata;
1871
1885
  }
1886
+ /**
1887
+ * Triggered when an event is canceled.
1888
+ *
1889
+ * Not triggered when `INSTANCE` events are canceled. You can use the
1890
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
1891
+ * to get notified about `INSTANCE` events.
1892
+ * @permissionScope Read Calendar - Including PI
1893
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1894
+ * @permissionScope Manage Calendars
1895
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1896
+ * @permissionScope Manage Bookings
1897
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1898
+ * @permissionScope Read Bookings - Including Participants
1899
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1900
+ * @permissionScope Read Bookings - all read permissions
1901
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1902
+ * @permissionScope Manage Bookings - all permissions
1903
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1904
+ * @permissionScope Read bookings calendar - including participants
1905
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1906
+ * @permissionId CALENDAR.EVENT_READ_PI
1907
+ * @webhook
1908
+ * @eventType wix.calendar.v3.event_cancelled
1909
+ * @slug cancelled
1910
+ */
1911
+ declare function onEventCancelled(handler: (event: EventCancelledEnvelope) => void | Promise<void>): void;
1872
1912
  interface EventCreatedEnvelope {
1873
1913
  entity: Event;
1874
1914
  metadata: EventMetadata;
1875
1915
  }
1916
+ /**
1917
+ * Triggered when an event is created, including when an existing `MASTER`
1918
+ * event is split.
1919
+ *
1920
+ * Not triggered when `INSTANCE` events are created. You can use the
1921
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
1922
+ * to get notified about `INSTANCE` events.
1923
+ * @permissionScope Read Calendar - Including PI
1924
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1925
+ * @permissionScope Manage Calendars
1926
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1927
+ * @permissionScope Manage Bookings
1928
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1929
+ * @permissionScope Read Bookings - Including Participants
1930
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1931
+ * @permissionScope Read Bookings - all read permissions
1932
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1933
+ * @permissionScope Manage Bookings - all permissions
1934
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1935
+ * @permissionScope Read bookings calendar - including participants
1936
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1937
+ * @permissionId CALENDAR.EVENT_READ_PI
1938
+ * @webhook
1939
+ * @eventType wix.calendar.v3.event_created
1940
+ * @slug created
1941
+ */
1942
+ declare function onEventCreated(handler: (event: EventCreatedEnvelope) => void | Promise<void>): void;
1876
1943
  interface EventRecurringSplitEnvelope {
1877
1944
  data: RecurringEventSplit;
1878
1945
  metadata: EventMetadata;
1879
1946
  }
1947
+ /**
1948
+ * Triggered when a `MASTER` event is split.
1949
+ * @permissionScope Read Calendar - Including PI
1950
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1951
+ * @permissionScope Manage Calendars
1952
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1953
+ * @permissionScope Manage Bookings
1954
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1955
+ * @permissionScope Read Bookings - Including Participants
1956
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1957
+ * @permissionScope Read Bookings - all read permissions
1958
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1959
+ * @permissionScope Manage Bookings - all permissions
1960
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1961
+ * @permissionScope Read bookings calendar - including participants
1962
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1963
+ * @permissionId CALENDAR.EVENT_READ_PI
1964
+ * @webhook
1965
+ * @eventType wix.calendar.v3.event_recurring_split
1966
+ * @slug recurring_split
1967
+ */
1968
+ declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
1880
1969
  interface EventUpdatedEnvelope {
1881
1970
  entity: Event;
1882
1971
  metadata: EventMetadata;
1883
1972
  }
1973
+ /**
1974
+ * Triggered when an event is updated, including when it's canceled.
1975
+ *
1976
+ * Not triggered when `INSTANCE` events are updated. You can use the
1977
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
1978
+ * to get notified about `INSTANCE` events.
1979
+ * @permissionScope Read Calendar - Including PI
1980
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1981
+ * @permissionScope Manage Calendars
1982
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1983
+ * @permissionScope Manage Bookings
1984
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1985
+ * @permissionScope Read Bookings - Including Participants
1986
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1987
+ * @permissionScope Read Bookings - all read permissions
1988
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1989
+ * @permissionScope Manage Bookings - all permissions
1990
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1991
+ * @permissionScope Read bookings calendar - including participants
1992
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1993
+ * @permissionId CALENDAR.EVENT_READ_PI
1994
+ * @webhook
1995
+ * @eventType wix.calendar.v3.event_updated
1996
+ * @slug updated
1997
+ */
1998
+ declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
1999
+ type EventNonNullablePaths = `status` | `recurrenceType` | `recurrenceRule.frequency` | `recurrenceRule.days` | `transparency` | `location.type` | `resources` | `resources.${number}.transparency` | `resources.${number}.permissionRole` | `participants.list` | `participants.status` | `conferencingDetails.type` | `inheritedFields` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
2000
+ /**
2001
+ * Retrieves a list of events filtered by the participant's
2002
+ * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
2003
+ * ID.
2004
+ *
2005
+ *
2006
+ * You can't set `toLocalDate` to a value that's more than a full year after
2007
+ * `fromLocalDate`.
2008
+ * @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2009
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2010
+ * @public
2011
+ * @requiredField contactId
2012
+ * @permissionId CALENDAR.EVENT_READ_PI
2013
+ * @applicableIdentity APP
2014
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
2015
+ */
2016
+ declare function listEventsByContactId(contactId: string, options?: ListEventsByContactIdOptions): Promise<NonNullablePaths<ListEventsByContactIdResponse, {
2017
+ [P in EventNonNullablePaths]: `events.${number}.${P}`;
2018
+ }[EventNonNullablePaths]>>;
1884
2019
  interface ListEventsByContactIdOptions {
1885
2020
  /**
1886
2021
  * Local start date and time from which events are returned in
@@ -1920,6 +2055,31 @@ interface ListEventsByContactIdOptions {
1920
2055
  /** Cursor to retrieve the next page of the results. */
1921
2056
  cursorPaging?: CommonCursorPaging;
1922
2057
  }
2058
+ /**
2059
+ * Retrieves a list of events filtered by the participant's
2060
+ * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
2061
+ * ID.
2062
+ *
2063
+ *
2064
+ * You can't set `toLocalDate` to a value that's more than a full year after
2065
+ * `fromLocalDate`.
2066
+ * @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2067
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2068
+ * Provide `me` to retrieve events for the currently logged-in member.
2069
+ * You must have the `Read Calendars - Including PI`
2070
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2071
+ * to retrieve events for members who aren't the currently logged in member.
2072
+ * @public
2073
+ * @requiredField memberId
2074
+ * @permissionId CALENDAR.EVENT_READ
2075
+ * @permissionId CALENDAR.EVENT_READ_PI
2076
+ * @applicableIdentity APP
2077
+ * @applicableIdentity VISITOR
2078
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
2079
+ */
2080
+ declare function listEventsByMemberId(memberId: string, options?: ListEventsByMemberIdOptions): Promise<NonNullablePaths<ListEventsByMemberIdResponse, {
2081
+ [P in EventNonNullablePaths]: `events.${number}.${P}`;
2082
+ }[EventNonNullablePaths]>>;
1923
2083
  interface ListEventsByMemberIdOptions {
1924
2084
  /**
1925
2085
  * Local start date and time from which events are returned in
@@ -1969,6 +2129,22 @@ interface ListEventsByMemberIdOptions {
1969
2129
  */
1970
2130
  eventIds?: string[];
1971
2131
  }
2132
+ /**
2133
+ * Retrieves an event.
2134
+ * @param eventId - ID of the event to retrieve.
2135
+ *
2136
+ * Min: 36 characters
2137
+ * Max: 250 characters
2138
+ * @public
2139
+ * @requiredField eventId
2140
+ * @permissionId CALENDAR.EVENT_READ
2141
+ * @permissionId CALENDAR.EVENT_READ_PI
2142
+ * @applicableIdentity APP
2143
+ * @applicableIdentity VISITOR
2144
+ * @returns Retrieved event.
2145
+ * @fqn wix.calendar.events.v3.EventsService.GetEvent
2146
+ */
2147
+ declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
1972
2148
  interface GetEventOptions {
1973
2149
  /**
1974
2150
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -1993,6 +2169,23 @@ interface GetEventOptions {
1993
2169
  */
1994
2170
  fields?: RequestedFieldsWithLiterals[];
1995
2171
  }
2172
+ /**
2173
+ * Retrieves a list of events by their IDs.
2174
+ * @param eventIds - IDs of the events to retrieve.
2175
+ *
2176
+ * Min: 1 event ID
2177
+ * Min: 100 event IDs
2178
+ * @public
2179
+ * @requiredField eventIds
2180
+ * @permissionId CALENDAR.EVENT_READ
2181
+ * @permissionId CALENDAR.EVENT_READ_PI
2182
+ * @applicableIdentity APP
2183
+ * @applicableIdentity VISITOR
2184
+ * @fqn wix.calendar.events.v3.EventsService.ListEvents
2185
+ */
2186
+ declare function listEvents(eventIds: string[], options?: ListEventsOptions): Promise<NonNullablePaths<ListEventsResponse, {
2187
+ [P in EventNonNullablePaths]: `events.${number}.${P}`;
2188
+ }[EventNonNullablePaths]>>;
1996
2189
  interface ListEventsOptions {
1997
2190
  /**
1998
2191
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2017,6 +2210,32 @@ interface ListEventsOptions {
2017
2210
  */
2018
2211
  fields?: RequestedFieldsWithLiterals[];
2019
2212
  }
2213
+ /**
2214
+ * Creates a query to retrieve a list of events.
2215
+ *
2216
+ * The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object.
2217
+ *
2218
+ * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-builder/find) function.
2219
+ *
2220
+ * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results that `queryEvents()` returns.
2221
+ *
2222
+ * `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override:
2223
+ *
2224
+ * + `limit` is `50`.
2225
+ * + Sorted by `event.start` in ascending order.
2226
+ *
2227
+ * The functions that are chained to `queryEvents()` are applied in the order they are called.
2228
+ *
2229
+ * The following `EventsQueryBuilder` functions are supported for the `queryEvents()` function. For a full description of the events object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-result/items) property in `EventsQueryResult`.
2230
+ *
2231
+ * @public
2232
+ * @permissionId CALENDAR.EVENT_READ
2233
+ * @permissionId CALENDAR.EVENT_READ_PI
2234
+ * @applicableIdentity APP
2235
+ * @applicableIdentity VISITOR
2236
+ * @fqn wix.calendar.events.v3.EventsService.QueryEvents
2237
+ */
2238
+ declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
2020
2239
  interface QueryEventsOptions {
2021
2240
  /**
2022
2241
  * Local start date and time from which events are returned in
@@ -2125,6 +2344,37 @@ interface EventsQueryBuilder {
2125
2344
  skipTo: (cursor: string) => EventsQueryBuilder;
2126
2345
  find: () => Promise<EventsQueryResult>;
2127
2346
  }
2347
+ /**
2348
+ * Creates an event.
2349
+ *
2350
+ *
2351
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is created. Then, you can't set `start.localDate` to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates.
2352
+ *
2353
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`. `INSTANCE` events are generated automatically based on the recurrence rule in the relevant `MASTER` event. `EXCEPTION` events are automatically created when you [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2354
+ * @param event - Event to create.
2355
+ * @public
2356
+ * @requiredField event
2357
+ * @requiredField event.conferencingDetails.guestUrl
2358
+ * @requiredField event.conferencingDetails.hostUrl
2359
+ * @requiredField event.conferencingDetails.type
2360
+ * @requiredField event.end
2361
+ * @requiredField event.end.localDate
2362
+ * @requiredField event.location.type
2363
+ * @requiredField event.participants.list.name
2364
+ * @requiredField event.recurrenceRule.days
2365
+ * @requiredField event.recurrenceRule.frequency
2366
+ * @requiredField event.recurrenceRule.until.localDate
2367
+ * @requiredField event.resources._id
2368
+ * @requiredField event.scheduleId
2369
+ * @requiredField event.start
2370
+ * @requiredField event.start.localDate
2371
+ * @permissionId CALENDAR.EVENT_CREATE_OWN
2372
+ * @permissionId CALENDAR.EVENT_CREATE
2373
+ * @applicableIdentity APP
2374
+ * @returns Created event.
2375
+ * @fqn wix.calendar.events.v3.EventsService.CreateEvent
2376
+ */
2377
+ declare function createEvent(event: NonNullablePaths<Event, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `scheduleId` | `start` | `start.localDate`>, options?: CreateEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
2128
2378
  interface CreateEventOptions {
2129
2379
  /**
2130
2380
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2141,6 +2391,46 @@ interface CreateEventOptions {
2141
2391
  */
2142
2392
  idempotencyKey?: string | null;
2143
2393
  }
2394
+ /**
2395
+ * Creates multiple events in bulk.
2396
+ *
2397
+ *
2398
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
2399
+ * created. Then, you can't set `start.localDate` to a past date, though the time can be
2400
+ * earlier on the same day. You can, however, create single-occurrence events for
2401
+ * past dates.
2402
+ *
2403
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2404
+ * `INSTANCE` events are generated automatically based on the recurrence rule in the
2405
+ * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2406
+ * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2407
+ * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2408
+ * @param events - Events to create.
2409
+ * @public
2410
+ * @requiredField events
2411
+ * @requiredField events.event
2412
+ * @requiredField events.event.conferencingDetails.guestUrl
2413
+ * @requiredField events.event.conferencingDetails.hostUrl
2414
+ * @requiredField events.event.conferencingDetails.type
2415
+ * @requiredField events.event.end
2416
+ * @requiredField events.event.end.localDate
2417
+ * @requiredField events.event.location.type
2418
+ * @requiredField events.event.participants.list.name
2419
+ * @requiredField events.event.recurrenceRule.days
2420
+ * @requiredField events.event.recurrenceRule.frequency
2421
+ * @requiredField events.event.recurrenceRule.until.localDate
2422
+ * @requiredField events.event.resources._id
2423
+ * @requiredField events.event.scheduleId
2424
+ * @requiredField events.event.start
2425
+ * @requiredField events.event.start.localDate
2426
+ * @permissionId CALENDAR.EVENT_CREATE_OWN
2427
+ * @permissionId CALENDAR.EVENT_CREATE
2428
+ * @applicableIdentity APP
2429
+ * @fqn wix.calendar.events.v3.EventsService.BulkCreateEvent
2430
+ */
2431
+ declare function bulkCreateEvent(events: NonNullablePaths<MaskedEvent, `event` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.scheduleId` | `event.start` | `event.start.localDate`>[], options?: BulkCreateEventOptions): Promise<NonNullablePaths<BulkCreateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2432
+ [P in EventNonNullablePaths]: `results.${number}.item.${P}`;
2433
+ }[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
2144
2434
  interface BulkCreateEventOptions {
2145
2435
  /**
2146
2436
  * Whether to return created events.
@@ -2157,6 +2447,41 @@ interface BulkCreateEventOptions {
2157
2447
  */
2158
2448
  timeZone?: string | null;
2159
2449
  }
2450
+ /**
2451
+ * Updates an event.
2452
+ *
2453
+ *
2454
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
2455
+ * `recurrenceType` automatically changes to `EXCEPTION`.
2456
+ *
2457
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
2458
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
2459
+ * + For future `INSTANCE` events, all relevant fields are updated.
2460
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
2461
+ * applied, while other fields remain unchanged.
2462
+ * @param _id - Event ID.
2463
+ * @public
2464
+ * @requiredField _id
2465
+ * @requiredField event
2466
+ * @requiredField event.conferencingDetails.guestUrl
2467
+ * @requiredField event.conferencingDetails.hostUrl
2468
+ * @requiredField event.conferencingDetails.type
2469
+ * @requiredField event.end.localDate
2470
+ * @requiredField event.location.type
2471
+ * @requiredField event.participants.list.name
2472
+ * @requiredField event.recurrenceRule.days
2473
+ * @requiredField event.recurrenceRule.frequency
2474
+ * @requiredField event.recurrenceRule.until.localDate
2475
+ * @requiredField event.resources._id
2476
+ * @requiredField event.revision
2477
+ * @requiredField event.start.localDate
2478
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2479
+ * @permissionId CALENDAR.EVENT_UPDATE
2480
+ * @applicableIdentity APP
2481
+ * @returns Updated event.
2482
+ * @fqn wix.calendar.events.v3.EventsService.UpdateEvent
2483
+ */
2484
+ declare function updateEvent(_id: string, event: NonNullablePaths<UpdateEvent, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `revision` | `start.localDate`>, options?: UpdateEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
2160
2485
  interface UpdateEvent {
2161
2486
  /**
2162
2487
  * Event ID.
@@ -2403,6 +2728,46 @@ interface UpdateEventOptions {
2403
2728
  */
2404
2729
  timeZone?: string | null;
2405
2730
  }
2731
+ /**
2732
+ * Updates multiple events in bulk.
2733
+ *
2734
+ *
2735
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
2736
+ * `recurrenceType` automatically changes to `EXCEPTION`.
2737
+ *
2738
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
2739
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
2740
+ * + For future `INSTANCE` events, all relevant fields are updated.
2741
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
2742
+ * applied, while other fields remain unchanged.
2743
+ * @param events - Events to update.
2744
+ *
2745
+ * Min: 1 event
2746
+ * Max: 50 events
2747
+ * @public
2748
+ * @requiredField events
2749
+ * @requiredField events.event
2750
+ * @requiredField events.event._id
2751
+ * @requiredField events.event.conferencingDetails.guestUrl
2752
+ * @requiredField events.event.conferencingDetails.hostUrl
2753
+ * @requiredField events.event.conferencingDetails.type
2754
+ * @requiredField events.event.end.localDate
2755
+ * @requiredField events.event.location.type
2756
+ * @requiredField events.event.participants.list.name
2757
+ * @requiredField events.event.recurrenceRule.days
2758
+ * @requiredField events.event.recurrenceRule.frequency
2759
+ * @requiredField events.event.recurrenceRule.until.localDate
2760
+ * @requiredField events.event.resources._id
2761
+ * @requiredField events.event.revision
2762
+ * @requiredField events.event.start.localDate
2763
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2764
+ * @permissionId CALENDAR.EVENT_UPDATE
2765
+ * @applicableIdentity APP
2766
+ * @fqn wix.calendar.events.v3.EventsService.BulkUpdateEvent
2767
+ */
2768
+ declare function bulkUpdateEvent(events: NonNullablePaths<BulkUpdateEventRequestMaskedEvent, `event` | `event._id` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.revision` | `event.start.localDate`>[], options?: BulkUpdateEventOptions): Promise<NonNullablePaths<BulkUpdateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2769
+ [P in EventNonNullablePaths]: `results.${number}.item.${P}`;
2770
+ }[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
2406
2771
  interface BulkUpdateEventOptions {
2407
2772
  /**
2408
2773
  * Whether to return the updated events.
@@ -2424,6 +2789,37 @@ interface BulkUpdateEventOptions {
2424
2789
  */
2425
2790
  timeZone?: string | null;
2426
2791
  }
2792
+ /**
2793
+ * Restores the event's default values from the relevant schedule or `MASTER`
2794
+ * event.
2795
+ *
2796
+ *
2797
+ * You must provide `fields` to specify which `inheritedFields` are restored.
2798
+ *
2799
+ * For example, if you've created an event that takes place in a non-default
2800
+ * location with a custom title and capacity, but you want to reset only title
2801
+ * and capacity to default values without affecting the location, provide the
2802
+ * event ID and set `fields` to `["TITLE", "CAPACITY"]`.
2803
+ *
2804
+ * Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
2805
+ * for more information.
2806
+ * @param eventId - ID of the event for which to restore default values.
2807
+ * @param fields - Fields for which to restore default values.
2808
+ *
2809
+ * `TIME` restores default values for `start` and `end`.
2810
+ *
2811
+ * Min: 1 field
2812
+ * @public
2813
+ * @requiredField eventId
2814
+ * @requiredField fields
2815
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2816
+ * @permissionId CALENDAR.EVENT_UPDATE
2817
+ * @applicableIdentity APP
2818
+ * @fqn wix.calendar.events.v3.EventsService.RestoreEventDefaults
2819
+ */
2820
+ declare function restoreEventDefaults(eventId: string, fields: FieldWithLiterals[], options?: RestoreEventDefaultsOptions): Promise<NonNullablePaths<RestoreEventDefaultsResponse, {
2821
+ [P in EventNonNullablePaths]: `event.${P}`;
2822
+ }[EventNonNullablePaths]>>;
2427
2823
  interface RestoreEventDefaultsOptions {
2428
2824
  /**
2429
2825
  * Information about whether participants of the updated event are notified and
@@ -2439,6 +2835,51 @@ interface RestoreEventDefaultsOptions {
2439
2835
  */
2440
2836
  timeZone?: string | null;
2441
2837
  }
2838
+ /**
2839
+ * Splits a recurring `MASTER` event into 2 separate `MASTER` events.
2840
+ *
2841
+ *
2842
+ * You must provide a `splitLocalDate` that's in the future and after the `start`
2843
+ * date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally,
2844
+ * there must be another `INSTANCE` or `EXCEPTION` event following this next event,
2845
+ * as the changes wouldn't affect any event without a subsequent occurrence.
2846
+ *
2847
+ * If you want to modify a `MASTER` event with the changes already applying to
2848
+ * the very next event, use
2849
+ * [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2850
+ * instead, as this preserves past events and only modifies future events.
2851
+ *
2852
+ * The main consequences are:
2853
+ * - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate`
2854
+ * is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION`
2855
+ * event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event
2856
+ * starts before but ends after `splitLocalDate`, `until.localDate` is set
2857
+ * to value that's later than `splitLocalDate`.
2858
+ * - **A new `MASTER` event is created**, starting from the first event that
2859
+ * begins after `splitLocalDate`.
2860
+ * - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**.
2861
+ * Their `recurringEventId` is set to the ID of the newly created `MASTER` event.
2862
+ * @param recurringEventId - ID of the `MASTER` event to split.
2863
+ * @param splitLocalDate - Local date and time at which the `MASTER` event is split in
2864
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2865
+ * `2025-03-11T09:00:00`.
2866
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
2867
+ * `EXCEPTION` event in the series. Additionally, there must be another
2868
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
2869
+ * wouldn't affect any event without a subsequent occurrence.
2870
+ * @public
2871
+ * @requiredField recurringEventId
2872
+ * @requiredField splitLocalDate
2873
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2874
+ * @permissionId CALENDAR.EVENT_UPDATE
2875
+ * @applicableIdentity APP
2876
+ * @fqn wix.calendar.events.v3.EventsService.SplitRecurringEvent
2877
+ */
2878
+ declare function splitRecurringEvent(recurringEventId: string, splitLocalDate: string, options?: SplitRecurringEventOptions): Promise<NonNullablePaths<SplitRecurringEventResponse, {
2879
+ [P in EventNonNullablePaths]: `updatedRecurringEventEndingBeforeSplit.${P}`;
2880
+ }[EventNonNullablePaths] | {
2881
+ [P in EventNonNullablePaths]: `newRecurringEventStartingFromSplit.${P}`;
2882
+ }[EventNonNullablePaths]>>;
2442
2883
  interface SplitRecurringEventOptions {
2443
2884
  /**
2444
2885
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2449,6 +2890,21 @@ interface SplitRecurringEventOptions {
2449
2890
  */
2450
2891
  timeZone?: string | null;
2451
2892
  }
2893
+ /**
2894
+ * Cancels an event.
2895
+ * @param eventId - ID of the event to cancel.
2896
+ * @public
2897
+ * @requiredField eventId
2898
+ * @permissionId CALENDAR.EVENT_CANCEL_OWN
2899
+ * @permissionId CALENDAR.EVENT_CANCEL
2900
+ * @applicableIdentity APP
2901
+ * @fqn wix.calendar.events.v3.EventsService.CancelEvent
2902
+ */
2903
+ declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
2904
+ [P in EventNonNullablePaths]: `event.${P}`;
2905
+ }[EventNonNullablePaths]> & {
2906
+ __applicationErrorsType?: CancelEventApplicationErrors;
2907
+ }>;
2452
2908
  interface CancelEventOptions {
2453
2909
  /**
2454
2910
  * Information about whether participants of the canceled event are notified and
@@ -2464,6 +2920,21 @@ interface CancelEventOptions {
2464
2920
  */
2465
2921
  timeZone?: string | null;
2466
2922
  }
2923
+ /**
2924
+ * Cancels multiple events in bulk.
2925
+ * @param eventIds - IDs of the events to cancel.
2926
+ * @public
2927
+ * @requiredField eventIds
2928
+ * @permissionId CALENDAR.EVENT_CANCEL_OWN
2929
+ * @permissionId CALENDAR.EVENT_CANCEL
2930
+ * @applicableIdentity APP
2931
+ * @fqn wix.calendar.events.v3.EventsService.BulkCancelEvent
2932
+ */
2933
+ declare function bulkCancelEvent(eventIds: string[], options?: BulkCancelEventOptions): Promise<NonNullablePaths<BulkCancelEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2934
+ [P in EventNonNullablePaths]: `results.${number}.item.${P}`;
2935
+ }[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`> & {
2936
+ __applicationErrorsType?: BulkCancelEventApplicationErrors;
2937
+ }>;
2467
2938
  interface BulkCancelEventOptions {
2468
2939
  /**
2469
2940
  * Whether to return the canceled events.
@@ -2486,4 +2957,4 @@ interface BulkCancelEventOptions {
2486
2957
  timeZone?: string | null;
2487
2958
  }
2488
2959
 
2489
- export { type Participants as $, Type as A, type BulkCreateEventOptions as B, type CreateEventOptions as C, Day as D, type Event as E, type FieldWithLiterals as F, type GetEventOptions as G, Field as H, IdentityType as I, PlacementType as J, DayOfWeek as K, type ListEventsByContactIdOptions as L, type MaskedEvent as M, ResolutionMethod as N, RequestedFields as O, ParticipantsStatus as P, type QueryEventsOptions as Q, type RestoreEventDefaultsOptions as R, type SplitRecurringEventOptions as S, Transparency as T, type UpdateEvent as U, SortOrder as V, WebhookIdentityType as W, type RecurrenceRule as X, type Location as Y, type ZonedDate as Z, type Resource as _, type ListEventsByContactIdResponse as a, type CreateEventRequest as a$, type Participant as a0, type ConferencingDetails as a1, type Permission as a2, type CommonIdentificationData as a3, type CommonIdentificationDataIdOneOf as a4, type ExtendedFields as a5, type RecurringEventSplit as a6, type EventCancelled as a7, type ParticipantNotification as a8, type EventUpdatedWithMetadata as a9, type DomainEvent as aA, type DomainEventBodyOneOf as aB, type EntityCreatedEvent as aC, type RestoreInfo as aD, type EntityUpdatedEvent as aE, type EntityDeletedEvent as aF, type ActionEvent as aG, type MessageEnvelope as aH, type IdentificationData as aI, type IdentificationDataIdOneOf as aJ, type UpdateScheduleWithFixedBusinessResourceIdRequest as aK, type UpdateScheduleWithFixedBusinessResourceIdResponse as aL, type UpdateEventsWithFixedBusinessResourceIdRequest as aM, type UpdateEventsWithFixedBusinessResourceIdResponse as aN, type GetEventRequest as aO, type GetEventResponse as aP, type ListEventsRequest as aQ, type QueryEventsRequest as aR, type CursorQuery as aS, type CursorQueryPagingMethodOneOf as aT, type Sorting as aU, type CursorPaging as aV, type QueryEventsResponse as aW, type CursorPagingMetadata as aX, type Cursors as aY, type ListRecurringEventInstancesHistoryRequest as aZ, type ListRecurringEventInstancesHistoryResponse as a_, type ListEventsByContactIdRequest as aa, type CommonCursorPaging as ab, type CommonCursorPagingMetadata as ac, type CommonCursors as ad, type ListEventsByMemberIdRequest as ae, type SitePropertiesNotification as af, type SitePropertiesEvent as ag, type Properties as ah, type Categories as ai, type Locale as aj, type Address as ak, type AddressHint as al, type GeoCoordinates as am, type BusinessSchedule as an, type TimePeriod as ao, type SpecialHourPeriod as ap, type Multilingual as aq, type SupportedLanguage as ar, type ConsentPolicy as as, type Translation as at, type ChangeContext as au, type ChangeContextPayloadOneOf as av, type PropertiesChange as aw, type SiteCreated as ax, type SiteCloned as ay, type Empty as az, type ListEventsByMemberIdOptions as b, type CreateEventResponse as b0, type BulkCreateEventRequest as b1, type BulkEventResult as b2, type ItemMetadata as b3, type ApplicationError as b4, type BulkActionMetadata as b5, type UpdateEventRequest as b6, type UpdateEventResponse as b7, type BulkUpdateEventRequest as b8, type UpdateEventParticipantsRequest as b9, type UpdateEventParticipantsResponse as ba, type RestoreEventDefaultsRequest as bb, type SplitRecurringEventRequest as bc, type CancelEventRequest as bd, type BulkCancelEventRequest as be, type BaseEventMetadata as bf, type EventMetadata as bg, type EventsQueryResult as bh, type ListEventsByMemberIdResponse as c, type ListEventsOptions as d, type ListEventsResponse as e, type EventsQueryBuilder as f, type BulkCreateEventResponse as g, type UpdateEventOptions as h, type BulkUpdateEventRequestMaskedEvent as i, type BulkUpdateEventOptions as j, type BulkUpdateEventResponse as k, type RestoreEventDefaultsResponse as l, type SplitRecurringEventResponse as m, type CancelEventOptions as n, type CancelEventResponse as o, type BulkCancelEventOptions as p, type BulkCancelEventResponse as q, type EventCancelledEnvelope as r, type EventCreatedEnvelope as s, type EventRecurringSplitEnvelope as t, type EventUpdatedEnvelope as u, Status as v, RecurrenceType as w, Frequency as x, LocationType as y, Role as z };
2960
+ export { type ActionEvent, type Address, type AddressHint, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCancelEventApplicationErrors, type BulkCancelEventOptions, type BulkCancelEventRequest, type BulkCancelEventResponse, type BulkCreateEventOptions, type BulkCreateEventRequest, type BulkCreateEventResponse, type BulkEventResult, type BulkUpdateEventOptions, type BulkUpdateEventRequest, type BulkUpdateEventRequestMaskedEvent, type BulkUpdateEventResponse, type BusinessSchedule, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CommonCursorPaging, type CommonCursorPagingMetadata, type CommonCursors, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type ConferencingDetails, type ConsentPolicy, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, Day, DayOfWeek, type DayOfWeekWithLiterals, type DayWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCancelled, type EventCancelledEnvelope, type EventCreatedEnvelope, type EventMetadata, type EventRecurringSplitEnvelope, type EventUpdatedEnvelope, type EventUpdatedWithMetadata, type EventsQueryBuilder, type EventsQueryResult, type ExtendedFields, Field, type FieldWithLiterals, Frequency, type FrequencyWithLiterals, type GeoCoordinates, type GetEventOptions, type GetEventRequest, type GetEventResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type ItemMetadata, type ListEventsByContactIdOptions, type ListEventsByContactIdRequest, type ListEventsByContactIdResponse, type ListEventsByMemberIdOptions, type ListEventsByMemberIdRequest, type ListEventsByMemberIdResponse, type ListEventsOptions, type ListEventsRequest, type ListEventsResponse, type ListRecurringEventInstancesHistoryRequest, type ListRecurringEventInstancesHistoryResponse, type Locale, type Location, LocationType, type LocationTypeWithLiterals, type MaskedEvent, type MessageEnvelope, type Multilingual, type Participant, type ParticipantNotification, type Participants, ParticipantsStatus, type ParticipantsStatusWithLiterals, type Permission, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type RecurrenceRule, RecurrenceType, type RecurrenceTypeWithLiterals, type RecurringEventSplit, RequestedFields, type RequestedFieldsWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type Resource, type RestoreEventDefaultsOptions, type RestoreEventDefaultsRequest, type RestoreEventDefaultsResponse, type RestoreInfo, Role, type RoleWithLiterals, type SiteCloned, type SiteCreated, type SitePropertiesEvent, type SitePropertiesNotification, SortOrder, type SortOrderWithLiterals, type Sorting, type SpecialHourPeriod, type SplitRecurringEventOptions, type SplitRecurringEventRequest, type SplitRecurringEventResponse, Status, type StatusWithLiterals, type SupportedLanguage, type TimePeriod, type Translation, Transparency, type TransparencyWithLiterals, Type, type TypeWithLiterals, type UpdateEvent, type UpdateEventOptions, type UpdateEventParticipantsRequest, type UpdateEventParticipantsResponse, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventsWithFixedBusinessResourceIdRequest, type UpdateEventsWithFixedBusinessResourceIdResponse, type UpdateScheduleWithFixedBusinessResourceIdRequest, type UpdateScheduleWithFixedBusinessResourceIdResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZonedDate, bulkCancelEvent, bulkCreateEvent, bulkUpdateEvent, cancelEvent, createEvent, getEvent, listEvents, listEventsByContactId, listEventsByMemberId, onEventCancelled, onEventCreated, onEventRecurringSplit, onEventUpdated, queryEvents, restoreEventDefaults, splitRecurringEvent, updateEvent };