@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.
Files changed (126) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/calendar-v3-event-events.context.d.ts +51 -0
  11. package/build/cjs/src/calendar-v3-event-events.context.js +71 -0
  12. package/build/cjs/src/calendar-v3-event-events.context.js.map +1 -0
  13. package/build/cjs/src/calendar-v3-event-events.http.d.ts +144 -0
  14. package/build/cjs/src/calendar-v3-event-events.http.js +785 -0
  15. package/build/cjs/src/calendar-v3-event-events.http.js.map +1 -0
  16. package/build/cjs/src/calendar-v3-event-events.meta.d.ts +39 -0
  17. package/build/cjs/src/calendar-v3-event-events.meta.js +275 -0
  18. package/build/cjs/src/calendar-v3-event-events.meta.js.map +1 -0
  19. package/build/{internal/index.d.ts → cjs/src/calendar-v3-event-events.public.d.ts} +23 -63
  20. package/build/cjs/src/calendar-v3-event-events.public.js +196 -0
  21. package/build/cjs/src/calendar-v3-event-events.public.js.map +1 -0
  22. package/build/{internal/meta.d.mts → cjs/src/calendar-v3-event-events.types.d.ts} +592 -111
  23. package/build/cjs/src/calendar-v3-event-events.types.js +157 -0
  24. package/build/cjs/src/calendar-v3-event-events.types.js.map +1 -0
  25. package/build/{calendar-v3-event-events.universal-DwDyFLdW.d.mts → cjs/src/calendar-v3-event-events.universal.d.ts} +872 -140
  26. package/build/cjs/src/calendar-v3-event-events.universal.js +1196 -0
  27. package/build/cjs/src/calendar-v3-event-events.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/calendar-v3-event-events.context.d.ts +51 -0
  39. package/build/es/src/calendar-v3-event-events.context.js +51 -0
  40. package/build/es/src/calendar-v3-event-events.context.js.map +1 -0
  41. package/build/es/src/calendar-v3-event-events.http.d.ts +144 -0
  42. package/build/es/src/calendar-v3-event-events.http.js +769 -0
  43. package/build/es/src/calendar-v3-event-events.http.js.map +1 -0
  44. package/build/es/src/calendar-v3-event-events.meta.d.ts +39 -0
  45. package/build/es/src/calendar-v3-event-events.meta.js +236 -0
  46. package/build/es/src/calendar-v3-event-events.meta.js.map +1 -0
  47. package/build/{index.d.ts → es/src/calendar-v3-event-events.public.d.ts} +23 -63
  48. package/build/es/src/calendar-v3-event-events.public.js +163 -0
  49. package/build/es/src/calendar-v3-event-events.public.js.map +1 -0
  50. package/build/{internal/meta.d.ts → es/src/calendar-v3-event-events.types.d.ts} +592 -111
  51. package/build/es/src/calendar-v3-event-events.types.js +154 -0
  52. package/build/es/src/calendar-v3-event-events.types.js.map +1 -0
  53. package/build/{calendar-v3-event-events.universal-DwDyFLdW.d.ts → es/src/calendar-v3-event-events.universal.d.ts} +872 -140
  54. package/build/es/src/calendar-v3-event-events.universal.js +1157 -0
  55. package/build/es/src/calendar-v3-event-events.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/calendar-v3-event-events.context.d.ts +51 -0
  66. package/build/internal/cjs/src/calendar-v3-event-events.context.js +71 -0
  67. package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +1 -0
  68. package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +144 -0
  69. package/build/internal/cjs/src/calendar-v3-event-events.http.js +785 -0
  70. package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +1 -0
  71. package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +39 -0
  72. package/build/internal/cjs/src/calendar-v3-event-events.meta.js +275 -0
  73. package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +1 -0
  74. package/build/internal/{index.d.mts → cjs/src/calendar-v3-event-events.public.d.ts} +23 -63
  75. package/build/internal/cjs/src/calendar-v3-event-events.public.js +196 -0
  76. package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +1 -0
  77. package/build/{meta.d.mts → internal/cjs/src/calendar-v3-event-events.types.d.ts} +592 -111
  78. package/build/internal/cjs/src/calendar-v3-event-events.types.js +157 -0
  79. package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +1 -0
  80. package/build/internal/{calendar-v3-event-events.universal-DwDyFLdW.d.ts → cjs/src/calendar-v3-event-events.universal.d.ts} +872 -140
  81. package/build/internal/cjs/src/calendar-v3-event-events.universal.js +1196 -0
  82. package/build/internal/cjs/src/calendar-v3-event-events.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/calendar-v3-event-events.context.d.ts +51 -0
  93. package/build/internal/es/src/calendar-v3-event-events.context.js +51 -0
  94. package/build/internal/es/src/calendar-v3-event-events.context.js.map +1 -0
  95. package/build/internal/es/src/calendar-v3-event-events.http.d.ts +144 -0
  96. package/build/internal/es/src/calendar-v3-event-events.http.js +769 -0
  97. package/build/internal/es/src/calendar-v3-event-events.http.js.map +1 -0
  98. package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +39 -0
  99. package/build/internal/es/src/calendar-v3-event-events.meta.js +236 -0
  100. package/build/internal/es/src/calendar-v3-event-events.meta.js.map +1 -0
  101. package/build/{index.d.mts → internal/es/src/calendar-v3-event-events.public.d.ts} +23 -63
  102. package/build/internal/es/src/calendar-v3-event-events.public.js +163 -0
  103. package/build/internal/es/src/calendar-v3-event-events.public.js.map +1 -0
  104. package/build/{meta.d.ts → internal/es/src/calendar-v3-event-events.types.d.ts} +592 -111
  105. package/build/internal/es/src/calendar-v3-event-events.types.js +154 -0
  106. package/build/internal/es/src/calendar-v3-event-events.types.js.map +1 -0
  107. package/build/internal/{calendar-v3-event-events.universal-DwDyFLdW.d.mts → es/src/calendar-v3-event-events.universal.d.ts} +872 -140
  108. package/build/internal/es/src/calendar-v3-event-events.universal.js +1157 -0
  109. package/build/internal/es/src/calendar-v3-event-events.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.js +0 -1548
  112. package/build/index.js.map +0 -1
  113. package/build/index.mjs +0 -1491
  114. package/build/index.mjs.map +0 -1
  115. package/build/internal/index.js +0 -1548
  116. package/build/internal/index.js.map +0 -1
  117. package/build/internal/index.mjs +0 -1491
  118. package/build/internal/index.mjs.map +0 -1
  119. package/build/internal/meta.js +0 -930
  120. package/build/internal/meta.js.map +0 -1
  121. package/build/internal/meta.mjs +0 -891
  122. package/build/internal/meta.mjs.map +0 -1
  123. package/build/meta.js +0 -930
  124. package/build/meta.js.map +0 -1
  125. package/build/meta.mjs +0 -891
  126. package/build/meta.mjs.map +0 -1
@@ -1,5 +1,3 @@
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.js';
2
-
3
1
  /**
4
2
  * An event is a scheduled entry on a calendar that includes details like timing,
5
3
  * location, and participants. Each event is associated with
@@ -9,7 +7,7 @@ import { aj as ListEventsByContactIdRequest$1, a as ListEventsByContactIdRespons
9
7
  * recurrence pattern. You can also specify whether events block time on the
10
8
  * schedule or allow other events to be scheduled concurrently.
11
9
  */
12
- interface Event {
10
+ export interface Event {
13
11
  /**
14
12
  * Event ID.
15
13
  * @minLength 36
@@ -243,7 +241,7 @@ interface Event {
243
241
  */
244
242
  updatedDate?: Date | null;
245
243
  }
246
- declare enum Status {
244
+ export declare enum Status {
247
245
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
248
246
  /** Event is scheduled to happen or has happened. */
249
247
  CONFIRMED = "CONFIRMED",
@@ -251,7 +249,7 @@ declare enum Status {
251
249
  CANCELLED = "CANCELLED"
252
250
  }
253
251
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
254
- interface ZonedDate {
252
+ export interface ZonedDate {
255
253
  /**
256
254
  * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
257
255
  * For example, `2024-01-30T13:30:00`.
@@ -274,7 +272,7 @@ interface ZonedDate {
274
272
  */
275
273
  utcDate?: Date | null;
276
274
  }
277
- declare enum RecurrenceType {
275
+ export declare enum RecurrenceType {
278
276
  UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
279
277
  /** The event occurs only once and doesn't repeat. */
280
278
  NONE = "NONE",
@@ -285,7 +283,7 @@ declare enum RecurrenceType {
285
283
  /** 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. */
286
284
  EXCEPTION = "EXCEPTION"
287
285
  }
288
- interface RecurrenceRule {
286
+ export interface RecurrenceRule {
289
287
  /**
290
288
  * Frequency how often the event repeats. Works together with `interval`.
291
289
  *
@@ -329,12 +327,12 @@ interface RecurrenceRule {
329
327
  */
330
328
  adjustedUntil?: ZonedDate;
331
329
  }
332
- declare enum Frequency {
330
+ export declare enum Frequency {
333
331
  UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
334
332
  /** The event's recurrence pattern is based on weeks. */
335
333
  WEEKLY = "WEEKLY"
336
334
  }
337
- declare enum Day {
335
+ export declare enum Day {
338
336
  /** The recurring event takes place on Mondays. */
339
337
  MONDAY = "MONDAY",
340
338
  /** The recurring event takes place on Tuesdays. */
@@ -350,14 +348,14 @@ declare enum Day {
350
348
  /** The recurring event takes place on Sundays. */
351
349
  SUNDAY = "SUNDAY"
352
350
  }
353
- declare enum Transparency {
351
+ export declare enum Transparency {
354
352
  UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
355
353
  /** 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. */
356
354
  OPAQUE = "OPAQUE",
357
355
  /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
358
356
  TRANSPARENT = "TRANSPARENT"
359
357
  }
360
- interface Location {
358
+ export interface Location {
361
359
  /**
362
360
  * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
363
361
  * ID. Available only for `BUSINESS` locations.
@@ -393,7 +391,7 @@ interface Location {
393
391
  */
394
392
  address?: string | null;
395
393
  }
396
- declare enum LocationType {
394
+ export declare enum LocationType {
397
395
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
398
396
  /** The event is held at a business location. */
399
397
  BUSINESS = "BUSINESS",
@@ -402,7 +400,7 @@ declare enum LocationType {
402
400
  /** The event is held at an address or venue not tied to the business or customer. */
403
401
  CUSTOM = "CUSTOM"
404
402
  }
405
- interface Resource {
403
+ export interface Resource {
406
404
  /**
407
405
  * Resource ID.
408
406
  * @format GUID
@@ -435,14 +433,14 @@ interface Resource {
435
433
  */
436
434
  permissionRole?: Role;
437
435
  }
438
- declare enum Role {
436
+ export declare enum Role {
439
437
  UNKNOWN_ROLE = "UNKNOWN_ROLE",
440
438
  /** Full read and write access. */
441
439
  WRITER = "WRITER",
442
440
  /** Full read access, write access limited to `event.notes`. */
443
441
  COMMENTER = "COMMENTER"
444
442
  }
445
- interface Participants {
443
+ export interface Participants {
446
444
  /**
447
445
  * Total number of participants.
448
446
  *
@@ -472,7 +470,7 @@ interface Participants {
472
470
  */
473
471
  status?: ParticipantsStatus;
474
472
  }
475
- interface Participant {
473
+ export interface Participant {
476
474
  /**
477
475
  * Participant name.
478
476
  *
@@ -499,14 +497,14 @@ interface Participant {
499
497
  */
500
498
  contactId?: string | null;
501
499
  }
502
- declare enum ParticipantsStatus {
500
+ export declare enum ParticipantsStatus {
503
501
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
504
502
  /** All participants are confirmed. */
505
503
  CONFIRMED = "CONFIRMED",
506
504
  /** At least one participant isn't confirmed yet. */
507
505
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
508
506
  }
509
- interface ConferencingDetails {
507
+ export interface ConferencingDetails {
510
508
  /** Conference type. For example, `Zoom`. */
511
509
  type?: Type;
512
510
  /**
@@ -546,12 +544,12 @@ interface ConferencingDetails {
546
544
  */
547
545
  externalId?: string | null;
548
546
  }
549
- declare enum Type {
547
+ export declare enum Type {
550
548
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
551
549
  ZOOM = "ZOOM",
552
550
  CUSTOM = "CUSTOM"
553
551
  }
554
- declare enum Field {
552
+ export declare enum Field {
555
553
  UNKNOWN_FIELD = "UNKNOWN_FIELD",
556
554
  /** `title` is inherited from the schedule or `MASTER` event. */
557
555
  TITLE = "TITLE",
@@ -570,7 +568,7 @@ declare enum Field {
570
568
  /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
571
569
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
572
570
  }
573
- interface Permission {
571
+ export interface Permission {
574
572
  /**
575
573
  * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
576
574
  * granted the permission.
@@ -585,7 +583,7 @@ interface Permission {
585
583
  */
586
584
  role?: Role;
587
585
  }
588
- interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
586
+ export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
589
587
  /**
590
588
  * ID of a Wix user. For example, the site owner or a
591
589
  * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
@@ -594,7 +592,7 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
594
592
  wixUserId?: string;
595
593
  }
596
594
  /** @oneof */
597
- interface CommonIdentificationDataIdOneOf {
595
+ export interface CommonIdentificationDataIdOneOf {
598
596
  /**
599
597
  * ID of a Wix user. For example, the site owner or a
600
598
  * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
@@ -602,7 +600,11 @@ interface CommonIdentificationDataIdOneOf {
602
600
  */
603
601
  wixUserId?: string;
604
602
  }
605
- interface ExtendedFields {
603
+ export declare enum IdentityType {
604
+ UNKNOWN = "UNKNOWN",
605
+ WIX_USER = "WIX_USER"
606
+ }
607
+ export interface ExtendedFields {
606
608
  /**
607
609
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
608
610
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -613,7 +615,17 @@ interface ExtendedFields {
613
615
  */
614
616
  namespaces?: Record<string, Record<string, any>>;
615
617
  }
616
- interface ParticipantNotification {
618
+ export interface RecurringEventSplit {
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 {
617
629
  /**
618
630
  * Whether to notify the participants about changes made to the schedule or event.
619
631
  *
@@ -630,7 +642,177 @@ interface ParticipantNotification {
630
642
  */
631
643
  message?: string | null;
632
644
  }
633
- interface ListEventsByContactIdRequest {
645
+ /** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
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 {
634
816
  /**
635
817
  * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
636
818
  * to retrieve events for. Required, unless you provide `cursorPaging`.
@@ -676,7 +858,7 @@ interface ListEventsByContactIdRequest {
676
858
  cursorPaging?: CommonCursorPaging;
677
859
  }
678
860
  /** TODO Diverge */
679
- interface CommonCursorPaging {
861
+ export interface CommonCursorPaging {
680
862
  /**
681
863
  * Number of events to return.
682
864
  * Defaults to `50`. Maximum `100`.
@@ -693,14 +875,14 @@ interface CommonCursorPaging {
693
875
  */
694
876
  cursor?: string | null;
695
877
  }
696
- interface ListEventsByContactIdResponse {
878
+ export interface ListEventsByContactIdResponse {
697
879
  /** Retrieved events. */
698
880
  events?: Event[];
699
881
  /** Paging metadata. */
700
882
  pagingMetadata?: CommonCursorPagingMetadata;
701
883
  }
702
884
  /** TODO Diverge */
703
- interface CommonCursorPagingMetadata {
885
+ export interface CommonCursorPagingMetadata {
704
886
  /** Number of items returned in the response. */
705
887
  count?: number | null;
706
888
  /** 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). */
@@ -712,11 +894,11 @@ interface CommonCursorPagingMetadata {
712
894
  */
713
895
  hasNext?: boolean | null;
714
896
  }
715
- interface CommonCursors {
897
+ export interface CommonCursors {
716
898
  /** Cursor pointing to next page in the list of results. */
717
899
  next?: string | null;
718
900
  }
719
- interface ListEventsByMemberIdRequest {
901
+ export interface ListEventsByMemberIdRequest {
720
902
  /**
721
903
  * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
722
904
  * to retrieve events for. Required, unless you provide `cursorPaging`.
@@ -776,13 +958,293 @@ interface ListEventsByMemberIdRequest {
776
958
  */
777
959
  eventIds?: string[];
778
960
  }
779
- interface ListEventsByMemberIdResponse {
961
+ export interface ListEventsByMemberIdResponse {
780
962
  /** Retrieved events. */
781
963
  events?: Event[];
782
964
  /** Paging metadata. */
783
965
  pagingMetadata?: CommonCursorPagingMetadata;
784
966
  }
785
- interface GetEventRequest {
967
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
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 {
786
1248
  /**
787
1249
  * ID of the event to retrieve.
788
1250
  *
@@ -815,18 +1277,18 @@ interface GetEventRequest {
815
1277
  */
816
1278
  fields?: RequestedFields[];
817
1279
  }
818
- declare enum RequestedFields {
1280
+ export declare enum RequestedFields {
819
1281
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
820
1282
  /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
821
1283
  PI_FIELDS = "PI_FIELDS",
822
1284
  /** Returns only fields containing your own personal data. */
823
1285
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
824
1286
  }
825
- interface GetEventResponse {
1287
+ export interface GetEventResponse {
826
1288
  /** Retrieved event. */
827
1289
  event?: Event;
828
1290
  }
829
- interface ListEventsRequest {
1291
+ export interface ListEventsRequest {
830
1292
  /**
831
1293
  * IDs of the events to retrieve.
832
1294
  *
@@ -861,11 +1323,11 @@ interface ListEventsRequest {
861
1323
  */
862
1324
  fields?: RequestedFields[];
863
1325
  }
864
- interface ListEventsResponse {
1326
+ export interface ListEventsResponse {
865
1327
  /** Retrieved events matching the provided IDs. */
866
1328
  events?: Event[];
867
1329
  }
868
- interface QueryEventsRequest {
1330
+ export interface QueryEventsRequest {
869
1331
  /**
870
1332
  * Local start date and time from which events are returned in
871
1333
  * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
@@ -896,7 +1358,11 @@ interface QueryEventsRequest {
896
1358
  * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
897
1359
  */
898
1360
  timeZone?: string | null;
899
- /** Query containing filters and paging. */
1361
+ /**
1362
+ * Query containing filters and paging.
1363
+ * Do not specify filters for start and end dates inside `query.filter`, instead
1364
+ * specify `fromLocalDate` and `toLocalDate`.
1365
+ */
900
1366
  query?: CursorQuery;
901
1367
  /**
902
1368
  * Filters events based on their `recurrenceType`.
@@ -922,17 +1388,21 @@ interface QueryEventsRequest {
922
1388
  fields?: RequestedFields[];
923
1389
  }
924
1390
  /** TODO Diverge */
925
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
1391
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
926
1392
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
927
1393
  cursorPaging?: CursorPaging;
928
1394
  /**
929
1395
  * Filter object.
930
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
1396
+ * See API Query Language
1397
+ * ([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))
931
1398
  * for more information.
932
1399
  *
933
1400
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
934
1401
  *
935
- * For a detailed list of supported filters, see Supported Filters.
1402
+ * Do not specify filters for start and end dates inside `query.filter`, instead
1403
+ * specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
1404
+ * filters, refer to the supported filters article
1405
+ * ([REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting)).
936
1406
  */
937
1407
  filter?: Record<string, any> | null;
938
1408
  /**
@@ -943,12 +1413,12 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
943
1413
  sort?: Sorting[];
944
1414
  }
945
1415
  /** @oneof */
946
- interface CursorQueryPagingMethodOneOf {
1416
+ export interface CursorQueryPagingMethodOneOf {
947
1417
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
948
1418
  cursorPaging?: CursorPaging;
949
1419
  }
950
1420
  /** TODO Diverge */
951
- interface Sorting {
1421
+ export interface Sorting {
952
1422
  /**
953
1423
  * The field to sort by.
954
1424
  * Either `start` or `end`.
@@ -958,12 +1428,12 @@ interface Sorting {
958
1428
  /** Sort order. */
959
1429
  order?: SortOrder;
960
1430
  }
961
- declare enum SortOrder {
1431
+ export declare enum SortOrder {
962
1432
  ASC = "ASC",
963
1433
  DESC = "DESC"
964
1434
  }
965
1435
  /** TODO Diverge */
966
- interface CursorPaging {
1436
+ export interface CursorPaging {
967
1437
  /**
968
1438
  * Number of events to return.
969
1439
  * Defaults to `50`. Maximum `1000`.
@@ -980,14 +1450,14 @@ interface CursorPaging {
980
1450
  */
981
1451
  cursor?: string | null;
982
1452
  }
983
- interface QueryEventsResponse {
1453
+ export interface QueryEventsResponse {
984
1454
  /** Retrieved events matching the provided query. */
985
1455
  events?: Event[];
986
1456
  /** Paging metadata. */
987
1457
  pagingMetadata?: CursorPagingMetadata;
988
1458
  }
989
1459
  /** TODO Diverge */
990
- interface CursorPagingMetadata {
1460
+ export interface CursorPagingMetadata {
991
1461
  /** Number of items returned in the response. */
992
1462
  count?: number | null;
993
1463
  /** 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). */
@@ -999,11 +1469,45 @@ interface CursorPagingMetadata {
999
1469
  */
1000
1470
  hasNext?: boolean | null;
1001
1471
  }
1002
- interface Cursors {
1472
+ export interface Cursors {
1003
1473
  /** Cursor pointing to next page in the list of results. */
1004
1474
  next?: string | null;
1005
1475
  }
1006
- interface CreateEventRequest {
1476
+ export interface ListRecurringEventInstancesHistoryRequest {
1477
+ /**
1478
+ * The ID of the recurring event.
1479
+ * Required, unless `cursorPaging` is provided.
1480
+ * @minLength 64
1481
+ * @maxLength 64
1482
+ */
1483
+ recurringEventId?: string | null;
1484
+ /**
1485
+ * The revision of the recurring event.
1486
+ * Required, unless `cursorPaging` is provided.
1487
+ */
1488
+ revision?: string | null;
1489
+ /**
1490
+ * Inclusive start date for which events are returned, in ISO-8601 format.
1491
+ * Events that begin at or after the `fromDate` are included in the results.
1492
+ * Required, unless `cursorPaging` is provided.
1493
+ */
1494
+ fromDate?: Date | null;
1495
+ /**
1496
+ * Exclusive end date for which events are returned, in ISO-8601 format.
1497
+ * Events that begin before the `toDate` are included in the results.
1498
+ * Required, unless `cursorPaging` is provided.
1499
+ */
1500
+ toDate?: Date | null;
1501
+ /** Optional cursor pointing to the next page of events. */
1502
+ cursorPaging?: CursorPaging;
1503
+ }
1504
+ export interface ListRecurringEventInstancesHistoryResponse {
1505
+ /** The recurring event instances. */
1506
+ recurringEventInstances?: Event[];
1507
+ /** Paging metadata. */
1508
+ pagingMetadata?: CursorPagingMetadata;
1509
+ }
1510
+ export interface CreateEventRequest {
1007
1511
  /** Event to create. */
1008
1512
  event: Event;
1009
1513
  /**
@@ -1021,11 +1525,11 @@ interface CreateEventRequest {
1021
1525
  */
1022
1526
  idempotencyKey?: string | null;
1023
1527
  }
1024
- interface CreateEventResponse {
1528
+ export interface CreateEventResponse {
1025
1529
  /** Created event. */
1026
1530
  event?: Event;
1027
1531
  }
1028
- interface BulkCreateEventRequest {
1532
+ export interface BulkCreateEventRequest {
1029
1533
  /**
1030
1534
  * Events to create.
1031
1535
  * @minSize 1
@@ -1047,23 +1551,23 @@ interface BulkCreateEventRequest {
1047
1551
  */
1048
1552
  timeZone?: string | null;
1049
1553
  }
1050
- interface MaskedEvent {
1554
+ export interface MaskedEvent {
1051
1555
  /** Event to create. */
1052
1556
  event?: Event;
1053
1557
  }
1054
- interface BulkCreateEventResponse {
1558
+ export interface BulkCreateEventResponse {
1055
1559
  /** The result for each event, containing the event and whether the action was successful. */
1056
1560
  results?: BulkEventResult[];
1057
1561
  /** Total successes and failures. */
1058
1562
  bulkActionMetadata?: BulkActionMetadata;
1059
1563
  }
1060
- interface BulkEventResult {
1564
+ export interface BulkEventResult {
1061
1565
  /** Whether the requested action was successful. */
1062
1566
  itemMetadata?: ItemMetadata;
1063
1567
  /** The event. */
1064
1568
  item?: Event;
1065
1569
  }
1066
- interface ItemMetadata {
1570
+ export interface ItemMetadata {
1067
1571
  /**
1068
1572
  * Event ID.
1069
1573
  * Should always be available, unless it's impossible (for example, when failing to create an event).
@@ -1079,7 +1583,7 @@ interface ItemMetadata {
1079
1583
  /** Details about the error in case of failure. */
1080
1584
  error?: ApplicationError;
1081
1585
  }
1082
- interface ApplicationError {
1586
+ export interface ApplicationError {
1083
1587
  /** Error code. */
1084
1588
  code?: string;
1085
1589
  /** Description of the error. */
@@ -1087,13 +1591,13 @@ interface ApplicationError {
1087
1591
  /** Data related to the error. */
1088
1592
  data?: Record<string, any> | null;
1089
1593
  }
1090
- interface BulkActionMetadata {
1594
+ export interface BulkActionMetadata {
1091
1595
  /** Number of events that were successfully processed. */
1092
1596
  totalSuccesses?: number;
1093
1597
  /** Number of events that couldn't be processed. */
1094
1598
  totalFailures?: number;
1095
1599
  }
1096
- interface UpdateEventRequest {
1600
+ export interface UpdateEventRequest {
1097
1601
  /** Event to update. */
1098
1602
  event: Event;
1099
1603
  /**
@@ -1110,11 +1614,11 @@ interface UpdateEventRequest {
1110
1614
  */
1111
1615
  timeZone?: string | null;
1112
1616
  }
1113
- interface UpdateEventResponse {
1617
+ export interface UpdateEventResponse {
1114
1618
  /** Updated event. */
1115
1619
  event?: Event;
1116
1620
  }
1117
- interface BulkUpdateEventRequest {
1621
+ export interface BulkUpdateEventRequest {
1118
1622
  /**
1119
1623
  * Events to update.
1120
1624
  *
@@ -1144,17 +1648,34 @@ interface BulkUpdateEventRequest {
1144
1648
  */
1145
1649
  timeZone?: string | null;
1146
1650
  }
1147
- interface BulkUpdateEventRequestMaskedEvent {
1651
+ export interface BulkUpdateEventRequestMaskedEvent {
1148
1652
  /** Event to update. */
1149
1653
  event?: Event;
1150
1654
  }
1151
- interface BulkUpdateEventResponse {
1655
+ export interface BulkUpdateEventResponse {
1152
1656
  /** The result for each event, containing the event and whether the action was successful. */
1153
1657
  results?: BulkEventResult[];
1154
1658
  /** Total successes and failures. */
1155
1659
  bulkActionMetadata?: BulkActionMetadata;
1156
1660
  }
1157
- interface RestoreEventDefaultsRequest {
1661
+ export interface UpdateEventParticipantsRequest {
1662
+ /**
1663
+ * ID of the event to update.
1664
+ *
1665
+ * Min: 36 characters
1666
+ * Max: 250 characters
1667
+ * @minLength 36
1668
+ * @maxLength 250
1669
+ */
1670
+ eventId?: string | null;
1671
+ /** The participants to update. */
1672
+ participants?: Participants;
1673
+ }
1674
+ export interface UpdateEventParticipantsResponse {
1675
+ /** Updated event. */
1676
+ event?: Event;
1677
+ }
1678
+ export interface RestoreEventDefaultsRequest {
1158
1679
  /**
1159
1680
  * ID of the event for which to restore default values.
1160
1681
  * @minLength 36
@@ -1184,11 +1705,11 @@ interface RestoreEventDefaultsRequest {
1184
1705
  */
1185
1706
  timeZone?: string | null;
1186
1707
  }
1187
- interface RestoreEventDefaultsResponse {
1708
+ export interface RestoreEventDefaultsResponse {
1188
1709
  /** Updated event. */
1189
1710
  event?: Event;
1190
1711
  }
1191
- interface SplitRecurringEventRequest {
1712
+ export interface SplitRecurringEventRequest {
1192
1713
  /**
1193
1714
  * ID of the `MASTER` event to split.
1194
1715
  * @minLength 36
@@ -1215,13 +1736,13 @@ interface SplitRecurringEventRequest {
1215
1736
  */
1216
1737
  timeZone?: string | null;
1217
1738
  }
1218
- interface SplitRecurringEventResponse {
1739
+ export interface SplitRecurringEventResponse {
1219
1740
  /** Original `MASTER` event that was shortened. */
1220
1741
  updatedRecurringEventEndingBeforeSplit?: Event;
1221
1742
  /** New `MASTER` event starting with the first event after the split date. */
1222
1743
  newRecurringEventStartingFromSplit?: Event;
1223
1744
  }
1224
- interface CancelEventRequest {
1745
+ export interface CancelEventRequest {
1225
1746
  /**
1226
1747
  * ID of the event to cancel.
1227
1748
  * @minLength 36
@@ -1242,11 +1763,11 @@ interface CancelEventRequest {
1242
1763
  */
1243
1764
  timeZone?: string | null;
1244
1765
  }
1245
- interface CancelEventResponse {
1766
+ export interface CancelEventResponse {
1246
1767
  /** Canceled event. */
1247
1768
  event?: Event;
1248
1769
  }
1249
- interface BulkCancelEventRequest {
1770
+ export interface BulkCancelEventRequest {
1250
1771
  /**
1251
1772
  * IDs of the events to cancel.
1252
1773
  * @minSize 1
@@ -1273,49 +1794,9 @@ interface BulkCancelEventRequest {
1273
1794
  */
1274
1795
  timeZone?: string | null;
1275
1796
  }
1276
- interface BulkCancelEventResponse {
1797
+ export interface BulkCancelEventResponse {
1277
1798
  /** The result for each event, containing the event and whether the action was successful. */
1278
1799
  results?: BulkEventResult[];
1279
1800
  /** Total successes and failures. */
1280
1801
  bulkActionMetadata?: BulkActionMetadata;
1281
1802
  }
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 };