@wix/calendar 1.0.0 → 1.0.2
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/context.d.ts +2 -0
- package/build/cjs/context.js +3 -1
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +2 -0
- package/build/cjs/index.js +3 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -0
- package/build/cjs/meta.js +3 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +2 -0
- package/build/es/context.js +2 -0
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +2 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +2 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -1
- package/package.json +5 -3
- package/type-bundles/context.bundle.d.ts +3394 -799
- package/type-bundles/index.bundle.d.ts +3388 -837
- package/type-bundles/meta.bundle.d.ts +2380 -206
|
@@ -1,3 +1,2070 @@
|
|
|
1
|
+
interface Event$1 {
|
|
2
|
+
/**
|
|
3
|
+
* The event ID.
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
id?: string | null;
|
|
7
|
+
/**
|
|
8
|
+
* The ID of the schedule that the event belongs to.
|
|
9
|
+
* Cannot change.
|
|
10
|
+
*/
|
|
11
|
+
scheduleId?: string | null;
|
|
12
|
+
/**
|
|
13
|
+
* The external schedule ID.
|
|
14
|
+
* @readonly
|
|
15
|
+
*/
|
|
16
|
+
externalScheduleId?: string | null;
|
|
17
|
+
/**
|
|
18
|
+
* The schedule name.
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
scheduleName?: string | null;
|
|
22
|
+
/**
|
|
23
|
+
* The event type.
|
|
24
|
+
* Cannot change.
|
|
25
|
+
*
|
|
26
|
+
* The possible values are:
|
|
27
|
+
* - `"DEFAULT"` Default event.
|
|
28
|
+
* - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
|
|
29
|
+
*
|
|
30
|
+
* The Wix Bookings App, once installed, also provides the following:
|
|
31
|
+
* - `"APPOINTMENT"` Bookings Appointment event.
|
|
32
|
+
* - `"CLASS"` Bookings Class event.
|
|
33
|
+
* - `"COURSE"` Bookings Course event.
|
|
34
|
+
*
|
|
35
|
+
* See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
|
|
36
|
+
*/
|
|
37
|
+
type?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* The event status. Read only.
|
|
40
|
+
*
|
|
41
|
+
* The possible values are:
|
|
42
|
+
* - `"CONFIRMED"` Event is confirmed. Default value.
|
|
43
|
+
* - `"CANCELLED"` Event has been cancelled.
|
|
44
|
+
* @readonly
|
|
45
|
+
*/
|
|
46
|
+
status?: Status$5;
|
|
47
|
+
/**
|
|
48
|
+
* The event title.
|
|
49
|
+
*
|
|
50
|
+
* The title is inherited from the schedule and can be overridden.
|
|
51
|
+
*/
|
|
52
|
+
title?: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* The event start date.
|
|
55
|
+
*
|
|
56
|
+
* Recurring events must start from at least today.
|
|
57
|
+
*/
|
|
58
|
+
start?: ZonedDate$3;
|
|
59
|
+
/** The event end date. */
|
|
60
|
+
end?: ZonedDate$3;
|
|
61
|
+
/**
|
|
62
|
+
* Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
adjustedStart?: ZonedDate$3;
|
|
66
|
+
/**
|
|
67
|
+
* Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
68
|
+
* @readonly
|
|
69
|
+
*/
|
|
70
|
+
adjustedEnd?: ZonedDate$3;
|
|
71
|
+
/**
|
|
72
|
+
* The event time zone, formatted according to the IANA time zone format.
|
|
73
|
+
* Must be a regional time zone (Area/Location) or UTC.
|
|
74
|
+
*
|
|
75
|
+
* The time zone is inherited from the schedule and can be overridden.
|
|
76
|
+
*/
|
|
77
|
+
timeZone?: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* Whether this event is a recurring event or an instance of recurring event.
|
|
80
|
+
*
|
|
81
|
+
* The possible values are:
|
|
82
|
+
* - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
|
|
83
|
+
* - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
|
|
84
|
+
* - `"INSTANCE"` The event is an instance of a recurring event. Read only.
|
|
85
|
+
* - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
88
|
+
recurrenceType?: RecurrenceType$1;
|
|
89
|
+
/**
|
|
90
|
+
* The recurrence rule defining a repeating pattern for the event.
|
|
91
|
+
* Required for `MASTER` recurrence, read only otherwise.
|
|
92
|
+
*
|
|
93
|
+
* For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
|
|
94
|
+
* - `frequency = WEEKLY`
|
|
95
|
+
* - `interval = 2`
|
|
96
|
+
* - `days = [MONDAY]`
|
|
97
|
+
* - `until = 20240107T08:00:00Z`
|
|
98
|
+
*/
|
|
99
|
+
recurrenceRule?: RecurrenceRule$1;
|
|
100
|
+
/**
|
|
101
|
+
* The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
|
|
102
|
+
* @readonly
|
|
103
|
+
*/
|
|
104
|
+
recurringEventId?: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* Specifies whether the event blocks the schedule time.
|
|
107
|
+
* Default is true.
|
|
108
|
+
*/
|
|
109
|
+
transparency?: Transparency$1;
|
|
110
|
+
/**
|
|
111
|
+
* The event location.
|
|
112
|
+
*
|
|
113
|
+
* The location is inherited from the schedule and can be overridden.
|
|
114
|
+
*/
|
|
115
|
+
location?: Location$3;
|
|
116
|
+
/**
|
|
117
|
+
* List of resources affected by the event.
|
|
118
|
+
*
|
|
119
|
+
* For example:
|
|
120
|
+
* - Event occupying a resource time, such as a room, equipment or person.
|
|
121
|
+
* - The Bookings App Staff is affected by the Booking Class Sessions it provides.
|
|
122
|
+
*/
|
|
123
|
+
resources?: Resource$1[];
|
|
124
|
+
/**
|
|
125
|
+
* The event capacity, which is the max number of participants that can participate in the event.
|
|
126
|
+
*
|
|
127
|
+
* The total capacity is inherited from the schedule and can be overridden.
|
|
128
|
+
*/
|
|
129
|
+
totalCapacity?: number | null;
|
|
130
|
+
/**
|
|
131
|
+
* The remaining number of participants that can be added to the event.
|
|
132
|
+
* @readonly
|
|
133
|
+
*/
|
|
134
|
+
remainingCapacity?: number | null;
|
|
135
|
+
/**
|
|
136
|
+
* The event participants.
|
|
137
|
+
* @readonly
|
|
138
|
+
*/
|
|
139
|
+
participants?: Participants$1;
|
|
140
|
+
/**
|
|
141
|
+
* Online conferencing details.
|
|
142
|
+
*
|
|
143
|
+
* The conferencing details are inherited from the schedule and can be overridden.
|
|
144
|
+
*/
|
|
145
|
+
conferencingDetails?: ConferencingDetails$3;
|
|
146
|
+
/** Additional notes and information about the event. */
|
|
147
|
+
notes?: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* A list of fields for which values were inherited from the schedule or the recurring event,
|
|
150
|
+
* if this event is an instance of recurring event.
|
|
151
|
+
* @readonly
|
|
152
|
+
*/
|
|
153
|
+
inheritedFields?: Field$1[];
|
|
154
|
+
/**
|
|
155
|
+
* ID of the Wix app owning the event, as derived from the schedule.
|
|
156
|
+
* @readonly
|
|
157
|
+
*/
|
|
158
|
+
appId?: string | null;
|
|
159
|
+
/**
|
|
160
|
+
* List of granted permissions for this event.
|
|
161
|
+
*
|
|
162
|
+
* Derived from the schedule and the resources of the the event.
|
|
163
|
+
* @readonly
|
|
164
|
+
*/
|
|
165
|
+
permissions?: Permission$3[];
|
|
166
|
+
/** Extensions enabling applications or users to save custom data related to the event. */
|
|
167
|
+
extendedFields?: ExtendedFields$3;
|
|
168
|
+
/**
|
|
169
|
+
* The event revision number, which incremented on updates.
|
|
170
|
+
*
|
|
171
|
+
* The current revision should be provided on updates to prevent conflicting changes.
|
|
172
|
+
* @readonly
|
|
173
|
+
*/
|
|
174
|
+
revision?: string | null;
|
|
175
|
+
/**
|
|
176
|
+
* Date the event was created.
|
|
177
|
+
* @readonly
|
|
178
|
+
*/
|
|
179
|
+
createdDate?: Date;
|
|
180
|
+
/**
|
|
181
|
+
* Date the event was last updated.
|
|
182
|
+
* @readonly
|
|
183
|
+
*/
|
|
184
|
+
updatedDate?: Date;
|
|
185
|
+
}
|
|
186
|
+
declare enum Status$5 {
|
|
187
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
188
|
+
/** Event is confirmed. Default value. */
|
|
189
|
+
CONFIRMED = "CONFIRMED",
|
|
190
|
+
/** DEPRECATED! AND WILL BE REMOVED SOON */
|
|
191
|
+
PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
|
|
192
|
+
/** Event has been cancelled. */
|
|
193
|
+
CANCELLED = "CANCELLED"
|
|
194
|
+
}
|
|
195
|
+
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
196
|
+
interface ZonedDate$3 {
|
|
197
|
+
/**
|
|
198
|
+
* Local date time, in ISO-8601 format.
|
|
199
|
+
* E.g, "2024-01-30T13:30:00".
|
|
200
|
+
*
|
|
201
|
+
* Note: seconds are not supported and ignored.
|
|
202
|
+
*/
|
|
203
|
+
localDate?: string | null;
|
|
204
|
+
/**
|
|
205
|
+
* The event time zone.
|
|
206
|
+
* @readonly
|
|
207
|
+
*/
|
|
208
|
+
timeZone?: string | null;
|
|
209
|
+
/**
|
|
210
|
+
* The UTC date determined by the server.
|
|
211
|
+
* Not returned for adjusted dates.
|
|
212
|
+
* @readonly
|
|
213
|
+
*/
|
|
214
|
+
utcDate?: Date;
|
|
215
|
+
}
|
|
216
|
+
declare enum RecurrenceType$1 {
|
|
217
|
+
UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
|
|
218
|
+
/** No recurrence, i.e the event is a single event instance. Default. */
|
|
219
|
+
NONE = "NONE",
|
|
220
|
+
/** The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events. */
|
|
221
|
+
MASTER = "MASTER",
|
|
222
|
+
/** The event is an instance of a recurring event. Read only. */
|
|
223
|
+
INSTANCE = "INSTANCE",
|
|
224
|
+
/** The event is an exceptional instance of a recurring event. Read only. */
|
|
225
|
+
EXCEPTION = "EXCEPTION"
|
|
226
|
+
}
|
|
227
|
+
interface RecurrenceRule$1 {
|
|
228
|
+
/** The frequency with which the event should be repeated. */
|
|
229
|
+
frequency?: Frequency$1;
|
|
230
|
+
/**
|
|
231
|
+
* Works together with `frequency` to specify how often the event should be repeated. Default is `1`.
|
|
232
|
+
* For example, `WEEKLY` frequency and `interval` of `2` means once every two weeks.
|
|
233
|
+
*/
|
|
234
|
+
interval?: number | null;
|
|
235
|
+
/**
|
|
236
|
+
* The days of the week when the event should be repeated.
|
|
237
|
+
* Currently, only a single day is supported.
|
|
238
|
+
*/
|
|
239
|
+
days?: Day$1[];
|
|
240
|
+
/**
|
|
241
|
+
* The date until which the event should be repeated.
|
|
242
|
+
* When it is not specified, the event repeats forever.
|
|
243
|
+
*/
|
|
244
|
+
until?: ZonedDate$3;
|
|
245
|
+
/**
|
|
246
|
+
* Read-only until date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
247
|
+
* @readonly
|
|
248
|
+
*/
|
|
249
|
+
adjustedUntil?: ZonedDate$3;
|
|
250
|
+
}
|
|
251
|
+
declare enum Frequency$1 {
|
|
252
|
+
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
253
|
+
/** The event repeats every few weeks. */
|
|
254
|
+
WEEKLY = "WEEKLY"
|
|
255
|
+
}
|
|
256
|
+
declare enum Day$1 {
|
|
257
|
+
MONDAY = "MONDAY",
|
|
258
|
+
TUESDAY = "TUESDAY",
|
|
259
|
+
WEDNESDAY = "WEDNESDAY",
|
|
260
|
+
THURSDAY = "THURSDAY",
|
|
261
|
+
FRIDAY = "FRIDAY",
|
|
262
|
+
SATURDAY = "SATURDAY",
|
|
263
|
+
SUNDAY = "SUNDAY"
|
|
264
|
+
}
|
|
265
|
+
declare enum Transparency$1 {
|
|
266
|
+
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
267
|
+
/** The event block time. Default. */
|
|
268
|
+
OPAQUE = "OPAQUE",
|
|
269
|
+
/** The event does not block the time. */
|
|
270
|
+
TRANSPARENT = "TRANSPARENT"
|
|
271
|
+
}
|
|
272
|
+
interface Location$3 {
|
|
273
|
+
/**
|
|
274
|
+
* The location ID. Optional.
|
|
275
|
+
* Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
|
|
276
|
+
*/
|
|
277
|
+
id?: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* The location type.
|
|
280
|
+
* The possible values are:
|
|
281
|
+
* - `"BUSINESS"` event takes place at the business location.
|
|
282
|
+
* - `"CUSTOM"` event takes place at the custom location.
|
|
283
|
+
*/
|
|
284
|
+
type?: LocationType$3;
|
|
285
|
+
/**
|
|
286
|
+
* The location name. Optional.
|
|
287
|
+
* Derived from the Wix Business Location if the location is of type `BUSINESS`.
|
|
288
|
+
*/
|
|
289
|
+
name?: string | null;
|
|
290
|
+
/**
|
|
291
|
+
* The location address. Optional.
|
|
292
|
+
* Derived from the Wix Business Location if the location is of type `BUSINESS`.
|
|
293
|
+
*/
|
|
294
|
+
address?: string | null;
|
|
295
|
+
}
|
|
296
|
+
declare enum LocationType$3 {
|
|
297
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
298
|
+
/** The event takes place at the business location. */
|
|
299
|
+
BUSINESS = "BUSINESS",
|
|
300
|
+
/** The event takes place at the customer location. */
|
|
301
|
+
CUSTOMER = "CUSTOMER",
|
|
302
|
+
/** The event takes place at the custom location. */
|
|
303
|
+
CUSTOM = "CUSTOM"
|
|
304
|
+
}
|
|
305
|
+
interface Resource$1 {
|
|
306
|
+
/** The resource ID. */
|
|
307
|
+
id?: string | null;
|
|
308
|
+
/**
|
|
309
|
+
* The resource name.
|
|
310
|
+
* @readonly
|
|
311
|
+
*/
|
|
312
|
+
name?: string | null;
|
|
313
|
+
/**
|
|
314
|
+
* The resource type.
|
|
315
|
+
* @readonly
|
|
316
|
+
*/
|
|
317
|
+
type?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* Specifies whether the event blocks the resource time.
|
|
320
|
+
* Default is `OPAQUE`.
|
|
321
|
+
*/
|
|
322
|
+
transparency?: Transparency$1;
|
|
323
|
+
/** Optional permission role to grant the identities associated with the resource. */
|
|
324
|
+
permissionRole?: Role$3;
|
|
325
|
+
}
|
|
326
|
+
declare enum Role$3 {
|
|
327
|
+
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
328
|
+
/** Role grants full write and read access. */
|
|
329
|
+
WRITER = "WRITER",
|
|
330
|
+
/** Role grants full read access and permission to edit notes. */
|
|
331
|
+
COMMENTER = "COMMENTER"
|
|
332
|
+
}
|
|
333
|
+
interface Participants$1 {
|
|
334
|
+
/** The total number of participants. */
|
|
335
|
+
total?: number | null;
|
|
336
|
+
/** A full or partial list of the participants. */
|
|
337
|
+
list?: Participant$1[];
|
|
338
|
+
/** Whether there are more participants for the event which were not listed. */
|
|
339
|
+
hasMore?: boolean | null;
|
|
340
|
+
/**
|
|
341
|
+
* The participants status.
|
|
342
|
+
*
|
|
343
|
+
* The possible values are:
|
|
344
|
+
* - `"CONFIRMED"` All participants are confirmed.
|
|
345
|
+
* - `"PENDING_CONFIRMATION"` Some participants are pending confirmation..
|
|
346
|
+
*/
|
|
347
|
+
status?: ParticipantsStatus$1;
|
|
348
|
+
}
|
|
349
|
+
interface Participant$1 {
|
|
350
|
+
/** The participant name. */
|
|
351
|
+
name?: string | null;
|
|
352
|
+
/** The participant phone. */
|
|
353
|
+
phone?: string | null;
|
|
354
|
+
/** The participant email address. */
|
|
355
|
+
email?: string | null;
|
|
356
|
+
/** The ID of the Wix contact. */
|
|
357
|
+
contactId?: string | null;
|
|
358
|
+
}
|
|
359
|
+
declare enum ParticipantsStatus$1 {
|
|
360
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
361
|
+
/** All participants are confirmed. */
|
|
362
|
+
CONFIRMED = "CONFIRMED",
|
|
363
|
+
/** Some participants are pending confirmation. */
|
|
364
|
+
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
365
|
+
}
|
|
366
|
+
interface ConferencingDetails$3 {
|
|
367
|
+
/** World known conference type, such as Zoom. */
|
|
368
|
+
type?: Type$3;
|
|
369
|
+
/** URL used by the host to start the conference. */
|
|
370
|
+
hostUrl?: string | null;
|
|
371
|
+
/** URL used by a guest to join the conference. */
|
|
372
|
+
guestUrl?: string | null;
|
|
373
|
+
/** Optional conference password. */
|
|
374
|
+
password?: string | null;
|
|
375
|
+
/** Optional conference ID in an external system. */
|
|
376
|
+
externalId?: string | null;
|
|
377
|
+
}
|
|
378
|
+
declare enum Type$3 {
|
|
379
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
380
|
+
ZOOM = "ZOOM",
|
|
381
|
+
CUSTOM = "CUSTOM"
|
|
382
|
+
}
|
|
383
|
+
declare enum Field$1 {
|
|
384
|
+
UNKNOWN_FIELD = "UNKNOWN_FIELD",
|
|
385
|
+
/** The title is inherited from the schedule or the recurring event. */
|
|
386
|
+
TITLE = "TITLE",
|
|
387
|
+
/** The time zone is inherited from the schedule or the recurring event. */
|
|
388
|
+
TIME_ZONE = "TIME_ZONE",
|
|
389
|
+
/** The time is inherited from the recurring event. */
|
|
390
|
+
TIME = "TIME",
|
|
391
|
+
/** The location is inherited from the schedule or the recurring event. */
|
|
392
|
+
LOCATION = "LOCATION",
|
|
393
|
+
/** The resources are inherited from the recurring event. */
|
|
394
|
+
RESOURCES = "RESOURCES",
|
|
395
|
+
/** The capacity is inherited from the schedule or the recurring event. */
|
|
396
|
+
CAPACITY = "CAPACITY",
|
|
397
|
+
/** The participants are inherited from the recurring event. */
|
|
398
|
+
PARTICIPANTS = "PARTICIPANTS",
|
|
399
|
+
/** The conferencing details are inherited from the schedule or the recurring event. */
|
|
400
|
+
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
401
|
+
}
|
|
402
|
+
interface Permission$3 {
|
|
403
|
+
/** The identity granted the permission. */
|
|
404
|
+
identity?: CommonIdentificationData$3;
|
|
405
|
+
/**
|
|
406
|
+
* The permission role.
|
|
407
|
+
*
|
|
408
|
+
* The possible values are:
|
|
409
|
+
* - `"WRITER"` Role grants full write and read access.
|
|
410
|
+
* - `"COMMENTER"` Role grants full read access and permission to edit notes.
|
|
411
|
+
*/
|
|
412
|
+
role?: Role$3;
|
|
413
|
+
}
|
|
414
|
+
interface CommonIdentificationData$3 extends CommonIdentificationDataIdOneOf$3 {
|
|
415
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
416
|
+
wixUserId?: string;
|
|
417
|
+
}
|
|
418
|
+
/** @oneof */
|
|
419
|
+
interface CommonIdentificationDataIdOneOf$3 {
|
|
420
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
421
|
+
wixUserId?: string;
|
|
422
|
+
}
|
|
423
|
+
declare enum IdentityType$3 {
|
|
424
|
+
UNKNOWN = "UNKNOWN",
|
|
425
|
+
WIX_USER = "WIX_USER"
|
|
426
|
+
}
|
|
427
|
+
interface ExtendedFields$3 {
|
|
428
|
+
/**
|
|
429
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
430
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
431
|
+
*
|
|
432
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
433
|
+
*
|
|
434
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
435
|
+
*/
|
|
436
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
437
|
+
}
|
|
438
|
+
interface GetEventRequest$1 {
|
|
439
|
+
/** The ID of the event to retrieve. Required. */
|
|
440
|
+
eventId: string | null;
|
|
441
|
+
/**
|
|
442
|
+
* Optional time zone used to adjust the returned events time.
|
|
443
|
+
* Default is the Wix Business time zone.
|
|
444
|
+
*/
|
|
445
|
+
timeZone?: string | null;
|
|
446
|
+
/** List of additional fields to be included in the response. */
|
|
447
|
+
fields?: RequestedFields$3[];
|
|
448
|
+
}
|
|
449
|
+
declare enum RequestedFields$3 {
|
|
450
|
+
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
451
|
+
/**
|
|
452
|
+
* Include fields containing personal information.
|
|
453
|
+
* Requires the `CALENDAR.EVENT_READ_PI` additional permission.
|
|
454
|
+
*/
|
|
455
|
+
PI_FIELDS = "PI_FIELDS",
|
|
456
|
+
/**
|
|
457
|
+
* Include fields containing personal information for events the current caller has access to.
|
|
458
|
+
* See `event.permissions` for more details.
|
|
459
|
+
*/
|
|
460
|
+
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
461
|
+
}
|
|
462
|
+
interface GetEventResponse$1 {
|
|
463
|
+
/** The event. */
|
|
464
|
+
event?: Event$1;
|
|
465
|
+
}
|
|
466
|
+
interface ListEventsRequest$1 {
|
|
467
|
+
/** The IDs of the events to retrieve. */
|
|
468
|
+
eventIds: string[];
|
|
469
|
+
/**
|
|
470
|
+
* Optional time zone used to adjust the returned events time.
|
|
471
|
+
* Default is the Wix Business time zone.
|
|
472
|
+
*/
|
|
473
|
+
timeZone?: string | null;
|
|
474
|
+
/** List of additional fields to be included in the response. */
|
|
475
|
+
fields?: RequestedFields$3[];
|
|
476
|
+
}
|
|
477
|
+
interface ListEventsResponse$1 {
|
|
478
|
+
/** The events matching the provided IDs. */
|
|
479
|
+
events?: Event$1[];
|
|
480
|
+
}
|
|
481
|
+
interface QueryEventsRequest$1 {
|
|
482
|
+
/**
|
|
483
|
+
* Local start date for which events are returned, in ISO-8601 format. Optional.
|
|
484
|
+
* E.g, "2024-01-30T13:30:00".
|
|
485
|
+
*
|
|
486
|
+
* Events that begin before the `fromLocalDate` but end after it are included in the results.
|
|
487
|
+
*/
|
|
488
|
+
fromLocalDate?: string | null;
|
|
489
|
+
/**
|
|
490
|
+
* Local end date for which events are returned, in ISO-8601 format. Optional.
|
|
491
|
+
* E.g, "2024-01-30T14:30:00".
|
|
492
|
+
*
|
|
493
|
+
* Events that begin before the `toLocalDate` but end after it are included in the results.
|
|
494
|
+
*
|
|
495
|
+
* `toLocalDate` must be after `fromLocalDate` unless the sort order is `DESCENDING`.
|
|
496
|
+
*/
|
|
497
|
+
toLocalDate?: string | null;
|
|
498
|
+
/**
|
|
499
|
+
* The time zone, in IANA time zone format.
|
|
500
|
+
* Default is the Wix Business time zone.
|
|
501
|
+
*/
|
|
502
|
+
timeZone?: string | null;
|
|
503
|
+
/** Query containing filters and paging. */
|
|
504
|
+
query?: CursorQuery$3;
|
|
505
|
+
/**
|
|
506
|
+
* Optional recurrence filter.
|
|
507
|
+
*
|
|
508
|
+
* By default only single event instances and instances of recurring events are returned.
|
|
509
|
+
*/
|
|
510
|
+
recurrenceType?: RecurrenceType$1[];
|
|
511
|
+
/** List of additional fields to be included in the response. */
|
|
512
|
+
fields?: RequestedFields$3[];
|
|
513
|
+
}
|
|
514
|
+
/** TODO Diverge */
|
|
515
|
+
interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
|
|
516
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
517
|
+
cursorPaging?: CursorPaging$3;
|
|
518
|
+
/**
|
|
519
|
+
* Filter object.
|
|
520
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
521
|
+
* for more information.
|
|
522
|
+
*
|
|
523
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
524
|
+
*
|
|
525
|
+
* For a detailed list of supported filters, see Supported Filters.
|
|
526
|
+
*/
|
|
527
|
+
filter?: Record<string, any> | null;
|
|
528
|
+
/**
|
|
529
|
+
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
530
|
+
* Default is start ascending.
|
|
531
|
+
*/
|
|
532
|
+
sort?: Sorting$1[];
|
|
533
|
+
}
|
|
534
|
+
/** @oneof */
|
|
535
|
+
interface CursorQueryPagingMethodOneOf$3 {
|
|
536
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
537
|
+
cursorPaging?: CursorPaging$3;
|
|
538
|
+
}
|
|
539
|
+
/** TODO Diverge */
|
|
540
|
+
interface Sorting$1 {
|
|
541
|
+
/**
|
|
542
|
+
* The field to sort by.
|
|
543
|
+
* Either `start` or `end.
|
|
544
|
+
* Default is `start`.
|
|
545
|
+
*/
|
|
546
|
+
fieldName?: string;
|
|
547
|
+
/** Sort order. */
|
|
548
|
+
order?: SortOrder$1;
|
|
549
|
+
}
|
|
550
|
+
declare enum SortOrder$1 {
|
|
551
|
+
ASC = "ASC",
|
|
552
|
+
DESC = "DESC"
|
|
553
|
+
}
|
|
554
|
+
/** TODO Diverge */
|
|
555
|
+
interface CursorPaging$3 {
|
|
556
|
+
/**
|
|
557
|
+
* Number of events to return.
|
|
558
|
+
* Defaults to `50`. Maximum `1000`.
|
|
559
|
+
*/
|
|
560
|
+
limit?: number | null;
|
|
561
|
+
/**
|
|
562
|
+
* Pointer to the next or previous page in the list of results.
|
|
563
|
+
*
|
|
564
|
+
* You can get the relevant cursor token
|
|
565
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
566
|
+
* Not relevant for the first request.
|
|
567
|
+
*/
|
|
568
|
+
cursor?: string | null;
|
|
569
|
+
}
|
|
570
|
+
interface QueryEventsResponse$1 {
|
|
571
|
+
/** The events matching the provided query. */
|
|
572
|
+
events?: Event$1[];
|
|
573
|
+
/** Paging metadata. */
|
|
574
|
+
pagingMetadata?: CursorPagingMetadata$3;
|
|
575
|
+
}
|
|
576
|
+
/** TODO Diverge */
|
|
577
|
+
interface CursorPagingMetadata$3 {
|
|
578
|
+
/** Number of items returned in the response. */
|
|
579
|
+
count?: number | null;
|
|
580
|
+
/** 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). */
|
|
581
|
+
cursors?: Cursors$3;
|
|
582
|
+
/**
|
|
583
|
+
* Indicates if there are more results after the current page.
|
|
584
|
+
* If `true`, another page of results can be retrieved.
|
|
585
|
+
* If `false`, this is the last page.
|
|
586
|
+
*/
|
|
587
|
+
hasNext?: boolean | null;
|
|
588
|
+
}
|
|
589
|
+
interface Cursors$3 {
|
|
590
|
+
/** Cursor pointing to next page in the list of results. */
|
|
591
|
+
next?: string | null;
|
|
592
|
+
}
|
|
593
|
+
interface CreateEventRequest$1 {
|
|
594
|
+
/** The event to create. */
|
|
595
|
+
event: Event$1;
|
|
596
|
+
/**
|
|
597
|
+
* Optional time zone used to adjust the returned event time.
|
|
598
|
+
* Default is the Wix Business time zone.
|
|
599
|
+
*/
|
|
600
|
+
timeZone?: string | null;
|
|
601
|
+
/** Optional idempotency key to guarantee that the event is created at most once if the same request is issued multiple times. */
|
|
602
|
+
idempotencyKey?: string | null;
|
|
603
|
+
}
|
|
604
|
+
interface CreateEventResponse$1 {
|
|
605
|
+
/** The created event. */
|
|
606
|
+
event?: Event$1;
|
|
607
|
+
}
|
|
608
|
+
interface BulkCreateEventRequest$1 {
|
|
609
|
+
/** The events to create. */
|
|
610
|
+
events: MaskedEvent$1[];
|
|
611
|
+
/**
|
|
612
|
+
* Whether to return the created events.
|
|
613
|
+
* Default is false.
|
|
614
|
+
*/
|
|
615
|
+
returnEntity?: boolean | null;
|
|
616
|
+
/**
|
|
617
|
+
* Optional time zone used to adjust the returned events time.
|
|
618
|
+
* Default is the Wix Business time zone.
|
|
619
|
+
*/
|
|
620
|
+
timeZone?: string | null;
|
|
621
|
+
}
|
|
622
|
+
interface MaskedEvent$1 {
|
|
623
|
+
/** The event to create. */
|
|
624
|
+
event?: Event$1;
|
|
625
|
+
}
|
|
626
|
+
interface BulkCreateEventResponse$1 {
|
|
627
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
628
|
+
results?: BulkEventResult$1[];
|
|
629
|
+
/** Total successes and failures. */
|
|
630
|
+
bulkActionMetadata?: BulkActionMetadata$1;
|
|
631
|
+
}
|
|
632
|
+
interface BulkEventResult$1 {
|
|
633
|
+
/** Whether the requested action was successful. */
|
|
634
|
+
itemMetadata?: ItemMetadata$1;
|
|
635
|
+
/** The event. */
|
|
636
|
+
item?: Event$1;
|
|
637
|
+
}
|
|
638
|
+
interface ItemMetadata$1 {
|
|
639
|
+
/**
|
|
640
|
+
* Event ID.
|
|
641
|
+
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
642
|
+
*/
|
|
643
|
+
id?: string | null;
|
|
644
|
+
/** Index of the item within the request array, for correlation between request and response items. */
|
|
645
|
+
originalIndex?: number;
|
|
646
|
+
/**
|
|
647
|
+
* Whether the requested action was successful for this event.
|
|
648
|
+
* When `false`, the `error` field is populated.
|
|
649
|
+
*/
|
|
650
|
+
success?: boolean;
|
|
651
|
+
/** Details about the error in case of failure. */
|
|
652
|
+
error?: ApplicationError$1;
|
|
653
|
+
}
|
|
654
|
+
interface ApplicationError$1 {
|
|
655
|
+
/** Error code. */
|
|
656
|
+
code?: string;
|
|
657
|
+
/** Description of the error. */
|
|
658
|
+
description?: string;
|
|
659
|
+
/** Data related to the error. */
|
|
660
|
+
data?: Record<string, any> | null;
|
|
661
|
+
}
|
|
662
|
+
interface BulkActionMetadata$1 {
|
|
663
|
+
/** Number of events that were successfully processed. */
|
|
664
|
+
totalSuccesses?: number;
|
|
665
|
+
/** Number of events that couldn't be processed. */
|
|
666
|
+
totalFailures?: number;
|
|
667
|
+
}
|
|
668
|
+
interface UpdateEventRequest$1 {
|
|
669
|
+
/** The event to update. */
|
|
670
|
+
event: Event$1;
|
|
671
|
+
/** Whether to notify participants regarding the changes. */
|
|
672
|
+
participantNotification?: ParticipantNotification$3;
|
|
673
|
+
/**
|
|
674
|
+
* Optional time zone used to adjust the returned event time.
|
|
675
|
+
* Default is the Wix Business time zone.
|
|
676
|
+
*/
|
|
677
|
+
timeZone?: string | null;
|
|
678
|
+
}
|
|
679
|
+
interface ParticipantNotification$3 {
|
|
680
|
+
/**
|
|
681
|
+
* Whether to notify the participant/s about changes made to the schedule or event.
|
|
682
|
+
* Default is false.
|
|
683
|
+
*/
|
|
684
|
+
notifyParticipants?: boolean | null;
|
|
685
|
+
/** Optional custom message to send. */
|
|
686
|
+
message?: string | null;
|
|
687
|
+
}
|
|
688
|
+
interface UpdateEventResponse$1 {
|
|
689
|
+
/** The updated event. */
|
|
690
|
+
event?: Event$1;
|
|
691
|
+
}
|
|
692
|
+
interface BulkUpdateEventRequest$1 {
|
|
693
|
+
/** The events to update. */
|
|
694
|
+
events: BulkUpdateEventRequestMaskedEvent$1[];
|
|
695
|
+
/**
|
|
696
|
+
* Whether to return the created events.
|
|
697
|
+
* Default is false.
|
|
698
|
+
*/
|
|
699
|
+
returnEntity?: boolean | null;
|
|
700
|
+
/** Whether to notify participants regarding the changes. */
|
|
701
|
+
participantNotification?: ParticipantNotification$3;
|
|
702
|
+
/**
|
|
703
|
+
* Optional time zone used to adjust the returned events time.
|
|
704
|
+
* Default is the Wix Business time zone.
|
|
705
|
+
*/
|
|
706
|
+
timeZone?: string | null;
|
|
707
|
+
}
|
|
708
|
+
interface BulkUpdateEventRequestMaskedEvent$1 {
|
|
709
|
+
/** The event to update. */
|
|
710
|
+
event?: Event$1;
|
|
711
|
+
}
|
|
712
|
+
interface BulkUpdateEventResponse$1 {
|
|
713
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
714
|
+
results?: BulkEventResult$1[];
|
|
715
|
+
/** Total successes and failures. */
|
|
716
|
+
bulkActionMetadata?: BulkActionMetadata$1;
|
|
717
|
+
}
|
|
718
|
+
interface RestoreEventDefaultsRequest$1 {
|
|
719
|
+
/** The ID of the event. */
|
|
720
|
+
eventId: string | null;
|
|
721
|
+
/** The fields for which to restore default values. */
|
|
722
|
+
fields: Field$1[];
|
|
723
|
+
/** Whether to notify participants regarding the changes. */
|
|
724
|
+
participantNotification?: ParticipantNotification$3;
|
|
725
|
+
/**
|
|
726
|
+
* Optional time zone used to adjust the returned event time.
|
|
727
|
+
* Default is the Wix Business time zone.
|
|
728
|
+
*/
|
|
729
|
+
timeZone?: string | null;
|
|
730
|
+
}
|
|
731
|
+
interface RestoreEventDefaultsResponse$1 {
|
|
732
|
+
/** The updated event. */
|
|
733
|
+
event?: Event$1;
|
|
734
|
+
}
|
|
735
|
+
interface SplitRecurringEventRequest$1 {
|
|
736
|
+
/** The ID of the recurring event to split. */
|
|
737
|
+
recurringEventId: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* The ISO-8601 local date where the recurring event is to be split.
|
|
740
|
+
* Must be a future date.
|
|
741
|
+
* Must be between two instances of the recurring event.
|
|
742
|
+
*/
|
|
743
|
+
splitLocalDate: string | null;
|
|
744
|
+
/**
|
|
745
|
+
* The time zone, in IANA time zone format.
|
|
746
|
+
* Default is the Wix Business time zone.
|
|
747
|
+
*/
|
|
748
|
+
timeZone?: string | null;
|
|
749
|
+
}
|
|
750
|
+
interface SplitRecurringEventResponse$1 {
|
|
751
|
+
/** The updated recurring event which set to end in the last instance before the split date. */
|
|
752
|
+
updatedRecurringEventEndingBeforeSplit?: Event$1;
|
|
753
|
+
/** The new recurring event which set to start from the next instance at or after the split date. */
|
|
754
|
+
newRecurringEventStartingFromSplit?: Event$1;
|
|
755
|
+
}
|
|
756
|
+
interface CancelEventRequest$1 {
|
|
757
|
+
/** The ID of the event to cancel. */
|
|
758
|
+
eventId: string | null;
|
|
759
|
+
/** Whether to notify participants regarding the changes. */
|
|
760
|
+
participantNotification?: ParticipantNotification$3;
|
|
761
|
+
/**
|
|
762
|
+
* Optional time zone used to adjust the returned event time.
|
|
763
|
+
* Default is the Wix Business time zone.
|
|
764
|
+
*/
|
|
765
|
+
timeZone?: string | null;
|
|
766
|
+
}
|
|
767
|
+
interface CancelEventResponse$1 {
|
|
768
|
+
/** The cancelled event. */
|
|
769
|
+
event?: Event$1;
|
|
770
|
+
}
|
|
771
|
+
interface BulkCancelEventRequest$1 {
|
|
772
|
+
/** The IDs of the events to cancel. */
|
|
773
|
+
eventIds: string[];
|
|
774
|
+
/**
|
|
775
|
+
* Whether to return the cancelled events.
|
|
776
|
+
* Default is false.
|
|
777
|
+
*/
|
|
778
|
+
returnEntity?: boolean | null;
|
|
779
|
+
/** Whether to notify participants regarding the changes. */
|
|
780
|
+
participantNotification?: ParticipantNotification$3;
|
|
781
|
+
/**
|
|
782
|
+
* Optional time zone used to adjust the returned events time.
|
|
783
|
+
* Default is the Wix Business time zone.
|
|
784
|
+
*/
|
|
785
|
+
timeZone?: string | null;
|
|
786
|
+
}
|
|
787
|
+
interface BulkCancelEventResponse$1 {
|
|
788
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
789
|
+
results?: BulkEventResult$1[];
|
|
790
|
+
/** Total successes and failures. */
|
|
791
|
+
bulkActionMetadata?: BulkActionMetadata$1;
|
|
792
|
+
}
|
|
793
|
+
interface ListEventsByContactIdRequest$1 {
|
|
794
|
+
/**
|
|
795
|
+
* The ID of the contact participating in the events.
|
|
796
|
+
* Required, unless `cursorPaging` is provided.
|
|
797
|
+
*/
|
|
798
|
+
contactId: string | null;
|
|
799
|
+
/**
|
|
800
|
+
* Local start date for which events are returned, in ISO-8601 format.
|
|
801
|
+
* E.g, `2024-01-01T00:00:00`.
|
|
802
|
+
*
|
|
803
|
+
* Required, unless `cursorPaging` is provided.
|
|
804
|
+
*/
|
|
805
|
+
fromLocalDate?: string | null;
|
|
806
|
+
/**
|
|
807
|
+
* Local end date for which events are returned, in ISO-8601 format.
|
|
808
|
+
* E.g, `2024-01-7T00:00:00`.
|
|
809
|
+
*
|
|
810
|
+
* Required, unless `cursorPaging` is provided.
|
|
811
|
+
* Max: 1 year after `fromLocalDate`.
|
|
812
|
+
*/
|
|
813
|
+
toLocalDate?: string | null;
|
|
814
|
+
/**
|
|
815
|
+
* The time zone, in IANA time zone format.
|
|
816
|
+
* Default is the Wix Business time zone.
|
|
817
|
+
*/
|
|
818
|
+
timeZone?: string | null;
|
|
819
|
+
/** Optional Wix app ID to filter events by. */
|
|
820
|
+
appId?: string | null;
|
|
821
|
+
/** Optional cursor to the next events page. */
|
|
822
|
+
cursorPaging?: CommonCursorPaging$1;
|
|
823
|
+
}
|
|
824
|
+
/** TODO Diverge */
|
|
825
|
+
interface CommonCursorPaging$1 {
|
|
826
|
+
/**
|
|
827
|
+
* Number of events to return.
|
|
828
|
+
* Defaults to `50`. Maximum `100`.
|
|
829
|
+
*/
|
|
830
|
+
limit?: number | null;
|
|
831
|
+
/**
|
|
832
|
+
* Pointer to the next or previous page in the list of results.
|
|
833
|
+
*
|
|
834
|
+
* You can get the relevant cursor token
|
|
835
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
836
|
+
* Not relevant for the first request.
|
|
837
|
+
*/
|
|
838
|
+
cursor?: string | null;
|
|
839
|
+
}
|
|
840
|
+
interface ListEventsByContactIdResponse$1 {
|
|
841
|
+
/** The participant events. */
|
|
842
|
+
events?: Event$1[];
|
|
843
|
+
/** Paging metadata. */
|
|
844
|
+
pagingMetadata?: CommonCursorPagingMetadata$1;
|
|
845
|
+
}
|
|
846
|
+
/** TODO Diverge */
|
|
847
|
+
interface CommonCursorPagingMetadata$1 {
|
|
848
|
+
/** Number of items returned in the response. */
|
|
849
|
+
count?: number | null;
|
|
850
|
+
/** 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). */
|
|
851
|
+
cursors?: CommonCursors$1;
|
|
852
|
+
/**
|
|
853
|
+
* Indicates if there are more results after the current page.
|
|
854
|
+
* If `true`, another page of results can be retrieved.
|
|
855
|
+
* If `false`, this is the last page.
|
|
856
|
+
*/
|
|
857
|
+
hasNext?: boolean | null;
|
|
858
|
+
}
|
|
859
|
+
interface CommonCursors$1 {
|
|
860
|
+
/** Cursor pointing to next page in the list of results. */
|
|
861
|
+
next?: string | null;
|
|
862
|
+
}
|
|
863
|
+
interface ListEventsByMemberIdRequest$1 {
|
|
864
|
+
/**
|
|
865
|
+
* The ID of the member participating in the events.
|
|
866
|
+
*
|
|
867
|
+
* Can be `me` for the currently logged-in member ID.
|
|
868
|
+
* To retrieve other member events the `CALENDAR.EVENT_READ_PI` permission is required.
|
|
869
|
+
*
|
|
870
|
+
* Required, unless `cursorPaging` is provided.
|
|
871
|
+
*/
|
|
872
|
+
memberId: string | null;
|
|
873
|
+
/**
|
|
874
|
+
* Local start date for which events are returned, in ISO-8601 format.
|
|
875
|
+
* E.g, `2024-01-01T00:00:00`.
|
|
876
|
+
*
|
|
877
|
+
* Required, unless `cursorPaging` or `eventIds` are provided.
|
|
878
|
+
*/
|
|
879
|
+
fromLocalDate?: string | null;
|
|
880
|
+
/**
|
|
881
|
+
* Local end date for which events are returned, in ISO-8601 format.
|
|
882
|
+
* E.g, `2024-01-7T00:00:00`.
|
|
883
|
+
*
|
|
884
|
+
* Required, unless `cursorPaging` or `eventIds` are provided.
|
|
885
|
+
* Max: 1 year after `fromLocalDate`.
|
|
886
|
+
*/
|
|
887
|
+
toLocalDate?: string | null;
|
|
888
|
+
/**
|
|
889
|
+
* The time zone, in IANA time zone format.
|
|
890
|
+
* Default is the Wix Business time zone.
|
|
891
|
+
*/
|
|
892
|
+
timeZone?: string | null;
|
|
893
|
+
/** Optional Wix app ID to filter events by. */
|
|
894
|
+
appId?: string | null;
|
|
895
|
+
/** Optional cursor to the next events page. */
|
|
896
|
+
cursorPaging?: CommonCursorPaging$1;
|
|
897
|
+
/**
|
|
898
|
+
* Optional event IDs to filter events by.
|
|
899
|
+
* If provided, other filters are ignored.
|
|
900
|
+
*/
|
|
901
|
+
eventIds?: string[];
|
|
902
|
+
}
|
|
903
|
+
interface ListEventsByMemberIdResponse$1 {
|
|
904
|
+
/** The participant events. */
|
|
905
|
+
events?: Event$1[];
|
|
906
|
+
/** Paging metadata. */
|
|
907
|
+
pagingMetadata?: CommonCursorPagingMetadata$1;
|
|
908
|
+
}
|
|
909
|
+
interface RecurrenceRuleNonNullableFields$1 {
|
|
910
|
+
frequency: Frequency$1;
|
|
911
|
+
days: Day$1[];
|
|
912
|
+
}
|
|
913
|
+
interface LocationNonNullableFields$3 {
|
|
914
|
+
type: LocationType$3;
|
|
915
|
+
}
|
|
916
|
+
interface ResourceNonNullableFields$1 {
|
|
917
|
+
transparency: Transparency$1;
|
|
918
|
+
permissionRole: Role$3;
|
|
919
|
+
}
|
|
920
|
+
interface ParticipantsNonNullableFields$1 {
|
|
921
|
+
status: ParticipantsStatus$1;
|
|
922
|
+
}
|
|
923
|
+
interface ConferencingDetailsNonNullableFields$3 {
|
|
924
|
+
type: Type$3;
|
|
925
|
+
}
|
|
926
|
+
interface CommonIdentificationDataNonNullableFields$3 {
|
|
927
|
+
wixUserId: string;
|
|
928
|
+
identityType: IdentityType$3;
|
|
929
|
+
}
|
|
930
|
+
interface PermissionNonNullableFields$3 {
|
|
931
|
+
identity?: CommonIdentificationDataNonNullableFields$3;
|
|
932
|
+
role: Role$3;
|
|
933
|
+
}
|
|
934
|
+
interface EventNonNullableFields$1 {
|
|
935
|
+
status: Status$5;
|
|
936
|
+
recurrenceType: RecurrenceType$1;
|
|
937
|
+
recurrenceRule?: RecurrenceRuleNonNullableFields$1;
|
|
938
|
+
transparency: Transparency$1;
|
|
939
|
+
location?: LocationNonNullableFields$3;
|
|
940
|
+
resources: ResourceNonNullableFields$1[];
|
|
941
|
+
participants?: ParticipantsNonNullableFields$1;
|
|
942
|
+
conferencingDetails?: ConferencingDetailsNonNullableFields$3;
|
|
943
|
+
inheritedFields: Field$1[];
|
|
944
|
+
permissions: PermissionNonNullableFields$3[];
|
|
945
|
+
}
|
|
946
|
+
interface GetEventResponseNonNullableFields$1 {
|
|
947
|
+
event?: EventNonNullableFields$1;
|
|
948
|
+
}
|
|
949
|
+
interface ListEventsResponseNonNullableFields$1 {
|
|
950
|
+
events: EventNonNullableFields$1[];
|
|
951
|
+
}
|
|
952
|
+
interface QueryEventsResponseNonNullableFields$1 {
|
|
953
|
+
events: EventNonNullableFields$1[];
|
|
954
|
+
}
|
|
955
|
+
interface CreateEventResponseNonNullableFields$1 {
|
|
956
|
+
event?: EventNonNullableFields$1;
|
|
957
|
+
}
|
|
958
|
+
interface ApplicationErrorNonNullableFields$1 {
|
|
959
|
+
code: string;
|
|
960
|
+
description: string;
|
|
961
|
+
}
|
|
962
|
+
interface ItemMetadataNonNullableFields$1 {
|
|
963
|
+
originalIndex: number;
|
|
964
|
+
success: boolean;
|
|
965
|
+
error?: ApplicationErrorNonNullableFields$1;
|
|
966
|
+
}
|
|
967
|
+
interface BulkEventResultNonNullableFields$1 {
|
|
968
|
+
itemMetadata?: ItemMetadataNonNullableFields$1;
|
|
969
|
+
item?: EventNonNullableFields$1;
|
|
970
|
+
}
|
|
971
|
+
interface BulkActionMetadataNonNullableFields$1 {
|
|
972
|
+
totalSuccesses: number;
|
|
973
|
+
totalFailures: number;
|
|
974
|
+
}
|
|
975
|
+
interface BulkCreateEventResponseNonNullableFields$1 {
|
|
976
|
+
results: BulkEventResultNonNullableFields$1[];
|
|
977
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
|
|
978
|
+
}
|
|
979
|
+
interface UpdateEventResponseNonNullableFields$1 {
|
|
980
|
+
event?: EventNonNullableFields$1;
|
|
981
|
+
}
|
|
982
|
+
interface BulkUpdateEventResponseNonNullableFields$1 {
|
|
983
|
+
results: BulkEventResultNonNullableFields$1[];
|
|
984
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
|
|
985
|
+
}
|
|
986
|
+
interface RestoreEventDefaultsResponseNonNullableFields$1 {
|
|
987
|
+
event?: EventNonNullableFields$1;
|
|
988
|
+
}
|
|
989
|
+
interface SplitRecurringEventResponseNonNullableFields$1 {
|
|
990
|
+
updatedRecurringEventEndingBeforeSplit?: EventNonNullableFields$1;
|
|
991
|
+
newRecurringEventStartingFromSplit?: EventNonNullableFields$1;
|
|
992
|
+
}
|
|
993
|
+
interface CancelEventResponseNonNullableFields$1 {
|
|
994
|
+
event?: EventNonNullableFields$1;
|
|
995
|
+
}
|
|
996
|
+
interface BulkCancelEventResponseNonNullableFields$1 {
|
|
997
|
+
results: BulkEventResultNonNullableFields$1[];
|
|
998
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
|
|
999
|
+
}
|
|
1000
|
+
interface ListEventsByContactIdResponseNonNullableFields$1 {
|
|
1001
|
+
events: EventNonNullableFields$1[];
|
|
1002
|
+
}
|
|
1003
|
+
interface ListEventsByMemberIdResponseNonNullableFields$1 {
|
|
1004
|
+
events: EventNonNullableFields$1[];
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
interface Event {
|
|
1008
|
+
/**
|
|
1009
|
+
* The event ID.
|
|
1010
|
+
* @readonly
|
|
1011
|
+
*/
|
|
1012
|
+
_id?: string | null;
|
|
1013
|
+
/**
|
|
1014
|
+
* The ID of the schedule that the event belongs to.
|
|
1015
|
+
* Cannot change.
|
|
1016
|
+
*/
|
|
1017
|
+
scheduleId?: string | null;
|
|
1018
|
+
/**
|
|
1019
|
+
* The external schedule ID.
|
|
1020
|
+
* @readonly
|
|
1021
|
+
*/
|
|
1022
|
+
externalScheduleId?: string | null;
|
|
1023
|
+
/**
|
|
1024
|
+
* The schedule name.
|
|
1025
|
+
* @readonly
|
|
1026
|
+
*/
|
|
1027
|
+
scheduleName?: string | null;
|
|
1028
|
+
/**
|
|
1029
|
+
* The event type.
|
|
1030
|
+
* Cannot change.
|
|
1031
|
+
*
|
|
1032
|
+
* The possible values are:
|
|
1033
|
+
* - `"DEFAULT"` Default event.
|
|
1034
|
+
* - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
|
|
1035
|
+
*
|
|
1036
|
+
* The Wix Bookings App, once installed, also provides the following:
|
|
1037
|
+
* - `"APPOINTMENT"` Bookings Appointment event.
|
|
1038
|
+
* - `"CLASS"` Bookings Class event.
|
|
1039
|
+
* - `"COURSE"` Bookings Course event.
|
|
1040
|
+
*
|
|
1041
|
+
* See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
|
|
1042
|
+
*/
|
|
1043
|
+
type?: string | null;
|
|
1044
|
+
/**
|
|
1045
|
+
* The event status. Read only.
|
|
1046
|
+
*
|
|
1047
|
+
* The possible values are:
|
|
1048
|
+
* - `"CONFIRMED"` Event is confirmed. Default value.
|
|
1049
|
+
* - `"CANCELLED"` Event has been cancelled.
|
|
1050
|
+
* @readonly
|
|
1051
|
+
*/
|
|
1052
|
+
status?: Status$4;
|
|
1053
|
+
/**
|
|
1054
|
+
* The event title.
|
|
1055
|
+
*
|
|
1056
|
+
* The title is inherited from the schedule and can be overridden.
|
|
1057
|
+
*/
|
|
1058
|
+
title?: string | null;
|
|
1059
|
+
/**
|
|
1060
|
+
* The event start date.
|
|
1061
|
+
*
|
|
1062
|
+
* Recurring events must start from at least today.
|
|
1063
|
+
*/
|
|
1064
|
+
start?: ZonedDate$2;
|
|
1065
|
+
/** The event end date. */
|
|
1066
|
+
end?: ZonedDate$2;
|
|
1067
|
+
/**
|
|
1068
|
+
* Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
1069
|
+
* @readonly
|
|
1070
|
+
*/
|
|
1071
|
+
adjustedStart?: ZonedDate$2;
|
|
1072
|
+
/**
|
|
1073
|
+
* Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
1074
|
+
* @readonly
|
|
1075
|
+
*/
|
|
1076
|
+
adjustedEnd?: ZonedDate$2;
|
|
1077
|
+
/**
|
|
1078
|
+
* The event time zone, formatted according to the IANA time zone format.
|
|
1079
|
+
* Must be a regional time zone (Area/Location) or UTC.
|
|
1080
|
+
*
|
|
1081
|
+
* The time zone is inherited from the schedule and can be overridden.
|
|
1082
|
+
*/
|
|
1083
|
+
timeZone?: string | null;
|
|
1084
|
+
/**
|
|
1085
|
+
* Whether this event is a recurring event or an instance of recurring event.
|
|
1086
|
+
*
|
|
1087
|
+
* The possible values are:
|
|
1088
|
+
* - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
|
|
1089
|
+
* - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
|
|
1090
|
+
* - `"INSTANCE"` The event is an instance of a recurring event. Read only.
|
|
1091
|
+
* - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
|
|
1092
|
+
* @readonly
|
|
1093
|
+
*/
|
|
1094
|
+
recurrenceType?: RecurrenceType;
|
|
1095
|
+
/**
|
|
1096
|
+
* The recurrence rule defining a repeating pattern for the event.
|
|
1097
|
+
* Required for `MASTER` recurrence, read only otherwise.
|
|
1098
|
+
*
|
|
1099
|
+
* For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
|
|
1100
|
+
* - `frequency = WEEKLY`
|
|
1101
|
+
* - `interval = 2`
|
|
1102
|
+
* - `days = [MONDAY]`
|
|
1103
|
+
* - `until = 20240107T08:00:00Z`
|
|
1104
|
+
*/
|
|
1105
|
+
recurrenceRule?: RecurrenceRule;
|
|
1106
|
+
/**
|
|
1107
|
+
* The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
|
|
1108
|
+
* @readonly
|
|
1109
|
+
*/
|
|
1110
|
+
recurringEventId?: string | null;
|
|
1111
|
+
/**
|
|
1112
|
+
* Specifies whether the event blocks the schedule time.
|
|
1113
|
+
* Default is true.
|
|
1114
|
+
*/
|
|
1115
|
+
transparency?: Transparency;
|
|
1116
|
+
/**
|
|
1117
|
+
* The event location.
|
|
1118
|
+
*
|
|
1119
|
+
* The location is inherited from the schedule and can be overridden.
|
|
1120
|
+
*/
|
|
1121
|
+
location?: Location$2;
|
|
1122
|
+
/**
|
|
1123
|
+
* List of resources affected by the event.
|
|
1124
|
+
*
|
|
1125
|
+
* For example:
|
|
1126
|
+
* - Event occupying a resource time, such as a room, equipment or person.
|
|
1127
|
+
* - The Bookings App Staff is affected by the Booking Class Sessions it provides.
|
|
1128
|
+
*/
|
|
1129
|
+
resources?: Resource[];
|
|
1130
|
+
/**
|
|
1131
|
+
* The event capacity, which is the max number of participants that can participate in the event.
|
|
1132
|
+
*
|
|
1133
|
+
* The total capacity is inherited from the schedule and can be overridden.
|
|
1134
|
+
*/
|
|
1135
|
+
totalCapacity?: number | null;
|
|
1136
|
+
/**
|
|
1137
|
+
* The remaining number of participants that can be added to the event.
|
|
1138
|
+
* @readonly
|
|
1139
|
+
*/
|
|
1140
|
+
remainingCapacity?: number | null;
|
|
1141
|
+
/**
|
|
1142
|
+
* The event participants.
|
|
1143
|
+
* @readonly
|
|
1144
|
+
*/
|
|
1145
|
+
participants?: Participants;
|
|
1146
|
+
/**
|
|
1147
|
+
* Online conferencing details.
|
|
1148
|
+
*
|
|
1149
|
+
* The conferencing details are inherited from the schedule and can be overridden.
|
|
1150
|
+
*/
|
|
1151
|
+
conferencingDetails?: ConferencingDetails$2;
|
|
1152
|
+
/** Additional notes and information about the event. */
|
|
1153
|
+
notes?: string | null;
|
|
1154
|
+
/**
|
|
1155
|
+
* A list of fields for which values were inherited from the schedule or the recurring event,
|
|
1156
|
+
* if this event is an instance of recurring event.
|
|
1157
|
+
* @readonly
|
|
1158
|
+
*/
|
|
1159
|
+
inheritedFields?: Field[];
|
|
1160
|
+
/**
|
|
1161
|
+
* ID of the Wix app owning the event, as derived from the schedule.
|
|
1162
|
+
* @readonly
|
|
1163
|
+
*/
|
|
1164
|
+
appId?: string | null;
|
|
1165
|
+
/**
|
|
1166
|
+
* List of granted permissions for this event.
|
|
1167
|
+
*
|
|
1168
|
+
* Derived from the schedule and the resources of the the event.
|
|
1169
|
+
* @readonly
|
|
1170
|
+
*/
|
|
1171
|
+
permissions?: Permission$2[];
|
|
1172
|
+
/** Extensions enabling applications or users to save custom data related to the event. */
|
|
1173
|
+
extendedFields?: ExtendedFields$2;
|
|
1174
|
+
/**
|
|
1175
|
+
* The event revision number, which incremented on updates.
|
|
1176
|
+
*
|
|
1177
|
+
* The current revision should be provided on updates to prevent conflicting changes.
|
|
1178
|
+
* @readonly
|
|
1179
|
+
*/
|
|
1180
|
+
revision?: string | null;
|
|
1181
|
+
/**
|
|
1182
|
+
* Date the event was created.
|
|
1183
|
+
* @readonly
|
|
1184
|
+
*/
|
|
1185
|
+
_createdDate?: Date;
|
|
1186
|
+
/**
|
|
1187
|
+
* Date the event was last updated.
|
|
1188
|
+
* @readonly
|
|
1189
|
+
*/
|
|
1190
|
+
_updatedDate?: Date;
|
|
1191
|
+
}
|
|
1192
|
+
declare enum Status$4 {
|
|
1193
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1194
|
+
/** Event is confirmed. Default value. */
|
|
1195
|
+
CONFIRMED = "CONFIRMED",
|
|
1196
|
+
/** DEPRECATED! AND WILL BE REMOVED SOON */
|
|
1197
|
+
PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
|
|
1198
|
+
/** Event has been cancelled. */
|
|
1199
|
+
CANCELLED = "CANCELLED"
|
|
1200
|
+
}
|
|
1201
|
+
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
1202
|
+
interface ZonedDate$2 {
|
|
1203
|
+
/**
|
|
1204
|
+
* Local date time, in ISO-8601 format.
|
|
1205
|
+
* E.g, "2024-01-30T13:30:00".
|
|
1206
|
+
*
|
|
1207
|
+
* Note: seconds are not supported and ignored.
|
|
1208
|
+
*/
|
|
1209
|
+
localDate?: string | null;
|
|
1210
|
+
/**
|
|
1211
|
+
* The event time zone.
|
|
1212
|
+
* @readonly
|
|
1213
|
+
*/
|
|
1214
|
+
timeZone?: string | null;
|
|
1215
|
+
/**
|
|
1216
|
+
* The UTC date determined by the server.
|
|
1217
|
+
* Not returned for adjusted dates.
|
|
1218
|
+
* @readonly
|
|
1219
|
+
*/
|
|
1220
|
+
utcDate?: Date;
|
|
1221
|
+
}
|
|
1222
|
+
declare enum RecurrenceType {
|
|
1223
|
+
UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
|
|
1224
|
+
/** No recurrence, i.e the event is a single event instance. Default. */
|
|
1225
|
+
NONE = "NONE",
|
|
1226
|
+
/** The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events. */
|
|
1227
|
+
MASTER = "MASTER",
|
|
1228
|
+
/** The event is an instance of a recurring event. Read only. */
|
|
1229
|
+
INSTANCE = "INSTANCE",
|
|
1230
|
+
/** The event is an exceptional instance of a recurring event. Read only. */
|
|
1231
|
+
EXCEPTION = "EXCEPTION"
|
|
1232
|
+
}
|
|
1233
|
+
interface RecurrenceRule {
|
|
1234
|
+
/** The frequency with which the event should be repeated. */
|
|
1235
|
+
frequency?: Frequency;
|
|
1236
|
+
/**
|
|
1237
|
+
* Works together with `frequency` to specify how often the event should be repeated. Default is `1`.
|
|
1238
|
+
* For example, `WEEKLY` frequency and `interval` of `2` means once every two weeks.
|
|
1239
|
+
*/
|
|
1240
|
+
interval?: number | null;
|
|
1241
|
+
/**
|
|
1242
|
+
* The days of the week when the event should be repeated.
|
|
1243
|
+
* Currently, only a single day is supported.
|
|
1244
|
+
*/
|
|
1245
|
+
days?: Day[];
|
|
1246
|
+
/**
|
|
1247
|
+
* The date until which the event should be repeated.
|
|
1248
|
+
* When it is not specified, the event repeats forever.
|
|
1249
|
+
*/
|
|
1250
|
+
until?: ZonedDate$2;
|
|
1251
|
+
/**
|
|
1252
|
+
* Read-only until date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
1253
|
+
* @readonly
|
|
1254
|
+
*/
|
|
1255
|
+
adjustedUntil?: ZonedDate$2;
|
|
1256
|
+
}
|
|
1257
|
+
declare enum Frequency {
|
|
1258
|
+
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
1259
|
+
/** The event repeats every few weeks. */
|
|
1260
|
+
WEEKLY = "WEEKLY"
|
|
1261
|
+
}
|
|
1262
|
+
declare enum Day {
|
|
1263
|
+
MONDAY = "MONDAY",
|
|
1264
|
+
TUESDAY = "TUESDAY",
|
|
1265
|
+
WEDNESDAY = "WEDNESDAY",
|
|
1266
|
+
THURSDAY = "THURSDAY",
|
|
1267
|
+
FRIDAY = "FRIDAY",
|
|
1268
|
+
SATURDAY = "SATURDAY",
|
|
1269
|
+
SUNDAY = "SUNDAY"
|
|
1270
|
+
}
|
|
1271
|
+
declare enum Transparency {
|
|
1272
|
+
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
1273
|
+
/** The event block time. Default. */
|
|
1274
|
+
OPAQUE = "OPAQUE",
|
|
1275
|
+
/** The event does not block the time. */
|
|
1276
|
+
TRANSPARENT = "TRANSPARENT"
|
|
1277
|
+
}
|
|
1278
|
+
interface Location$2 {
|
|
1279
|
+
/**
|
|
1280
|
+
* The location ID. Optional.
|
|
1281
|
+
* Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
|
|
1282
|
+
*/
|
|
1283
|
+
_id?: string | null;
|
|
1284
|
+
/**
|
|
1285
|
+
* The location type.
|
|
1286
|
+
* The possible values are:
|
|
1287
|
+
* - `"BUSINESS"` event takes place at the business location.
|
|
1288
|
+
* - `"CUSTOM"` event takes place at the custom location.
|
|
1289
|
+
*/
|
|
1290
|
+
type?: LocationType$2;
|
|
1291
|
+
/**
|
|
1292
|
+
* The location name. Optional.
|
|
1293
|
+
* Derived from the Wix Business Location if the location is of type `BUSINESS`.
|
|
1294
|
+
*/
|
|
1295
|
+
name?: string | null;
|
|
1296
|
+
/**
|
|
1297
|
+
* The location address. Optional.
|
|
1298
|
+
* Derived from the Wix Business Location if the location is of type `BUSINESS`.
|
|
1299
|
+
*/
|
|
1300
|
+
address?: string | null;
|
|
1301
|
+
}
|
|
1302
|
+
declare enum LocationType$2 {
|
|
1303
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
1304
|
+
/** The event takes place at the business location. */
|
|
1305
|
+
BUSINESS = "BUSINESS",
|
|
1306
|
+
/** The event takes place at the customer location. */
|
|
1307
|
+
CUSTOMER = "CUSTOMER",
|
|
1308
|
+
/** The event takes place at the custom location. */
|
|
1309
|
+
CUSTOM = "CUSTOM"
|
|
1310
|
+
}
|
|
1311
|
+
interface Resource {
|
|
1312
|
+
/** The resource ID. */
|
|
1313
|
+
_id?: string | null;
|
|
1314
|
+
/**
|
|
1315
|
+
* The resource name.
|
|
1316
|
+
* @readonly
|
|
1317
|
+
*/
|
|
1318
|
+
name?: string | null;
|
|
1319
|
+
/**
|
|
1320
|
+
* The resource type.
|
|
1321
|
+
* @readonly
|
|
1322
|
+
*/
|
|
1323
|
+
type?: string | null;
|
|
1324
|
+
/**
|
|
1325
|
+
* Specifies whether the event blocks the resource time.
|
|
1326
|
+
* Default is `OPAQUE`.
|
|
1327
|
+
*/
|
|
1328
|
+
transparency?: Transparency;
|
|
1329
|
+
/** Optional permission role to grant the identities associated with the resource. */
|
|
1330
|
+
permissionRole?: Role$2;
|
|
1331
|
+
}
|
|
1332
|
+
declare enum Role$2 {
|
|
1333
|
+
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
1334
|
+
/** Role grants full write and read access. */
|
|
1335
|
+
WRITER = "WRITER",
|
|
1336
|
+
/** Role grants full read access and permission to edit notes. */
|
|
1337
|
+
COMMENTER = "COMMENTER"
|
|
1338
|
+
}
|
|
1339
|
+
interface Participants {
|
|
1340
|
+
/** The total number of participants. */
|
|
1341
|
+
total?: number | null;
|
|
1342
|
+
/** A full or partial list of the participants. */
|
|
1343
|
+
list?: Participant[];
|
|
1344
|
+
/** Whether there are more participants for the event which were not listed. */
|
|
1345
|
+
hasMore?: boolean | null;
|
|
1346
|
+
/**
|
|
1347
|
+
* The participants status.
|
|
1348
|
+
*
|
|
1349
|
+
* The possible values are:
|
|
1350
|
+
* - `"CONFIRMED"` All participants are confirmed.
|
|
1351
|
+
* - `"PENDING_CONFIRMATION"` Some participants are pending confirmation..
|
|
1352
|
+
*/
|
|
1353
|
+
status?: ParticipantsStatus;
|
|
1354
|
+
}
|
|
1355
|
+
interface Participant {
|
|
1356
|
+
/** The participant name. */
|
|
1357
|
+
name?: string | null;
|
|
1358
|
+
/** The participant phone. */
|
|
1359
|
+
phone?: string | null;
|
|
1360
|
+
/** The participant email address. */
|
|
1361
|
+
email?: string | null;
|
|
1362
|
+
/** The ID of the Wix contact. */
|
|
1363
|
+
contactId?: string | null;
|
|
1364
|
+
}
|
|
1365
|
+
declare enum ParticipantsStatus {
|
|
1366
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1367
|
+
/** All participants are confirmed. */
|
|
1368
|
+
CONFIRMED = "CONFIRMED",
|
|
1369
|
+
/** Some participants are pending confirmation. */
|
|
1370
|
+
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
1371
|
+
}
|
|
1372
|
+
interface ConferencingDetails$2 {
|
|
1373
|
+
/** World known conference type, such as Zoom. */
|
|
1374
|
+
type?: Type$2;
|
|
1375
|
+
/** URL used by the host to start the conference. */
|
|
1376
|
+
hostUrl?: string | null;
|
|
1377
|
+
/** URL used by a guest to join the conference. */
|
|
1378
|
+
guestUrl?: string | null;
|
|
1379
|
+
/** Optional conference password. */
|
|
1380
|
+
password?: string | null;
|
|
1381
|
+
/** Optional conference ID in an external system. */
|
|
1382
|
+
externalId?: string | null;
|
|
1383
|
+
}
|
|
1384
|
+
declare enum Type$2 {
|
|
1385
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
1386
|
+
ZOOM = "ZOOM",
|
|
1387
|
+
CUSTOM = "CUSTOM"
|
|
1388
|
+
}
|
|
1389
|
+
declare enum Field {
|
|
1390
|
+
UNKNOWN_FIELD = "UNKNOWN_FIELD",
|
|
1391
|
+
/** The title is inherited from the schedule or the recurring event. */
|
|
1392
|
+
TITLE = "TITLE",
|
|
1393
|
+
/** The time zone is inherited from the schedule or the recurring event. */
|
|
1394
|
+
TIME_ZONE = "TIME_ZONE",
|
|
1395
|
+
/** The time is inherited from the recurring event. */
|
|
1396
|
+
TIME = "TIME",
|
|
1397
|
+
/** The location is inherited from the schedule or the recurring event. */
|
|
1398
|
+
LOCATION = "LOCATION",
|
|
1399
|
+
/** The resources are inherited from the recurring event. */
|
|
1400
|
+
RESOURCES = "RESOURCES",
|
|
1401
|
+
/** The capacity is inherited from the schedule or the recurring event. */
|
|
1402
|
+
CAPACITY = "CAPACITY",
|
|
1403
|
+
/** The participants are inherited from the recurring event. */
|
|
1404
|
+
PARTICIPANTS = "PARTICIPANTS",
|
|
1405
|
+
/** The conferencing details are inherited from the schedule or the recurring event. */
|
|
1406
|
+
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
1407
|
+
}
|
|
1408
|
+
interface Permission$2 {
|
|
1409
|
+
/** The identity granted the permission. */
|
|
1410
|
+
identity?: CommonIdentificationData$2;
|
|
1411
|
+
/**
|
|
1412
|
+
* The permission role.
|
|
1413
|
+
*
|
|
1414
|
+
* The possible values are:
|
|
1415
|
+
* - `"WRITER"` Role grants full write and read access.
|
|
1416
|
+
* - `"COMMENTER"` Role grants full read access and permission to edit notes.
|
|
1417
|
+
*/
|
|
1418
|
+
role?: Role$2;
|
|
1419
|
+
}
|
|
1420
|
+
interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
|
|
1421
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1422
|
+
wixUserId?: string;
|
|
1423
|
+
}
|
|
1424
|
+
/** @oneof */
|
|
1425
|
+
interface CommonIdentificationDataIdOneOf$2 {
|
|
1426
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1427
|
+
wixUserId?: string;
|
|
1428
|
+
}
|
|
1429
|
+
declare enum IdentityType$2 {
|
|
1430
|
+
UNKNOWN = "UNKNOWN",
|
|
1431
|
+
WIX_USER = "WIX_USER"
|
|
1432
|
+
}
|
|
1433
|
+
interface ExtendedFields$2 {
|
|
1434
|
+
/**
|
|
1435
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1436
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
1437
|
+
*
|
|
1438
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
1439
|
+
*
|
|
1440
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
1441
|
+
*/
|
|
1442
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
1443
|
+
}
|
|
1444
|
+
interface GetEventRequest {
|
|
1445
|
+
/** The ID of the event to retrieve. Required. */
|
|
1446
|
+
eventId: string | null;
|
|
1447
|
+
/**
|
|
1448
|
+
* Optional time zone used to adjust the returned events time.
|
|
1449
|
+
* Default is the Wix Business time zone.
|
|
1450
|
+
*/
|
|
1451
|
+
timeZone?: string | null;
|
|
1452
|
+
/** List of additional fields to be included in the response. */
|
|
1453
|
+
fields?: RequestedFields$2[];
|
|
1454
|
+
}
|
|
1455
|
+
declare enum RequestedFields$2 {
|
|
1456
|
+
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1457
|
+
/**
|
|
1458
|
+
* Include fields containing personal information.
|
|
1459
|
+
* Requires the `CALENDAR.EVENT_READ_PI` additional permission.
|
|
1460
|
+
*/
|
|
1461
|
+
PI_FIELDS = "PI_FIELDS",
|
|
1462
|
+
/**
|
|
1463
|
+
* Include fields containing personal information for events the current caller has access to.
|
|
1464
|
+
* See `event.permissions` for more details.
|
|
1465
|
+
*/
|
|
1466
|
+
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1467
|
+
}
|
|
1468
|
+
interface GetEventResponse {
|
|
1469
|
+
/** The event. */
|
|
1470
|
+
event?: Event;
|
|
1471
|
+
}
|
|
1472
|
+
interface ListEventsRequest {
|
|
1473
|
+
/** The IDs of the events to retrieve. */
|
|
1474
|
+
eventIds: string[];
|
|
1475
|
+
/**
|
|
1476
|
+
* Optional time zone used to adjust the returned events time.
|
|
1477
|
+
* Default is the Wix Business time zone.
|
|
1478
|
+
*/
|
|
1479
|
+
timeZone?: string | null;
|
|
1480
|
+
/** List of additional fields to be included in the response. */
|
|
1481
|
+
fields?: RequestedFields$2[];
|
|
1482
|
+
}
|
|
1483
|
+
interface ListEventsResponse {
|
|
1484
|
+
/** The events matching the provided IDs. */
|
|
1485
|
+
events?: Event[];
|
|
1486
|
+
}
|
|
1487
|
+
interface QueryEventsRequest {
|
|
1488
|
+
/**
|
|
1489
|
+
* Local start date for which events are returned, in ISO-8601 format. Optional.
|
|
1490
|
+
* E.g, "2024-01-30T13:30:00".
|
|
1491
|
+
*
|
|
1492
|
+
* Events that begin before the `fromLocalDate` but end after it are included in the results.
|
|
1493
|
+
*/
|
|
1494
|
+
fromLocalDate?: string | null;
|
|
1495
|
+
/**
|
|
1496
|
+
* Local end date for which events are returned, in ISO-8601 format. Optional.
|
|
1497
|
+
* E.g, "2024-01-30T14:30:00".
|
|
1498
|
+
*
|
|
1499
|
+
* Events that begin before the `toLocalDate` but end after it are included in the results.
|
|
1500
|
+
*
|
|
1501
|
+
* `toLocalDate` must be after `fromLocalDate` unless the sort order is `DESCENDING`.
|
|
1502
|
+
*/
|
|
1503
|
+
toLocalDate?: string | null;
|
|
1504
|
+
/**
|
|
1505
|
+
* The time zone, in IANA time zone format.
|
|
1506
|
+
* Default is the Wix Business time zone.
|
|
1507
|
+
*/
|
|
1508
|
+
timeZone?: string | null;
|
|
1509
|
+
/** Query containing filters and paging. */
|
|
1510
|
+
query?: CursorQuery$2;
|
|
1511
|
+
/**
|
|
1512
|
+
* Optional recurrence filter.
|
|
1513
|
+
*
|
|
1514
|
+
* By default only single event instances and instances of recurring events are returned.
|
|
1515
|
+
*/
|
|
1516
|
+
recurrenceType?: RecurrenceType[];
|
|
1517
|
+
/** List of additional fields to be included in the response. */
|
|
1518
|
+
fields?: RequestedFields$2[];
|
|
1519
|
+
}
|
|
1520
|
+
/** TODO Diverge */
|
|
1521
|
+
interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
|
|
1522
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1523
|
+
cursorPaging?: CursorPaging$2;
|
|
1524
|
+
/**
|
|
1525
|
+
* Filter object.
|
|
1526
|
+
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
1527
|
+
* for more information.
|
|
1528
|
+
*
|
|
1529
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
|
|
1530
|
+
*
|
|
1531
|
+
* For a detailed list of supported filters, see Supported Filters.
|
|
1532
|
+
*/
|
|
1533
|
+
filter?: Record<string, any> | null;
|
|
1534
|
+
/**
|
|
1535
|
+
* Whether to sort events by their start date in ascending order or by their end date in descending order.
|
|
1536
|
+
* Default is start ascending.
|
|
1537
|
+
*/
|
|
1538
|
+
sort?: Sorting[];
|
|
1539
|
+
}
|
|
1540
|
+
/** @oneof */
|
|
1541
|
+
interface CursorQueryPagingMethodOneOf$2 {
|
|
1542
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1543
|
+
cursorPaging?: CursorPaging$2;
|
|
1544
|
+
}
|
|
1545
|
+
/** TODO Diverge */
|
|
1546
|
+
interface Sorting {
|
|
1547
|
+
/**
|
|
1548
|
+
* The field to sort by.
|
|
1549
|
+
* Either `start` or `end.
|
|
1550
|
+
* Default is `start`.
|
|
1551
|
+
*/
|
|
1552
|
+
fieldName?: string;
|
|
1553
|
+
/** Sort order. */
|
|
1554
|
+
order?: SortOrder;
|
|
1555
|
+
}
|
|
1556
|
+
declare enum SortOrder {
|
|
1557
|
+
ASC = "ASC",
|
|
1558
|
+
DESC = "DESC"
|
|
1559
|
+
}
|
|
1560
|
+
/** TODO Diverge */
|
|
1561
|
+
interface CursorPaging$2 {
|
|
1562
|
+
/**
|
|
1563
|
+
* Number of events to return.
|
|
1564
|
+
* Defaults to `50`. Maximum `1000`.
|
|
1565
|
+
*/
|
|
1566
|
+
limit?: number | null;
|
|
1567
|
+
/**
|
|
1568
|
+
* Pointer to the next or previous page in the list of results.
|
|
1569
|
+
*
|
|
1570
|
+
* You can get the relevant cursor token
|
|
1571
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1572
|
+
* Not relevant for the first request.
|
|
1573
|
+
*/
|
|
1574
|
+
cursor?: string | null;
|
|
1575
|
+
}
|
|
1576
|
+
interface QueryEventsResponse {
|
|
1577
|
+
/** The events matching the provided query. */
|
|
1578
|
+
events?: Event[];
|
|
1579
|
+
/** Paging metadata. */
|
|
1580
|
+
pagingMetadata?: CursorPagingMetadata$2;
|
|
1581
|
+
}
|
|
1582
|
+
/** TODO Diverge */
|
|
1583
|
+
interface CursorPagingMetadata$2 {
|
|
1584
|
+
/** Number of items returned in the response. */
|
|
1585
|
+
count?: number | null;
|
|
1586
|
+
/** 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). */
|
|
1587
|
+
cursors?: Cursors$2;
|
|
1588
|
+
/**
|
|
1589
|
+
* Indicates if there are more results after the current page.
|
|
1590
|
+
* If `true`, another page of results can be retrieved.
|
|
1591
|
+
* If `false`, this is the last page.
|
|
1592
|
+
*/
|
|
1593
|
+
hasNext?: boolean | null;
|
|
1594
|
+
}
|
|
1595
|
+
interface Cursors$2 {
|
|
1596
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1597
|
+
next?: string | null;
|
|
1598
|
+
}
|
|
1599
|
+
interface CreateEventRequest {
|
|
1600
|
+
/** The event to create. */
|
|
1601
|
+
event: Event;
|
|
1602
|
+
/**
|
|
1603
|
+
* Optional time zone used to adjust the returned event time.
|
|
1604
|
+
* Default is the Wix Business time zone.
|
|
1605
|
+
*/
|
|
1606
|
+
timeZone?: string | null;
|
|
1607
|
+
/** Optional idempotency key to guarantee that the event is created at most once if the same request is issued multiple times. */
|
|
1608
|
+
idempotencyKey?: string | null;
|
|
1609
|
+
}
|
|
1610
|
+
interface CreateEventResponse {
|
|
1611
|
+
/** The created event. */
|
|
1612
|
+
event?: Event;
|
|
1613
|
+
}
|
|
1614
|
+
interface BulkCreateEventRequest {
|
|
1615
|
+
/** The events to create. */
|
|
1616
|
+
events: MaskedEvent[];
|
|
1617
|
+
/**
|
|
1618
|
+
* Whether to return the created events.
|
|
1619
|
+
* Default is false.
|
|
1620
|
+
*/
|
|
1621
|
+
returnEntity?: boolean | null;
|
|
1622
|
+
/**
|
|
1623
|
+
* Optional time zone used to adjust the returned events time.
|
|
1624
|
+
* Default is the Wix Business time zone.
|
|
1625
|
+
*/
|
|
1626
|
+
timeZone?: string | null;
|
|
1627
|
+
}
|
|
1628
|
+
interface MaskedEvent {
|
|
1629
|
+
/** The event to create. */
|
|
1630
|
+
event?: Event;
|
|
1631
|
+
}
|
|
1632
|
+
interface BulkCreateEventResponse {
|
|
1633
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1634
|
+
results?: BulkEventResult[];
|
|
1635
|
+
/** Total successes and failures. */
|
|
1636
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1637
|
+
}
|
|
1638
|
+
interface BulkEventResult {
|
|
1639
|
+
/** Whether the requested action was successful. */
|
|
1640
|
+
itemMetadata?: ItemMetadata;
|
|
1641
|
+
/** The event. */
|
|
1642
|
+
item?: Event;
|
|
1643
|
+
}
|
|
1644
|
+
interface ItemMetadata {
|
|
1645
|
+
/**
|
|
1646
|
+
* Event ID.
|
|
1647
|
+
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
1648
|
+
*/
|
|
1649
|
+
_id?: string | null;
|
|
1650
|
+
/** Index of the item within the request array, for correlation between request and response items. */
|
|
1651
|
+
originalIndex?: number;
|
|
1652
|
+
/**
|
|
1653
|
+
* Whether the requested action was successful for this event.
|
|
1654
|
+
* When `false`, the `error` field is populated.
|
|
1655
|
+
*/
|
|
1656
|
+
success?: boolean;
|
|
1657
|
+
/** Details about the error in case of failure. */
|
|
1658
|
+
error?: ApplicationError;
|
|
1659
|
+
}
|
|
1660
|
+
interface ApplicationError {
|
|
1661
|
+
/** Error code. */
|
|
1662
|
+
code?: string;
|
|
1663
|
+
/** Description of the error. */
|
|
1664
|
+
description?: string;
|
|
1665
|
+
/** Data related to the error. */
|
|
1666
|
+
data?: Record<string, any> | null;
|
|
1667
|
+
}
|
|
1668
|
+
interface BulkActionMetadata {
|
|
1669
|
+
/** Number of events that were successfully processed. */
|
|
1670
|
+
totalSuccesses?: number;
|
|
1671
|
+
/** Number of events that couldn't be processed. */
|
|
1672
|
+
totalFailures?: number;
|
|
1673
|
+
}
|
|
1674
|
+
interface UpdateEventRequest {
|
|
1675
|
+
/** The event to update. */
|
|
1676
|
+
event: Event;
|
|
1677
|
+
/** Whether to notify participants regarding the changes. */
|
|
1678
|
+
participantNotification?: ParticipantNotification$2;
|
|
1679
|
+
/**
|
|
1680
|
+
* Optional time zone used to adjust the returned event time.
|
|
1681
|
+
* Default is the Wix Business time zone.
|
|
1682
|
+
*/
|
|
1683
|
+
timeZone?: string | null;
|
|
1684
|
+
}
|
|
1685
|
+
interface ParticipantNotification$2 {
|
|
1686
|
+
/**
|
|
1687
|
+
* Whether to notify the participant/s about changes made to the schedule or event.
|
|
1688
|
+
* Default is false.
|
|
1689
|
+
*/
|
|
1690
|
+
notifyParticipants?: boolean | null;
|
|
1691
|
+
/** Optional custom message to send. */
|
|
1692
|
+
message?: string | null;
|
|
1693
|
+
}
|
|
1694
|
+
interface UpdateEventResponse {
|
|
1695
|
+
/** The updated event. */
|
|
1696
|
+
event?: Event;
|
|
1697
|
+
}
|
|
1698
|
+
interface BulkUpdateEventRequest {
|
|
1699
|
+
/** The events to update. */
|
|
1700
|
+
events: BulkUpdateEventRequestMaskedEvent[];
|
|
1701
|
+
/**
|
|
1702
|
+
* Whether to return the created events.
|
|
1703
|
+
* Default is false.
|
|
1704
|
+
*/
|
|
1705
|
+
returnEntity?: boolean | null;
|
|
1706
|
+
/** Whether to notify participants regarding the changes. */
|
|
1707
|
+
participantNotification?: ParticipantNotification$2;
|
|
1708
|
+
/**
|
|
1709
|
+
* Optional time zone used to adjust the returned events time.
|
|
1710
|
+
* Default is the Wix Business time zone.
|
|
1711
|
+
*/
|
|
1712
|
+
timeZone?: string | null;
|
|
1713
|
+
}
|
|
1714
|
+
interface BulkUpdateEventRequestMaskedEvent {
|
|
1715
|
+
/** The event to update. */
|
|
1716
|
+
event?: Event;
|
|
1717
|
+
}
|
|
1718
|
+
interface BulkUpdateEventResponse {
|
|
1719
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1720
|
+
results?: BulkEventResult[];
|
|
1721
|
+
/** Total successes and failures. */
|
|
1722
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1723
|
+
}
|
|
1724
|
+
interface RestoreEventDefaultsRequest {
|
|
1725
|
+
/** The ID of the event. */
|
|
1726
|
+
eventId: string | null;
|
|
1727
|
+
/** The fields for which to restore default values. */
|
|
1728
|
+
fields: Field[];
|
|
1729
|
+
/** Whether to notify participants regarding the changes. */
|
|
1730
|
+
participantNotification?: ParticipantNotification$2;
|
|
1731
|
+
/**
|
|
1732
|
+
* Optional time zone used to adjust the returned event time.
|
|
1733
|
+
* Default is the Wix Business time zone.
|
|
1734
|
+
*/
|
|
1735
|
+
timeZone?: string | null;
|
|
1736
|
+
}
|
|
1737
|
+
interface RestoreEventDefaultsResponse {
|
|
1738
|
+
/** The updated event. */
|
|
1739
|
+
event?: Event;
|
|
1740
|
+
}
|
|
1741
|
+
interface SplitRecurringEventRequest {
|
|
1742
|
+
/** The ID of the recurring event to split. */
|
|
1743
|
+
recurringEventId: string | null;
|
|
1744
|
+
/**
|
|
1745
|
+
* The ISO-8601 local date where the recurring event is to be split.
|
|
1746
|
+
* Must be a future date.
|
|
1747
|
+
* Must be between two instances of the recurring event.
|
|
1748
|
+
*/
|
|
1749
|
+
splitLocalDate: string | null;
|
|
1750
|
+
/**
|
|
1751
|
+
* The time zone, in IANA time zone format.
|
|
1752
|
+
* Default is the Wix Business time zone.
|
|
1753
|
+
*/
|
|
1754
|
+
timeZone?: string | null;
|
|
1755
|
+
}
|
|
1756
|
+
interface SplitRecurringEventResponse {
|
|
1757
|
+
/** The updated recurring event which set to end in the last instance before the split date. */
|
|
1758
|
+
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1759
|
+
/** The new recurring event which set to start from the next instance at or after the split date. */
|
|
1760
|
+
newRecurringEventStartingFromSplit?: Event;
|
|
1761
|
+
}
|
|
1762
|
+
interface CancelEventRequest {
|
|
1763
|
+
/** The ID of the event to cancel. */
|
|
1764
|
+
eventId: string | null;
|
|
1765
|
+
/** Whether to notify participants regarding the changes. */
|
|
1766
|
+
participantNotification?: ParticipantNotification$2;
|
|
1767
|
+
/**
|
|
1768
|
+
* Optional time zone used to adjust the returned event time.
|
|
1769
|
+
* Default is the Wix Business time zone.
|
|
1770
|
+
*/
|
|
1771
|
+
timeZone?: string | null;
|
|
1772
|
+
}
|
|
1773
|
+
interface CancelEventResponse {
|
|
1774
|
+
/** The cancelled event. */
|
|
1775
|
+
event?: Event;
|
|
1776
|
+
}
|
|
1777
|
+
interface BulkCancelEventRequest {
|
|
1778
|
+
/** The IDs of the events to cancel. */
|
|
1779
|
+
eventIds: string[];
|
|
1780
|
+
/**
|
|
1781
|
+
* Whether to return the cancelled events.
|
|
1782
|
+
* Default is false.
|
|
1783
|
+
*/
|
|
1784
|
+
returnEntity?: boolean | null;
|
|
1785
|
+
/** Whether to notify participants regarding the changes. */
|
|
1786
|
+
participantNotification?: ParticipantNotification$2;
|
|
1787
|
+
/**
|
|
1788
|
+
* Optional time zone used to adjust the returned events time.
|
|
1789
|
+
* Default is the Wix Business time zone.
|
|
1790
|
+
*/
|
|
1791
|
+
timeZone?: string | null;
|
|
1792
|
+
}
|
|
1793
|
+
interface BulkCancelEventResponse {
|
|
1794
|
+
/** The result for each event, containing the event and whether the action was successful. */
|
|
1795
|
+
results?: BulkEventResult[];
|
|
1796
|
+
/** Total successes and failures. */
|
|
1797
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1798
|
+
}
|
|
1799
|
+
interface ListEventsByContactIdRequest {
|
|
1800
|
+
/**
|
|
1801
|
+
* The ID of the contact participating in the events.
|
|
1802
|
+
* Required, unless `cursorPaging` is provided.
|
|
1803
|
+
*/
|
|
1804
|
+
contactId: string | null;
|
|
1805
|
+
/**
|
|
1806
|
+
* Local start date for which events are returned, in ISO-8601 format.
|
|
1807
|
+
* E.g, `2024-01-01T00:00:00`.
|
|
1808
|
+
*
|
|
1809
|
+
* Required, unless `cursorPaging` is provided.
|
|
1810
|
+
*/
|
|
1811
|
+
fromLocalDate?: string | null;
|
|
1812
|
+
/**
|
|
1813
|
+
* Local end date for which events are returned, in ISO-8601 format.
|
|
1814
|
+
* E.g, `2024-01-7T00:00:00`.
|
|
1815
|
+
*
|
|
1816
|
+
* Required, unless `cursorPaging` is provided.
|
|
1817
|
+
* Max: 1 year after `fromLocalDate`.
|
|
1818
|
+
*/
|
|
1819
|
+
toLocalDate?: string | null;
|
|
1820
|
+
/**
|
|
1821
|
+
* The time zone, in IANA time zone format.
|
|
1822
|
+
* Default is the Wix Business time zone.
|
|
1823
|
+
*/
|
|
1824
|
+
timeZone?: string | null;
|
|
1825
|
+
/** Optional Wix app ID to filter events by. */
|
|
1826
|
+
appId?: string | null;
|
|
1827
|
+
/** Optional cursor to the next events page. */
|
|
1828
|
+
cursorPaging?: CommonCursorPaging;
|
|
1829
|
+
}
|
|
1830
|
+
/** TODO Diverge */
|
|
1831
|
+
interface CommonCursorPaging {
|
|
1832
|
+
/**
|
|
1833
|
+
* Number of events to return.
|
|
1834
|
+
* Defaults to `50`. Maximum `100`.
|
|
1835
|
+
*/
|
|
1836
|
+
limit?: number | null;
|
|
1837
|
+
/**
|
|
1838
|
+
* Pointer to the next or previous page in the list of results.
|
|
1839
|
+
*
|
|
1840
|
+
* You can get the relevant cursor token
|
|
1841
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1842
|
+
* Not relevant for the first request.
|
|
1843
|
+
*/
|
|
1844
|
+
cursor?: string | null;
|
|
1845
|
+
}
|
|
1846
|
+
interface ListEventsByContactIdResponse {
|
|
1847
|
+
/** The participant events. */
|
|
1848
|
+
events?: Event[];
|
|
1849
|
+
/** Paging metadata. */
|
|
1850
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1851
|
+
}
|
|
1852
|
+
/** TODO Diverge */
|
|
1853
|
+
interface CommonCursorPagingMetadata {
|
|
1854
|
+
/** Number of items returned in the response. */
|
|
1855
|
+
count?: number | null;
|
|
1856
|
+
/** 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). */
|
|
1857
|
+
cursors?: CommonCursors;
|
|
1858
|
+
/**
|
|
1859
|
+
* Indicates if there are more results after the current page.
|
|
1860
|
+
* If `true`, another page of results can be retrieved.
|
|
1861
|
+
* If `false`, this is the last page.
|
|
1862
|
+
*/
|
|
1863
|
+
hasNext?: boolean | null;
|
|
1864
|
+
}
|
|
1865
|
+
interface CommonCursors {
|
|
1866
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1867
|
+
next?: string | null;
|
|
1868
|
+
}
|
|
1869
|
+
interface ListEventsByMemberIdRequest {
|
|
1870
|
+
/**
|
|
1871
|
+
* The ID of the member participating in the events.
|
|
1872
|
+
*
|
|
1873
|
+
* Can be `me` for the currently logged-in member ID.
|
|
1874
|
+
* To retrieve other member events the `CALENDAR.EVENT_READ_PI` permission is required.
|
|
1875
|
+
*
|
|
1876
|
+
* Required, unless `cursorPaging` is provided.
|
|
1877
|
+
*/
|
|
1878
|
+
memberId: string | null;
|
|
1879
|
+
/**
|
|
1880
|
+
* Local start date for which events are returned, in ISO-8601 format.
|
|
1881
|
+
* E.g, `2024-01-01T00:00:00`.
|
|
1882
|
+
*
|
|
1883
|
+
* Required, unless `cursorPaging` or `eventIds` are provided.
|
|
1884
|
+
*/
|
|
1885
|
+
fromLocalDate?: string | null;
|
|
1886
|
+
/**
|
|
1887
|
+
* Local end date for which events are returned, in ISO-8601 format.
|
|
1888
|
+
* E.g, `2024-01-7T00:00:00`.
|
|
1889
|
+
*
|
|
1890
|
+
* Required, unless `cursorPaging` or `eventIds` are provided.
|
|
1891
|
+
* Max: 1 year after `fromLocalDate`.
|
|
1892
|
+
*/
|
|
1893
|
+
toLocalDate?: string | null;
|
|
1894
|
+
/**
|
|
1895
|
+
* The time zone, in IANA time zone format.
|
|
1896
|
+
* Default is the Wix Business time zone.
|
|
1897
|
+
*/
|
|
1898
|
+
timeZone?: string | null;
|
|
1899
|
+
/** Optional Wix app ID to filter events by. */
|
|
1900
|
+
appId?: string | null;
|
|
1901
|
+
/** Optional cursor to the next events page. */
|
|
1902
|
+
cursorPaging?: CommonCursorPaging;
|
|
1903
|
+
/**
|
|
1904
|
+
* Optional event IDs to filter events by.
|
|
1905
|
+
* If provided, other filters are ignored.
|
|
1906
|
+
*/
|
|
1907
|
+
eventIds?: string[];
|
|
1908
|
+
}
|
|
1909
|
+
interface ListEventsByMemberIdResponse {
|
|
1910
|
+
/** The participant events. */
|
|
1911
|
+
events?: Event[];
|
|
1912
|
+
/** Paging metadata. */
|
|
1913
|
+
pagingMetadata?: CommonCursorPagingMetadata;
|
|
1914
|
+
}
|
|
1915
|
+
interface RecurrenceRuleNonNullableFields {
|
|
1916
|
+
frequency: Frequency;
|
|
1917
|
+
days: Day[];
|
|
1918
|
+
}
|
|
1919
|
+
interface LocationNonNullableFields$2 {
|
|
1920
|
+
type: LocationType$2;
|
|
1921
|
+
}
|
|
1922
|
+
interface ResourceNonNullableFields {
|
|
1923
|
+
transparency: Transparency;
|
|
1924
|
+
permissionRole: Role$2;
|
|
1925
|
+
}
|
|
1926
|
+
interface ParticipantsNonNullableFields {
|
|
1927
|
+
status: ParticipantsStatus;
|
|
1928
|
+
}
|
|
1929
|
+
interface ConferencingDetailsNonNullableFields$2 {
|
|
1930
|
+
type: Type$2;
|
|
1931
|
+
}
|
|
1932
|
+
interface CommonIdentificationDataNonNullableFields$2 {
|
|
1933
|
+
wixUserId: string;
|
|
1934
|
+
identityType: IdentityType$2;
|
|
1935
|
+
}
|
|
1936
|
+
interface PermissionNonNullableFields$2 {
|
|
1937
|
+
identity?: CommonIdentificationDataNonNullableFields$2;
|
|
1938
|
+
role: Role$2;
|
|
1939
|
+
}
|
|
1940
|
+
interface EventNonNullableFields {
|
|
1941
|
+
status: Status$4;
|
|
1942
|
+
recurrenceType: RecurrenceType;
|
|
1943
|
+
recurrenceRule?: RecurrenceRuleNonNullableFields;
|
|
1944
|
+
transparency: Transparency;
|
|
1945
|
+
location?: LocationNonNullableFields$2;
|
|
1946
|
+
resources: ResourceNonNullableFields[];
|
|
1947
|
+
participants?: ParticipantsNonNullableFields;
|
|
1948
|
+
conferencingDetails?: ConferencingDetailsNonNullableFields$2;
|
|
1949
|
+
inheritedFields: Field[];
|
|
1950
|
+
permissions: PermissionNonNullableFields$2[];
|
|
1951
|
+
}
|
|
1952
|
+
interface GetEventResponseNonNullableFields {
|
|
1953
|
+
event?: EventNonNullableFields;
|
|
1954
|
+
}
|
|
1955
|
+
interface ListEventsResponseNonNullableFields {
|
|
1956
|
+
events: EventNonNullableFields[];
|
|
1957
|
+
}
|
|
1958
|
+
interface QueryEventsResponseNonNullableFields {
|
|
1959
|
+
events: EventNonNullableFields[];
|
|
1960
|
+
}
|
|
1961
|
+
interface CreateEventResponseNonNullableFields {
|
|
1962
|
+
event?: EventNonNullableFields;
|
|
1963
|
+
}
|
|
1964
|
+
interface ApplicationErrorNonNullableFields {
|
|
1965
|
+
code: string;
|
|
1966
|
+
description: string;
|
|
1967
|
+
}
|
|
1968
|
+
interface ItemMetadataNonNullableFields {
|
|
1969
|
+
originalIndex: number;
|
|
1970
|
+
success: boolean;
|
|
1971
|
+
error?: ApplicationErrorNonNullableFields;
|
|
1972
|
+
}
|
|
1973
|
+
interface BulkEventResultNonNullableFields {
|
|
1974
|
+
itemMetadata?: ItemMetadataNonNullableFields;
|
|
1975
|
+
item?: EventNonNullableFields;
|
|
1976
|
+
}
|
|
1977
|
+
interface BulkActionMetadataNonNullableFields {
|
|
1978
|
+
totalSuccesses: number;
|
|
1979
|
+
totalFailures: number;
|
|
1980
|
+
}
|
|
1981
|
+
interface BulkCreateEventResponseNonNullableFields {
|
|
1982
|
+
results: BulkEventResultNonNullableFields[];
|
|
1983
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
1984
|
+
}
|
|
1985
|
+
interface UpdateEventResponseNonNullableFields {
|
|
1986
|
+
event?: EventNonNullableFields;
|
|
1987
|
+
}
|
|
1988
|
+
interface BulkUpdateEventResponseNonNullableFields {
|
|
1989
|
+
results: BulkEventResultNonNullableFields[];
|
|
1990
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
1991
|
+
}
|
|
1992
|
+
interface RestoreEventDefaultsResponseNonNullableFields {
|
|
1993
|
+
event?: EventNonNullableFields;
|
|
1994
|
+
}
|
|
1995
|
+
interface SplitRecurringEventResponseNonNullableFields {
|
|
1996
|
+
updatedRecurringEventEndingBeforeSplit?: EventNonNullableFields;
|
|
1997
|
+
newRecurringEventStartingFromSplit?: EventNonNullableFields;
|
|
1998
|
+
}
|
|
1999
|
+
interface CancelEventResponseNonNullableFields {
|
|
2000
|
+
event?: EventNonNullableFields;
|
|
2001
|
+
}
|
|
2002
|
+
interface BulkCancelEventResponseNonNullableFields {
|
|
2003
|
+
results: BulkEventResultNonNullableFields[];
|
|
2004
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
2005
|
+
}
|
|
2006
|
+
interface ListEventsByContactIdResponseNonNullableFields {
|
|
2007
|
+
events: EventNonNullableFields[];
|
|
2008
|
+
}
|
|
2009
|
+
interface ListEventsByMemberIdResponseNonNullableFields {
|
|
2010
|
+
events: EventNonNullableFields[];
|
|
2011
|
+
}
|
|
2012
|
+
|
|
2013
|
+
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2014
|
+
getUrl: (context: any) => string;
|
|
2015
|
+
httpMethod: K;
|
|
2016
|
+
path: string;
|
|
2017
|
+
pathParams: M;
|
|
2018
|
+
__requestType: T;
|
|
2019
|
+
__originalRequestType: S;
|
|
2020
|
+
__responseType: Q;
|
|
2021
|
+
__originalResponseType: R;
|
|
2022
|
+
};
|
|
2023
|
+
declare function getEvent(): __PublicMethodMetaInfo$2<'GET', {
|
|
2024
|
+
eventId: string;
|
|
2025
|
+
}, GetEventRequest, GetEventRequest$1, GetEventResponse & GetEventResponseNonNullableFields, GetEventResponse$1 & GetEventResponseNonNullableFields$1>;
|
|
2026
|
+
declare function listEvents(): __PublicMethodMetaInfo$2<'GET', {}, ListEventsRequest, ListEventsRequest$1, ListEventsResponse & ListEventsResponseNonNullableFields, ListEventsResponse$1 & ListEventsResponseNonNullableFields$1>;
|
|
2027
|
+
declare function queryEvents(): __PublicMethodMetaInfo$2<'POST', {}, QueryEventsRequest, QueryEventsRequest$1, QueryEventsResponse & QueryEventsResponseNonNullableFields, QueryEventsResponse$1 & QueryEventsResponseNonNullableFields$1>;
|
|
2028
|
+
declare function createEvent(): __PublicMethodMetaInfo$2<'POST', {}, CreateEventRequest, CreateEventRequest$1, CreateEventResponse & CreateEventResponseNonNullableFields, CreateEventResponse$1 & CreateEventResponseNonNullableFields$1>;
|
|
2029
|
+
declare function bulkCreateEvent(): __PublicMethodMetaInfo$2<'POST', {}, BulkCreateEventRequest, BulkCreateEventRequest$1, BulkCreateEventResponse & BulkCreateEventResponseNonNullableFields, BulkCreateEventResponse$1 & BulkCreateEventResponseNonNullableFields$1>;
|
|
2030
|
+
declare function updateEvent(): __PublicMethodMetaInfo$2<'PATCH', {
|
|
2031
|
+
eventId: string;
|
|
2032
|
+
}, UpdateEventRequest, UpdateEventRequest$1, UpdateEventResponse & UpdateEventResponseNonNullableFields, UpdateEventResponse$1 & UpdateEventResponseNonNullableFields$1>;
|
|
2033
|
+
declare function bulkUpdateEvent(): __PublicMethodMetaInfo$2<'POST', {}, BulkUpdateEventRequest, BulkUpdateEventRequest$1, BulkUpdateEventResponse & BulkUpdateEventResponseNonNullableFields, BulkUpdateEventResponse$1 & BulkUpdateEventResponseNonNullableFields$1>;
|
|
2034
|
+
declare function restoreEventDefaults(): __PublicMethodMetaInfo$2<'POST', {
|
|
2035
|
+
eventId: string;
|
|
2036
|
+
}, RestoreEventDefaultsRequest, RestoreEventDefaultsRequest$1, RestoreEventDefaultsResponse & RestoreEventDefaultsResponseNonNullableFields, RestoreEventDefaultsResponse$1 & RestoreEventDefaultsResponseNonNullableFields$1>;
|
|
2037
|
+
declare function splitRecurringEvent(): __PublicMethodMetaInfo$2<'POST', {
|
|
2038
|
+
recurringEventId: string;
|
|
2039
|
+
}, SplitRecurringEventRequest, SplitRecurringEventRequest$1, SplitRecurringEventResponse & SplitRecurringEventResponseNonNullableFields, SplitRecurringEventResponse$1 & SplitRecurringEventResponseNonNullableFields$1>;
|
|
2040
|
+
declare function cancelEvent(): __PublicMethodMetaInfo$2<'POST', {
|
|
2041
|
+
eventId: string;
|
|
2042
|
+
}, CancelEventRequest, CancelEventRequest$1, CancelEventResponse & CancelEventResponseNonNullableFields, CancelEventResponse$1 & CancelEventResponseNonNullableFields$1>;
|
|
2043
|
+
declare function bulkCancelEvent(): __PublicMethodMetaInfo$2<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
|
|
2044
|
+
declare function listEventsByContactId(): __PublicMethodMetaInfo$2<'GET', {
|
|
2045
|
+
contactId: string;
|
|
2046
|
+
}, ListEventsByContactIdRequest, ListEventsByContactIdRequest$1, ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields, ListEventsByContactIdResponse$1 & ListEventsByContactIdResponseNonNullableFields$1>;
|
|
2047
|
+
declare function listEventsByMemberId(): __PublicMethodMetaInfo$2<'GET', {
|
|
2048
|
+
memberId: string;
|
|
2049
|
+
}, ListEventsByMemberIdRequest, ListEventsByMemberIdRequest$1, ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields, ListEventsByMemberIdResponse$1 & ListEventsByMemberIdResponseNonNullableFields$1>;
|
|
2050
|
+
|
|
2051
|
+
declare const meta$2_bulkCancelEvent: typeof bulkCancelEvent;
|
|
2052
|
+
declare const meta$2_bulkCreateEvent: typeof bulkCreateEvent;
|
|
2053
|
+
declare const meta$2_bulkUpdateEvent: typeof bulkUpdateEvent;
|
|
2054
|
+
declare const meta$2_cancelEvent: typeof cancelEvent;
|
|
2055
|
+
declare const meta$2_createEvent: typeof createEvent;
|
|
2056
|
+
declare const meta$2_getEvent: typeof getEvent;
|
|
2057
|
+
declare const meta$2_listEvents: typeof listEvents;
|
|
2058
|
+
declare const meta$2_listEventsByContactId: typeof listEventsByContactId;
|
|
2059
|
+
declare const meta$2_listEventsByMemberId: typeof listEventsByMemberId;
|
|
2060
|
+
declare const meta$2_queryEvents: typeof queryEvents;
|
|
2061
|
+
declare const meta$2_restoreEventDefaults: typeof restoreEventDefaults;
|
|
2062
|
+
declare const meta$2_splitRecurringEvent: typeof splitRecurringEvent;
|
|
2063
|
+
declare const meta$2_updateEvent: typeof updateEvent;
|
|
2064
|
+
declare namespace meta$2 {
|
|
2065
|
+
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkCancelEvent as bulkCancelEvent, meta$2_bulkCreateEvent as bulkCreateEvent, meta$2_bulkUpdateEvent as bulkUpdateEvent, meta$2_cancelEvent as cancelEvent, meta$2_createEvent as createEvent, meta$2_getEvent as getEvent, meta$2_listEvents as listEvents, meta$2_listEventsByContactId as listEventsByContactId, meta$2_listEventsByMemberId as listEventsByMemberId, meta$2_queryEvents as queryEvents, meta$2_restoreEventDefaults as restoreEventDefaults, meta$2_splitRecurringEvent as splitRecurringEvent, meta$2_updateEvent as updateEvent };
|
|
2066
|
+
}
|
|
2067
|
+
|
|
1
2068
|
interface Schedule$1 {
|
|
2
2069
|
/**
|
|
3
2070
|
* The schedule ID.
|
|
@@ -24,7 +2091,7 @@ interface Schedule$1 {
|
|
|
24
2091
|
* - `"CANCELLED"` Schedule has been cancelled.
|
|
25
2092
|
* @readonly
|
|
26
2093
|
*/
|
|
27
|
-
status?: Status$
|
|
2094
|
+
status?: Status$3;
|
|
28
2095
|
/**
|
|
29
2096
|
* The schedule time zone, formatted according to the IANA time zone format.
|
|
30
2097
|
* Must be a regional time zone (Area/Location) or UTC.
|
|
@@ -82,7 +2149,7 @@ interface Schedule$1 {
|
|
|
82
2149
|
*/
|
|
83
2150
|
updatedDate?: Date;
|
|
84
2151
|
}
|
|
85
|
-
declare enum Status$
|
|
2152
|
+
declare enum Status$3 {
|
|
86
2153
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
87
2154
|
/** Schedule is active. Default value. */
|
|
88
2155
|
ACTIVE = "ACTIVE",
|
|
@@ -160,7 +2227,7 @@ interface CommonIdentificationDataIdOneOf$1 {
|
|
|
160
2227
|
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
161
2228
|
wixUserId?: string;
|
|
162
2229
|
}
|
|
163
|
-
declare enum IdentityType {
|
|
2230
|
+
declare enum IdentityType$1 {
|
|
164
2231
|
UNKNOWN = "UNKNOWN",
|
|
165
2232
|
WIX_USER = "WIX_USER"
|
|
166
2233
|
}
|
|
@@ -326,113 +2393,43 @@ interface CancelScheduleResponse$1 {
|
|
|
326
2393
|
/** The cancelled schedule. */
|
|
327
2394
|
schedule?: Schedule$1;
|
|
328
2395
|
}
|
|
2396
|
+
interface LocationNonNullableFields$1 {
|
|
2397
|
+
type: LocationType$1;
|
|
2398
|
+
}
|
|
2399
|
+
interface ConferencingDetailsNonNullableFields$1 {
|
|
2400
|
+
type: Type$1;
|
|
2401
|
+
}
|
|
2402
|
+
interface CommonIdentificationDataNonNullableFields$1 {
|
|
2403
|
+
wixUserId: string;
|
|
2404
|
+
identityType: IdentityType$1;
|
|
2405
|
+
}
|
|
2406
|
+
interface PermissionNonNullableFields$1 {
|
|
2407
|
+
identity?: CommonIdentificationDataNonNullableFields$1;
|
|
2408
|
+
role: Role$1;
|
|
2409
|
+
}
|
|
2410
|
+
interface ScheduleNonNullableFields$1 {
|
|
2411
|
+
status: Status$3;
|
|
2412
|
+
defaultLocation?: LocationNonNullableFields$1;
|
|
2413
|
+
defaultConferencingDetails?: ConferencingDetailsNonNullableFields$1;
|
|
2414
|
+
permissions: PermissionNonNullableFields$1[];
|
|
2415
|
+
}
|
|
329
2416
|
interface GetScheduleResponseNonNullableFields$1 {
|
|
330
|
-
schedule?:
|
|
331
|
-
status: Status$1;
|
|
332
|
-
defaultLocation?: {
|
|
333
|
-
type: LocationType$1;
|
|
334
|
-
};
|
|
335
|
-
defaultConferencingDetails?: {
|
|
336
|
-
type: Type$1;
|
|
337
|
-
};
|
|
338
|
-
permissions: {
|
|
339
|
-
identity?: {
|
|
340
|
-
wixUserId: string;
|
|
341
|
-
identityType: IdentityType;
|
|
342
|
-
};
|
|
343
|
-
role: Role$1;
|
|
344
|
-
}[];
|
|
345
|
-
};
|
|
2417
|
+
schedule?: ScheduleNonNullableFields$1;
|
|
346
2418
|
}
|
|
347
2419
|
interface QuerySchedulesResponseNonNullableFields$1 {
|
|
348
|
-
schedules:
|
|
349
|
-
status: Status$1;
|
|
350
|
-
defaultLocation?: {
|
|
351
|
-
type: LocationType$1;
|
|
352
|
-
};
|
|
353
|
-
defaultConferencingDetails?: {
|
|
354
|
-
type: Type$1;
|
|
355
|
-
};
|
|
356
|
-
permissions: {
|
|
357
|
-
identity?: {
|
|
358
|
-
wixUserId: string;
|
|
359
|
-
identityType: IdentityType;
|
|
360
|
-
};
|
|
361
|
-
role: Role$1;
|
|
362
|
-
}[];
|
|
363
|
-
}[];
|
|
2420
|
+
schedules: ScheduleNonNullableFields$1[];
|
|
364
2421
|
}
|
|
365
2422
|
interface CreateScheduleResponseNonNullableFields$1 {
|
|
366
|
-
schedule?:
|
|
367
|
-
status: Status$1;
|
|
368
|
-
defaultLocation?: {
|
|
369
|
-
type: LocationType$1;
|
|
370
|
-
};
|
|
371
|
-
defaultConferencingDetails?: {
|
|
372
|
-
type: Type$1;
|
|
373
|
-
};
|
|
374
|
-
permissions: {
|
|
375
|
-
identity?: {
|
|
376
|
-
wixUserId: string;
|
|
377
|
-
identityType: IdentityType;
|
|
378
|
-
};
|
|
379
|
-
role: Role$1;
|
|
380
|
-
}[];
|
|
381
|
-
};
|
|
2423
|
+
schedule?: ScheduleNonNullableFields$1;
|
|
382
2424
|
}
|
|
383
2425
|
interface UpdateScheduleResponseNonNullableFields$1 {
|
|
384
|
-
schedule?:
|
|
385
|
-
status: Status$1;
|
|
386
|
-
defaultLocation?: {
|
|
387
|
-
type: LocationType$1;
|
|
388
|
-
};
|
|
389
|
-
defaultConferencingDetails?: {
|
|
390
|
-
type: Type$1;
|
|
391
|
-
};
|
|
392
|
-
permissions: {
|
|
393
|
-
identity?: {
|
|
394
|
-
wixUserId: string;
|
|
395
|
-
identityType: IdentityType;
|
|
396
|
-
};
|
|
397
|
-
role: Role$1;
|
|
398
|
-
}[];
|
|
399
|
-
};
|
|
2426
|
+
schedule?: ScheduleNonNullableFields$1;
|
|
400
2427
|
}
|
|
401
2428
|
interface CloneScheduleResponseNonNullableFields$1 {
|
|
402
|
-
schedule?:
|
|
403
|
-
status: Status$1;
|
|
404
|
-
defaultLocation?: {
|
|
405
|
-
type: LocationType$1;
|
|
406
|
-
};
|
|
407
|
-
defaultConferencingDetails?: {
|
|
408
|
-
type: Type$1;
|
|
409
|
-
};
|
|
410
|
-
permissions: {
|
|
411
|
-
identity?: {
|
|
412
|
-
wixUserId: string;
|
|
413
|
-
identityType: IdentityType;
|
|
414
|
-
};
|
|
415
|
-
role: Role$1;
|
|
416
|
-
}[];
|
|
417
|
-
};
|
|
2429
|
+
schedule?: ScheduleNonNullableFields$1;
|
|
418
2430
|
}
|
|
419
2431
|
interface CancelScheduleResponseNonNullableFields$1 {
|
|
420
|
-
schedule?:
|
|
421
|
-
status: Status$1;
|
|
422
|
-
defaultLocation?: {
|
|
423
|
-
type: LocationType$1;
|
|
424
|
-
};
|
|
425
|
-
defaultConferencingDetails?: {
|
|
426
|
-
type: Type$1;
|
|
427
|
-
};
|
|
428
|
-
permissions: {
|
|
429
|
-
identity?: {
|
|
430
|
-
wixUserId: string;
|
|
431
|
-
identityType: IdentityType;
|
|
432
|
-
};
|
|
433
|
-
role: Role$1;
|
|
434
|
-
}[];
|
|
435
|
-
};
|
|
2432
|
+
schedule?: ScheduleNonNullableFields$1;
|
|
436
2433
|
}
|
|
437
2434
|
|
|
438
2435
|
interface Schedule {
|
|
@@ -461,7 +2458,7 @@ interface Schedule {
|
|
|
461
2458
|
* - `"CANCELLED"` Schedule has been cancelled.
|
|
462
2459
|
* @readonly
|
|
463
2460
|
*/
|
|
464
|
-
status?: Status;
|
|
2461
|
+
status?: Status$2;
|
|
465
2462
|
/**
|
|
466
2463
|
* The schedule time zone, formatted according to the IANA time zone format.
|
|
467
2464
|
* Must be a regional time zone (Area/Location) or UTC.
|
|
@@ -519,7 +2516,7 @@ interface Schedule {
|
|
|
519
2516
|
*/
|
|
520
2517
|
_updatedDate?: Date;
|
|
521
2518
|
}
|
|
522
|
-
declare enum Status {
|
|
2519
|
+
declare enum Status$2 {
|
|
523
2520
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
524
2521
|
/** Schedule is active. Default value. */
|
|
525
2522
|
ACTIVE = "ACTIVE",
|
|
@@ -597,6 +2594,10 @@ interface CommonIdentificationDataIdOneOf {
|
|
|
597
2594
|
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
598
2595
|
wixUserId?: string;
|
|
599
2596
|
}
|
|
2597
|
+
declare enum IdentityType {
|
|
2598
|
+
UNKNOWN = "UNKNOWN",
|
|
2599
|
+
WIX_USER = "WIX_USER"
|
|
2600
|
+
}
|
|
600
2601
|
declare enum Role {
|
|
601
2602
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
602
2603
|
/** Role grants full write and read access. */
|
|
@@ -759,110 +2760,46 @@ interface CancelScheduleResponse {
|
|
|
759
2760
|
/** The cancelled schedule. */
|
|
760
2761
|
schedule?: Schedule;
|
|
761
2762
|
}
|
|
2763
|
+
interface LocationNonNullableFields {
|
|
2764
|
+
type: LocationType;
|
|
2765
|
+
}
|
|
2766
|
+
interface ConferencingDetailsNonNullableFields {
|
|
2767
|
+
type: Type;
|
|
2768
|
+
}
|
|
2769
|
+
interface CommonIdentificationDataNonNullableFields {
|
|
2770
|
+
wixUserId: string;
|
|
2771
|
+
identityType: IdentityType;
|
|
2772
|
+
}
|
|
2773
|
+
interface PermissionNonNullableFields {
|
|
2774
|
+
identity?: CommonIdentificationDataNonNullableFields;
|
|
2775
|
+
role: Role;
|
|
2776
|
+
}
|
|
2777
|
+
interface ScheduleNonNullableFields {
|
|
2778
|
+
status: Status$2;
|
|
2779
|
+
defaultLocation?: LocationNonNullableFields;
|
|
2780
|
+
defaultConferencingDetails?: ConferencingDetailsNonNullableFields;
|
|
2781
|
+
permissions: PermissionNonNullableFields[];
|
|
2782
|
+
}
|
|
762
2783
|
interface GetScheduleResponseNonNullableFields {
|
|
763
|
-
schedule?:
|
|
764
|
-
status: Status;
|
|
765
|
-
defaultLocation?: {
|
|
766
|
-
type: LocationType;
|
|
767
|
-
};
|
|
768
|
-
defaultConferencingDetails?: {
|
|
769
|
-
type: Type;
|
|
770
|
-
};
|
|
771
|
-
permissions: {
|
|
772
|
-
identity?: {
|
|
773
|
-
wixUserId: string;
|
|
774
|
-
};
|
|
775
|
-
role: Role;
|
|
776
|
-
}[];
|
|
777
|
-
};
|
|
2784
|
+
schedule?: ScheduleNonNullableFields;
|
|
778
2785
|
}
|
|
779
2786
|
interface QuerySchedulesResponseNonNullableFields {
|
|
780
|
-
schedules:
|
|
781
|
-
status: Status;
|
|
782
|
-
defaultLocation?: {
|
|
783
|
-
type: LocationType;
|
|
784
|
-
};
|
|
785
|
-
defaultConferencingDetails?: {
|
|
786
|
-
type: Type;
|
|
787
|
-
};
|
|
788
|
-
permissions: {
|
|
789
|
-
identity?: {
|
|
790
|
-
wixUserId: string;
|
|
791
|
-
};
|
|
792
|
-
role: Role;
|
|
793
|
-
}[];
|
|
794
|
-
}[];
|
|
2787
|
+
schedules: ScheduleNonNullableFields[];
|
|
795
2788
|
}
|
|
796
2789
|
interface CreateScheduleResponseNonNullableFields {
|
|
797
|
-
schedule?:
|
|
798
|
-
status: Status;
|
|
799
|
-
defaultLocation?: {
|
|
800
|
-
type: LocationType;
|
|
801
|
-
};
|
|
802
|
-
defaultConferencingDetails?: {
|
|
803
|
-
type: Type;
|
|
804
|
-
};
|
|
805
|
-
permissions: {
|
|
806
|
-
identity?: {
|
|
807
|
-
wixUserId: string;
|
|
808
|
-
};
|
|
809
|
-
role: Role;
|
|
810
|
-
}[];
|
|
811
|
-
};
|
|
2790
|
+
schedule?: ScheduleNonNullableFields;
|
|
812
2791
|
}
|
|
813
2792
|
interface UpdateScheduleResponseNonNullableFields {
|
|
814
|
-
schedule?:
|
|
815
|
-
status: Status;
|
|
816
|
-
defaultLocation?: {
|
|
817
|
-
type: LocationType;
|
|
818
|
-
};
|
|
819
|
-
defaultConferencingDetails?: {
|
|
820
|
-
type: Type;
|
|
821
|
-
};
|
|
822
|
-
permissions: {
|
|
823
|
-
identity?: {
|
|
824
|
-
wixUserId: string;
|
|
825
|
-
};
|
|
826
|
-
role: Role;
|
|
827
|
-
}[];
|
|
828
|
-
};
|
|
2793
|
+
schedule?: ScheduleNonNullableFields;
|
|
829
2794
|
}
|
|
830
2795
|
interface CloneScheduleResponseNonNullableFields {
|
|
831
|
-
schedule?:
|
|
832
|
-
status: Status;
|
|
833
|
-
defaultLocation?: {
|
|
834
|
-
type: LocationType;
|
|
835
|
-
};
|
|
836
|
-
defaultConferencingDetails?: {
|
|
837
|
-
type: Type;
|
|
838
|
-
};
|
|
839
|
-
permissions: {
|
|
840
|
-
identity?: {
|
|
841
|
-
wixUserId: string;
|
|
842
|
-
};
|
|
843
|
-
role: Role;
|
|
844
|
-
}[];
|
|
845
|
-
};
|
|
2796
|
+
schedule?: ScheduleNonNullableFields;
|
|
846
2797
|
}
|
|
847
2798
|
interface CancelScheduleResponseNonNullableFields {
|
|
848
|
-
schedule?:
|
|
849
|
-
status: Status;
|
|
850
|
-
defaultLocation?: {
|
|
851
|
-
type: LocationType;
|
|
852
|
-
};
|
|
853
|
-
defaultConferencingDetails?: {
|
|
854
|
-
type: Type;
|
|
855
|
-
};
|
|
856
|
-
permissions: {
|
|
857
|
-
identity?: {
|
|
858
|
-
wixUserId: string;
|
|
859
|
-
};
|
|
860
|
-
role: Role;
|
|
861
|
-
}[];
|
|
862
|
-
};
|
|
2799
|
+
schedule?: ScheduleNonNullableFields;
|
|
863
2800
|
}
|
|
864
2801
|
|
|
865
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2802
|
+
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
866
2803
|
getUrl: (context: any) => string;
|
|
867
2804
|
httpMethod: K;
|
|
868
2805
|
path: string;
|
|
@@ -872,30 +2809,267 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
872
2809
|
__responseType: Q;
|
|
873
2810
|
__originalResponseType: R;
|
|
874
2811
|
};
|
|
875
|
-
declare function getSchedule(): __PublicMethodMetaInfo<'GET', {
|
|
2812
|
+
declare function getSchedule(): __PublicMethodMetaInfo$1<'GET', {
|
|
876
2813
|
scheduleId: string;
|
|
877
2814
|
}, GetScheduleRequest, GetScheduleRequest$1, GetScheduleResponse & GetScheduleResponseNonNullableFields, GetScheduleResponse$1 & GetScheduleResponseNonNullableFields$1>;
|
|
878
|
-
declare function querySchedules(): __PublicMethodMetaInfo<'POST', {}, QuerySchedulesRequest, QuerySchedulesRequest$1, QuerySchedulesResponse & QuerySchedulesResponseNonNullableFields, QuerySchedulesResponse$1 & QuerySchedulesResponseNonNullableFields$1>;
|
|
879
|
-
declare function createSchedule(): __PublicMethodMetaInfo<'POST', {}, CreateScheduleRequest, CreateScheduleRequest$1, CreateScheduleResponse & CreateScheduleResponseNonNullableFields, CreateScheduleResponse$1 & CreateScheduleResponseNonNullableFields$1>;
|
|
880
|
-
declare function updateSchedule(): __PublicMethodMetaInfo<'PATCH', {
|
|
2815
|
+
declare function querySchedules(): __PublicMethodMetaInfo$1<'POST', {}, QuerySchedulesRequest, QuerySchedulesRequest$1, QuerySchedulesResponse & QuerySchedulesResponseNonNullableFields, QuerySchedulesResponse$1 & QuerySchedulesResponseNonNullableFields$1>;
|
|
2816
|
+
declare function createSchedule(): __PublicMethodMetaInfo$1<'POST', {}, CreateScheduleRequest, CreateScheduleRequest$1, CreateScheduleResponse & CreateScheduleResponseNonNullableFields, CreateScheduleResponse$1 & CreateScheduleResponseNonNullableFields$1>;
|
|
2817
|
+
declare function updateSchedule(): __PublicMethodMetaInfo$1<'PATCH', {
|
|
881
2818
|
scheduleId: string;
|
|
882
2819
|
}, UpdateScheduleRequest, UpdateScheduleRequest$1, UpdateScheduleResponse & UpdateScheduleResponseNonNullableFields, UpdateScheduleResponse$1 & UpdateScheduleResponseNonNullableFields$1>;
|
|
883
|
-
declare function cloneSchedule(): __PublicMethodMetaInfo<'POST', {
|
|
2820
|
+
declare function cloneSchedule(): __PublicMethodMetaInfo$1<'POST', {
|
|
884
2821
|
scheduleId: string;
|
|
885
2822
|
}, CloneScheduleRequest, CloneScheduleRequest$1, CloneScheduleResponse & CloneScheduleResponseNonNullableFields, CloneScheduleResponse$1 & CloneScheduleResponseNonNullableFields$1>;
|
|
886
|
-
declare function cancelSchedule(): __PublicMethodMetaInfo<'POST', {
|
|
2823
|
+
declare function cancelSchedule(): __PublicMethodMetaInfo$1<'POST', {
|
|
887
2824
|
scheduleId: string;
|
|
888
2825
|
}, CancelScheduleRequest, CancelScheduleRequest$1, CancelScheduleResponse & CancelScheduleResponseNonNullableFields, CancelScheduleResponse$1 & CancelScheduleResponseNonNullableFields$1>;
|
|
889
2826
|
|
|
2827
|
+
declare const meta$1_cancelSchedule: typeof cancelSchedule;
|
|
2828
|
+
declare const meta$1_cloneSchedule: typeof cloneSchedule;
|
|
2829
|
+
declare const meta$1_createSchedule: typeof createSchedule;
|
|
2830
|
+
declare const meta$1_getSchedule: typeof getSchedule;
|
|
2831
|
+
declare const meta$1_querySchedules: typeof querySchedules;
|
|
2832
|
+
declare const meta$1_updateSchedule: typeof updateSchedule;
|
|
2833
|
+
declare namespace meta$1 {
|
|
2834
|
+
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_cancelSchedule as cancelSchedule, meta$1_cloneSchedule as cloneSchedule, meta$1_createSchedule as createSchedule, meta$1_getSchedule as getSchedule, meta$1_querySchedules as querySchedules, meta$1_updateSchedule as updateSchedule };
|
|
2835
|
+
}
|
|
2836
|
+
|
|
2837
|
+
interface ScheduleTimeFrame$1 {
|
|
2838
|
+
/**
|
|
2839
|
+
* The schedule ID.
|
|
2840
|
+
* @readonly
|
|
2841
|
+
*/
|
|
2842
|
+
id?: string | null;
|
|
2843
|
+
/**
|
|
2844
|
+
* The schedule time frame status.
|
|
2845
|
+
*
|
|
2846
|
+
* The possible values are:
|
|
2847
|
+
* - `"NONE"` Time frame is not defined since there are no schedule events.
|
|
2848
|
+
* - `"FINITE"` Time frame is finite. I.e, with defined start and end dates.
|
|
2849
|
+
* - `"INFINITE"` Time frame is infinite, since there is at least one recurring event which repeats forever.
|
|
2850
|
+
* @readonly
|
|
2851
|
+
*/
|
|
2852
|
+
status?: Status$1;
|
|
2853
|
+
/**
|
|
2854
|
+
* The schedule's first event start date.
|
|
2855
|
+
* @readonly
|
|
2856
|
+
*/
|
|
2857
|
+
firstEventStartDate?: ZonedDate$1;
|
|
2858
|
+
/**
|
|
2859
|
+
* The schedule's last event end date.
|
|
2860
|
+
* @readonly
|
|
2861
|
+
*/
|
|
2862
|
+
lastEventEndDate?: ZonedDate$1;
|
|
2863
|
+
/**
|
|
2864
|
+
* First event start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
2865
|
+
* @readonly
|
|
2866
|
+
*/
|
|
2867
|
+
adjustedFirstEventStartDate?: ZonedDate$1;
|
|
2868
|
+
/**
|
|
2869
|
+
* Last event end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
2870
|
+
* @readonly
|
|
2871
|
+
*/
|
|
2872
|
+
adjustedLastEventEndDate?: ZonedDate$1;
|
|
2873
|
+
/**
|
|
2874
|
+
* The revision number, which incremented on updates.
|
|
2875
|
+
* @readonly
|
|
2876
|
+
*/
|
|
2877
|
+
revision?: string | null;
|
|
2878
|
+
}
|
|
2879
|
+
declare enum Status$1 {
|
|
2880
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2881
|
+
/** Time frame is not defined since there are no schedule events. */
|
|
2882
|
+
NONE = "NONE",
|
|
2883
|
+
/** Time frame is finite. I.e, with defined start and end dates. */
|
|
2884
|
+
FINITE = "FINITE",
|
|
2885
|
+
/** Time frame is infinite, since there is at least one recurring event which repeats forever. */
|
|
2886
|
+
INFINITE = "INFINITE"
|
|
2887
|
+
}
|
|
2888
|
+
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
2889
|
+
interface ZonedDate$1 {
|
|
2890
|
+
/**
|
|
2891
|
+
* Local date time, in ISO-8601 format.
|
|
2892
|
+
* E.g, "2024-01-30T13:30:00".
|
|
2893
|
+
*
|
|
2894
|
+
* Note: seconds are not supported and ignored.
|
|
2895
|
+
*/
|
|
2896
|
+
localDate?: string | null;
|
|
2897
|
+
/**
|
|
2898
|
+
* The event time zone.
|
|
2899
|
+
* @readonly
|
|
2900
|
+
*/
|
|
2901
|
+
timeZone?: string | null;
|
|
2902
|
+
/**
|
|
2903
|
+
* The UTC date determined by the server.
|
|
2904
|
+
* Not returned for adjusted dates.
|
|
2905
|
+
* @readonly
|
|
2906
|
+
*/
|
|
2907
|
+
utcDate?: Date;
|
|
2908
|
+
}
|
|
2909
|
+
interface GetScheduleTimeFrameRequest$1 {
|
|
2910
|
+
/** The schedule ID. */
|
|
2911
|
+
id: string | null;
|
|
2912
|
+
/**
|
|
2913
|
+
* Optional time zone used to adjust the returned time.
|
|
2914
|
+
* Default is the Wix Business time zone.
|
|
2915
|
+
*/
|
|
2916
|
+
timeZone?: string | null;
|
|
2917
|
+
}
|
|
2918
|
+
interface GetScheduleTimeFrameResponse$1 {
|
|
2919
|
+
/** The schedule time frame. */
|
|
2920
|
+
scheduleTimeFrame?: ScheduleTimeFrame$1;
|
|
2921
|
+
}
|
|
2922
|
+
interface ListScheduleTimeFramesRequest$1 {
|
|
2923
|
+
/** The schedule IDs. */
|
|
2924
|
+
ids: string[];
|
|
2925
|
+
/**
|
|
2926
|
+
* Optional time zone used to adjust the returned time.
|
|
2927
|
+
* Default is the Wix Business time zone.
|
|
2928
|
+
*/
|
|
2929
|
+
timeZone?: string | null;
|
|
2930
|
+
}
|
|
2931
|
+
interface ListScheduleTimeFramesResponse$1 {
|
|
2932
|
+
/** The schedules time frames. */
|
|
2933
|
+
scheduleTimeFrames?: ScheduleTimeFrame$1[];
|
|
2934
|
+
}
|
|
2935
|
+
interface ScheduleTimeFrameNonNullableFields$1 {
|
|
2936
|
+
status: Status$1;
|
|
2937
|
+
}
|
|
2938
|
+
interface GetScheduleTimeFrameResponseNonNullableFields$1 {
|
|
2939
|
+
scheduleTimeFrame?: ScheduleTimeFrameNonNullableFields$1;
|
|
2940
|
+
}
|
|
2941
|
+
interface ListScheduleTimeFramesResponseNonNullableFields$1 {
|
|
2942
|
+
scheduleTimeFrames: ScheduleTimeFrameNonNullableFields$1[];
|
|
2943
|
+
}
|
|
2944
|
+
|
|
2945
|
+
interface ScheduleTimeFrame {
|
|
2946
|
+
/**
|
|
2947
|
+
* The schedule ID.
|
|
2948
|
+
* @readonly
|
|
2949
|
+
*/
|
|
2950
|
+
_id?: string | null;
|
|
2951
|
+
/**
|
|
2952
|
+
* The schedule time frame status.
|
|
2953
|
+
*
|
|
2954
|
+
* The possible values are:
|
|
2955
|
+
* - `"NONE"` Time frame is not defined since there are no schedule events.
|
|
2956
|
+
* - `"FINITE"` Time frame is finite. I.e, with defined start and end dates.
|
|
2957
|
+
* - `"INFINITE"` Time frame is infinite, since there is at least one recurring event which repeats forever.
|
|
2958
|
+
* @readonly
|
|
2959
|
+
*/
|
|
2960
|
+
status?: Status;
|
|
2961
|
+
/**
|
|
2962
|
+
* The schedule's first event start date.
|
|
2963
|
+
* @readonly
|
|
2964
|
+
*/
|
|
2965
|
+
firstEventStartDate?: ZonedDate;
|
|
2966
|
+
/**
|
|
2967
|
+
* The schedule's last event end date.
|
|
2968
|
+
* @readonly
|
|
2969
|
+
*/
|
|
2970
|
+
lastEventEndDate?: ZonedDate;
|
|
2971
|
+
/**
|
|
2972
|
+
* First event start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
2973
|
+
* @readonly
|
|
2974
|
+
*/
|
|
2975
|
+
adjustedFirstEventStartDate?: ZonedDate;
|
|
2976
|
+
/**
|
|
2977
|
+
* Last event end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
|
|
2978
|
+
* @readonly
|
|
2979
|
+
*/
|
|
2980
|
+
adjustedLastEventEndDate?: ZonedDate;
|
|
2981
|
+
/**
|
|
2982
|
+
* The revision number, which incremented on updates.
|
|
2983
|
+
* @readonly
|
|
2984
|
+
*/
|
|
2985
|
+
revision?: string | null;
|
|
2986
|
+
}
|
|
2987
|
+
declare enum Status {
|
|
2988
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2989
|
+
/** Time frame is not defined since there are no schedule events. */
|
|
2990
|
+
NONE = "NONE",
|
|
2991
|
+
/** Time frame is finite. I.e, with defined start and end dates. */
|
|
2992
|
+
FINITE = "FINITE",
|
|
2993
|
+
/** Time frame is infinite, since there is at least one recurring event which repeats forever. */
|
|
2994
|
+
INFINITE = "INFINITE"
|
|
2995
|
+
}
|
|
2996
|
+
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
2997
|
+
interface ZonedDate {
|
|
2998
|
+
/**
|
|
2999
|
+
* Local date time, in ISO-8601 format.
|
|
3000
|
+
* E.g, "2024-01-30T13:30:00".
|
|
3001
|
+
*
|
|
3002
|
+
* Note: seconds are not supported and ignored.
|
|
3003
|
+
*/
|
|
3004
|
+
localDate?: string | null;
|
|
3005
|
+
/**
|
|
3006
|
+
* The event time zone.
|
|
3007
|
+
* @readonly
|
|
3008
|
+
*/
|
|
3009
|
+
timeZone?: string | null;
|
|
3010
|
+
/**
|
|
3011
|
+
* The UTC date determined by the server.
|
|
3012
|
+
* Not returned for adjusted dates.
|
|
3013
|
+
* @readonly
|
|
3014
|
+
*/
|
|
3015
|
+
utcDate?: Date;
|
|
3016
|
+
}
|
|
3017
|
+
interface GetScheduleTimeFrameRequest {
|
|
3018
|
+
/** The schedule ID. */
|
|
3019
|
+
_id: string | null;
|
|
3020
|
+
/**
|
|
3021
|
+
* Optional time zone used to adjust the returned time.
|
|
3022
|
+
* Default is the Wix Business time zone.
|
|
3023
|
+
*/
|
|
3024
|
+
timeZone?: string | null;
|
|
3025
|
+
}
|
|
3026
|
+
interface GetScheduleTimeFrameResponse {
|
|
3027
|
+
/** The schedule time frame. */
|
|
3028
|
+
scheduleTimeFrame?: ScheduleTimeFrame;
|
|
3029
|
+
}
|
|
3030
|
+
interface ListScheduleTimeFramesRequest {
|
|
3031
|
+
/** The schedule IDs. */
|
|
3032
|
+
ids: string[];
|
|
3033
|
+
/**
|
|
3034
|
+
* Optional time zone used to adjust the returned time.
|
|
3035
|
+
* Default is the Wix Business time zone.
|
|
3036
|
+
*/
|
|
3037
|
+
timeZone?: string | null;
|
|
3038
|
+
}
|
|
3039
|
+
interface ListScheduleTimeFramesResponse {
|
|
3040
|
+
/** The schedules time frames. */
|
|
3041
|
+
scheduleTimeFrames?: ScheduleTimeFrame[];
|
|
3042
|
+
}
|
|
3043
|
+
interface ScheduleTimeFrameNonNullableFields {
|
|
3044
|
+
status: Status;
|
|
3045
|
+
}
|
|
3046
|
+
interface GetScheduleTimeFrameResponseNonNullableFields {
|
|
3047
|
+
scheduleTimeFrame?: ScheduleTimeFrameNonNullableFields;
|
|
3048
|
+
}
|
|
3049
|
+
interface ListScheduleTimeFramesResponseNonNullableFields {
|
|
3050
|
+
scheduleTimeFrames: ScheduleTimeFrameNonNullableFields[];
|
|
3051
|
+
}
|
|
3052
|
+
|
|
3053
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3054
|
+
getUrl: (context: any) => string;
|
|
3055
|
+
httpMethod: K;
|
|
3056
|
+
path: string;
|
|
3057
|
+
pathParams: M;
|
|
3058
|
+
__requestType: T;
|
|
3059
|
+
__originalRequestType: S;
|
|
3060
|
+
__responseType: Q;
|
|
3061
|
+
__originalResponseType: R;
|
|
3062
|
+
};
|
|
3063
|
+
declare function getScheduleTimeFrame(): __PublicMethodMetaInfo<'GET', {
|
|
3064
|
+
id: string;
|
|
3065
|
+
}, GetScheduleTimeFrameRequest, GetScheduleTimeFrameRequest$1, GetScheduleTimeFrameResponse & GetScheduleTimeFrameResponseNonNullableFields, GetScheduleTimeFrameResponse$1 & GetScheduleTimeFrameResponseNonNullableFields$1>;
|
|
3066
|
+
declare function listScheduleTimeFrames(): __PublicMethodMetaInfo<'GET', {}, ListScheduleTimeFramesRequest, ListScheduleTimeFramesRequest$1, ListScheduleTimeFramesResponse & ListScheduleTimeFramesResponseNonNullableFields, ListScheduleTimeFramesResponse$1 & ListScheduleTimeFramesResponseNonNullableFields$1>;
|
|
3067
|
+
|
|
890
3068
|
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
891
|
-
declare const
|
|
892
|
-
declare const
|
|
893
|
-
declare const meta_createSchedule: typeof createSchedule;
|
|
894
|
-
declare const meta_getSchedule: typeof getSchedule;
|
|
895
|
-
declare const meta_querySchedules: typeof querySchedules;
|
|
896
|
-
declare const meta_updateSchedule: typeof updateSchedule;
|
|
3069
|
+
declare const meta_getScheduleTimeFrame: typeof getScheduleTimeFrame;
|
|
3070
|
+
declare const meta_listScheduleTimeFrames: typeof listScheduleTimeFrames;
|
|
897
3071
|
declare namespace meta {
|
|
898
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo,
|
|
3072
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getScheduleTimeFrame as getScheduleTimeFrame, meta_listScheduleTimeFrames as listScheduleTimeFrames };
|
|
899
3073
|
}
|
|
900
3074
|
|
|
901
|
-
export { meta as schedules };
|
|
3075
|
+
export { meta$2 as events, meta as scheduleTimeFrames, meta$1 as schedules };
|