@wix/events 1.0.340 → 1.0.342

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.
@@ -493,7 +493,7 @@ interface EventGuest {
493
493
  contactId?: string | null;
494
494
  /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
495
495
  guestDetails?: GuestDetails$2;
496
- /** Attendance status. The attendaces status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
496
+ /** Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
497
497
  attendanceStatus?: AttendanceStatus;
498
498
  /** Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. */
499
499
  secondaryLanguageCode?: string | null;
@@ -505,7 +505,7 @@ interface EventGuest {
505
505
  attendanceStatusUpdatedDate?: Date | null;
506
506
  /** Site member ID. */
507
507
  memberId?: string | null;
508
- /** Guest type: <br/> <br/> `RSVP`: An invited guest, no ticket necessary. <br/> <br/> `BUYER`: The guest who bought the tickets. <br/> <br/> `TICKET_HOLDER`: The guest for whom the ticket was bought. */
508
+ /** Guest type. */
509
509
  guestType?: GuestType;
510
510
  /** Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. */
511
511
  locale?: string | null;
@@ -651,11 +651,11 @@ declare enum AttendanceStatus {
651
651
  IN_WAITLIST = "IN_WAITLIST"
652
652
  }
653
653
  declare enum GuestType {
654
- /** Rsvp guest. */
654
+ /** An invited guest, no ticket necessary. */
655
655
  RSVP = "RSVP",
656
- /** Buyer guest. */
656
+ /** The guest who bought the ticket. */
657
657
  BUYER = "BUYER",
658
- /** Ticket holder guest. */
658
+ /** The guest for whom the ticket was bought. */
659
659
  TICKET_HOLDER = "TICKET_HOLDER"
660
660
  }
661
661
  interface GuestCountUpdated {
@@ -682,24 +682,24 @@ interface MemberEventStatusUpdated {
682
682
  }
683
683
  declare enum MemberEventStatusUpdatedEventType {
684
684
  /**
685
- * Every time a guest with specified member ID is added to the event.
686
- * This event can also be fired if existing guest changed member ID.
685
+ * Triggered every time a guest with a specified member ID is added to the event.
686
+ * This event can also be triggered if an existing guest changed their member ID.
687
687
  */
688
688
  MEMBER_JOINED = "MEMBER_JOINED",
689
689
  /**
690
- * Every time a guest with specified member ID is removed from the event.
691
- * This event can also be fired if existing guest changed member ID.
690
+ * Triggered every time a guest with a specified member ID is removed from the event.
691
+ * This event can also be triggered if an existing guest changed their member ID.
692
692
  */
693
693
  MEMBER_LEFT = "MEMBER_LEFT",
694
694
  /**
695
- * Every time a guest with specified member ID and status ATTENDING is added to the event.
696
- * This event can also be fired if existing guest changed member ID or status to ATTENDING.
695
+ * Triggered every time a guest with a specified member ID whose status is `ATTENDING` is added to the event.
696
+ * This event can also be triggered if an existing guest changed their member ID or changed their status to `ATTENDING`.
697
697
  */
698
698
  ATTENDING_MEMBER_JOINED = "ATTENDING_MEMBER_JOINED",
699
699
  /**
700
- * Once last guest with specified member ID is removed from the event or status became not ATTENDING.
701
- * Once this is fired there are no more attending guests with specified member ID in the event.
702
- * This event can also be fired if existing guest changed their member ID or status to not ATTENDING.
700
+ * Triggered when the last guest with a specified member ID is removed from the event or their status changes to `ATTENDING`.
701
+ * Once triggered there are no more attending guests with a specified member ID in the event.
702
+ * This event can also be triggered if the last existing guest changed their member ID or their status to `NOT_ATTENDING`.
703
703
  */
704
704
  LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
705
705
  }
@@ -713,19 +713,19 @@ interface ContactEventStatusUpdated {
713
713
  }
714
714
  declare enum EventType$5 {
715
715
  /**
716
- * Every time a guest with specified contact ID is added to the event.
717
- * This event can also be fired if existing guest changed contact ID.
716
+ * Triggered every time a guest with a specified contact ID is added to the event.
717
+ * This event can also be triggered if an existing guest changed their contact ID.
718
718
  */
719
719
  CONTACT_JOINED = "CONTACT_JOINED",
720
720
  /**
721
- * Every time a guest with specified contact ID is removed from the event.
722
- * This event can also be fired if existing guest changed contact ID.
721
+ * Triggered every time a guest with a specified contact ID is removed from the event.
722
+ * This event can also be triggered if an existing guest changed their contact ID.
723
723
  */
724
724
  CONTACT_LEFT = "CONTACT_LEFT",
725
725
  /**
726
- * Once last guest with specified contact ID is removed from the event.
727
- * Once this is fired there are no more guests with specified contact ID in the event.
728
- * This event can also be fired if existing guest changed their contact ID.
726
+ * Triggred when the last guest with a specified contact ID is removed from the event.
727
+ * Once triggered there are no more guests with a specified contact ID in the event.
728
+ * This event can also be triggered if the last existing guest changed their contact ID.
729
729
  */
730
730
  LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
731
731
  }
@@ -770,11 +770,7 @@ interface EventDetails$1 {
770
770
  interface Location$7 {
771
771
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
772
772
  name?: string | null;
773
- /**
774
- * Location type. Possible values:
775
- * - `VENUE`: Event is on-site at a specific physical location.
776
- * - `ONLINE`: Event is online, such as a virtual video conference.
777
- */
773
+ /** Location type. */
778
774
  type?: LocationType$7;
779
775
  /** Exact location address. */
780
776
  address?: CommonAddress$4;
@@ -782,9 +778,11 @@ interface Location$7 {
782
778
  locationTbd?: boolean | null;
783
779
  }
784
780
  declare enum LocationType$7 {
785
- /** Default value. This value is unused. */
781
+ /** Unknown location type. */
786
782
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
783
+ /** Event is on-site at a specific physical location. */
787
784
  VENUE = "VENUE",
785
+ /** Event is online, such as a virtual video conference. */
788
786
  ONLINE = "ONLINE"
789
787
  }
790
788
  /** Physical address */
@@ -860,12 +858,7 @@ interface DateAndTimeSettings$2 {
860
858
  /** Whether the time zone is displayed in the formatted schedule. */
861
859
  showTimeZone?: boolean | null;
862
860
  /**
863
- * Repeating event status. Possible values:
864
- * - `ONE_TIME`: Event happens only once and can last multiple days.
865
- * - `RECURRING`: A series of events that repeat.
866
- * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
867
- * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
868
- * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
861
+ * Repeating event status.
869
862
  * @readonly
870
863
  */
871
864
  recurrenceStatus?: RecurrenceStatusStatus$2;
@@ -875,17 +868,17 @@ interface DateAndTimeSettings$2 {
875
868
  formatted?: Formatted$2;
876
869
  }
877
870
  declare enum RecurrenceStatusStatus$2 {
878
- /** Default value. This value is unused. */
871
+ /** Unknown recurrance status. */
879
872
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
880
- /** Event happens only once. */
873
+ /** Event happens only once and can last multiple days. */
881
874
  ONE_TIME = "ONE_TIME",
882
- /** Event is repeating and has a list of scheduled repetitions. */
875
+ /** A series of events that repeat. */
883
876
  RECURRING = "RECURRING",
884
- /** An upcoming event from the list of repetitions. */
877
+ /** Next event in a schedule of recurring events. */
885
878
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
886
- /** Latest ended event from the list of repetitions. */
879
+ /** Latest event that ended in a schedule of recurring events. */
887
880
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
888
- /** Latest cancelled event from the list of repetitions. */
881
+ /** Latest canceled event in a schedule of recurring events */
889
882
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
890
883
  }
891
884
  interface Recurrences$7 {
@@ -937,17 +930,17 @@ interface Formatted$2 {
937
930
  endTime?: string | null;
938
931
  }
939
932
  declare enum Status$8 {
940
- /** Default value. This value is unused */
933
+ /** Unknown event status. */
941
934
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
942
- /** Event is public and scheduled to start */
935
+ /** Event is published and scheduled to start. */
943
936
  UPCOMING = "UPCOMING",
944
- /** Event has started */
937
+ /** Event has started. */
945
938
  STARTED = "STARTED",
946
- /** Event has ended */
939
+ /** Event has ended. */
947
940
  ENDED = "ENDED",
948
- /** Event is canceled */
941
+ /** Event is canceled. */
949
942
  CANCELED = "CANCELED",
950
- /** Event is not public */
943
+ /** Event is not public. */
951
944
  DRAFT = "DRAFT"
952
945
  }
953
946
  interface NotifyGuestAction {
@@ -978,21 +971,21 @@ declare enum NotifyActionType {
978
971
  ORDER_CANCELED = "ORDER_CANCELED"
979
972
  }
980
973
  declare enum Timing {
981
- /** Default value. This value is unused. */
974
+ /** Unknown event start time. */
982
975
  UNKNOWN_TIMING = "UNKNOWN_TIMING",
983
- /** Instant */
976
+ /** Instant. */
984
977
  NOW = "NOW",
985
- /** 24 hours prior */
978
+ /** 24 hours prior. */
986
979
  STARTS_IN_1_DAY = "STARTS_IN_1_DAY",
987
- /** 3 days prior */
980
+ /** 3 days prior. */
988
981
  STARTS_IN_3_DAYS = "STARTS_IN_3_DAYS",
989
- /** 7 days prior */
982
+ /** 7 days prior. */
990
983
  STARTS_IN_1_WEEK = "STARTS_IN_1_WEEK",
991
- /** 1 hour prior */
984
+ /** 1 hour prior. */
992
985
  STARTS_IN_1_HOUR = "STARTS_IN_1_HOUR",
993
- /** 30 minutes prior */
986
+ /** 30 minutes prior. */
994
987
  STARTS_IN_30_MINUTES = "STARTS_IN_30_MINUTES",
995
- /** 2 hours prior */
988
+ /** 2 hours prior. */
996
989
  STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
997
990
  }
998
991
  interface OrderDetails {
@@ -1002,27 +995,27 @@ interface OrderDetails {
1002
995
  invoice?: Invoice$2;
1003
996
  }
1004
997
  declare enum OrderStatus$3 {
1005
- /** Order status not available for this request fieldset */
998
+ /** Order status not available for this request fieldset. */
1006
999
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
1007
- /** Order is confirmed, no payment required */
1000
+ /** Order is confirmed and payment isn't required. */
1008
1001
  FREE = "FREE",
1009
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
1002
+ /** Order is paid for but the payment gateway has suspended the payment. */
1010
1003
  PENDING = "PENDING",
1011
- /** Order paid via payment gateway */
1004
+ /** Order is paid via a payment gateway. */
1012
1005
  PAID = "PAID",
1013
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
1006
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
1014
1007
  OFFLINE_PENDING = "OFFLINE_PENDING",
1015
- /** Order is awaiting for payment in Cashier */
1008
+ /** Order is awaiting payment at the cashier. */
1016
1009
  INITIATED = "INITIATED",
1017
- /** Order was canceled */
1010
+ /** Order is canceled. */
1018
1011
  CANCELED = "CANCELED",
1019
- /** Order payment was declined */
1012
+ /** Order payment is declined. */
1020
1013
  DECLINED = "DECLINED",
1021
- /** Order payment was authorized */
1014
+ /** Order payment is authorized. */
1022
1015
  AUTHORIZED = "AUTHORIZED",
1023
- /** Order payment was voided */
1016
+ /** Order payment is voided. */
1024
1017
  VOIDED = "VOIDED",
1025
- /** Order was partially paid, less than total amount covered. */
1018
+ /** Order is partially paid with less than the total amount. */
1026
1019
  PARTIALLY_PAID = "PARTIALLY_PAID"
1027
1020
  }
1028
1021
  interface Invoice$2 {
@@ -1062,7 +1055,7 @@ interface Item$3 {
1062
1055
  _id?: string;
1063
1056
  /** Line item quantity. */
1064
1057
  quantity?: number;
1065
- /** Line item mame. */
1058
+ /** Line item name. */
1066
1059
  name?: string;
1067
1060
  /** Line item price. */
1068
1061
  price?: Money$8;
@@ -1335,11 +1328,7 @@ declare enum WebhookIdentityType$d {
1335
1328
  interface QueryEventGuestsRequest {
1336
1329
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
1337
1330
  query: QueryV2$8;
1338
- /**
1339
- * Predefined sets of fields to return.
1340
- * - `GUEST_DETAILS`: Returns `guestDetails` and `tickets`.
1341
- * - `GUEST_TOTAL`: Returns `totalGuests`.
1342
- */
1331
+ /** Predefined sets of fields to return. */
1343
1332
  fields?: RequestedFieldsEnumRequestedFields[];
1344
1333
  }
1345
1334
  interface QueryV2$8 extends QueryV2PagingMethodOneOf$8 {
@@ -1394,10 +1383,11 @@ interface CursorPaging$7 {
1394
1383
  cursor?: string | null;
1395
1384
  }
1396
1385
  declare enum RequestedFieldsEnumRequestedFields {
1386
+ /** Unknown requested field. */
1397
1387
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1398
- /** Select fields: `guestDetails` and `tickets`. */
1388
+ /** Returns `guestDetails` and `tickets`. */
1399
1389
  GUEST_DETAILS = "GUEST_DETAILS",
1400
- /** Returns queried guests total */
1390
+ /** Returns `totalGuests`. */
1401
1391
  GUEST_TOTAL = "GUEST_TOTAL"
1402
1392
  }
1403
1393
  interface QueryEventGuestsResponse {
@@ -1695,9 +1685,9 @@ interface OrderDeleted$1 {
1695
1685
  tickets?: Ticket$3[];
1696
1686
  }
1697
1687
  declare enum OrderType$1 {
1698
- /** Buyer form is used for all tickets */
1688
+ /** Buyer form is used for all tickets. */
1699
1689
  UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
1700
- /** Each order ticket has its own form */
1690
+ /** Each order ticket has its own form. */
1701
1691
  ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
1702
1692
  }
1703
1693
  interface EventDeleted$5 {
@@ -1893,11 +1883,7 @@ interface GuestOrderCanceledEnvelope {
1893
1883
  metadata: EventMetadata$6;
1894
1884
  }
1895
1885
  interface QueryEventGuestsOptions {
1896
- /**
1897
- * Predefined sets of fields to return.
1898
- * - `GUEST_DETAILS`: Returns `guestDetails` and `tickets`.
1899
- * - `GUEST_TOTAL`: Returns `totalGuests`.
1900
- */
1886
+ /** Predefined sets of fields to return. */
1901
1887
  fields?: RequestedFieldsEnumRequestedFields[] | undefined;
1902
1888
  }
1903
1889
  interface QueryCursorResult$7 {
@@ -3435,27 +3421,27 @@ interface OrderConfirmed$1 {
3435
3421
  reservationId?: string;
3436
3422
  }
3437
3423
  declare enum OrderStatus$2 {
3438
- /** Order status not available for this request fieldset */
3424
+ /** Order status not available for this request fieldset. */
3439
3425
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
3440
- /** Order is confirmed, no payment required */
3426
+ /** Order is confirmed and payment isn't required. */
3441
3427
  FREE = "FREE",
3442
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
3428
+ /** Order is paid for but the payment gateway has suspended the payment. */
3443
3429
  PENDING = "PENDING",
3444
- /** Order paid via payment gateway */
3430
+ /** Order is paid via a payment gateway. */
3445
3431
  PAID = "PAID",
3446
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
3432
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
3447
3433
  OFFLINE_PENDING = "OFFLINE_PENDING",
3448
- /** Order is awaiting for payment in Cashier */
3434
+ /** Order is awaiting payment at the cashier. */
3449
3435
  INITIATED = "INITIATED",
3450
- /** Order was canceled */
3436
+ /** Order is canceled. */
3451
3437
  CANCELED = "CANCELED",
3452
- /** Order payment was declined */
3438
+ /** Order payment is declined. */
3453
3439
  DECLINED = "DECLINED",
3454
- /** Order payment was authorized */
3440
+ /** Order payment is authorized. */
3455
3441
  AUTHORIZED = "AUTHORIZED",
3456
- /** Order payment was voided */
3442
+ /** Order payment is voided. */
3457
3443
  VOIDED = "VOIDED",
3458
- /** Order was partially paid, less than total amount covered. */
3444
+ /** Order is partially paid with less than the total amount. */
3459
3445
  PARTIALLY_PAID = "PARTIALLY_PAID"
3460
3446
  }
3461
3447
  interface Ticket$2 {
@@ -3527,7 +3513,7 @@ interface Item$2 {
3527
3513
  _id?: string;
3528
3514
  /** Line item quantity. */
3529
3515
  quantity?: number;
3530
- /** Line item mame. */
3516
+ /** Line item name. */
3531
3517
  name?: string;
3532
3518
  /** Line item price. */
3533
3519
  price?: Money$7;
@@ -4192,9 +4178,9 @@ interface TimeInterval$1 {
4192
4178
  timeZoneId?: string | null;
4193
4179
  }
4194
4180
  declare enum ScheduleStatus$1 {
4195
- /** Item is scheduled for a future date */
4181
+ /** Item is scheduled for a future date. */
4196
4182
  SCHEDULED = "SCHEDULED",
4197
- /** Item was canceled */
4183
+ /** Item is canceled. */
4198
4184
  CANCELED = "CANCELED"
4199
4185
  }
4200
4186
  interface ListScheduleItemsRequest$1 {
@@ -4602,9 +4588,9 @@ interface TimeInterval {
4602
4588
  timeZoneId?: string | null;
4603
4589
  }
4604
4590
  declare enum ScheduleStatus {
4605
- /** Item is scheduled for a future date */
4591
+ /** Item is scheduled for a future date. */
4606
4592
  SCHEDULED = "SCHEDULED",
4607
- /** Item was canceled */
4593
+ /** Item is canceled. */
4608
4594
  CANCELED = "CANCELED"
4609
4595
  }
4610
4596
  interface ListScheduleItemsRequest {
@@ -8439,27 +8425,27 @@ interface StandardDetails$3 {
8439
8425
  iso31662?: string | null;
8440
8426
  }
8441
8427
  declare enum OrderStatus$1 {
8442
- /** Order status not available for this request fieldset */
8428
+ /** Order status not available for this request fieldset. */
8443
8429
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
8444
- /** Order is confirmed, no payment required */
8430
+ /** Order is confirmed and payment isn't required. */
8445
8431
  FREE = "FREE",
8446
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
8432
+ /** Order is paid for but the payment gateway has suspended the payment. */
8447
8433
  PENDING = "PENDING",
8448
- /** Order paid via payment gateway */
8434
+ /** Order is paid via a payment gateway. */
8449
8435
  PAID = "PAID",
8450
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
8436
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
8451
8437
  OFFLINE_PENDING = "OFFLINE_PENDING",
8452
- /** Order is awaiting for payment in Cashier */
8438
+ /** Order is awaiting payment at the cashier. */
8453
8439
  INITIATED = "INITIATED",
8454
- /** Order was canceled */
8440
+ /** Order is canceled. */
8455
8441
  CANCELED = "CANCELED",
8456
- /** Order payment was declined */
8442
+ /** Order payment is declined. */
8457
8443
  DECLINED = "DECLINED",
8458
- /** Order payment was authorized */
8444
+ /** Order payment is authorized. */
8459
8445
  AUTHORIZED = "AUTHORIZED",
8460
- /** Order payment was voided */
8446
+ /** Order payment is voided. */
8461
8447
  VOIDED = "VOIDED",
8462
- /** Order was partially paid, less than total amount covered. */
8448
+ /** Order is partially paid with less than the total amount. */
8463
8449
  PARTIALLY_PAID = "PARTIALLY_PAID"
8464
8450
  }
8465
8451
  interface Money$5 {
@@ -8560,9 +8546,9 @@ interface GuestDetails$1 {
8560
8546
  phone?: string | null;
8561
8547
  }
8562
8548
  declare enum ChannelType$1 {
8563
- /** Buyer created order via one of the online channels (website, mobile app, etc.) */
8549
+ /** Buyer created the order via an online channel such as a website or mobile app. */
8564
8550
  ONLINE = "ONLINE",
8565
- /** Order created and money collected by the sales person */
8551
+ /** Sales person created the order and collected the money. */
8566
8552
  OFFLINE_POS = "OFFLINE_POS"
8567
8553
  }
8568
8554
  interface TicketDetails$1 {
@@ -8643,7 +8629,7 @@ interface Item$1 {
8643
8629
  _id?: string;
8644
8630
  /** Line item quantity. */
8645
8631
  quantity?: number;
8646
- /** Line item mame. */
8632
+ /** Line item name. */
8647
8633
  name?: string;
8648
8634
  /** Line item price. */
8649
8635
  price?: Money$5;
@@ -8787,11 +8773,11 @@ interface PaymentTransaction {
8787
8773
  method?: string;
8788
8774
  }
8789
8775
  declare enum ScheduledActionEnumAction {
8790
- /** Action not scheduled */
8776
+ /** Action not scheduled. */
8791
8777
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
8792
- /** Capture after the delay */
8778
+ /** Captured after the delay. */
8793
8779
  CAPTURE = "CAPTURE",
8794
- /** Void after the delay */
8780
+ /** Void after the delay. */
8795
8781
  VOID = "VOID"
8796
8782
  }
8797
8783
  declare enum Action {
@@ -8853,9 +8839,9 @@ interface OrderDeleted {
8853
8839
  tickets?: Ticket$1[];
8854
8840
  }
8855
8841
  declare enum OrderType {
8856
- /** Buyer form is used for all tickets */
8842
+ /** Buyer form is used for all tickets. */
8857
8843
  UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
8858
- /** Each order ticket has its own form */
8844
+ /** Each order ticket has its own form. */
8859
8845
  ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
8860
8846
  }
8861
8847
  interface Ticket$1 {
@@ -8952,29 +8938,29 @@ interface ListOrdersRequest {
8952
8938
  contactId?: string[];
8953
8939
  }
8954
8940
  declare enum OrderFieldset {
8955
- /** Include tickets in response */
8941
+ /** Include tickets in response. */
8956
8942
  TICKETS = "TICKETS",
8957
- /** Include order details: status, first_name, last_name, email, created, etc. */
8943
+ /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
8958
8944
  DETAILS = "DETAILS",
8959
- /** Include checkout_form */
8945
+ /** Include `checkoutForm` in the response. */
8960
8946
  FORM = "FORM",
8961
- /** Include invoice */
8947
+ /** Include `invoice` in the response. */
8962
8948
  INVOICE = "INVOICE"
8963
8949
  }
8964
8950
  declare enum OrderTag {
8965
- /** Return only confirmed orders */
8951
+ /** Return only confirmed orders. */
8966
8952
  CONFIRMED = "CONFIRMED",
8967
- /** Return only unconfirmed orders */
8953
+ /** Return only unconfirmed orders. */
8968
8954
  UNCONFIRMED = "UNCONFIRMED",
8969
- /** Return only member orders */
8955
+ /** Return only member orders. */
8970
8956
  MEMBER = "MEMBER",
8971
- /** Return only archived orders */
8957
+ /** Return only archived orders. */
8972
8958
  ARCHIVED = "ARCHIVED",
8973
- /** Return only non archived orders */
8959
+ /** Return only non archived orders. */
8974
8960
  NON_ARCHIVED = "NON_ARCHIVED",
8975
- /** Return only orders with all guests checked-in */
8961
+ /** Return only orders with all guests checked-in. */
8976
8962
  FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
8977
- /** Return only orders with no guests checked-in */
8963
+ /** Return only orders with no guests checked-in. */
8978
8964
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
8979
8965
  }
8980
8966
  interface ListOrdersResponse {
@@ -9395,18 +9381,15 @@ interface ReservationCreated$1 {
9395
9381
  counts?: ReservationCount$1[];
9396
9382
  }
9397
9383
  declare enum ReservationStatus$1 {
9398
- /**
9399
- * Reservation is pending confirmation.
9400
- * The reservation will expire after the expiration due time.
9401
- */
9384
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
9402
9385
  RESERVATION_PENDING = "RESERVATION_PENDING",
9403
- /** The reservation was confirmed and will not expire. */
9386
+ /** The reservation is confirmed and will not expire. */
9404
9387
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
9405
- /** The reservation was canceled because of non payment. */
9388
+ /** The reservation is canceled because of non payment. */
9406
9389
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
9407
- /** The reservation was canceled manually by the buyer. */
9390
+ /** The reservation is canceled manually by the buyer. */
9408
9391
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
9409
- /** The reservation has expired. */
9392
+ /** The reservation is expired. */
9410
9393
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
9411
9394
  }
9412
9395
  interface TicketQuantity$1 {
@@ -9563,11 +9546,11 @@ interface TicketSalePeriod$1 {
9563
9546
  hideNotOnSale?: boolean;
9564
9547
  }
9565
9548
  declare enum TicketSaleStatus$1 {
9566
- /** Ticket sale is scheduled to start */
9549
+ /** Ticket sale is scheduled to start. */
9567
9550
  SALE_SCHEDULED = "SALE_SCHEDULED",
9568
- /** Ticket sale has started */
9551
+ /** Ticket sale has started. */
9569
9552
  SALE_STARTED = "SALE_STARTED",
9570
- /** Ticket sale has ended */
9553
+ /** Ticket sale has ended. */
9571
9554
  SALE_ENDED = "SALE_ENDED"
9572
9555
  }
9573
9556
  interface TicketPricing$1 extends TicketPricingPriceOneOf$1 {
@@ -9623,9 +9606,9 @@ interface QueryAvailableTicketsRequest {
9623
9606
  sort?: string;
9624
9607
  }
9625
9608
  declare enum TicketDefinitionFieldset$1 {
9626
- /** Include policy in the response. */
9609
+ /** Include `policy` in the response. */
9627
9610
  POLICY = "POLICY",
9628
- /** Include dashboard in the response. */
9611
+ /** Include `dashboard` in the response. */
9629
9612
  DASHBOARD = "DASHBOARD"
9630
9613
  }
9631
9614
  interface QueryAvailableTicketsResponse {
@@ -13428,19 +13411,19 @@ interface ListRsvpRequest {
13428
13411
  tag?: RsvpTag[];
13429
13412
  }
13430
13413
  declare enum RsvpFieldset {
13431
- /** Include RSVP details: created, modified, first_name, last_name, etc. */
13414
+ /** Include RSVP details including: `created`, `modified`, `firstName`, `lastName`, `status`, `totalGuests`, `guests`, and `annonymized`. */
13432
13415
  DETAILS = "DETAILS",
13433
- /** Include rsvp_form. */
13416
+ /** Include RSVP form. */
13434
13417
  FORM = "FORM",
13435
13418
  /** Include RSVP email. */
13436
13419
  CONTACT_DETAILS = "CONTACT_DETAILS"
13437
13420
  }
13438
13421
  declare enum RsvpTag {
13439
- /** Return only rsvps with all guests checked-in */
13422
+ /** Return only RSVPs of all guests that are fully checked-in. */
13440
13423
  FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
13441
- /** Return only rsvps with not all guests checked-in */
13424
+ /** Return only RSVPs of all guests that aren't fully checked-in. */
13442
13425
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN",
13443
- /** Return only member rsvp */
13426
+ /** Return only RSVPs of guests that are members. */
13444
13427
  MEMBER = "MEMBER"
13445
13428
  }
13446
13429
  interface ListRsvpResponse {
@@ -14341,27 +14324,27 @@ interface CheckIn {
14341
14324
  created?: Date | null;
14342
14325
  }
14343
14326
  declare enum OrderStatus {
14344
- /** Order status not available for this request fieldset */
14327
+ /** Order status not available for this request fieldset. */
14345
14328
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
14346
- /** Order is confirmed, no payment required */
14329
+ /** Order is confirmed and payment isn't required. */
14347
14330
  FREE = "FREE",
14348
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
14331
+ /** Order is paid for but the payment gateway has suspended the payment. */
14349
14332
  PENDING = "PENDING",
14350
- /** Order paid via payment gateway */
14333
+ /** Order is paid via a payment gateway. */
14351
14334
  PAID = "PAID",
14352
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
14335
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
14353
14336
  OFFLINE_PENDING = "OFFLINE_PENDING",
14354
- /** Order is awaiting for payment in Cashier */
14337
+ /** Order is awaiting payment at the cashier. */
14355
14338
  INITIATED = "INITIATED",
14356
- /** Order was canceled */
14339
+ /** Order is canceled. */
14357
14340
  CANCELED = "CANCELED",
14358
- /** Order payment was declined */
14341
+ /** Order payment is declined. */
14359
14342
  DECLINED = "DECLINED",
14360
- /** Order payment was authorized */
14343
+ /** Order payment is authorized. */
14361
14344
  AUTHORIZED = "AUTHORIZED",
14362
- /** Order payment was voided */
14345
+ /** Order payment is voided. */
14363
14346
  VOIDED = "VOIDED",
14364
- /** Order was partially paid, less than total amount covered. */
14347
+ /** Order is partially paid with less than the total amount. */
14365
14348
  PARTIALLY_PAID = "PARTIALLY_PAID"
14366
14349
  }
14367
14350
  interface GuestDetails {
@@ -14461,9 +14444,9 @@ interface StandardDetails$1 {
14461
14444
  iso31662?: string | null;
14462
14445
  }
14463
14446
  declare enum ChannelType {
14464
- /** Buyer created order via one of the online channels (website, mobile app, etc.) */
14447
+ /** Buyer created the order via an online channel such as a website or mobile app. */
14465
14448
  ONLINE = "ONLINE",
14466
- /** Order created and money collected by the sales person */
14449
+ /** Sales person created the order and collected the money. */
14467
14450
  OFFLINE_POS = "OFFLINE_POS"
14468
14451
  }
14469
14452
  interface TicketDetails {
@@ -14555,31 +14538,31 @@ interface ListTicketsRequest {
14555
14538
  ticketDefinitionId?: string[];
14556
14539
  }
14557
14540
  declare enum TicketFieldset {
14558
- /** Include guest details in ticket response */
14541
+ /** Include guest details in the ticket response. */
14559
14542
  GUEST_DETAILS = "GUEST_DETAILS",
14560
- /** Include ticket details in ticket response */
14543
+ /** Include ticket details in the ticket response. */
14561
14544
  TICKET_DETAILS = "TICKET_DETAILS",
14562
- /** Include individual guest form in ticket response */
14545
+ /** Include individual guest form in the ticket response. */
14563
14546
  GUEST_FORM = "GUEST_FORM"
14564
14547
  }
14565
14548
  declare enum State$4 {
14566
- /** Returns only archived orders' tickets */
14549
+ /** Returns only archived orders' tickets. */
14567
14550
  ORDER_ARCHIVED = "ORDER_ARCHIVED",
14568
- /** Returns only non-archived orders' tickets */
14551
+ /** Returns only non-archived orders' tickets. */
14569
14552
  ORDER_ACTIVE = "ORDER_ACTIVE",
14570
- /** Returns only archived tickets */
14553
+ /** Returns only archived tickets. */
14571
14554
  TICKET_ARCHIVED = "TICKET_ARCHIVED",
14572
- /** Returns only non-archived tickets */
14555
+ /** Returns only non-archived tickets. */
14573
14556
  TICKET_ACTIVE = "TICKET_ACTIVE",
14574
- /** Returns only checked-in tickets */
14557
+ /** Returns only checked-in tickets. */
14575
14558
  CHECKED_IN = "CHECKED_IN",
14576
- /** Returns only non-checked-in tickets */
14559
+ /** Returns only non-checked-in tickets. */
14577
14560
  NON_CHECKED_IN = "NON_CHECKED_IN",
14578
- /** Returns only free tickets */
14561
+ /** Returns only free tickets. */
14579
14562
  FREE = "FREE",
14580
- /** Returns only paid tickets */
14563
+ /** Returns only paid tickets. */
14581
14564
  PAID = "PAID",
14582
- /** Returns only member tickets */
14565
+ /** Returns only member tickets. */
14583
14566
  MEMBER = "MEMBER"
14584
14567
  }
14585
14568
  interface ListTicketsResponse {
@@ -15233,11 +15216,11 @@ interface TicketSalePeriod {
15233
15216
  hideNotOnSale?: boolean;
15234
15217
  }
15235
15218
  declare enum TicketSaleStatus {
15236
- /** Ticket sale is scheduled to start */
15219
+ /** Ticket sale is scheduled to start. */
15237
15220
  SALE_SCHEDULED = "SALE_SCHEDULED",
15238
- /** Ticket sale has started */
15221
+ /** Ticket sale has started. */
15239
15222
  SALE_STARTED = "SALE_STARTED",
15240
- /** Ticket sale has ended */
15223
+ /** Ticket sale has ended. */
15241
15224
  SALE_ENDED = "SALE_ENDED"
15242
15225
  }
15243
15226
  declare enum TicketDefinitionStateEnumState {
@@ -15302,9 +15285,9 @@ interface QueryTicketDefinitionsRequest$1 {
15302
15285
  facet?: string[];
15303
15286
  }
15304
15287
  declare enum TicketDefinitionFieldset {
15305
- /** Include policy in the response. */
15288
+ /** Include `policy` in the response. */
15306
15289
  POLICY = "POLICY",
15307
- /** Include dashboard in the response. */
15290
+ /** Include `dashboard` in the response. */
15308
15291
  DASHBOARD = "DASHBOARD"
15309
15292
  }
15310
15293
  interface QueryTicketDefinitionsResponse$1 {
@@ -15447,13 +15430,13 @@ interface ListTicketDefinitionsRequest {
15447
15430
  facet?: string[];
15448
15431
  }
15449
15432
  declare enum State$3 {
15450
- /** Ticket is available for purchase. */
15433
+ /** The ticket is available for purchase. */
15451
15434
  VISIBLE = "VISIBLE",
15452
- /** Opposite to VISIBLE. */
15435
+ /** The ticket is unavailable for purchase. */
15453
15436
  HIDDEN = "HIDDEN",
15454
- /** Ticket price is 0. */
15437
+ /** The ticket price is 0. */
15455
15438
  FREE = "FREE",
15456
- /** Ticket price is greater than 0. */
15439
+ /** The ticket price is greater than 0. */
15457
15440
  PAID = "PAID"
15458
15441
  }
15459
15442
  declare enum GroupBy {
@@ -16993,6 +16976,7 @@ interface Rsvp {
16993
16976
  email?: string | null;
16994
16977
  /** Event registration form. */
16995
16978
  form?: FormResponse;
16979
+ /** RSVP response status. */
16996
16980
  status?: RsvpStatus;
16997
16981
  /**
16998
16982
  * Total number of guests per 1 RSVP.
@@ -17119,8 +17103,11 @@ interface StandardDetails {
17119
17103
  }
17120
17104
  declare enum RsvpStatus {
17121
17105
  UNKNOWN_RSVP_STATUS = "UNKNOWN_RSVP_STATUS",
17106
+ /** Guest is attending the event. */
17122
17107
  YES = "YES",
17108
+ /** Guest is not attending the event. */
17123
17109
  NO = "NO",
17110
+ /** Guest is in a waitlist. */
17124
17111
  WAITLIST = "WAITLIST"
17125
17112
  }
17126
17113
  interface GuestList {
@@ -19270,6 +19257,7 @@ interface UpdateRsvp {
19270
19257
  email?: string | null;
19271
19258
  /** Event registration form. */
19272
19259
  form?: FormResponse;
19260
+ /** RSVP response status. */
19273
19261
  status?: RsvpStatus;
19274
19262
  /**
19275
19263
  * Total number of guests per 1 RSVP.
@@ -19749,9 +19737,11 @@ interface Location$1 {
19749
19737
  locationTbd?: boolean | null;
19750
19738
  }
19751
19739
  declare enum LocationType$1 {
19752
- /** Default value. This value is unused. */
19740
+ /** Unknown location type. */
19753
19741
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
19742
+ /** Event is on-site at a specific physical location. */
19754
19743
  VENUE = "VENUE",
19744
+ /** Event is online, such as a virtual video conference. */
19755
19745
  ONLINE = "ONLINE"
19756
19746
  }
19757
19747
  /** Physical address */
@@ -19843,17 +19833,17 @@ interface DateAndTimeSettings$1 {
19843
19833
  formatted?: Formatted$1;
19844
19834
  }
19845
19835
  declare enum RecurrenceStatusStatus$1 {
19846
- /** Default value. This value is unused. */
19836
+ /** Unknown recurrance status. */
19847
19837
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
19848
- /** Event happens only once. */
19838
+ /** Event happens only once and can last multiple days. */
19849
19839
  ONE_TIME = "ONE_TIME",
19850
- /** Event is repeating and has a list of scheduled repetitions. */
19840
+ /** A series of events that repeat. */
19851
19841
  RECURRING = "RECURRING",
19852
- /** An upcoming event from the list of repetitions. */
19842
+ /** Next event in a schedule of recurring events. */
19853
19843
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
19854
- /** Latest ended event from the list of repetitions. */
19844
+ /** Latest event that ended in a schedule of recurring events. */
19855
19845
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
19856
- /** Latest cancelled event from the list of repetitions. */
19846
+ /** Latest canceled event in a schedule of recurring events */
19857
19847
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
19858
19848
  }
19859
19849
  interface Recurrences$1 {
@@ -19918,17 +19908,17 @@ interface TimeDuration {
19918
19908
  minutes?: number;
19919
19909
  }
19920
19910
  declare enum Status$1 {
19921
- /** Default value. This value is unused */
19911
+ /** Unknown event status. */
19922
19912
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
19923
- /** Event is public and scheduled to start */
19913
+ /** Event is published and scheduled to start. */
19924
19914
  UPCOMING = "UPCOMING",
19925
- /** Event has started */
19915
+ /** Event has started. */
19926
19916
  STARTED = "STARTED",
19927
- /** Event has ended */
19917
+ /** Event has ended. */
19928
19918
  ENDED = "ENDED",
19929
- /** Event is canceled */
19919
+ /** Event is canceled. */
19930
19920
  CANCELED = "CANCELED",
19931
- /** Event is not public */
19921
+ /** Event is not public. */
19932
19922
  DRAFT = "DRAFT"
19933
19923
  }
19934
19924
  interface Registration$1 {
@@ -19985,41 +19975,37 @@ interface Registration$1 {
19985
19975
  registrationDisabled?: boolean;
19986
19976
  }
19987
19977
  declare enum RegistrationTypeType {
19988
- /** Default value. This value is unused */
19978
+ /** Unknown registration type. */
19989
19979
  UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
19990
- /** Registration via RSVP */
19980
+ /** Guests register by RSVPing to the event. */
19991
19981
  RSVP = "RSVP",
19992
- /** Registration via ticket purchase */
19982
+ /** Guests register by buying tickets. */
19993
19983
  TICKETING = "TICKETING",
19994
- /** External registration */
19984
+ /** Guests register externally using some other site or platform. */
19995
19985
  EXTERNAL = "EXTERNAL",
19996
- /** Registration not available */
19986
+ /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
19997
19987
  NONE = "NONE"
19998
19988
  }
19999
19989
  declare enum RegistrationStatusStatus {
20000
19990
  /** Registration status is not applicable */
20001
19991
  UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
20002
- /** Registration to event is closed */
19992
+ /** Registration is closed after tickets are sold out. */
20003
19993
  CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
20004
- /** Registration to event is closed manually */
19994
+ /** Registration is closed when the `registration.registrationDisabled` property is set to `true`. */
20005
19995
  CLOSED_MANUALLY = "CLOSED_MANUALLY",
20006
- /** Registration is open via RSVP */
19996
+ /** Guests can start RSVPing to the event. */
20007
19997
  OPEN_RSVP = "OPEN_RSVP",
20008
- /** Registration to event waitlist is open via RSVP */
19998
+ /** Guest list has reached the maximum, new guests are added to a waitlist. */
20009
19999
  OPEN_RSVP_WAITLIST_ONLY = "OPEN_RSVP_WAITLIST_ONLY",
20010
- /** Registration is open via ticket purchase */
20000
+ /** Guests can buy tickets to the event. */
20011
20001
  OPEN_TICKETS = "OPEN_TICKETS",
20012
- /** Registration is open via external URL */
20002
+ /** Guests register on a different page or web address. */
20013
20003
  OPEN_EXTERNAL = "OPEN_EXTERNAL",
20014
- /** Registration will be open via RSVP */
20004
+ /** Registration via RSVP is scheduled for the future. */
20015
20005
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
20016
20006
  }
20017
20007
  interface RsvpRegistration {
20018
- /**
20019
- * Available answers for registration to an event. Possible values:
20020
- * - `YES_ONLY`: Only a **Yes** answer is available to select when RSVP'ing to an event.
20021
- * - `YES_AND_NO`: Both **Yes** and **No** answers are available to select when RSVP'ing to an event.
20022
- */
20008
+ /** Available answers for registration to an event. */
20023
20009
  responseType?: ResponseType;
20024
20010
  /** How many guests can RSVP to an event. */
20025
20011
  limit?: number | null;
@@ -20031,11 +20017,11 @@ interface RsvpRegistration {
20031
20017
  endDate?: Date | null;
20032
20018
  }
20033
20019
  declare enum ResponseType {
20034
- /** Default value. This value is unused. */
20020
+ /** Unknown response type. */
20035
20021
  UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
20036
- /** Only a **Yes** answer is available for the registration. */
20022
+ /** Only a **Yes** answer is available to select when RSVP'ing to an event. */
20037
20023
  YES_ONLY = "YES_ONLY",
20038
- /** *Yes** and **No** answers are available for the registration. */
20024
+ /** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
20039
20025
  YES_AND_NO = "YES_AND_NO"
20040
20026
  }
20041
20027
  interface TicketsRegistration {
@@ -20096,12 +20082,13 @@ interface TaxSettings {
20096
20082
  /** Apply tax to donations. */
20097
20083
  appliedToDonations?: boolean | null;
20098
20084
  }
20085
+ /** Tax application settings. */
20099
20086
  declare enum TaxType$1 {
20100
- /** Default value. This value is unused. */
20087
+ /** Unknown tax type. */
20101
20088
  UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
20102
- /** Tax is included in the ticket price */
20089
+ /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a service fee of $0.25 is deducted from the price and you'll get $9.75. */
20103
20090
  INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
20104
- /** Tax is added to the final total at the checkout */
20091
+ /** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a service fee of $0.25 and pays $10.25 in total. */
20105
20092
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
20106
20093
  }
20107
20094
  interface ExternalRegistration {
@@ -20109,19 +20096,19 @@ interface ExternalRegistration {
20109
20096
  url?: string | null;
20110
20097
  }
20111
20098
  declare enum GuestTypeType {
20112
- /** Default value. This value is unused */
20099
+ /** Unknown guest type. */
20113
20100
  UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
20114
- /** Site visitor or member */
20101
+ /** All site visitors can RSVP to the event. */
20115
20102
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
20116
- /** Site member */
20103
+ /** Only people who have signed up as members of your site are able to RSVP to the event. */
20117
20104
  MEMBER = "MEMBER"
20118
20105
  }
20119
20106
  declare enum InitialRegistrationTypeType {
20120
- /** Default value. This value is unused */
20107
+ /** Unknown initial registration type. */
20121
20108
  UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
20122
- /** Registration via RSVP */
20109
+ /** Guests register by RSVPing to the event. */
20123
20110
  RSVP = "RSVP",
20124
- /** Registration via ticket purchase */
20111
+ /** Guests register by buying tickets. This property value never changes. */
20125
20112
  TICKETING = "TICKETING"
20126
20113
  }
20127
20114
  interface CalendarUrls {
@@ -20469,9 +20456,9 @@ interface OnlineConferencing$1 {
20469
20456
  declare enum ConferenceTypeType {
20470
20457
  /** Default value. This value is unused */
20471
20458
  UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
20472
- /** Guests can publish and subscribe to video and audio. */
20459
+ /** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */
20473
20460
  MEETING = "MEETING",
20474
- /** Guests can only subscribe to video and audio. */
20461
+ /** Guests can only watch the conference. */
20475
20462
  WEBINAR = "WEBINAR"
20476
20463
  }
20477
20464
  interface OnlineConferencingSession$1 {
@@ -20709,44 +20696,33 @@ interface CreateEventRequest {
20709
20696
  event: V3Event;
20710
20697
  /** Whether to create the event as a draft. */
20711
20698
  draft?: boolean;
20712
- /**
20713
- * Predefined sets of fields to return.
20714
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
20715
- * - `TEXTS`: Returns `detailedDescription`.
20716
- * - `REGISTRATION`: Returns `registration`.
20717
- * - `URLS`: Returns `eventPageUrl`.
20718
- * - `FORM`: Returns `form`.
20719
- * - `DASHBOARD`: Returns `summaries`.
20720
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
20721
- * - `SEO_SETTINGS`: Returns `seoSettings`.
20722
- * - `AGENDA`: Returns `agendaSettings`.
20723
- * - `CATEGORIES`: Returns `categories`.
20724
- */
20699
+ /** Predefined sets of fields to return. */
20725
20700
  fields?: RequestedFields[];
20726
20701
  }
20727
20702
  declare enum RequestedFields {
20703
+ /** Unknown requested field. */
20728
20704
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
20729
- /** Include `description`, `mainImage` and `calendarLinks` in the response. */
20705
+ /** Returns `shortDescription`, `mainImage` and `calendarUrls`. */
20730
20706
  DETAILS = "DETAILS",
20731
- /** Include `about` event rich text in the response. */
20707
+ /** Returns `detailedDescription`. */
20732
20708
  TEXTS = "TEXTS",
20733
- /** Include `registration` in the response. */
20709
+ /** Returns `registration`. */
20734
20710
  REGISTRATION = "REGISTRATION",
20735
- /** Include `eventPageUrl` in the response. */
20711
+ /** Returns `eventPageUrl`. */
20736
20712
  URLS = "URLS",
20737
- /** Include `form` in the response. */
20713
+ /** Returns `form`. */
20738
20714
  FORM = "FORM",
20739
- /** Include `dashboard` in the response. */
20715
+ /** Returns `summaries`. */
20740
20716
  DASHBOARD = "DASHBOARD",
20741
- /** Include `feed` in the response. */
20717
+ /** Returns `feed`. */
20742
20718
  FEED = "FEED",
20743
- /** Include `onlineConferencing` in the response. */
20719
+ /** Returns `onlineConferencing.session`. */
20744
20720
  ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
20745
- /** Include `seoSettings` in the response. */
20721
+ /** Returns `seoSettings`. */
20746
20722
  SEO_SETTINGS = "SEO_SETTINGS",
20747
- /** Include `agendaSettings` in the response. */
20723
+ /** Returns `agendaSettings`. */
20748
20724
  AGENDA = "AGENDA",
20749
- /** Include `categories` in the response. */
20725
+ /** Returns `categories`. */
20750
20726
  CATEGORIES = "CATEGORIES",
20751
20727
  CUSTOMIZABLE_TICKETS = "CUSTOMIZABLE_TICKETS"
20752
20728
  }
@@ -20761,19 +20737,7 @@ interface CloneEventRequest {
20761
20737
  event?: V3Event;
20762
20738
  /** Whether to clone the event as a draft. */
20763
20739
  draft?: boolean;
20764
- /**
20765
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
20766
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
20767
- * - `TEXTS`: Returns `detailedDescription`.
20768
- * - `REGISTRATION`: Returns `registration`.
20769
- * - `URLS`: Returns `eventPageUrl`.
20770
- * - `FORM`: Returns `form`.
20771
- * - `DASHBOARD`: Returns `summaries`.
20772
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
20773
- * - `SEO_SETTINGS`: Returns `seoSettings`.
20774
- * - `AGENDA`: Returns `agendaSettings`.
20775
- * - `CATEGORIES`: Returns `categories`.
20776
- */
20740
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
20777
20741
  fields?: RequestedFields[];
20778
20742
  }
20779
20743
  interface CloneEventResponse {
@@ -20783,19 +20747,7 @@ interface CloneEventResponse {
20783
20747
  interface UpdateEventRequest {
20784
20748
  /** Field values to be changed. */
20785
20749
  event?: V3Event;
20786
- /**
20787
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
20788
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
20789
- * - `TEXTS`: Returns `detailedDescription`.
20790
- * - `REGISTRATION`: Returns `registration`.
20791
- * - `URLS`: Returns `eventPageUrl`.
20792
- * - `FORM`: Returns `form`.
20793
- * - `DASHBOARD`: Returns `summaries`.
20794
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
20795
- * - `SEO_SETTINGS`: Returns `seoSettings`.
20796
- * - `AGENDA`: Returns `agendaSettings`.
20797
- * - `CATEGORIES`: Returns `categories`.
20798
- */
20750
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
20799
20751
  fields?: RequestedFields[];
20800
20752
  }
20801
20753
  interface UpdateEventResponse {
@@ -20805,19 +20757,7 @@ interface UpdateEventResponse {
20805
20757
  interface PublishDraftEventRequest {
20806
20758
  /** Event ID. */
20807
20759
  eventId: string;
20808
- /**
20809
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
20810
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
20811
- * - `TEXTS`: Returns `detailedDescription`.
20812
- * - `REGISTRATION`: Returns `registration`.
20813
- * - `URLS`: Returns `eventPageUrl`.
20814
- * - `FORM`: Returns `form`.
20815
- * - `DASHBOARD`: Returns `summaries`.
20816
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
20817
- * - `SEO_SETTINGS`: Returns `seoSettings`.
20818
- * - `AGENDA`: Returns `agendaSettings`.
20819
- * - `CATEGORIES`: Returns `categories`.
20820
- */
20760
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
20821
20761
  fields?: RequestedFields[];
20822
20762
  }
20823
20763
  interface PublishDraftEventResponse {
@@ -20827,19 +20767,7 @@ interface PublishDraftEventResponse {
20827
20767
  interface CancelEventRequest {
20828
20768
  /** Event ID. */
20829
20769
  eventId: string;
20830
- /**
20831
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
20832
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
20833
- * - `TEXTS`: Returns `detailedDescription`.
20834
- * - `REGISTRATION`: Returns `registration`.
20835
- * - `URLS`: Returns `eventPageUrl`.
20836
- * - `FORM`: Returns `form`.
20837
- * - `DASHBOARD`: Returns `summaries`.
20838
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
20839
- * - `SEO_SETTINGS`: Returns `seoSettings`.
20840
- * - `AGENDA`: Returns `agendaSettings`.
20841
- * - `CATEGORIES`: Returns `categories`.
20842
- */
20770
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
20843
20771
  fields?: RequestedFields[];
20844
20772
  }
20845
20773
  interface CancelEventResponse {
@@ -20912,19 +20840,7 @@ interface BulkDeleteEventsByFilterResponse {
20912
20840
  interface QueryEventsRequest {
20913
20841
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
20914
20842
  query?: CommonQueryV2;
20915
- /**
20916
- * Predefined sets of fields to return.
20917
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
20918
- * - `TEXTS`: Returns `detailedDescription`.
20919
- * - `REGISTRATION`: Returns `registration`.
20920
- * - `URLS`: Returns `eventPageUrl`.
20921
- * - `FORM`: Returns `form`.
20922
- * - `DASHBOARD`: Returns `summaries`.
20923
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
20924
- * - `SEO_SETTINGS`: Returns `seoSettings`.
20925
- * - `AGENDA`: Returns `agendaSettings`.
20926
- * - `CATEGORIES`: Returns `categories`.
20927
- */
20843
+ /** Predefined sets of fields to return. */
20928
20844
  fields?: RequestedFields[];
20929
20845
  /**
20930
20846
  * Whether draft events should be returned in the response. <br>
@@ -21071,10 +20987,7 @@ interface ListUserEventsRequest {
21071
20987
  sort?: CommonSorting[];
21072
20988
  /** Event status. */
21073
20989
  status?: Status$1[];
21074
- /**
21075
- * Wix user filter, by default any.
21076
- * Allows to filter events by user relation to the event among all wix sites.
21077
- */
20990
+ /** Allows to filter events by user relation to the event among all wix sites. */
21078
20991
  userFilter?: UserFilter;
21079
20992
  /**
21080
20993
  * Filter facets to include in the response.
@@ -21085,14 +20998,11 @@ interface ListUserEventsRequest {
21085
20998
  interface UserFilter {
21086
20999
  /** User who is related to event */
21087
21000
  userId?: string;
21088
- /** Relation of user to event */
21001
+ /** Relation of user to event. */
21089
21002
  relation?: Relation[];
21090
21003
  }
21091
21004
  declare enum Relation {
21092
- /**
21093
- * User is attending the event.
21094
- * User has RSVP with status YES or has ordered tickets.
21095
- */
21005
+ /** User is attending the event. The user RSVP'd with status of `YES` or has ordered tickets. */
21096
21006
  ATTENDING = "ATTENDING"
21097
21007
  }
21098
21008
  interface ListUserEventsResponse {
@@ -21108,19 +21018,7 @@ interface ListEventsByCategoryRequest {
21108
21018
  categoryId?: string;
21109
21019
  /** Paging options to limit and skip the number of items. */
21110
21020
  paging?: CommonPaging;
21111
- /**
21112
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
21113
- * - `DETAILS`: Returns `shortDescription`, `mainImage`, and `calendarUrls`.
21114
- * - `TEXTS`: Returns `detailedDescription`.
21115
- * - `REGISTRATION`: Returns `registration`.
21116
- * - `URLS`: Returns `eventPageUrl`.
21117
- * - `FORM`: Returns `form`.
21118
- * - `DASHBOARD`: Returns `summaries`.
21119
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
21120
- * - `SEO_SETTINGS`: Returns `seoSettings`.
21121
- * - `AGENDA`: Returns `agendaSettings`.
21122
- * - `CATEGORIES`: Returns `categories`.
21123
- */
21021
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
21124
21022
  fields?: RequestedFields[];
21125
21023
  }
21126
21024
  interface ListEventsByCategoryResponse {
@@ -21132,19 +21030,6 @@ interface ListEventsByCategoryResponse {
21132
21030
  interface GetEventRequest {
21133
21031
  /** Event ID. */
21134
21032
  eventId: string | null;
21135
- /**
21136
- * Predefined sets of fields to return.
21137
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
21138
- * - `TEXTS`: Returns `detailedDescription`.
21139
- * - `REGISTRATION`: Returns `registration`.
21140
- * - `URLS`: Returns `eventPageUrl`.
21141
- * - `FORM`: Returns `form`.
21142
- * - `DASHBOARD`: Returns `summaries`.
21143
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
21144
- * - `SEO_SETTINGS`: Returns `seoSettings`.
21145
- * - `AGENDA`: Returns `agendaSettings`.
21146
- * - `CATEGORIES`: Returns `categories`.
21147
- */
21148
21033
  fields?: RequestedFields[];
21149
21034
  }
21150
21035
  interface GetEventResponse {
@@ -21154,19 +21039,6 @@ interface GetEventResponse {
21154
21039
  interface GetEventBySlugRequest {
21155
21040
  /** URL slug. */
21156
21041
  slug: string | null;
21157
- /**
21158
- * Predefined sets of fields to return.
21159
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
21160
- * - `TEXTS`: Returns `detailedDescription`.
21161
- * - `REGISTRATION`: Returns `registration`.
21162
- * - `URLS`: Returns `eventPageUrl`.
21163
- * - `FORM`: Returns `form`.
21164
- * - `DASHBOARD`: Returns `summaries`.
21165
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
21166
- * - `SEO_SETTINGS`: Returns `seoSettings`.
21167
- * - `AGENDA`: Returns `agendaSettings`.
21168
- * - `CATEGORIES`: Returns `categories`.
21169
- */
21170
21042
  fields?: RequestedFields[];
21171
21043
  }
21172
21044
  interface GetEventBySlugResponse {
@@ -21178,19 +21050,7 @@ interface FindEventRequest extends FindEventRequestFindByOneOf {
21178
21050
  eventId?: string | null;
21179
21051
  /** URL slug. */
21180
21052
  slug?: string | null;
21181
- /**
21182
- * Predefined sets of fields to return.
21183
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
21184
- * - `TEXTS`: Returns `detailedDescription`.
21185
- * - `REGISTRATION`: Returns `registration`.
21186
- * - `URLS`: Returns `eventPageUrl`.
21187
- * - `FORM`: Returns `form`.
21188
- * - `DASHBOARD`: Returns `summaries`.
21189
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
21190
- * - `SEO_SETTINGS`: Returns `seoSettings`.
21191
- * - `AGENDA`: Returns `agendaSettings`.
21192
- * - `CATEGORIES`: Returns `categories`.
21193
- */
21053
+ /** Predefined sets of fields to return. */
21194
21054
  fields?: RequestedFields[];
21195
21055
  }
21196
21056
  /** @oneof */
@@ -22370,19 +22230,7 @@ interface EventCanceledEnvelope {
22370
22230
  interface CreateEventOptions {
22371
22231
  /** Whether to create the event as a draft. */
22372
22232
  draft?: boolean;
22373
- /**
22374
- * Predefined sets of fields to return.
22375
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22376
- * - `TEXTS`: Returns `detailedDescription`.
22377
- * - `REGISTRATION`: Returns `registration`.
22378
- * - `URLS`: Returns `eventPageUrl`.
22379
- * - `FORM`: Returns `form`.
22380
- * - `DASHBOARD`: Returns `summaries`.
22381
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22382
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22383
- * - `AGENDA`: Returns `agendaSettings`.
22384
- * - `CATEGORIES`: Returns `categories`.
22385
- */
22233
+ /** Predefined sets of fields to return. */
22386
22234
  fields?: RequestedFields[];
22387
22235
  }
22388
22236
  interface CloneEventOptions {
@@ -22390,19 +22238,7 @@ interface CloneEventOptions {
22390
22238
  event?: V3Event;
22391
22239
  /** Whether to clone the event as a draft. */
22392
22240
  draft?: boolean;
22393
- /**
22394
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
22395
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22396
- * - `TEXTS`: Returns `detailedDescription`.
22397
- * - `REGISTRATION`: Returns `registration`.
22398
- * - `URLS`: Returns `eventPageUrl`.
22399
- * - `FORM`: Returns `form`.
22400
- * - `DASHBOARD`: Returns `summaries`.
22401
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22402
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22403
- * - `AGENDA`: Returns `agendaSettings`.
22404
- * - `CATEGORIES`: Returns `categories`.
22405
- */
22241
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
22406
22242
  fields?: RequestedFields[];
22407
22243
  }
22408
22244
  interface UpdateEventOptions {
@@ -22515,51 +22351,15 @@ interface UpdateEventOptions {
22515
22351
  /** Visual settings for event. */
22516
22352
  eventDisplaySettings?: V3EventDisplaySettings;
22517
22353
  };
22518
- /**
22519
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
22520
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22521
- * - `TEXTS`: Returns `detailedDescription`.
22522
- * - `REGISTRATION`: Returns `registration`.
22523
- * - `URLS`: Returns `eventPageUrl`.
22524
- * - `FORM`: Returns `form`.
22525
- * - `DASHBOARD`: Returns `summaries`.
22526
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22527
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22528
- * - `AGENDA`: Returns `agendaSettings`.
22529
- * - `CATEGORIES`: Returns `categories`.
22530
- */
22354
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
22531
22355
  fields?: RequestedFields[];
22532
22356
  }
22533
22357
  interface PublishDraftEventOptions {
22534
- /**
22535
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
22536
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22537
- * - `TEXTS`: Returns `detailedDescription`.
22538
- * - `REGISTRATION`: Returns `registration`.
22539
- * - `URLS`: Returns `eventPageUrl`.
22540
- * - `FORM`: Returns `form`.
22541
- * - `DASHBOARD`: Returns `summaries`.
22542
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22543
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22544
- * - `AGENDA`: Returns `agendaSettings`.
22545
- * - `CATEGORIES`: Returns `categories`.
22546
- */
22358
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
22547
22359
  fields?: RequestedFields[];
22548
22360
  }
22549
22361
  interface CancelEventOptions {
22550
- /**
22551
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
22552
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22553
- * - `TEXTS`: Returns `detailedDescription`.
22554
- * - `REGISTRATION`: Returns `registration`.
22555
- * - `URLS`: Returns `eventPageUrl`.
22556
- * - `FORM`: Returns `form`.
22557
- * - `DASHBOARD`: Returns `summaries`.
22558
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22559
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22560
- * - `AGENDA`: Returns `agendaSettings`.
22561
- * - `CATEGORIES`: Returns `categories`.
22562
- */
22362
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
22563
22363
  fields?: RequestedFields[];
22564
22364
  }
22565
22365
  interface BulkCancelEventsByFilterOptions {
@@ -22571,19 +22371,7 @@ interface BulkDeleteEventsByFilterOptions {
22571
22371
  filter?: CommonQueryV2;
22572
22372
  }
22573
22373
  interface QueryEventsOptions {
22574
- /**
22575
- * Predefined sets of fields to return.
22576
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22577
- * - `TEXTS`: Returns `detailedDescription`.
22578
- * - `REGISTRATION`: Returns `registration`.
22579
- * - `URLS`: Returns `eventPageUrl`.
22580
- * - `FORM`: Returns `form`.
22581
- * - `DASHBOARD`: Returns `summaries`.
22582
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22583
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22584
- * - `AGENDA`: Returns `agendaSettings`.
22585
- * - `CATEGORIES`: Returns `categories`.
22586
- */
22374
+ /** Predefined sets of fields to return. */
22587
22375
  fields?: RequestedFields[] | undefined;
22588
22376
  /**
22589
22377
  * Whether draft events should be returned in the response. <br>
@@ -22654,35 +22442,9 @@ interface CountEventsByStatusOptions {
22654
22442
  includeDrafts?: boolean;
22655
22443
  }
22656
22444
  interface GetEventOptions {
22657
- /**
22658
- * Predefined sets of fields to return.
22659
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22660
- * - `TEXTS`: Returns `detailedDescription`.
22661
- * - `REGISTRATION`: Returns `registration`.
22662
- * - `URLS`: Returns `eventPageUrl`.
22663
- * - `FORM`: Returns `form`.
22664
- * - `DASHBOARD`: Returns `summaries`.
22665
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22666
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22667
- * - `AGENDA`: Returns `agendaSettings`.
22668
- * - `CATEGORIES`: Returns `categories`.
22669
- */
22670
22445
  fields?: RequestedFields[];
22671
22446
  }
22672
22447
  interface GetEventBySlugOptions {
22673
- /**
22674
- * Predefined sets of fields to return.
22675
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
22676
- * - `TEXTS`: Returns `detailedDescription`.
22677
- * - `REGISTRATION`: Returns `registration`.
22678
- * - `URLS`: Returns `eventPageUrl`.
22679
- * - `FORM`: Returns `form`.
22680
- * - `DASHBOARD`: Returns `summaries`.
22681
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
22682
- * - `SEO_SETTINGS`: Returns `seoSettings`.
22683
- * - `AGENDA`: Returns `agendaSettings`.
22684
- * - `CATEGORIES`: Returns `categories`.
22685
- */
22686
22448
  fields?: RequestedFields[];
22687
22449
  }
22688
22450
 
@@ -23118,19 +22880,12 @@ interface TicketDefinition {
23118
22880
  actualLimit?: number | null;
23119
22881
  /** Ticket pricing method. */
23120
22882
  pricingMethod?: PricingMethod;
23121
- /**
23122
- * Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:
23123
- * - `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.
23124
- * - `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total.
23125
- */
22883
+ /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
23126
22884
  feeType?: Type;
23127
22885
  /** Ticket sale period. */
23128
22886
  salePeriod?: SalePeriod;
23129
22887
  /**
23130
- * Ticket sale status. Possible values:
23131
- * - `SALE_SCHEDULED`: Tickets are not on sale yet.
23132
- * - `SALE_STARTED`: Tickets are on sale.
23133
- * - `SALE_ENDED`: Tickets are not on sale.
22888
+ * Ticket sale status.
23134
22889
  * @readonly
23135
22890
  */
23136
22891
  saleStatus?: SaleStatusEnumStatus;
@@ -23169,9 +22924,7 @@ interface PricingMethod extends PricingMethodPriceOneOf {
23169
22924
  /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
23170
22925
  pricingOptions?: PricingOptions;
23171
22926
  /**
23172
- * Ticket price type. Possible values:
23173
- * - `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`.
23174
- * - `DONATION`: All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method.
22927
+ * Ticket price type.
23175
22928
  * @readonly
23176
22929
  */
23177
22930
  pricingType?: PricingTypeEnumType;
@@ -23213,26 +22966,31 @@ interface OptionDetails {
23213
22966
  price?: CommonMoney;
23214
22967
  }
23215
22968
  declare enum PricingTypeEnumType {
22969
+ /** Undefined pricing type. */
23216
22970
  UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
22971
+ /** All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. */
23217
22972
  STANDARD = "STANDARD",
22973
+ /** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */
23218
22974
  DONATION = "DONATION"
23219
22975
  }
23220
22976
  declare enum Type {
22977
+ /** Unknown fee type. */
23221
22978
  UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
23222
- /** Seller absorbs the fee. It is deducted from the ticket price. */
22979
+ /** The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75. */
23223
22980
  FEE_INCLUDED = "FEE_INCLUDED",
23224
- /** Fee is added to the ticket price at checkout. */
22981
+ /** The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total. */
23225
22982
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
23226
- /** Service fee is not collected - available only for free tickets and legacy users. */
22983
+ /** Service fee is not collected. Available only for free tickets and legacy users. */
23227
22984
  NO_FEE = "NO_FEE"
23228
22985
  }
23229
22986
  declare enum SaleStatusEnumStatus {
22987
+ /** Undefined sale status. */
23230
22988
  UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
23231
- /** Ticket sale is scheduled to start */
22989
+ /** Tickets are not on sale yet. */
23232
22990
  SALE_SCHEDULED = "SALE_SCHEDULED",
23233
- /** Ticket sale has started */
22991
+ /** Tickets are on sale. */
23234
22992
  SALE_STARTED = "SALE_STARTED",
23235
- /** Ticket sale has ended */
22993
+ /** Tickets are not on sale. */
23236
22994
  SALE_ENDED = "SALE_ENDED"
23237
22995
  }
23238
22996
  interface SalesDetails {
@@ -23303,11 +23061,7 @@ interface EventDetails {
23303
23061
  interface Location {
23304
23062
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
23305
23063
  name?: string | null;
23306
- /**
23307
- * Location type. Possible values:
23308
- * - `VENUE`: Event is on-site at a specific physical location.
23309
- * - `ONLINE`: Event is online, such as a virtual video conference.
23310
- */
23064
+ /** Location type. */
23311
23065
  type?: LocationType;
23312
23066
  /** Exact location address. */
23313
23067
  address?: CommonAddress;
@@ -23315,9 +23069,11 @@ interface Location {
23315
23069
  locationTbd?: boolean | null;
23316
23070
  }
23317
23071
  declare enum LocationType {
23318
- /** Default value. This value is unused. */
23072
+ /** Unknown location type. */
23319
23073
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
23074
+ /** Event is on-site at a specific physical location. */
23320
23075
  VENUE = "VENUE",
23076
+ /** Event is online, such as a virtual video conference. */
23321
23077
  ONLINE = "ONLINE"
23322
23078
  }
23323
23079
  /** Physical address */
@@ -23393,12 +23149,7 @@ interface DateAndTimeSettings {
23393
23149
  /** Whether the time zone is displayed in the formatted schedule. */
23394
23150
  showTimeZone?: boolean | null;
23395
23151
  /**
23396
- * Repeating event status. Possible values:
23397
- * - `ONE_TIME`: Event happens only once and can last multiple days.
23398
- * - `RECURRING`: A series of events that repeat.
23399
- * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
23400
- * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
23401
- * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
23152
+ * Repeating event status.
23402
23153
  * @readonly
23403
23154
  */
23404
23155
  recurrenceStatus?: RecurrenceStatusStatus;
@@ -23408,17 +23159,17 @@ interface DateAndTimeSettings {
23408
23159
  formatted?: Formatted;
23409
23160
  }
23410
23161
  declare enum RecurrenceStatusStatus {
23411
- /** Default value. This value is unused. */
23162
+ /** Unknown recurrance status. */
23412
23163
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
23413
- /** Event happens only once. */
23164
+ /** Event happens only once and can last multiple days. */
23414
23165
  ONE_TIME = "ONE_TIME",
23415
- /** Event is repeating and has a list of scheduled repetitions. */
23166
+ /** A series of events that repeat. */
23416
23167
  RECURRING = "RECURRING",
23417
- /** An upcoming event from the list of repetitions. */
23168
+ /** Next event in a schedule of recurring events. */
23418
23169
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
23419
- /** Latest ended event from the list of repetitions. */
23170
+ /** Latest event that ended in a schedule of recurring events. */
23420
23171
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
23421
- /** Latest cancelled event from the list of repetitions. */
23172
+ /** Latest canceled event in a schedule of recurring events */
23422
23173
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
23423
23174
  }
23424
23175
  interface Recurrences {
@@ -23470,17 +23221,17 @@ interface Formatted {
23470
23221
  endTime?: string | null;
23471
23222
  }
23472
23223
  declare enum Status {
23473
- /** Default value. This value is unused */
23224
+ /** Unknown event status. */
23474
23225
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
23475
- /** Event is public and scheduled to start */
23226
+ /** Event is published and scheduled to start. */
23476
23227
  UPCOMING = "UPCOMING",
23477
- /** Event has started */
23228
+ /** Event has started. */
23478
23229
  STARTED = "STARTED",
23479
- /** Event has ended */
23230
+ /** Event has ended. */
23480
23231
  ENDED = "ENDED",
23481
- /** Event is canceled */
23232
+ /** Event is canceled. */
23482
23233
  CANCELED = "CANCELED",
23483
- /** Event is not public */
23234
+ /** Event is not public. */
23484
23235
  DRAFT = "DRAFT"
23485
23236
  }
23486
23237
  interface SalePeriodUpdated {
@@ -23777,18 +23528,15 @@ interface ReservationCreated {
23777
23528
  counts?: ReservationCount[];
23778
23529
  }
23779
23530
  declare enum ReservationStatus {
23780
- /**
23781
- * Reservation is pending confirmation.
23782
- * The reservation will expire after the expiration due time.
23783
- */
23531
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
23784
23532
  RESERVATION_PENDING = "RESERVATION_PENDING",
23785
- /** The reservation was confirmed and will not expire. */
23533
+ /** The reservation is confirmed and will not expire. */
23786
23534
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
23787
- /** The reservation was canceled because of non payment. */
23535
+ /** The reservation is canceled because of non payment. */
23788
23536
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
23789
- /** The reservation was canceled manually by the buyer. */
23537
+ /** The reservation is canceled manually by the buyer. */
23790
23538
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
23791
- /** The reservation has expired. */
23539
+ /** The reservation is expired. */
23792
23540
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
23793
23541
  }
23794
23542
  interface TicketQuantity {
@@ -23845,17 +23593,15 @@ interface EventDeleted {
23845
23593
  interface CreateTicketDefinitionRequest {
23846
23594
  /** Ticket definition info. */
23847
23595
  ticketDefinition: TicketDefinition;
23848
- /**
23849
- * Predefined sets of fields to return.
23850
- * - `SALES_DETAILS`: Returns `salesDetails`.
23851
- */
23596
+ /** Predefined sets of fields to return. */
23852
23597
  fields?: Field[];
23853
23598
  }
23854
23599
  declare enum Field {
23600
+ /** Unknown requested field. */
23855
23601
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
23856
- /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
23602
+ /** Returns `salesDetails` in the response. */
23857
23603
  SALES_DETAILS = "SALES_DETAILS",
23858
- /** Include `eventDetails`. */
23604
+ /** Returns `eventDetails` in the response. */
23859
23605
  EVENT_DETAILS = "EVENT_DETAILS"
23860
23606
  }
23861
23607
  interface CreateTicketDefinitionResponse {
@@ -23865,10 +23611,7 @@ interface CreateTicketDefinitionResponse {
23865
23611
  interface UpdateTicketDefinitionRequest {
23866
23612
  /** Ticket definition to update. */
23867
23613
  ticketDefinition: TicketDefinition;
23868
- /**
23869
- * Predefined sets of fields to return.
23870
- * - `SALES_DETAILS`: Returns `salesDetails`.
23871
- */
23614
+ /** Predefined sets of fields to return. */
23872
23615
  fields?: Field[];
23873
23616
  }
23874
23617
  interface UpdateTicketDefinitionResponse {
@@ -23878,10 +23621,7 @@ interface UpdateTicketDefinitionResponse {
23878
23621
  interface GetTicketDefinitionRequest {
23879
23622
  /** Ticket definition ID. */
23880
23623
  ticketDefinitionId: string;
23881
- /**
23882
- * Predefined sets of fields to return.
23883
- * - `SALES_DETAILS`: Returns `salesDetails`.
23884
- */
23624
+ /** Predefined sets of fields to return. */
23885
23625
  fields?: Field[];
23886
23626
  }
23887
23627
  interface GetTicketDefinitionResponse {
@@ -23930,10 +23670,7 @@ interface UpdateTicketDefinitionSortIndexResponse {
23930
23670
  interface QueryTicketDefinitionsRequest {
23931
23671
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
23932
23672
  query: QueryV2;
23933
- /**
23934
- * Predefined sets of fields to return.
23935
- * - `SALES_DETAILS`: Returns `salesDetails`.
23936
- */
23673
+ /** Predefined sets of fields to return. */
23937
23674
  fields?: Field[];
23938
23675
  }
23939
23676
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -24007,10 +23744,7 @@ interface Cursors {
24007
23744
  interface QueryAvailableTicketDefinitionsRequest {
24008
23745
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
24009
23746
  query: QueryV2;
24010
- /**
24011
- * Predefined sets of fields to return.
24012
- * - `SALES_DETAILS`: Returns `salesDetails`.
24013
- */
23747
+ /** Predefined sets of fields to return. */
24014
23748
  fields?: Field[];
24015
23749
  }
24016
23750
  interface QueryAvailableTicketDefinitionsResponse {
@@ -25492,10 +25226,7 @@ interface TicketDefinitionSaleEndedEnvelope {
25492
25226
  metadata: EventMetadata;
25493
25227
  }
25494
25228
  interface CreateTicketDefinitionOptions {
25495
- /**
25496
- * Predefined sets of fields to return.
25497
- * - `SALES_DETAILS`: Returns `salesDetails`.
25498
- */
25229
+ /** Predefined sets of fields to return. */
25499
25230
  fields?: Field[];
25500
25231
  }
25501
25232
  interface UpdateTicketDefinition {
@@ -25543,19 +25274,12 @@ interface UpdateTicketDefinition {
25543
25274
  actualLimit?: number | null;
25544
25275
  /** Ticket pricing method. */
25545
25276
  pricingMethod?: PricingMethod;
25546
- /**
25547
- * Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:
25548
- * - `FEE_INCLUDED`: The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a service fee of $0.25 will be deducted from the price and you'll get $9.75.
25549
- * - `FEE_ADDED_AT_CHECKOUT`: The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a service fee of $0.25 and will pay $10.25 in total.
25550
- */
25277
+ /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
25551
25278
  feeType?: Type;
25552
25279
  /** Ticket sale period. */
25553
25280
  salePeriod?: SalePeriod;
25554
25281
  /**
25555
- * Ticket sale status. Possible values:
25556
- * - `SALE_SCHEDULED`: Tickets are not on sale yet.
25557
- * - `SALE_STARTED`: Tickets are on sale.
25558
- * - `SALE_ENDED`: Tickets are not on sale.
25282
+ * Ticket sale status.
25559
25283
  * @readonly
25560
25284
  */
25561
25285
  saleStatus?: SaleStatusEnumStatus;
@@ -25579,17 +25303,11 @@ interface UpdateTicketDefinition {
25579
25303
  eventDetails?: EventDetails;
25580
25304
  }
25581
25305
  interface UpdateTicketDefinitionOptions {
25582
- /**
25583
- * Predefined sets of fields to return.
25584
- * - `SALES_DETAILS`: Returns `salesDetails`.
25585
- */
25306
+ /** Predefined sets of fields to return. */
25586
25307
  fields?: Field[];
25587
25308
  }
25588
25309
  interface GetTicketDefinitionOptions {
25589
- /**
25590
- * Predefined sets of fields to return.
25591
- * - `SALES_DETAILS`: Returns `salesDetails`.
25592
- */
25310
+ /** Predefined sets of fields to return. */
25593
25311
  fields?: Field[];
25594
25312
  }
25595
25313
  interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
@@ -25601,10 +25319,7 @@ interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsReques
25601
25319
  afterDefinitionId?: string;
25602
25320
  }
25603
25321
  interface QueryTicketDefinitionsOptions {
25604
- /**
25605
- * Predefined sets of fields to return.
25606
- * - `SALES_DETAILS`: Returns `salesDetails`.
25607
- */
25322
+ /** Predefined sets of fields to return. */
25608
25323
  fields?: Field[] | undefined;
25609
25324
  }
25610
25325
  interface QueryCursorResult {
@@ -25658,10 +25373,7 @@ interface TicketDefinitionsQueryBuilder {
25658
25373
  find: () => Promise<TicketDefinitionsQueryResult>;
25659
25374
  }
25660
25375
  interface QueryAvailableTicketDefinitionsOptions {
25661
- /**
25662
- * Predefined sets of fields to return.
25663
- * - `SALES_DETAILS`: Returns `salesDetails`.
25664
- */
25376
+ /** Predefined sets of fields to return. */
25665
25377
  fields?: Field[];
25666
25378
  }
25667
25379
  interface CountTicketDefinitionsOptions {