@wix/auto_sdk_calendar_events 1.0.15 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-DwDyFLdW.d.mts} +137 -875
- package/build/{cjs/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-DwDyFLdW.d.ts} +137 -875
- package/build/{cjs/src/calendar-v3-event-events.public.d.ts → index.d.mts} +63 -23
- package/build/{internal/cjs/src/calendar-v3-event-events.public.d.ts → index.d.ts} +63 -23
- package/build/index.js +1548 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1491 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/calendar-v3-event-events.universal.d.ts → internal/calendar-v3-event-events.universal-DwDyFLdW.d.mts} +137 -875
- package/build/internal/{es/src/calendar-v3-event-events.universal.d.ts → calendar-v3-event-events.universal-DwDyFLdW.d.ts} +137 -875
- package/build/{es/src/calendar-v3-event-events.public.d.ts → internal/index.d.mts} +63 -23
- package/build/internal/{es/src/calendar-v3-event-events.public.d.ts → index.d.ts} +63 -23
- package/build/internal/index.js +1548 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1491 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/calendar-v3-event-events.types.d.ts → internal/meta.d.mts} +108 -581
- package/build/internal/{es/src/calendar-v3-event-events.types.d.ts → meta.d.ts} +108 -581
- package/build/internal/meta.js +930 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +891 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/calendar-v3-event-events.types.d.ts → meta.d.mts} +108 -581
- package/build/{internal/cjs/src/calendar-v3-event-events.types.d.ts → meta.d.ts} +108 -581
- package/build/meta.js +930 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +891 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/cjs/src/calendar-v3-event-events.context.js +0 -71
- package/build/cjs/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/cjs/src/calendar-v3-event-events.http.js +0 -785
- package/build/cjs/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/cjs/src/calendar-v3-event-events.meta.js +0 -275
- package/build/cjs/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.public.js +0 -196
- package/build/cjs/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.types.js +0 -157
- package/build/cjs/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/cjs/src/calendar-v3-event-events.universal.js +0 -1202
- package/build/cjs/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/es/src/calendar-v3-event-events.context.js +0 -51
- package/build/es/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/es/src/calendar-v3-event-events.http.js +0 -769
- package/build/es/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/es/src/calendar-v3-event-events.meta.js +0 -236
- package/build/es/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.public.js +0 -163
- package/build/es/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.types.js +0 -154
- package/build/es/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/es/src/calendar-v3-event-events.universal.js +0 -1163
- package/build/es/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/internal/cjs/src/calendar-v3-event-events.context.js +0 -71
- package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/internal/cjs/src/calendar-v3-event-events.http.js +0 -785
- package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js +0 -275
- package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.public.js +0 -196
- package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.types.js +0 -157
- package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js +0 -1202
- package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.context.d.ts +0 -51
- package/build/internal/es/src/calendar-v3-event-events.context.js +0 -51
- package/build/internal/es/src/calendar-v3-event-events.context.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.http.d.ts +0 -144
- package/build/internal/es/src/calendar-v3-event-events.http.js +0 -769
- package/build/internal/es/src/calendar-v3-event-events.http.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +0 -39
- package/build/internal/es/src/calendar-v3-event-events.meta.js +0 -236
- package/build/internal/es/src/calendar-v3-event-events.meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.public.js +0 -163
- package/build/internal/es/src/calendar-v3-event-events.public.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.types.js +0 -154
- package/build/internal/es/src/calendar-v3-event-events.types.js.map +0 -1
- package/build/internal/es/src/calendar-v3-event-events.universal.js +0 -1163
- package/build/internal/es/src/calendar-v3-event-events.universal.js.map +0 -1
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { aj as ListEventsByContactIdRequest$1, a as ListEventsByContactIdResponse$1, an as ListEventsByMemberIdRequest$1, c as ListEventsByMemberIdResponse$1, aJ as GetEventRequest$1, aK as GetEventResponse$1, aL as ListEventsRequest$1, e as ListEventsResponse$1, aM as QueryEventsRequest$1, aR as QueryEventsResponse$1, aW as CreateEventRequest$1, aX as CreateEventResponse$1, aY as BulkCreateEventRequest$1, g as BulkCreateEventResponse$1, b1 as UpdateEventRequest$1, b2 as UpdateEventResponse$1, b3 as BulkUpdateEventRequest$1, k as BulkUpdateEventResponse$1, b6 as RestoreEventDefaultsRequest$1, l as RestoreEventDefaultsResponse$1, b7 as SplitRecurringEventRequest$1, m as SplitRecurringEventResponse$1, b8 as CancelEventRequest$1, o as CancelEventResponse$1, b9 as BulkCancelEventRequest$1, q as BulkCancelEventResponse$1 } from './calendar-v3-event-events.universal-DwDyFLdW.mjs';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An event is a scheduled entry on a calendar that includes details like timing,
|
|
3
5
|
* location, and participants. Each event is associated with
|
|
@@ -7,7 +9,7 @@
|
|
|
7
9
|
* recurrence pattern. You can also specify whether events block time on the
|
|
8
10
|
* schedule or allow other events to be scheduled concurrently.
|
|
9
11
|
*/
|
|
10
|
-
|
|
12
|
+
interface Event {
|
|
11
13
|
/**
|
|
12
14
|
* Event ID.
|
|
13
15
|
* @minLength 36
|
|
@@ -241,7 +243,7 @@ export interface Event {
|
|
|
241
243
|
*/
|
|
242
244
|
updatedDate?: Date | null;
|
|
243
245
|
}
|
|
244
|
-
|
|
246
|
+
declare enum Status {
|
|
245
247
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
246
248
|
/** Event is scheduled to happen or has happened. */
|
|
247
249
|
CONFIRMED = "CONFIRMED",
|
|
@@ -249,7 +251,7 @@ export declare enum Status {
|
|
|
249
251
|
CANCELLED = "CANCELLED"
|
|
250
252
|
}
|
|
251
253
|
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
252
|
-
|
|
254
|
+
interface ZonedDate {
|
|
253
255
|
/**
|
|
254
256
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
255
257
|
* For example, `2024-01-30T13:30:00`.
|
|
@@ -272,7 +274,7 @@ export interface ZonedDate {
|
|
|
272
274
|
*/
|
|
273
275
|
utcDate?: Date | null;
|
|
274
276
|
}
|
|
275
|
-
|
|
277
|
+
declare enum RecurrenceType {
|
|
276
278
|
UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
|
|
277
279
|
/** The event occurs only once and doesn't repeat. */
|
|
278
280
|
NONE = "NONE",
|
|
@@ -283,7 +285,7 @@ export declare enum RecurrenceType {
|
|
|
283
285
|
/** 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. */
|
|
284
286
|
EXCEPTION = "EXCEPTION"
|
|
285
287
|
}
|
|
286
|
-
|
|
288
|
+
interface RecurrenceRule {
|
|
287
289
|
/**
|
|
288
290
|
* Frequency how often the event repeats. Works together with `interval`.
|
|
289
291
|
*
|
|
@@ -327,12 +329,12 @@ export interface RecurrenceRule {
|
|
|
327
329
|
*/
|
|
328
330
|
adjustedUntil?: ZonedDate;
|
|
329
331
|
}
|
|
330
|
-
|
|
332
|
+
declare enum Frequency {
|
|
331
333
|
UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
|
|
332
334
|
/** The event's recurrence pattern is based on weeks. */
|
|
333
335
|
WEEKLY = "WEEKLY"
|
|
334
336
|
}
|
|
335
|
-
|
|
337
|
+
declare enum Day {
|
|
336
338
|
/** The recurring event takes place on Mondays. */
|
|
337
339
|
MONDAY = "MONDAY",
|
|
338
340
|
/** The recurring event takes place on Tuesdays. */
|
|
@@ -348,14 +350,14 @@ export declare enum Day {
|
|
|
348
350
|
/** The recurring event takes place on Sundays. */
|
|
349
351
|
SUNDAY = "SUNDAY"
|
|
350
352
|
}
|
|
351
|
-
|
|
353
|
+
declare enum Transparency {
|
|
352
354
|
UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
|
|
353
355
|
/** 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. */
|
|
354
356
|
OPAQUE = "OPAQUE",
|
|
355
357
|
/** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
|
|
356
358
|
TRANSPARENT = "TRANSPARENT"
|
|
357
359
|
}
|
|
358
|
-
|
|
360
|
+
interface Location {
|
|
359
361
|
/**
|
|
360
362
|
* [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
|
|
361
363
|
* ID. Available only for `BUSINESS` locations.
|
|
@@ -391,7 +393,7 @@ export interface Location {
|
|
|
391
393
|
*/
|
|
392
394
|
address?: string | null;
|
|
393
395
|
}
|
|
394
|
-
|
|
396
|
+
declare enum LocationType {
|
|
395
397
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
396
398
|
/** The event is held at a business location. */
|
|
397
399
|
BUSINESS = "BUSINESS",
|
|
@@ -400,7 +402,7 @@ export declare enum LocationType {
|
|
|
400
402
|
/** The event is held at an address or venue not tied to the business or customer. */
|
|
401
403
|
CUSTOM = "CUSTOM"
|
|
402
404
|
}
|
|
403
|
-
|
|
405
|
+
interface Resource {
|
|
404
406
|
/**
|
|
405
407
|
* Resource ID.
|
|
406
408
|
* @format GUID
|
|
@@ -433,14 +435,14 @@ export interface Resource {
|
|
|
433
435
|
*/
|
|
434
436
|
permissionRole?: Role;
|
|
435
437
|
}
|
|
436
|
-
|
|
438
|
+
declare enum Role {
|
|
437
439
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
438
440
|
/** Full read and write access. */
|
|
439
441
|
WRITER = "WRITER",
|
|
440
442
|
/** Full read access, write access limited to `event.notes`. */
|
|
441
443
|
COMMENTER = "COMMENTER"
|
|
442
444
|
}
|
|
443
|
-
|
|
445
|
+
interface Participants {
|
|
444
446
|
/**
|
|
445
447
|
* Total number of participants.
|
|
446
448
|
*
|
|
@@ -470,7 +472,7 @@ export interface Participants {
|
|
|
470
472
|
*/
|
|
471
473
|
status?: ParticipantsStatus;
|
|
472
474
|
}
|
|
473
|
-
|
|
475
|
+
interface Participant {
|
|
474
476
|
/**
|
|
475
477
|
* Participant name.
|
|
476
478
|
*
|
|
@@ -497,14 +499,14 @@ export interface Participant {
|
|
|
497
499
|
*/
|
|
498
500
|
contactId?: string | null;
|
|
499
501
|
}
|
|
500
|
-
|
|
502
|
+
declare enum ParticipantsStatus {
|
|
501
503
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
502
504
|
/** All participants are confirmed. */
|
|
503
505
|
CONFIRMED = "CONFIRMED",
|
|
504
506
|
/** At least one participant isn't confirmed yet. */
|
|
505
507
|
PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
|
|
506
508
|
}
|
|
507
|
-
|
|
509
|
+
interface ConferencingDetails {
|
|
508
510
|
/** Conference type. For example, `Zoom`. */
|
|
509
511
|
type?: Type;
|
|
510
512
|
/**
|
|
@@ -544,12 +546,12 @@ export interface ConferencingDetails {
|
|
|
544
546
|
*/
|
|
545
547
|
externalId?: string | null;
|
|
546
548
|
}
|
|
547
|
-
|
|
549
|
+
declare enum Type {
|
|
548
550
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
549
551
|
ZOOM = "ZOOM",
|
|
550
552
|
CUSTOM = "CUSTOM"
|
|
551
553
|
}
|
|
552
|
-
|
|
554
|
+
declare enum Field {
|
|
553
555
|
UNKNOWN_FIELD = "UNKNOWN_FIELD",
|
|
554
556
|
/** `title` is inherited from the schedule or `MASTER` event. */
|
|
555
557
|
TITLE = "TITLE",
|
|
@@ -568,7 +570,7 @@ export declare enum Field {
|
|
|
568
570
|
/** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
|
|
569
571
|
CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
|
|
570
572
|
}
|
|
571
|
-
|
|
573
|
+
interface Permission {
|
|
572
574
|
/**
|
|
573
575
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
574
576
|
* granted the permission.
|
|
@@ -583,7 +585,7 @@ export interface Permission {
|
|
|
583
585
|
*/
|
|
584
586
|
role?: Role;
|
|
585
587
|
}
|
|
586
|
-
|
|
588
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
587
589
|
/**
|
|
588
590
|
* ID of a Wix user. For example, the site owner or a
|
|
589
591
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -592,7 +594,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
592
594
|
wixUserId?: string;
|
|
593
595
|
}
|
|
594
596
|
/** @oneof */
|
|
595
|
-
|
|
597
|
+
interface CommonIdentificationDataIdOneOf {
|
|
596
598
|
/**
|
|
597
599
|
* ID of a Wix user. For example, the site owner or a
|
|
598
600
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -600,11 +602,7 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
600
602
|
*/
|
|
601
603
|
wixUserId?: string;
|
|
602
604
|
}
|
|
603
|
-
|
|
604
|
-
UNKNOWN = "UNKNOWN",
|
|
605
|
-
WIX_USER = "WIX_USER"
|
|
606
|
-
}
|
|
607
|
-
export interface ExtendedFields {
|
|
605
|
+
interface ExtendedFields {
|
|
608
606
|
/**
|
|
609
607
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
610
608
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -615,17 +613,7 @@ export interface ExtendedFields {
|
|
|
615
613
|
*/
|
|
616
614
|
namespaces?: Record<string, Record<string, any>>;
|
|
617
615
|
}
|
|
618
|
-
|
|
619
|
-
/** Original `MASTER` event that was shortened. */
|
|
620
|
-
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
621
|
-
/** New `MASTER` event starting with the first event after the split date. */
|
|
622
|
-
newRecurringEventStartingFromSplit?: Event;
|
|
623
|
-
}
|
|
624
|
-
export interface EventCancelled {
|
|
625
|
-
/** Canceled event. */
|
|
626
|
-
event?: Event;
|
|
627
|
-
}
|
|
628
|
-
export interface ParticipantNotification {
|
|
616
|
+
interface ParticipantNotification {
|
|
629
617
|
/**
|
|
630
618
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
631
619
|
*
|
|
@@ -642,177 +630,7 @@ export interface ParticipantNotification {
|
|
|
642
630
|
*/
|
|
643
631
|
message?: string | null;
|
|
644
632
|
}
|
|
645
|
-
|
|
646
|
-
export interface EventUpdatedWithMetadata {
|
|
647
|
-
/** The updated event. */
|
|
648
|
-
event?: Event;
|
|
649
|
-
/**
|
|
650
|
-
* Information about whether participants of the updated event are notified and
|
|
651
|
-
* the message they receive.
|
|
652
|
-
*/
|
|
653
|
-
participantNotification?: ParticipantNotification;
|
|
654
|
-
}
|
|
655
|
-
export interface UpdateScheduleWithFixedBusinessResourceIdRequest {
|
|
656
|
-
/** @format GUID */
|
|
657
|
-
metaSiteId?: string;
|
|
658
|
-
/** @format GUID */
|
|
659
|
-
currentBusinessResourceId?: string;
|
|
660
|
-
migrateBusinessConferenceId?: boolean;
|
|
661
|
-
}
|
|
662
|
-
export interface UpdateScheduleWithFixedBusinessResourceIdResponse {
|
|
663
|
-
}
|
|
664
|
-
export interface UpdateEventsWithFixedBusinessResourceIdRequest {
|
|
665
|
-
/** @format GUID */
|
|
666
|
-
metaSiteId?: string;
|
|
667
|
-
/** @format GUID */
|
|
668
|
-
currentBusinessResourceId?: string;
|
|
669
|
-
migrateBusinessConferenceId?: boolean;
|
|
670
|
-
}
|
|
671
|
-
export interface UpdateEventsWithFixedBusinessResourceIdResponse {
|
|
672
|
-
}
|
|
673
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
674
|
-
createdEvent?: EntityCreatedEvent;
|
|
675
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
676
|
-
deletedEvent?: EntityDeletedEvent;
|
|
677
|
-
actionEvent?: ActionEvent;
|
|
678
|
-
/**
|
|
679
|
-
* Unique event ID.
|
|
680
|
-
* Allows clients to ignore duplicate webhooks.
|
|
681
|
-
*/
|
|
682
|
-
id?: string;
|
|
683
|
-
/**
|
|
684
|
-
* Assumes actions are also always typed to an entity_type
|
|
685
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
686
|
-
*/
|
|
687
|
-
entityFqdn?: string;
|
|
688
|
-
/**
|
|
689
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
690
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
691
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
692
|
-
*/
|
|
693
|
-
slug?: string;
|
|
694
|
-
/** ID of the entity associated with the event. */
|
|
695
|
-
entityId?: string;
|
|
696
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
697
|
-
eventTime?: Date | null;
|
|
698
|
-
/**
|
|
699
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
700
|
-
* (for example, GDPR).
|
|
701
|
-
*/
|
|
702
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
703
|
-
/** If present, indicates the action that triggered the event. */
|
|
704
|
-
originatedFrom?: string | null;
|
|
705
|
-
/**
|
|
706
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
707
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
708
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
709
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
710
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
711
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
712
|
-
*/
|
|
713
|
-
entityEventSequence?: string | null;
|
|
714
|
-
}
|
|
715
|
-
/** @oneof */
|
|
716
|
-
export interface DomainEventBodyOneOf {
|
|
717
|
-
createdEvent?: EntityCreatedEvent;
|
|
718
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
719
|
-
deletedEvent?: EntityDeletedEvent;
|
|
720
|
-
actionEvent?: ActionEvent;
|
|
721
|
-
}
|
|
722
|
-
export interface EntityCreatedEvent {
|
|
723
|
-
entityAsJson?: string;
|
|
724
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
725
|
-
restoreInfo?: RestoreInfo;
|
|
726
|
-
}
|
|
727
|
-
export interface RestoreInfo {
|
|
728
|
-
deletedDate?: Date | null;
|
|
729
|
-
}
|
|
730
|
-
export interface EntityUpdatedEvent {
|
|
731
|
-
/**
|
|
732
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
733
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
734
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
735
|
-
*/
|
|
736
|
-
currentEntityAsJson?: string;
|
|
737
|
-
}
|
|
738
|
-
export interface EntityDeletedEvent {
|
|
739
|
-
/** Entity that was deleted */
|
|
740
|
-
deletedEntityAsJson?: string | null;
|
|
741
|
-
}
|
|
742
|
-
export interface ActionEvent {
|
|
743
|
-
bodyAsJson?: string;
|
|
744
|
-
}
|
|
745
|
-
export interface MessageEnvelope {
|
|
746
|
-
/**
|
|
747
|
-
* App instance ID.
|
|
748
|
-
* @format GUID
|
|
749
|
-
*/
|
|
750
|
-
instanceId?: string | null;
|
|
751
|
-
/**
|
|
752
|
-
* Event type.
|
|
753
|
-
* @maxLength 150
|
|
754
|
-
*/
|
|
755
|
-
eventType?: string;
|
|
756
|
-
/** The identification type and identity data. */
|
|
757
|
-
identity?: IdentificationData;
|
|
758
|
-
/** Stringify payload. */
|
|
759
|
-
data?: string;
|
|
760
|
-
}
|
|
761
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
762
|
-
/**
|
|
763
|
-
* ID of a site visitor that has not logged in to the site.
|
|
764
|
-
* @format GUID
|
|
765
|
-
*/
|
|
766
|
-
anonymousVisitorId?: string;
|
|
767
|
-
/**
|
|
768
|
-
* ID of a site visitor that has logged in to the site.
|
|
769
|
-
* @format GUID
|
|
770
|
-
*/
|
|
771
|
-
memberId?: string;
|
|
772
|
-
/**
|
|
773
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
774
|
-
* @format GUID
|
|
775
|
-
*/
|
|
776
|
-
wixUserId?: string;
|
|
777
|
-
/**
|
|
778
|
-
* ID of an app.
|
|
779
|
-
* @format GUID
|
|
780
|
-
*/
|
|
781
|
-
appId?: string;
|
|
782
|
-
/** @readonly */
|
|
783
|
-
identityType?: WebhookIdentityType;
|
|
784
|
-
}
|
|
785
|
-
/** @oneof */
|
|
786
|
-
export interface IdentificationDataIdOneOf {
|
|
787
|
-
/**
|
|
788
|
-
* ID of a site visitor that has not logged in to the site.
|
|
789
|
-
* @format GUID
|
|
790
|
-
*/
|
|
791
|
-
anonymousVisitorId?: string;
|
|
792
|
-
/**
|
|
793
|
-
* ID of a site visitor that has logged in to the site.
|
|
794
|
-
* @format GUID
|
|
795
|
-
*/
|
|
796
|
-
memberId?: string;
|
|
797
|
-
/**
|
|
798
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
799
|
-
* @format GUID
|
|
800
|
-
*/
|
|
801
|
-
wixUserId?: string;
|
|
802
|
-
/**
|
|
803
|
-
* ID of an app.
|
|
804
|
-
* @format GUID
|
|
805
|
-
*/
|
|
806
|
-
appId?: string;
|
|
807
|
-
}
|
|
808
|
-
export declare enum WebhookIdentityType {
|
|
809
|
-
UNKNOWN = "UNKNOWN",
|
|
810
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
811
|
-
MEMBER = "MEMBER",
|
|
812
|
-
WIX_USER = "WIX_USER",
|
|
813
|
-
APP = "APP"
|
|
814
|
-
}
|
|
815
|
-
export interface ListEventsByContactIdRequest {
|
|
633
|
+
interface ListEventsByContactIdRequest {
|
|
816
634
|
/**
|
|
817
635
|
* ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
|
|
818
636
|
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
@@ -858,7 +676,7 @@ export interface ListEventsByContactIdRequest {
|
|
|
858
676
|
cursorPaging?: CommonCursorPaging;
|
|
859
677
|
}
|
|
860
678
|
/** TODO Diverge */
|
|
861
|
-
|
|
679
|
+
interface CommonCursorPaging {
|
|
862
680
|
/**
|
|
863
681
|
* Number of events to return.
|
|
864
682
|
* Defaults to `50`. Maximum `100`.
|
|
@@ -875,14 +693,14 @@ export interface CommonCursorPaging {
|
|
|
875
693
|
*/
|
|
876
694
|
cursor?: string | null;
|
|
877
695
|
}
|
|
878
|
-
|
|
696
|
+
interface ListEventsByContactIdResponse {
|
|
879
697
|
/** Retrieved events. */
|
|
880
698
|
events?: Event[];
|
|
881
699
|
/** Paging metadata. */
|
|
882
700
|
pagingMetadata?: CommonCursorPagingMetadata;
|
|
883
701
|
}
|
|
884
702
|
/** TODO Diverge */
|
|
885
|
-
|
|
703
|
+
interface CommonCursorPagingMetadata {
|
|
886
704
|
/** Number of items returned in the response. */
|
|
887
705
|
count?: number | null;
|
|
888
706
|
/** 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). */
|
|
@@ -894,11 +712,11 @@ export interface CommonCursorPagingMetadata {
|
|
|
894
712
|
*/
|
|
895
713
|
hasNext?: boolean | null;
|
|
896
714
|
}
|
|
897
|
-
|
|
715
|
+
interface CommonCursors {
|
|
898
716
|
/** Cursor pointing to next page in the list of results. */
|
|
899
717
|
next?: string | null;
|
|
900
718
|
}
|
|
901
|
-
|
|
719
|
+
interface ListEventsByMemberIdRequest {
|
|
902
720
|
/**
|
|
903
721
|
* ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
|
|
904
722
|
* to retrieve events for. Required, unless you provide `cursorPaging`.
|
|
@@ -958,293 +776,13 @@ export interface ListEventsByMemberIdRequest {
|
|
|
958
776
|
*/
|
|
959
777
|
eventIds?: string[];
|
|
960
778
|
}
|
|
961
|
-
|
|
779
|
+
interface ListEventsByMemberIdResponse {
|
|
962
780
|
/** Retrieved events. */
|
|
963
781
|
events?: Event[];
|
|
964
782
|
/** Paging metadata. */
|
|
965
783
|
pagingMetadata?: CommonCursorPagingMetadata;
|
|
966
784
|
}
|
|
967
|
-
|
|
968
|
-
export interface SitePropertiesNotification {
|
|
969
|
-
/** The site ID for which this update notification applies. */
|
|
970
|
-
metasiteId?: string;
|
|
971
|
-
/** The actual update event. */
|
|
972
|
-
event?: SitePropertiesEvent;
|
|
973
|
-
/**
|
|
974
|
-
* A convenience set of mappings from the MetaSite ID to its constituent services.
|
|
975
|
-
* @maxSize 500
|
|
976
|
-
*/
|
|
977
|
-
translations?: Translation[];
|
|
978
|
-
/** Context of the notification */
|
|
979
|
-
changeContext?: ChangeContext;
|
|
980
|
-
}
|
|
981
|
-
/** The actual update event for a particular notification. */
|
|
982
|
-
export interface SitePropertiesEvent {
|
|
983
|
-
/** Version of the site's properties represented by this update. */
|
|
984
|
-
version?: number;
|
|
985
|
-
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
986
|
-
fields?: string[];
|
|
987
|
-
/** Updated properties. */
|
|
988
|
-
properties?: Properties;
|
|
989
|
-
}
|
|
990
|
-
export interface Properties {
|
|
991
|
-
/** Site categories. */
|
|
992
|
-
categories?: Categories;
|
|
993
|
-
/** Site locale. */
|
|
994
|
-
locale?: Locale;
|
|
995
|
-
/**
|
|
996
|
-
* Site language.
|
|
997
|
-
*
|
|
998
|
-
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
999
|
-
*/
|
|
1000
|
-
language?: string | null;
|
|
1001
|
-
/**
|
|
1002
|
-
* Site currency format used to bill customers.
|
|
1003
|
-
*
|
|
1004
|
-
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1005
|
-
*/
|
|
1006
|
-
paymentCurrency?: string | null;
|
|
1007
|
-
/** Timezone in `America/New_York` format. */
|
|
1008
|
-
timeZone?: string | null;
|
|
1009
|
-
/** Email address. */
|
|
1010
|
-
email?: string | null;
|
|
1011
|
-
/** Phone number. */
|
|
1012
|
-
phone?: string | null;
|
|
1013
|
-
/** Fax number. */
|
|
1014
|
-
fax?: string | null;
|
|
1015
|
-
/** Address. */
|
|
1016
|
-
address?: Address;
|
|
1017
|
-
/** Site display name. */
|
|
1018
|
-
siteDisplayName?: string | null;
|
|
1019
|
-
/** Business name. */
|
|
1020
|
-
businessName?: string | null;
|
|
1021
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1022
|
-
logo?: string | null;
|
|
1023
|
-
/** Site description. */
|
|
1024
|
-
description?: string | null;
|
|
1025
|
-
/**
|
|
1026
|
-
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1027
|
-
*
|
|
1028
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
1029
|
-
*/
|
|
1030
|
-
businessSchedule?: BusinessSchedule;
|
|
1031
|
-
/** Supported languages of a site and the primary language. */
|
|
1032
|
-
multilingual?: Multilingual;
|
|
1033
|
-
/** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
|
|
1034
|
-
consentPolicy?: ConsentPolicy;
|
|
1035
|
-
/**
|
|
1036
|
-
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1037
|
-
*
|
|
1038
|
-
* Site business type.
|
|
1039
|
-
*/
|
|
1040
|
-
businessConfig?: string | null;
|
|
1041
|
-
/** External site URL that uses Wix as its headless business solution. */
|
|
1042
|
-
externalSiteUrl?: string | null;
|
|
1043
|
-
/** Track clicks analytics. */
|
|
1044
|
-
trackClicksAnalytics?: boolean;
|
|
1045
|
-
}
|
|
1046
|
-
export interface Categories {
|
|
1047
|
-
/** Primary site category. */
|
|
1048
|
-
primary?: string;
|
|
1049
|
-
/**
|
|
1050
|
-
* Secondary site category.
|
|
1051
|
-
* @maxSize 50
|
|
1052
|
-
*/
|
|
1053
|
-
secondary?: string[];
|
|
1054
|
-
/** Business Term Id */
|
|
1055
|
-
businessTermId?: string | null;
|
|
1056
|
-
}
|
|
1057
|
-
export interface Locale {
|
|
1058
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1059
|
-
languageCode?: string;
|
|
1060
|
-
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1061
|
-
country?: string;
|
|
1062
|
-
}
|
|
1063
|
-
export interface Address {
|
|
1064
|
-
/** Street name. */
|
|
1065
|
-
street?: string;
|
|
1066
|
-
/** City name. */
|
|
1067
|
-
city?: string;
|
|
1068
|
-
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1069
|
-
country?: string;
|
|
1070
|
-
/** State. */
|
|
1071
|
-
state?: string;
|
|
1072
|
-
/**
|
|
1073
|
-
* Zip or postal code.
|
|
1074
|
-
* @maxLength 20
|
|
1075
|
-
*/
|
|
1076
|
-
zip?: string;
|
|
1077
|
-
/** Extra information to be displayed in the address. */
|
|
1078
|
-
hint?: AddressHint;
|
|
1079
|
-
/** Whether this address represents a physical location. */
|
|
1080
|
-
isPhysical?: boolean;
|
|
1081
|
-
/** Google-formatted version of this address. */
|
|
1082
|
-
googleFormattedAddress?: string;
|
|
1083
|
-
/** Street number. */
|
|
1084
|
-
streetNumber?: string;
|
|
1085
|
-
/** Apartment number. */
|
|
1086
|
-
apartmentNumber?: string;
|
|
1087
|
-
/** Geographic coordinates of location. */
|
|
1088
|
-
coordinates?: GeoCoordinates;
|
|
1089
|
-
}
|
|
1090
|
-
/**
|
|
1091
|
-
* Extra information on displayed addresses.
|
|
1092
|
-
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1093
|
-
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1094
|
-
*/
|
|
1095
|
-
export interface AddressHint {
|
|
1096
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1097
|
-
text?: string;
|
|
1098
|
-
/** Where the extra text should be displayed. */
|
|
1099
|
-
placement?: PlacementType;
|
|
1100
|
-
}
|
|
1101
|
-
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1102
|
-
export declare enum PlacementType {
|
|
1103
|
-
BEFORE = "BEFORE",
|
|
1104
|
-
AFTER = "AFTER",
|
|
1105
|
-
REPLACE = "REPLACE"
|
|
1106
|
-
}
|
|
1107
|
-
/** Geocoordinates for a particular address. */
|
|
1108
|
-
export interface GeoCoordinates {
|
|
1109
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
1110
|
-
latitude?: number;
|
|
1111
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
1112
|
-
longitude?: number;
|
|
1113
|
-
}
|
|
1114
|
-
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1115
|
-
export interface BusinessSchedule {
|
|
1116
|
-
/**
|
|
1117
|
-
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1118
|
-
* @maxSize 100
|
|
1119
|
-
*/
|
|
1120
|
-
periods?: TimePeriod[];
|
|
1121
|
-
/**
|
|
1122
|
-
* Exceptions to the business's regular hours. The business can be open or closed during the exception.
|
|
1123
|
-
* @maxSize 100
|
|
1124
|
-
*/
|
|
1125
|
-
specialHourPeriod?: SpecialHourPeriod[];
|
|
1126
|
-
}
|
|
1127
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1128
|
-
export interface TimePeriod {
|
|
1129
|
-
/** Day of the week the period starts on. */
|
|
1130
|
-
openDay?: DayOfWeek;
|
|
1131
|
-
/**
|
|
1132
|
-
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1133
|
-
* midnight at the end of the specified day.
|
|
1134
|
-
*/
|
|
1135
|
-
openTime?: string;
|
|
1136
|
-
/** Day of the week the period ends on. */
|
|
1137
|
-
closeDay?: DayOfWeek;
|
|
1138
|
-
/**
|
|
1139
|
-
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1140
|
-
* midnight at the end of the specified day.
|
|
1141
|
-
*
|
|
1142
|
-
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1143
|
-
*/
|
|
1144
|
-
closeTime?: string;
|
|
1145
|
-
}
|
|
1146
|
-
/** Enumerates the days of the week. */
|
|
1147
|
-
export declare enum DayOfWeek {
|
|
1148
|
-
MONDAY = "MONDAY",
|
|
1149
|
-
TUESDAY = "TUESDAY",
|
|
1150
|
-
WEDNESDAY = "WEDNESDAY",
|
|
1151
|
-
THURSDAY = "THURSDAY",
|
|
1152
|
-
FRIDAY = "FRIDAY",
|
|
1153
|
-
SATURDAY = "SATURDAY",
|
|
1154
|
-
SUNDAY = "SUNDAY"
|
|
1155
|
-
}
|
|
1156
|
-
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1157
|
-
export interface SpecialHourPeriod {
|
|
1158
|
-
/** 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). */
|
|
1159
|
-
startDate?: string;
|
|
1160
|
-
/** 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). */
|
|
1161
|
-
endDate?: string;
|
|
1162
|
-
/**
|
|
1163
|
-
* Whether the business is closed (or the service is not available) during the exception.
|
|
1164
|
-
*
|
|
1165
|
-
* Default: `true`.
|
|
1166
|
-
*/
|
|
1167
|
-
isClosed?: boolean;
|
|
1168
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1169
|
-
comment?: string;
|
|
1170
|
-
}
|
|
1171
|
-
export interface Multilingual {
|
|
1172
|
-
/**
|
|
1173
|
-
* Supported languages list.
|
|
1174
|
-
* @maxSize 200
|
|
1175
|
-
*/
|
|
1176
|
-
supportedLanguages?: SupportedLanguage[];
|
|
1177
|
-
/** Whether to redirect to user language. */
|
|
1178
|
-
autoRedirect?: boolean;
|
|
1179
|
-
}
|
|
1180
|
-
export interface SupportedLanguage {
|
|
1181
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1182
|
-
languageCode?: string;
|
|
1183
|
-
/** Locale. */
|
|
1184
|
-
locale?: Locale;
|
|
1185
|
-
/** Whether the supported language is the primary language for the site. */
|
|
1186
|
-
isPrimary?: boolean;
|
|
1187
|
-
/** Language icon. */
|
|
1188
|
-
countryCode?: string;
|
|
1189
|
-
/** How the language will be resolved. For internal use. */
|
|
1190
|
-
resolutionMethod?: ResolutionMethod;
|
|
1191
|
-
}
|
|
1192
|
-
export declare enum ResolutionMethod {
|
|
1193
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
1194
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
1195
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1196
|
-
}
|
|
1197
|
-
export interface ConsentPolicy {
|
|
1198
|
-
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1199
|
-
essential?: boolean | null;
|
|
1200
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1201
|
-
functional?: boolean | null;
|
|
1202
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1203
|
-
analytics?: boolean | null;
|
|
1204
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1205
|
-
advertising?: boolean | null;
|
|
1206
|
-
/** CCPA compliance flag. */
|
|
1207
|
-
dataToThirdParty?: boolean | null;
|
|
1208
|
-
}
|
|
1209
|
-
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1210
|
-
export interface Translation {
|
|
1211
|
-
/** The service type. */
|
|
1212
|
-
serviceType?: string;
|
|
1213
|
-
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1214
|
-
appDefId?: string;
|
|
1215
|
-
/** The instance ID of the service. */
|
|
1216
|
-
instanceId?: string;
|
|
1217
|
-
}
|
|
1218
|
-
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1219
|
-
/** Properties were updated. */
|
|
1220
|
-
propertiesChange?: PropertiesChange;
|
|
1221
|
-
/** Default properties were created on site creation. */
|
|
1222
|
-
siteCreated?: SiteCreated;
|
|
1223
|
-
/** Properties were cloned on site cloning. */
|
|
1224
|
-
siteCloned?: SiteCloned;
|
|
1225
|
-
}
|
|
1226
|
-
/** @oneof */
|
|
1227
|
-
export interface ChangeContextPayloadOneOf {
|
|
1228
|
-
/** Properties were updated. */
|
|
1229
|
-
propertiesChange?: PropertiesChange;
|
|
1230
|
-
/** Default properties were created on site creation. */
|
|
1231
|
-
siteCreated?: SiteCreated;
|
|
1232
|
-
/** Properties were cloned on site cloning. */
|
|
1233
|
-
siteCloned?: SiteCloned;
|
|
1234
|
-
}
|
|
1235
|
-
export interface PropertiesChange {
|
|
1236
|
-
}
|
|
1237
|
-
export interface SiteCreated {
|
|
1238
|
-
/** Origin template site id. */
|
|
1239
|
-
originTemplateId?: string | null;
|
|
1240
|
-
}
|
|
1241
|
-
export interface SiteCloned {
|
|
1242
|
-
/** Origin site id. */
|
|
1243
|
-
originMetaSiteId?: string;
|
|
1244
|
-
}
|
|
1245
|
-
export interface Empty {
|
|
1246
|
-
}
|
|
1247
|
-
export interface GetEventRequest {
|
|
785
|
+
interface GetEventRequest {
|
|
1248
786
|
/**
|
|
1249
787
|
* ID of the event to retrieve.
|
|
1250
788
|
*
|
|
@@ -1277,18 +815,18 @@ export interface GetEventRequest {
|
|
|
1277
815
|
*/
|
|
1278
816
|
fields?: RequestedFields[];
|
|
1279
817
|
}
|
|
1280
|
-
|
|
818
|
+
declare enum RequestedFields {
|
|
1281
819
|
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
1282
820
|
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
1283
821
|
PI_FIELDS = "PI_FIELDS",
|
|
1284
822
|
/** Returns only fields containing your own personal data. */
|
|
1285
823
|
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
1286
824
|
}
|
|
1287
|
-
|
|
825
|
+
interface GetEventResponse {
|
|
1288
826
|
/** Retrieved event. */
|
|
1289
827
|
event?: Event;
|
|
1290
828
|
}
|
|
1291
|
-
|
|
829
|
+
interface ListEventsRequest {
|
|
1292
830
|
/**
|
|
1293
831
|
* IDs of the events to retrieve.
|
|
1294
832
|
*
|
|
@@ -1323,11 +861,11 @@ export interface ListEventsRequest {
|
|
|
1323
861
|
*/
|
|
1324
862
|
fields?: RequestedFields[];
|
|
1325
863
|
}
|
|
1326
|
-
|
|
864
|
+
interface ListEventsResponse {
|
|
1327
865
|
/** Retrieved events matching the provided IDs. */
|
|
1328
866
|
events?: Event[];
|
|
1329
867
|
}
|
|
1330
|
-
|
|
868
|
+
interface QueryEventsRequest {
|
|
1331
869
|
/**
|
|
1332
870
|
* Local start date and time from which events are returned in
|
|
1333
871
|
* [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
|
|
@@ -1384,7 +922,7 @@ export interface QueryEventsRequest {
|
|
|
1384
922
|
fields?: RequestedFields[];
|
|
1385
923
|
}
|
|
1386
924
|
/** TODO Diverge */
|
|
1387
|
-
|
|
925
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1388
926
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1389
927
|
cursorPaging?: CursorPaging;
|
|
1390
928
|
/**
|
|
@@ -1405,12 +943,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1405
943
|
sort?: Sorting[];
|
|
1406
944
|
}
|
|
1407
945
|
/** @oneof */
|
|
1408
|
-
|
|
946
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1409
947
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
1410
948
|
cursorPaging?: CursorPaging;
|
|
1411
949
|
}
|
|
1412
950
|
/** TODO Diverge */
|
|
1413
|
-
|
|
951
|
+
interface Sorting {
|
|
1414
952
|
/**
|
|
1415
953
|
* The field to sort by.
|
|
1416
954
|
* Either `start` or `end`.
|
|
@@ -1420,12 +958,12 @@ export interface Sorting {
|
|
|
1420
958
|
/** Sort order. */
|
|
1421
959
|
order?: SortOrder;
|
|
1422
960
|
}
|
|
1423
|
-
|
|
961
|
+
declare enum SortOrder {
|
|
1424
962
|
ASC = "ASC",
|
|
1425
963
|
DESC = "DESC"
|
|
1426
964
|
}
|
|
1427
965
|
/** TODO Diverge */
|
|
1428
|
-
|
|
966
|
+
interface CursorPaging {
|
|
1429
967
|
/**
|
|
1430
968
|
* Number of events to return.
|
|
1431
969
|
* Defaults to `50`. Maximum `1000`.
|
|
@@ -1442,14 +980,14 @@ export interface CursorPaging {
|
|
|
1442
980
|
*/
|
|
1443
981
|
cursor?: string | null;
|
|
1444
982
|
}
|
|
1445
|
-
|
|
983
|
+
interface QueryEventsResponse {
|
|
1446
984
|
/** Retrieved events matching the provided query. */
|
|
1447
985
|
events?: Event[];
|
|
1448
986
|
/** Paging metadata. */
|
|
1449
987
|
pagingMetadata?: CursorPagingMetadata;
|
|
1450
988
|
}
|
|
1451
989
|
/** TODO Diverge */
|
|
1452
|
-
|
|
990
|
+
interface CursorPagingMetadata {
|
|
1453
991
|
/** Number of items returned in the response. */
|
|
1454
992
|
count?: number | null;
|
|
1455
993
|
/** 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). */
|
|
@@ -1461,45 +999,11 @@ export interface CursorPagingMetadata {
|
|
|
1461
999
|
*/
|
|
1462
1000
|
hasNext?: boolean | null;
|
|
1463
1001
|
}
|
|
1464
|
-
|
|
1002
|
+
interface Cursors {
|
|
1465
1003
|
/** Cursor pointing to next page in the list of results. */
|
|
1466
1004
|
next?: string | null;
|
|
1467
1005
|
}
|
|
1468
|
-
|
|
1469
|
-
/**
|
|
1470
|
-
* The ID of the recurring event.
|
|
1471
|
-
* Required, unless `cursorPaging` is provided.
|
|
1472
|
-
* @minLength 64
|
|
1473
|
-
* @maxLength 64
|
|
1474
|
-
*/
|
|
1475
|
-
recurringEventId?: string | null;
|
|
1476
|
-
/**
|
|
1477
|
-
* The revision of the recurring event.
|
|
1478
|
-
* Required, unless `cursorPaging` is provided.
|
|
1479
|
-
*/
|
|
1480
|
-
revision?: string | null;
|
|
1481
|
-
/**
|
|
1482
|
-
* Inclusive start date for which events are returned, in ISO-8601 format.
|
|
1483
|
-
* Events that begin at or after the `fromDate` are included in the results.
|
|
1484
|
-
* Required, unless `cursorPaging` is provided.
|
|
1485
|
-
*/
|
|
1486
|
-
fromDate?: Date | null;
|
|
1487
|
-
/**
|
|
1488
|
-
* Exclusive end date for which events are returned, in ISO-8601 format.
|
|
1489
|
-
* Events that begin before the `toDate` are included in the results.
|
|
1490
|
-
* Required, unless `cursorPaging` is provided.
|
|
1491
|
-
*/
|
|
1492
|
-
toDate?: Date | null;
|
|
1493
|
-
/** Optional cursor pointing to the next page of events. */
|
|
1494
|
-
cursorPaging?: CursorPaging;
|
|
1495
|
-
}
|
|
1496
|
-
export interface ListRecurringEventInstancesHistoryResponse {
|
|
1497
|
-
/** The recurring event instances. */
|
|
1498
|
-
recurringEventInstances?: Event[];
|
|
1499
|
-
/** Paging metadata. */
|
|
1500
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
1501
|
-
}
|
|
1502
|
-
export interface CreateEventRequest {
|
|
1006
|
+
interface CreateEventRequest {
|
|
1503
1007
|
/** Event to create. */
|
|
1504
1008
|
event: Event;
|
|
1505
1009
|
/**
|
|
@@ -1517,11 +1021,11 @@ export interface CreateEventRequest {
|
|
|
1517
1021
|
*/
|
|
1518
1022
|
idempotencyKey?: string | null;
|
|
1519
1023
|
}
|
|
1520
|
-
|
|
1024
|
+
interface CreateEventResponse {
|
|
1521
1025
|
/** Created event. */
|
|
1522
1026
|
event?: Event;
|
|
1523
1027
|
}
|
|
1524
|
-
|
|
1028
|
+
interface BulkCreateEventRequest {
|
|
1525
1029
|
/**
|
|
1526
1030
|
* Events to create.
|
|
1527
1031
|
* @minSize 1
|
|
@@ -1543,23 +1047,23 @@ export interface BulkCreateEventRequest {
|
|
|
1543
1047
|
*/
|
|
1544
1048
|
timeZone?: string | null;
|
|
1545
1049
|
}
|
|
1546
|
-
|
|
1050
|
+
interface MaskedEvent {
|
|
1547
1051
|
/** Event to create. */
|
|
1548
1052
|
event?: Event;
|
|
1549
1053
|
}
|
|
1550
|
-
|
|
1054
|
+
interface BulkCreateEventResponse {
|
|
1551
1055
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1552
1056
|
results?: BulkEventResult[];
|
|
1553
1057
|
/** Total successes and failures. */
|
|
1554
1058
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1555
1059
|
}
|
|
1556
|
-
|
|
1060
|
+
interface BulkEventResult {
|
|
1557
1061
|
/** Whether the requested action was successful. */
|
|
1558
1062
|
itemMetadata?: ItemMetadata;
|
|
1559
1063
|
/** The event. */
|
|
1560
1064
|
item?: Event;
|
|
1561
1065
|
}
|
|
1562
|
-
|
|
1066
|
+
interface ItemMetadata {
|
|
1563
1067
|
/**
|
|
1564
1068
|
* Event ID.
|
|
1565
1069
|
* Should always be available, unless it's impossible (for example, when failing to create an event).
|
|
@@ -1575,7 +1079,7 @@ export interface ItemMetadata {
|
|
|
1575
1079
|
/** Details about the error in case of failure. */
|
|
1576
1080
|
error?: ApplicationError;
|
|
1577
1081
|
}
|
|
1578
|
-
|
|
1082
|
+
interface ApplicationError {
|
|
1579
1083
|
/** Error code. */
|
|
1580
1084
|
code?: string;
|
|
1581
1085
|
/** Description of the error. */
|
|
@@ -1583,13 +1087,13 @@ export interface ApplicationError {
|
|
|
1583
1087
|
/** Data related to the error. */
|
|
1584
1088
|
data?: Record<string, any> | null;
|
|
1585
1089
|
}
|
|
1586
|
-
|
|
1090
|
+
interface BulkActionMetadata {
|
|
1587
1091
|
/** Number of events that were successfully processed. */
|
|
1588
1092
|
totalSuccesses?: number;
|
|
1589
1093
|
/** Number of events that couldn't be processed. */
|
|
1590
1094
|
totalFailures?: number;
|
|
1591
1095
|
}
|
|
1592
|
-
|
|
1096
|
+
interface UpdateEventRequest {
|
|
1593
1097
|
/** Event to update. */
|
|
1594
1098
|
event: Event;
|
|
1595
1099
|
/**
|
|
@@ -1606,11 +1110,11 @@ export interface UpdateEventRequest {
|
|
|
1606
1110
|
*/
|
|
1607
1111
|
timeZone?: string | null;
|
|
1608
1112
|
}
|
|
1609
|
-
|
|
1113
|
+
interface UpdateEventResponse {
|
|
1610
1114
|
/** Updated event. */
|
|
1611
1115
|
event?: Event;
|
|
1612
1116
|
}
|
|
1613
|
-
|
|
1117
|
+
interface BulkUpdateEventRequest {
|
|
1614
1118
|
/**
|
|
1615
1119
|
* Events to update.
|
|
1616
1120
|
*
|
|
@@ -1640,34 +1144,17 @@ export interface BulkUpdateEventRequest {
|
|
|
1640
1144
|
*/
|
|
1641
1145
|
timeZone?: string | null;
|
|
1642
1146
|
}
|
|
1643
|
-
|
|
1147
|
+
interface BulkUpdateEventRequestMaskedEvent {
|
|
1644
1148
|
/** Event to update. */
|
|
1645
1149
|
event?: Event;
|
|
1646
1150
|
}
|
|
1647
|
-
|
|
1151
|
+
interface BulkUpdateEventResponse {
|
|
1648
1152
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1649
1153
|
results?: BulkEventResult[];
|
|
1650
1154
|
/** Total successes and failures. */
|
|
1651
1155
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1652
1156
|
}
|
|
1653
|
-
|
|
1654
|
-
/**
|
|
1655
|
-
* ID of the event to update.
|
|
1656
|
-
*
|
|
1657
|
-
* Min: 36 characters
|
|
1658
|
-
* Max: 250 characters
|
|
1659
|
-
* @minLength 36
|
|
1660
|
-
* @maxLength 250
|
|
1661
|
-
*/
|
|
1662
|
-
eventId?: string | null;
|
|
1663
|
-
/** The participants to update. */
|
|
1664
|
-
participants?: Participants;
|
|
1665
|
-
}
|
|
1666
|
-
export interface UpdateEventParticipantsResponse {
|
|
1667
|
-
/** Updated event. */
|
|
1668
|
-
event?: Event;
|
|
1669
|
-
}
|
|
1670
|
-
export interface RestoreEventDefaultsRequest {
|
|
1157
|
+
interface RestoreEventDefaultsRequest {
|
|
1671
1158
|
/**
|
|
1672
1159
|
* ID of the event for which to restore default values.
|
|
1673
1160
|
* @minLength 36
|
|
@@ -1697,11 +1184,11 @@ export interface RestoreEventDefaultsRequest {
|
|
|
1697
1184
|
*/
|
|
1698
1185
|
timeZone?: string | null;
|
|
1699
1186
|
}
|
|
1700
|
-
|
|
1187
|
+
interface RestoreEventDefaultsResponse {
|
|
1701
1188
|
/** Updated event. */
|
|
1702
1189
|
event?: Event;
|
|
1703
1190
|
}
|
|
1704
|
-
|
|
1191
|
+
interface SplitRecurringEventRequest {
|
|
1705
1192
|
/**
|
|
1706
1193
|
* ID of the `MASTER` event to split.
|
|
1707
1194
|
* @minLength 36
|
|
@@ -1728,13 +1215,13 @@ export interface SplitRecurringEventRequest {
|
|
|
1728
1215
|
*/
|
|
1729
1216
|
timeZone?: string | null;
|
|
1730
1217
|
}
|
|
1731
|
-
|
|
1218
|
+
interface SplitRecurringEventResponse {
|
|
1732
1219
|
/** Original `MASTER` event that was shortened. */
|
|
1733
1220
|
updatedRecurringEventEndingBeforeSplit?: Event;
|
|
1734
1221
|
/** New `MASTER` event starting with the first event after the split date. */
|
|
1735
1222
|
newRecurringEventStartingFromSplit?: Event;
|
|
1736
1223
|
}
|
|
1737
|
-
|
|
1224
|
+
interface CancelEventRequest {
|
|
1738
1225
|
/**
|
|
1739
1226
|
* ID of the event to cancel.
|
|
1740
1227
|
* @minLength 36
|
|
@@ -1755,11 +1242,11 @@ export interface CancelEventRequest {
|
|
|
1755
1242
|
*/
|
|
1756
1243
|
timeZone?: string | null;
|
|
1757
1244
|
}
|
|
1758
|
-
|
|
1245
|
+
interface CancelEventResponse {
|
|
1759
1246
|
/** Canceled event. */
|
|
1760
1247
|
event?: Event;
|
|
1761
1248
|
}
|
|
1762
|
-
|
|
1249
|
+
interface BulkCancelEventRequest {
|
|
1763
1250
|
/**
|
|
1764
1251
|
* IDs of the events to cancel.
|
|
1765
1252
|
* @minSize 1
|
|
@@ -1786,9 +1273,49 @@ export interface BulkCancelEventRequest {
|
|
|
1786
1273
|
*/
|
|
1787
1274
|
timeZone?: string | null;
|
|
1788
1275
|
}
|
|
1789
|
-
|
|
1276
|
+
interface BulkCancelEventResponse {
|
|
1790
1277
|
/** The result for each event, containing the event and whether the action was successful. */
|
|
1791
1278
|
results?: BulkEventResult[];
|
|
1792
1279
|
/** Total successes and failures. */
|
|
1793
1280
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1794
1281
|
}
|
|
1282
|
+
|
|
1283
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1284
|
+
getUrl: (context: any) => string;
|
|
1285
|
+
httpMethod: K;
|
|
1286
|
+
path: string;
|
|
1287
|
+
pathParams: M;
|
|
1288
|
+
__requestType: T;
|
|
1289
|
+
__originalRequestType: S;
|
|
1290
|
+
__responseType: Q;
|
|
1291
|
+
__originalResponseType: R;
|
|
1292
|
+
};
|
|
1293
|
+
declare function listEventsByContactId(): __PublicMethodMetaInfo<'GET', {
|
|
1294
|
+
contactId: string;
|
|
1295
|
+
}, ListEventsByContactIdRequest$1, ListEventsByContactIdRequest, ListEventsByContactIdResponse$1, ListEventsByContactIdResponse>;
|
|
1296
|
+
declare function listEventsByMemberId(): __PublicMethodMetaInfo<'GET', {
|
|
1297
|
+
memberId: string;
|
|
1298
|
+
}, ListEventsByMemberIdRequest$1, ListEventsByMemberIdRequest, ListEventsByMemberIdResponse$1, ListEventsByMemberIdResponse>;
|
|
1299
|
+
declare function getEvent(): __PublicMethodMetaInfo<'GET', {
|
|
1300
|
+
eventId: string;
|
|
1301
|
+
}, GetEventRequest$1, GetEventRequest, GetEventResponse$1, GetEventResponse>;
|
|
1302
|
+
declare function listEvents(): __PublicMethodMetaInfo<'GET', {}, ListEventsRequest$1, ListEventsRequest, ListEventsResponse$1, ListEventsResponse>;
|
|
1303
|
+
declare function queryEvents(): __PublicMethodMetaInfo<'POST', {}, QueryEventsRequest$1, QueryEventsRequest, QueryEventsResponse$1, QueryEventsResponse>;
|
|
1304
|
+
declare function createEvent(): __PublicMethodMetaInfo<'POST', {}, CreateEventRequest$1, CreateEventRequest, CreateEventResponse$1, CreateEventResponse>;
|
|
1305
|
+
declare function bulkCreateEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCreateEventRequest$1, BulkCreateEventRequest, BulkCreateEventResponse$1, BulkCreateEventResponse>;
|
|
1306
|
+
declare function updateEvent(): __PublicMethodMetaInfo<'PATCH', {
|
|
1307
|
+
eventId: string;
|
|
1308
|
+
}, UpdateEventRequest$1, UpdateEventRequest, UpdateEventResponse$1, UpdateEventResponse>;
|
|
1309
|
+
declare function bulkUpdateEvent(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateEventRequest$1, BulkUpdateEventRequest, BulkUpdateEventResponse$1, BulkUpdateEventResponse>;
|
|
1310
|
+
declare function restoreEventDefaults(): __PublicMethodMetaInfo<'POST', {
|
|
1311
|
+
eventId: string;
|
|
1312
|
+
}, RestoreEventDefaultsRequest$1, RestoreEventDefaultsRequest, RestoreEventDefaultsResponse$1, RestoreEventDefaultsResponse>;
|
|
1313
|
+
declare function splitRecurringEvent(): __PublicMethodMetaInfo<'POST', {
|
|
1314
|
+
recurringEventId: string;
|
|
1315
|
+
}, SplitRecurringEventRequest$1, SplitRecurringEventRequest, SplitRecurringEventResponse$1, SplitRecurringEventResponse>;
|
|
1316
|
+
declare function cancelEvent(): __PublicMethodMetaInfo<'POST', {
|
|
1317
|
+
eventId: string;
|
|
1318
|
+
}, CancelEventRequest$1, CancelEventRequest, CancelEventResponse$1, CancelEventResponse>;
|
|
1319
|
+
declare function bulkCancelEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCancelEventRequest$1, BulkCancelEventRequest, BulkCancelEventResponse$1, BulkCancelEventResponse>;
|
|
1320
|
+
|
|
1321
|
+
export { type __PublicMethodMetaInfo, bulkCancelEvent, bulkCreateEvent, bulkUpdateEvent, cancelEvent, createEvent, getEvent, listEvents, listEventsByContactId, listEventsByMemberId, queryEvents, restoreEventDefaults, splitRecurringEvent, updateEvent };
|