@wix/auto_sdk_calendar_events 1.0.15 → 1.0.16

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