@wix/auto_sdk_calendar_events 1.0.0

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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/calendar-v3-event-events.context.d.ts +51 -0
  11. package/build/cjs/src/calendar-v3-event-events.context.js +71 -0
  12. package/build/cjs/src/calendar-v3-event-events.context.js.map +1 -0
  13. package/build/cjs/src/calendar-v3-event-events.http.d.ts +144 -0
  14. package/build/cjs/src/calendar-v3-event-events.http.js +777 -0
  15. package/build/cjs/src/calendar-v3-event-events.http.js.map +1 -0
  16. package/build/cjs/src/calendar-v3-event-events.meta.d.ts +39 -0
  17. package/build/cjs/src/calendar-v3-event-events.meta.js +275 -0
  18. package/build/cjs/src/calendar-v3-event-events.meta.js.map +1 -0
  19. package/build/cjs/src/calendar-v3-event-events.public.d.ts +242 -0
  20. package/build/cjs/src/calendar-v3-event-events.public.js +196 -0
  21. package/build/cjs/src/calendar-v3-event-events.public.js.map +1 -0
  22. package/build/cjs/src/calendar-v3-event-events.types.d.ts +1750 -0
  23. package/build/cjs/src/calendar-v3-event-events.types.js +157 -0
  24. package/build/cjs/src/calendar-v3-event-events.types.js.map +1 -0
  25. package/build/cjs/src/calendar-v3-event-events.universal.d.ts +3063 -0
  26. package/build/cjs/src/calendar-v3-event-events.universal.js +1182 -0
  27. package/build/cjs/src/calendar-v3-event-events.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/calendar-v3-event-events.context.d.ts +51 -0
  39. package/build/es/src/calendar-v3-event-events.context.js +51 -0
  40. package/build/es/src/calendar-v3-event-events.context.js.map +1 -0
  41. package/build/es/src/calendar-v3-event-events.http.d.ts +144 -0
  42. package/build/es/src/calendar-v3-event-events.http.js +761 -0
  43. package/build/es/src/calendar-v3-event-events.http.js.map +1 -0
  44. package/build/es/src/calendar-v3-event-events.meta.d.ts +39 -0
  45. package/build/es/src/calendar-v3-event-events.meta.js +236 -0
  46. package/build/es/src/calendar-v3-event-events.meta.js.map +1 -0
  47. package/build/es/src/calendar-v3-event-events.public.d.ts +242 -0
  48. package/build/es/src/calendar-v3-event-events.public.js +163 -0
  49. package/build/es/src/calendar-v3-event-events.public.js.map +1 -0
  50. package/build/es/src/calendar-v3-event-events.types.d.ts +1750 -0
  51. package/build/es/src/calendar-v3-event-events.types.js +154 -0
  52. package/build/es/src/calendar-v3-event-events.types.js.map +1 -0
  53. package/build/es/src/calendar-v3-event-events.universal.d.ts +3063 -0
  54. package/build/es/src/calendar-v3-event-events.universal.js +1143 -0
  55. package/build/es/src/calendar-v3-event-events.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +51 -0
  66. package/build/internal/cjs/src/calendar-v3-event-events.context.js +71 -0
  67. package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +1 -0
  68. package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +144 -0
  69. package/build/internal/cjs/src/calendar-v3-event-events.http.js +777 -0
  70. package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +1 -0
  71. package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +39 -0
  72. package/build/internal/cjs/src/calendar-v3-event-events.meta.js +275 -0
  73. package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +1 -0
  74. package/build/internal/cjs/src/calendar-v3-event-events.public.d.ts +242 -0
  75. package/build/internal/cjs/src/calendar-v3-event-events.public.js +196 -0
  76. package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +1 -0
  77. package/build/internal/cjs/src/calendar-v3-event-events.types.d.ts +1750 -0
  78. package/build/internal/cjs/src/calendar-v3-event-events.types.js +157 -0
  79. package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +1 -0
  80. package/build/internal/cjs/src/calendar-v3-event-events.universal.d.ts +3063 -0
  81. package/build/internal/cjs/src/calendar-v3-event-events.universal.js +1182 -0
  82. package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/calendar-v3-event-events.context.d.ts +51 -0
  93. package/build/internal/es/src/calendar-v3-event-events.context.js +51 -0
  94. package/build/internal/es/src/calendar-v3-event-events.context.js.map +1 -0
  95. package/build/internal/es/src/calendar-v3-event-events.http.d.ts +144 -0
  96. package/build/internal/es/src/calendar-v3-event-events.http.js +761 -0
  97. package/build/internal/es/src/calendar-v3-event-events.http.js.map +1 -0
  98. package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +39 -0
  99. package/build/internal/es/src/calendar-v3-event-events.meta.js +236 -0
  100. package/build/internal/es/src/calendar-v3-event-events.meta.js.map +1 -0
  101. package/build/internal/es/src/calendar-v3-event-events.public.d.ts +242 -0
  102. package/build/internal/es/src/calendar-v3-event-events.public.js +163 -0
  103. package/build/internal/es/src/calendar-v3-event-events.public.js.map +1 -0
  104. package/build/internal/es/src/calendar-v3-event-events.types.d.ts +1750 -0
  105. package/build/internal/es/src/calendar-v3-event-events.types.js +154 -0
  106. package/build/internal/es/src/calendar-v3-event-events.types.js.map +1 -0
  107. package/build/internal/es/src/calendar-v3-event-events.universal.d.ts +3063 -0
  108. package/build/internal/es/src/calendar-v3-event-events.universal.js +1143 -0
  109. package/build/internal/es/src/calendar-v3-event-events.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1143 @@
1
+ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
+ import { queryBuilder } from '@wix/sdk-runtime/query-builder';
3
+ import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
4
+ import * as ambassadorWixCalendarV3Event from './calendar-v3-event-events.http.js';
5
+ export var Status;
6
+ (function (Status) {
7
+ Status["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
8
+ /** Event is scheduled to happen or has happened. */
9
+ Status["CONFIRMED"] = "CONFIRMED";
10
+ /** Event has been canceled. */
11
+ Status["CANCELLED"] = "CANCELLED";
12
+ })(Status || (Status = {}));
13
+ export var RecurrenceType;
14
+ (function (RecurrenceType) {
15
+ RecurrenceType["UNKNOWN_RECURRENCE_TYPE"] = "UNKNOWN_RECURRENCE_TYPE";
16
+ /** The event occurs only once and doesn't repeat. */
17
+ RecurrenceType["NONE"] = "NONE";
18
+ /** Defines the recurrence pattern for a series of recurring events. */
19
+ RecurrenceType["MASTER"] = "MASTER";
20
+ /** A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`. */
21
+ RecurrenceType["INSTANCE"] = "INSTANCE";
22
+ /** A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event. */
23
+ RecurrenceType["EXCEPTION"] = "EXCEPTION";
24
+ })(RecurrenceType || (RecurrenceType = {}));
25
+ export var Frequency;
26
+ (function (Frequency) {
27
+ Frequency["UNKNOWN_FREQUENCY"] = "UNKNOWN_FREQUENCY";
28
+ /** The event's recurrence pattern is based on weeks. */
29
+ Frequency["WEEKLY"] = "WEEKLY";
30
+ })(Frequency || (Frequency = {}));
31
+ export var Day;
32
+ (function (Day) {
33
+ /** The recurring event takes place on Mondays. */
34
+ Day["MONDAY"] = "MONDAY";
35
+ /** The recurring event takes place on Tuesdays. */
36
+ Day["TUESDAY"] = "TUESDAY";
37
+ /** The recurring event takes place on Wednesday. */
38
+ Day["WEDNESDAY"] = "WEDNESDAY";
39
+ /** The recurring event takes place on Thursdays. */
40
+ Day["THURSDAY"] = "THURSDAY";
41
+ /** The recurring event takes place on Fridays. */
42
+ Day["FRIDAY"] = "FRIDAY";
43
+ /** The recurring event takes place on Saturdays. */
44
+ Day["SATURDAY"] = "SATURDAY";
45
+ /** The recurring event takes place on Sundays. */
46
+ Day["SUNDAY"] = "SUNDAY";
47
+ })(Day || (Day = {}));
48
+ export var Transparency;
49
+ (function (Transparency) {
50
+ Transparency["UNKNOWN_TRANSPARENCY"] = "UNKNOWN_TRANSPARENCY";
51
+ /** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
52
+ Transparency["OPAQUE"] = "OPAQUE";
53
+ /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
54
+ Transparency["TRANSPARENT"] = "TRANSPARENT";
55
+ })(Transparency || (Transparency = {}));
56
+ export var LocationType;
57
+ (function (LocationType) {
58
+ LocationType["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
59
+ /** The event is held at a business location. */
60
+ LocationType["BUSINESS"] = "BUSINESS";
61
+ /** The event is held at the customer's location, such as their home or office. */
62
+ LocationType["CUSTOMER"] = "CUSTOMER";
63
+ /** The event is held at an address or venue not tied to the business or customer. */
64
+ LocationType["CUSTOM"] = "CUSTOM";
65
+ })(LocationType || (LocationType = {}));
66
+ export var Role;
67
+ (function (Role) {
68
+ Role["UNKNOWN_ROLE"] = "UNKNOWN_ROLE";
69
+ /** Full read and write access. */
70
+ Role["WRITER"] = "WRITER";
71
+ /** Full read access, write access limited to `event.notes`. */
72
+ Role["COMMENTER"] = "COMMENTER";
73
+ })(Role || (Role = {}));
74
+ export var ParticipantsStatus;
75
+ (function (ParticipantsStatus) {
76
+ ParticipantsStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
77
+ /** All participants are confirmed. */
78
+ ParticipantsStatus["CONFIRMED"] = "CONFIRMED";
79
+ /** At least one participant isn't confirmed yet. */
80
+ ParticipantsStatus["PENDING_CONFIRMATION"] = "PENDING_CONFIRMATION";
81
+ })(ParticipantsStatus || (ParticipantsStatus = {}));
82
+ export var Type;
83
+ (function (Type) {
84
+ Type["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
85
+ Type["ZOOM"] = "ZOOM";
86
+ Type["CUSTOM"] = "CUSTOM";
87
+ })(Type || (Type = {}));
88
+ export var Field;
89
+ (function (Field) {
90
+ Field["UNKNOWN_FIELD"] = "UNKNOWN_FIELD";
91
+ /** `title` is inherited from the schedule or `MASTER` event. */
92
+ Field["TITLE"] = "TITLE";
93
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
94
+ Field["TIME_ZONE"] = "TIME_ZONE";
95
+ /** `start` and `end` are inherited from the `MASTER` event. */
96
+ Field["TIME"] = "TIME";
97
+ /** `location` is inherited from the schedule or `MASTER` event. */
98
+ Field["LOCATION"] = "LOCATION";
99
+ /** `resources` is inherited from the `MASTER` event. */
100
+ Field["RESOURCES"] = "RESOURCES";
101
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
102
+ Field["CAPACITY"] = "CAPACITY";
103
+ /** `participants` is inherited from the `MASTER` event. */
104
+ Field["PARTICIPANTS"] = "PARTICIPANTS";
105
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
106
+ Field["CONFERENCING_DETAILS"] = "CONFERENCING_DETAILS";
107
+ })(Field || (Field = {}));
108
+ export var IdentityType;
109
+ (function (IdentityType) {
110
+ IdentityType["UNKNOWN"] = "UNKNOWN";
111
+ IdentityType["WIX_USER"] = "WIX_USER";
112
+ })(IdentityType || (IdentityType = {}));
113
+ export var RequestedFields;
114
+ (function (RequestedFields) {
115
+ RequestedFields["UNKNOWN_REQUESTED_FIELDS"] = "UNKNOWN_REQUESTED_FIELDS";
116
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
117
+ RequestedFields["PI_FIELDS"] = "PI_FIELDS";
118
+ /** Returns only fields containing your own personal data. */
119
+ RequestedFields["OWN_PI_FIELDS"] = "OWN_PI_FIELDS";
120
+ })(RequestedFields || (RequestedFields = {}));
121
+ export var SortOrder;
122
+ (function (SortOrder) {
123
+ SortOrder["ASC"] = "ASC";
124
+ SortOrder["DESC"] = "DESC";
125
+ })(SortOrder || (SortOrder = {}));
126
+ export var WebhookIdentityType;
127
+ (function (WebhookIdentityType) {
128
+ WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
129
+ WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
130
+ WebhookIdentityType["MEMBER"] = "MEMBER";
131
+ WebhookIdentityType["WIX_USER"] = "WIX_USER";
132
+ WebhookIdentityType["APP"] = "APP";
133
+ })(WebhookIdentityType || (WebhookIdentityType = {}));
134
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
135
+ export var PlacementType;
136
+ (function (PlacementType) {
137
+ PlacementType["BEFORE"] = "BEFORE";
138
+ PlacementType["AFTER"] = "AFTER";
139
+ PlacementType["REPLACE"] = "REPLACE";
140
+ })(PlacementType || (PlacementType = {}));
141
+ /** Enumerates the days of the week. */
142
+ export var DayOfWeek;
143
+ (function (DayOfWeek) {
144
+ DayOfWeek["MONDAY"] = "MONDAY";
145
+ DayOfWeek["TUESDAY"] = "TUESDAY";
146
+ DayOfWeek["WEDNESDAY"] = "WEDNESDAY";
147
+ DayOfWeek["THURSDAY"] = "THURSDAY";
148
+ DayOfWeek["FRIDAY"] = "FRIDAY";
149
+ DayOfWeek["SATURDAY"] = "SATURDAY";
150
+ DayOfWeek["SUNDAY"] = "SUNDAY";
151
+ })(DayOfWeek || (DayOfWeek = {}));
152
+ export var ResolutionMethod;
153
+ (function (ResolutionMethod) {
154
+ ResolutionMethod["QUERY_PARAM"] = "QUERY_PARAM";
155
+ ResolutionMethod["SUBDOMAIN"] = "SUBDOMAIN";
156
+ ResolutionMethod["SUBDIRECTORY"] = "SUBDIRECTORY";
157
+ })(ResolutionMethod || (ResolutionMethod = {}));
158
+ /**
159
+ * Retrieves an event.
160
+ * @param eventId - ID of the event to retrieve.
161
+ *
162
+ * Min: 36 characters
163
+ * Max: 250 characters
164
+ * @public
165
+ * @documentationMaturity preview
166
+ * @requiredField eventId
167
+ * @permissionId CALENDAR.EVENT_READ
168
+ * @permissionId CALENDAR.EVENT_READ_PI
169
+ * @permissionScope Read Bookings - Public Data
170
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
171
+ * @permissionScope Read Calendar - Including PI
172
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
173
+ * @permissionScope Manage Calendars
174
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
175
+ * @permissionScope Manage Bookings
176
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
177
+ * @permissionScope Read Bookings - Including Participants
178
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
179
+ * @permissionScope Read Bookings - all read permissions
180
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
181
+ * @permissionScope Read Bookings Calendar Availability
182
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
183
+ * @permissionScope Read Calendar
184
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
185
+ * @permissionScope Manage Bookings - all permissions
186
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
187
+ * @permissionScope Read bookings calendar - including participants
188
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
189
+ * @permissionScope Read Bookings Calendar
190
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
191
+ * @permissionScope Read Calendar - Including PI
192
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
193
+ * @permissionScope Manage Calendars
194
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
195
+ * @permissionScope Manage Bookings
196
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
197
+ * @permissionScope Read Bookings - Including Participants
198
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
199
+ * @permissionScope Manage Bookings - all permissions
200
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
201
+ * @permissionScope Read bookings calendar - including participants
202
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
203
+ * @applicableIdentity APP
204
+ * @applicableIdentity VISITOR
205
+ * @returns Retrieved event.
206
+ * @fqn wix.calendar.events.v3.EventsService.GetEvent
207
+ */
208
+ export async function getEvent(eventId, options) {
209
+ // @ts-ignore
210
+ const { httpClient, sideEffects } = arguments[2];
211
+ const payload = renameKeysFromSDKRequestToRESTRequest({
212
+ eventId: eventId,
213
+ timeZone: options?.timeZone,
214
+ fields: options?.fields,
215
+ });
216
+ const reqOpts = ambassadorWixCalendarV3Event.getEvent(payload);
217
+ sideEffects?.onSiteCall?.();
218
+ try {
219
+ const result = await httpClient.request(reqOpts);
220
+ sideEffects?.onSuccess?.(result);
221
+ return renameKeysFromRESTResponseToSDKResponse(result.data)?.event;
222
+ }
223
+ catch (err) {
224
+ const transformedError = sdkTransformError(err, {
225
+ spreadPathsToArguments: {},
226
+ explicitPathsToArguments: {
227
+ eventId: '$[0]',
228
+ timeZone: '$[1].timeZone',
229
+ fields: '$[1].fields',
230
+ },
231
+ singleArgumentUnchanged: false,
232
+ }, ['eventId', 'options']);
233
+ sideEffects?.onError?.(err);
234
+ throw transformedError;
235
+ }
236
+ }
237
+ /**
238
+ * Retrieves a list of events by their IDs.
239
+ * @param eventIds - IDs of the events to retrieve.
240
+ *
241
+ * Min: 1 event ID
242
+ * Min: 100 event IDs
243
+ * @public
244
+ * @documentationMaturity preview
245
+ * @requiredField eventIds
246
+ * @permissionId CALENDAR.EVENT_READ
247
+ * @permissionId CALENDAR.EVENT_READ_PI
248
+ * @permissionScope Read Bookings - Public Data
249
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
250
+ * @permissionScope Read Calendar - Including PI
251
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
252
+ * @permissionScope Manage Calendars
253
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
254
+ * @permissionScope Manage Bookings
255
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
256
+ * @permissionScope Read Bookings - Including Participants
257
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
258
+ * @permissionScope Read Bookings - all read permissions
259
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
260
+ * @permissionScope Read Bookings Calendar Availability
261
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
262
+ * @permissionScope Read Calendar
263
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
264
+ * @permissionScope Manage Bookings - all permissions
265
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
266
+ * @permissionScope Read bookings calendar - including participants
267
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
268
+ * @permissionScope Read Bookings Calendar
269
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
270
+ * @permissionScope Read Calendar - Including PI
271
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
272
+ * @permissionScope Manage Calendars
273
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
274
+ * @permissionScope Manage Bookings
275
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
276
+ * @permissionScope Read Bookings - Including Participants
277
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
278
+ * @permissionScope Manage Bookings - all permissions
279
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
280
+ * @permissionScope Read bookings calendar - including participants
281
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
282
+ * @applicableIdentity APP
283
+ * @applicableIdentity VISITOR
284
+ * @fqn wix.calendar.events.v3.EventsService.ListEvents
285
+ */
286
+ export async function listEvents(eventIds, options) {
287
+ // @ts-ignore
288
+ const { httpClient, sideEffects } = arguments[2];
289
+ const payload = renameKeysFromSDKRequestToRESTRequest({
290
+ eventIds: eventIds,
291
+ timeZone: options?.timeZone,
292
+ fields: options?.fields,
293
+ });
294
+ const reqOpts = ambassadorWixCalendarV3Event.listEvents(payload);
295
+ sideEffects?.onSiteCall?.();
296
+ try {
297
+ const result = await httpClient.request(reqOpts);
298
+ sideEffects?.onSuccess?.(result);
299
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
300
+ }
301
+ catch (err) {
302
+ const transformedError = sdkTransformError(err, {
303
+ spreadPathsToArguments: {},
304
+ explicitPathsToArguments: {
305
+ eventIds: '$[0]',
306
+ timeZone: '$[1].timeZone',
307
+ fields: '$[1].fields',
308
+ },
309
+ singleArgumentUnchanged: false,
310
+ }, ['eventIds', 'options']);
311
+ sideEffects?.onError?.(err);
312
+ throw transformedError;
313
+ }
314
+ }
315
+ /**
316
+ * Creates a query to retrieve a list of events.
317
+ *
318
+ * The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object.
319
+ *
320
+ * 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.
321
+ *
322
+ * 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.
323
+ *
324
+ * `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override:
325
+ *
326
+ * + `limit` is `50`.
327
+ * + Sorted by `event.start` in ascending order.
328
+ *
329
+ * The functions that are chained to `queryEvents()` are applied in the order they are called.
330
+ *
331
+ * 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`.
332
+ *
333
+ * @public
334
+ * @documentationMaturity preview
335
+ * @permissionScope Read Bookings - Public Data
336
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
337
+ * @permissionScope Read Calendar - Including PI
338
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
339
+ * @permissionScope Manage Calendars
340
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
341
+ * @permissionScope Manage Bookings
342
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
343
+ * @permissionScope Read Bookings - Including Participants
344
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
345
+ * @permissionScope Read Bookings - all read permissions
346
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
347
+ * @permissionScope Read Bookings Calendar Availability
348
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
349
+ * @permissionScope Read Calendar
350
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
351
+ * @permissionScope Manage Bookings - all permissions
352
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
353
+ * @permissionScope Read bookings calendar - including participants
354
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
355
+ * @permissionScope Read Bookings Calendar
356
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
357
+ * @permissionScope Read Calendar - Including PI
358
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
359
+ * @permissionScope Manage Calendars
360
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
361
+ * @permissionScope Manage Bookings
362
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
363
+ * @permissionScope Read Bookings - Including Participants
364
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
365
+ * @permissionScope Manage Bookings - all permissions
366
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
367
+ * @permissionScope Read bookings calendar - including participants
368
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
369
+ * @permissionId CALENDAR.EVENT_READ
370
+ * @permissionId CALENDAR.EVENT_READ_PI
371
+ * @applicableIdentity APP
372
+ * @applicableIdentity VISITOR
373
+ * @fqn wix.calendar.events.v3.EventsService.QueryEvents
374
+ */
375
+ export function queryEvents(options) {
376
+ // @ts-ignore
377
+ const { httpClient, sideEffects } = arguments[1];
378
+ return queryBuilder({
379
+ func: async (payload) => {
380
+ const reqOpts = ambassadorWixCalendarV3Event.queryEvents({
381
+ ...payload,
382
+ ...(options ?? {}),
383
+ });
384
+ sideEffects?.onSiteCall?.();
385
+ try {
386
+ const result = await httpClient.request(reqOpts);
387
+ sideEffects?.onSuccess?.(result);
388
+ return result;
389
+ }
390
+ catch (err) {
391
+ sideEffects?.onError?.(err);
392
+ throw err;
393
+ }
394
+ },
395
+ requestTransformer: (query) => {
396
+ const args = [query, options];
397
+ return renameKeysFromSDKRequestToRESTRequest({
398
+ ...args?.[1],
399
+ query: args?.[0],
400
+ });
401
+ },
402
+ responseTransformer: ({ data }) => {
403
+ const transformedData = renameKeysFromRESTResponseToSDKResponse(data);
404
+ return {
405
+ items: transformedData?.events,
406
+ pagingMetadata: transformedData?.pagingMetadata,
407
+ };
408
+ },
409
+ errorTransformer: (err) => {
410
+ const transformedError = sdkTransformError(err, {
411
+ spreadPathsToArguments: {},
412
+ explicitPathsToArguments: { query: '$[0]' },
413
+ singleArgumentUnchanged: false,
414
+ });
415
+ throw transformedError;
416
+ },
417
+ pagingMethod: 'CURSOR',
418
+ transformationPaths: {},
419
+ });
420
+ }
421
+ /**
422
+ * Creates an event.
423
+ *
424
+ *
425
+ * 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.
426
+ *
427
+ * 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`.
428
+ * @param event - Event to create.
429
+ * @public
430
+ * @documentationMaturity preview
431
+ * @requiredField event
432
+ * @requiredField event.conferencingDetails.guestUrl
433
+ * @requiredField event.conferencingDetails.hostUrl
434
+ * @requiredField event.conferencingDetails.type
435
+ * @requiredField event.end
436
+ * @requiredField event.end.localDate
437
+ * @requiredField event.location.type
438
+ * @requiredField event.participants.list.name
439
+ * @requiredField event.recurrenceRule.days
440
+ * @requiredField event.recurrenceRule.frequency
441
+ * @requiredField event.recurrenceRule.until.localDate
442
+ * @requiredField event.resources._id
443
+ * @requiredField event.scheduleId
444
+ * @requiredField event.start
445
+ * @requiredField event.start.localDate
446
+ * @permissionId CALENDAR.EVENT_CREATE_OWN
447
+ * @permissionId CALENDAR.EVENT_CREATE
448
+ * @permissionScope Manage Calendars
449
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
450
+ * @permissionScope Manage Bookings
451
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
452
+ * @permissionScope Manage Bookings - all permissions
453
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
454
+ * @permissionScope Manage Calendars
455
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
456
+ * @permissionScope Manage Bookings
457
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
458
+ * @permissionScope Manage Bookings - all permissions
459
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
460
+ * @applicableIdentity APP
461
+ * @returns Created event.
462
+ * @fqn wix.calendar.events.v3.EventsService.CreateEvent
463
+ */
464
+ export async function createEvent(event, options) {
465
+ // @ts-ignore
466
+ const { httpClient, sideEffects } = arguments[2];
467
+ const payload = renameKeysFromSDKRequestToRESTRequest({
468
+ event: event,
469
+ timeZone: options?.timeZone,
470
+ idempotencyKey: options?.idempotencyKey,
471
+ });
472
+ const reqOpts = ambassadorWixCalendarV3Event.createEvent(payload);
473
+ sideEffects?.onSiteCall?.();
474
+ try {
475
+ const result = await httpClient.request(reqOpts);
476
+ sideEffects?.onSuccess?.(result);
477
+ return renameKeysFromRESTResponseToSDKResponse(result.data)?.event;
478
+ }
479
+ catch (err) {
480
+ const transformedError = sdkTransformError(err, {
481
+ spreadPathsToArguments: {},
482
+ explicitPathsToArguments: {
483
+ event: '$[0]',
484
+ timeZone: '$[1].timeZone',
485
+ idempotencyKey: '$[1].idempotencyKey',
486
+ },
487
+ singleArgumentUnchanged: false,
488
+ }, ['event', 'options']);
489
+ sideEffects?.onError?.(err);
490
+ throw transformedError;
491
+ }
492
+ }
493
+ /**
494
+ * Creates multiple events in bulk.
495
+ *
496
+ *
497
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
498
+ * created. Then, you can't set `start.localDate` to a past date, though the time can be
499
+ * earlier on the same day. You can, however, create single-occurrence events for
500
+ * past dates.
501
+ *
502
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
503
+ * `INSTANCE` events are generated automatically based on the recurrence rule in the
504
+ * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
505
+ * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
506
+ * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
507
+ * @param events - Events to create.
508
+ * @public
509
+ * @documentationMaturity preview
510
+ * @requiredField events
511
+ * @requiredField events.event
512
+ * @requiredField events.event.conferencingDetails.guestUrl
513
+ * @requiredField events.event.conferencingDetails.hostUrl
514
+ * @requiredField events.event.conferencingDetails.type
515
+ * @requiredField events.event.end
516
+ * @requiredField events.event.end.localDate
517
+ * @requiredField events.event.location.type
518
+ * @requiredField events.event.participants.list.name
519
+ * @requiredField events.event.recurrenceRule.days
520
+ * @requiredField events.event.recurrenceRule.frequency
521
+ * @requiredField events.event.recurrenceRule.until.localDate
522
+ * @requiredField events.event.resources._id
523
+ * @requiredField events.event.scheduleId
524
+ * @requiredField events.event.start
525
+ * @requiredField events.event.start.localDate
526
+ * @permissionId CALENDAR.EVENT_CREATE_OWN
527
+ * @permissionId CALENDAR.EVENT_CREATE
528
+ * @permissionScope Manage Calendars
529
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
530
+ * @permissionScope Manage Bookings
531
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
532
+ * @permissionScope Manage Bookings - all permissions
533
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
534
+ * @permissionScope Manage Calendars
535
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
536
+ * @permissionScope Manage Bookings
537
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
538
+ * @permissionScope Manage Bookings - all permissions
539
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
540
+ * @applicableIdentity APP
541
+ * @fqn wix.calendar.events.v3.EventsService.BulkCreateEvent
542
+ */
543
+ export async function bulkCreateEvent(events, options) {
544
+ // @ts-ignore
545
+ const { httpClient, sideEffects } = arguments[2];
546
+ const payload = renameKeysFromSDKRequestToRESTRequest({
547
+ events: events,
548
+ returnEntity: options?.returnEntity,
549
+ timeZone: options?.timeZone,
550
+ });
551
+ const reqOpts = ambassadorWixCalendarV3Event.bulkCreateEvent(payload);
552
+ sideEffects?.onSiteCall?.();
553
+ try {
554
+ const result = await httpClient.request(reqOpts);
555
+ sideEffects?.onSuccess?.(result);
556
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
557
+ }
558
+ catch (err) {
559
+ const transformedError = sdkTransformError(err, {
560
+ spreadPathsToArguments: {},
561
+ explicitPathsToArguments: {
562
+ events: '$[0]',
563
+ returnEntity: '$[1].returnEntity',
564
+ timeZone: '$[1].timeZone',
565
+ },
566
+ singleArgumentUnchanged: false,
567
+ }, ['events', 'options']);
568
+ sideEffects?.onError?.(err);
569
+ throw transformedError;
570
+ }
571
+ }
572
+ /**
573
+ * Updates an event.
574
+ *
575
+ *
576
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
577
+ * `recurrenceType` automatically changes to `EXCEPTION`.
578
+ *
579
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
580
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
581
+ * + For future `INSTANCE` events, all relevant fields are updated.
582
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
583
+ * applied, while other fields remain unchanged.
584
+ * @param _id - Event ID.
585
+ * @public
586
+ * @documentationMaturity preview
587
+ * @requiredField _id
588
+ * @requiredField event
589
+ * @requiredField event.conferencingDetails.guestUrl
590
+ * @requiredField event.conferencingDetails.hostUrl
591
+ * @requiredField event.conferencingDetails.type
592
+ * @requiredField event.end.localDate
593
+ * @requiredField event.location.type
594
+ * @requiredField event.participants.list.name
595
+ * @requiredField event.recurrenceRule.days
596
+ * @requiredField event.recurrenceRule.frequency
597
+ * @requiredField event.recurrenceRule.until.localDate
598
+ * @requiredField event.resources._id
599
+ * @requiredField event.revision
600
+ * @requiredField event.start.localDate
601
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
602
+ * @permissionId CALENDAR.EVENT_UPDATE
603
+ * @permissionScope Manage Calendars
604
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
605
+ * @permissionScope Manage Bookings
606
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
607
+ * @permissionScope Manage Bookings - all permissions
608
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
609
+ * @permissionScope Manage Calendars
610
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
611
+ * @permissionScope Manage Bookings
612
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
613
+ * @permissionScope Manage Bookings - all permissions
614
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
615
+ * @applicableIdentity APP
616
+ * @returns Updated event.
617
+ * @fqn wix.calendar.events.v3.EventsService.UpdateEvent
618
+ */
619
+ export async function updateEvent(_id, event, options) {
620
+ // @ts-ignore
621
+ const { httpClient, sideEffects } = arguments[3];
622
+ const payload = renameKeysFromSDKRequestToRESTRequest({
623
+ event: { ...event, id: _id },
624
+ participantNotification: options?.participantNotification,
625
+ timeZone: options?.timeZone,
626
+ });
627
+ const reqOpts = ambassadorWixCalendarV3Event.updateEvent(payload);
628
+ sideEffects?.onSiteCall?.();
629
+ try {
630
+ const result = await httpClient.request(reqOpts);
631
+ sideEffects?.onSuccess?.(result);
632
+ return renameKeysFromRESTResponseToSDKResponse(result.data)?.event;
633
+ }
634
+ catch (err) {
635
+ const transformedError = sdkTransformError(err, {
636
+ spreadPathsToArguments: { event: '$[1]' },
637
+ explicitPathsToArguments: {
638
+ 'event.id': '$[0]',
639
+ participantNotification: '$[2].participantNotification',
640
+ timeZone: '$[2].timeZone',
641
+ },
642
+ singleArgumentUnchanged: false,
643
+ }, ['_id', 'event', 'options']);
644
+ sideEffects?.onError?.(err);
645
+ throw transformedError;
646
+ }
647
+ }
648
+ /**
649
+ * Updates multiple events in bulk.
650
+ *
651
+ *
652
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
653
+ * `recurrenceType` automatically changes to `EXCEPTION`.
654
+ *
655
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
656
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
657
+ * + For future `INSTANCE` events, all relevant fields are updated.
658
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
659
+ * applied, while other fields remain unchanged.
660
+ * @param events - Events to update.
661
+ *
662
+ * Min: 1 event
663
+ * Max: 50 events
664
+ * @public
665
+ * @documentationMaturity preview
666
+ * @requiredField events
667
+ * @requiredField events.event
668
+ * @requiredField events.event._id
669
+ * @requiredField events.event.conferencingDetails.guestUrl
670
+ * @requiredField events.event.conferencingDetails.hostUrl
671
+ * @requiredField events.event.conferencingDetails.type
672
+ * @requiredField events.event.end.localDate
673
+ * @requiredField events.event.location.type
674
+ * @requiredField events.event.participants.list.name
675
+ * @requiredField events.event.recurrenceRule.days
676
+ * @requiredField events.event.recurrenceRule.frequency
677
+ * @requiredField events.event.recurrenceRule.until.localDate
678
+ * @requiredField events.event.resources._id
679
+ * @requiredField events.event.revision
680
+ * @requiredField events.event.start.localDate
681
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
682
+ * @permissionId CALENDAR.EVENT_UPDATE
683
+ * @permissionScope Manage Calendars
684
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
685
+ * @permissionScope Manage Bookings
686
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
687
+ * @permissionScope Manage Bookings - all permissions
688
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
689
+ * @permissionScope Manage Calendars
690
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
691
+ * @permissionScope Manage Bookings
692
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
693
+ * @permissionScope Manage Bookings - all permissions
694
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
695
+ * @applicableIdentity APP
696
+ * @fqn wix.calendar.events.v3.EventsService.BulkUpdateEvent
697
+ */
698
+ export async function bulkUpdateEvent(events, options) {
699
+ // @ts-ignore
700
+ const { httpClient, sideEffects } = arguments[2];
701
+ const payload = renameKeysFromSDKRequestToRESTRequest({
702
+ events: events,
703
+ returnEntity: options?.returnEntity,
704
+ participantNotification: options?.participantNotification,
705
+ timeZone: options?.timeZone,
706
+ });
707
+ const reqOpts = ambassadorWixCalendarV3Event.bulkUpdateEvent(payload);
708
+ sideEffects?.onSiteCall?.();
709
+ try {
710
+ const result = await httpClient.request(reqOpts);
711
+ sideEffects?.onSuccess?.(result);
712
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
713
+ }
714
+ catch (err) {
715
+ const transformedError = sdkTransformError(err, {
716
+ spreadPathsToArguments: {},
717
+ explicitPathsToArguments: {
718
+ events: '$[0]',
719
+ returnEntity: '$[1].returnEntity',
720
+ participantNotification: '$[1].participantNotification',
721
+ timeZone: '$[1].timeZone',
722
+ },
723
+ singleArgumentUnchanged: false,
724
+ }, ['events', 'options']);
725
+ sideEffects?.onError?.(err);
726
+ throw transformedError;
727
+ }
728
+ }
729
+ /**
730
+ * Restores the event's default values from the relevant schedule or `MASTER`
731
+ * event.
732
+ *
733
+ *
734
+ * You must provide `fields` to specify which `inheritedFields` are restored.
735
+ *
736
+ * For example, if you've created an event that takes place in a non-default
737
+ * location with a custom title and capacity, but you want to reset only title
738
+ * and capacity to default values without affecting the location, provide the
739
+ * event ID and set `fields` to `["TITLE", "CAPACITY"]`.
740
+ *
741
+ * Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
742
+ * for more information.
743
+ * @param eventId - ID of the event for which to restore default values.
744
+ * @param fields - Fields for which to restore default values.
745
+ *
746
+ * `TIME` restores default values for `start` and `end`.
747
+ *
748
+ * Min: 1 field
749
+ * @public
750
+ * @documentationMaturity preview
751
+ * @requiredField eventId
752
+ * @requiredField fields
753
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
754
+ * @permissionId CALENDAR.EVENT_UPDATE
755
+ * @permissionScope Manage Calendars
756
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
757
+ * @permissionScope Manage Bookings
758
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
759
+ * @permissionScope Manage Bookings - all permissions
760
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
761
+ * @permissionScope Manage Calendars
762
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
763
+ * @permissionScope Manage Bookings
764
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
765
+ * @permissionScope Manage Bookings - all permissions
766
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
767
+ * @applicableIdentity APP
768
+ * @fqn wix.calendar.events.v3.EventsService.RestoreEventDefaults
769
+ */
770
+ export async function restoreEventDefaults(eventId, fields, options) {
771
+ // @ts-ignore
772
+ const { httpClient, sideEffects } = arguments[3];
773
+ const payload = renameKeysFromSDKRequestToRESTRequest({
774
+ eventId: eventId,
775
+ fields: fields,
776
+ participantNotification: options?.participantNotification,
777
+ timeZone: options?.timeZone,
778
+ });
779
+ const reqOpts = ambassadorWixCalendarV3Event.restoreEventDefaults(payload);
780
+ sideEffects?.onSiteCall?.();
781
+ try {
782
+ const result = await httpClient.request(reqOpts);
783
+ sideEffects?.onSuccess?.(result);
784
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
785
+ }
786
+ catch (err) {
787
+ const transformedError = sdkTransformError(err, {
788
+ spreadPathsToArguments: {},
789
+ explicitPathsToArguments: {
790
+ eventId: '$[0]',
791
+ fields: '$[1]',
792
+ participantNotification: '$[2].participantNotification',
793
+ timeZone: '$[2].timeZone',
794
+ },
795
+ singleArgumentUnchanged: false,
796
+ }, ['eventId', 'fields', 'options']);
797
+ sideEffects?.onError?.(err);
798
+ throw transformedError;
799
+ }
800
+ }
801
+ /**
802
+ * Splits a recurring `MASTER` event into 2 separate `MASTER` events.
803
+ *
804
+ *
805
+ * You must provide a `splitLocalDate` that's in the future and after the `start`
806
+ * date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally,
807
+ * there must be another `INSTANCE` or `EXCEPTION` event following this next event,
808
+ * as the changes wouldn't affect any event without a subsequent occurrence.
809
+ *
810
+ * If you want to modify a `MASTER` event with the changes already applying to
811
+ * the very next event, use
812
+ * [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
813
+ * instead, as this preserves past events and only modifies future events.
814
+ *
815
+ * The main consequences are:
816
+ * - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate`
817
+ * is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION`
818
+ * event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event
819
+ * starts before but ends after `splitLocalDate`, `until.localDate` is set
820
+ * to value that's later than `splitLocalDate`.
821
+ * - **A new `MASTER` event is created**, starting from the first event that
822
+ * begins after `splitLocalDate`.
823
+ * - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**.
824
+ * Their `recurringEventId` is set to the ID of the newly created `MASTER` event.
825
+ * @param recurringEventId - ID of the `MASTER` event to split.
826
+ * @param splitLocalDate - Local date and time at which the `MASTER` event is split in
827
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
828
+ * `2025-03-11T09:00:00`.
829
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
830
+ * `EXCEPTION` event in the series. Additionally, there must be another
831
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
832
+ * wouldn't affect any event without a subsequent occurrence.
833
+ * @public
834
+ * @documentationMaturity preview
835
+ * @requiredField recurringEventId
836
+ * @requiredField splitLocalDate
837
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
838
+ * @permissionId CALENDAR.EVENT_UPDATE
839
+ * @permissionScope Manage Calendars
840
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
841
+ * @permissionScope Manage Bookings
842
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
843
+ * @permissionScope Manage Bookings - all permissions
844
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
845
+ * @permissionScope Manage Calendars
846
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
847
+ * @permissionScope Manage Bookings
848
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
849
+ * @permissionScope Manage Bookings - all permissions
850
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
851
+ * @applicableIdentity APP
852
+ * @fqn wix.calendar.events.v3.EventsService.SplitRecurringEvent
853
+ */
854
+ export async function splitRecurringEvent(recurringEventId, splitLocalDate, options) {
855
+ // @ts-ignore
856
+ const { httpClient, sideEffects } = arguments[3];
857
+ const payload = renameKeysFromSDKRequestToRESTRequest({
858
+ recurringEventId: recurringEventId,
859
+ splitLocalDate: splitLocalDate,
860
+ timeZone: options?.timeZone,
861
+ });
862
+ const reqOpts = ambassadorWixCalendarV3Event.splitRecurringEvent(payload);
863
+ sideEffects?.onSiteCall?.();
864
+ try {
865
+ const result = await httpClient.request(reqOpts);
866
+ sideEffects?.onSuccess?.(result);
867
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
868
+ }
869
+ catch (err) {
870
+ const transformedError = sdkTransformError(err, {
871
+ spreadPathsToArguments: {},
872
+ explicitPathsToArguments: {
873
+ recurringEventId: '$[0]',
874
+ splitLocalDate: '$[1]',
875
+ timeZone: '$[2].timeZone',
876
+ },
877
+ singleArgumentUnchanged: false,
878
+ }, ['recurringEventId', 'splitLocalDate', 'options']);
879
+ sideEffects?.onError?.(err);
880
+ throw transformedError;
881
+ }
882
+ }
883
+ /**
884
+ * Cancels an event.
885
+ * @param eventId - ID of the event to cancel.
886
+ * @public
887
+ * @documentationMaturity preview
888
+ * @requiredField eventId
889
+ * @permissionId CALENDAR.EVENT_CANCEL_OWN
890
+ * @permissionId CALENDAR.EVENT_CANCEL
891
+ * @permissionScope Manage Calendars
892
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
893
+ * @permissionScope Manage Bookings
894
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
895
+ * @permissionScope Manage Bookings - all permissions
896
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
897
+ * @permissionScope Manage Calendars
898
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
899
+ * @permissionScope Manage Bookings
900
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
901
+ * @permissionScope Manage Bookings - all permissions
902
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
903
+ * @applicableIdentity APP
904
+ * @fqn wix.calendar.events.v3.EventsService.CancelEvent
905
+ */
906
+ export async function cancelEvent(eventId, options) {
907
+ // @ts-ignore
908
+ const { httpClient, sideEffects } = arguments[2];
909
+ const payload = renameKeysFromSDKRequestToRESTRequest({
910
+ eventId: eventId,
911
+ participantNotification: options?.participantNotification,
912
+ timeZone: options?.timeZone,
913
+ });
914
+ const reqOpts = ambassadorWixCalendarV3Event.cancelEvent(payload);
915
+ sideEffects?.onSiteCall?.();
916
+ try {
917
+ const result = await httpClient.request(reqOpts);
918
+ sideEffects?.onSuccess?.(result);
919
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
920
+ }
921
+ catch (err) {
922
+ const transformedError = sdkTransformError(err, {
923
+ spreadPathsToArguments: {},
924
+ explicitPathsToArguments: {
925
+ eventId: '$[0]',
926
+ participantNotification: '$[1].participantNotification',
927
+ timeZone: '$[1].timeZone',
928
+ },
929
+ singleArgumentUnchanged: false,
930
+ }, ['eventId', 'options']);
931
+ sideEffects?.onError?.(err);
932
+ throw transformedError;
933
+ }
934
+ }
935
+ /**
936
+ * Cancels multiple events in bulk.
937
+ * @param eventIds - IDs of the events to cancel.
938
+ * @public
939
+ * @documentationMaturity preview
940
+ * @requiredField eventIds
941
+ * @permissionId CALENDAR.EVENT_CANCEL_OWN
942
+ * @permissionId CALENDAR.EVENT_CANCEL
943
+ * @permissionScope Manage Calendars
944
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
945
+ * @permissionScope Manage Bookings
946
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
947
+ * @permissionScope Manage Bookings - all permissions
948
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
949
+ * @permissionScope Manage Calendars
950
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
951
+ * @permissionScope Manage Bookings
952
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
953
+ * @permissionScope Manage Bookings - all permissions
954
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
955
+ * @applicableIdentity APP
956
+ * @fqn wix.calendar.events.v3.EventsService.BulkCancelEvent
957
+ */
958
+ export async function bulkCancelEvent(eventIds, options) {
959
+ // @ts-ignore
960
+ const { httpClient, sideEffects } = arguments[2];
961
+ const payload = renameKeysFromSDKRequestToRESTRequest({
962
+ eventIds: eventIds,
963
+ returnEntity: options?.returnEntity,
964
+ participantNotification: options?.participantNotification,
965
+ timeZone: options?.timeZone,
966
+ });
967
+ const reqOpts = ambassadorWixCalendarV3Event.bulkCancelEvent(payload);
968
+ sideEffects?.onSiteCall?.();
969
+ try {
970
+ const result = await httpClient.request(reqOpts);
971
+ sideEffects?.onSuccess?.(result);
972
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
973
+ }
974
+ catch (err) {
975
+ const transformedError = sdkTransformError(err, {
976
+ spreadPathsToArguments: {},
977
+ explicitPathsToArguments: {
978
+ eventIds: '$[0]',
979
+ returnEntity: '$[1].returnEntity',
980
+ participantNotification: '$[1].participantNotification',
981
+ timeZone: '$[1].timeZone',
982
+ },
983
+ singleArgumentUnchanged: false,
984
+ }, ['eventIds', 'options']);
985
+ sideEffects?.onError?.(err);
986
+ throw transformedError;
987
+ }
988
+ }
989
+ /**
990
+ * Retrieves a list of events filtered by the participant's
991
+ * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
992
+ * ID.
993
+ *
994
+ *
995
+ * You can't set `toLocalDate` to a value that's more than a full year after
996
+ * `fromLocalDate`.
997
+ * @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
998
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
999
+ * @public
1000
+ * @documentationMaturity preview
1001
+ * @requiredField contactId
1002
+ * @permissionId CALENDAR.EVENT_READ_PI
1003
+ * @permissionScope Read Calendar - Including PI
1004
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1005
+ * @permissionScope Manage Calendars
1006
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1007
+ * @permissionScope Manage Bookings
1008
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1009
+ * @permissionScope Read Bookings - Including Participants
1010
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1011
+ * @permissionScope Read bookings calendar - including participants
1012
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1013
+ * @applicableIdentity APP
1014
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
1015
+ */
1016
+ export async function listEventsByContactId(contactId, options) {
1017
+ // @ts-ignore
1018
+ const { httpClient, sideEffects } = arguments[2];
1019
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1020
+ contactId: contactId,
1021
+ fromLocalDate: options?.fromLocalDate,
1022
+ toLocalDate: options?.toLocalDate,
1023
+ timeZone: options?.timeZone,
1024
+ appId: options?.appId,
1025
+ cursorPaging: options?.cursorPaging,
1026
+ });
1027
+ const reqOpts = ambassadorWixCalendarV3Event.listEventsByContactId(payload);
1028
+ sideEffects?.onSiteCall?.();
1029
+ try {
1030
+ const result = await httpClient.request(reqOpts);
1031
+ sideEffects?.onSuccess?.(result);
1032
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1033
+ }
1034
+ catch (err) {
1035
+ const transformedError = sdkTransformError(err, {
1036
+ spreadPathsToArguments: {},
1037
+ explicitPathsToArguments: {
1038
+ contactId: '$[0]',
1039
+ fromLocalDate: '$[1].fromLocalDate',
1040
+ toLocalDate: '$[1].toLocalDate',
1041
+ timeZone: '$[1].timeZone',
1042
+ appId: '$[1].appId',
1043
+ cursorPaging: '$[1].cursorPaging',
1044
+ },
1045
+ singleArgumentUnchanged: false,
1046
+ }, ['contactId', 'options']);
1047
+ sideEffects?.onError?.(err);
1048
+ throw transformedError;
1049
+ }
1050
+ }
1051
+ /**
1052
+ * Retrieves a list of events filtered by the participant's
1053
+ * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
1054
+ * ID.
1055
+ *
1056
+ *
1057
+ * You can't set `toLocalDate` to a value that's more than a full year after
1058
+ * `fromLocalDate`.
1059
+ * @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1060
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1061
+ * Provide `me` to retrieve events for the currently logged-in member.
1062
+ * You must have the `Read Calendars - Including PI`
1063
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1064
+ * to retrieve events for members who aren't the currently logged in member.
1065
+ * @public
1066
+ * @documentationMaturity preview
1067
+ * @requiredField memberId
1068
+ * @permissionId CALENDAR.EVENT_READ
1069
+ * @permissionId CALENDAR.EVENT_READ_PI
1070
+ * @permissionScope Read Bookings - Public Data
1071
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
1072
+ * @permissionScope Read Calendar - Including PI
1073
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1074
+ * @permissionScope Manage Calendars
1075
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1076
+ * @permissionScope Manage Bookings
1077
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1078
+ * @permissionScope Read Bookings - Including Participants
1079
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1080
+ * @permissionScope Read Bookings - all read permissions
1081
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1082
+ * @permissionScope Read Bookings Calendar Availability
1083
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1084
+ * @permissionScope Read Calendar
1085
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
1086
+ * @permissionScope Manage Bookings - all permissions
1087
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1088
+ * @permissionScope Read bookings calendar - including participants
1089
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1090
+ * @permissionScope Read Bookings Calendar
1091
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
1092
+ * @permissionScope Read Calendar - Including PI
1093
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1094
+ * @permissionScope Manage Calendars
1095
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1096
+ * @permissionScope Manage Bookings
1097
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1098
+ * @permissionScope Read Bookings - Including Participants
1099
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1100
+ * @permissionScope Read bookings calendar - including participants
1101
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1102
+ * @applicableIdentity APP
1103
+ * @applicableIdentity VISITOR
1104
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
1105
+ */
1106
+ export async function listEventsByMemberId(memberId, options) {
1107
+ // @ts-ignore
1108
+ const { httpClient, sideEffects } = arguments[2];
1109
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1110
+ memberId: memberId,
1111
+ fromLocalDate: options?.fromLocalDate,
1112
+ toLocalDate: options?.toLocalDate,
1113
+ timeZone: options?.timeZone,
1114
+ appId: options?.appId,
1115
+ cursorPaging: options?.cursorPaging,
1116
+ eventIds: options?.eventIds,
1117
+ });
1118
+ const reqOpts = ambassadorWixCalendarV3Event.listEventsByMemberId(payload);
1119
+ sideEffects?.onSiteCall?.();
1120
+ try {
1121
+ const result = await httpClient.request(reqOpts);
1122
+ sideEffects?.onSuccess?.(result);
1123
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1124
+ }
1125
+ catch (err) {
1126
+ const transformedError = sdkTransformError(err, {
1127
+ spreadPathsToArguments: {},
1128
+ explicitPathsToArguments: {
1129
+ memberId: '$[0]',
1130
+ fromLocalDate: '$[1].fromLocalDate',
1131
+ toLocalDate: '$[1].toLocalDate',
1132
+ timeZone: '$[1].timeZone',
1133
+ appId: '$[1].appId',
1134
+ cursorPaging: '$[1].cursorPaging',
1135
+ eventIds: '$[1].eventIds',
1136
+ },
1137
+ singleArgumentUnchanged: false,
1138
+ }, ['memberId', 'options']);
1139
+ sideEffects?.onError?.(err);
1140
+ throw transformedError;
1141
+ }
1142
+ }
1143
+ //# sourceMappingURL=calendar-v3-event-events.universal.js.map