@wix/auto_sdk_calendar_events 1.0.15 → 1.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-DwDyFLdW.d.mts} +137 -875
- package/build/{cjs/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-DwDyFLdW.d.ts} +137 -875
- package/build/{cjs/src/calendar-v3-event-events.public.d.ts → index.d.mts} +63 -23
- package/build/{internal/cjs/src/calendar-v3-event-events.public.d.ts → index.d.ts} +63 -23
- package/build/index.js +1548 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1491 -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-DwDyFLdW.d.mts} +137 -875
- package/build/internal/{es/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-DwDyFLdW.d.ts} +137 -875
- package/build/{es/src/calendar-v3-event-events.public.d.ts → internal/index.d.mts} +63 -23
- package/build/internal/{es/src/calendar-v3-event-events.public.d.ts → index.d.ts} +63 -23
- package/build/internal/index.js +1548 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1491 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/calendar-v3-event-events.types.d.ts → internal/meta.d.mts} +108 -581
- package/build/internal/{es/src/calendar-v3-event-events.types.d.ts → meta.d.ts} +108 -581
- 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} +108 -581
- package/build/{internal/cjs/src/calendar-v3-event-events.types.d.ts → meta.d.ts} +108 -581
- 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 +13 -12
- 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 -1202
- 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 -1163
- 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 -1202
- 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 -1163
- 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,7 +246,7 @@ export declare enum Status {
|
|
|
247
246
|
CANCELLED = "CANCELLED"
|
|
248
247
|
}
|
|
249
248
|
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
250
|
-
|
|
249
|
+
interface ZonedDate {
|
|
251
250
|
/**
|
|
252
251
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
253
252
|
* For example, `2024-01-30T13:30:00`.
|
|
@@ -270,7 +269,7 @@ export interface ZonedDate {
|
|
|
270
269
|
*/
|
|
271
270
|
utcDate?: Date | null;
|
|
272
271
|
}
|
|
273
|
-
|
|
272
|
+
declare enum RecurrenceType {
|
|
274
273
|
UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
|
|
275
274
|
/** The event occurs only once and doesn't repeat. */
|
|
276
275
|
NONE = "NONE",
|
|
@@ -281,7 +280,7 @@ export declare enum RecurrenceType {
|
|
|
281
280
|
/** A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event. */
|
|
282
281
|
EXCEPTION = "EXCEPTION"
|
|
283
282
|
}
|
|
284
|
-
|
|
283
|
+
interface RecurrenceRule {
|
|
285
284
|
/**
|
|
286
285
|
* Frequency how often the event repeats. Works together with `interval`.
|
|
287
286
|
*
|
|
@@ -325,12 +324,12 @@ export interface RecurrenceRule {
|
|
|
325
324
|
*/
|
|
326
325
|
adjustedUntil?: ZonedDate;
|
|
327
326
|
}
|
|
328
|
-
|
|
327
|
+
declare enum Frequency {
|
|
329
328
|
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
330
329
|
/** The event's recurrence pattern is based on weeks. */
|
|
331
330
|
WEEKLY = "WEEKLY"
|
|
332
331
|
}
|
|
333
|
-
|
|
332
|
+
declare enum Day {
|
|
334
333
|
/** The recurring event takes place on Mondays. */
|
|
335
334
|
MONDAY = "MONDAY",
|
|
336
335
|
/** The recurring event takes place on Tuesdays. */
|
|
@@ -346,14 +345,14 @@ export declare enum Day {
|
|
|
346
345
|
/** The recurring event takes place on Sundays. */
|
|
347
346
|
SUNDAY = "SUNDAY"
|
|
348
347
|
}
|
|
349
|
-
|
|
348
|
+
declare enum Transparency {
|
|
350
349
|
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
351
350
|
/** 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. */
|
|
352
351
|
OPAQUE = "OPAQUE",
|
|
353
352
|
/** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
|
|
354
353
|
TRANSPARENT = "TRANSPARENT"
|
|
355
354
|
}
|
|
356
|
-
|
|
355
|
+
interface Location {
|
|
357
356
|
/**
|
|
358
357
|
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
359
358
|
* ID. Available only for `BUSINESS` locations.
|
|
@@ -389,7 +388,7 @@ export interface Location {
|
|
|
389
388
|
*/
|
|
390
389
|
address?: string | null;
|
|
391
390
|
}
|
|
392
|
-
|
|
391
|
+
declare enum LocationType {
|
|
393
392
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
394
393
|
/** The event is held at a business location. */
|
|
395
394
|
BUSINESS = "BUSINESS",
|
|
@@ -398,7 +397,7 @@ export declare enum LocationType {
|
|
|
398
397
|
/** The event is held at an address or venue not tied to the business or customer. */
|
|
399
398
|
CUSTOM = "CUSTOM"
|
|
400
399
|
}
|
|
401
|
-
|
|
400
|
+
interface Resource {
|
|
402
401
|
/**
|
|
403
402
|
* Resource ID.
|
|
404
403
|
* @format GUID
|
|
@@ -431,14 +430,14 @@ export interface Resource {
|
|
|
431
430
|
*/
|
|
432
431
|
permissionRole?: Role;
|
|
433
432
|
}
|
|
434
|
-
|
|
433
|
+
declare enum Role {
|
|
435
434
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
436
435
|
/** Full read and write access. */
|
|
437
436
|
WRITER = "WRITER",
|
|
438
437
|
/** Full read access, write access limited to `event.notes`. */
|
|
439
438
|
COMMENTER = "COMMENTER"
|
|
440
439
|
}
|
|
441
|
-
|
|
440
|
+
interface Participants {
|
|
442
441
|
/**
|
|
443
442
|
* Total number of participants.
|
|
444
443
|
*
|
|
@@ -468,7 +467,7 @@ export interface Participants {
|
|
|
468
467
|
*/
|
|
469
468
|
status?: ParticipantsStatus;
|
|
470
469
|
}
|
|
471
|
-
|
|
470
|
+
interface Participant {
|
|
472
471
|
/**
|
|
473
472
|
* Participant name.
|
|
474
473
|
*
|
|
@@ -495,14 +494,14 @@ export interface Participant {
|
|
|
495
494
|
*/
|
|
496
495
|
contactId?: string | null;
|
|
497
496
|
}
|
|
498
|
-
|
|
497
|
+
declare enum ParticipantsStatus {
|
|
499
498
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
500
499
|
/** All participants are confirmed. */
|
|
501
500
|
CONFIRMED = "CONFIRMED",
|
|
502
501
|
/** At least one participant isn't confirmed yet. */
|
|
503
502
|
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
504
503
|
}
|
|
505
|
-
|
|
504
|
+
interface ConferencingDetails {
|
|
506
505
|
/** Conference type. For example, `Zoom`. */
|
|
507
506
|
type?: Type;
|
|
508
507
|
/**
|
|
@@ -542,12 +541,12 @@ export interface ConferencingDetails {
|
|
|
542
541
|
*/
|
|
543
542
|
externalId?: string | null;
|
|
544
543
|
}
|
|
545
|
-
|
|
544
|
+
declare enum Type {
|
|
546
545
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
547
546
|
ZOOM = "ZOOM",
|
|
548
547
|
CUSTOM = "CUSTOM"
|
|
549
548
|
}
|
|
550
|
-
|
|
549
|
+
declare enum Field {
|
|
551
550
|
UNKNOWN_FIELD = "UNKNOWN_FIELD",
|
|
552
551
|
/** `title` is inherited from the schedule or `MASTER` event. */
|
|
553
552
|
TITLE = "TITLE",
|
|
@@ -566,7 +565,7 @@ export declare enum Field {
|
|
|
566
565
|
/** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
|
|
567
566
|
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
568
567
|
}
|
|
569
|
-
|
|
568
|
+
interface Permission {
|
|
570
569
|
/**
|
|
571
570
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
572
571
|
* granted the permission.
|
|
@@ -581,7 +580,7 @@ export interface Permission {
|
|
|
581
580
|
*/
|
|
582
581
|
role?: Role;
|
|
583
582
|
}
|
|
584
|
-
|
|
583
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
585
584
|
/**
|
|
586
585
|
* ID of a Wix user. For example, the site owner or a
|
|
587
586
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -590,7 +589,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
590
589
|
wixUserId?: string;
|
|
591
590
|
}
|
|
592
591
|
/** @oneof */
|
|
593
|
-
|
|
592
|
+
interface CommonIdentificationDataIdOneOf {
|
|
594
593
|
/**
|
|
595
594
|
* ID of a Wix user. For example, the site owner or a
|
|
596
595
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -598,11 +597,11 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
598
597
|
*/
|
|
599
598
|
wixUserId?: string;
|
|
600
599
|
}
|
|
601
|
-
|
|
600
|
+
declare enum IdentityType {
|
|
602
601
|
UNKNOWN = "UNKNOWN",
|
|
603
602
|
WIX_USER = "WIX_USER"
|
|
604
603
|
}
|
|
605
|
-
|
|
604
|
+
interface ExtendedFields {
|
|
606
605
|
/**
|
|
607
606
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
608
607
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -613,17 +612,17 @@ export interface ExtendedFields {
|
|
|
613
612
|
*/
|
|
614
613
|
namespaces?: Record<string, Record<string, any>>;
|
|
615
614
|
}
|
|
616
|
-
|
|
615
|
+
interface RecurringEventSplit {
|
|
617
616
|
/** Original `MASTER` event that was shortened. */
|
|
618
617
|
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
619
618
|
/** New `MASTER` event starting with the first event after the split date. */
|
|
620
619
|
newRecurringEventStartingFromSplit?: Event;
|
|
621
620
|
}
|
|
622
|
-
|
|
621
|
+
interface EventCancelled {
|
|
623
622
|
/** Canceled event. */
|
|
624
623
|
event?: Event;
|
|
625
624
|
}
|
|
626
|
-
|
|
625
|
+
interface ParticipantNotification {
|
|
627
626
|
/**
|
|
628
627
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
629
628
|
*
|
|
@@ -641,7 +640,7 @@ export interface ParticipantNotification {
|
|
|
641
640
|
message?: string | null;
|
|
642
641
|
}
|
|
643
642
|
/** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
|
|
644
|
-
|
|
643
|
+
interface EventUpdatedWithMetadata {
|
|
645
644
|
/** The updated event. */
|
|
646
645
|
event?: Event;
|
|
647
646
|
/**
|
|
@@ -650,25 +649,25 @@ export interface EventUpdatedWithMetadata {
|
|
|
650
649
|
*/
|
|
651
650
|
participantNotification?: ParticipantNotification;
|
|
652
651
|
}
|
|
653
|
-
|
|
652
|
+
interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
654
653
|
/** @format GUID */
|
|
655
654
|
metaSiteId?: string;
|
|
656
655
|
/** @format GUID */
|
|
657
656
|
currentBusinessResourceId?: string;
|
|
658
657
|
migrateBusinessConferenceId?: boolean;
|
|
659
658
|
}
|
|
660
|
-
|
|
659
|
+
interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
661
660
|
}
|
|
662
|
-
|
|
661
|
+
interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
663
662
|
/** @format GUID */
|
|
664
663
|
metaSiteId?: string;
|
|
665
664
|
/** @format GUID */
|
|
666
665
|
currentBusinessResourceId?: string;
|
|
667
666
|
migrateBusinessConferenceId?: boolean;
|
|
668
667
|
}
|
|
669
|
-
|
|
668
|
+
interface UpdateEventsWithFixedBusinessResourceIdResponse {
|
|
670
669
|
}
|
|
671
|
-
|
|
670
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
672
671
|
createdEvent?: EntityCreatedEvent;
|
|
673
672
|
updatedEvent?: EntityUpdatedEvent;
|
|
674
673
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -711,19 +710,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
711
710
|
entityEventSequence?: string | null;
|
|
712
711
|
}
|
|
713
712
|
/** @oneof */
|
|
714
|
-
|
|
713
|
+
interface DomainEventBodyOneOf {
|
|
715
714
|
createdEvent?: EntityCreatedEvent;
|
|
716
715
|
updatedEvent?: EntityUpdatedEvent;
|
|
717
716
|
deletedEvent?: EntityDeletedEvent;
|
|
718
717
|
actionEvent?: ActionEvent;
|
|
719
718
|
}
|
|
720
|
-
|
|
719
|
+
interface EntityCreatedEvent {
|
|
721
720
|
entity?: string;
|
|
722
721
|
}
|
|
723
|
-
|
|
722
|
+
interface RestoreInfo {
|
|
724
723
|
deletedDate?: Date | null;
|
|
725
724
|
}
|
|
726
|
-
|
|
725
|
+
interface EntityUpdatedEvent {
|
|
727
726
|
/**
|
|
728
727
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
729
728
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -731,14 +730,14 @@ export interface EntityUpdatedEvent {
|
|
|
731
730
|
*/
|
|
732
731
|
currentEntity?: string;
|
|
733
732
|
}
|
|
734
|
-
|
|
733
|
+
interface EntityDeletedEvent {
|
|
735
734
|
/** Entity that was deleted */
|
|
736
735
|
deletedEntity?: string | null;
|
|
737
736
|
}
|
|
738
|
-
|
|
737
|
+
interface ActionEvent {
|
|
739
738
|
body?: string;
|
|
740
739
|
}
|
|
741
|
-
|
|
740
|
+
interface MessageEnvelope {
|
|
742
741
|
/**
|
|
743
742
|
* App instance ID.
|
|
744
743
|
* @format GUID
|
|
@@ -754,7 +753,7 @@ export interface MessageEnvelope {
|
|
|
754
753
|
/** Stringify payload. */
|
|
755
754
|
data?: string;
|
|
756
755
|
}
|
|
757
|
-
|
|
756
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
758
757
|
/**
|
|
759
758
|
* ID of a site visitor that has not logged in to the site.
|
|
760
759
|
* @format GUID
|
|
@@ -779,7 +778,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
779
778
|
identityType?: WebhookIdentityType;
|
|
780
779
|
}
|
|
781
780
|
/** @oneof */
|
|
782
|
-
|
|
781
|
+
interface IdentificationDataIdOneOf {
|
|
783
782
|
/**
|
|
784
783
|
* ID of a site visitor that has not logged in to the site.
|
|
785
784
|
* @format GUID
|
|
@@ -801,14 +800,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
801
800
|
*/
|
|
802
801
|
appId?: string;
|
|
803
802
|
}
|
|
804
|
-
|
|
803
|
+
declare enum WebhookIdentityType {
|
|
805
804
|
UNKNOWN = "UNKNOWN",
|
|
806
805
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
807
806
|
MEMBER = "MEMBER",
|
|
808
807
|
WIX_USER = "WIX_USER",
|
|
809
808
|
APP = "APP"
|
|
810
809
|
}
|
|
811
|
-
|
|
810
|
+
interface ListEventsByContactIdRequest {
|
|
812
811
|
/**
|
|
813
812
|
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
814
813
|
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
@@ -854,7 +853,7 @@ export interface ListEventsByContactIdRequest {
|
|
|
854
853
|
cursorPaging?: CommonCursorPaging;
|
|
855
854
|
}
|
|
856
855
|
/** TODO Diverge */
|
|
857
|
-
|
|
856
|
+
interface CommonCursorPaging {
|
|
858
857
|
/**
|
|
859
858
|
* Number of events to return.
|
|
860
859
|
* Defaults to `50`. Maximum `100`.
|
|
@@ -871,14 +870,14 @@ export interface CommonCursorPaging {
|
|
|
871
870
|
*/
|
|
872
871
|
cursor?: string | null;
|
|
873
872
|
}
|
|
874
|
-
|
|
873
|
+
interface ListEventsByContactIdResponse {
|
|
875
874
|
/** Retrieved events. */
|
|
876
875
|
events?: Event[];
|
|
877
876
|
/** Paging metadata. */
|
|
878
877
|
pagingMetadata?: CommonCursorPagingMetadata;
|
|
879
878
|
}
|
|
880
879
|
/** TODO Diverge */
|
|
881
|
-
|
|
880
|
+
interface CommonCursorPagingMetadata {
|
|
882
881
|
/** Number of items returned in the response. */
|
|
883
882
|
count?: number | null;
|
|
884
883
|
/** 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). */
|
|
@@ -890,11 +889,11 @@ export interface CommonCursorPagingMetadata {
|
|
|
890
889
|
*/
|
|
891
890
|
hasNext?: boolean | null;
|
|
892
891
|
}
|
|
893
|
-
|
|
892
|
+
interface CommonCursors {
|
|
894
893
|
/** Cursor pointing to next page in the list of results. */
|
|
895
894
|
next?: string | null;
|
|
896
895
|
}
|
|
897
|
-
|
|
896
|
+
interface ListEventsByMemberIdRequest {
|
|
898
897
|
/**
|
|
899
898
|
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
900
899
|
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
@@ -954,14 +953,14 @@ export interface ListEventsByMemberIdRequest {
|
|
|
954
953
|
*/
|
|
955
954
|
eventIds?: string[];
|
|
956
955
|
}
|
|
957
|
-
|
|
956
|
+
interface ListEventsByMemberIdResponse {
|
|
958
957
|
/** Retrieved events. */
|
|
959
958
|
events?: Event[];
|
|
960
959
|
/** Paging metadata. */
|
|
961
960
|
pagingMetadata?: CommonCursorPagingMetadata;
|
|
962
961
|
}
|
|
963
962
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
964
|
-
|
|
963
|
+
interface SitePropertiesNotification {
|
|
965
964
|
/** The site ID for which this update notification applies. */
|
|
966
965
|
metasiteId?: string;
|
|
967
966
|
/** The actual update event. */
|
|
@@ -975,7 +974,7 @@ export interface SitePropertiesNotification {
|
|
|
975
974
|
changeContext?: ChangeContext;
|
|
976
975
|
}
|
|
977
976
|
/** The actual update event for a particular notification. */
|
|
978
|
-
|
|
977
|
+
interface SitePropertiesEvent {
|
|
979
978
|
/** Version of the site's properties represented by this update. */
|
|
980
979
|
version?: number;
|
|
981
980
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -983,7 +982,7 @@ export interface SitePropertiesEvent {
|
|
|
983
982
|
/** Updated properties. */
|
|
984
983
|
properties?: Properties;
|
|
985
984
|
}
|
|
986
|
-
|
|
985
|
+
interface Properties {
|
|
987
986
|
/** Site categories. */
|
|
988
987
|
categories?: Categories;
|
|
989
988
|
/** Site locale. */
|
|
@@ -1039,7 +1038,7 @@ export interface Properties {
|
|
|
1039
1038
|
/** Track clicks analytics. */
|
|
1040
1039
|
trackClicksAnalytics?: boolean;
|
|
1041
1040
|
}
|
|
1042
|
-
|
|
1041
|
+
interface Categories {
|
|
1043
1042
|
/** Primary site category. */
|
|
1044
1043
|
primary?: string;
|
|
1045
1044
|
/**
|
|
@@ -1050,13 +1049,13 @@ export interface Categories {
|
|
|
1050
1049
|
/** Business Term Id */
|
|
1051
1050
|
businessTermId?: string | null;
|
|
1052
1051
|
}
|
|
1053
|
-
|
|
1052
|
+
interface Locale {
|
|
1054
1053
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1055
1054
|
languageCode?: string;
|
|
1056
1055
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1057
1056
|
country?: string;
|
|
1058
1057
|
}
|
|
1059
|
-
|
|
1058
|
+
interface Address {
|
|
1060
1059
|
/** Street name. */
|
|
1061
1060
|
street?: string;
|
|
1062
1061
|
/** City name. */
|
|
@@ -1088,27 +1087,27 @@ export interface Address {
|
|
|
1088
1087
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1089
1088
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1090
1089
|
*/
|
|
1091
|
-
|
|
1090
|
+
interface AddressHint {
|
|
1092
1091
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1093
1092
|
text?: string;
|
|
1094
1093
|
/** Where the extra text should be displayed. */
|
|
1095
1094
|
placement?: PlacementType;
|
|
1096
1095
|
}
|
|
1097
1096
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1098
|
-
|
|
1097
|
+
declare enum PlacementType {
|
|
1099
1098
|
BEFORE = "BEFORE",
|
|
1100
1099
|
AFTER = "AFTER",
|
|
1101
1100
|
REPLACE = "REPLACE"
|
|
1102
1101
|
}
|
|
1103
1102
|
/** Geocoordinates for a particular address. */
|
|
1104
|
-
|
|
1103
|
+
interface GeoCoordinates {
|
|
1105
1104
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
1106
1105
|
latitude?: number;
|
|
1107
1106
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
1108
1107
|
longitude?: number;
|
|
1109
1108
|
}
|
|
1110
1109
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1111
|
-
|
|
1110
|
+
interface BusinessSchedule {
|
|
1112
1111
|
/**
|
|
1113
1112
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1114
1113
|
* @maxSize 100
|
|
@@ -1121,7 +1120,7 @@ export interface BusinessSchedule {
|
|
|
1121
1120
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1122
1121
|
}
|
|
1123
1122
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1124
|
-
|
|
1123
|
+
interface TimePeriod {
|
|
1125
1124
|
/** Day of the week the period starts on. */
|
|
1126
1125
|
openDay?: DayOfWeek;
|
|
1127
1126
|
/**
|
|
@@ -1140,7 +1139,7 @@ export interface TimePeriod {
|
|
|
1140
1139
|
closeTime?: string;
|
|
1141
1140
|
}
|
|
1142
1141
|
/** Enumerates the days of the week. */
|
|
1143
|
-
|
|
1142
|
+
declare enum DayOfWeek {
|
|
1144
1143
|
MONDAY = "MONDAY",
|
|
1145
1144
|
TUESDAY = "TUESDAY",
|
|
1146
1145
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -1150,7 +1149,7 @@ export declare enum DayOfWeek {
|
|
|
1150
1149
|
SUNDAY = "SUNDAY"
|
|
1151
1150
|
}
|
|
1152
1151
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1153
|
-
|
|
1152
|
+
interface SpecialHourPeriod {
|
|
1154
1153
|
/** 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). */
|
|
1155
1154
|
startDate?: string;
|
|
1156
1155
|
/** 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). */
|
|
@@ -1164,7 +1163,7 @@ export interface SpecialHourPeriod {
|
|
|
1164
1163
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1165
1164
|
comment?: string;
|
|
1166
1165
|
}
|
|
1167
|
-
|
|
1166
|
+
interface Multilingual {
|
|
1168
1167
|
/**
|
|
1169
1168
|
* Supported languages list.
|
|
1170
1169
|
* @maxSize 200
|
|
@@ -1173,7 +1172,7 @@ export interface Multilingual {
|
|
|
1173
1172
|
/** Whether to redirect to user language. */
|
|
1174
1173
|
autoRedirect?: boolean;
|
|
1175
1174
|
}
|
|
1176
|
-
|
|
1175
|
+
interface SupportedLanguage {
|
|
1177
1176
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1178
1177
|
languageCode?: string;
|
|
1179
1178
|
/** Locale. */
|
|
@@ -1185,12 +1184,12 @@ export interface SupportedLanguage {
|
|
|
1185
1184
|
/** How the language will be resolved. For internal use. */
|
|
1186
1185
|
resolutionMethod?: ResolutionMethod;
|
|
1187
1186
|
}
|
|
1188
|
-
|
|
1187
|
+
declare enum ResolutionMethod {
|
|
1189
1188
|
QUERY_PARAM = "QUERY_PARAM",
|
|
1190
1189
|
SUBDOMAIN = "SUBDOMAIN",
|
|
1191
1190
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1192
1191
|
}
|
|
1193
|
-
|
|
1192
|
+
interface ConsentPolicy {
|
|
1194
1193
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1195
1194
|
essential?: boolean | null;
|
|
1196
1195
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -1203,7 +1202,7 @@ export interface ConsentPolicy {
|
|
|
1203
1202
|
dataToThirdParty?: boolean | null;
|
|
1204
1203
|
}
|
|
1205
1204
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1206
|
-
|
|
1205
|
+
interface Translation {
|
|
1207
1206
|
/** The service type. */
|
|
1208
1207
|
serviceType?: string;
|
|
1209
1208
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -1211,7 +1210,7 @@ export interface Translation {
|
|
|
1211
1210
|
/** The instance ID of the service. */
|
|
1212
1211
|
instanceId?: string;
|
|
1213
1212
|
}
|
|
1214
|
-
|
|
1213
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1215
1214
|
/** Properties were updated. */
|
|
1216
1215
|
propertiesChange?: PropertiesChange;
|
|
1217
1216
|
/** Default properties were created on site creation. */
|
|
@@ -1220,7 +1219,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
1220
1219
|
siteCloned?: SiteCloned;
|
|
1221
1220
|
}
|
|
1222
1221
|
/** @oneof */
|
|
1223
|
-
|
|
1222
|
+
interface ChangeContextPayloadOneOf {
|
|
1224
1223
|
/** Properties were updated. */
|
|
1225
1224
|
propertiesChange?: PropertiesChange;
|
|
1226
1225
|
/** Default properties were created on site creation. */
|
|
@@ -1228,19 +1227,19 @@ export interface ChangeContextPayloadOneOf {
|
|
|
1228
1227
|
/** Properties were cloned on site cloning. */
|
|
1229
1228
|
siteCloned?: SiteCloned;
|
|
1230
1229
|
}
|
|
1231
|
-
|
|
1230
|
+
interface PropertiesChange {
|
|
1232
1231
|
}
|
|
1233
|
-
|
|
1232
|
+
interface SiteCreated {
|
|
1234
1233
|
/** Origin template site id. */
|
|
1235
1234
|
originTemplateId?: string | null;
|
|
1236
1235
|
}
|
|
1237
|
-
|
|
1236
|
+
interface SiteCloned {
|
|
1238
1237
|
/** Origin site id. */
|
|
1239
1238
|
originMetaSiteId?: string;
|
|
1240
1239
|
}
|
|
1241
|
-
|
|
1240
|
+
interface Empty {
|
|
1242
1241
|
}
|
|
1243
|
-
|
|
1242
|
+
interface GetEventRequest {
|
|
1244
1243
|
/**
|
|
1245
1244
|
* ID of the event to retrieve.
|
|
1246
1245
|
*
|
|
@@ -1273,18 +1272,18 @@ export interface GetEventRequest {
|
|
|
1273
1272
|
*/
|
|
1274
1273
|
fields?: RequestedFields[];
|
|
1275
1274
|
}
|
|
1276
|
-
|
|
1275
|
+
declare enum RequestedFields {
|
|
1277
1276
|
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1278
1277
|
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1279
1278
|
PI_FIELDS = "PI_FIELDS",
|
|
1280
1279
|
/** Returns only fields containing your own personal data. */
|
|
1281
1280
|
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1282
1281
|
}
|
|
1283
|
-
|
|
1282
|
+
interface GetEventResponse {
|
|
1284
1283
|
/** Retrieved event. */
|
|
1285
1284
|
event?: Event;
|
|
1286
1285
|
}
|
|
1287
|
-
|
|
1286
|
+
interface ListEventsRequest {
|
|
1288
1287
|
/**
|
|
1289
1288
|
* IDs of the events to retrieve.
|
|
1290
1289
|
*
|
|
@@ -1319,11 +1318,11 @@ export interface ListEventsRequest {
|
|
|
1319
1318
|
*/
|
|
1320
1319
|
fields?: RequestedFields[];
|
|
1321
1320
|
}
|
|
1322
|
-
|
|
1321
|
+
interface ListEventsResponse {
|
|
1323
1322
|
/** Retrieved events matching the provided IDs. */
|
|
1324
1323
|
events?: Event[];
|
|
1325
1324
|
}
|
|
1326
|
-
|
|
1325
|
+
interface QueryEventsRequest {
|
|
1327
1326
|
/**
|
|
1328
1327
|
* Local start date and time from which events are returned in
|
|
1329
1328
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -1380,7 +1379,7 @@ export interface QueryEventsRequest {
|
|
|
1380
1379
|
fields?: RequestedFields[];
|
|
1381
1380
|
}
|
|
1382
1381
|
/** TODO Diverge */
|
|
1383
|
-
|
|
1382
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1384
1383
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1385
1384
|
cursorPaging?: CursorPaging;
|
|
1386
1385
|
/**
|
|
@@ -1401,12 +1400,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1401
1400
|
sort?: Sorting[];
|
|
1402
1401
|
}
|
|
1403
1402
|
/** @oneof */
|
|
1404
|
-
|
|
1403
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1405
1404
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1406
1405
|
cursorPaging?: CursorPaging;
|
|
1407
1406
|
}
|
|
1408
1407
|
/** TODO Diverge */
|
|
1409
|
-
|
|
1408
|
+
interface Sorting {
|
|
1410
1409
|
/**
|
|
1411
1410
|
* The field to sort by.
|
|
1412
1411
|
* Either `start` or `end`.
|
|
@@ -1416,12 +1415,12 @@ export interface Sorting {
|
|
|
1416
1415
|
/** Sort order. */
|
|
1417
1416
|
order?: SortOrder;
|
|
1418
1417
|
}
|
|
1419
|
-
|
|
1418
|
+
declare enum SortOrder {
|
|
1420
1419
|
ASC = "ASC",
|
|
1421
1420
|
DESC = "DESC"
|
|
1422
1421
|
}
|
|
1423
1422
|
/** TODO Diverge */
|
|
1424
|
-
|
|
1423
|
+
interface CursorPaging {
|
|
1425
1424
|
/**
|
|
1426
1425
|
* Number of events to return.
|
|
1427
1426
|
* Defaults to `50`. Maximum `1000`.
|
|
@@ -1438,14 +1437,14 @@ export interface CursorPaging {
|
|
|
1438
1437
|
*/
|
|
1439
1438
|
cursor?: string | null;
|
|
1440
1439
|
}
|
|
1441
|
-
|
|
1440
|
+
interface QueryEventsResponse {
|
|
1442
1441
|
/** Retrieved events matching the provided query. */
|
|
1443
1442
|
events?: Event[];
|
|
1444
1443
|
/** Paging metadata. */
|
|
1445
1444
|
pagingMetadata?: CursorPagingMetadata;
|
|
1446
1445
|
}
|
|
1447
1446
|
/** TODO Diverge */
|
|
1448
|
-
|
|
1447
|
+
interface CursorPagingMetadata {
|
|
1449
1448
|
/** Number of items returned in the response. */
|
|
1450
1449
|
count?: number | null;
|
|
1451
1450
|
/** 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). */
|
|
@@ -1457,11 +1456,11 @@ export interface CursorPagingMetadata {
|
|
|
1457
1456
|
*/
|
|
1458
1457
|
hasNext?: boolean | null;
|
|
1459
1458
|
}
|
|
1460
|
-
|
|
1459
|
+
interface Cursors {
|
|
1461
1460
|
/** Cursor pointing to next page in the list of results. */
|
|
1462
1461
|
next?: string | null;
|
|
1463
1462
|
}
|
|
1464
|
-
|
|
1463
|
+
interface ListRecurringEventInstancesHistoryRequest {
|
|
1465
1464
|
/**
|
|
1466
1465
|
* The ID of the recurring event.
|
|
1467
1466
|
* Required, unless `cursorPaging` is provided.
|
|
@@ -1489,13 +1488,13 @@ export interface ListRecurringEventInstancesHistoryRequest {
|
|
|
1489
1488
|
/** Optional cursor pointing to the next page of events. */
|
|
1490
1489
|
cursorPaging?: CursorPaging;
|
|
1491
1490
|
}
|
|
1492
|
-
|
|
1491
|
+
interface ListRecurringEventInstancesHistoryResponse {
|
|
1493
1492
|
/** The recurring event instances. */
|
|
1494
1493
|
recurringEventInstances?: Event[];
|
|
1495
1494
|
/** Paging metadata. */
|
|
1496
1495
|
pagingMetadata?: CursorPagingMetadata;
|
|
1497
1496
|
}
|
|
1498
|
-
|
|
1497
|
+
interface CreateEventRequest {
|
|
1499
1498
|
/** Event to create. */
|
|
1500
1499
|
event: Event;
|
|
1501
1500
|
/**
|
|
@@ -1513,11 +1512,11 @@ export interface CreateEventRequest {
|
|
|
1513
1512
|
*/
|
|
1514
1513
|
idempotencyKey?: string | null;
|
|
1515
1514
|
}
|
|
1516
|
-
|
|
1515
|
+
interface CreateEventResponse {
|
|
1517
1516
|
/** Created event. */
|
|
1518
1517
|
event?: Event;
|
|
1519
1518
|
}
|
|
1520
|
-
|
|
1519
|
+
interface BulkCreateEventRequest {
|
|
1521
1520
|
/**
|
|
1522
1521
|
* Events to create.
|
|
1523
1522
|
* @minSize 1
|
|
@@ -1539,23 +1538,23 @@ export interface BulkCreateEventRequest {
|
|
|
1539
1538
|
*/
|
|
1540
1539
|
timeZone?: string | null;
|
|
1541
1540
|
}
|
|
1542
|
-
|
|
1541
|
+
interface MaskedEvent {
|
|
1543
1542
|
/** Event to create. */
|
|
1544
1543
|
event?: Event;
|
|
1545
1544
|
}
|
|
1546
|
-
|
|
1545
|
+
interface BulkCreateEventResponse {
|
|
1547
1546
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1548
1547
|
results?: BulkEventResult[];
|
|
1549
1548
|
/** Total successes and failures. */
|
|
1550
1549
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1551
1550
|
}
|
|
1552
|
-
|
|
1551
|
+
interface BulkEventResult {
|
|
1553
1552
|
/** Whether the requested action was successful. */
|
|
1554
1553
|
itemMetadata?: ItemMetadata;
|
|
1555
1554
|
/** The event. */
|
|
1556
1555
|
item?: Event;
|
|
1557
1556
|
}
|
|
1558
|
-
|
|
1557
|
+
interface ItemMetadata {
|
|
1559
1558
|
/**
|
|
1560
1559
|
* Event ID.
|
|
1561
1560
|
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
@@ -1571,7 +1570,7 @@ export interface ItemMetadata {
|
|
|
1571
1570
|
/** Details about the error in case of failure. */
|
|
1572
1571
|
error?: ApplicationError;
|
|
1573
1572
|
}
|
|
1574
|
-
|
|
1573
|
+
interface ApplicationError {
|
|
1575
1574
|
/** Error code. */
|
|
1576
1575
|
code?: string;
|
|
1577
1576
|
/** Description of the error. */
|
|
@@ -1579,13 +1578,13 @@ export interface ApplicationError {
|
|
|
1579
1578
|
/** Data related to the error. */
|
|
1580
1579
|
data?: Record<string, any> | null;
|
|
1581
1580
|
}
|
|
1582
|
-
|
|
1581
|
+
interface BulkActionMetadata {
|
|
1583
1582
|
/** Number of events that were successfully processed. */
|
|
1584
1583
|
totalSuccesses?: number;
|
|
1585
1584
|
/** Number of events that couldn't be processed. */
|
|
1586
1585
|
totalFailures?: number;
|
|
1587
1586
|
}
|
|
1588
|
-
|
|
1587
|
+
interface UpdateEventRequest {
|
|
1589
1588
|
/** Event to update. */
|
|
1590
1589
|
event: Event;
|
|
1591
1590
|
/**
|
|
@@ -1602,11 +1601,11 @@ export interface UpdateEventRequest {
|
|
|
1602
1601
|
*/
|
|
1603
1602
|
timeZone?: string | null;
|
|
1604
1603
|
}
|
|
1605
|
-
|
|
1604
|
+
interface UpdateEventResponse {
|
|
1606
1605
|
/** Updated event. */
|
|
1607
1606
|
event?: Event;
|
|
1608
1607
|
}
|
|
1609
|
-
|
|
1608
|
+
interface BulkUpdateEventRequest {
|
|
1610
1609
|
/**
|
|
1611
1610
|
* Events to update.
|
|
1612
1611
|
*
|
|
@@ -1636,17 +1635,17 @@ export interface BulkUpdateEventRequest {
|
|
|
1636
1635
|
*/
|
|
1637
1636
|
timeZone?: string | null;
|
|
1638
1637
|
}
|
|
1639
|
-
|
|
1638
|
+
interface BulkUpdateEventRequestMaskedEvent {
|
|
1640
1639
|
/** Event to update. */
|
|
1641
1640
|
event?: Event;
|
|
1642
1641
|
}
|
|
1643
|
-
|
|
1642
|
+
interface BulkUpdateEventResponse {
|
|
1644
1643
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1645
1644
|
results?: BulkEventResult[];
|
|
1646
1645
|
/** Total successes and failures. */
|
|
1647
1646
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1648
1647
|
}
|
|
1649
|
-
|
|
1648
|
+
interface UpdateEventParticipantsRequest {
|
|
1650
1649
|
/**
|
|
1651
1650
|
* ID of the event to update.
|
|
1652
1651
|
*
|
|
@@ -1659,11 +1658,11 @@ export interface UpdateEventParticipantsRequest {
|
|
|
1659
1658
|
/** The participants to update. */
|
|
1660
1659
|
participants?: Participants;
|
|
1661
1660
|
}
|
|
1662
|
-
|
|
1661
|
+
interface UpdateEventParticipantsResponse {
|
|
1663
1662
|
/** Updated event. */
|
|
1664
1663
|
event?: Event;
|
|
1665
1664
|
}
|
|
1666
|
-
|
|
1665
|
+
interface RestoreEventDefaultsRequest {
|
|
1667
1666
|
/**
|
|
1668
1667
|
* ID of the event for which to restore default values.
|
|
1669
1668
|
* @minLength 36
|
|
@@ -1693,11 +1692,11 @@ export interface RestoreEventDefaultsRequest {
|
|
|
1693
1692
|
*/
|
|
1694
1693
|
timeZone?: string | null;
|
|
1695
1694
|
}
|
|
1696
|
-
|
|
1695
|
+
interface RestoreEventDefaultsResponse {
|
|
1697
1696
|
/** Updated event. */
|
|
1698
1697
|
event?: Event;
|
|
1699
1698
|
}
|
|
1700
|
-
|
|
1699
|
+
interface SplitRecurringEventRequest {
|
|
1701
1700
|
/**
|
|
1702
1701
|
* ID of the `MASTER` event to split.
|
|
1703
1702
|
* @minLength 36
|
|
@@ -1724,13 +1723,13 @@ export interface SplitRecurringEventRequest {
|
|
|
1724
1723
|
*/
|
|
1725
1724
|
timeZone?: string | null;
|
|
1726
1725
|
}
|
|
1727
|
-
|
|
1726
|
+
interface SplitRecurringEventResponse {
|
|
1728
1727
|
/** Original `MASTER` event that was shortened. */
|
|
1729
1728
|
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1730
1729
|
/** New `MASTER` event starting with the first event after the split date. */
|
|
1731
1730
|
newRecurringEventStartingFromSplit?: Event;
|
|
1732
1731
|
}
|
|
1733
|
-
|
|
1732
|
+
interface CancelEventRequest {
|
|
1734
1733
|
/**
|
|
1735
1734
|
* ID of the event to cancel.
|
|
1736
1735
|
* @minLength 36
|
|
@@ -1751,11 +1750,11 @@ export interface CancelEventRequest {
|
|
|
1751
1750
|
*/
|
|
1752
1751
|
timeZone?: string | null;
|
|
1753
1752
|
}
|
|
1754
|
-
|
|
1753
|
+
interface CancelEventResponse {
|
|
1755
1754
|
/** Canceled event. */
|
|
1756
1755
|
event?: Event;
|
|
1757
1756
|
}
|
|
1758
|
-
|
|
1757
|
+
interface BulkCancelEventRequest {
|
|
1759
1758
|
/**
|
|
1760
1759
|
* IDs of the events to cancel.
|
|
1761
1760
|
* @minSize 1
|
|
@@ -1782,13 +1781,13 @@ export interface BulkCancelEventRequest {
|
|
|
1782
1781
|
*/
|
|
1783
1782
|
timeZone?: string | null;
|
|
1784
1783
|
}
|
|
1785
|
-
|
|
1784
|
+
interface BulkCancelEventResponse {
|
|
1786
1785
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1787
1786
|
results?: BulkEventResult[];
|
|
1788
1787
|
/** Total successes and failures. */
|
|
1789
1788
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1790
1789
|
}
|
|
1791
|
-
|
|
1790
|
+
interface BaseEventMetadata {
|
|
1792
1791
|
/**
|
|
1793
1792
|
* App instance ID.
|
|
1794
1793
|
* @format GUID
|
|
@@ -1802,7 +1801,7 @@ export interface BaseEventMetadata {
|
|
|
1802
1801
|
/** The identification type and identity data. */
|
|
1803
1802
|
identity?: IdentificationData;
|
|
1804
1803
|
}
|
|
1805
|
-
|
|
1804
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1806
1805
|
/**
|
|
1807
1806
|
* Unique event ID.
|
|
1808
1807
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1840,173 +1839,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1840
1839
|
*/
|
|
1841
1840
|
entityEventSequence?: string | null;
|
|
1842
1841
|
}
|
|
1843
|
-
|
|
1842
|
+
interface EventCancelledEnvelope {
|
|
1844
1843
|
data: EventCancelled;
|
|
1845
1844
|
metadata: EventMetadata;
|
|
1846
1845
|
}
|
|
1847
|
-
|
|
1848
|
-
* Triggered when an event is canceled.
|
|
1849
|
-
*
|
|
1850
|
-
* Not triggered when `INSTANCE` events are canceled. You can use the
|
|
1851
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1852
|
-
* to get notified about `INSTANCE` events.
|
|
1853
|
-
* @permissionScope Read Calendar - Including PI
|
|
1854
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1855
|
-
* @permissionScope Manage Calendars
|
|
1856
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1857
|
-
* @permissionScope Manage Bookings
|
|
1858
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1859
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1860
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1861
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1862
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1863
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1864
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1865
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1866
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1867
|
-
* @permissionScope Picasso private app mega scope
|
|
1868
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1869
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1870
|
-
* @webhook
|
|
1871
|
-
* @eventType wix.calendar.v3.event_cancelled
|
|
1872
|
-
* @slug cancelled
|
|
1873
|
-
* @documentationMaturity preview
|
|
1874
|
-
*/
|
|
1875
|
-
export declare function onEventCancelled(handler: (event: EventCancelledEnvelope) => void | Promise<void>): void;
|
|
1876
|
-
export interface EventCreatedEnvelope {
|
|
1846
|
+
interface EventCreatedEnvelope {
|
|
1877
1847
|
entity: Event;
|
|
1878
1848
|
metadata: EventMetadata;
|
|
1879
1849
|
}
|
|
1880
|
-
|
|
1881
|
-
* Triggered when an event is created, including when an existing `MASTER`
|
|
1882
|
-
* event is split.
|
|
1883
|
-
*
|
|
1884
|
-
* Not triggered when `INSTANCE` events are created. You can use the
|
|
1885
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1886
|
-
* to get notified about `INSTANCE` events.
|
|
1887
|
-
* @permissionScope Read Calendar - Including PI
|
|
1888
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1889
|
-
* @permissionScope Manage Calendars
|
|
1890
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1891
|
-
* @permissionScope Manage Bookings
|
|
1892
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1893
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1894
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1895
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1896
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1897
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1898
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1899
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1900
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1901
|
-
* @permissionScope Picasso private app mega scope
|
|
1902
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1903
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1904
|
-
* @webhook
|
|
1905
|
-
* @eventType wix.calendar.v3.event_created
|
|
1906
|
-
* @slug created
|
|
1907
|
-
* @documentationMaturity preview
|
|
1908
|
-
*/
|
|
1909
|
-
export declare function onEventCreated(handler: (event: EventCreatedEnvelope) => void | Promise<void>): void;
|
|
1910
|
-
export interface EventRecurringSplitEnvelope {
|
|
1850
|
+
interface EventRecurringSplitEnvelope {
|
|
1911
1851
|
data: RecurringEventSplit;
|
|
1912
1852
|
metadata: EventMetadata;
|
|
1913
1853
|
}
|
|
1914
|
-
|
|
1915
|
-
* Triggered when a `MASTER` event is split.
|
|
1916
|
-
* @permissionScope Read Calendar - Including PI
|
|
1917
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1918
|
-
* @permissionScope Manage Calendars
|
|
1919
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1920
|
-
* @permissionScope Manage Bookings
|
|
1921
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1922
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1923
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1924
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1925
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1926
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1927
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1928
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1929
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1930
|
-
* @permissionScope Picasso private app mega scope
|
|
1931
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1932
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1933
|
-
* @webhook
|
|
1934
|
-
* @eventType wix.calendar.v3.event_recurring_split
|
|
1935
|
-
* @slug recurring_split
|
|
1936
|
-
* @documentationMaturity preview
|
|
1937
|
-
*/
|
|
1938
|
-
export declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
|
|
1939
|
-
export interface EventUpdatedEnvelope {
|
|
1854
|
+
interface EventUpdatedEnvelope {
|
|
1940
1855
|
entity: Event;
|
|
1941
1856
|
metadata: EventMetadata;
|
|
1942
1857
|
}
|
|
1943
|
-
|
|
1944
|
-
* Triggered when an event is updated, including when it's canceled.
|
|
1945
|
-
*
|
|
1946
|
-
* Not triggered when `INSTANCE` events are updated. You can use the
|
|
1947
|
-
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
1948
|
-
* to get notified about `INSTANCE` events.
|
|
1949
|
-
* @permissionScope Read Calendar - Including PI
|
|
1950
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1951
|
-
* @permissionScope Manage Calendars
|
|
1952
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1953
|
-
* @permissionScope Manage Bookings
|
|
1954
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1955
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1956
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1957
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1958
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1959
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1960
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1961
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1962
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1963
|
-
* @permissionScope Picasso private app mega scope
|
|
1964
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1965
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1966
|
-
* @webhook
|
|
1967
|
-
* @eventType wix.calendar.v3.event_updated
|
|
1968
|
-
* @slug updated
|
|
1969
|
-
* @documentationMaturity preview
|
|
1970
|
-
*/
|
|
1971
|
-
export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
|
|
1972
|
-
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`;
|
|
1973
|
-
/**
|
|
1974
|
-
* Retrieves a list of events filtered by the participant's
|
|
1975
|
-
* [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
|
|
1976
|
-
* ID.
|
|
1977
|
-
*
|
|
1978
|
-
*
|
|
1979
|
-
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
1980
|
-
* `fromLocalDate`.
|
|
1981
|
-
* @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
1982
|
-
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
1983
|
-
* @public
|
|
1984
|
-
* @documentationMaturity preview
|
|
1985
|
-
* @requiredField contactId
|
|
1986
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
1987
|
-
* @permissionScope Read Calendar - Including PI
|
|
1988
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1989
|
-
* @permissionScope Manage Calendars
|
|
1990
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1991
|
-
* @permissionScope Manage Bookings
|
|
1992
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1993
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1994
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1995
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1996
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1997
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1998
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1999
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2000
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2001
|
-
* @permissionScope Picasso private app mega scope
|
|
2002
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
2003
|
-
* @applicableIdentity APP
|
|
2004
|
-
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
|
|
2005
|
-
*/
|
|
2006
|
-
export declare function listEventsByContactId(contactId: string, options?: ListEventsByContactIdOptions): Promise<NonNullablePaths<ListEventsByContactIdResponse, {
|
|
2007
|
-
[P in EventNonNullablePaths]: `events.${number}.${P}`;
|
|
2008
|
-
}[EventNonNullablePaths]>>;
|
|
2009
|
-
export interface ListEventsByContactIdOptions {
|
|
1858
|
+
interface ListEventsByContactIdOptions {
|
|
2010
1859
|
/**
|
|
2011
1860
|
* Local start date and time from which events are returned in
|
|
2012
1861
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -2045,73 +1894,7 @@ export interface ListEventsByContactIdOptions {
|
|
|
2045
1894
|
/** Cursor to retrieve the next page of the results. */
|
|
2046
1895
|
cursorPaging?: CommonCursorPaging;
|
|
2047
1896
|
}
|
|
2048
|
-
|
|
2049
|
-
* Retrieves a list of events filtered by the participant's
|
|
2050
|
-
* [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
|
|
2051
|
-
* ID.
|
|
2052
|
-
*
|
|
2053
|
-
*
|
|
2054
|
-
* You can't set `toLocalDate` to a value that's more than a full year after
|
|
2055
|
-
* `fromLocalDate`.
|
|
2056
|
-
* @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
2057
|
-
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
2058
|
-
* Provide `me` to retrieve events for the currently logged-in member.
|
|
2059
|
-
* You must have the `Read Calendars - Including PI`
|
|
2060
|
-
* [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
|
|
2061
|
-
* to retrieve events for members who aren't the currently logged in member.
|
|
2062
|
-
* @public
|
|
2063
|
-
* @documentationMaturity preview
|
|
2064
|
-
* @requiredField memberId
|
|
2065
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2066
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2067
|
-
* @permissionScope Read Bookings - Public Data
|
|
2068
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2069
|
-
* @permissionScope Read Calendar - Including PI
|
|
2070
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2071
|
-
* @permissionScope Manage Calendars
|
|
2072
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2073
|
-
* @permissionScope Manage Bookings
|
|
2074
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2075
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2076
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2077
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2078
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2079
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2080
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2081
|
-
* @permissionScope Read Calendar
|
|
2082
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2083
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2084
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2085
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2086
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2087
|
-
* @permissionScope Read Bookings Calendar
|
|
2088
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2089
|
-
* @permissionScope Picasso private app mega scope
|
|
2090
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
2091
|
-
* @permissionScope Read Calendar - Including PI
|
|
2092
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2093
|
-
* @permissionScope Manage Calendars
|
|
2094
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2095
|
-
* @permissionScope Manage Bookings
|
|
2096
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2097
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2098
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2099
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2100
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2101
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2102
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2103
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2104
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2105
|
-
* @permissionScope Picasso private app mega scope
|
|
2106
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
2107
|
-
* @applicableIdentity APP
|
|
2108
|
-
* @applicableIdentity VISITOR
|
|
2109
|
-
* @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
|
|
2110
|
-
*/
|
|
2111
|
-
export declare function listEventsByMemberId(memberId: string, options?: ListEventsByMemberIdOptions): Promise<NonNullablePaths<ListEventsByMemberIdResponse, {
|
|
2112
|
-
[P in EventNonNullablePaths]: `events.${number}.${P}`;
|
|
2113
|
-
}[EventNonNullablePaths]>>;
|
|
2114
|
-
export interface ListEventsByMemberIdOptions {
|
|
1897
|
+
interface ListEventsByMemberIdOptions {
|
|
2115
1898
|
/**
|
|
2116
1899
|
* Local start date and time from which events are returned in
|
|
2117
1900
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -2160,60 +1943,7 @@ export interface ListEventsByMemberIdOptions {
|
|
|
2160
1943
|
*/
|
|
2161
1944
|
eventIds?: string[];
|
|
2162
1945
|
}
|
|
2163
|
-
|
|
2164
|
-
* Retrieves an event.
|
|
2165
|
-
* @param eventId - ID of the event to retrieve.
|
|
2166
|
-
*
|
|
2167
|
-
* Min: 36 characters
|
|
2168
|
-
* Max: 250 characters
|
|
2169
|
-
* @public
|
|
2170
|
-
* @documentationMaturity preview
|
|
2171
|
-
* @requiredField eventId
|
|
2172
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2173
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2174
|
-
* @permissionScope Read Bookings - Public Data
|
|
2175
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2176
|
-
* @permissionScope Read Calendar - Including PI
|
|
2177
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2178
|
-
* @permissionScope Manage Calendars
|
|
2179
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2180
|
-
* @permissionScope Manage Bookings
|
|
2181
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2182
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2183
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2184
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2185
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2186
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2187
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2188
|
-
* @permissionScope Read Calendar
|
|
2189
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2190
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2191
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2192
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2193
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2194
|
-
* @permissionScope Read Bookings Calendar
|
|
2195
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2196
|
-
* @permissionScope Read Calendar - Including PI
|
|
2197
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2198
|
-
* @permissionScope Manage Calendars
|
|
2199
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2200
|
-
* @permissionScope Manage Bookings
|
|
2201
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2202
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2203
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2204
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2205
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2206
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2207
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2208
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2209
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2210
|
-
* @applicableIdentity APP
|
|
2211
|
-
* @applicableIdentity VISITOR
|
|
2212
|
-
* @returns Retrieved event.
|
|
2213
|
-
* @fqn wix.calendar.events.v3.EventsService.GetEvent
|
|
2214
|
-
*/
|
|
2215
|
-
export declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
|
|
2216
|
-
export interface GetEventOptions {
|
|
1946
|
+
interface GetEventOptions {
|
|
2217
1947
|
/**
|
|
2218
1948
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2219
1949
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -2237,61 +1967,7 @@ export interface GetEventOptions {
|
|
|
2237
1967
|
*/
|
|
2238
1968
|
fields?: RequestedFields[];
|
|
2239
1969
|
}
|
|
2240
|
-
|
|
2241
|
-
* Retrieves a list of events by their IDs.
|
|
2242
|
-
* @param eventIds - IDs of the events to retrieve.
|
|
2243
|
-
*
|
|
2244
|
-
* Min: 1 event ID
|
|
2245
|
-
* Min: 100 event IDs
|
|
2246
|
-
* @public
|
|
2247
|
-
* @documentationMaturity preview
|
|
2248
|
-
* @requiredField eventIds
|
|
2249
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2250
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2251
|
-
* @permissionScope Read Bookings - Public Data
|
|
2252
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2253
|
-
* @permissionScope Read Calendar - Including PI
|
|
2254
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2255
|
-
* @permissionScope Manage Calendars
|
|
2256
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2257
|
-
* @permissionScope Manage Bookings
|
|
2258
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2259
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2260
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2261
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2262
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2263
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2264
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2265
|
-
* @permissionScope Read Calendar
|
|
2266
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2267
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2268
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2269
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2270
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2271
|
-
* @permissionScope Read Bookings Calendar
|
|
2272
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2273
|
-
* @permissionScope Read Calendar - Including PI
|
|
2274
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2275
|
-
* @permissionScope Manage Calendars
|
|
2276
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2277
|
-
* @permissionScope Manage Bookings
|
|
2278
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2279
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2280
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2281
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2282
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2283
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2284
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2285
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2286
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2287
|
-
* @applicableIdentity APP
|
|
2288
|
-
* @applicableIdentity VISITOR
|
|
2289
|
-
* @fqn wix.calendar.events.v3.EventsService.ListEvents
|
|
2290
|
-
*/
|
|
2291
|
-
export declare function listEvents(eventIds: string[], options?: ListEventsOptions): Promise<NonNullablePaths<ListEventsResponse, {
|
|
2292
|
-
[P in EventNonNullablePaths]: `events.${number}.${P}`;
|
|
2293
|
-
}[EventNonNullablePaths]>>;
|
|
2294
|
-
export interface ListEventsOptions {
|
|
1970
|
+
interface ListEventsOptions {
|
|
2295
1971
|
/**
|
|
2296
1972
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2297
1973
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -2315,70 +1991,7 @@ export interface ListEventsOptions {
|
|
|
2315
1991
|
*/
|
|
2316
1992
|
fields?: RequestedFields[];
|
|
2317
1993
|
}
|
|
2318
|
-
|
|
2319
|
-
* Creates a query to retrieve a list of events.
|
|
2320
|
-
*
|
|
2321
|
-
* The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object.
|
|
2322
|
-
*
|
|
2323
|
-
* 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.
|
|
2324
|
-
*
|
|
2325
|
-
* 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.
|
|
2326
|
-
*
|
|
2327
|
-
* `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override:
|
|
2328
|
-
*
|
|
2329
|
-
* + `limit` is `50`.
|
|
2330
|
-
* + Sorted by `event.start` in ascending order.
|
|
2331
|
-
*
|
|
2332
|
-
* The functions that are chained to `queryEvents()` are applied in the order they are called.
|
|
2333
|
-
*
|
|
2334
|
-
* 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`.
|
|
2335
|
-
*
|
|
2336
|
-
* @public
|
|
2337
|
-
* @documentationMaturity preview
|
|
2338
|
-
* @permissionScope Read Bookings - Public Data
|
|
2339
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
2340
|
-
* @permissionScope Read Calendar - Including PI
|
|
2341
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2342
|
-
* @permissionScope Manage Calendars
|
|
2343
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2344
|
-
* @permissionScope Manage Bookings
|
|
2345
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2346
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2347
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2348
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2349
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2350
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
2351
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
2352
|
-
* @permissionScope Read Calendar
|
|
2353
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
2354
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2355
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2356
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2357
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2358
|
-
* @permissionScope Read Bookings Calendar
|
|
2359
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
2360
|
-
* @permissionScope Read Calendar - Including PI
|
|
2361
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
2362
|
-
* @permissionScope Manage Calendars
|
|
2363
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2364
|
-
* @permissionScope Manage Bookings
|
|
2365
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2366
|
-
* @permissionScope Read Bookings - Including Participants
|
|
2367
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
2368
|
-
* @permissionScope Read Bookings - all read permissions
|
|
2369
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
2370
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2371
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2372
|
-
* @permissionScope Read bookings calendar - including participants
|
|
2373
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
2374
|
-
* @permissionId CALENDAR.EVENT_READ
|
|
2375
|
-
* @permissionId CALENDAR.EVENT_READ_PI
|
|
2376
|
-
* @applicableIdentity APP
|
|
2377
|
-
* @applicableIdentity VISITOR
|
|
2378
|
-
* @fqn wix.calendar.events.v3.EventsService.QueryEvents
|
|
2379
|
-
*/
|
|
2380
|
-
export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
2381
|
-
export interface QueryEventsOptions {
|
|
1994
|
+
interface QueryEventsOptions {
|
|
2382
1995
|
/**
|
|
2383
1996
|
* Local start date and time from which events are returned in
|
|
2384
1997
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -2439,13 +2052,13 @@ interface QueryCursorResult {
|
|
|
2439
2052
|
length: number;
|
|
2440
2053
|
pageSize: number;
|
|
2441
2054
|
}
|
|
2442
|
-
|
|
2055
|
+
interface EventsQueryResult extends QueryCursorResult {
|
|
2443
2056
|
items: Event[];
|
|
2444
2057
|
query: EventsQueryBuilder;
|
|
2445
2058
|
next: () => Promise<EventsQueryResult>;
|
|
2446
2059
|
prev: () => Promise<EventsQueryResult>;
|
|
2447
2060
|
}
|
|
2448
|
-
|
|
2061
|
+
interface EventsQueryBuilder {
|
|
2449
2062
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2450
2063
|
* @param value - Value to compare against.
|
|
2451
2064
|
* @documentationMaturity preview
|
|
@@ -2496,51 +2109,7 @@ export interface EventsQueryBuilder {
|
|
|
2496
2109
|
/** @documentationMaturity preview */
|
|
2497
2110
|
find: () => Promise<EventsQueryResult>;
|
|
2498
2111
|
}
|
|
2499
|
-
|
|
2500
|
-
* Creates an event.
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2503
|
-
* 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.
|
|
2504
|
-
*
|
|
2505
|
-
* 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`.
|
|
2506
|
-
* @param event - Event to create.
|
|
2507
|
-
* @public
|
|
2508
|
-
* @documentationMaturity preview
|
|
2509
|
-
* @requiredField event
|
|
2510
|
-
* @requiredField event.conferencingDetails.guestUrl
|
|
2511
|
-
* @requiredField event.conferencingDetails.hostUrl
|
|
2512
|
-
* @requiredField event.conferencingDetails.type
|
|
2513
|
-
* @requiredField event.end
|
|
2514
|
-
* @requiredField event.end.localDate
|
|
2515
|
-
* @requiredField event.location.type
|
|
2516
|
-
* @requiredField event.participants.list.name
|
|
2517
|
-
* @requiredField event.recurrenceRule.days
|
|
2518
|
-
* @requiredField event.recurrenceRule.frequency
|
|
2519
|
-
* @requiredField event.recurrenceRule.until.localDate
|
|
2520
|
-
* @requiredField event.resources._id
|
|
2521
|
-
* @requiredField event.scheduleId
|
|
2522
|
-
* @requiredField event.start
|
|
2523
|
-
* @requiredField event.start.localDate
|
|
2524
|
-
* @permissionId CALENDAR.EVENT_CREATE_OWN
|
|
2525
|
-
* @permissionId CALENDAR.EVENT_CREATE
|
|
2526
|
-
* @permissionScope Manage Calendars
|
|
2527
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2528
|
-
* @permissionScope Manage Bookings
|
|
2529
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2530
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2531
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2532
|
-
* @permissionScope Manage Calendars
|
|
2533
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2534
|
-
* @permissionScope Manage Bookings
|
|
2535
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2536
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2537
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2538
|
-
* @applicableIdentity APP
|
|
2539
|
-
* @returns Created event.
|
|
2540
|
-
* @fqn wix.calendar.events.v3.EventsService.CreateEvent
|
|
2541
|
-
*/
|
|
2542
|
-
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>>;
|
|
2543
|
-
export interface CreateEventOptions {
|
|
2112
|
+
interface CreateEventOptions {
|
|
2544
2113
|
/**
|
|
2545
2114
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
2546
2115
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -2556,60 +2125,7 @@ export interface CreateEventOptions {
|
|
|
2556
2125
|
*/
|
|
2557
2126
|
idempotencyKey?: string | null;
|
|
2558
2127
|
}
|
|
2559
|
-
|
|
2560
|
-
* Creates multiple events in bulk.
|
|
2561
|
-
*
|
|
2562
|
-
*
|
|
2563
|
-
* If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
|
|
2564
|
-
* created. Then, you can't set `start.localDate` to a past date, though the time can be
|
|
2565
|
-
* earlier on the same day. You can, however, create single-occurrence events for
|
|
2566
|
-
* past dates.
|
|
2567
|
-
*
|
|
2568
|
-
* You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
|
|
2569
|
-
* `INSTANCE` events are generated automatically based on the recurrence rule in the
|
|
2570
|
-
* relevant `MASTER` event. `EXCEPTION` events are automatically created when you
|
|
2571
|
-
* [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
|
|
2572
|
-
* an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
|
|
2573
|
-
* @param events - Events to create.
|
|
2574
|
-
* @public
|
|
2575
|
-
* @documentationMaturity preview
|
|
2576
|
-
* @requiredField events
|
|
2577
|
-
* @requiredField events.event
|
|
2578
|
-
* @requiredField events.event.conferencingDetails.guestUrl
|
|
2579
|
-
* @requiredField events.event.conferencingDetails.hostUrl
|
|
2580
|
-
* @requiredField events.event.conferencingDetails.type
|
|
2581
|
-
* @requiredField events.event.end
|
|
2582
|
-
* @requiredField events.event.end.localDate
|
|
2583
|
-
* @requiredField events.event.location.type
|
|
2584
|
-
* @requiredField events.event.participants.list.name
|
|
2585
|
-
* @requiredField events.event.recurrenceRule.days
|
|
2586
|
-
* @requiredField events.event.recurrenceRule.frequency
|
|
2587
|
-
* @requiredField events.event.recurrenceRule.until.localDate
|
|
2588
|
-
* @requiredField events.event.resources._id
|
|
2589
|
-
* @requiredField events.event.scheduleId
|
|
2590
|
-
* @requiredField events.event.start
|
|
2591
|
-
* @requiredField events.event.start.localDate
|
|
2592
|
-
* @permissionId CALENDAR.EVENT_CREATE_OWN
|
|
2593
|
-
* @permissionId CALENDAR.EVENT_CREATE
|
|
2594
|
-
* @permissionScope Manage Calendars
|
|
2595
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2596
|
-
* @permissionScope Manage Bookings
|
|
2597
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2598
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2599
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2600
|
-
* @permissionScope Manage Calendars
|
|
2601
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2602
|
-
* @permissionScope Manage Bookings
|
|
2603
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2604
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2605
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2606
|
-
* @applicableIdentity APP
|
|
2607
|
-
* @fqn wix.calendar.events.v3.EventsService.BulkCreateEvent
|
|
2608
|
-
*/
|
|
2609
|
-
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` | {
|
|
2610
|
-
[P in EventNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2611
|
-
}[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
|
|
2612
|
-
export interface BulkCreateEventOptions {
|
|
2128
|
+
interface BulkCreateEventOptions {
|
|
2613
2129
|
/**
|
|
2614
2130
|
* Whether to return created events.
|
|
2615
2131
|
*
|
|
@@ -2625,55 +2141,7 @@ export interface BulkCreateEventOptions {
|
|
|
2625
2141
|
*/
|
|
2626
2142
|
timeZone?: string | null;
|
|
2627
2143
|
}
|
|
2628
|
-
|
|
2629
|
-
* Updates an event.
|
|
2630
|
-
*
|
|
2631
|
-
*
|
|
2632
|
-
* When updating an event with `{"recurrenceType": "INSTANCE"}`, the
|
|
2633
|
-
* `recurrenceType` automatically changes to `EXCEPTION`.
|
|
2634
|
-
*
|
|
2635
|
-
* When updating an event with `{"recurrenceType": "MASTER"}`:
|
|
2636
|
-
* + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
|
|
2637
|
-
* + For future `INSTANCE` events, all relevant fields are updated.
|
|
2638
|
-
* + For future `EXCEPTION` events, only changes to the `inheritedFields` are
|
|
2639
|
-
* applied, while other fields remain unchanged.
|
|
2640
|
-
* @param _id - Event ID.
|
|
2641
|
-
* @public
|
|
2642
|
-
* @documentationMaturity preview
|
|
2643
|
-
* @requiredField _id
|
|
2644
|
-
* @requiredField event
|
|
2645
|
-
* @requiredField event.conferencingDetails.guestUrl
|
|
2646
|
-
* @requiredField event.conferencingDetails.hostUrl
|
|
2647
|
-
* @requiredField event.conferencingDetails.type
|
|
2648
|
-
* @requiredField event.end.localDate
|
|
2649
|
-
* @requiredField event.location.type
|
|
2650
|
-
* @requiredField event.participants.list.name
|
|
2651
|
-
* @requiredField event.recurrenceRule.days
|
|
2652
|
-
* @requiredField event.recurrenceRule.frequency
|
|
2653
|
-
* @requiredField event.recurrenceRule.until.localDate
|
|
2654
|
-
* @requiredField event.resources._id
|
|
2655
|
-
* @requiredField event.revision
|
|
2656
|
-
* @requiredField event.start.localDate
|
|
2657
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
2658
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
2659
|
-
* @permissionScope Manage Calendars
|
|
2660
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2661
|
-
* @permissionScope Manage Bookings
|
|
2662
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2663
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2664
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2665
|
-
* @permissionScope Manage Calendars
|
|
2666
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2667
|
-
* @permissionScope Manage Bookings
|
|
2668
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2669
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2670
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2671
|
-
* @applicableIdentity APP
|
|
2672
|
-
* @returns Updated event.
|
|
2673
|
-
* @fqn wix.calendar.events.v3.EventsService.UpdateEvent
|
|
2674
|
-
*/
|
|
2675
|
-
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>>;
|
|
2676
|
-
export interface UpdateEvent {
|
|
2144
|
+
interface UpdateEvent {
|
|
2677
2145
|
/**
|
|
2678
2146
|
* Event ID.
|
|
2679
2147
|
* @minLength 36
|
|
@@ -2904,7 +2372,7 @@ export interface UpdateEvent {
|
|
|
2904
2372
|
*/
|
|
2905
2373
|
_updatedDate?: Date | null;
|
|
2906
2374
|
}
|
|
2907
|
-
|
|
2375
|
+
interface UpdateEventOptions {
|
|
2908
2376
|
/**
|
|
2909
2377
|
* Information about whether participants of the updated event are notified and
|
|
2910
2378
|
* the message they receive.
|
|
@@ -2919,60 +2387,7 @@ export interface UpdateEventOptions {
|
|
|
2919
2387
|
*/
|
|
2920
2388
|
timeZone?: string | null;
|
|
2921
2389
|
}
|
|
2922
|
-
|
|
2923
|
-
* Updates multiple events in bulk.
|
|
2924
|
-
*
|
|
2925
|
-
*
|
|
2926
|
-
* When updating an event with `{"recurrenceType": "INSTANCE"}`, the
|
|
2927
|
-
* `recurrenceType` automatically changes to `EXCEPTION`.
|
|
2928
|
-
*
|
|
2929
|
-
* When updating an event with `{"recurrenceType": "MASTER"}`:
|
|
2930
|
-
* + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
|
|
2931
|
-
* + For future `INSTANCE` events, all relevant fields are updated.
|
|
2932
|
-
* + For future `EXCEPTION` events, only changes to the `inheritedFields` are
|
|
2933
|
-
* applied, while other fields remain unchanged.
|
|
2934
|
-
* @param events - Events to update.
|
|
2935
|
-
*
|
|
2936
|
-
* Min: 1 event
|
|
2937
|
-
* Max: 50 events
|
|
2938
|
-
* @public
|
|
2939
|
-
* @documentationMaturity preview
|
|
2940
|
-
* @requiredField events
|
|
2941
|
-
* @requiredField events.event
|
|
2942
|
-
* @requiredField events.event._id
|
|
2943
|
-
* @requiredField events.event.conferencingDetails.guestUrl
|
|
2944
|
-
* @requiredField events.event.conferencingDetails.hostUrl
|
|
2945
|
-
* @requiredField events.event.conferencingDetails.type
|
|
2946
|
-
* @requiredField events.event.end.localDate
|
|
2947
|
-
* @requiredField events.event.location.type
|
|
2948
|
-
* @requiredField events.event.participants.list.name
|
|
2949
|
-
* @requiredField events.event.recurrenceRule.days
|
|
2950
|
-
* @requiredField events.event.recurrenceRule.frequency
|
|
2951
|
-
* @requiredField events.event.recurrenceRule.until.localDate
|
|
2952
|
-
* @requiredField events.event.resources._id
|
|
2953
|
-
* @requiredField events.event.revision
|
|
2954
|
-
* @requiredField events.event.start.localDate
|
|
2955
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
2956
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
2957
|
-
* @permissionScope Manage Calendars
|
|
2958
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2959
|
-
* @permissionScope Manage Bookings
|
|
2960
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2961
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2962
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2963
|
-
* @permissionScope Manage Calendars
|
|
2964
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
2965
|
-
* @permissionScope Manage Bookings
|
|
2966
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
2967
|
-
* @permissionScope Manage Bookings - all permissions
|
|
2968
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
2969
|
-
* @applicableIdentity APP
|
|
2970
|
-
* @fqn wix.calendar.events.v3.EventsService.BulkUpdateEvent
|
|
2971
|
-
*/
|
|
2972
|
-
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` | {
|
|
2973
|
-
[P in EventNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2974
|
-
}[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
|
|
2975
|
-
export interface BulkUpdateEventOptions {
|
|
2390
|
+
interface BulkUpdateEventOptions {
|
|
2976
2391
|
/**
|
|
2977
2392
|
* Whether to return the updated events.
|
|
2978
2393
|
*
|
|
@@ -2993,51 +2408,7 @@ export interface BulkUpdateEventOptions {
|
|
|
2993
2408
|
*/
|
|
2994
2409
|
timeZone?: string | null;
|
|
2995
2410
|
}
|
|
2996
|
-
|
|
2997
|
-
* Restores the event's default values from the relevant schedule or `MASTER`
|
|
2998
|
-
* event.
|
|
2999
|
-
*
|
|
3000
|
-
*
|
|
3001
|
-
* You must provide `fields` to specify which `inheritedFields` are restored.
|
|
3002
|
-
*
|
|
3003
|
-
* For example, if you've created an event that takes place in a non-default
|
|
3004
|
-
* location with a custom title and capacity, but you want to reset only title
|
|
3005
|
-
* and capacity to default values without affecting the location, provide the
|
|
3006
|
-
* event ID and set `fields` to `["TITLE", "CAPACITY"]`.
|
|
3007
|
-
*
|
|
3008
|
-
* Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
|
|
3009
|
-
* for more information.
|
|
3010
|
-
* @param eventId - ID of the event for which to restore default values.
|
|
3011
|
-
* @param fields - Fields for which to restore default values.
|
|
3012
|
-
*
|
|
3013
|
-
* `TIME` restores default values for `start` and `end`.
|
|
3014
|
-
*
|
|
3015
|
-
* Min: 1 field
|
|
3016
|
-
* @public
|
|
3017
|
-
* @documentationMaturity preview
|
|
3018
|
-
* @requiredField eventId
|
|
3019
|
-
* @requiredField fields
|
|
3020
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
3021
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
3022
|
-
* @permissionScope Manage Calendars
|
|
3023
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3024
|
-
* @permissionScope Manage Bookings
|
|
3025
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3026
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3027
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3028
|
-
* @permissionScope Manage Calendars
|
|
3029
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3030
|
-
* @permissionScope Manage Bookings
|
|
3031
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3032
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3033
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3034
|
-
* @applicableIdentity APP
|
|
3035
|
-
* @fqn wix.calendar.events.v3.EventsService.RestoreEventDefaults
|
|
3036
|
-
*/
|
|
3037
|
-
export declare function restoreEventDefaults(eventId: string, fields: Field[], options?: RestoreEventDefaultsOptions): Promise<NonNullablePaths<RestoreEventDefaultsResponse, {
|
|
3038
|
-
[P in EventNonNullablePaths]: `event.${P}`;
|
|
3039
|
-
}[EventNonNullablePaths]>>;
|
|
3040
|
-
export interface RestoreEventDefaultsOptions {
|
|
2411
|
+
interface RestoreEventDefaultsOptions {
|
|
3041
2412
|
/**
|
|
3042
2413
|
* Information about whether participants of the updated event are notified and
|
|
3043
2414
|
* the message they receive.
|
|
@@ -3052,65 +2423,7 @@ export interface RestoreEventDefaultsOptions {
|
|
|
3052
2423
|
*/
|
|
3053
2424
|
timeZone?: string | null;
|
|
3054
2425
|
}
|
|
3055
|
-
|
|
3056
|
-
* Splits a recurring `MASTER` event into 2 separate `MASTER` events.
|
|
3057
|
-
*
|
|
3058
|
-
*
|
|
3059
|
-
* You must provide a `splitLocalDate` that's in the future and after the `start`
|
|
3060
|
-
* date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally,
|
|
3061
|
-
* there must be another `INSTANCE` or `EXCEPTION` event following this next event,
|
|
3062
|
-
* as the changes wouldn't affect any event without a subsequent occurrence.
|
|
3063
|
-
*
|
|
3064
|
-
* If you want to modify a `MASTER` event with the changes already applying to
|
|
3065
|
-
* the very next event, use
|
|
3066
|
-
* [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
|
|
3067
|
-
* instead, as this preserves past events and only modifies future events.
|
|
3068
|
-
*
|
|
3069
|
-
* The main consequences are:
|
|
3070
|
-
* - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate`
|
|
3071
|
-
* is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION`
|
|
3072
|
-
* event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event
|
|
3073
|
-
* starts before but ends after `splitLocalDate`, `until.localDate` is set
|
|
3074
|
-
* to value that's later than `splitLocalDate`.
|
|
3075
|
-
* - **A new `MASTER` event is created**, starting from the first event that
|
|
3076
|
-
* begins after `splitLocalDate`.
|
|
3077
|
-
* - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**.
|
|
3078
|
-
* Their `recurringEventId` is set to the ID of the newly created `MASTER` event.
|
|
3079
|
-
* @param recurringEventId - ID of the `MASTER` event to split.
|
|
3080
|
-
* @param splitLocalDate - Local date and time at which the `MASTER` event is split in
|
|
3081
|
-
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
3082
|
-
* `2025-03-11T09:00:00`.
|
|
3083
|
-
* Must be a future date that's after the `start` date of the next `INSTANCE` or
|
|
3084
|
-
* `EXCEPTION` event in the series. Additionally, there must be another
|
|
3085
|
-
* `INSTANCE` or `EXCEPTION` event following this next event, as the changes
|
|
3086
|
-
* wouldn't affect any event without a subsequent occurrence.
|
|
3087
|
-
* @public
|
|
3088
|
-
* @documentationMaturity preview
|
|
3089
|
-
* @requiredField recurringEventId
|
|
3090
|
-
* @requiredField splitLocalDate
|
|
3091
|
-
* @permissionId CALENDAR.EVENT_UPDATE_OWN
|
|
3092
|
-
* @permissionId CALENDAR.EVENT_UPDATE
|
|
3093
|
-
* @permissionScope Manage Calendars
|
|
3094
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3095
|
-
* @permissionScope Manage Bookings
|
|
3096
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3097
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3098
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3099
|
-
* @permissionScope Manage Calendars
|
|
3100
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3101
|
-
* @permissionScope Manage Bookings
|
|
3102
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3103
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3104
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3105
|
-
* @applicableIdentity APP
|
|
3106
|
-
* @fqn wix.calendar.events.v3.EventsService.SplitRecurringEvent
|
|
3107
|
-
*/
|
|
3108
|
-
export declare function splitRecurringEvent(recurringEventId: string, splitLocalDate: string, options?: SplitRecurringEventOptions): Promise<NonNullablePaths<SplitRecurringEventResponse, {
|
|
3109
|
-
[P in EventNonNullablePaths]: `updatedRecurringEventEndingBeforeSplit.${P}`;
|
|
3110
|
-
}[EventNonNullablePaths] | {
|
|
3111
|
-
[P in EventNonNullablePaths]: `newRecurringEventStartingFromSplit.${P}`;
|
|
3112
|
-
}[EventNonNullablePaths]>>;
|
|
3113
|
-
export interface SplitRecurringEventOptions {
|
|
2426
|
+
interface SplitRecurringEventOptions {
|
|
3114
2427
|
/**
|
|
3115
2428
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
|
|
3116
2429
|
* for calculating `adjustedStart` and `adjustedEnd`. For example,
|
|
@@ -3120,33 +2433,7 @@ export interface SplitRecurringEventOptions {
|
|
|
3120
2433
|
*/
|
|
3121
2434
|
timeZone?: string | null;
|
|
3122
2435
|
}
|
|
3123
|
-
|
|
3124
|
-
* Cancels an event.
|
|
3125
|
-
* @param eventId - ID of the event to cancel.
|
|
3126
|
-
* @public
|
|
3127
|
-
* @documentationMaturity preview
|
|
3128
|
-
* @requiredField eventId
|
|
3129
|
-
* @permissionId CALENDAR.EVENT_CANCEL_OWN
|
|
3130
|
-
* @permissionId CALENDAR.EVENT_CANCEL
|
|
3131
|
-
* @permissionScope Manage Calendars
|
|
3132
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3133
|
-
* @permissionScope Manage Bookings
|
|
3134
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3135
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3136
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3137
|
-
* @permissionScope Manage Calendars
|
|
3138
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3139
|
-
* @permissionScope Manage Bookings
|
|
3140
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3141
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3142
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3143
|
-
* @applicableIdentity APP
|
|
3144
|
-
* @fqn wix.calendar.events.v3.EventsService.CancelEvent
|
|
3145
|
-
*/
|
|
3146
|
-
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
|
|
3147
|
-
[P in EventNonNullablePaths]: `event.${P}`;
|
|
3148
|
-
}[EventNonNullablePaths]>>;
|
|
3149
|
-
export interface CancelEventOptions {
|
|
2436
|
+
interface CancelEventOptions {
|
|
3150
2437
|
/**
|
|
3151
2438
|
* Information about whether participants of the canceled event are notified and
|
|
3152
2439
|
* the message they receive.
|
|
@@ -3161,33 +2448,7 @@ export interface CancelEventOptions {
|
|
|
3161
2448
|
*/
|
|
3162
2449
|
timeZone?: string | null;
|
|
3163
2450
|
}
|
|
3164
|
-
|
|
3165
|
-
* Cancels multiple events in bulk.
|
|
3166
|
-
* @param eventIds - IDs of the events to cancel.
|
|
3167
|
-
* @public
|
|
3168
|
-
* @documentationMaturity preview
|
|
3169
|
-
* @requiredField eventIds
|
|
3170
|
-
* @permissionId CALENDAR.EVENT_CANCEL_OWN
|
|
3171
|
-
* @permissionId CALENDAR.EVENT_CANCEL
|
|
3172
|
-
* @permissionScope Manage Calendars
|
|
3173
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3174
|
-
* @permissionScope Manage Bookings
|
|
3175
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3176
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3177
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3178
|
-
* @permissionScope Manage Calendars
|
|
3179
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
3180
|
-
* @permissionScope Manage Bookings
|
|
3181
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
3182
|
-
* @permissionScope Manage Bookings - all permissions
|
|
3183
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
3184
|
-
* @applicableIdentity APP
|
|
3185
|
-
* @fqn wix.calendar.events.v3.EventsService.BulkCancelEvent
|
|
3186
|
-
*/
|
|
3187
|
-
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` | {
|
|
3188
|
-
[P in EventNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3189
|
-
}[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
|
|
3190
|
-
export interface BulkCancelEventOptions {
|
|
2451
|
+
interface BulkCancelEventOptions {
|
|
3191
2452
|
/**
|
|
3192
2453
|
* Whether to return the canceled events.
|
|
3193
2454
|
*
|
|
@@ -3208,4 +2469,5 @@ export interface BulkCancelEventOptions {
|
|
|
3208
2469
|
*/
|
|
3209
2470
|
timeZone?: string | null;
|
|
3210
2471
|
}
|
|
3211
|
-
|
|
2472
|
+
|
|
2473
|
+
export { type CommonIdentificationDataIdOneOf as $, RequestedFields as A, type BulkCreateEventOptions as B, type CreateEventOptions as C, Day as D, type Event as E, Field as F, type GetEventOptions as G, SortOrder as H, IdentityType as I, type RecurrenceRule as J, type Location as K, type ListEventsByContactIdOptions as L, type MaskedEvent as M, type Resource as N, type Participants as O, ParticipantsStatus as P, type QueryEventsOptions as Q, type RestoreEventDefaultsOptions as R, type SplitRecurringEventOptions as S, Transparency as T, type UpdateEvent as U, type Participant as V, WebhookIdentityType as W, type ConferencingDetails as X, type Permission as Y, type ZonedDate as Z, type CommonIdentificationData as _, type ListEventsByContactIdResponse as a, type ApplicationError as a$, type ExtendedFields as a0, type RecurringEventSplit as a1, type EventCancelled as a2, type ParticipantNotification as a3, type EventUpdatedWithMetadata as a4, type UpdateScheduleWithFixedBusinessResourceIdRequest as a5, type UpdateScheduleWithFixedBusinessResourceIdResponse as a6, type UpdateEventsWithFixedBusinessResourceIdRequest as a7, type UpdateEventsWithFixedBusinessResourceIdResponse as a8, type DomainEvent as a9, type SupportedLanguage as aA, type ConsentPolicy as aB, type Translation as aC, type ChangeContext as aD, type ChangeContextPayloadOneOf as aE, type PropertiesChange as aF, type SiteCreated as aG, type SiteCloned as aH, type Empty as aI, type GetEventRequest as aJ, type GetEventResponse as aK, type ListEventsRequest as aL, type QueryEventsRequest as aM, type CursorQuery as aN, type CursorQueryPagingMethodOneOf as aO, type Sorting as aP, type CursorPaging as aQ, type QueryEventsResponse as aR, type CursorPagingMetadata as aS, type Cursors as aT, type ListRecurringEventInstancesHistoryRequest as aU, type ListRecurringEventInstancesHistoryResponse as aV, type CreateEventRequest as aW, type CreateEventResponse as aX, type BulkCreateEventRequest as aY, type BulkEventResult as aZ, type ItemMetadata as a_, type DomainEventBodyOneOf as aa, type EntityCreatedEvent as ab, type RestoreInfo as ac, type EntityUpdatedEvent as ad, type EntityDeletedEvent as ae, type ActionEvent as af, type MessageEnvelope as ag, type IdentificationData as ah, type IdentificationDataIdOneOf as ai, type ListEventsByContactIdRequest as aj, type CommonCursorPaging as ak, type CommonCursorPagingMetadata as al, type CommonCursors as am, type ListEventsByMemberIdRequest as an, type SitePropertiesNotification as ao, type SitePropertiesEvent as ap, type Properties as aq, type Categories as ar, type Locale as as, type Address as at, type AddressHint as au, type GeoCoordinates as av, type BusinessSchedule as aw, type TimePeriod as ax, type SpecialHourPeriod as ay, type Multilingual as az, type ListEventsByMemberIdOptions as b, type BulkActionMetadata as b0, type UpdateEventRequest as b1, type UpdateEventResponse as b2, type BulkUpdateEventRequest as b3, type UpdateEventParticipantsRequest as b4, type UpdateEventParticipantsResponse as b5, type RestoreEventDefaultsRequest as b6, type SplitRecurringEventRequest as b7, type CancelEventRequest as b8, type BulkCancelEventRequest as b9, type BaseEventMetadata as ba, type EventMetadata as bb, type EventCancelledEnvelope as bc, type EventCreatedEnvelope as bd, type EventRecurringSplitEnvelope as be, type EventUpdatedEnvelope as bf, type EventsQueryResult as bg, 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, Status as r, RecurrenceType as s, Frequency as t, LocationType as u, Role as v, Type as w, PlacementType as x, DayOfWeek as y, ResolutionMethod as z };
|