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