@wix/auto_sdk_calendar_events 1.0.27 → 1.0.29
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/{internal/cjs/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-CLDnUCNu.d.mts} +161 -862
- package/build/{cjs/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-CLDnUCNu.d.ts} +161 -862
- package/build/{cjs/src/calendar-v3-event-events.public.d.ts → index.d.mts} +66 -23
- package/build/{internal/es/src/calendar-v3-event-events.public.d.ts → index.d.ts} +66 -23
- package/build/index.js +1551 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1494 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/calendar-v3-event-events.universal.d.ts → internal/calendar-v3-event-events.universal-CLDnUCNu.d.mts} +161 -862
- package/build/internal/{es/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-CLDnUCNu.d.ts} +161 -862
- package/build/{es/src/calendar-v3-event-events.public.d.ts → internal/index.d.mts} +66 -23
- package/build/internal/{cjs/src/calendar-v3-event-events.public.d.ts → index.d.ts} +66 -23
- package/build/internal/index.js +1551 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1494 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/calendar-v3-event-events.types.d.ts → internal/meta.d.mts} +120 -597
- package/build/internal/{es/src/calendar-v3-event-events.types.d.ts → meta.d.ts} +120 -597
- package/build/internal/meta.js +930 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +891 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/calendar-v3-event-events.types.d.ts → meta.d.mts} +120 -597
- package/build/{internal/cjs/src/calendar-v3-event-events.types.d.ts → meta.d.ts} +120 -597
- package/build/meta.js +930 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +891 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/cjs/src/calendar-v3-event-events.context.js +0 -71
- package/build/cjs/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/cjs/src/calendar-v3-event-events.http.js +0 -785
- package/build/cjs/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/cjs/src/calendar-v3-event-events.meta.js +0 -275
- package/build/cjs/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.public.js +0 -196
- package/build/cjs/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.types.js +0 -157
- package/build/cjs/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.universal.js +0 -1185
- package/build/cjs/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/es/src/calendar-v3-event-events.context.js +0 -51
- package/build/es/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/es/src/calendar-v3-event-events.http.js +0 -769
- package/build/es/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/es/src/calendar-v3-event-events.meta.js +0 -236
- package/build/es/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.public.js +0 -163
- package/build/es/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.types.js +0 -154
- package/build/es/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.universal.js +0 -1146
- package/build/es/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/internal/cjs/src/calendar-v3-event-events.context.js +0 -71
- package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/internal/cjs/src/calendar-v3-event-events.http.js +0 -785
- package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js +0 -275
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.public.js +0 -196
- package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.types.js +0 -157
- package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js +0 -1185
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/internal/es/src/calendar-v3-event-events.context.js +0 -51
- package/build/internal/es/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/internal/es/src/calendar-v3-event-events.http.js +0 -769
- package/build/internal/es/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/internal/es/src/calendar-v3-event-events.meta.js +0 -236
- package/build/internal/es/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.public.js +0 -163
- package/build/internal/es/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.types.js +0 -154
- package/build/internal/es/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.universal.js +0 -1146
- package/build/internal/es/src/calendar-v3-event-events.universal.js.map +0 -1
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* An event is a scheduled entry on a calendar that includes details like timing,
|
|
4
3
|
* location, and participants. Each event is associated with
|
|
@@ -8,7 +7,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
8
7
|
* recurrence pattern. You can also specify whether events block time on the
|
|
9
8
|
* schedule or allow other events to be scheduled concurrently.
|
|
10
9
|
*/
|
|
11
|
-
|
|
10
|
+
interface Event {
|
|
12
11
|
/**
|
|
13
12
|
* Event ID.
|
|
14
13
|
* @minLength 36
|
|
@@ -239,7 +238,7 @@ export interface Event {
|
|
|
239
238
|
*/
|
|
240
239
|
_updatedDate?: Date | null;
|
|
241
240
|
}
|
|
242
|
-
|
|
241
|
+
declare enum Status {
|
|
243
242
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
244
243
|
/** Event is scheduled to happen or has happened. */
|
|
245
244
|
CONFIRMED = "CONFIRMED",
|
|
@@ -247,9 +246,9 @@ export declare enum Status {
|
|
|
247
246
|
CANCELLED = "CANCELLED"
|
|
248
247
|
}
|
|
249
248
|
/** @enumType */
|
|
250
|
-
|
|
249
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'CONFIRMED' | 'CANCELLED';
|
|
251
250
|
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
252
|
-
|
|
251
|
+
interface ZonedDate {
|
|
253
252
|
/**
|
|
254
253
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
255
254
|
* For example, `2024-01-30T13:30:00`.
|
|
@@ -272,7 +271,7 @@ export interface ZonedDate {
|
|
|
272
271
|
*/
|
|
273
272
|
utcDate?: Date | null;
|
|
274
273
|
}
|
|
275
|
-
|
|
274
|
+
declare enum RecurrenceType {
|
|
276
275
|
UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
|
|
277
276
|
/** The event occurs only once and doesn't repeat. */
|
|
278
277
|
NONE = "NONE",
|
|
@@ -284,8 +283,8 @@ export declare enum RecurrenceType {
|
|
|
284
283
|
EXCEPTION = "EXCEPTION"
|
|
285
284
|
}
|
|
286
285
|
/** @enumType */
|
|
287
|
-
|
|
288
|
-
|
|
286
|
+
type RecurrenceTypeWithLiterals = RecurrenceType | 'UNKNOWN_RECURRENCE_TYPE' | 'NONE' | 'MASTER' | 'INSTANCE' | 'EXCEPTION';
|
|
287
|
+
interface RecurrenceRule {
|
|
289
288
|
/**
|
|
290
289
|
* Frequency how often the event repeats. Works together with `interval`.
|
|
291
290
|
*
|
|
@@ -329,14 +328,14 @@ export interface RecurrenceRule {
|
|
|
329
328
|
*/
|
|
330
329
|
adjustedUntil?: ZonedDate;
|
|
331
330
|
}
|
|
332
|
-
|
|
331
|
+
declare enum Frequency {
|
|
333
332
|
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
334
333
|
/** The event's recurrence pattern is based on weeks. */
|
|
335
334
|
WEEKLY = "WEEKLY"
|
|
336
335
|
}
|
|
337
336
|
/** @enumType */
|
|
338
|
-
|
|
339
|
-
|
|
337
|
+
type FrequencyWithLiterals = Frequency | 'UNKNOWN_FREQUENCY' | 'WEEKLY';
|
|
338
|
+
declare enum Day {
|
|
340
339
|
/** The recurring event takes place on Mondays. */
|
|
341
340
|
MONDAY = "MONDAY",
|
|
342
341
|
/** The recurring event takes place on Tuesdays. */
|
|
@@ -353,8 +352,8 @@ export declare enum Day {
|
|
|
353
352
|
SUNDAY = "SUNDAY"
|
|
354
353
|
}
|
|
355
354
|
/** @enumType */
|
|
356
|
-
|
|
357
|
-
|
|
355
|
+
type DayWithLiterals = Day | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
356
|
+
declare enum Transparency {
|
|
358
357
|
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
359
358
|
/** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
|
|
360
359
|
OPAQUE = "OPAQUE",
|
|
@@ -362,8 +361,8 @@ export declare enum Transparency {
|
|
|
362
361
|
TRANSPARENT = "TRANSPARENT"
|
|
363
362
|
}
|
|
364
363
|
/** @enumType */
|
|
365
|
-
|
|
366
|
-
|
|
364
|
+
type TransparencyWithLiterals = Transparency | 'UNKNOWN_TRANSPARENCY' | 'OPAQUE' | 'TRANSPARENT';
|
|
365
|
+
interface Location {
|
|
367
366
|
/**
|
|
368
367
|
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
369
368
|
* ID. Available only for `BUSINESS` locations.
|
|
@@ -399,7 +398,7 @@ export interface Location {
|
|
|
399
398
|
*/
|
|
400
399
|
address?: string | null;
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
declare enum LocationType {
|
|
403
402
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
404
403
|
/** The event is held at a business location. */
|
|
405
404
|
BUSINESS = "BUSINESS",
|
|
@@ -409,8 +408,8 @@ export declare enum LocationType {
|
|
|
409
408
|
CUSTOM = "CUSTOM"
|
|
410
409
|
}
|
|
411
410
|
/** @enumType */
|
|
412
|
-
|
|
413
|
-
|
|
411
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_TYPE' | 'BUSINESS' | 'CUSTOMER' | 'CUSTOM';
|
|
412
|
+
interface Resource {
|
|
414
413
|
/**
|
|
415
414
|
* Resource ID.
|
|
416
415
|
* @format GUID
|
|
@@ -443,7 +442,7 @@ export interface Resource {
|
|
|
443
442
|
*/
|
|
444
443
|
permissionRole?: RoleWithLiterals;
|
|
445
444
|
}
|
|
446
|
-
|
|
445
|
+
declare enum Role {
|
|
447
446
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
448
447
|
/** Full read and write access. */
|
|
449
448
|
WRITER = "WRITER",
|
|
@@ -451,8 +450,8 @@ export declare enum Role {
|
|
|
451
450
|
COMMENTER = "COMMENTER"
|
|
452
451
|
}
|
|
453
452
|
/** @enumType */
|
|
454
|
-
|
|
455
|
-
|
|
453
|
+
type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'WRITER' | 'COMMENTER';
|
|
454
|
+
interface Participants {
|
|
456
455
|
/**
|
|
457
456
|
* Total number of participants.
|
|
458
457
|
*
|
|
@@ -482,7 +481,7 @@ export interface Participants {
|
|
|
482
481
|
*/
|
|
483
482
|
status?: ParticipantsStatusWithLiterals;
|
|
484
483
|
}
|
|
485
|
-
|
|
484
|
+
interface Participant {
|
|
486
485
|
/**
|
|
487
486
|
* Participant name.
|
|
488
487
|
*
|
|
@@ -509,7 +508,7 @@ export interface Participant {
|
|
|
509
508
|
*/
|
|
510
509
|
contactId?: string | null;
|
|
511
510
|
}
|
|
512
|
-
|
|
511
|
+
declare enum ParticipantsStatus {
|
|
513
512
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
514
513
|
/** All participants are confirmed. */
|
|
515
514
|
CONFIRMED = "CONFIRMED",
|
|
@@ -517,8 +516,8 @@ export declare enum ParticipantsStatus {
|
|
|
517
516
|
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
518
517
|
}
|
|
519
518
|
/** @enumType */
|
|
520
|
-
|
|
521
|
-
|
|
519
|
+
type ParticipantsStatusWithLiterals = ParticipantsStatus | 'UNKNOWN_STATUS' | 'CONFIRMED' | 'PENDING_CONFIRMATION';
|
|
520
|
+
interface ConferencingDetails {
|
|
522
521
|
/** Conference type. For example, `Zoom`. */
|
|
523
522
|
type?: TypeWithLiterals;
|
|
524
523
|
/**
|
|
@@ -558,14 +557,14 @@ export interface ConferencingDetails {
|
|
|
558
557
|
*/
|
|
559
558
|
externalId?: string | null;
|
|
560
559
|
}
|
|
561
|
-
|
|
560
|
+
declare enum Type {
|
|
562
561
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
563
562
|
ZOOM = "ZOOM",
|
|
564
563
|
CUSTOM = "CUSTOM"
|
|
565
564
|
}
|
|
566
565
|
/** @enumType */
|
|
567
|
-
|
|
568
|
-
|
|
566
|
+
type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'ZOOM' | 'CUSTOM';
|
|
567
|
+
declare enum Field {
|
|
569
568
|
UNKNOWN_FIELD = "UNKNOWN_FIELD",
|
|
570
569
|
/** `title` is inherited from the schedule or `MASTER` event. */
|
|
571
570
|
TITLE = "TITLE",
|
|
@@ -585,8 +584,8 @@ export declare enum Field {
|
|
|
585
584
|
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
586
585
|
}
|
|
587
586
|
/** @enumType */
|
|
588
|
-
|
|
589
|
-
|
|
587
|
+
type FieldWithLiterals = Field | 'UNKNOWN_FIELD' | 'TITLE' | 'TIME_ZONE' | 'TIME' | 'LOCATION' | 'RESOURCES' | 'CAPACITY' | 'PARTICIPANTS' | 'CONFERENCING_DETAILS';
|
|
588
|
+
interface Permission {
|
|
590
589
|
/**
|
|
591
590
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
592
591
|
* granted the permission.
|
|
@@ -601,7 +600,7 @@ export interface Permission {
|
|
|
601
600
|
*/
|
|
602
601
|
role?: RoleWithLiterals;
|
|
603
602
|
}
|
|
604
|
-
|
|
603
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
605
604
|
/**
|
|
606
605
|
* ID of a Wix user. For example, the site owner or a
|
|
607
606
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -610,7 +609,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
610
609
|
wixUserId?: string;
|
|
611
610
|
}
|
|
612
611
|
/** @oneof */
|
|
613
|
-
|
|
612
|
+
interface CommonIdentificationDataIdOneOf {
|
|
614
613
|
/**
|
|
615
614
|
* ID of a Wix user. For example, the site owner or a
|
|
616
615
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -618,13 +617,11 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
618
617
|
*/
|
|
619
618
|
wixUserId?: string;
|
|
620
619
|
}
|
|
621
|
-
|
|
620
|
+
declare enum IdentityType {
|
|
622
621
|
UNKNOWN = "UNKNOWN",
|
|
623
622
|
WIX_USER = "WIX_USER"
|
|
624
623
|
}
|
|
625
|
-
|
|
626
|
-
export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
|
|
627
|
-
export interface ExtendedFields {
|
|
624
|
+
interface ExtendedFields {
|
|
628
625
|
/**
|
|
629
626
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
630
627
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -635,17 +632,17 @@ export interface ExtendedFields {
|
|
|
635
632
|
*/
|
|
636
633
|
namespaces?: Record<string, Record<string, any>>;
|
|
637
634
|
}
|
|
638
|
-
|
|
635
|
+
interface RecurringEventSplit {
|
|
639
636
|
/** Original `MASTER` event that was shortened. */
|
|
640
637
|
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
641
638
|
/** New `MASTER` event starting with the first event after the split date. */
|
|
642
639
|
newRecurringEventStartingFromSplit?: Event;
|
|
643
640
|
}
|
|
644
|
-
|
|
641
|
+
interface EventCancelled {
|
|
645
642
|
/** Canceled event. */
|
|
646
643
|
event?: Event;
|
|
647
644
|
}
|
|
648
|
-
|
|
645
|
+
interface ParticipantNotification {
|
|
649
646
|
/**
|
|
650
647
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
651
648
|
*
|
|
@@ -663,7 +660,7 @@ export interface ParticipantNotification {
|
|
|
663
660
|
message?: string | null;
|
|
664
661
|
}
|
|
665
662
|
/** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
|
|
666
|
-
|
|
663
|
+
interface EventUpdatedWithMetadata {
|
|
667
664
|
/** The updated event. */
|
|
668
665
|
event?: Event;
|
|
669
666
|
/**
|
|
@@ -672,25 +669,25 @@ export interface EventUpdatedWithMetadata {
|
|
|
672
669
|
*/
|
|
673
670
|
participantNotification?: ParticipantNotification;
|
|
674
671
|
}
|
|
675
|
-
|
|
672
|
+
interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
676
673
|
/** @format GUID */
|
|
677
674
|
metaSiteId?: string;
|
|
678
675
|
/** @format GUID */
|
|
679
676
|
currentBusinessResourceId?: string;
|
|
680
677
|
migrateBusinessConferenceId?: boolean;
|
|
681
678
|
}
|
|
682
|
-
|
|
679
|
+
interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
683
680
|
}
|
|
684
|
-
|
|
681
|
+
interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
685
682
|
/** @format GUID */
|
|
686
683
|
metaSiteId?: string;
|
|
687
684
|
/** @format GUID */
|
|
688
685
|
currentBusinessResourceId?: string;
|
|
689
686
|
migrateBusinessConferenceId?: boolean;
|
|
690
687
|
}
|
|
691
|
-
|
|
688
|
+
interface UpdateEventsWithFixedBusinessResourceIdResponse {
|
|
692
689
|
}
|
|
693
|
-
|
|
690
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
694
691
|
createdEvent?: EntityCreatedEvent;
|
|
695
692
|
updatedEvent?: EntityUpdatedEvent;
|
|
696
693
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -725,19 +722,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
725
722
|
entityEventSequence?: string | null;
|
|
726
723
|
}
|
|
727
724
|
/** @oneof */
|
|
728
|
-
|
|
725
|
+
interface DomainEventBodyOneOf {
|
|
729
726
|
createdEvent?: EntityCreatedEvent;
|
|
730
727
|
updatedEvent?: EntityUpdatedEvent;
|
|
731
728
|
deletedEvent?: EntityDeletedEvent;
|
|
732
729
|
actionEvent?: ActionEvent;
|
|
733
730
|
}
|
|
734
|
-
|
|
731
|
+
interface EntityCreatedEvent {
|
|
735
732
|
entity?: string;
|
|
736
733
|
}
|
|
737
|
-
|
|
734
|
+
interface RestoreInfo {
|
|
738
735
|
deletedDate?: Date | null;
|
|
739
736
|
}
|
|
740
|
-
|
|
737
|
+
interface EntityUpdatedEvent {
|
|
741
738
|
/**
|
|
742
739
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
743
740
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -745,14 +742,14 @@ export interface EntityUpdatedEvent {
|
|
|
745
742
|
*/
|
|
746
743
|
currentEntity?: string;
|
|
747
744
|
}
|
|
748
|
-
|
|
745
|
+
interface EntityDeletedEvent {
|
|
749
746
|
/** Entity that was deleted. */
|
|
750
747
|
deletedEntity?: string | null;
|
|
751
748
|
}
|
|
752
|
-
|
|
749
|
+
interface ActionEvent {
|
|
753
750
|
body?: string;
|
|
754
751
|
}
|
|
755
|
-
|
|
752
|
+
interface MessageEnvelope {
|
|
756
753
|
/**
|
|
757
754
|
* App instance ID.
|
|
758
755
|
* @format GUID
|
|
@@ -768,7 +765,7 @@ export interface MessageEnvelope {
|
|
|
768
765
|
/** Stringify payload. */
|
|
769
766
|
data?: string;
|
|
770
767
|
}
|
|
771
|
-
|
|
768
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
772
769
|
/**
|
|
773
770
|
* ID of a site visitor that has not logged in to the site.
|
|
774
771
|
* @format GUID
|
|
@@ -793,7 +790,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
793
790
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
794
791
|
}
|
|
795
792
|
/** @oneof */
|
|
796
|
-
|
|
793
|
+
interface IdentificationDataIdOneOf {
|
|
797
794
|
/**
|
|
798
795
|
* ID of a site visitor that has not logged in to the site.
|
|
799
796
|
* @format GUID
|
|
@@ -815,7 +812,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
815
812
|
*/
|
|
816
813
|
appId?: string;
|
|
817
814
|
}
|
|
818
|
-
|
|
815
|
+
declare enum WebhookIdentityType {
|
|
819
816
|
UNKNOWN = "UNKNOWN",
|
|
820
817
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
821
818
|
MEMBER = "MEMBER",
|
|
@@ -823,8 +820,8 @@ export declare enum WebhookIdentityType {
|
|
|
823
820
|
APP = "APP"
|
|
824
821
|
}
|
|
825
822
|
/** @enumType */
|
|
826
|
-
|
|
827
|
-
|
|
823
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
824
|
+
interface ListEventsByContactIdRequest {
|
|
828
825
|
/**
|
|
829
826
|
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
830
827
|
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
@@ -870,7 +867,7 @@ export interface ListEventsByContactIdRequest {
|
|
|
870
867
|
cursorPaging?: CommonCursorPaging;
|
|
871
868
|
}
|
|
872
869
|
/** TODO Diverge */
|
|
873
|
-
|
|
870
|
+
interface CommonCursorPaging {
|
|
874
871
|
/**
|
|
875
872
|
* Number of events to return.
|
|
876
873
|
* Defaults to `50`. Maximum `100`.
|
|
@@ -887,14 +884,14 @@ export interface CommonCursorPaging {
|
|
|
887
884
|
*/
|
|
888
885
|
cursor?: string | null;
|
|
889
886
|
}
|
|
890
|
-
|
|
887
|
+
interface ListEventsByContactIdResponse {
|
|
891
888
|
/** Retrieved events. */
|
|
892
889
|
events?: Event[];
|
|
893
890
|
/** Paging metadata. */
|
|
894
891
|
pagingMetadata?: CommonCursorPagingMetadata;
|
|
895
892
|
}
|
|
896
893
|
/** TODO Diverge */
|
|
897
|
-
|
|
894
|
+
interface CommonCursorPagingMetadata {
|
|
898
895
|
/** Number of items returned in the response. */
|
|
899
896
|
count?: number | null;
|
|
900
897
|
/** 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). */
|
|
@@ -906,11 +903,11 @@ export interface CommonCursorPagingMetadata {
|
|
|
906
903
|
*/
|
|
907
904
|
hasNext?: boolean | null;
|
|
908
905
|
}
|
|
909
|
-
|
|
906
|
+
interface CommonCursors {
|
|
910
907
|
/** Cursor pointing to next page in the list of results. */
|
|
911
908
|
next?: string | null;
|
|
912
909
|
}
|
|
913
|
-
|
|
910
|
+
interface ListEventsByMemberIdRequest {
|
|
914
911
|
/**
|
|
915
912
|
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
916
913
|
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
@@ -970,14 +967,14 @@ export interface ListEventsByMemberIdRequest {
|
|
|
970
967
|
*/
|
|
971
968
|
eventIds?: string[];
|
|
972
969
|
}
|
|
973
|
-
|
|
970
|
+
interface ListEventsByMemberIdResponse {
|
|
974
971
|
/** Retrieved events. */
|
|
975
972
|
events?: Event[];
|
|
976
973
|
/** Paging metadata. */
|
|
977
974
|
pagingMetadata?: CommonCursorPagingMetadata;
|
|
978
975
|
}
|
|
979
976
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
980
|
-
|
|
977
|
+
interface SitePropertiesNotification {
|
|
981
978
|
/** The site ID for which this update notification applies. */
|
|
982
979
|
metasiteId?: string;
|
|
983
980
|
/** The actual update event. */
|
|
@@ -991,7 +988,7 @@ export interface SitePropertiesNotification {
|
|
|
991
988
|
changeContext?: ChangeContext;
|
|
992
989
|
}
|
|
993
990
|
/** The actual update event for a particular notification. */
|
|
994
|
-
|
|
991
|
+
interface SitePropertiesEvent {
|
|
995
992
|
/** Version of the site's properties represented by this update. */
|
|
996
993
|
version?: number;
|
|
997
994
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -999,7 +996,7 @@ export interface SitePropertiesEvent {
|
|
|
999
996
|
/** Updated properties. */
|
|
1000
997
|
properties?: Properties;
|
|
1001
998
|
}
|
|
1002
|
-
|
|
999
|
+
interface Properties {
|
|
1003
1000
|
/** Site categories. */
|
|
1004
1001
|
categories?: Categories;
|
|
1005
1002
|
/** Site locale. */
|
|
@@ -1055,7 +1052,7 @@ export interface Properties {
|
|
|
1055
1052
|
/** Track clicks analytics. */
|
|
1056
1053
|
trackClicksAnalytics?: boolean;
|
|
1057
1054
|
}
|
|
1058
|
-
|
|
1055
|
+
interface Categories {
|
|
1059
1056
|
/** Primary site category. */
|
|
1060
1057
|
primary?: string;
|
|
1061
1058
|
/**
|
|
@@ -1066,13 +1063,13 @@ export interface Categories {
|
|
|
1066
1063
|
/** Business Term Id */
|
|
1067
1064
|
businessTermId?: string | null;
|
|
1068
1065
|
}
|
|
1069
|
-
|
|
1066
|
+
interface Locale {
|
|
1070
1067
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1071
1068
|
languageCode?: string;
|
|
1072
1069
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1073
1070
|
country?: string;
|
|
1074
1071
|
}
|
|
1075
|
-
|
|
1072
|
+
interface Address {
|
|
1076
1073
|
/** Street name. */
|
|
1077
1074
|
street?: string;
|
|
1078
1075
|
/** City name. */
|
|
@@ -1104,29 +1101,29 @@ export interface Address {
|
|
|
1104
1101
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1105
1102
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1106
1103
|
*/
|
|
1107
|
-
|
|
1104
|
+
interface AddressHint {
|
|
1108
1105
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1109
1106
|
text?: string;
|
|
1110
1107
|
/** Where the extra text should be displayed. */
|
|
1111
1108
|
placement?: PlacementTypeWithLiterals;
|
|
1112
1109
|
}
|
|
1113
1110
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1114
|
-
|
|
1111
|
+
declare enum PlacementType {
|
|
1115
1112
|
BEFORE = "BEFORE",
|
|
1116
1113
|
AFTER = "AFTER",
|
|
1117
1114
|
REPLACE = "REPLACE"
|
|
1118
1115
|
}
|
|
1119
1116
|
/** @enumType */
|
|
1120
|
-
|
|
1117
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
1121
1118
|
/** Geocoordinates for a particular address. */
|
|
1122
|
-
|
|
1119
|
+
interface GeoCoordinates {
|
|
1123
1120
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
1124
1121
|
latitude?: number;
|
|
1125
1122
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
1126
1123
|
longitude?: number;
|
|
1127
1124
|
}
|
|
1128
1125
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1129
|
-
|
|
1126
|
+
interface BusinessSchedule {
|
|
1130
1127
|
/**
|
|
1131
1128
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1132
1129
|
* @maxSize 100
|
|
@@ -1139,7 +1136,7 @@ export interface BusinessSchedule {
|
|
|
1139
1136
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1140
1137
|
}
|
|
1141
1138
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1142
|
-
|
|
1139
|
+
interface TimePeriod {
|
|
1143
1140
|
/** Day of the week the period starts on. */
|
|
1144
1141
|
openDay?: DayOfWeekWithLiterals;
|
|
1145
1142
|
/**
|
|
@@ -1158,7 +1155,7 @@ export interface TimePeriod {
|
|
|
1158
1155
|
closeTime?: string;
|
|
1159
1156
|
}
|
|
1160
1157
|
/** Enumerates the days of the week. */
|
|
1161
|
-
|
|
1158
|
+
declare enum DayOfWeek {
|
|
1162
1159
|
MONDAY = "MONDAY",
|
|
1163
1160
|
TUESDAY = "TUESDAY",
|
|
1164
1161
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -1168,9 +1165,9 @@ export declare enum DayOfWeek {
|
|
|
1168
1165
|
SUNDAY = "SUNDAY"
|
|
1169
1166
|
}
|
|
1170
1167
|
/** @enumType */
|
|
1171
|
-
|
|
1168
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1172
1169
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1173
|
-
|
|
1170
|
+
interface SpecialHourPeriod {
|
|
1174
1171
|
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1175
1172
|
startDate?: string;
|
|
1176
1173
|
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
@@ -1184,7 +1181,7 @@ export interface SpecialHourPeriod {
|
|
|
1184
1181
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1185
1182
|
comment?: string;
|
|
1186
1183
|
}
|
|
1187
|
-
|
|
1184
|
+
interface Multilingual {
|
|
1188
1185
|
/**
|
|
1189
1186
|
* Supported languages list.
|
|
1190
1187
|
* @maxSize 200
|
|
@@ -1193,7 +1190,7 @@ export interface Multilingual {
|
|
|
1193
1190
|
/** Whether to redirect to user language. */
|
|
1194
1191
|
autoRedirect?: boolean;
|
|
1195
1192
|
}
|
|
1196
|
-
|
|
1193
|
+
interface SupportedLanguage {
|
|
1197
1194
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1198
1195
|
languageCode?: string;
|
|
1199
1196
|
/** Locale. */
|
|
@@ -1207,14 +1204,14 @@ export interface SupportedLanguage {
|
|
|
1207
1204
|
/** Whether the supported language is the primary language for site visitors. */
|
|
1208
1205
|
isVisitorPrimary?: boolean | null;
|
|
1209
1206
|
}
|
|
1210
|
-
|
|
1207
|
+
declare enum ResolutionMethod {
|
|
1211
1208
|
QUERY_PARAM = "QUERY_PARAM",
|
|
1212
1209
|
SUBDOMAIN = "SUBDOMAIN",
|
|
1213
1210
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1214
1211
|
}
|
|
1215
1212
|
/** @enumType */
|
|
1216
|
-
|
|
1217
|
-
|
|
1213
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1214
|
+
interface ConsentPolicy {
|
|
1218
1215
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1219
1216
|
essential?: boolean | null;
|
|
1220
1217
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -1227,7 +1224,7 @@ export interface ConsentPolicy {
|
|
|
1227
1224
|
dataToThirdParty?: boolean | null;
|
|
1228
1225
|
}
|
|
1229
1226
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1230
|
-
|
|
1227
|
+
interface Translation {
|
|
1231
1228
|
/** The service type. */
|
|
1232
1229
|
serviceType?: string;
|
|
1233
1230
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -1235,7 +1232,7 @@ export interface Translation {
|
|
|
1235
1232
|
/** The instance ID of the service. */
|
|
1236
1233
|
instanceId?: string;
|
|
1237
1234
|
}
|
|
1238
|
-
|
|
1235
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1239
1236
|
/** Properties were updated. */
|
|
1240
1237
|
propertiesChange?: PropertiesChange;
|
|
1241
1238
|
/** Default properties were created on site creation. */
|
|
@@ -1244,7 +1241,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
1244
1241
|
siteCloned?: SiteCloned;
|
|
1245
1242
|
}
|
|
1246
1243
|
/** @oneof */
|
|
1247
|
-
|
|
1244
|
+
interface ChangeContextPayloadOneOf {
|
|
1248
1245
|
/** Properties were updated. */
|
|
1249
1246
|
propertiesChange?: PropertiesChange;
|
|
1250
1247
|
/** Default properties were created on site creation. */
|
|
@@ -1252,19 +1249,19 @@ export interface ChangeContextPayloadOneOf {
|
|
|
1252
1249
|
/** Properties were cloned on site cloning. */
|
|
1253
1250
|
siteCloned?: SiteCloned;
|
|
1254
1251
|
}
|
|
1255
|
-
|
|
1252
|
+
interface PropertiesChange {
|
|
1256
1253
|
}
|
|
1257
|
-
|
|
1254
|
+
interface SiteCreated {
|
|
1258
1255
|
/** Origin template site id. */
|
|
1259
1256
|
originTemplateId?: string | null;
|
|
1260
1257
|
}
|
|
1261
|
-
|
|
1258
|
+
interface SiteCloned {
|
|
1262
1259
|
/** Origin site id. */
|
|
1263
1260
|
originMetaSiteId?: string;
|
|
1264
1261
|
}
|
|
1265
|
-
|
|
1262
|
+
interface Empty {
|
|
1266
1263
|
}
|
|
1267
|
-
|
|
1264
|
+
interface GetEventRequest {
|
|
1268
1265
|
/**
|
|
1269
1266
|
* ID of the event to retrieve.
|
|
1270
1267
|
*
|
|
@@ -1297,7 +1294,7 @@ export interface GetEventRequest {
|
|
|
1297
1294
|
*/
|
|
1298
1295
|
fields?: RequestedFieldsWithLiterals[];
|
|
1299
1296
|
}
|
|
1300
|
-
|
|
1297
|
+
declare enum RequestedFields {
|
|
1301
1298
|
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1302
1299
|
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1303
1300
|
PI_FIELDS = "PI_FIELDS",
|
|
@@ -1305,12 +1302,12 @@ export declare enum RequestedFields {
|
|
|
1305
1302
|
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1306
1303
|
}
|
|
1307
1304
|
/** @enumType */
|
|
1308
|
-
|
|
1309
|
-
|
|
1305
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
|
|
1306
|
+
interface GetEventResponse {
|
|
1310
1307
|
/** Retrieved event. */
|
|
1311
1308
|
event?: Event;
|
|
1312
1309
|
}
|
|
1313
|
-
|
|
1310
|
+
interface ListEventsRequest {
|
|
1314
1311
|
/**
|
|
1315
1312
|
* IDs of the events to retrieve.
|
|
1316
1313
|
*
|
|
@@ -1345,11 +1342,11 @@ export interface ListEventsRequest {
|
|
|
1345
1342
|
*/
|
|
1346
1343
|
fields?: RequestedFieldsWithLiterals[];
|
|
1347
1344
|
}
|
|
1348
|
-
|
|
1345
|
+
interface ListEventsResponse {
|
|
1349
1346
|
/** Retrieved events matching the provided IDs. */
|
|
1350
1347
|
events?: Event[];
|
|
1351
1348
|
}
|
|
1352
|
-
|
|
1349
|
+
interface QueryEventsRequest {
|
|
1353
1350
|
/**
|
|
1354
1351
|
* Local start date and time from which events are returned in
|
|
1355
1352
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -1410,7 +1407,7 @@ export interface QueryEventsRequest {
|
|
|
1410
1407
|
fields?: RequestedFieldsWithLiterals[];
|
|
1411
1408
|
}
|
|
1412
1409
|
/** TODO Diverge */
|
|
1413
|
-
|
|
1410
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1414
1411
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1415
1412
|
cursorPaging?: CursorPaging;
|
|
1416
1413
|
/**
|
|
@@ -1435,12 +1432,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1435
1432
|
sort?: Sorting[];
|
|
1436
1433
|
}
|
|
1437
1434
|
/** @oneof */
|
|
1438
|
-
|
|
1435
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1439
1436
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1440
1437
|
cursorPaging?: CursorPaging;
|
|
1441
1438
|
}
|
|
1442
1439
|
/** TODO Diverge */
|
|
1443
|
-
|
|
1440
|
+
interface Sorting {
|
|
1444
1441
|
/**
|
|
1445
1442
|
* The field to sort by.
|
|
1446
1443
|
* Either `start` or `end`.
|
|
@@ -1450,14 +1447,14 @@ export interface Sorting {
|
|
|
1450
1447
|
/** Sort order. */
|
|
1451
1448
|
order?: SortOrderWithLiterals;
|
|
1452
1449
|
}
|
|
1453
|
-
|
|
1450
|
+
declare enum SortOrder {
|
|
1454
1451
|
ASC = "ASC",
|
|
1455
1452
|
DESC = "DESC"
|
|
1456
1453
|
}
|
|
1457
1454
|
/** @enumType */
|
|
1458
|
-
|
|
1455
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1459
1456
|
/** TODO Diverge */
|
|
1460
|
-
|
|
1457
|
+
interface CursorPaging {
|
|
1461
1458
|
/**
|
|
1462
1459
|
* Number of events to return.
|
|
1463
1460
|
* Defaults to `50`. Maximum `1000`.
|
|
@@ -1474,14 +1471,14 @@ export interface CursorPaging {
|
|
|
1474
1471
|
*/
|
|
1475
1472
|
cursor?: string | null;
|
|
1476
1473
|
}
|
|
1477
|
-
|
|
1474
|
+
interface QueryEventsResponse {
|
|
1478
1475
|
/** Retrieved events matching the provided query. */
|
|
1479
1476
|
events?: Event[];
|
|
1480
1477
|
/** Paging metadata. */
|
|
1481
1478
|
pagingMetadata?: CursorPagingMetadata;
|
|
1482
1479
|
}
|
|
1483
1480
|
/** TODO Diverge */
|
|
1484
|
-
|
|
1481
|
+
interface CursorPagingMetadata {
|
|
1485
1482
|
/** Number of items returned in the response. */
|
|
1486
1483
|
count?: number | null;
|
|
1487
1484
|
/** 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). */
|
|
@@ -1493,11 +1490,11 @@ export interface CursorPagingMetadata {
|
|
|
1493
1490
|
*/
|
|
1494
1491
|
hasNext?: boolean | null;
|
|
1495
1492
|
}
|
|
1496
|
-
|
|
1493
|
+
interface Cursors {
|
|
1497
1494
|
/** Cursor pointing to next page in the list of results. */
|
|
1498
1495
|
next?: string | null;
|
|
1499
1496
|
}
|
|
1500
|
-
|
|
1497
|
+
interface ListRecurringEventInstancesHistoryRequest {
|
|
1501
1498
|
/**
|
|
1502
1499
|
* The ID of the recurring event.
|
|
1503
1500
|
* Required, unless `cursorPaging` is provided.
|
|
@@ -1525,13 +1522,13 @@ export interface ListRecurringEventInstancesHistoryRequest {
|
|
|
1525
1522
|
/** Optional cursor pointing to the next page of events. */
|
|
1526
1523
|
cursorPaging?: CursorPaging;
|
|
1527
1524
|
}
|
|
1528
|
-
|
|
1525
|
+
interface ListRecurringEventInstancesHistoryResponse {
|
|
1529
1526
|
/** The recurring event instances. */
|
|
1530
1527
|
recurringEventInstances?: Event[];
|
|
1531
1528
|
/** Paging metadata. */
|
|
1532
1529
|
pagingMetadata?: CursorPagingMetadata;
|
|
1533
1530
|
}
|
|
1534
|
-
|
|
1531
|
+
interface CreateEventRequest {
|
|
1535
1532
|
/** Event to create. */
|
|
1536
1533
|
event: Event;
|
|
1537
1534
|
/**
|
|
@@ -1549,11 +1546,11 @@ export interface CreateEventRequest {
|
|
|
1549
1546
|
*/
|
|
1550
1547
|
idempotencyKey?: string | null;
|
|
1551
1548
|
}
|
|
1552
|
-
|
|
1549
|
+
interface CreateEventResponse {
|
|
1553
1550
|
/** Created event. */
|
|
1554
1551
|
event?: Event;
|
|
1555
1552
|
}
|
|
1556
|
-
|
|
1553
|
+
interface BulkCreateEventRequest {
|
|
1557
1554
|
/**
|
|
1558
1555
|
* Events to create.
|
|
1559
1556
|
* @minSize 1
|
|
@@ -1575,23 +1572,23 @@ export interface BulkCreateEventRequest {
|
|
|
1575
1572
|
*/
|
|
1576
1573
|
timeZone?: string | null;
|
|
1577
1574
|
}
|
|
1578
|
-
|
|
1575
|
+
interface MaskedEvent {
|
|
1579
1576
|
/** Event to create. */
|
|
1580
1577
|
event?: Event;
|
|
1581
1578
|
}
|
|
1582
|
-
|
|
1579
|
+
interface BulkCreateEventResponse {
|
|
1583
1580
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1584
1581
|
results?: BulkEventResult[];
|
|
1585
1582
|
/** Total successes and failures. */
|
|
1586
1583
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1587
1584
|
}
|
|
1588
|
-
|
|
1585
|
+
interface BulkEventResult {
|
|
1589
1586
|
/** Whether the requested action was successful. */
|
|
1590
1587
|
itemMetadata?: ItemMetadata;
|
|
1591
1588
|
/** The event. */
|
|
1592
1589
|
item?: Event;
|
|
1593
1590
|
}
|
|
1594
|
-
|
|
1591
|
+
interface ItemMetadata {
|
|
1595
1592
|
/**
|
|
1596
1593
|
* Event ID.
|
|
1597
1594
|
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
@@ -1607,7 +1604,7 @@ export interface ItemMetadata {
|
|
|
1607
1604
|
/** Details about the error in case of failure. */
|
|
1608
1605
|
error?: ApplicationError;
|
|
1609
1606
|
}
|
|
1610
|
-
|
|
1607
|
+
interface ApplicationError {
|
|
1611
1608
|
/** Error code. */
|
|
1612
1609
|
code?: string;
|
|
1613
1610
|
/** Description of the error. */
|
|
@@ -1615,13 +1612,13 @@ export interface ApplicationError {
|
|
|
1615
1612
|
/** Data related to the error. */
|
|
1616
1613
|
data?: Record<string, any> | null;
|
|
1617
1614
|
}
|
|
1618
|
-
|
|
1615
|
+
interface BulkActionMetadata {
|
|
1619
1616
|
/** Number of events that were successfully processed. */
|
|
1620
1617
|
totalSuccesses?: number;
|
|
1621
1618
|
/** Number of events that couldn't be processed. */
|
|
1622
1619
|
totalFailures?: number;
|
|
1623
1620
|
}
|
|
1624
|
-
|
|
1621
|
+
interface UpdateEventRequest {
|
|
1625
1622
|
/** Event to update. */
|
|
1626
1623
|
event: Event;
|
|
1627
1624
|
/**
|
|
@@ -1638,11 +1635,11 @@ export interface UpdateEventRequest {
|
|
|
1638
1635
|
*/
|
|
1639
1636
|
timeZone?: string | null;
|
|
1640
1637
|
}
|
|
1641
|
-
|
|
1638
|
+
interface UpdateEventResponse {
|
|
1642
1639
|
/** Updated event. */
|
|
1643
1640
|
event?: Event;
|
|
1644
1641
|
}
|
|
1645
|
-
|
|
1642
|
+
interface BulkUpdateEventRequest {
|
|
1646
1643
|
/**
|
|
1647
1644
|
* Events to update.
|
|
1648
1645
|
*
|
|
@@ -1672,17 +1669,17 @@ export interface BulkUpdateEventRequest {
|
|
|
1672
1669
|
*/
|
|
1673
1670
|
timeZone?: string | null;
|
|
1674
1671
|
}
|
|
1675
|
-
|
|
1672
|
+
interface BulkUpdateEventRequestMaskedEvent {
|
|
1676
1673
|
/** Event to update. */
|
|
1677
1674
|
event?: Event;
|
|
1678
1675
|
}
|
|
1679
|
-
|
|
1676
|
+
interface BulkUpdateEventResponse {
|
|
1680
1677
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1681
1678
|
results?: BulkEventResult[];
|
|
1682
1679
|
/** Total successes and failures. */
|
|
1683
1680
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1684
1681
|
}
|
|
1685
|
-
|
|
1682
|
+
interface UpdateEventParticipantsRequest {
|
|
1686
1683
|
/**
|
|
1687
1684
|
* ID of the event to update.
|
|
1688
1685
|
*
|
|
@@ -1695,11 +1692,11 @@ export interface UpdateEventParticipantsRequest {
|
|
|
1695
1692
|
/** The participants to update. */
|
|
1696
1693
|
participants?: Participants;
|
|
1697
1694
|
}
|
|
1698
|
-
|
|
1695
|
+
interface UpdateEventParticipantsResponse {
|
|
1699
1696
|
/** Updated event. */
|
|
1700
1697
|
event?: Event;
|
|
1701
1698
|
}
|
|
1702
|
-
|
|
1699
|
+
interface RestoreEventDefaultsRequest {
|
|
1703
1700
|
/**
|
|
1704
1701
|
* ID of the event for which to restore default values.
|
|
1705
1702
|
* @minLength 36
|
|
@@ -1729,11 +1726,11 @@ export interface RestoreEventDefaultsRequest {
|
|
|
1729
1726
|
*/
|
|
1730
1727
|
timeZone?: string | null;
|
|
1731
1728
|
}
|
|
1732
|
-
|
|
1729
|
+
interface RestoreEventDefaultsResponse {
|
|
1733
1730
|
/** Updated event. */
|
|
1734
1731
|
event?: Event;
|
|
1735
1732
|
}
|
|
1736
|
-
|
|
1733
|
+
interface SplitRecurringEventRequest {
|
|
1737
1734
|
/**
|
|
1738
1735
|
* ID of the `MASTER` event to split.
|
|
1739
1736
|
* @minLength 36
|
|
@@ -1760,13 +1757,13 @@ export interface SplitRecurringEventRequest {
|
|
|
1760
1757
|
*/
|
|
1761
1758
|
timeZone?: string | null;
|
|
1762
1759
|
}
|
|
1763
|
-
|
|
1760
|
+
interface SplitRecurringEventResponse {
|
|
1764
1761
|
/** Original `MASTER` event that was shortened. */
|
|
1765
1762
|
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1766
1763
|
/** New `MASTER` event starting with the first event after the split date. */
|
|
1767
1764
|
newRecurringEventStartingFromSplit?: Event;
|
|
1768
1765
|
}
|
|
1769
|
-
|
|
1766
|
+
interface CancelEventRequest {
|
|
1770
1767
|
/**
|
|
1771
1768
|
* ID of the event to cancel.
|
|
1772
1769
|
* @minLength 36
|
|
@@ -1787,11 +1784,11 @@ export interface CancelEventRequest {
|
|
|
1787
1784
|
*/
|
|
1788
1785
|
timeZone?: string | null;
|
|
1789
1786
|
}
|
|
1790
|
-
|
|
1787
|
+
interface CancelEventResponse {
|
|
1791
1788
|
/** Canceled event. */
|
|
1792
1789
|
event?: Event;
|
|
1793
1790
|
}
|
|
1794
|
-
|
|
1791
|
+
interface BulkCancelEventRequest {
|
|
1795
1792
|
/**
|
|
1796
1793
|
* IDs of the events to cancel.
|
|
1797
1794
|
* @minSize 1
|
|
@@ -1818,13 +1815,13 @@ export interface BulkCancelEventRequest {
|
|
|
1818
1815
|
*/
|
|
1819
1816
|
timeZone?: string | null;
|
|
1820
1817
|
}
|
|
1821
|
-
|
|
1818
|
+
interface BulkCancelEventResponse {
|
|
1822
1819
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1823
1820
|
results?: BulkEventResult[];
|
|
1824
1821
|
/** Total successes and failures. */
|
|
1825
1822
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1826
1823
|
}
|
|
1827
|
-
|
|
1824
|
+
interface BaseEventMetadata {
|
|
1828
1825
|
/**
|
|
1829
1826
|
* App instance ID.
|
|
1830
1827
|
* @format GUID
|
|
@@ -1838,7 +1835,7 @@ export interface BaseEventMetadata {
|
|
|
1838
1835
|
/** The identification type and identity data. */
|
|
1839
1836
|
identity?: IdentificationData;
|
|
1840
1837
|
}
|
|
1841
|
-
|
|
1838
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1842
1839
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1843
1840
|
_id?: string;
|
|
1844
1841
|
/**
|
|
@@ -1868,158 +1865,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1868
1865
|
*/
|
|
1869
1866
|
entityEventSequence?: string | null;
|
|
1870
1867
|
}
|
|
1871
|
-
|
|
1868
|
+
interface EventCancelledEnvelope {
|
|
1872
1869
|
data: EventCancelled;
|
|
1873
1870
|
metadata: EventMetadata;
|
|
1874
1871
|
}
|
|
1875
|
-
|
|
1876
|
-
* Triggered when an event is canceled.
|
|
1877
|
-
*
|
|
1878
|
-
* Not triggered when `INSTANCE` events are canceled. You can use the
|
|
1879
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1880
|
-
* to get notified about `INSTANCE` events.
|
|
1881
|
-
* @permissionScope Read Calendar - Including PI
|
|
1882
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1883
|
-
* @permissionScope Manage Calendars
|
|
1884
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1885
|
-
* @permissionScope Manage Bookings
|
|
1886
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1887
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1888
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1889
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1890
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1891
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1892
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1893
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1894
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1895
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1896
|
-
* @webhook
|
|
1897
|
-
* @eventType wix.calendar.v3.event_cancelled
|
|
1898
|
-
* @slug cancelled
|
|
1899
|
-
*/
|
|
1900
|
-
export declare function onEventCancelled(handler: (event: EventCancelledEnvelope) => void | Promise<void>): void;
|
|
1901
|
-
export interface EventCreatedEnvelope {
|
|
1872
|
+
interface EventCreatedEnvelope {
|
|
1902
1873
|
entity: Event;
|
|
1903
1874
|
metadata: EventMetadata;
|
|
1904
1875
|
}
|
|
1905
|
-
|
|
1906
|
-
* Triggered when an event is created, including when an existing `MASTER`
|
|
1907
|
-
* event is split.
|
|
1908
|
-
*
|
|
1909
|
-
* Not triggered when `INSTANCE` events are created. You can use the
|
|
1910
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1911
|
-
* to get notified about `INSTANCE` events.
|
|
1912
|
-
* @permissionScope Read Calendar - Including PI
|
|
1913
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1914
|
-
* @permissionScope Manage Calendars
|
|
1915
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1916
|
-
* @permissionScope Manage Bookings
|
|
1917
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1918
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1919
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1920
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1921
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1922
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1923
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1924
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1925
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1926
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1927
|
-
* @webhook
|
|
1928
|
-
* @eventType wix.calendar.v3.event_created
|
|
1929
|
-
* @slug created
|
|
1930
|
-
*/
|
|
1931
|
-
export declare function onEventCreated(handler: (event: EventCreatedEnvelope) => void | Promise<void>): void;
|
|
1932
|
-
export interface EventRecurringSplitEnvelope {
|
|
1876
|
+
interface EventRecurringSplitEnvelope {
|
|
1933
1877
|
data: RecurringEventSplit;
|
|
1934
1878
|
metadata: EventMetadata;
|
|
1935
1879
|
}
|
|
1936
|
-
|
|
1937
|
-
* Triggered when a `MASTER` event is split.
|
|
1938
|
-
* @permissionScope Read Calendar - Including PI
|
|
1939
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1940
|
-
* @permissionScope Manage Calendars
|
|
1941
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1942
|
-
* @permissionScope Manage Bookings
|
|
1943
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1944
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1945
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1946
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1947
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1948
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1949
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1950
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1951
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1952
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1953
|
-
* @webhook
|
|
1954
|
-
* @eventType wix.calendar.v3.event_recurring_split
|
|
1955
|
-
* @slug recurring_split
|
|
1956
|
-
*/
|
|
1957
|
-
export declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
|
|
1958
|
-
export interface EventUpdatedEnvelope {
|
|
1880
|
+
interface EventUpdatedEnvelope {
|
|
1959
1881
|
entity: Event;
|
|
1960
1882
|
metadata: EventMetadata;
|
|
1961
1883
|
}
|
|
1962
|
-
|
|
1963
|
-
* Triggered when an event is updated, including when it's canceled.
|
|
1964
|
-
*
|
|
1965
|
-
* Not triggered when `INSTANCE` events are updated. You can use the
|
|
1966
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1967
|
-
* to get notified about `INSTANCE` events.
|
|
1968
|
-
* @permissionScope Read Calendar - Including PI
|
|
1969
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1970
|
-
* @permissionScope Manage Calendars
|
|
1971
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1972
|
-
* @permissionScope Manage Bookings
|
|
1973
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1974
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1975
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1976
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1977
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1978
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1979
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1980
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1981
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1982
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1983
|
-
* @webhook
|
|
1984
|
-
* @eventType wix.calendar.v3.event_updated
|
|
1985
|
-
* @slug updated
|
|
1986
|
-
*/
|
|
1987
|
-
export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
|
|
1988
|
-
type EventNonNullablePaths = `status` | `recurrenceType` | `recurrenceRule.frequency` | `recurrenceRule.days` | `transparency` | `location.type` | `resources` | `resources.${number}.transparency` | `resources.${number}.permissionRole` | `participants.list` | `participants.status` | `conferencingDetails.type` | `inheritedFields` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
|
|
1989
|
-
/**
|
|
1990
|
-
* Retrieves a list of events filtered by the participant's
|
|
1991
|
-
* [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
1992
|
-
* ID.
|
|
1993
|
-
*
|
|
1994
|
-
*
|
|
1995
|
-
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
1996
|
-
* `fromLocalDate`.
|
|
1997
|
-
* @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
1998
|
-
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
1999
|
-
* @public
|
|
2000
|
-
* @requiredField contactId
|
|
2001
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2002
|
-
* @permissionScope Read Calendar - Including PI
|
|
2003
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2004
|
-
* @permissionScope Manage Calendars
|
|
2005
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2006
|
-
* @permissionScope Manage Bookings
|
|
2007
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2008
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2009
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2010
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2011
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2012
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2013
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2014
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2015
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2016
|
-
* @applicableIdentity APP
|
|
2017
|
-
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
|
|
2018
|
-
*/
|
|
2019
|
-
export declare function listEventsByContactId(contactId: string, options?: ListEventsByContactIdOptions): Promise<NonNullablePaths<ListEventsByContactIdResponse, {
|
|
2020
|
-
[P in EventNonNullablePaths]: `events.${number}.${P}`;
|
|
2021
|
-
}[EventNonNullablePaths]>>;
|
|
2022
|
-
export interface ListEventsByContactIdOptions {
|
|
1884
|
+
interface ListEventsByContactIdOptions {
|
|
2023
1885
|
/**
|
|
2024
1886
|
* Local start date and time from which events are returned in
|
|
2025
1887
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -2058,68 +1920,7 @@ export interface ListEventsByContactIdOptions {
|
|
|
2058
1920
|
/** Cursor to retrieve the next page of the results. */
|
|
2059
1921
|
cursorPaging?: CommonCursorPaging;
|
|
2060
1922
|
}
|
|
2061
|
-
|
|
2062
|
-
* Retrieves a list of events filtered by the participant's
|
|
2063
|
-
* [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
|
|
2064
|
-
* ID.
|
|
2065
|
-
*
|
|
2066
|
-
*
|
|
2067
|
-
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
2068
|
-
* `fromLocalDate`.
|
|
2069
|
-
* @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
2070
|
-
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
2071
|
-
* Provide `me` to retrieve events for the currently logged-in member.
|
|
2072
|
-
* You must have the `Read Calendars - Including PI`
|
|
2073
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
2074
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
2075
|
-
* @public
|
|
2076
|
-
* @requiredField memberId
|
|
2077
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2078
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2079
|
-
* @permissionScope Read Bookings - Public Data
|
|
2080
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2081
|
-
* @permissionScope Read Calendar - Including PI
|
|
2082
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2083
|
-
* @permissionScope Manage Calendars
|
|
2084
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2085
|
-
* @permissionScope Manage Bookings
|
|
2086
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2087
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2088
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2089
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2090
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2091
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2092
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2093
|
-
* @permissionScope Read Calendar
|
|
2094
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2095
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2096
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2097
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2098
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2099
|
-
* @permissionScope Read Bookings Calendar
|
|
2100
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2101
|
-
* @permissionScope Read Calendar - Including PI
|
|
2102
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2103
|
-
* @permissionScope Manage Calendars
|
|
2104
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2105
|
-
* @permissionScope Manage Bookings
|
|
2106
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2107
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2108
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2109
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2110
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2111
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2112
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2113
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2114
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2115
|
-
* @applicableIdentity APP
|
|
2116
|
-
* @applicableIdentity VISITOR
|
|
2117
|
-
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
|
|
2118
|
-
*/
|
|
2119
|
-
export declare function listEventsByMemberId(memberId: string, options?: ListEventsByMemberIdOptions): Promise<NonNullablePaths<ListEventsByMemberIdResponse, {
|
|
2120
|
-
[P in EventNonNullablePaths]: `events.${number}.${P}`;
|
|
2121
|
-
}[EventNonNullablePaths]>>;
|
|
2122
|
-
export interface ListEventsByMemberIdOptions {
|
|
1923
|
+
interface ListEventsByMemberIdOptions {
|
|
2123
1924
|
/**
|
|
2124
1925
|
* Local start date and time from which events are returned in
|
|
2125
1926
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -2168,59 +1969,7 @@ export interface ListEventsByMemberIdOptions {
|
|
|
2168
1969
|
*/
|
|
2169
1970
|
eventIds?: string[];
|
|
2170
1971
|
}
|
|
2171
|
-
|
|
2172
|
-
* Retrieves an event.
|
|
2173
|
-
* @param eventId - ID of the event to retrieve.
|
|
2174
|
-
*
|
|
2175
|
-
* Min: 36 characters
|
|
2176
|
-
* Max: 250 characters
|
|
2177
|
-
* @public
|
|
2178
|
-
* @requiredField eventId
|
|
2179
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2180
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2181
|
-
* @permissionScope Read Bookings - Public Data
|
|
2182
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2183
|
-
* @permissionScope Read Calendar - Including PI
|
|
2184
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2185
|
-
* @permissionScope Manage Calendars
|
|
2186
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2187
|
-
* @permissionScope Manage Bookings
|
|
2188
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2189
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2190
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2191
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2192
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2193
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2194
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2195
|
-
* @permissionScope Read Calendar
|
|
2196
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2197
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2198
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2199
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2200
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2201
|
-
* @permissionScope Read Bookings Calendar
|
|
2202
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2203
|
-
* @permissionScope Read Calendar - Including PI
|
|
2204
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2205
|
-
* @permissionScope Manage Calendars
|
|
2206
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2207
|
-
* @permissionScope Manage Bookings
|
|
2208
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2209
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2210
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2211
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2212
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2213
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2214
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2215
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2216
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2217
|
-
* @applicableIdentity APP
|
|
2218
|
-
* @applicableIdentity VISITOR
|
|
2219
|
-
* @returns Retrieved event.
|
|
2220
|
-
* @fqn wix.calendar.events.v3.EventsService.GetEvent
|
|
2221
|
-
*/
|
|
2222
|
-
export declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
|
|
2223
|
-
export interface GetEventOptions {
|
|
1972
|
+
interface GetEventOptions {
|
|
2224
1973
|
/**
|
|
2225
1974
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2226
1975
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -2244,60 +1993,7 @@ export interface GetEventOptions {
|
|
|
2244
1993
|
*/
|
|
2245
1994
|
fields?: RequestedFieldsWithLiterals[];
|
|
2246
1995
|
}
|
|
2247
|
-
|
|
2248
|
-
* Retrieves a list of events by their IDs.
|
|
2249
|
-
* @param eventIds - IDs of the events to retrieve.
|
|
2250
|
-
*
|
|
2251
|
-
* Min: 1 event ID
|
|
2252
|
-
* Min: 100 event IDs
|
|
2253
|
-
* @public
|
|
2254
|
-
* @requiredField eventIds
|
|
2255
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2256
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2257
|
-
* @permissionScope Read Bookings - Public Data
|
|
2258
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2259
|
-
* @permissionScope Read Calendar - Including PI
|
|
2260
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2261
|
-
* @permissionScope Manage Calendars
|
|
2262
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2263
|
-
* @permissionScope Manage Bookings
|
|
2264
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2265
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2266
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2267
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2268
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2269
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2270
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2271
|
-
* @permissionScope Read Calendar
|
|
2272
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2273
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2274
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2275
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2276
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2277
|
-
* @permissionScope Read Bookings Calendar
|
|
2278
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2279
|
-
* @permissionScope Read Calendar - Including PI
|
|
2280
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2281
|
-
* @permissionScope Manage Calendars
|
|
2282
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2283
|
-
* @permissionScope Manage Bookings
|
|
2284
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2285
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2286
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2287
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2288
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2289
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2290
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2291
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2292
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2293
|
-
* @applicableIdentity APP
|
|
2294
|
-
* @applicableIdentity VISITOR
|
|
2295
|
-
* @fqn wix.calendar.events.v3.EventsService.ListEvents
|
|
2296
|
-
*/
|
|
2297
|
-
export declare function listEvents(eventIds: string[], options?: ListEventsOptions): Promise<NonNullablePaths<ListEventsResponse, {
|
|
2298
|
-
[P in EventNonNullablePaths]: `events.${number}.${P}`;
|
|
2299
|
-
}[EventNonNullablePaths]>>;
|
|
2300
|
-
export interface ListEventsOptions {
|
|
1996
|
+
interface ListEventsOptions {
|
|
2301
1997
|
/**
|
|
2302
1998
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2303
1999
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -2321,69 +2017,7 @@ export interface ListEventsOptions {
|
|
|
2321
2017
|
*/
|
|
2322
2018
|
fields?: RequestedFieldsWithLiterals[];
|
|
2323
2019
|
}
|
|
2324
|
-
|
|
2325
|
-
* Creates a query to retrieve a list of events.
|
|
2326
|
-
*
|
|
2327
|
-
* The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object.
|
|
2328
|
-
*
|
|
2329
|
-
* The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-builder/find) function.
|
|
2330
|
-
*
|
|
2331
|
-
* You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results that `queryEvents()` returns.
|
|
2332
|
-
*
|
|
2333
|
-
* `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override:
|
|
2334
|
-
*
|
|
2335
|
-
* + `limit` is `50`.
|
|
2336
|
-
* + Sorted by `event.start` in ascending order.
|
|
2337
|
-
*
|
|
2338
|
-
* The functions that are chained to `queryEvents()` are applied in the order they are called.
|
|
2339
|
-
*
|
|
2340
|
-
* The following `EventsQueryBuilder` functions are supported for the `queryEvents()` function. For a full description of the events object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-result/items) property in `EventsQueryResult`.
|
|
2341
|
-
*
|
|
2342
|
-
* @public
|
|
2343
|
-
* @permissionScope Read Bookings - Public Data
|
|
2344
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2345
|
-
* @permissionScope Read Calendar - Including PI
|
|
2346
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2347
|
-
* @permissionScope Manage Calendars
|
|
2348
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2349
|
-
* @permissionScope Manage Bookings
|
|
2350
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2351
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2352
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2353
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2354
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2355
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2356
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2357
|
-
* @permissionScope Read Calendar
|
|
2358
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2359
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2360
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2361
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2362
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2363
|
-
* @permissionScope Read Bookings Calendar
|
|
2364
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2365
|
-
* @permissionScope Read Calendar - Including PI
|
|
2366
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2367
|
-
* @permissionScope Manage Calendars
|
|
2368
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2369
|
-
* @permissionScope Manage Bookings
|
|
2370
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2371
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2372
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2373
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2374
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2375
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2376
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2377
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2378
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2379
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2380
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2381
|
-
* @applicableIdentity APP
|
|
2382
|
-
* @applicableIdentity VISITOR
|
|
2383
|
-
* @fqn wix.calendar.events.v3.EventsService.QueryEvents
|
|
2384
|
-
*/
|
|
2385
|
-
export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
2386
|
-
export interface QueryEventsOptions {
|
|
2020
|
+
interface QueryEventsOptions {
|
|
2387
2021
|
/**
|
|
2388
2022
|
* Local start date and time from which events are returned in
|
|
2389
2023
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -2444,13 +2078,13 @@ interface QueryCursorResult {
|
|
|
2444
2078
|
length: number;
|
|
2445
2079
|
pageSize: number;
|
|
2446
2080
|
}
|
|
2447
|
-
|
|
2081
|
+
interface EventsQueryResult extends QueryCursorResult {
|
|
2448
2082
|
items: Event[];
|
|
2449
2083
|
query: EventsQueryBuilder;
|
|
2450
2084
|
next: () => Promise<EventsQueryResult>;
|
|
2451
2085
|
prev: () => Promise<EventsQueryResult>;
|
|
2452
2086
|
}
|
|
2453
|
-
|
|
2087
|
+
interface EventsQueryBuilder {
|
|
2454
2088
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2455
2089
|
* @param value - Value to compare against.
|
|
2456
2090
|
*/
|
|
@@ -2475,6 +2109,14 @@ export interface EventsQueryBuilder {
|
|
|
2475
2109
|
* @param value - Value to compare against.
|
|
2476
2110
|
*/
|
|
2477
2111
|
lt: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
|
|
2112
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2113
|
+
* @param values - List of values to compare against.
|
|
2114
|
+
*/
|
|
2115
|
+
hasSome: (propertyName: string, value: any[]) => EventsQueryBuilder;
|
|
2116
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2117
|
+
* @param values - List of values to compare against.
|
|
2118
|
+
*/
|
|
2119
|
+
hasAll: (propertyName: string, value: any[]) => EventsQueryBuilder;
|
|
2478
2120
|
in: (propertyName: 'scheduleId' | 'externalScheduleId' | 'type' | 'recurringEventId' | 'location.id' | 'location.type' | 'appId', value: any) => EventsQueryBuilder;
|
|
2479
2121
|
exists: (propertyName: 'location' | 'totalCapacity' | 'conferencingDetails', value: boolean) => EventsQueryBuilder;
|
|
2480
2122
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
@@ -2483,50 +2125,7 @@ export interface EventsQueryBuilder {
|
|
|
2483
2125
|
skipTo: (cursor: string) => EventsQueryBuilder;
|
|
2484
2126
|
find: () => Promise<EventsQueryResult>;
|
|
2485
2127
|
}
|
|
2486
|
-
|
|
2487
|
-
* Creates an event.
|
|
2488
|
-
*
|
|
2489
|
-
*
|
|
2490
|
-
* If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is created. Then, you can't set `start.localDate` to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates.
|
|
2491
|
-
*
|
|
2492
|
-
* You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`. `INSTANCE` events are generated automatically based on the recurrence rule in the relevant `MASTER` event. `EXCEPTION` events are automatically created when you [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
|
|
2493
|
-
* @param event - Event to create.
|
|
2494
|
-
* @public
|
|
2495
|
-
* @requiredField event
|
|
2496
|
-
* @requiredField event.conferencingDetails.guestUrl
|
|
2497
|
-
* @requiredField event.conferencingDetails.hostUrl
|
|
2498
|
-
* @requiredField event.conferencingDetails.type
|
|
2499
|
-
* @requiredField event.end
|
|
2500
|
-
* @requiredField event.end.localDate
|
|
2501
|
-
* @requiredField event.location.type
|
|
2502
|
-
* @requiredField event.participants.list.name
|
|
2503
|
-
* @requiredField event.recurrenceRule.days
|
|
2504
|
-
* @requiredField event.recurrenceRule.frequency
|
|
2505
|
-
* @requiredField event.recurrenceRule.until.localDate
|
|
2506
|
-
* @requiredField event.resources._id
|
|
2507
|
-
* @requiredField event.scheduleId
|
|
2508
|
-
* @requiredField event.start
|
|
2509
|
-
* @requiredField event.start.localDate
|
|
2510
|
-
* @permissionId CALENDAR.EVENT_CREATE_OWN
|
|
2511
|
-
* @permissionId CALENDAR.EVENT_CREATE
|
|
2512
|
-
* @permissionScope Manage Calendars
|
|
2513
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2514
|
-
* @permissionScope Manage Bookings
|
|
2515
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2516
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2517
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2518
|
-
* @permissionScope Manage Calendars
|
|
2519
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2520
|
-
* @permissionScope Manage Bookings
|
|
2521
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2522
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2523
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2524
|
-
* @applicableIdentity APP
|
|
2525
|
-
* @returns Created event.
|
|
2526
|
-
* @fqn wix.calendar.events.v3.EventsService.CreateEvent
|
|
2527
|
-
*/
|
|
2528
|
-
export declare function createEvent(event: NonNullablePaths<Event, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `scheduleId` | `start` | `start.localDate`>, options?: CreateEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
|
|
2529
|
-
export interface CreateEventOptions {
|
|
2128
|
+
interface CreateEventOptions {
|
|
2530
2129
|
/**
|
|
2531
2130
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2532
2131
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -2542,59 +2141,7 @@ export interface CreateEventOptions {
|
|
|
2542
2141
|
*/
|
|
2543
2142
|
idempotencyKey?: string | null;
|
|
2544
2143
|
}
|
|
2545
|
-
|
|
2546
|
-
* Creates multiple events in bulk.
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2549
|
-
* If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
|
|
2550
|
-
* created. Then, you can't set `start.localDate` to a past date, though the time can be
|
|
2551
|
-
* earlier on the same day. You can, however, create single-occurrence events for
|
|
2552
|
-
* past dates.
|
|
2553
|
-
*
|
|
2554
|
-
* You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
|
|
2555
|
-
* `INSTANCE` events are generated automatically based on the recurrence rule in the
|
|
2556
|
-
* relevant `MASTER` event. `EXCEPTION` events are automatically created when you
|
|
2557
|
-
* [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
|
|
2558
|
-
* an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
|
|
2559
|
-
* @param events - Events to create.
|
|
2560
|
-
* @public
|
|
2561
|
-
* @requiredField events
|
|
2562
|
-
* @requiredField events.event
|
|
2563
|
-
* @requiredField events.event.conferencingDetails.guestUrl
|
|
2564
|
-
* @requiredField events.event.conferencingDetails.hostUrl
|
|
2565
|
-
* @requiredField events.event.conferencingDetails.type
|
|
2566
|
-
* @requiredField events.event.end
|
|
2567
|
-
* @requiredField events.event.end.localDate
|
|
2568
|
-
* @requiredField events.event.location.type
|
|
2569
|
-
* @requiredField events.event.participants.list.name
|
|
2570
|
-
* @requiredField events.event.recurrenceRule.days
|
|
2571
|
-
* @requiredField events.event.recurrenceRule.frequency
|
|
2572
|
-
* @requiredField events.event.recurrenceRule.until.localDate
|
|
2573
|
-
* @requiredField events.event.resources._id
|
|
2574
|
-
* @requiredField events.event.scheduleId
|
|
2575
|
-
* @requiredField events.event.start
|
|
2576
|
-
* @requiredField events.event.start.localDate
|
|
2577
|
-
* @permissionId CALENDAR.EVENT_CREATE_OWN
|
|
2578
|
-
* @permissionId CALENDAR.EVENT_CREATE
|
|
2579
|
-
* @permissionScope Manage Calendars
|
|
2580
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2581
|
-
* @permissionScope Manage Bookings
|
|
2582
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2583
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2584
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2585
|
-
* @permissionScope Manage Calendars
|
|
2586
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2587
|
-
* @permissionScope Manage Bookings
|
|
2588
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2589
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2590
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2591
|
-
* @applicableIdentity APP
|
|
2592
|
-
* @fqn wix.calendar.events.v3.EventsService.BulkCreateEvent
|
|
2593
|
-
*/
|
|
2594
|
-
export declare function bulkCreateEvent(events: NonNullablePaths<MaskedEvent, `event` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.scheduleId` | `event.start` | `event.start.localDate`>[], options?: BulkCreateEventOptions): Promise<NonNullablePaths<BulkCreateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
2595
|
-
[P in EventNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2596
|
-
}[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
|
|
2597
|
-
export interface BulkCreateEventOptions {
|
|
2144
|
+
interface BulkCreateEventOptions {
|
|
2598
2145
|
/**
|
|
2599
2146
|
* Whether to return created events.
|
|
2600
2147
|
*
|
|
@@ -2610,54 +2157,7 @@ export interface BulkCreateEventOptions {
|
|
|
2610
2157
|
*/
|
|
2611
2158
|
timeZone?: string | null;
|
|
2612
2159
|
}
|
|
2613
|
-
|
|
2614
|
-
* Updates an event.
|
|
2615
|
-
*
|
|
2616
|
-
*
|
|
2617
|
-
* When updating an event with `{"recurrenceType": "INSTANCE"}`, the
|
|
2618
|
-
* `recurrenceType` automatically changes to `EXCEPTION`.
|
|
2619
|
-
*
|
|
2620
|
-
* When updating an event with `{"recurrenceType": "MASTER"}`:
|
|
2621
|
-
* + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
|
|
2622
|
-
* + For future `INSTANCE` events, all relevant fields are updated.
|
|
2623
|
-
* + For future `EXCEPTION` events, only changes to the `inheritedFields` are
|
|
2624
|
-
* applied, while other fields remain unchanged.
|
|
2625
|
-
* @param _id - Event ID.
|
|
2626
|
-
* @public
|
|
2627
|
-
* @requiredField _id
|
|
2628
|
-
* @requiredField event
|
|
2629
|
-
* @requiredField event.conferencingDetails.guestUrl
|
|
2630
|
-
* @requiredField event.conferencingDetails.hostUrl
|
|
2631
|
-
* @requiredField event.conferencingDetails.type
|
|
2632
|
-
* @requiredField event.end.localDate
|
|
2633
|
-
* @requiredField event.location.type
|
|
2634
|
-
* @requiredField event.participants.list.name
|
|
2635
|
-
* @requiredField event.recurrenceRule.days
|
|
2636
|
-
* @requiredField event.recurrenceRule.frequency
|
|
2637
|
-
* @requiredField event.recurrenceRule.until.localDate
|
|
2638
|
-
* @requiredField event.resources._id
|
|
2639
|
-
* @requiredField event.revision
|
|
2640
|
-
* @requiredField event.start.localDate
|
|
2641
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
2642
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
2643
|
-
* @permissionScope Manage Calendars
|
|
2644
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2645
|
-
* @permissionScope Manage Bookings
|
|
2646
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2647
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2648
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2649
|
-
* @permissionScope Manage Calendars
|
|
2650
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2651
|
-
* @permissionScope Manage Bookings
|
|
2652
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2653
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2654
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2655
|
-
* @applicableIdentity APP
|
|
2656
|
-
* @returns Updated event.
|
|
2657
|
-
* @fqn wix.calendar.events.v3.EventsService.UpdateEvent
|
|
2658
|
-
*/
|
|
2659
|
-
export declare function updateEvent(_id: string, event: NonNullablePaths<UpdateEvent, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `revision` | `start.localDate`>, options?: UpdateEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
|
|
2660
|
-
export interface UpdateEvent {
|
|
2160
|
+
interface UpdateEvent {
|
|
2661
2161
|
/**
|
|
2662
2162
|
* Event ID.
|
|
2663
2163
|
* @minLength 36
|
|
@@ -2888,7 +2388,7 @@ export interface UpdateEvent {
|
|
|
2888
2388
|
*/
|
|
2889
2389
|
_updatedDate?: Date | null;
|
|
2890
2390
|
}
|
|
2891
|
-
|
|
2391
|
+
interface UpdateEventOptions {
|
|
2892
2392
|
/**
|
|
2893
2393
|
* Information about whether participants of the updated event are notified and
|
|
2894
2394
|
* the message they receive.
|
|
@@ -2903,59 +2403,7 @@ export interface UpdateEventOptions {
|
|
|
2903
2403
|
*/
|
|
2904
2404
|
timeZone?: string | null;
|
|
2905
2405
|
}
|
|
2906
|
-
|
|
2907
|
-
* Updates multiple events in bulk.
|
|
2908
|
-
*
|
|
2909
|
-
*
|
|
2910
|
-
* When updating an event with `{"recurrenceType": "INSTANCE"}`, the
|
|
2911
|
-
* `recurrenceType` automatically changes to `EXCEPTION`.
|
|
2912
|
-
*
|
|
2913
|
-
* When updating an event with `{"recurrenceType": "MASTER"}`:
|
|
2914
|
-
* + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
|
|
2915
|
-
* + For future `INSTANCE` events, all relevant fields are updated.
|
|
2916
|
-
* + For future `EXCEPTION` events, only changes to the `inheritedFields` are
|
|
2917
|
-
* applied, while other fields remain unchanged.
|
|
2918
|
-
* @param events - Events to update.
|
|
2919
|
-
*
|
|
2920
|
-
* Min: 1 event
|
|
2921
|
-
* Max: 50 events
|
|
2922
|
-
* @public
|
|
2923
|
-
* @requiredField events
|
|
2924
|
-
* @requiredField events.event
|
|
2925
|
-
* @requiredField events.event._id
|
|
2926
|
-
* @requiredField events.event.conferencingDetails.guestUrl
|
|
2927
|
-
* @requiredField events.event.conferencingDetails.hostUrl
|
|
2928
|
-
* @requiredField events.event.conferencingDetails.type
|
|
2929
|
-
* @requiredField events.event.end.localDate
|
|
2930
|
-
* @requiredField events.event.location.type
|
|
2931
|
-
* @requiredField events.event.participants.list.name
|
|
2932
|
-
* @requiredField events.event.recurrenceRule.days
|
|
2933
|
-
* @requiredField events.event.recurrenceRule.frequency
|
|
2934
|
-
* @requiredField events.event.recurrenceRule.until.localDate
|
|
2935
|
-
* @requiredField events.event.resources._id
|
|
2936
|
-
* @requiredField events.event.revision
|
|
2937
|
-
* @requiredField events.event.start.localDate
|
|
2938
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
2939
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
2940
|
-
* @permissionScope Manage Calendars
|
|
2941
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2942
|
-
* @permissionScope Manage Bookings
|
|
2943
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2944
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2945
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2946
|
-
* @permissionScope Manage Calendars
|
|
2947
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2948
|
-
* @permissionScope Manage Bookings
|
|
2949
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2950
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2951
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2952
|
-
* @applicableIdentity APP
|
|
2953
|
-
* @fqn wix.calendar.events.v3.EventsService.BulkUpdateEvent
|
|
2954
|
-
*/
|
|
2955
|
-
export declare function bulkUpdateEvent(events: NonNullablePaths<BulkUpdateEventRequestMaskedEvent, `event` | `event._id` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.revision` | `event.start.localDate`>[], options?: BulkUpdateEventOptions): Promise<NonNullablePaths<BulkUpdateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
2956
|
-
[P in EventNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2957
|
-
}[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
|
|
2958
|
-
export interface BulkUpdateEventOptions {
|
|
2406
|
+
interface BulkUpdateEventOptions {
|
|
2959
2407
|
/**
|
|
2960
2408
|
* Whether to return the updated events.
|
|
2961
2409
|
*
|
|
@@ -2976,50 +2424,7 @@ export interface BulkUpdateEventOptions {
|
|
|
2976
2424
|
*/
|
|
2977
2425
|
timeZone?: string | null;
|
|
2978
2426
|
}
|
|
2979
|
-
|
|
2980
|
-
* Restores the event's default values from the relevant schedule or `MASTER`
|
|
2981
|
-
* event.
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
2984
|
-
* You must provide `fields` to specify which `inheritedFields` are restored.
|
|
2985
|
-
*
|
|
2986
|
-
* For example, if you've created an event that takes place in a non-default
|
|
2987
|
-
* location with a custom title and capacity, but you want to reset only title
|
|
2988
|
-
* and capacity to default values without affecting the location, provide the
|
|
2989
|
-
* event ID and set `fields` to `["TITLE", "CAPACITY"]`.
|
|
2990
|
-
*
|
|
2991
|
-
* Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
|
|
2992
|
-
* for more information.
|
|
2993
|
-
* @param eventId - ID of the event for which to restore default values.
|
|
2994
|
-
* @param fields - Fields for which to restore default values.
|
|
2995
|
-
*
|
|
2996
|
-
* `TIME` restores default values for `start` and `end`.
|
|
2997
|
-
*
|
|
2998
|
-
* Min: 1 field
|
|
2999
|
-
* @public
|
|
3000
|
-
* @requiredField eventId
|
|
3001
|
-
* @requiredField fields
|
|
3002
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
3003
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
3004
|
-
* @permissionScope Manage Calendars
|
|
3005
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3006
|
-
* @permissionScope Manage Bookings
|
|
3007
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3008
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3009
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3010
|
-
* @permissionScope Manage Calendars
|
|
3011
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3012
|
-
* @permissionScope Manage Bookings
|
|
3013
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3014
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3015
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3016
|
-
* @applicableIdentity APP
|
|
3017
|
-
* @fqn wix.calendar.events.v3.EventsService.RestoreEventDefaults
|
|
3018
|
-
*/
|
|
3019
|
-
export declare function restoreEventDefaults(eventId: string, fields: FieldWithLiterals[], options?: RestoreEventDefaultsOptions): Promise<NonNullablePaths<RestoreEventDefaultsResponse, {
|
|
3020
|
-
[P in EventNonNullablePaths]: `event.${P}`;
|
|
3021
|
-
}[EventNonNullablePaths]>>;
|
|
3022
|
-
export interface RestoreEventDefaultsOptions {
|
|
2427
|
+
interface RestoreEventDefaultsOptions {
|
|
3023
2428
|
/**
|
|
3024
2429
|
* Information about whether participants of the updated event are notified and
|
|
3025
2430
|
* the message they receive.
|
|
@@ -3034,64 +2439,7 @@ export interface RestoreEventDefaultsOptions {
|
|
|
3034
2439
|
*/
|
|
3035
2440
|
timeZone?: string | null;
|
|
3036
2441
|
}
|
|
3037
|
-
|
|
3038
|
-
* Splits a recurring `MASTER` event into 2 separate `MASTER` events.
|
|
3039
|
-
*
|
|
3040
|
-
*
|
|
3041
|
-
* You must provide a `splitLocalDate` that's in the future and after the `start`
|
|
3042
|
-
* date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally,
|
|
3043
|
-
* there must be another `INSTANCE` or `EXCEPTION` event following this next event,
|
|
3044
|
-
* as the changes wouldn't affect any event without a subsequent occurrence.
|
|
3045
|
-
*
|
|
3046
|
-
* If you want to modify a `MASTER` event with the changes already applying to
|
|
3047
|
-
* the very next event, use
|
|
3048
|
-
* [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
|
|
3049
|
-
* instead, as this preserves past events and only modifies future events.
|
|
3050
|
-
*
|
|
3051
|
-
* The main consequences are:
|
|
3052
|
-
* - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate`
|
|
3053
|
-
* is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION`
|
|
3054
|
-
* event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event
|
|
3055
|
-
* starts before but ends after `splitLocalDate`, `until.localDate` is set
|
|
3056
|
-
* to value that's later than `splitLocalDate`.
|
|
3057
|
-
* - **A new `MASTER` event is created**, starting from the first event that
|
|
3058
|
-
* begins after `splitLocalDate`.
|
|
3059
|
-
* - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**.
|
|
3060
|
-
* Their `recurringEventId` is set to the ID of the newly created `MASTER` event.
|
|
3061
|
-
* @param recurringEventId - ID of the `MASTER` event to split.
|
|
3062
|
-
* @param splitLocalDate - Local date and time at which the `MASTER` event is split in
|
|
3063
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
3064
|
-
* `2025-03-11T09:00:00`.
|
|
3065
|
-
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
3066
|
-
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
3067
|
-
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
3068
|
-
* wouldn't affect any event without a subsequent occurrence.
|
|
3069
|
-
* @public
|
|
3070
|
-
* @requiredField recurringEventId
|
|
3071
|
-
* @requiredField splitLocalDate
|
|
3072
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
3073
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
3074
|
-
* @permissionScope Manage Calendars
|
|
3075
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3076
|
-
* @permissionScope Manage Bookings
|
|
3077
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3078
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3079
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3080
|
-
* @permissionScope Manage Calendars
|
|
3081
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3082
|
-
* @permissionScope Manage Bookings
|
|
3083
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3084
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3085
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3086
|
-
* @applicableIdentity APP
|
|
3087
|
-
* @fqn wix.calendar.events.v3.EventsService.SplitRecurringEvent
|
|
3088
|
-
*/
|
|
3089
|
-
export declare function splitRecurringEvent(recurringEventId: string, splitLocalDate: string, options?: SplitRecurringEventOptions): Promise<NonNullablePaths<SplitRecurringEventResponse, {
|
|
3090
|
-
[P in EventNonNullablePaths]: `updatedRecurringEventEndingBeforeSplit.${P}`;
|
|
3091
|
-
}[EventNonNullablePaths] | {
|
|
3092
|
-
[P in EventNonNullablePaths]: `newRecurringEventStartingFromSplit.${P}`;
|
|
3093
|
-
}[EventNonNullablePaths]>>;
|
|
3094
|
-
export interface SplitRecurringEventOptions {
|
|
2442
|
+
interface SplitRecurringEventOptions {
|
|
3095
2443
|
/**
|
|
3096
2444
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
3097
2445
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -3101,32 +2449,7 @@ export interface SplitRecurringEventOptions {
|
|
|
3101
2449
|
*/
|
|
3102
2450
|
timeZone?: string | null;
|
|
3103
2451
|
}
|
|
3104
|
-
|
|
3105
|
-
* Cancels an event.
|
|
3106
|
-
* @param eventId - ID of the event to cancel.
|
|
3107
|
-
* @public
|
|
3108
|
-
* @requiredField eventId
|
|
3109
|
-
* @permissionId CALENDAR.EVENT_CANCEL_OWN
|
|
3110
|
-
* @permissionId CALENDAR.EVENT_CANCEL
|
|
3111
|
-
* @permissionScope Manage Calendars
|
|
3112
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3113
|
-
* @permissionScope Manage Bookings
|
|
3114
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3115
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3116
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3117
|
-
* @permissionScope Manage Calendars
|
|
3118
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3119
|
-
* @permissionScope Manage Bookings
|
|
3120
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3121
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3122
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3123
|
-
* @applicableIdentity APP
|
|
3124
|
-
* @fqn wix.calendar.events.v3.EventsService.CancelEvent
|
|
3125
|
-
*/
|
|
3126
|
-
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
|
|
3127
|
-
[P in EventNonNullablePaths]: `event.${P}`;
|
|
3128
|
-
}[EventNonNullablePaths]>>;
|
|
3129
|
-
export interface CancelEventOptions {
|
|
2452
|
+
interface CancelEventOptions {
|
|
3130
2453
|
/**
|
|
3131
2454
|
* Information about whether participants of the canceled event are notified and
|
|
3132
2455
|
* the message they receive.
|
|
@@ -3141,32 +2464,7 @@ export interface CancelEventOptions {
|
|
|
3141
2464
|
*/
|
|
3142
2465
|
timeZone?: string | null;
|
|
3143
2466
|
}
|
|
3144
|
-
|
|
3145
|
-
* Cancels multiple events in bulk.
|
|
3146
|
-
* @param eventIds - IDs of the events to cancel.
|
|
3147
|
-
* @public
|
|
3148
|
-
* @requiredField eventIds
|
|
3149
|
-
* @permissionId CALENDAR.EVENT_CANCEL_OWN
|
|
3150
|
-
* @permissionId CALENDAR.EVENT_CANCEL
|
|
3151
|
-
* @permissionScope Manage Calendars
|
|
3152
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3153
|
-
* @permissionScope Manage Bookings
|
|
3154
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3155
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3156
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3157
|
-
* @permissionScope Manage Calendars
|
|
3158
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3159
|
-
* @permissionScope Manage Bookings
|
|
3160
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3161
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3162
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3163
|
-
* @applicableIdentity APP
|
|
3164
|
-
* @fqn wix.calendar.events.v3.EventsService.BulkCancelEvent
|
|
3165
|
-
*/
|
|
3166
|
-
export declare function bulkCancelEvent(eventIds: string[], options?: BulkCancelEventOptions): Promise<NonNullablePaths<BulkCancelEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
3167
|
-
[P in EventNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3168
|
-
}[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
|
|
3169
|
-
export interface BulkCancelEventOptions {
|
|
2467
|
+
interface BulkCancelEventOptions {
|
|
3170
2468
|
/**
|
|
3171
2469
|
* Whether to return the canceled events.
|
|
3172
2470
|
*
|
|
@@ -3187,4 +2485,5 @@ export interface BulkCancelEventOptions {
|
|
|
3187
2485
|
*/
|
|
3188
2486
|
timeZone?: string | null;
|
|
3189
2487
|
}
|
|
3190
|
-
|
|
2488
|
+
|
|
2489
|
+
export { type Participants as $, Type as A, type BulkCreateEventOptions as B, type CreateEventOptions as C, Day as D, type Event as E, type FieldWithLiterals as F, type GetEventOptions as G, Field as H, IdentityType as I, PlacementType as J, DayOfWeek as K, type ListEventsByContactIdOptions as L, type MaskedEvent as M, ResolutionMethod as N, RequestedFields as O, ParticipantsStatus as P, type QueryEventsOptions as Q, type RestoreEventDefaultsOptions as R, type SplitRecurringEventOptions as S, Transparency as T, type UpdateEvent as U, SortOrder as V, WebhookIdentityType as W, type RecurrenceRule as X, type Location as Y, type ZonedDate as Z, type Resource as _, type ListEventsByContactIdResponse as a, type CreateEventRequest as a$, type Participant as a0, type ConferencingDetails as a1, type Permission as a2, type CommonIdentificationData as a3, type CommonIdentificationDataIdOneOf as a4, type ExtendedFields as a5, type RecurringEventSplit as a6, type EventCancelled as a7, type ParticipantNotification as a8, type EventUpdatedWithMetadata as a9, type GeoCoordinates as aA, type BusinessSchedule as aB, type TimePeriod as aC, type SpecialHourPeriod as aD, type Multilingual as aE, type SupportedLanguage as aF, type ConsentPolicy as aG, type Translation as aH, type ChangeContext as aI, type ChangeContextPayloadOneOf as aJ, type PropertiesChange as aK, type SiteCreated as aL, type SiteCloned as aM, type Empty as aN, type GetEventRequest as aO, type GetEventResponse as aP, type ListEventsRequest as aQ, type QueryEventsRequest as aR, type CursorQuery as aS, type CursorQueryPagingMethodOneOf as aT, type Sorting as aU, type CursorPaging as aV, type QueryEventsResponse as aW, type CursorPagingMetadata as aX, type Cursors as aY, type ListRecurringEventInstancesHistoryRequest as aZ, type ListRecurringEventInstancesHistoryResponse as a_, type UpdateScheduleWithFixedBusinessResourceIdRequest as aa, type UpdateScheduleWithFixedBusinessResourceIdResponse as ab, type UpdateEventsWithFixedBusinessResourceIdRequest as ac, type UpdateEventsWithFixedBusinessResourceIdResponse as ad, type DomainEvent as ae, type DomainEventBodyOneOf as af, type EntityCreatedEvent as ag, type RestoreInfo as ah, type EntityUpdatedEvent as ai, type EntityDeletedEvent as aj, type ActionEvent as ak, type MessageEnvelope as al, type IdentificationData as am, type IdentificationDataIdOneOf as an, type ListEventsByContactIdRequest as ao, type CommonCursorPaging as ap, type CommonCursorPagingMetadata as aq, type CommonCursors as ar, type ListEventsByMemberIdRequest as as, type SitePropertiesNotification as at, type SitePropertiesEvent as au, type Properties as av, type Categories as aw, type Locale as ax, type Address as ay, type AddressHint as az, type ListEventsByMemberIdOptions as b, type CreateEventResponse as b0, type BulkCreateEventRequest as b1, type BulkEventResult as b2, type ItemMetadata as b3, type ApplicationError as b4, type BulkActionMetadata as b5, type UpdateEventRequest as b6, type UpdateEventResponse as b7, type BulkUpdateEventRequest as b8, type UpdateEventParticipantsRequest as b9, type UpdateEventParticipantsResponse as ba, type RestoreEventDefaultsRequest as bb, type SplitRecurringEventRequest as bc, type CancelEventRequest as bd, type BulkCancelEventRequest as be, type BaseEventMetadata as bf, type EventMetadata as bg, type EventsQueryResult as bh, type ListEventsByMemberIdResponse as c, type ListEventsOptions as d, type ListEventsResponse as e, type EventsQueryBuilder as f, type BulkCreateEventResponse as g, type UpdateEventOptions as h, type BulkUpdateEventRequestMaskedEvent as i, type BulkUpdateEventOptions as j, type BulkUpdateEventResponse as k, type RestoreEventDefaultsResponse as l, type SplitRecurringEventResponse as m, type CancelEventOptions as n, type CancelEventResponse as o, type BulkCancelEventOptions as p, type BulkCancelEventResponse as q, type EventCancelledEnvelope as r, type EventCreatedEnvelope as s, type EventRecurringSplitEnvelope as t, type EventUpdatedEnvelope as u, Status as v, RecurrenceType as w, Frequency as x, LocationType as y, Role as z };
|