@wix/auto_sdk_calendar_events 1.0.28 → 1.0.30
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.
- package/build/{cjs/src/calendar-v3-event-events.types.d.ts → calendar-v3-event-events.universal-Cfq4Piiv.d.mts} +983 -564
- package/build/{internal/cjs/src/calendar-v3-event-events.types.d.ts → calendar-v3-event-events.universal-Cfq4Piiv.d.ts} +983 -564
- package/build/{internal/cjs/src/calendar-v3-event-events.public.d.ts → index.d.mts} +62 -55
- package/build/{es/src/calendar-v3-event-events.public.d.ts → index.d.ts} +62 -55
- package/build/index.js +1340 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1285 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/calendar-v3-event-events.types.d.ts → calendar-v3-event-events.universal-Cfq4Piiv.d.mts} +983 -564
- package/build/{es/src/calendar-v3-event-events.types.d.ts → internal/calendar-v3-event-events.universal-Cfq4Piiv.d.ts} +983 -564
- package/build/{cjs/src/calendar-v3-event-events.public.d.ts → internal/index.d.mts} +62 -55
- package/build/internal/{es/src/calendar-v3-event-events.public.d.ts → index.d.ts} +62 -55
- package/build/internal/index.js +1340 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1285 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +1195 -0
- package/build/internal/meta.d.ts +1195 -0
- package/build/internal/meta.js +777 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +740 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +1195 -0
- package/build/meta.d.ts +1195 -0
- package/build/meta.js +777 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +740 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/cjs/src/calendar-v3-event-events.context.js +0 -71
- package/build/cjs/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/cjs/src/calendar-v3-event-events.http.js +0 -785
- package/build/cjs/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/cjs/src/calendar-v3-event-events.meta.js +0 -275
- package/build/cjs/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.public.js +0 -196
- package/build/cjs/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.types.js +0 -157
- package/build/cjs/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.universal.d.ts +0 -3198
- package/build/cjs/src/calendar-v3-event-events.universal.js +0 -1185
- package/build/cjs/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/es/src/calendar-v3-event-events.context.js +0 -51
- package/build/es/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/es/src/calendar-v3-event-events.http.js +0 -769
- package/build/es/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/es/src/calendar-v3-event-events.meta.js +0 -236
- package/build/es/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.public.js +0 -163
- package/build/es/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.types.js +0 -154
- package/build/es/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.universal.d.ts +0 -3198
- package/build/es/src/calendar-v3-event-events.universal.js +0 -1146
- package/build/es/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/internal/cjs/src/calendar-v3-event-events.context.js +0 -71
- package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/internal/cjs/src/calendar-v3-event-events.http.js +0 -785
- package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js +0 -275
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.public.js +0 -196
- package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.types.js +0 -157
- package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.universal.d.ts +0 -3198
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js +0 -1185
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/internal/es/src/calendar-v3-event-events.context.js +0 -51
- package/build/internal/es/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/internal/es/src/calendar-v3-event-events.http.js +0 -769
- package/build/internal/es/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/internal/es/src/calendar-v3-event-events.meta.js +0 -236
- package/build/internal/es/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.public.js +0 -163
- package/build/internal/es/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.types.js +0 -154
- package/build/internal/es/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.universal.d.ts +0 -3198
- package/build/internal/es/src/calendar-v3-event-events.universal.js +0 -1146
- package/build/internal/es/src/calendar-v3-event-events.universal.js.map +0 -1
|
@@ -7,16 +7,16 @@
|
|
|
7
7
|
* recurrence pattern. You can also specify whether events block time on the
|
|
8
8
|
* schedule or allow other events to be scheduled concurrently.
|
|
9
9
|
*/
|
|
10
|
-
|
|
10
|
+
interface Event {
|
|
11
11
|
/**
|
|
12
12
|
* Event ID.
|
|
13
13
|
* @minLength 36
|
|
14
14
|
* @maxLength 250
|
|
15
15
|
* @readonly
|
|
16
16
|
*/
|
|
17
|
-
|
|
17
|
+
_id?: string | null;
|
|
18
18
|
/**
|
|
19
|
-
* ID of the [schedule](https://dev.wix.com/docs/
|
|
19
|
+
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
20
20
|
* the event belongs to.
|
|
21
21
|
* After creating an event, you can't assign it to a different schedule.
|
|
22
22
|
* @format GUID
|
|
@@ -26,10 +26,7 @@ export interface Event {
|
|
|
26
26
|
/**
|
|
27
27
|
* ID of the external schedule the event belongs to.
|
|
28
28
|
*
|
|
29
|
-
* For example, if the event belongs to a Bookings staff member, identical to
|
|
30
|
-
* the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
|
|
31
|
-
* If the schedule belongs to a Bookings service,
|
|
32
|
-
* identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
|
|
29
|
+
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
33
30
|
* @format GUID
|
|
34
31
|
* @readonly
|
|
35
32
|
*/
|
|
@@ -44,7 +41,7 @@ export interface Event {
|
|
|
44
41
|
*
|
|
45
42
|
* Supported values:
|
|
46
43
|
* + `DEFAULT`: A standard event that's not further specified.
|
|
47
|
-
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [
|
|
44
|
+
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
|
|
48
45
|
*
|
|
49
46
|
* Additional supported values, if Wix Bookings is installed:
|
|
50
47
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
@@ -83,14 +80,14 @@ export interface Event {
|
|
|
83
80
|
end?: ZonedDate;
|
|
84
81
|
/**
|
|
85
82
|
* Information about when the event starts adjusted to the `timeZone` of the
|
|
86
|
-
* business [site properties](https://dev.wix.com/docs/
|
|
83
|
+
* business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
87
84
|
* or a different `timeZone` you provide in the call's request.
|
|
88
85
|
* @readonly
|
|
89
86
|
*/
|
|
90
87
|
adjustedStart?: ZonedDate;
|
|
91
88
|
/**
|
|
92
89
|
* Information about when the event ends adjusted to the `timeZone` of the
|
|
93
|
-
* business [site properties](https://dev.wix.com/docs/
|
|
90
|
+
* business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
94
91
|
* or a different `timeZone` you provide in the call's request.
|
|
95
92
|
* @readonly
|
|
96
93
|
*/
|
|
@@ -101,7 +98,7 @@ export interface Event {
|
|
|
101
98
|
* Only regional time zones and UTC are supported.
|
|
102
99
|
* For example, `America/New_York` or `UTC`.
|
|
103
100
|
*
|
|
104
|
-
* Default: `timeZone` of the [schedule](https://dev.wix.com/docs/
|
|
101
|
+
* Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
|
|
105
102
|
*/
|
|
106
103
|
timeZone?: string | null;
|
|
107
104
|
/**
|
|
@@ -152,13 +149,13 @@ export interface Event {
|
|
|
152
149
|
/**
|
|
153
150
|
* Event location.
|
|
154
151
|
*
|
|
155
|
-
* Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/
|
|
152
|
+
* Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
|
|
156
153
|
*/
|
|
157
154
|
location?: Location;
|
|
158
155
|
/**
|
|
159
|
-
* List of [Wix Bookings resources](https://dev.wix.com/docs/
|
|
156
|
+
* List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
|
|
160
157
|
* affected by the event. This could include, for example, the
|
|
161
|
-
* [Wix Bookings staff member](https://dev.wix.com/docs/
|
|
158
|
+
* [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
|
|
162
159
|
* providing the service or the room where the appointment takes place.
|
|
163
160
|
*
|
|
164
161
|
* Max: 100 resources
|
|
@@ -168,7 +165,7 @@ export interface Event {
|
|
|
168
165
|
/**
|
|
169
166
|
* Maximum number of participants who can participate in the event.
|
|
170
167
|
*
|
|
171
|
-
* Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/
|
|
168
|
+
* Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
|
|
172
169
|
*/
|
|
173
170
|
totalCapacity?: number | null;
|
|
174
171
|
/**
|
|
@@ -178,20 +175,20 @@ export interface Event {
|
|
|
178
175
|
remainingCapacity?: number | null;
|
|
179
176
|
/**
|
|
180
177
|
* Information about the event's participants.
|
|
181
|
-
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/
|
|
178
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
182
179
|
* @readonly
|
|
183
180
|
*/
|
|
184
181
|
participants?: Participants;
|
|
185
182
|
/**
|
|
186
183
|
* Information about the event's online conferencing.
|
|
187
|
-
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/
|
|
184
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
188
185
|
*
|
|
189
|
-
* Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/
|
|
186
|
+
* Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
|
|
190
187
|
*/
|
|
191
188
|
conferencingDetails?: ConferencingDetails;
|
|
192
189
|
/**
|
|
193
190
|
* Additional notes about the event.
|
|
194
|
-
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/
|
|
191
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
195
192
|
*
|
|
196
193
|
* Min: 1 character
|
|
197
194
|
* Max: 5000 characters
|
|
@@ -201,14 +198,14 @@ export interface Event {
|
|
|
201
198
|
notes?: string | null;
|
|
202
199
|
/**
|
|
203
200
|
* List of fields whose values are inherited.
|
|
204
|
-
* + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/
|
|
201
|
+
* + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
|
|
205
202
|
* + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
|
|
206
203
|
* @readonly
|
|
207
204
|
*/
|
|
208
205
|
inheritedFields?: FieldWithLiterals[];
|
|
209
206
|
/**
|
|
210
207
|
* ID of the app that owns the event. Identical to `appId` of the
|
|
211
|
-
* [schedule](https://dev.wix.com/docs/
|
|
208
|
+
* [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
212
209
|
* to which the event belongs.
|
|
213
210
|
* @format GUID
|
|
214
211
|
* @readonly
|
|
@@ -216,7 +213,7 @@ export interface Event {
|
|
|
216
213
|
appId?: string | null;
|
|
217
214
|
/**
|
|
218
215
|
* List of permissions associated with the event. Refer to the
|
|
219
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
216
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
|
|
220
217
|
* for more information.
|
|
221
218
|
* @readonly
|
|
222
219
|
*/
|
|
@@ -234,14 +231,14 @@ export interface Event {
|
|
|
234
231
|
* Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
235
232
|
* @readonly
|
|
236
233
|
*/
|
|
237
|
-
|
|
234
|
+
_createdDate?: Date | null;
|
|
238
235
|
/**
|
|
239
236
|
* Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
240
237
|
* @readonly
|
|
241
238
|
*/
|
|
242
|
-
|
|
239
|
+
_updatedDate?: Date | null;
|
|
243
240
|
}
|
|
244
|
-
|
|
241
|
+
declare enum Status {
|
|
245
242
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
246
243
|
/** Event is scheduled to happen or has happened. */
|
|
247
244
|
CONFIRMED = "CONFIRMED",
|
|
@@ -249,9 +246,9 @@ export declare enum Status {
|
|
|
249
246
|
CANCELLED = "CANCELLED"
|
|
250
247
|
}
|
|
251
248
|
/** @enumType */
|
|
252
|
-
|
|
249
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'CONFIRMED' | 'CANCELLED';
|
|
253
250
|
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
254
|
-
|
|
251
|
+
interface ZonedDate {
|
|
255
252
|
/**
|
|
256
253
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
257
254
|
* For example, `2024-01-30T13:30:00`.
|
|
@@ -274,7 +271,7 @@ export interface ZonedDate {
|
|
|
274
271
|
*/
|
|
275
272
|
utcDate?: Date | null;
|
|
276
273
|
}
|
|
277
|
-
|
|
274
|
+
declare enum RecurrenceType {
|
|
278
275
|
UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
|
|
279
276
|
/** The event occurs only once and doesn't repeat. */
|
|
280
277
|
NONE = "NONE",
|
|
@@ -286,8 +283,8 @@ export declare enum RecurrenceType {
|
|
|
286
283
|
EXCEPTION = "EXCEPTION"
|
|
287
284
|
}
|
|
288
285
|
/** @enumType */
|
|
289
|
-
|
|
290
|
-
|
|
286
|
+
type RecurrenceTypeWithLiterals = RecurrenceType | 'UNKNOWN_RECURRENCE_TYPE' | 'NONE' | 'MASTER' | 'INSTANCE' | 'EXCEPTION';
|
|
287
|
+
interface RecurrenceRule {
|
|
291
288
|
/**
|
|
292
289
|
* Frequency how often the event repeats. Works together with `interval`.
|
|
293
290
|
*
|
|
@@ -325,20 +322,20 @@ export interface RecurrenceRule {
|
|
|
325
322
|
/**
|
|
326
323
|
* Date until when the event repeats
|
|
327
324
|
* adjusted to the `timeZone` of the business
|
|
328
|
-
* [site properties](https://dev.wix.com/docs/
|
|
325
|
+
* [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
329
326
|
* or a different `timeZone` you provide in the call's request.
|
|
330
327
|
* @readonly
|
|
331
328
|
*/
|
|
332
329
|
adjustedUntil?: ZonedDate;
|
|
333
330
|
}
|
|
334
|
-
|
|
331
|
+
declare enum Frequency {
|
|
335
332
|
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
336
333
|
/** The event's recurrence pattern is based on weeks. */
|
|
337
334
|
WEEKLY = "WEEKLY"
|
|
338
335
|
}
|
|
339
336
|
/** @enumType */
|
|
340
|
-
|
|
341
|
-
|
|
337
|
+
type FrequencyWithLiterals = Frequency | 'UNKNOWN_FREQUENCY' | 'WEEKLY';
|
|
338
|
+
declare enum Day {
|
|
342
339
|
/** The recurring event takes place on Mondays. */
|
|
343
340
|
MONDAY = "MONDAY",
|
|
344
341
|
/** The recurring event takes place on Tuesdays. */
|
|
@@ -355,8 +352,8 @@ export declare enum Day {
|
|
|
355
352
|
SUNDAY = "SUNDAY"
|
|
356
353
|
}
|
|
357
354
|
/** @enumType */
|
|
358
|
-
|
|
359
|
-
|
|
355
|
+
type DayWithLiterals = Day | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
356
|
+
declare enum Transparency {
|
|
360
357
|
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
361
358
|
/** 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. */
|
|
362
359
|
OPAQUE = "OPAQUE",
|
|
@@ -364,14 +361,14 @@ export declare enum Transparency {
|
|
|
364
361
|
TRANSPARENT = "TRANSPARENT"
|
|
365
362
|
}
|
|
366
363
|
/** @enumType */
|
|
367
|
-
|
|
368
|
-
|
|
364
|
+
type TransparencyWithLiterals = Transparency | 'UNKNOWN_TRANSPARENCY' | 'OPAQUE' | 'TRANSPARENT';
|
|
365
|
+
interface Location {
|
|
369
366
|
/**
|
|
370
367
|
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
371
368
|
* ID. Available only for `BUSINESS` locations.
|
|
372
369
|
* @format GUID
|
|
373
370
|
*/
|
|
374
|
-
|
|
371
|
+
_id?: string | null;
|
|
375
372
|
/**
|
|
376
373
|
* Location type.
|
|
377
374
|
*
|
|
@@ -401,7 +398,7 @@ export interface Location {
|
|
|
401
398
|
*/
|
|
402
399
|
address?: string | null;
|
|
403
400
|
}
|
|
404
|
-
|
|
401
|
+
declare enum LocationType {
|
|
405
402
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
406
403
|
/** The event is held at a business location. */
|
|
407
404
|
BUSINESS = "BUSINESS",
|
|
@@ -411,13 +408,13 @@ export declare enum LocationType {
|
|
|
411
408
|
CUSTOM = "CUSTOM"
|
|
412
409
|
}
|
|
413
410
|
/** @enumType */
|
|
414
|
-
|
|
415
|
-
|
|
411
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_TYPE' | 'BUSINESS' | 'CUSTOMER' | 'CUSTOM';
|
|
412
|
+
interface Resource {
|
|
416
413
|
/**
|
|
417
414
|
* Resource ID.
|
|
418
415
|
* @format GUID
|
|
419
416
|
*/
|
|
420
|
-
|
|
417
|
+
_id?: string | null;
|
|
421
418
|
/**
|
|
422
419
|
* Resource name.
|
|
423
420
|
* @readonly
|
|
@@ -445,7 +442,7 @@ export interface Resource {
|
|
|
445
442
|
*/
|
|
446
443
|
permissionRole?: RoleWithLiterals;
|
|
447
444
|
}
|
|
448
|
-
|
|
445
|
+
declare enum Role {
|
|
449
446
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
450
447
|
/** Full read and write access. */
|
|
451
448
|
WRITER = "WRITER",
|
|
@@ -453,8 +450,8 @@ export declare enum Role {
|
|
|
453
450
|
COMMENTER = "COMMENTER"
|
|
454
451
|
}
|
|
455
452
|
/** @enumType */
|
|
456
|
-
|
|
457
|
-
|
|
453
|
+
type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'WRITER' | 'COMMENTER';
|
|
454
|
+
interface Participants {
|
|
458
455
|
/**
|
|
459
456
|
* Total number of participants.
|
|
460
457
|
*
|
|
@@ -484,7 +481,7 @@ export interface Participants {
|
|
|
484
481
|
*/
|
|
485
482
|
status?: ParticipantsStatusWithLiterals;
|
|
486
483
|
}
|
|
487
|
-
|
|
484
|
+
interface Participant {
|
|
488
485
|
/**
|
|
489
486
|
* Participant name.
|
|
490
487
|
*
|
|
@@ -505,13 +502,13 @@ export interface Participant {
|
|
|
505
502
|
*/
|
|
506
503
|
email?: string | null;
|
|
507
504
|
/**
|
|
508
|
-
* [Contact](https://dev.wix.com/docs/
|
|
505
|
+
* [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
509
506
|
* ID of the participant.
|
|
510
507
|
* @format GUID
|
|
511
508
|
*/
|
|
512
509
|
contactId?: string | null;
|
|
513
510
|
}
|
|
514
|
-
|
|
511
|
+
declare enum ParticipantsStatus {
|
|
515
512
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
516
513
|
/** All participants are confirmed. */
|
|
517
514
|
CONFIRMED = "CONFIRMED",
|
|
@@ -519,8 +516,8 @@ export declare enum ParticipantsStatus {
|
|
|
519
516
|
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
520
517
|
}
|
|
521
518
|
/** @enumType */
|
|
522
|
-
|
|
523
|
-
|
|
519
|
+
type ParticipantsStatusWithLiterals = ParticipantsStatus | 'UNKNOWN_STATUS' | 'CONFIRMED' | 'PENDING_CONFIRMATION';
|
|
520
|
+
interface ConferencingDetails {
|
|
524
521
|
/** Conference type. For example, `Zoom`. */
|
|
525
522
|
type?: TypeWithLiterals;
|
|
526
523
|
/**
|
|
@@ -560,14 +557,14 @@ export interface ConferencingDetails {
|
|
|
560
557
|
*/
|
|
561
558
|
externalId?: string | null;
|
|
562
559
|
}
|
|
563
|
-
|
|
560
|
+
declare enum Type {
|
|
564
561
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
565
562
|
ZOOM = "ZOOM",
|
|
566
563
|
CUSTOM = "CUSTOM"
|
|
567
564
|
}
|
|
568
565
|
/** @enumType */
|
|
569
|
-
|
|
570
|
-
|
|
566
|
+
type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'ZOOM' | 'CUSTOM';
|
|
567
|
+
declare enum Field {
|
|
571
568
|
UNKNOWN_FIELD = "UNKNOWN_FIELD",
|
|
572
569
|
/** `title` is inherited from the schedule or `MASTER` event. */
|
|
573
570
|
TITLE = "TITLE",
|
|
@@ -587,8 +584,8 @@ export declare enum Field {
|
|
|
587
584
|
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
588
585
|
}
|
|
589
586
|
/** @enumType */
|
|
590
|
-
|
|
591
|
-
|
|
587
|
+
type FieldWithLiterals = Field | 'UNKNOWN_FIELD' | 'TITLE' | 'TIME_ZONE' | 'TIME' | 'LOCATION' | 'RESOURCES' | 'CAPACITY' | 'PARTICIPANTS' | 'CONFERENCING_DETAILS';
|
|
588
|
+
interface Permission {
|
|
592
589
|
/**
|
|
593
590
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
594
591
|
* granted the permission.
|
|
@@ -603,7 +600,7 @@ export interface Permission {
|
|
|
603
600
|
*/
|
|
604
601
|
role?: RoleWithLiterals;
|
|
605
602
|
}
|
|
606
|
-
|
|
603
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
607
604
|
/**
|
|
608
605
|
* ID of a Wix user. For example, the site owner or a
|
|
609
606
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -612,7 +609,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
612
609
|
wixUserId?: string;
|
|
613
610
|
}
|
|
614
611
|
/** @oneof */
|
|
615
|
-
|
|
612
|
+
interface CommonIdentificationDataIdOneOf {
|
|
616
613
|
/**
|
|
617
614
|
* ID of a Wix user. For example, the site owner or a
|
|
618
615
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -620,13 +617,11 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
620
617
|
*/
|
|
621
618
|
wixUserId?: string;
|
|
622
619
|
}
|
|
623
|
-
|
|
620
|
+
declare enum IdentityType {
|
|
624
621
|
UNKNOWN = "UNKNOWN",
|
|
625
622
|
WIX_USER = "WIX_USER"
|
|
626
623
|
}
|
|
627
|
-
|
|
628
|
-
export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
|
|
629
|
-
export interface ExtendedFields {
|
|
624
|
+
interface ExtendedFields {
|
|
630
625
|
/**
|
|
631
626
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
632
627
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -637,17 +632,17 @@ export interface ExtendedFields {
|
|
|
637
632
|
*/
|
|
638
633
|
namespaces?: Record<string, Record<string, any>>;
|
|
639
634
|
}
|
|
640
|
-
|
|
635
|
+
interface RecurringEventSplit {
|
|
641
636
|
/** Original `MASTER` event that was shortened. */
|
|
642
637
|
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
643
638
|
/** New `MASTER` event starting with the first event after the split date. */
|
|
644
639
|
newRecurringEventStartingFromSplit?: Event;
|
|
645
640
|
}
|
|
646
|
-
|
|
641
|
+
interface EventCancelled {
|
|
647
642
|
/** Canceled event. */
|
|
648
643
|
event?: Event;
|
|
649
644
|
}
|
|
650
|
-
|
|
645
|
+
interface ParticipantNotification {
|
|
651
646
|
/**
|
|
652
647
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
653
648
|
*
|
|
@@ -665,7 +660,7 @@ export interface ParticipantNotification {
|
|
|
665
660
|
message?: string | null;
|
|
666
661
|
}
|
|
667
662
|
/** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
|
|
668
|
-
|
|
663
|
+
interface EventUpdatedWithMetadata {
|
|
669
664
|
/** The updated event. */
|
|
670
665
|
event?: Event;
|
|
671
666
|
/**
|
|
@@ -674,31 +669,31 @@ export interface EventUpdatedWithMetadata {
|
|
|
674
669
|
*/
|
|
675
670
|
participantNotification?: ParticipantNotification;
|
|
676
671
|
}
|
|
677
|
-
|
|
672
|
+
interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
678
673
|
/** @format GUID */
|
|
679
674
|
metaSiteId?: string;
|
|
680
675
|
/** @format GUID */
|
|
681
676
|
currentBusinessResourceId?: string;
|
|
682
677
|
migrateBusinessConferenceId?: boolean;
|
|
683
678
|
}
|
|
684
|
-
|
|
679
|
+
interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
685
680
|
}
|
|
686
|
-
|
|
681
|
+
interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
687
682
|
/** @format GUID */
|
|
688
683
|
metaSiteId?: string;
|
|
689
684
|
/** @format GUID */
|
|
690
685
|
currentBusinessResourceId?: string;
|
|
691
686
|
migrateBusinessConferenceId?: boolean;
|
|
692
687
|
}
|
|
693
|
-
|
|
688
|
+
interface UpdateEventsWithFixedBusinessResourceIdResponse {
|
|
694
689
|
}
|
|
695
|
-
|
|
690
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
696
691
|
createdEvent?: EntityCreatedEvent;
|
|
697
692
|
updatedEvent?: EntityUpdatedEvent;
|
|
698
693
|
deletedEvent?: EntityDeletedEvent;
|
|
699
694
|
actionEvent?: ActionEvent;
|
|
700
695
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
701
|
-
|
|
696
|
+
_id?: string;
|
|
702
697
|
/**
|
|
703
698
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
704
699
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -727,36 +722,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
727
722
|
entityEventSequence?: string | null;
|
|
728
723
|
}
|
|
729
724
|
/** @oneof */
|
|
730
|
-
|
|
725
|
+
interface DomainEventBodyOneOf {
|
|
731
726
|
createdEvent?: EntityCreatedEvent;
|
|
732
727
|
updatedEvent?: EntityUpdatedEvent;
|
|
733
728
|
deletedEvent?: EntityDeletedEvent;
|
|
734
729
|
actionEvent?: ActionEvent;
|
|
735
730
|
}
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
739
|
-
restoreInfo?: RestoreInfo;
|
|
731
|
+
interface EntityCreatedEvent {
|
|
732
|
+
entity?: string;
|
|
740
733
|
}
|
|
741
|
-
|
|
734
|
+
interface RestoreInfo {
|
|
742
735
|
deletedDate?: Date | null;
|
|
743
736
|
}
|
|
744
|
-
|
|
737
|
+
interface EntityUpdatedEvent {
|
|
745
738
|
/**
|
|
746
739
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
747
740
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
748
741
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
749
742
|
*/
|
|
750
|
-
|
|
743
|
+
currentEntity?: string;
|
|
751
744
|
}
|
|
752
|
-
|
|
745
|
+
interface EntityDeletedEvent {
|
|
753
746
|
/** Entity that was deleted. */
|
|
754
|
-
|
|
747
|
+
deletedEntity?: string | null;
|
|
755
748
|
}
|
|
756
|
-
|
|
757
|
-
|
|
749
|
+
interface ActionEvent {
|
|
750
|
+
body?: string;
|
|
758
751
|
}
|
|
759
|
-
|
|
752
|
+
interface MessageEnvelope {
|
|
760
753
|
/**
|
|
761
754
|
* App instance ID.
|
|
762
755
|
* @format GUID
|
|
@@ -772,7 +765,7 @@ export interface MessageEnvelope {
|
|
|
772
765
|
/** Stringify payload. */
|
|
773
766
|
data?: string;
|
|
774
767
|
}
|
|
775
|
-
|
|
768
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
776
769
|
/**
|
|
777
770
|
* ID of a site visitor that has not logged in to the site.
|
|
778
771
|
* @format GUID
|
|
@@ -797,7 +790,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
797
790
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
798
791
|
}
|
|
799
792
|
/** @oneof */
|
|
800
|
-
|
|
793
|
+
interface IdentificationDataIdOneOf {
|
|
801
794
|
/**
|
|
802
795
|
* ID of a site visitor that has not logged in to the site.
|
|
803
796
|
* @format GUID
|
|
@@ -819,7 +812,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
819
812
|
*/
|
|
820
813
|
appId?: string;
|
|
821
814
|
}
|
|
822
|
-
|
|
815
|
+
declare enum WebhookIdentityType {
|
|
823
816
|
UNKNOWN = "UNKNOWN",
|
|
824
817
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
825
818
|
MEMBER = "MEMBER",
|
|
@@ -827,32 +820,112 @@ export declare enum WebhookIdentityType {
|
|
|
827
820
|
APP = "APP"
|
|
828
821
|
}
|
|
829
822
|
/** @enumType */
|
|
830
|
-
|
|
831
|
-
|
|
823
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
824
|
+
interface GetEventRequest {
|
|
832
825
|
/**
|
|
833
|
-
* ID of the
|
|
834
|
-
*
|
|
835
|
-
*
|
|
826
|
+
* ID of the event to retrieve.
|
|
827
|
+
*
|
|
828
|
+
* Min: 36 characters
|
|
829
|
+
* Max: 250 characters
|
|
830
|
+
* @minLength 36
|
|
831
|
+
* @maxLength 250
|
|
832
|
+
*/
|
|
833
|
+
eventId: string | null;
|
|
834
|
+
/**
|
|
835
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
836
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
837
|
+
* `America/New_York` or `UTC`.
|
|
838
|
+
*
|
|
839
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
840
|
+
*/
|
|
841
|
+
timeZone?: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
844
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
845
|
+
* for more information.
|
|
846
|
+
*
|
|
847
|
+
* Supported values:
|
|
848
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
849
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
850
|
+
*
|
|
851
|
+
* Max: 1 field
|
|
852
|
+
* Default: No personal data is returned.
|
|
853
|
+
* @maxSize 1
|
|
854
|
+
*/
|
|
855
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
856
|
+
}
|
|
857
|
+
declare enum RequestedFields {
|
|
858
|
+
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
859
|
+
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
860
|
+
PI_FIELDS = "PI_FIELDS",
|
|
861
|
+
/** Returns only fields containing your own personal data. */
|
|
862
|
+
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
863
|
+
}
|
|
864
|
+
/** @enumType */
|
|
865
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
|
|
866
|
+
interface GetEventResponse {
|
|
867
|
+
/** Retrieved event. */
|
|
868
|
+
event?: Event;
|
|
869
|
+
}
|
|
870
|
+
interface ListEventsRequest {
|
|
871
|
+
/**
|
|
872
|
+
* IDs of the events to retrieve.
|
|
873
|
+
*
|
|
874
|
+
* Min: 1 event ID
|
|
875
|
+
* Min: 100 event IDs
|
|
876
|
+
* @minSize 1
|
|
877
|
+
* @maxSize 100
|
|
878
|
+
* @minLength 36
|
|
879
|
+
* @maxLength 250
|
|
880
|
+
*/
|
|
881
|
+
eventIds: string[];
|
|
882
|
+
/**
|
|
883
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
884
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
885
|
+
* `America/New_York` or `UTC`.
|
|
886
|
+
*
|
|
887
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
888
|
+
*/
|
|
889
|
+
timeZone?: string | null;
|
|
890
|
+
/**
|
|
891
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
892
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
893
|
+
* for more information.
|
|
894
|
+
*
|
|
895
|
+
* Supported values:
|
|
896
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
897
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
898
|
+
*
|
|
899
|
+
* Max: 1 field
|
|
900
|
+
* Default: No personal data is returned.
|
|
901
|
+
* @maxSize 1
|
|
836
902
|
*/
|
|
837
|
-
|
|
903
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
904
|
+
}
|
|
905
|
+
interface ListEventsResponse {
|
|
906
|
+
/** Retrieved events matching the provided IDs. */
|
|
907
|
+
events?: Event[];
|
|
908
|
+
}
|
|
909
|
+
interface QueryEventsRequest {
|
|
838
910
|
/**
|
|
839
911
|
* Local start date and time from which events are returned in
|
|
840
912
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
841
|
-
* `2024-01-30T13:30:00`.
|
|
913
|
+
* `2024-01-30T13:30:00`.
|
|
842
914
|
*
|
|
843
915
|
* Events that start before the `fromLocalDate` but end after it are included in
|
|
844
|
-
* the results. Must be earlier than `toLocalDate
|
|
916
|
+
* the results. Must be earlier than `toLocalDate` unless the sort order is
|
|
917
|
+
* descending.
|
|
845
918
|
* @format LOCAL_DATE_TIME
|
|
846
919
|
*/
|
|
847
920
|
fromLocalDate?: string | null;
|
|
848
921
|
/**
|
|
849
922
|
* Local end date and time up to which events are returned in
|
|
850
923
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
851
|
-
* `2024-01-30T13:30:00`.
|
|
852
|
-
* `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
|
|
924
|
+
* `2024-01-30T13:30:00`.
|
|
853
925
|
*
|
|
854
926
|
* Events that start before `toLocalDate` but end after it are included in the
|
|
855
|
-
* results. Must be later than `fromLocalDate
|
|
927
|
+
* results. Must be later than `fromLocalDate` unless the sort order is
|
|
928
|
+
* descending.
|
|
856
929
|
* @format LOCAL_DATE_TIME
|
|
857
930
|
*/
|
|
858
931
|
toLocalDate?: string | null;
|
|
@@ -865,21 +938,88 @@ export interface ListEventsByContactIdRequest {
|
|
|
865
938
|
*/
|
|
866
939
|
timeZone?: string | null;
|
|
867
940
|
/**
|
|
868
|
-
*
|
|
869
|
-
*
|
|
870
|
-
*
|
|
941
|
+
* Query containing filters and paging.
|
|
942
|
+
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
943
|
+
* specify `fromLocalDate` and `toLocalDate`.
|
|
871
944
|
*/
|
|
872
|
-
|
|
873
|
-
/**
|
|
874
|
-
|
|
945
|
+
query?: CursorQuery;
|
|
946
|
+
/**
|
|
947
|
+
* Filters events based on their `recurrenceType`.
|
|
948
|
+
*
|
|
949
|
+
* Max: 5 recurrence types can be specified.
|
|
950
|
+
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
951
|
+
* @maxSize 5
|
|
952
|
+
*/
|
|
953
|
+
recurrenceType?: RecurrenceTypeWithLiterals[];
|
|
954
|
+
/**
|
|
955
|
+
* Information about which fields containing personal data to return. Refer to the
|
|
956
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
957
|
+
* for more information.
|
|
958
|
+
*
|
|
959
|
+
* Supported values:
|
|
960
|
+
* + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
|
|
961
|
+
* + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
|
|
962
|
+
*
|
|
963
|
+
* Max: 1 field
|
|
964
|
+
* Default: No personal data is returned.
|
|
965
|
+
* @maxSize 1
|
|
966
|
+
*/
|
|
967
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
968
|
+
}
|
|
969
|
+
/** TODO Diverge */
|
|
970
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
971
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
972
|
+
cursorPaging?: CursorPaging;
|
|
973
|
+
/**
|
|
974
|
+
* Filter object.
|
|
975
|
+
* See API Query Language
|
|
976
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language))
|
|
977
|
+
* for more information.
|
|
978
|
+
*
|
|
979
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
980
|
+
*
|
|
981
|
+
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
982
|
+
* specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
|
|
983
|
+
* filters, refer to the supported filters article
|
|
984
|
+
* ([REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting)).
|
|
985
|
+
*/
|
|
986
|
+
filter?: Record<string, any> | null;
|
|
987
|
+
/**
|
|
988
|
+
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
989
|
+
* Default is start ascending.
|
|
990
|
+
* @maxSize 1
|
|
991
|
+
*/
|
|
992
|
+
sort?: Sorting[];
|
|
993
|
+
}
|
|
994
|
+
/** @oneof */
|
|
995
|
+
interface CursorQueryPagingMethodOneOf {
|
|
996
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
997
|
+
cursorPaging?: CursorPaging;
|
|
998
|
+
}
|
|
999
|
+
/** TODO Diverge */
|
|
1000
|
+
interface Sorting {
|
|
1001
|
+
/**
|
|
1002
|
+
* The field to sort by.
|
|
1003
|
+
* Either `start` or `end`.
|
|
1004
|
+
* Default is `start`.
|
|
1005
|
+
*/
|
|
1006
|
+
fieldName?: string;
|
|
1007
|
+
/** Sort order. */
|
|
1008
|
+
order?: SortOrderWithLiterals;
|
|
875
1009
|
}
|
|
1010
|
+
declare enum SortOrder {
|
|
1011
|
+
ASC = "ASC",
|
|
1012
|
+
DESC = "DESC"
|
|
1013
|
+
}
|
|
1014
|
+
/** @enumType */
|
|
1015
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
876
1016
|
/** TODO Diverge */
|
|
877
|
-
|
|
1017
|
+
interface CursorPaging {
|
|
878
1018
|
/**
|
|
879
1019
|
* Number of events to return.
|
|
880
|
-
* Defaults to `50`. Maximum `
|
|
1020
|
+
* Defaults to `50`. Maximum `1000`.
|
|
881
1021
|
* @min 1
|
|
882
|
-
* @max
|
|
1022
|
+
* @max 1000
|
|
883
1023
|
*/
|
|
884
1024
|
limit?: number | null;
|
|
885
1025
|
/**
|
|
@@ -891,18 +1031,18 @@ export interface CommonCursorPaging {
|
|
|
891
1031
|
*/
|
|
892
1032
|
cursor?: string | null;
|
|
893
1033
|
}
|
|
894
|
-
|
|
895
|
-
/** Retrieved events. */
|
|
1034
|
+
interface QueryEventsResponse {
|
|
1035
|
+
/** Retrieved events matching the provided query. */
|
|
896
1036
|
events?: Event[];
|
|
897
1037
|
/** Paging metadata. */
|
|
898
|
-
pagingMetadata?:
|
|
1038
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
899
1039
|
}
|
|
900
1040
|
/** TODO Diverge */
|
|
901
|
-
|
|
1041
|
+
interface CursorPagingMetadata {
|
|
902
1042
|
/** Number of items returned in the response. */
|
|
903
1043
|
count?: number | null;
|
|
904
1044
|
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
905
|
-
cursors?:
|
|
1045
|
+
cursors?: Cursors;
|
|
906
1046
|
/**
|
|
907
1047
|
* Indicates if there are more results after the current page.
|
|
908
1048
|
* If `true`, another page of results can be retrieved.
|
|
@@ -910,116 +1050,377 @@ export interface CommonCursorPagingMetadata {
|
|
|
910
1050
|
*/
|
|
911
1051
|
hasNext?: boolean | null;
|
|
912
1052
|
}
|
|
913
|
-
|
|
1053
|
+
interface Cursors {
|
|
914
1054
|
/** Cursor pointing to next page in the list of results. */
|
|
915
1055
|
next?: string | null;
|
|
916
1056
|
}
|
|
917
|
-
|
|
1057
|
+
interface ListRecurringEventInstancesHistoryRequest {
|
|
1058
|
+
/**
|
|
1059
|
+
* The ID of the recurring event.
|
|
1060
|
+
* Required, unless `cursorPaging` is provided.
|
|
1061
|
+
* @minLength 64
|
|
1062
|
+
* @maxLength 64
|
|
1063
|
+
*/
|
|
1064
|
+
recurringEventId?: string | null;
|
|
918
1065
|
/**
|
|
919
|
-
*
|
|
920
|
-
*
|
|
921
|
-
* Provide `me` to retrieve events for the currently logged-in member.
|
|
922
|
-
* You must have the `Read Calendars - Including PI`
|
|
923
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
924
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
925
|
-
* @minLength 2
|
|
926
|
-
* @maxLength 36
|
|
1066
|
+
* The revision of the recurring event.
|
|
1067
|
+
* Required, unless `cursorPaging` is provided.
|
|
927
1068
|
*/
|
|
928
|
-
|
|
1069
|
+
revision?: string | null;
|
|
929
1070
|
/**
|
|
930
|
-
*
|
|
931
|
-
*
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
* Events that start before the `fromLocalDate` but end after it are included in
|
|
935
|
-
* the results. Must be earlier than `toLocalDate`.
|
|
936
|
-
* @format LOCAL_DATE_TIME
|
|
1071
|
+
* Inclusive start date for which events are returned, in ISO-8601 format.
|
|
1072
|
+
* Events that begin at or after the `fromDate` are included in the results.
|
|
1073
|
+
* Required, unless `cursorPaging` is provided.
|
|
937
1074
|
*/
|
|
938
|
-
|
|
1075
|
+
fromDate?: Date | null;
|
|
939
1076
|
/**
|
|
940
|
-
*
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
* `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
|
|
944
|
-
*
|
|
945
|
-
* Events that start before `toLocalDate` but end after it are included in the
|
|
946
|
-
* results. Must be later than `fromLocalDate`.
|
|
947
|
-
* @format LOCAL_DATE_TIME
|
|
1077
|
+
* Exclusive end date for which events are returned, in ISO-8601 format.
|
|
1078
|
+
* Events that begin before the `toDate` are included in the results.
|
|
1079
|
+
* Required, unless `cursorPaging` is provided.
|
|
948
1080
|
*/
|
|
949
|
-
|
|
1081
|
+
toDate?: Date | null;
|
|
1082
|
+
/** Optional cursor pointing to the next page of events. */
|
|
1083
|
+
cursorPaging?: CursorPaging;
|
|
1084
|
+
}
|
|
1085
|
+
interface ListRecurringEventInstancesHistoryResponse {
|
|
1086
|
+
/** The recurring event instances. */
|
|
1087
|
+
recurringEventInstances?: Event[];
|
|
1088
|
+
/** Paging metadata. */
|
|
1089
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1090
|
+
}
|
|
1091
|
+
interface CreateEventRequest {
|
|
1092
|
+
/** Event to create. */
|
|
1093
|
+
event: Event;
|
|
950
1094
|
/**
|
|
951
1095
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
952
|
-
* for
|
|
953
|
-
* `
|
|
1096
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1097
|
+
* `America/New_York` or `UTC`.
|
|
954
1098
|
*
|
|
955
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
1099
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
956
1100
|
*/
|
|
957
1101
|
timeZone?: string | null;
|
|
958
1102
|
/**
|
|
959
|
-
*
|
|
960
|
-
*
|
|
1103
|
+
* Idempotency key guaranteeing that you don't create the same event more
|
|
1104
|
+
* than once.
|
|
961
1105
|
* @format GUID
|
|
962
1106
|
*/
|
|
963
|
-
|
|
964
|
-
/** Cursor to retrieve the next page of the results. */
|
|
965
|
-
cursorPaging?: CommonCursorPaging;
|
|
966
|
-
/**
|
|
967
|
-
* IDs of the events to retrieve.
|
|
968
|
-
* If you provide a list of IDs, all other filters are ignored.
|
|
969
|
-
*
|
|
970
|
-
* Max: 100 `eventId`s
|
|
971
|
-
* @maxSize 100
|
|
972
|
-
* @minLength 36
|
|
973
|
-
* @maxLength 250
|
|
974
|
-
*/
|
|
975
|
-
eventIds?: string[];
|
|
1107
|
+
idempotencyKey?: string | null;
|
|
976
1108
|
}
|
|
977
|
-
|
|
978
|
-
/**
|
|
979
|
-
|
|
980
|
-
/** Paging metadata. */
|
|
981
|
-
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1109
|
+
interface CreateEventResponse {
|
|
1110
|
+
/** Created event. */
|
|
1111
|
+
event?: Event;
|
|
982
1112
|
}
|
|
983
|
-
|
|
984
|
-
export interface SitePropertiesNotification {
|
|
985
|
-
/** The site ID for which this update notification applies. */
|
|
986
|
-
metasiteId?: string;
|
|
987
|
-
/** The actual update event. */
|
|
988
|
-
event?: SitePropertiesEvent;
|
|
1113
|
+
interface BulkCreateEventRequest {
|
|
989
1114
|
/**
|
|
990
|
-
*
|
|
991
|
-
* @
|
|
1115
|
+
* Events to create.
|
|
1116
|
+
* @minSize 1
|
|
1117
|
+
* @maxSize 50
|
|
992
1118
|
*/
|
|
993
|
-
|
|
994
|
-
/** Context of the notification */
|
|
995
|
-
changeContext?: ChangeContext;
|
|
996
|
-
}
|
|
997
|
-
/** The actual update event for a particular notification. */
|
|
998
|
-
export interface SitePropertiesEvent {
|
|
999
|
-
/** Version of the site's properties represented by this update. */
|
|
1000
|
-
version?: number;
|
|
1001
|
-
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1002
|
-
fields?: string[];
|
|
1003
|
-
/** Updated properties. */
|
|
1004
|
-
properties?: Properties;
|
|
1005
|
-
}
|
|
1006
|
-
export interface Properties {
|
|
1007
|
-
/** Site categories. */
|
|
1008
|
-
categories?: Categories;
|
|
1009
|
-
/** Site locale. */
|
|
1010
|
-
locale?: Locale;
|
|
1119
|
+
events: MaskedEvent[];
|
|
1011
1120
|
/**
|
|
1012
|
-
*
|
|
1121
|
+
* Whether to return created events.
|
|
1013
1122
|
*
|
|
1014
|
-
*
|
|
1123
|
+
* Default: `false`.
|
|
1015
1124
|
*/
|
|
1016
|
-
|
|
1125
|
+
returnEntity?: boolean | null;
|
|
1017
1126
|
/**
|
|
1018
|
-
*
|
|
1127
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1128
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1129
|
+
* `America/New_York` or `UTC`.
|
|
1019
1130
|
*
|
|
1020
|
-
*
|
|
1131
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1021
1132
|
*/
|
|
1022
|
-
|
|
1133
|
+
timeZone?: string | null;
|
|
1134
|
+
}
|
|
1135
|
+
interface MaskedEvent {
|
|
1136
|
+
/** Event to create. */
|
|
1137
|
+
event?: Event;
|
|
1138
|
+
}
|
|
1139
|
+
interface BulkCreateEventResponse {
|
|
1140
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1141
|
+
results?: BulkEventResult[];
|
|
1142
|
+
/** Total successes and failures. */
|
|
1143
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1144
|
+
}
|
|
1145
|
+
interface BulkEventResult {
|
|
1146
|
+
/** Whether the requested action was successful. */
|
|
1147
|
+
itemMetadata?: ItemMetadata;
|
|
1148
|
+
/** The event. */
|
|
1149
|
+
item?: Event;
|
|
1150
|
+
}
|
|
1151
|
+
interface ItemMetadata {
|
|
1152
|
+
/**
|
|
1153
|
+
* Event ID.
|
|
1154
|
+
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1155
|
+
*/
|
|
1156
|
+
_id?: string | null;
|
|
1157
|
+
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1158
|
+
originalIndex?: number;
|
|
1159
|
+
/**
|
|
1160
|
+
* Whether the requested action was successful for this event.
|
|
1161
|
+
* When `false`, the `error` field is populated.
|
|
1162
|
+
*/
|
|
1163
|
+
success?: boolean;
|
|
1164
|
+
/** Details about the error in case of failure. */
|
|
1165
|
+
error?: ApplicationError;
|
|
1166
|
+
}
|
|
1167
|
+
interface ApplicationError {
|
|
1168
|
+
/** Error code. */
|
|
1169
|
+
code?: string;
|
|
1170
|
+
/** Description of the error. */
|
|
1171
|
+
description?: string;
|
|
1172
|
+
/** Data related to the error. */
|
|
1173
|
+
data?: Record<string, any> | null;
|
|
1174
|
+
}
|
|
1175
|
+
interface BulkActionMetadata {
|
|
1176
|
+
/** Number of events that were successfully processed. */
|
|
1177
|
+
totalSuccesses?: number;
|
|
1178
|
+
/** Number of events that couldn't be processed. */
|
|
1179
|
+
totalFailures?: number;
|
|
1180
|
+
}
|
|
1181
|
+
interface UpdateEventRequest {
|
|
1182
|
+
/** Event to update. */
|
|
1183
|
+
event: Event;
|
|
1184
|
+
/**
|
|
1185
|
+
* Information about whether participants of the updated event are notified and
|
|
1186
|
+
* the message they receive.
|
|
1187
|
+
*/
|
|
1188
|
+
participantNotification?: ParticipantNotification;
|
|
1189
|
+
/**
|
|
1190
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1191
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1192
|
+
* `America/New_York` or `UTC`.
|
|
1193
|
+
*
|
|
1194
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1195
|
+
*/
|
|
1196
|
+
timeZone?: string | null;
|
|
1197
|
+
}
|
|
1198
|
+
interface UpdateEventResponse {
|
|
1199
|
+
/** Updated event. */
|
|
1200
|
+
event?: Event;
|
|
1201
|
+
}
|
|
1202
|
+
interface BulkUpdateEventRequest {
|
|
1203
|
+
/**
|
|
1204
|
+
* Events to update.
|
|
1205
|
+
*
|
|
1206
|
+
* Min: 1 event
|
|
1207
|
+
* Max: 50 events
|
|
1208
|
+
* @minSize 1
|
|
1209
|
+
* @maxSize 50
|
|
1210
|
+
*/
|
|
1211
|
+
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1212
|
+
/**
|
|
1213
|
+
* Whether to return the updated events.
|
|
1214
|
+
*
|
|
1215
|
+
* Default: `false`
|
|
1216
|
+
*/
|
|
1217
|
+
returnEntity?: boolean | null;
|
|
1218
|
+
/**
|
|
1219
|
+
* Information about whether participants of the updated event are notified and
|
|
1220
|
+
* the message they receive.
|
|
1221
|
+
*/
|
|
1222
|
+
participantNotification?: ParticipantNotification;
|
|
1223
|
+
/**
|
|
1224
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1225
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1226
|
+
* `America/New_York` or `UTC`.
|
|
1227
|
+
*
|
|
1228
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1229
|
+
*/
|
|
1230
|
+
timeZone?: string | null;
|
|
1231
|
+
}
|
|
1232
|
+
interface BulkUpdateEventRequestMaskedEvent {
|
|
1233
|
+
/** Event to update. */
|
|
1234
|
+
event?: Event;
|
|
1235
|
+
}
|
|
1236
|
+
interface BulkUpdateEventResponse {
|
|
1237
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1238
|
+
results?: BulkEventResult[];
|
|
1239
|
+
/** Total successes and failures. */
|
|
1240
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1241
|
+
}
|
|
1242
|
+
interface UpdateEventParticipantsRequest {
|
|
1243
|
+
/**
|
|
1244
|
+
* ID of the event to update.
|
|
1245
|
+
*
|
|
1246
|
+
* Min: 36 characters
|
|
1247
|
+
* Max: 250 characters
|
|
1248
|
+
* @minLength 36
|
|
1249
|
+
* @maxLength 250
|
|
1250
|
+
*/
|
|
1251
|
+
eventId?: string | null;
|
|
1252
|
+
/** The participants to update. */
|
|
1253
|
+
participants?: Participants;
|
|
1254
|
+
}
|
|
1255
|
+
interface UpdateEventParticipantsResponse {
|
|
1256
|
+
/** Updated event. */
|
|
1257
|
+
event?: Event;
|
|
1258
|
+
}
|
|
1259
|
+
interface RestoreEventDefaultsRequest {
|
|
1260
|
+
/**
|
|
1261
|
+
* ID of the event for which to restore default values.
|
|
1262
|
+
* @minLength 36
|
|
1263
|
+
* @maxLength 250
|
|
1264
|
+
*/
|
|
1265
|
+
eventId: string | null;
|
|
1266
|
+
/**
|
|
1267
|
+
* Fields for which to restore default values.
|
|
1268
|
+
*
|
|
1269
|
+
* `TIME` restores default values for `start` and `end`.
|
|
1270
|
+
*
|
|
1271
|
+
* Min: 1 field
|
|
1272
|
+
* @minSize 1
|
|
1273
|
+
*/
|
|
1274
|
+
fields: FieldWithLiterals[];
|
|
1275
|
+
/**
|
|
1276
|
+
* Information about whether participants of the updated event are notified and
|
|
1277
|
+
* the message they receive.
|
|
1278
|
+
*/
|
|
1279
|
+
participantNotification?: ParticipantNotification;
|
|
1280
|
+
/**
|
|
1281
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1282
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1283
|
+
* `America/New_York` or `UTC`.
|
|
1284
|
+
*
|
|
1285
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1286
|
+
*/
|
|
1287
|
+
timeZone?: string | null;
|
|
1288
|
+
}
|
|
1289
|
+
interface RestoreEventDefaultsResponse {
|
|
1290
|
+
/** Updated event. */
|
|
1291
|
+
event?: Event;
|
|
1292
|
+
}
|
|
1293
|
+
interface SplitRecurringEventRequest {
|
|
1294
|
+
/**
|
|
1295
|
+
* ID of the `MASTER` event to split.
|
|
1296
|
+
* @minLength 36
|
|
1297
|
+
* @maxLength 250
|
|
1298
|
+
*/
|
|
1299
|
+
recurringEventId: string | null;
|
|
1300
|
+
/**
|
|
1301
|
+
* Local date and time at which the `MASTER` event is split in
|
|
1302
|
+
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1303
|
+
* `2025-03-11T09:00:00`.
|
|
1304
|
+
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1305
|
+
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1306
|
+
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1307
|
+
* wouldn't affect any event without a subsequent occurrence.
|
|
1308
|
+
* @format LOCAL_DATE_TIME
|
|
1309
|
+
*/
|
|
1310
|
+
splitLocalDate: string | null;
|
|
1311
|
+
/**
|
|
1312
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1313
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1314
|
+
* `America/New_York` or `UTC`.
|
|
1315
|
+
*
|
|
1316
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1317
|
+
*/
|
|
1318
|
+
timeZone?: string | null;
|
|
1319
|
+
}
|
|
1320
|
+
interface SplitRecurringEventResponse {
|
|
1321
|
+
/** Original `MASTER` event that was shortened. */
|
|
1322
|
+
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1323
|
+
/** New `MASTER` event starting with the first event after the split date. */
|
|
1324
|
+
newRecurringEventStartingFromSplit?: Event;
|
|
1325
|
+
}
|
|
1326
|
+
interface CancelEventRequest {
|
|
1327
|
+
/**
|
|
1328
|
+
* ID of the event to cancel.
|
|
1329
|
+
* @minLength 36
|
|
1330
|
+
* @maxLength 250
|
|
1331
|
+
*/
|
|
1332
|
+
eventId: string | null;
|
|
1333
|
+
/**
|
|
1334
|
+
* Information about whether participants of the canceled event are notified and
|
|
1335
|
+
* the message they receive.
|
|
1336
|
+
*/
|
|
1337
|
+
participantNotification?: ParticipantNotification;
|
|
1338
|
+
/**
|
|
1339
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1340
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1341
|
+
* `America/New_York` or `UTC`.
|
|
1342
|
+
*
|
|
1343
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1344
|
+
*/
|
|
1345
|
+
timeZone?: string | null;
|
|
1346
|
+
}
|
|
1347
|
+
interface CancelEventResponse {
|
|
1348
|
+
/** Canceled event. */
|
|
1349
|
+
event?: Event;
|
|
1350
|
+
}
|
|
1351
|
+
interface BulkCancelEventRequest {
|
|
1352
|
+
/**
|
|
1353
|
+
* IDs of the events to cancel.
|
|
1354
|
+
* @minSize 1
|
|
1355
|
+
* @maxSize 50
|
|
1356
|
+
*/
|
|
1357
|
+
eventIds: string[];
|
|
1358
|
+
/**
|
|
1359
|
+
* Whether to return the canceled events.
|
|
1360
|
+
*
|
|
1361
|
+
* Default: `false`
|
|
1362
|
+
*/
|
|
1363
|
+
returnEntity?: boolean | null;
|
|
1364
|
+
/**
|
|
1365
|
+
* Information about whether participants of the canceled events are notified and
|
|
1366
|
+
* the message they receive.
|
|
1367
|
+
*/
|
|
1368
|
+
participantNotification?: ParticipantNotification;
|
|
1369
|
+
/**
|
|
1370
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1371
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1372
|
+
* `America/New_York` or `UTC`.
|
|
1373
|
+
*
|
|
1374
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1375
|
+
*/
|
|
1376
|
+
timeZone?: string | null;
|
|
1377
|
+
}
|
|
1378
|
+
interface BulkCancelEventResponse {
|
|
1379
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1380
|
+
results?: BulkEventResult[];
|
|
1381
|
+
/** Total successes and failures. */
|
|
1382
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1383
|
+
}
|
|
1384
|
+
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1385
|
+
interface SitePropertiesNotification {
|
|
1386
|
+
/** The site ID for which this update notification applies. */
|
|
1387
|
+
metasiteId?: string;
|
|
1388
|
+
/** The actual update event. */
|
|
1389
|
+
event?: SitePropertiesEvent;
|
|
1390
|
+
/**
|
|
1391
|
+
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
1392
|
+
* @maxSize 500
|
|
1393
|
+
*/
|
|
1394
|
+
translations?: Translation[];
|
|
1395
|
+
/** Context of the notification */
|
|
1396
|
+
changeContext?: ChangeContext;
|
|
1397
|
+
}
|
|
1398
|
+
/** The actual update event for a particular notification. */
|
|
1399
|
+
interface SitePropertiesEvent {
|
|
1400
|
+
/** Version of the site's properties represented by this update. */
|
|
1401
|
+
version?: number;
|
|
1402
|
+
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
1403
|
+
fields?: string[];
|
|
1404
|
+
/** Updated properties. */
|
|
1405
|
+
properties?: Properties;
|
|
1406
|
+
}
|
|
1407
|
+
interface Properties {
|
|
1408
|
+
/** Site categories. */
|
|
1409
|
+
categories?: Categories;
|
|
1410
|
+
/** Site locale. */
|
|
1411
|
+
locale?: Locale;
|
|
1412
|
+
/**
|
|
1413
|
+
* Site language.
|
|
1414
|
+
*
|
|
1415
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1416
|
+
*/
|
|
1417
|
+
language?: string | null;
|
|
1418
|
+
/**
|
|
1419
|
+
* Site currency format used to bill customers.
|
|
1420
|
+
*
|
|
1421
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1422
|
+
*/
|
|
1423
|
+
paymentCurrency?: string | null;
|
|
1023
1424
|
/** Timezone in `America/New_York` format. */
|
|
1024
1425
|
timeZone?: string | null;
|
|
1025
1426
|
/** Email address. */
|
|
@@ -1059,7 +1460,7 @@ export interface Properties {
|
|
|
1059
1460
|
/** Track clicks analytics. */
|
|
1060
1461
|
trackClicksAnalytics?: boolean;
|
|
1061
1462
|
}
|
|
1062
|
-
|
|
1463
|
+
interface Categories {
|
|
1063
1464
|
/** Primary site category. */
|
|
1064
1465
|
primary?: string;
|
|
1065
1466
|
/**
|
|
@@ -1070,13 +1471,13 @@ export interface Categories {
|
|
|
1070
1471
|
/** Business Term Id */
|
|
1071
1472
|
businessTermId?: string | null;
|
|
1072
1473
|
}
|
|
1073
|
-
|
|
1474
|
+
interface Locale {
|
|
1074
1475
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1075
1476
|
languageCode?: string;
|
|
1076
1477
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1077
1478
|
country?: string;
|
|
1078
1479
|
}
|
|
1079
|
-
|
|
1480
|
+
interface Address {
|
|
1080
1481
|
/** Street name. */
|
|
1081
1482
|
street?: string;
|
|
1082
1483
|
/** City name. */
|
|
@@ -1108,29 +1509,29 @@ export interface Address {
|
|
|
1108
1509
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1109
1510
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1110
1511
|
*/
|
|
1111
|
-
|
|
1512
|
+
interface AddressHint {
|
|
1112
1513
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1113
1514
|
text?: string;
|
|
1114
1515
|
/** Where the extra text should be displayed. */
|
|
1115
1516
|
placement?: PlacementTypeWithLiterals;
|
|
1116
1517
|
}
|
|
1117
1518
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1118
|
-
|
|
1519
|
+
declare enum PlacementType {
|
|
1119
1520
|
BEFORE = "BEFORE",
|
|
1120
1521
|
AFTER = "AFTER",
|
|
1121
1522
|
REPLACE = "REPLACE"
|
|
1122
1523
|
}
|
|
1123
1524
|
/** @enumType */
|
|
1124
|
-
|
|
1525
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
1125
1526
|
/** Geocoordinates for a particular address. */
|
|
1126
|
-
|
|
1527
|
+
interface GeoCoordinates {
|
|
1127
1528
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
1128
1529
|
latitude?: number;
|
|
1129
1530
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
1130
1531
|
longitude?: number;
|
|
1131
1532
|
}
|
|
1132
1533
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1133
|
-
|
|
1534
|
+
interface BusinessSchedule {
|
|
1134
1535
|
/**
|
|
1135
1536
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1136
1537
|
* @maxSize 100
|
|
@@ -1143,7 +1544,7 @@ export interface BusinessSchedule {
|
|
|
1143
1544
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1144
1545
|
}
|
|
1145
1546
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1146
|
-
|
|
1547
|
+
interface TimePeriod {
|
|
1147
1548
|
/** Day of the week the period starts on. */
|
|
1148
1549
|
openDay?: DayOfWeekWithLiterals;
|
|
1149
1550
|
/**
|
|
@@ -1162,7 +1563,7 @@ export interface TimePeriod {
|
|
|
1162
1563
|
closeTime?: string;
|
|
1163
1564
|
}
|
|
1164
1565
|
/** Enumerates the days of the week. */
|
|
1165
|
-
|
|
1566
|
+
declare enum DayOfWeek {
|
|
1166
1567
|
MONDAY = "MONDAY",
|
|
1167
1568
|
TUESDAY = "TUESDAY",
|
|
1168
1569
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -1172,9 +1573,9 @@ export declare enum DayOfWeek {
|
|
|
1172
1573
|
SUNDAY = "SUNDAY"
|
|
1173
1574
|
}
|
|
1174
1575
|
/** @enumType */
|
|
1175
|
-
|
|
1576
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1176
1577
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1177
|
-
|
|
1578
|
+
interface SpecialHourPeriod {
|
|
1178
1579
|
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1179
1580
|
startDate?: string;
|
|
1180
1581
|
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
@@ -1188,7 +1589,7 @@ export interface SpecialHourPeriod {
|
|
|
1188
1589
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1189
1590
|
comment?: string;
|
|
1190
1591
|
}
|
|
1191
|
-
|
|
1592
|
+
interface Multilingual {
|
|
1192
1593
|
/**
|
|
1193
1594
|
* Supported languages list.
|
|
1194
1595
|
* @maxSize 200
|
|
@@ -1197,7 +1598,7 @@ export interface Multilingual {
|
|
|
1197
1598
|
/** Whether to redirect to user language. */
|
|
1198
1599
|
autoRedirect?: boolean;
|
|
1199
1600
|
}
|
|
1200
|
-
|
|
1601
|
+
interface SupportedLanguage {
|
|
1201
1602
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1202
1603
|
languageCode?: string;
|
|
1203
1604
|
/** Locale. */
|
|
@@ -1211,14 +1612,14 @@ export interface SupportedLanguage {
|
|
|
1211
1612
|
/** Whether the supported language is the primary language for site visitors. */
|
|
1212
1613
|
isVisitorPrimary?: boolean | null;
|
|
1213
1614
|
}
|
|
1214
|
-
|
|
1615
|
+
declare enum ResolutionMethod {
|
|
1215
1616
|
QUERY_PARAM = "QUERY_PARAM",
|
|
1216
1617
|
SUBDOMAIN = "SUBDOMAIN",
|
|
1217
1618
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1218
1619
|
}
|
|
1219
1620
|
/** @enumType */
|
|
1220
|
-
|
|
1221
|
-
|
|
1621
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1622
|
+
interface ConsentPolicy {
|
|
1222
1623
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1223
1624
|
essential?: boolean | null;
|
|
1224
1625
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -1231,7 +1632,7 @@ export interface ConsentPolicy {
|
|
|
1231
1632
|
dataToThirdParty?: boolean | null;
|
|
1232
1633
|
}
|
|
1233
1634
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1234
|
-
|
|
1635
|
+
interface Translation {
|
|
1235
1636
|
/** The service type. */
|
|
1236
1637
|
serviceType?: string;
|
|
1237
1638
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -1239,7 +1640,7 @@ export interface Translation {
|
|
|
1239
1640
|
/** The instance ID of the service. */
|
|
1240
1641
|
instanceId?: string;
|
|
1241
1642
|
}
|
|
1242
|
-
|
|
1643
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1243
1644
|
/** Properties were updated. */
|
|
1244
1645
|
propertiesChange?: PropertiesChange;
|
|
1245
1646
|
/** Default properties were created on site creation. */
|
|
@@ -1248,7 +1649,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
1248
1649
|
siteCloned?: SiteCloned;
|
|
1249
1650
|
}
|
|
1250
1651
|
/** @oneof */
|
|
1251
|
-
|
|
1652
|
+
interface ChangeContextPayloadOneOf {
|
|
1252
1653
|
/** Properties were updated. */
|
|
1253
1654
|
propertiesChange?: PropertiesChange;
|
|
1254
1655
|
/** Default properties were created on site creation. */
|
|
@@ -1256,39 +1657,90 @@ export interface ChangeContextPayloadOneOf {
|
|
|
1256
1657
|
/** Properties were cloned on site cloning. */
|
|
1257
1658
|
siteCloned?: SiteCloned;
|
|
1258
1659
|
}
|
|
1259
|
-
|
|
1660
|
+
interface PropertiesChange {
|
|
1661
|
+
}
|
|
1662
|
+
interface SiteCreated {
|
|
1663
|
+
/** Origin template site id. */
|
|
1664
|
+
originTemplateId?: string | null;
|
|
1665
|
+
}
|
|
1666
|
+
interface SiteCloned {
|
|
1667
|
+
/** Origin site id. */
|
|
1668
|
+
originMetaSiteId?: string;
|
|
1669
|
+
}
|
|
1670
|
+
interface Empty {
|
|
1671
|
+
}
|
|
1672
|
+
interface BaseEventMetadata {
|
|
1673
|
+
/**
|
|
1674
|
+
* App instance ID.
|
|
1675
|
+
* @format GUID
|
|
1676
|
+
*/
|
|
1677
|
+
instanceId?: string | null;
|
|
1678
|
+
/**
|
|
1679
|
+
* Event type.
|
|
1680
|
+
* @maxLength 150
|
|
1681
|
+
*/
|
|
1682
|
+
eventType?: string;
|
|
1683
|
+
/** The identification type and identity data. */
|
|
1684
|
+
identity?: IdentificationData;
|
|
1685
|
+
}
|
|
1686
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1687
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1688
|
+
_id?: string;
|
|
1689
|
+
/**
|
|
1690
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1691
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1692
|
+
*/
|
|
1693
|
+
entityFqdn?: string;
|
|
1694
|
+
/**
|
|
1695
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1696
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1697
|
+
*/
|
|
1698
|
+
slug?: string;
|
|
1699
|
+
/** ID of the entity associated with the event. */
|
|
1700
|
+
entityId?: string;
|
|
1701
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1702
|
+
eventTime?: Date | null;
|
|
1703
|
+
/**
|
|
1704
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1705
|
+
* (for example, GDPR).
|
|
1706
|
+
*/
|
|
1707
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1708
|
+
/** If present, indicates the action that triggered the event. */
|
|
1709
|
+
originatedFrom?: string | null;
|
|
1710
|
+
/**
|
|
1711
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1712
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1713
|
+
*/
|
|
1714
|
+
entityEventSequence?: string | null;
|
|
1715
|
+
}
|
|
1716
|
+
interface EventCancelledEnvelope {
|
|
1717
|
+
data: EventCancelled;
|
|
1718
|
+
metadata: EventMetadata;
|
|
1260
1719
|
}
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1720
|
+
interface EventCreatedEnvelope {
|
|
1721
|
+
entity: Event;
|
|
1722
|
+
metadata: EventMetadata;
|
|
1264
1723
|
}
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1724
|
+
interface EventRecurringSplitEnvelope {
|
|
1725
|
+
data: RecurringEventSplit;
|
|
1726
|
+
metadata: EventMetadata;
|
|
1268
1727
|
}
|
|
1269
|
-
|
|
1728
|
+
interface EventUpdatedEnvelope {
|
|
1729
|
+
entity: Event;
|
|
1730
|
+
metadata: EventMetadata;
|
|
1270
1731
|
}
|
|
1271
|
-
|
|
1272
|
-
/**
|
|
1273
|
-
* ID of the event to retrieve.
|
|
1274
|
-
*
|
|
1275
|
-
* Min: 36 characters
|
|
1276
|
-
* Max: 250 characters
|
|
1277
|
-
* @minLength 36
|
|
1278
|
-
* @maxLength 250
|
|
1279
|
-
*/
|
|
1280
|
-
eventId: string | null;
|
|
1732
|
+
interface GetEventOptions {
|
|
1281
1733
|
/**
|
|
1282
1734
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1283
1735
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1284
1736
|
* `America/New_York` or `UTC`.
|
|
1285
1737
|
*
|
|
1286
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
1738
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1287
1739
|
*/
|
|
1288
1740
|
timeZone?: string | null;
|
|
1289
1741
|
/**
|
|
1290
1742
|
* Information about which fields containing personal data to return. Refer to the
|
|
1291
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
1743
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1292
1744
|
* for more information.
|
|
1293
1745
|
*
|
|
1294
1746
|
* Supported values:
|
|
@@ -1301,31 +1753,7 @@ export interface GetEventRequest {
|
|
|
1301
1753
|
*/
|
|
1302
1754
|
fields?: RequestedFieldsWithLiterals[];
|
|
1303
1755
|
}
|
|
1304
|
-
|
|
1305
|
-
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1306
|
-
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1307
|
-
PI_FIELDS = "PI_FIELDS",
|
|
1308
|
-
/** Returns only fields containing your own personal data. */
|
|
1309
|
-
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1310
|
-
}
|
|
1311
|
-
/** @enumType */
|
|
1312
|
-
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
|
|
1313
|
-
export interface GetEventResponse {
|
|
1314
|
-
/** Retrieved event. */
|
|
1315
|
-
event?: Event;
|
|
1316
|
-
}
|
|
1317
|
-
export interface ListEventsRequest {
|
|
1318
|
-
/**
|
|
1319
|
-
* IDs of the events to retrieve.
|
|
1320
|
-
*
|
|
1321
|
-
* Min: 1 event ID
|
|
1322
|
-
* Min: 100 event IDs
|
|
1323
|
-
* @minSize 1
|
|
1324
|
-
* @maxSize 100
|
|
1325
|
-
* @minLength 36
|
|
1326
|
-
* @maxLength 250
|
|
1327
|
-
*/
|
|
1328
|
-
eventIds: string[];
|
|
1756
|
+
interface ListEventsOptions {
|
|
1329
1757
|
/**
|
|
1330
1758
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1331
1759
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -1336,7 +1764,7 @@ export interface ListEventsRequest {
|
|
|
1336
1764
|
timeZone?: string | null;
|
|
1337
1765
|
/**
|
|
1338
1766
|
* Information about which fields containing personal data to return. Refer to the
|
|
1339
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
1767
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1340
1768
|
* for more information.
|
|
1341
1769
|
*
|
|
1342
1770
|
* Supported values:
|
|
@@ -1349,11 +1777,7 @@ export interface ListEventsRequest {
|
|
|
1349
1777
|
*/
|
|
1350
1778
|
fields?: RequestedFieldsWithLiterals[];
|
|
1351
1779
|
}
|
|
1352
|
-
|
|
1353
|
-
/** Retrieved events matching the provided IDs. */
|
|
1354
|
-
events?: Event[];
|
|
1355
|
-
}
|
|
1356
|
-
export interface QueryEventsRequest {
|
|
1780
|
+
interface QueryEventsOptions {
|
|
1357
1781
|
/**
|
|
1358
1782
|
* Local start date and time from which events are returned in
|
|
1359
1783
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -1364,7 +1788,7 @@ export interface QueryEventsRequest {
|
|
|
1364
1788
|
* descending.
|
|
1365
1789
|
* @format LOCAL_DATE_TIME
|
|
1366
1790
|
*/
|
|
1367
|
-
fromLocalDate?: string | null;
|
|
1791
|
+
fromLocalDate?: string | null | undefined;
|
|
1368
1792
|
/**
|
|
1369
1793
|
* Local end date and time up to which events are returned in
|
|
1370
1794
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -1375,7 +1799,7 @@ export interface QueryEventsRequest {
|
|
|
1375
1799
|
* descending.
|
|
1376
1800
|
* @format LOCAL_DATE_TIME
|
|
1377
1801
|
*/
|
|
1378
|
-
toLocalDate?: string | null;
|
|
1802
|
+
toLocalDate?: string | null | undefined;
|
|
1379
1803
|
/**
|
|
1380
1804
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1381
1805
|
* for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
|
|
@@ -1383,13 +1807,7 @@ export interface QueryEventsRequest {
|
|
|
1383
1807
|
*
|
|
1384
1808
|
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1385
1809
|
*/
|
|
1386
|
-
timeZone?: string | null;
|
|
1387
|
-
/**
|
|
1388
|
-
* Query containing filters and paging.
|
|
1389
|
-
* Do not specify filters for start and end dates inside `query.filter`, instead
|
|
1390
|
-
* specify `fromLocalDate` and `toLocalDate`.
|
|
1391
|
-
*/
|
|
1392
|
-
query?: CursorQuery;
|
|
1810
|
+
timeZone?: string | null | undefined;
|
|
1393
1811
|
/**
|
|
1394
1812
|
* Filters events based on their `recurrenceType`.
|
|
1395
1813
|
*
|
|
@@ -1397,10 +1815,10 @@ export interface QueryEventsRequest {
|
|
|
1397
1815
|
* Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
|
|
1398
1816
|
* @maxSize 5
|
|
1399
1817
|
*/
|
|
1400
|
-
recurrenceType?: RecurrenceTypeWithLiterals[];
|
|
1818
|
+
recurrenceType?: RecurrenceTypeWithLiterals[] | undefined;
|
|
1401
1819
|
/**
|
|
1402
1820
|
* Information about which fields containing personal data to return. Refer to the
|
|
1403
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
1821
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
1404
1822
|
* for more information.
|
|
1405
1823
|
*
|
|
1406
1824
|
* Supported values:
|
|
@@ -1411,223 +1829,326 @@ export interface QueryEventsRequest {
|
|
|
1411
1829
|
* Default: No personal data is returned.
|
|
1412
1830
|
* @maxSize 1
|
|
1413
1831
|
*/
|
|
1414
|
-
fields?: RequestedFieldsWithLiterals[];
|
|
1832
|
+
fields?: RequestedFieldsWithLiterals[] | undefined;
|
|
1415
1833
|
}
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1834
|
+
interface QueryCursorResult {
|
|
1835
|
+
cursors: Cursors;
|
|
1836
|
+
hasNext: () => boolean;
|
|
1837
|
+
hasPrev: () => boolean;
|
|
1838
|
+
length: number;
|
|
1839
|
+
pageSize: number;
|
|
1840
|
+
}
|
|
1841
|
+
interface EventsQueryResult extends QueryCursorResult {
|
|
1842
|
+
items: Event[];
|
|
1843
|
+
query: EventsQueryBuilder;
|
|
1844
|
+
next: () => Promise<EventsQueryResult>;
|
|
1845
|
+
prev: () => Promise<EventsQueryResult>;
|
|
1846
|
+
}
|
|
1847
|
+
interface EventsQueryBuilder {
|
|
1848
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1849
|
+
* @param value - Value to compare against.
|
|
1850
|
+
*/
|
|
1851
|
+
eq: (propertyName: 'scheduleId' | 'externalScheduleId' | 'type' | 'recurringEventId' | 'transparency' | 'location.id' | 'location.type' | 'totalCapacity' | 'remainingCapacity' | 'participants.total' | 'appId', value: any) => EventsQueryBuilder;
|
|
1852
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1853
|
+
* @param value - Value to compare against.
|
|
1854
|
+
*/
|
|
1855
|
+
ne: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
|
|
1856
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1857
|
+
* @param value - Value to compare against.
|
|
1858
|
+
*/
|
|
1859
|
+
ge: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
|
|
1860
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1861
|
+
* @param value - Value to compare against.
|
|
1862
|
+
*/
|
|
1863
|
+
gt: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
|
|
1864
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1865
|
+
* @param value - Value to compare against.
|
|
1866
|
+
*/
|
|
1867
|
+
le: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
|
|
1868
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1869
|
+
* @param value - Value to compare against.
|
|
1870
|
+
*/
|
|
1871
|
+
lt: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
|
|
1872
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1873
|
+
* @param values - List of values to compare against.
|
|
1874
|
+
*/
|
|
1875
|
+
hasSome: (propertyName: string, value: any[]) => EventsQueryBuilder;
|
|
1876
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1877
|
+
* @param values - List of values to compare against.
|
|
1878
|
+
*/
|
|
1879
|
+
hasAll: (propertyName: string, value: any[]) => EventsQueryBuilder;
|
|
1880
|
+
in: (propertyName: 'scheduleId' | 'externalScheduleId' | 'type' | 'recurringEventId' | 'location.id' | 'location.type' | 'appId', value: any) => EventsQueryBuilder;
|
|
1881
|
+
exists: (propertyName: 'location' | 'totalCapacity' | 'conferencingDetails', value: boolean) => EventsQueryBuilder;
|
|
1882
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1883
|
+
limit: (limit: number) => EventsQueryBuilder;
|
|
1884
|
+
/** @param cursor - A pointer to specific record */
|
|
1885
|
+
skipTo: (cursor: string) => EventsQueryBuilder;
|
|
1886
|
+
find: () => Promise<EventsQueryResult>;
|
|
1887
|
+
}
|
|
1888
|
+
interface CreateEventOptions {
|
|
1420
1889
|
/**
|
|
1421
|
-
*
|
|
1422
|
-
*
|
|
1423
|
-
*
|
|
1424
|
-
* for more information.
|
|
1425
|
-
*
|
|
1426
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
1890
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1891
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1892
|
+
* `America/New_York` or `UTC`.
|
|
1427
1893
|
*
|
|
1428
|
-
*
|
|
1429
|
-
* specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
|
|
1430
|
-
* filters, refer to the supported filters article
|
|
1431
|
-
* ([REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting)).
|
|
1894
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1432
1895
|
*/
|
|
1433
|
-
|
|
1896
|
+
timeZone?: string | null;
|
|
1434
1897
|
/**
|
|
1435
|
-
*
|
|
1436
|
-
*
|
|
1437
|
-
* @
|
|
1898
|
+
* Idempotency key guaranteeing that you don't create the same event more
|
|
1899
|
+
* than once.
|
|
1900
|
+
* @format GUID
|
|
1438
1901
|
*/
|
|
1439
|
-
|
|
1440
|
-
}
|
|
1441
|
-
/** @oneof */
|
|
1442
|
-
export interface CursorQueryPagingMethodOneOf {
|
|
1443
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1444
|
-
cursorPaging?: CursorPaging;
|
|
1902
|
+
idempotencyKey?: string | null;
|
|
1445
1903
|
}
|
|
1446
|
-
|
|
1447
|
-
export interface Sorting {
|
|
1904
|
+
interface BulkCreateEventOptions {
|
|
1448
1905
|
/**
|
|
1449
|
-
*
|
|
1450
|
-
*
|
|
1451
|
-
* Default
|
|
1906
|
+
* Whether to return created events.
|
|
1907
|
+
*
|
|
1908
|
+
* Default: `false`.
|
|
1452
1909
|
*/
|
|
1453
|
-
|
|
1454
|
-
/**
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1910
|
+
returnEntity?: boolean | null;
|
|
1911
|
+
/**
|
|
1912
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1913
|
+
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1914
|
+
* `America/New_York` or `UTC`.
|
|
1915
|
+
*
|
|
1916
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1917
|
+
*/
|
|
1918
|
+
timeZone?: string | null;
|
|
1460
1919
|
}
|
|
1461
|
-
|
|
1462
|
-
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1463
|
-
/** TODO Diverge */
|
|
1464
|
-
export interface CursorPaging {
|
|
1920
|
+
interface UpdateEvent {
|
|
1465
1921
|
/**
|
|
1466
|
-
*
|
|
1467
|
-
*
|
|
1468
|
-
* @
|
|
1469
|
-
* @
|
|
1922
|
+
* Event ID.
|
|
1923
|
+
* @minLength 36
|
|
1924
|
+
* @maxLength 250
|
|
1925
|
+
* @readonly
|
|
1470
1926
|
*/
|
|
1471
|
-
|
|
1927
|
+
_id?: string | null;
|
|
1472
1928
|
/**
|
|
1473
|
-
*
|
|
1929
|
+
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
1930
|
+
* the event belongs to.
|
|
1931
|
+
* After creating an event, you can't assign it to a different schedule.
|
|
1932
|
+
* @format GUID
|
|
1933
|
+
* @immutable
|
|
1934
|
+
*/
|
|
1935
|
+
scheduleId?: string | null;
|
|
1936
|
+
/**
|
|
1937
|
+
* ID of the external schedule the event belongs to.
|
|
1474
1938
|
*
|
|
1475
|
-
*
|
|
1476
|
-
*
|
|
1477
|
-
*
|
|
1939
|
+
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
1940
|
+
* @format GUID
|
|
1941
|
+
* @readonly
|
|
1478
1942
|
*/
|
|
1479
|
-
|
|
1480
|
-
}
|
|
1481
|
-
export interface QueryEventsResponse {
|
|
1482
|
-
/** Retrieved events matching the provided query. */
|
|
1483
|
-
events?: Event[];
|
|
1484
|
-
/** Paging metadata. */
|
|
1485
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1486
|
-
}
|
|
1487
|
-
/** TODO Diverge */
|
|
1488
|
-
export interface CursorPagingMetadata {
|
|
1489
|
-
/** Number of items returned in the response. */
|
|
1490
|
-
count?: number | null;
|
|
1491
|
-
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
1492
|
-
cursors?: Cursors;
|
|
1943
|
+
externalScheduleId?: string | null;
|
|
1493
1944
|
/**
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1496
|
-
* If `false`, this is the last page.
|
|
1945
|
+
* Schedule name.
|
|
1946
|
+
* @readonly
|
|
1497
1947
|
*/
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1948
|
+
scheduleName?: string | null;
|
|
1949
|
+
/**
|
|
1950
|
+
* Event type. You can set the event type but you can't update it.
|
|
1951
|
+
*
|
|
1952
|
+
* Supported values:
|
|
1953
|
+
* + `DEFAULT`: A standard event that's not further specified.
|
|
1954
|
+
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
|
|
1955
|
+
*
|
|
1956
|
+
* Additional supported values, if Wix Bookings is installed:
|
|
1957
|
+
* + `APPOINTMENT`: Bookings appointment event.
|
|
1958
|
+
* + `CLASS`: Bookings class event.
|
|
1959
|
+
* + `COURSE`: Bookings course event.
|
|
1960
|
+
* @immutable
|
|
1961
|
+
*/
|
|
1962
|
+
type?: string | null;
|
|
1963
|
+
/**
|
|
1964
|
+
* Event status.
|
|
1965
|
+
*
|
|
1966
|
+
* Supported values:
|
|
1967
|
+
* + `CONFIRMED`: Event is scheduled to happen or has happened.
|
|
1968
|
+
* + `CANCELLED`: Event has been canceled.
|
|
1969
|
+
*
|
|
1970
|
+
* Default: `CONFIRMED`
|
|
1971
|
+
* @readonly
|
|
1972
|
+
*/
|
|
1973
|
+
status?: StatusWithLiterals;
|
|
1974
|
+
/**
|
|
1975
|
+
* Event title.
|
|
1976
|
+
*
|
|
1977
|
+
* Min: 1 character
|
|
1978
|
+
* Max: 200 characters
|
|
1979
|
+
* @minLength 1
|
|
1980
|
+
* @maxLength 200
|
|
1981
|
+
*/
|
|
1982
|
+
title?: string | null;
|
|
1983
|
+
/** Information about when the event starts. */
|
|
1984
|
+
start?: ZonedDate;
|
|
1985
|
+
/**
|
|
1986
|
+
* Information about when the event ends.
|
|
1987
|
+
*
|
|
1988
|
+
* Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
|
|
1989
|
+
*/
|
|
1990
|
+
end?: ZonedDate;
|
|
1991
|
+
/**
|
|
1992
|
+
* Information about when the event starts adjusted to the `timeZone` of the
|
|
1993
|
+
* business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
1994
|
+
* or a different `timeZone` you provide in the call's request.
|
|
1995
|
+
* @readonly
|
|
1996
|
+
*/
|
|
1997
|
+
adjustedStart?: ZonedDate;
|
|
1998
|
+
/**
|
|
1999
|
+
* Information about when the event ends adjusted to the `timeZone` of the
|
|
2000
|
+
* business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
2001
|
+
* or a different `timeZone` you provide in the call's request.
|
|
2002
|
+
* @readonly
|
|
2003
|
+
*/
|
|
2004
|
+
adjustedEnd?: ZonedDate;
|
|
2005
|
+
/**
|
|
2006
|
+
* Time zone the event is associated with in
|
|
2007
|
+
* [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
2008
|
+
* Only regional time zones and UTC are supported.
|
|
2009
|
+
* For example, `America/New_York` or `UTC`.
|
|
2010
|
+
*
|
|
2011
|
+
* Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
|
|
2012
|
+
*/
|
|
2013
|
+
timeZone?: string | null;
|
|
2014
|
+
/**
|
|
2015
|
+
* Information about whether the event is a single occurrence or part of a
|
|
2016
|
+
* recurring series.
|
|
2017
|
+
*
|
|
2018
|
+
* Supported values:
|
|
2019
|
+
* + `NONE`: The event occurs only once and doesn't repeat.
|
|
2020
|
+
* + `MASTER`: Defines the recurrence pattern for a series of recurring events.
|
|
2021
|
+
* + `INSTANCE`: 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`.
|
|
2022
|
+
* + `EXCEPTION`: 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.
|
|
2023
|
+
*
|
|
2024
|
+
* Default: `NONE`
|
|
2025
|
+
* @readonly
|
|
2026
|
+
*/
|
|
2027
|
+
recurrenceType?: RecurrenceTypeWithLiterals;
|
|
2028
|
+
/**
|
|
2029
|
+
* Recurrence pattern for a series of events. This field is required when
|
|
2030
|
+
* creating a `MASTER` event and isn't available for non-recurring events.
|
|
2031
|
+
* You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
|
|
2032
|
+
*
|
|
2033
|
+
* For example, an event that repeats every second Monday until January 7, 2026,
|
|
2034
|
+
* at 8:00 AM has the following `recurrenceRule`:
|
|
2035
|
+
* - `frequency = WEEKLY`
|
|
2036
|
+
* - `interval = 2`
|
|
2037
|
+
* - `days = [MONDAY]`
|
|
2038
|
+
* - `until = 20260107T08:00:00Z`
|
|
2039
|
+
*/
|
|
2040
|
+
recurrenceRule?: RecurrenceRule;
|
|
1505
2041
|
/**
|
|
1506
|
-
*
|
|
1507
|
-
*
|
|
2042
|
+
* ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
|
|
2043
|
+
* and `EXCEPTION` events.
|
|
1508
2044
|
* @minLength 64
|
|
1509
2045
|
* @maxLength 64
|
|
2046
|
+
* @readonly
|
|
1510
2047
|
*/
|
|
1511
2048
|
recurringEventId?: string | null;
|
|
1512
2049
|
/**
|
|
1513
|
-
*
|
|
1514
|
-
*
|
|
2050
|
+
* Specifies whether the event blocks time in the schedule it belongs to.
|
|
2051
|
+
*
|
|
2052
|
+
* Supported values:
|
|
2053
|
+
* + `OPAQUE`: 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.
|
|
2054
|
+
* + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
|
|
2055
|
+
*
|
|
2056
|
+
* Default: `OPAQUE`
|
|
1515
2057
|
*/
|
|
1516
|
-
|
|
2058
|
+
transparency?: TransparencyWithLiterals;
|
|
1517
2059
|
/**
|
|
1518
|
-
*
|
|
1519
|
-
*
|
|
1520
|
-
*
|
|
2060
|
+
* Event location.
|
|
2061
|
+
*
|
|
2062
|
+
* Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
|
|
1521
2063
|
*/
|
|
1522
|
-
|
|
2064
|
+
location?: Location;
|
|
1523
2065
|
/**
|
|
1524
|
-
*
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
2066
|
+
* List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
|
|
2067
|
+
* affected by the event. This could include, for example, the
|
|
2068
|
+
* [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
|
|
2069
|
+
* providing the service or the room where the appointment takes place.
|
|
2070
|
+
*
|
|
2071
|
+
* Max: 100 resources
|
|
2072
|
+
* @maxSize 100
|
|
1527
2073
|
*/
|
|
1528
|
-
|
|
1529
|
-
/** Optional cursor pointing to the next page of events. */
|
|
1530
|
-
cursorPaging?: CursorPaging;
|
|
1531
|
-
}
|
|
1532
|
-
export interface ListRecurringEventInstancesHistoryResponse {
|
|
1533
|
-
/** The recurring event instances. */
|
|
1534
|
-
recurringEventInstances?: Event[];
|
|
1535
|
-
/** Paging metadata. */
|
|
1536
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1537
|
-
}
|
|
1538
|
-
export interface CreateEventRequest {
|
|
1539
|
-
/** Event to create. */
|
|
1540
|
-
event: Event;
|
|
2074
|
+
resources?: Resource[];
|
|
1541
2075
|
/**
|
|
1542
|
-
*
|
|
1543
|
-
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1544
|
-
* `America/New_York` or `UTC`.
|
|
2076
|
+
* Maximum number of participants who can participate in the event.
|
|
1545
2077
|
*
|
|
1546
|
-
* Default: `
|
|
2078
|
+
* Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
|
|
1547
2079
|
*/
|
|
1548
|
-
|
|
2080
|
+
totalCapacity?: number | null;
|
|
1549
2081
|
/**
|
|
1550
|
-
*
|
|
1551
|
-
*
|
|
1552
|
-
* @format GUID
|
|
2082
|
+
* Number of participants who can still be added to the event.
|
|
2083
|
+
* @readonly
|
|
1553
2084
|
*/
|
|
1554
|
-
|
|
1555
|
-
}
|
|
1556
|
-
export interface CreateEventResponse {
|
|
1557
|
-
/** Created event. */
|
|
1558
|
-
event?: Event;
|
|
1559
|
-
}
|
|
1560
|
-
export interface BulkCreateEventRequest {
|
|
2085
|
+
remainingCapacity?: number | null;
|
|
1561
2086
|
/**
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
1564
|
-
* @
|
|
2087
|
+
* Information about the event's participants.
|
|
2088
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
2089
|
+
* @readonly
|
|
1565
2090
|
*/
|
|
1566
|
-
|
|
2091
|
+
participants?: Participants;
|
|
1567
2092
|
/**
|
|
1568
|
-
*
|
|
2093
|
+
* Information about the event's online conferencing.
|
|
2094
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
1569
2095
|
*
|
|
1570
|
-
* Default: `
|
|
2096
|
+
* Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
|
|
1571
2097
|
*/
|
|
1572
|
-
|
|
2098
|
+
conferencingDetails?: ConferencingDetails;
|
|
1573
2099
|
/**
|
|
1574
|
-
*
|
|
1575
|
-
*
|
|
1576
|
-
* `America/New_York` or `UTC`.
|
|
2100
|
+
* Additional notes about the event.
|
|
2101
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
1577
2102
|
*
|
|
1578
|
-
*
|
|
2103
|
+
* Min: 1 character
|
|
2104
|
+
* Max: 5000 characters
|
|
2105
|
+
* @minLength 1
|
|
2106
|
+
* @maxLength 5000
|
|
1579
2107
|
*/
|
|
1580
|
-
|
|
1581
|
-
}
|
|
1582
|
-
export interface MaskedEvent {
|
|
1583
|
-
/** Event to create. */
|
|
1584
|
-
event?: Event;
|
|
1585
|
-
}
|
|
1586
|
-
export interface BulkCreateEventResponse {
|
|
1587
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1588
|
-
results?: BulkEventResult[];
|
|
1589
|
-
/** Total successes and failures. */
|
|
1590
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1591
|
-
}
|
|
1592
|
-
export interface BulkEventResult {
|
|
1593
|
-
/** Whether the requested action was successful. */
|
|
1594
|
-
itemMetadata?: ItemMetadata;
|
|
1595
|
-
/** The event. */
|
|
1596
|
-
item?: Event;
|
|
1597
|
-
}
|
|
1598
|
-
export interface ItemMetadata {
|
|
2108
|
+
notes?: string | null;
|
|
1599
2109
|
/**
|
|
1600
|
-
*
|
|
1601
|
-
*
|
|
2110
|
+
* List of fields whose values are inherited.
|
|
2111
|
+
* + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
|
|
2112
|
+
* + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
|
|
2113
|
+
* @readonly
|
|
1602
2114
|
*/
|
|
1603
|
-
|
|
1604
|
-
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1605
|
-
originalIndex?: number;
|
|
2115
|
+
inheritedFields?: FieldWithLiterals[];
|
|
1606
2116
|
/**
|
|
1607
|
-
*
|
|
1608
|
-
*
|
|
2117
|
+
* ID of the app that owns the event. Identical to `appId` of the
|
|
2118
|
+
* [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
2119
|
+
* to which the event belongs.
|
|
2120
|
+
* @format GUID
|
|
2121
|
+
* @readonly
|
|
1609
2122
|
*/
|
|
1610
|
-
|
|
1611
|
-
/**
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
2123
|
+
appId?: string | null;
|
|
2124
|
+
/**
|
|
2125
|
+
* List of permissions associated with the event. Refer to the
|
|
2126
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
|
|
2127
|
+
* for more information.
|
|
2128
|
+
* @readonly
|
|
2129
|
+
*/
|
|
2130
|
+
permissions?: Permission[];
|
|
2131
|
+
/** Extensions enabling applications or users to save custom data related to the event. */
|
|
2132
|
+
extendedFields?: ExtendedFields;
|
|
2133
|
+
/**
|
|
2134
|
+
* Revision number, which increments each time the event is updated.
|
|
2135
|
+
* To prevent conflicting changes, the current revision must be passed when updating the event.
|
|
2136
|
+
* Ignored when creating an event.
|
|
2137
|
+
* @readonly
|
|
2138
|
+
*/
|
|
2139
|
+
revision?: string | null;
|
|
2140
|
+
/**
|
|
2141
|
+
* Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
2142
|
+
* @readonly
|
|
2143
|
+
*/
|
|
2144
|
+
_createdDate?: Date | null;
|
|
2145
|
+
/**
|
|
2146
|
+
* Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
2147
|
+
* @readonly
|
|
2148
|
+
*/
|
|
2149
|
+
_updatedDate?: Date | null;
|
|
1627
2150
|
}
|
|
1628
|
-
|
|
1629
|
-
/** Event to update. */
|
|
1630
|
-
event: Event;
|
|
2151
|
+
interface UpdateEventOptions {
|
|
1631
2152
|
/**
|
|
1632
2153
|
* Information about whether participants of the updated event are notified and
|
|
1633
2154
|
* the message they receive.
|
|
@@ -1638,24 +2159,11 @@ export interface UpdateEventRequest {
|
|
|
1638
2159
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1639
2160
|
* `America/New_York` or `UTC`.
|
|
1640
2161
|
*
|
|
1641
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
2162
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1642
2163
|
*/
|
|
1643
2164
|
timeZone?: string | null;
|
|
1644
2165
|
}
|
|
1645
|
-
|
|
1646
|
-
/** Updated event. */
|
|
1647
|
-
event?: Event;
|
|
1648
|
-
}
|
|
1649
|
-
export interface BulkUpdateEventRequest {
|
|
1650
|
-
/**
|
|
1651
|
-
* Events to update.
|
|
1652
|
-
*
|
|
1653
|
-
* Min: 1 event
|
|
1654
|
-
* Max: 50 events
|
|
1655
|
-
* @minSize 1
|
|
1656
|
-
* @maxSize 50
|
|
1657
|
-
*/
|
|
1658
|
-
events: BulkUpdateEventRequestMaskedEvent[];
|
|
2166
|
+
interface BulkUpdateEventOptions {
|
|
1659
2167
|
/**
|
|
1660
2168
|
* Whether to return the updated events.
|
|
1661
2169
|
*
|
|
@@ -1672,53 +2180,11 @@ export interface BulkUpdateEventRequest {
|
|
|
1672
2180
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1673
2181
|
* `America/New_York` or `UTC`.
|
|
1674
2182
|
*
|
|
1675
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
2183
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1676
2184
|
*/
|
|
1677
2185
|
timeZone?: string | null;
|
|
1678
2186
|
}
|
|
1679
|
-
|
|
1680
|
-
/** Event to update. */
|
|
1681
|
-
event?: Event;
|
|
1682
|
-
}
|
|
1683
|
-
export interface BulkUpdateEventResponse {
|
|
1684
|
-
/** The result for each event, containing the event and whether the action was successful. */
|
|
1685
|
-
results?: BulkEventResult[];
|
|
1686
|
-
/** Total successes and failures. */
|
|
1687
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1688
|
-
}
|
|
1689
|
-
export interface UpdateEventParticipantsRequest {
|
|
1690
|
-
/**
|
|
1691
|
-
* ID of the event to update.
|
|
1692
|
-
*
|
|
1693
|
-
* Min: 36 characters
|
|
1694
|
-
* Max: 250 characters
|
|
1695
|
-
* @minLength 36
|
|
1696
|
-
* @maxLength 250
|
|
1697
|
-
*/
|
|
1698
|
-
eventId?: string | null;
|
|
1699
|
-
/** The participants to update. */
|
|
1700
|
-
participants?: Participants;
|
|
1701
|
-
}
|
|
1702
|
-
export interface UpdateEventParticipantsResponse {
|
|
1703
|
-
/** Updated event. */
|
|
1704
|
-
event?: Event;
|
|
1705
|
-
}
|
|
1706
|
-
export interface RestoreEventDefaultsRequest {
|
|
1707
|
-
/**
|
|
1708
|
-
* ID of the event for which to restore default values.
|
|
1709
|
-
* @minLength 36
|
|
1710
|
-
* @maxLength 250
|
|
1711
|
-
*/
|
|
1712
|
-
eventId: string | null;
|
|
1713
|
-
/**
|
|
1714
|
-
* Fields for which to restore default values.
|
|
1715
|
-
*
|
|
1716
|
-
* `TIME` restores default values for `start` and `end`.
|
|
1717
|
-
*
|
|
1718
|
-
* Min: 1 field
|
|
1719
|
-
* @minSize 1
|
|
1720
|
-
*/
|
|
1721
|
-
fields: FieldWithLiterals[];
|
|
2187
|
+
interface RestoreEventDefaultsOptions {
|
|
1722
2188
|
/**
|
|
1723
2189
|
* Information about whether participants of the updated event are notified and
|
|
1724
2190
|
* the message they receive.
|
|
@@ -1729,54 +2195,21 @@ export interface RestoreEventDefaultsRequest {
|
|
|
1729
2195
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1730
2196
|
* `America/New_York` or `UTC`.
|
|
1731
2197
|
*
|
|
1732
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
2198
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1733
2199
|
*/
|
|
1734
2200
|
timeZone?: string | null;
|
|
1735
2201
|
}
|
|
1736
|
-
|
|
1737
|
-
/** Updated event. */
|
|
1738
|
-
event?: Event;
|
|
1739
|
-
}
|
|
1740
|
-
export interface SplitRecurringEventRequest {
|
|
1741
|
-
/**
|
|
1742
|
-
* ID of the `MASTER` event to split.
|
|
1743
|
-
* @minLength 36
|
|
1744
|
-
* @maxLength 250
|
|
1745
|
-
*/
|
|
1746
|
-
recurringEventId: string | null;
|
|
1747
|
-
/**
|
|
1748
|
-
* Local date and time at which the `MASTER` event is split in
|
|
1749
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
1750
|
-
* `2025-03-11T09:00:00`.
|
|
1751
|
-
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
1752
|
-
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
1753
|
-
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
1754
|
-
* wouldn't affect any event without a subsequent occurrence.
|
|
1755
|
-
* @format LOCAL_DATE_TIME
|
|
1756
|
-
*/
|
|
1757
|
-
splitLocalDate: string | null;
|
|
2202
|
+
interface SplitRecurringEventOptions {
|
|
1758
2203
|
/**
|
|
1759
2204
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
1760
2205
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1761
2206
|
* `America/New_York` or `UTC`.
|
|
1762
2207
|
*
|
|
1763
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
2208
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1764
2209
|
*/
|
|
1765
2210
|
timeZone?: string | null;
|
|
1766
2211
|
}
|
|
1767
|
-
|
|
1768
|
-
/** Original `MASTER` event that was shortened. */
|
|
1769
|
-
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1770
|
-
/** New `MASTER` event starting with the first event after the split date. */
|
|
1771
|
-
newRecurringEventStartingFromSplit?: Event;
|
|
1772
|
-
}
|
|
1773
|
-
export interface CancelEventRequest {
|
|
1774
|
-
/**
|
|
1775
|
-
* ID of the event to cancel.
|
|
1776
|
-
* @minLength 36
|
|
1777
|
-
* @maxLength 250
|
|
1778
|
-
*/
|
|
1779
|
-
eventId: string | null;
|
|
2212
|
+
interface CancelEventOptions {
|
|
1780
2213
|
/**
|
|
1781
2214
|
* Information about whether participants of the canceled event are notified and
|
|
1782
2215
|
* the message they receive.
|
|
@@ -1787,21 +2220,11 @@ export interface CancelEventRequest {
|
|
|
1787
2220
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1788
2221
|
* `America/New_York` or `UTC`.
|
|
1789
2222
|
*
|
|
1790
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
2223
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1791
2224
|
*/
|
|
1792
2225
|
timeZone?: string | null;
|
|
1793
2226
|
}
|
|
1794
|
-
|
|
1795
|
-
/** Canceled event. */
|
|
1796
|
-
event?: Event;
|
|
1797
|
-
}
|
|
1798
|
-
export interface BulkCancelEventRequest {
|
|
1799
|
-
/**
|
|
1800
|
-
* IDs of the events to cancel.
|
|
1801
|
-
* @minSize 1
|
|
1802
|
-
* @maxSize 50
|
|
1803
|
-
*/
|
|
1804
|
-
eventIds: string[];
|
|
2227
|
+
interface BulkCancelEventOptions {
|
|
1805
2228
|
/**
|
|
1806
2229
|
* Whether to return the canceled events.
|
|
1807
2230
|
*
|
|
@@ -1818,13 +2241,9 @@ export interface BulkCancelEventRequest {
|
|
|
1818
2241
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
1819
2242
|
* `America/New_York` or `UTC`.
|
|
1820
2243
|
*
|
|
1821
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
2244
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
1822
2245
|
*/
|
|
1823
2246
|
timeZone?: string | null;
|
|
1824
2247
|
}
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
results?: BulkEventResult[];
|
|
1828
|
-
/** Total successes and failures. */
|
|
1829
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
1830
|
-
}
|
|
2248
|
+
|
|
2249
|
+
export { type CommonIdentificationData as $, PlacementType as A, type BulkCreateEventOptions as B, type CreateEventOptions as C, Day as D, type Event as E, type FieldWithLiterals as F, type GetEventOptions as G, DayOfWeek as H, IdentityType as I, ResolutionMethod as J, type RecurrenceRule as K, type ListEventsOptions as L, type MaskedEvent as M, type Location as N, type Resource as O, ParticipantsStatus as P, type QueryEventsOptions as Q, type RestoreEventDefaultsOptions as R, type SplitRecurringEventOptions as S, Transparency as T, type UpdateEvent as U, type Participants as V, WebhookIdentityType as W, type Participant as X, type ConferencingDetails as Y, type ZonedDate as Z, type Permission as _, type ListEventsResponse as a, type Translation as a$, type CommonIdentificationDataIdOneOf as a0, type ExtendedFields as a1, type RecurringEventSplit as a2, type EventCancelled as a3, type ParticipantNotification as a4, type EventUpdatedWithMetadata as a5, type UpdateScheduleWithFixedBusinessResourceIdRequest as a6, type UpdateScheduleWithFixedBusinessResourceIdResponse as a7, type UpdateEventsWithFixedBusinessResourceIdRequest as a8, type UpdateEventsWithFixedBusinessResourceIdResponse as a9, type BulkEventResult as aA, type ItemMetadata as aB, type ApplicationError as aC, type BulkActionMetadata as aD, type UpdateEventRequest as aE, type UpdateEventResponse as aF, type BulkUpdateEventRequest as aG, type UpdateEventParticipantsRequest as aH, type UpdateEventParticipantsResponse as aI, type RestoreEventDefaultsRequest as aJ, type SplitRecurringEventRequest as aK, type CancelEventRequest as aL, type BulkCancelEventRequest as aM, type SitePropertiesNotification as aN, type SitePropertiesEvent as aO, type Properties as aP, type Categories as aQ, type Locale as aR, type Address as aS, type AddressHint as aT, type GeoCoordinates as aU, type BusinessSchedule as aV, type TimePeriod as aW, type SpecialHourPeriod as aX, type Multilingual as aY, type SupportedLanguage as aZ, type ConsentPolicy as a_, type DomainEvent as aa, type DomainEventBodyOneOf as ab, type EntityCreatedEvent as ac, type RestoreInfo as ad, type EntityUpdatedEvent as ae, type EntityDeletedEvent as af, type ActionEvent as ag, type MessageEnvelope as ah, type IdentificationData as ai, type IdentificationDataIdOneOf as aj, type GetEventRequest as ak, type GetEventResponse as al, type ListEventsRequest as am, type QueryEventsRequest as an, type CursorQuery as ao, type CursorQueryPagingMethodOneOf as ap, type Sorting as aq, type CursorPaging as ar, type QueryEventsResponse as as, type CursorPagingMetadata as at, type Cursors as au, type ListRecurringEventInstancesHistoryRequest as av, type ListRecurringEventInstancesHistoryResponse as aw, type CreateEventRequest as ax, type CreateEventResponse as ay, type BulkCreateEventRequest as az, type EventsQueryBuilder as b, type ChangeContext as b0, type ChangeContextPayloadOneOf as b1, type PropertiesChange as b2, type SiteCreated as b3, type SiteCloned as b4, type Empty as b5, type BaseEventMetadata as b6, type EventMetadata as b7, type EventsQueryResult as b8, type BulkCreateEventResponse as c, type UpdateEventOptions as d, type BulkUpdateEventRequestMaskedEvent as e, type BulkUpdateEventOptions as f, type BulkUpdateEventResponse as g, type RestoreEventDefaultsResponse as h, type SplitRecurringEventResponse as i, type CancelEventOptions as j, type CancelEventResponse as k, type BulkCancelEventOptions as l, type BulkCancelEventResponse as m, type EventCancelledEnvelope as n, type EventCreatedEnvelope as o, type EventRecurringSplitEnvelope as p, type EventUpdatedEnvelope as q, Status as r, RecurrenceType as s, Frequency as t, LocationType as u, Role as v, Type as w, Field as x, RequestedFields as y, SortOrder as z };
|