@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.
@@ -15,7 +15,7 @@ interface EventGuest$1 {
15
15
  contactId?: string | null;
16
16
  /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
17
17
  guestDetails?: GuestDetails$5;
18
- /** 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. */
18
+ /** 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. */
19
19
  attendanceStatus?: AttendanceStatus$1;
20
20
  /** 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. */
21
21
  secondaryLanguageCode?: string | null;
@@ -27,7 +27,7 @@ interface EventGuest$1 {
27
27
  attendanceStatusUpdatedDate?: Date | null;
28
28
  /** Site member ID. */
29
29
  memberId?: string | null;
30
- /** 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. */
30
+ /** Guest type. */
31
31
  guestType?: GuestType$1;
32
32
  /** 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. */
33
33
  locale?: string | null;
@@ -112,21 +112,17 @@ declare enum AttendanceStatus$1 {
112
112
  IN_WAITLIST = "IN_WAITLIST"
113
113
  }
114
114
  declare enum GuestType$1 {
115
- /** Rsvp guest. */
115
+ /** An invited guest, no ticket necessary. */
116
116
  RSVP = "RSVP",
117
- /** Buyer guest. */
117
+ /** The guest who bought the ticket. */
118
118
  BUYER = "BUYER",
119
- /** Ticket holder guest. */
119
+ /** The guest for whom the ticket was bought. */
120
120
  TICKET_HOLDER = "TICKET_HOLDER"
121
121
  }
122
122
  interface QueryEventGuestsRequest$1 {
123
123
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
124
124
  query: QueryV2$d;
125
- /**
126
- * Predefined sets of fields to return.
127
- * - `GUEST_DETAILS`: Returns `guestDetails` and `tickets`.
128
- * - `GUEST_TOTAL`: Returns `totalGuests`.
129
- */
125
+ /** Predefined sets of fields to return. */
130
126
  fields?: RequestedFieldsEnumRequestedFields$1[];
131
127
  }
132
128
  interface QueryV2$d extends QueryV2PagingMethodOneOf$d {
@@ -181,10 +177,11 @@ interface CursorPaging$d {
181
177
  cursor?: string | null;
182
178
  }
183
179
  declare enum RequestedFieldsEnumRequestedFields$1 {
180
+ /** Unknown requested field. */
184
181
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
185
- /** Select fields: `guestDetails` and `tickets`. */
182
+ /** Returns `guestDetails` and `tickets`. */
186
183
  GUEST_DETAILS = "GUEST_DETAILS",
187
- /** Returns queried guests total */
184
+ /** Returns `totalGuests`. */
188
185
  GUEST_TOTAL = "GUEST_TOTAL"
189
186
  }
190
187
  interface QueryEventGuestsResponse$1 {
@@ -280,7 +277,7 @@ interface EventGuest {
280
277
  contactId?: string | null;
281
278
  /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
282
279
  guestDetails?: GuestDetails$4;
283
- /** 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. */
280
+ /** 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. */
284
281
  attendanceStatus?: AttendanceStatus;
285
282
  /** 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. */
286
283
  secondaryLanguageCode?: string | null;
@@ -292,7 +289,7 @@ interface EventGuest {
292
289
  attendanceStatusUpdatedDate?: Date | null;
293
290
  /** Site member ID. */
294
291
  memberId?: string | null;
295
- /** 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. */
292
+ /** Guest type. */
296
293
  guestType?: GuestType;
297
294
  /** 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. */
298
295
  locale?: string | null;
@@ -362,21 +359,17 @@ declare enum AttendanceStatus {
362
359
  IN_WAITLIST = "IN_WAITLIST"
363
360
  }
364
361
  declare enum GuestType {
365
- /** Rsvp guest. */
362
+ /** An invited guest, no ticket necessary. */
366
363
  RSVP = "RSVP",
367
- /** Buyer guest. */
364
+ /** The guest who bought the ticket. */
368
365
  BUYER = "BUYER",
369
- /** Ticket holder guest. */
366
+ /** The guest for whom the ticket was bought. */
370
367
  TICKET_HOLDER = "TICKET_HOLDER"
371
368
  }
372
369
  interface QueryEventGuestsRequest {
373
370
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
374
371
  query: QueryV2$c;
375
- /**
376
- * Predefined sets of fields to return.
377
- * - `GUEST_DETAILS`: Returns `guestDetails` and `tickets`.
378
- * - `GUEST_TOTAL`: Returns `totalGuests`.
379
- */
372
+ /** Predefined sets of fields to return. */
380
373
  fields?: RequestedFieldsEnumRequestedFields[];
381
374
  }
382
375
  interface QueryV2$c extends QueryV2PagingMethodOneOf$c {
@@ -431,10 +424,11 @@ interface CursorPaging$c {
431
424
  cursor?: string | null;
432
425
  }
433
426
  declare enum RequestedFieldsEnumRequestedFields {
427
+ /** Unknown requested field. */
434
428
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
435
- /** Select fields: `guestDetails` and `tickets`. */
429
+ /** Returns `guestDetails` and `tickets`. */
436
430
  GUEST_DETAILS = "GUEST_DETAILS",
437
- /** Returns queried guests total */
431
+ /** Returns `totalGuests`. */
438
432
  GUEST_TOTAL = "GUEST_TOTAL"
439
433
  }
440
434
  interface QueryEventGuestsResponse {
@@ -1039,9 +1033,9 @@ interface TimeInterval$3 {
1039
1033
  timeZoneId?: string | null;
1040
1034
  }
1041
1035
  declare enum ScheduleStatus$3 {
1042
- /** Item is scheduled for a future date */
1036
+ /** Item is scheduled for a future date. */
1043
1037
  SCHEDULED = "SCHEDULED",
1044
- /** Item was canceled */
1038
+ /** Item is canceled. */
1045
1039
  CANCELED = "CANCELED"
1046
1040
  }
1047
1041
  interface ListBookmarksRequest$1 {
@@ -1142,9 +1136,9 @@ interface TimeInterval$2 {
1142
1136
  timeZoneId?: string | null;
1143
1137
  }
1144
1138
  declare enum ScheduleStatus$2 {
1145
- /** Item is scheduled for a future date */
1139
+ /** Item is scheduled for a future date. */
1146
1140
  SCHEDULED = "SCHEDULED",
1147
- /** Item was canceled */
1141
+ /** Item is canceled. */
1148
1142
  CANCELED = "CANCELED"
1149
1143
  }
1150
1144
  interface ListBookmarksRequest {
@@ -1266,9 +1260,9 @@ interface TimeInterval$1 {
1266
1260
  timeZoneId?: string | null;
1267
1261
  }
1268
1262
  declare enum ScheduleStatus$1 {
1269
- /** Item is scheduled for a future date */
1263
+ /** Item is scheduled for a future date. */
1270
1264
  SCHEDULED = "SCHEDULED",
1271
- /** Item was canceled */
1265
+ /** Item is canceled. */
1272
1266
  CANCELED = "CANCELED"
1273
1267
  }
1274
1268
  interface ListScheduleItemsRequest$1 {
@@ -1599,9 +1593,9 @@ interface TimeInterval {
1599
1593
  timeZoneId?: string | null;
1600
1594
  }
1601
1595
  declare enum ScheduleStatus {
1602
- /** Item is scheduled for a future date */
1596
+ /** Item is scheduled for a future date. */
1603
1597
  SCHEDULED = "SCHEDULED",
1604
- /** Item was canceled */
1598
+ /** Item is canceled. */
1605
1599
  CANCELED = "CANCELED"
1606
1600
  }
1607
1601
  interface ListScheduleItemsRequest {
@@ -4593,27 +4587,27 @@ declare enum SubdivisionType$3 {
4593
4587
  COUNTRY = "COUNTRY"
4594
4588
  }
4595
4589
  declare enum OrderStatus$3 {
4596
- /** Order status not available for this request fieldset */
4590
+ /** Order status not available for this request fieldset. */
4597
4591
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
4598
- /** Order is confirmed, no payment required */
4592
+ /** Order is confirmed and payment isn't required. */
4599
4593
  FREE = "FREE",
4600
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
4594
+ /** Order is paid for but the payment gateway has suspended the payment. */
4601
4595
  PENDING = "PENDING",
4602
- /** Order paid via payment gateway */
4596
+ /** Order is paid via a payment gateway. */
4603
4597
  PAID = "PAID",
4604
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
4598
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
4605
4599
  OFFLINE_PENDING = "OFFLINE_PENDING",
4606
- /** Order is awaiting for payment in Cashier */
4600
+ /** Order is awaiting payment at the cashier. */
4607
4601
  INITIATED = "INITIATED",
4608
- /** Order was canceled */
4602
+ /** Order is canceled. */
4609
4603
  CANCELED = "CANCELED",
4610
- /** Order payment was declined */
4604
+ /** Order payment is declined. */
4611
4605
  DECLINED = "DECLINED",
4612
- /** Order payment was authorized */
4606
+ /** Order payment is authorized. */
4613
4607
  AUTHORIZED = "AUTHORIZED",
4614
- /** Order payment was voided */
4608
+ /** Order payment is voided. */
4615
4609
  VOIDED = "VOIDED",
4616
- /** Order was partially paid, less than total amount covered. */
4610
+ /** Order is partially paid with less than the total amount. */
4617
4611
  PARTIALLY_PAID = "PARTIALLY_PAID"
4618
4612
  }
4619
4613
  interface Money$7 {
@@ -4714,9 +4708,9 @@ interface GuestDetails$3 {
4714
4708
  phone?: string | null;
4715
4709
  }
4716
4710
  declare enum ChannelType$3 {
4717
- /** Buyer created order via one of the online channels (website, mobile app, etc.) */
4711
+ /** Buyer created the order via an online channel such as a website or mobile app. */
4718
4712
  ONLINE = "ONLINE",
4719
- /** Order created and money collected by the sales person */
4713
+ /** Sales person created the order and collected the money. */
4720
4714
  OFFLINE_POS = "OFFLINE_POS"
4721
4715
  }
4722
4716
  interface TicketDetails$1 {
@@ -4796,7 +4790,7 @@ interface Item$3 {
4796
4790
  id?: string;
4797
4791
  /** Line item quantity. */
4798
4792
  quantity?: number;
4799
- /** Line item mame. */
4793
+ /** Line item name. */
4800
4794
  name?: string;
4801
4795
  /** Line item price. */
4802
4796
  price?: Money$7;
@@ -4940,11 +4934,11 @@ interface PaymentTransaction$1 {
4940
4934
  method?: string;
4941
4935
  }
4942
4936
  declare enum ScheduledActionEnumAction$1 {
4943
- /** Action not scheduled */
4937
+ /** Action not scheduled. */
4944
4938
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
4945
- /** Capture after the delay */
4939
+ /** Captured after the delay. */
4946
4940
  CAPTURE = "CAPTURE",
4947
- /** Void after the delay */
4941
+ /** Void after the delay. */
4948
4942
  VOID = "VOID"
4949
4943
  }
4950
4944
  declare enum Action$1 {
@@ -4994,29 +4988,29 @@ interface ListOrdersRequest$1 {
4994
4988
  contactId?: string[];
4995
4989
  }
4996
4990
  declare enum OrderFieldset$1 {
4997
- /** Include tickets in response */
4991
+ /** Include tickets in response. */
4998
4992
  TICKETS = "TICKETS",
4999
- /** Include order details: status, first_name, last_name, email, created, etc. */
4993
+ /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
5000
4994
  DETAILS = "DETAILS",
5001
- /** Include checkout_form */
4995
+ /** Include `checkoutForm` in the response. */
5002
4996
  FORM = "FORM",
5003
- /** Include invoice */
4997
+ /** Include `invoice` in the response. */
5004
4998
  INVOICE = "INVOICE"
5005
4999
  }
5006
5000
  declare enum OrderTag$1 {
5007
- /** Return only confirmed orders */
5001
+ /** Return only confirmed orders. */
5008
5002
  CONFIRMED = "CONFIRMED",
5009
- /** Return only unconfirmed orders */
5003
+ /** Return only unconfirmed orders. */
5010
5004
  UNCONFIRMED = "UNCONFIRMED",
5011
- /** Return only member orders */
5005
+ /** Return only member orders. */
5012
5006
  MEMBER = "MEMBER",
5013
- /** Return only archived orders */
5007
+ /** Return only archived orders. */
5014
5008
  ARCHIVED = "ARCHIVED",
5015
- /** Return only non archived orders */
5009
+ /** Return only non archived orders. */
5016
5010
  NON_ARCHIVED = "NON_ARCHIVED",
5017
- /** Return only orders with all guests checked-in */
5011
+ /** Return only orders with all guests checked-in. */
5018
5012
  FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
5019
- /** Return only orders with no guests checked-in */
5013
+ /** Return only orders with no guests checked-in. */
5020
5014
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
5021
5015
  }
5022
5016
  interface ListOrdersResponse$1 {
@@ -5143,18 +5137,15 @@ interface VoidAuthorizedPaymentRequest$1 {
5143
5137
  interface VoidAuthorizedPaymentResponse$1 {
5144
5138
  }
5145
5139
  declare enum ReservationStatus$1 {
5146
- /**
5147
- * Reservation is pending confirmation.
5148
- * The reservation will expire after the expiration due time.
5149
- */
5140
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
5150
5141
  RESERVATION_PENDING = "RESERVATION_PENDING",
5151
- /** The reservation was confirmed and will not expire. */
5142
+ /** The reservation is confirmed and will not expire. */
5152
5143
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
5153
- /** The reservation was canceled because of non payment. */
5144
+ /** The reservation is canceled because of non payment. */
5154
5145
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
5155
- /** The reservation was canceled manually by the buyer. */
5146
+ /** The reservation is canceled manually by the buyer. */
5156
5147
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
5157
- /** The reservation has expired. */
5148
+ /** The reservation is expired. */
5158
5149
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
5159
5150
  }
5160
5151
  interface GetCheckoutOptionsRequest$1 {
@@ -5273,11 +5264,11 @@ interface TicketSalePeriod$3 {
5273
5264
  hideNotOnSale?: boolean;
5274
5265
  }
5275
5266
  declare enum TicketSaleStatus$3 {
5276
- /** Ticket sale is scheduled to start */
5267
+ /** Ticket sale is scheduled to start. */
5277
5268
  SALE_SCHEDULED = "SALE_SCHEDULED",
5278
- /** Ticket sale has started */
5269
+ /** Ticket sale has started. */
5279
5270
  SALE_STARTED = "SALE_STARTED",
5280
- /** Ticket sale has ended */
5271
+ /** Ticket sale has ended. */
5281
5272
  SALE_ENDED = "SALE_ENDED"
5282
5273
  }
5283
5274
  interface TicketPricing$3 extends TicketPricingPriceOneOf$3 {
@@ -5336,9 +5327,9 @@ interface QueryAvailableTicketsRequest$1 {
5336
5327
  sort?: string;
5337
5328
  }
5338
5329
  declare enum TicketDefinitionFieldset$3 {
5339
- /** Include policy in the response. */
5330
+ /** Include `policy` in the response. */
5340
5331
  POLICY = "POLICY",
5341
- /** Include dashboard in the response. */
5332
+ /** Include `dashboard` in the response. */
5342
5333
  DASHBOARD = "DASHBOARD"
5343
5334
  }
5344
5335
  interface QueryAvailableTicketsResponse$1 {
@@ -5904,27 +5895,27 @@ interface InputValue$6 {
5904
5895
  values?: string[];
5905
5896
  }
5906
5897
  declare enum OrderStatus$2 {
5907
- /** Order status not available for this request fieldset */
5898
+ /** Order status not available for this request fieldset. */
5908
5899
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
5909
- /** Order is confirmed, no payment required */
5900
+ /** Order is confirmed and payment isn't required. */
5910
5901
  FREE = "FREE",
5911
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
5902
+ /** Order is paid for but the payment gateway has suspended the payment. */
5912
5903
  PENDING = "PENDING",
5913
- /** Order paid via payment gateway */
5904
+ /** Order is paid via a payment gateway. */
5914
5905
  PAID = "PAID",
5915
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
5906
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
5916
5907
  OFFLINE_PENDING = "OFFLINE_PENDING",
5917
- /** Order is awaiting for payment in Cashier */
5908
+ /** Order is awaiting payment at the cashier. */
5918
5909
  INITIATED = "INITIATED",
5919
- /** Order was canceled */
5910
+ /** Order is canceled. */
5920
5911
  CANCELED = "CANCELED",
5921
- /** Order payment was declined */
5912
+ /** Order payment is declined. */
5922
5913
  DECLINED = "DECLINED",
5923
- /** Order payment was authorized */
5914
+ /** Order payment is authorized. */
5924
5915
  AUTHORIZED = "AUTHORIZED",
5925
- /** Order payment was voided */
5916
+ /** Order payment is voided. */
5926
5917
  VOIDED = "VOIDED",
5927
- /** Order was partially paid, less than total amount covered. */
5918
+ /** Order is partially paid with less than the total amount. */
5928
5919
  PARTIALLY_PAID = "PARTIALLY_PAID"
5929
5920
  }
5930
5921
  interface Money$6 {
@@ -6025,9 +6016,9 @@ interface GuestDetails$2 {
6025
6016
  phone?: string | null;
6026
6017
  }
6027
6018
  declare enum ChannelType$2 {
6028
- /** Buyer created order via one of the online channels (website, mobile app, etc.) */
6019
+ /** Buyer created the order via an online channel such as a website or mobile app. */
6029
6020
  ONLINE = "ONLINE",
6030
- /** Order created and money collected by the sales person */
6021
+ /** Sales person created the order and collected the money. */
6031
6022
  OFFLINE_POS = "OFFLINE_POS"
6032
6023
  }
6033
6024
  interface TicketDetails {
@@ -6108,7 +6099,7 @@ interface Item$2 {
6108
6099
  _id?: string;
6109
6100
  /** Line item quantity. */
6110
6101
  quantity?: number;
6111
- /** Line item mame. */
6102
+ /** Line item name. */
6112
6103
  name?: string;
6113
6104
  /** Line item price. */
6114
6105
  price?: Money$6;
@@ -6252,11 +6243,11 @@ interface PaymentTransaction {
6252
6243
  method?: string;
6253
6244
  }
6254
6245
  declare enum ScheduledActionEnumAction {
6255
- /** Action not scheduled */
6246
+ /** Action not scheduled. */
6256
6247
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
6257
- /** Capture after the delay */
6248
+ /** Captured after the delay. */
6258
6249
  CAPTURE = "CAPTURE",
6259
- /** Void after the delay */
6250
+ /** Void after the delay. */
6260
6251
  VOID = "VOID"
6261
6252
  }
6262
6253
  declare enum Action {
@@ -6321,29 +6312,29 @@ interface ListOrdersRequest {
6321
6312
  contactId?: string[];
6322
6313
  }
6323
6314
  declare enum OrderFieldset {
6324
- /** Include tickets in response */
6315
+ /** Include tickets in response. */
6325
6316
  TICKETS = "TICKETS",
6326
- /** Include order details: status, first_name, last_name, email, created, etc. */
6317
+ /** Include order details in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */
6327
6318
  DETAILS = "DETAILS",
6328
- /** Include checkout_form */
6319
+ /** Include `checkoutForm` in the response. */
6329
6320
  FORM = "FORM",
6330
- /** Include invoice */
6321
+ /** Include `invoice` in the response. */
6331
6322
  INVOICE = "INVOICE"
6332
6323
  }
6333
6324
  declare enum OrderTag {
6334
- /** Return only confirmed orders */
6325
+ /** Return only confirmed orders. */
6335
6326
  CONFIRMED = "CONFIRMED",
6336
- /** Return only unconfirmed orders */
6327
+ /** Return only unconfirmed orders. */
6337
6328
  UNCONFIRMED = "UNCONFIRMED",
6338
- /** Return only member orders */
6329
+ /** Return only member orders. */
6339
6330
  MEMBER = "MEMBER",
6340
- /** Return only archived orders */
6331
+ /** Return only archived orders. */
6341
6332
  ARCHIVED = "ARCHIVED",
6342
- /** Return only non archived orders */
6333
+ /** Return only non archived orders. */
6343
6334
  NON_ARCHIVED = "NON_ARCHIVED",
6344
- /** Return only orders with all guests checked-in */
6335
+ /** Return only orders with all guests checked-in. */
6345
6336
  FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
6346
- /** Return only orders with no guests checked-in */
6337
+ /** Return only orders with no guests checked-in. */
6347
6338
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN"
6348
6339
  }
6349
6340
  interface ListOrdersResponse {
@@ -6479,18 +6470,15 @@ interface VoidAuthorizedPaymentRequest {
6479
6470
  interface VoidAuthorizedPaymentResponse {
6480
6471
  }
6481
6472
  declare enum ReservationStatus {
6482
- /**
6483
- * Reservation is pending confirmation.
6484
- * The reservation will expire after the expiration due time.
6485
- */
6473
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
6486
6474
  RESERVATION_PENDING = "RESERVATION_PENDING",
6487
- /** The reservation was confirmed and will not expire. */
6475
+ /** The reservation is confirmed and will not expire. */
6488
6476
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
6489
- /** The reservation was canceled because of non payment. */
6477
+ /** The reservation is canceled because of non payment. */
6490
6478
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
6491
- /** The reservation was canceled manually by the buyer. */
6479
+ /** The reservation is canceled manually by the buyer. */
6492
6480
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
6493
- /** The reservation has expired. */
6481
+ /** The reservation is expired. */
6494
6482
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
6495
6483
  }
6496
6484
  interface GetCheckoutOptionsRequest {
@@ -6606,11 +6594,11 @@ interface TicketSalePeriod$2 {
6606
6594
  hideNotOnSale?: boolean;
6607
6595
  }
6608
6596
  declare enum TicketSaleStatus$2 {
6609
- /** Ticket sale is scheduled to start */
6597
+ /** Ticket sale is scheduled to start. */
6610
6598
  SALE_SCHEDULED = "SALE_SCHEDULED",
6611
- /** Ticket sale has started */
6599
+ /** Ticket sale has started. */
6612
6600
  SALE_STARTED = "SALE_STARTED",
6613
- /** Ticket sale has ended */
6601
+ /** Ticket sale has ended. */
6614
6602
  SALE_ENDED = "SALE_ENDED"
6615
6603
  }
6616
6604
  interface TicketPricing$2 extends TicketPricingPriceOneOf$2 {
@@ -6666,9 +6654,9 @@ interface QueryAvailableTicketsRequest {
6666
6654
  sort?: string;
6667
6655
  }
6668
6656
  declare enum TicketDefinitionFieldset$2 {
6669
- /** Include policy in the response. */
6657
+ /** Include `policy` in the response. */
6670
6658
  POLICY = "POLICY",
6671
- /** Include dashboard in the response. */
6659
+ /** Include `dashboard` in the response. */
6672
6660
  DASHBOARD = "DASHBOARD"
6673
6661
  }
6674
6662
  interface QueryAvailableTicketsResponse {
@@ -10699,19 +10687,19 @@ interface ListRsvpRequest$1 {
10699
10687
  tag?: RsvpTag$1[];
10700
10688
  }
10701
10689
  declare enum RsvpFieldset$1 {
10702
- /** Include RSVP details: created, modified, first_name, last_name, etc. */
10690
+ /** Include RSVP details including: `created`, `modified`, `firstName`, `lastName`, `status`, `totalGuests`, `guests`, and `annonymized`. */
10703
10691
  DETAILS = "DETAILS",
10704
- /** Include rsvp_form. */
10692
+ /** Include RSVP form. */
10705
10693
  FORM = "FORM",
10706
10694
  /** Include RSVP email. */
10707
10695
  CONTACT_DETAILS = "CONTACT_DETAILS"
10708
10696
  }
10709
10697
  declare enum RsvpTag$1 {
10710
- /** Return only rsvps with all guests checked-in */
10698
+ /** Return only RSVPs of all guests that are fully checked-in. */
10711
10699
  FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
10712
- /** Return only rsvps with not all guests checked-in */
10700
+ /** Return only RSVPs of all guests that aren't fully checked-in. */
10713
10701
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN",
10714
- /** Return only member rsvp */
10702
+ /** Return only RSVPs of guests that are members. */
10715
10703
  MEMBER = "MEMBER"
10716
10704
  }
10717
10705
  interface ListRsvpResponse$1 {
@@ -11090,19 +11078,19 @@ interface ListRsvpRequest {
11090
11078
  tag?: RsvpTag[];
11091
11079
  }
11092
11080
  declare enum RsvpFieldset {
11093
- /** Include RSVP details: created, modified, first_name, last_name, etc. */
11081
+ /** Include RSVP details including: `created`, `modified`, `firstName`, `lastName`, `status`, `totalGuests`, `guests`, and `annonymized`. */
11094
11082
  DETAILS = "DETAILS",
11095
- /** Include rsvp_form. */
11083
+ /** Include RSVP form. */
11096
11084
  FORM = "FORM",
11097
11085
  /** Include RSVP email. */
11098
11086
  CONTACT_DETAILS = "CONTACT_DETAILS"
11099
11087
  }
11100
11088
  declare enum RsvpTag {
11101
- /** Return only rsvps with all guests checked-in */
11089
+ /** Return only RSVPs of all guests that are fully checked-in. */
11102
11090
  FULLY_CHECKED_IN = "FULLY_CHECKED_IN",
11103
- /** Return only rsvps with not all guests checked-in */
11091
+ /** Return only RSVPs of all guests that aren't fully checked-in. */
11104
11092
  NOT_FULLY_CHECKED_IN = "NOT_FULLY_CHECKED_IN",
11105
- /** Return only member rsvp */
11093
+ /** Return only RSVPs of guests that are members. */
11106
11094
  MEMBER = "MEMBER"
11107
11095
  }
11108
11096
  interface ListRsvpResponse {
@@ -11508,27 +11496,27 @@ interface CheckIn$1 {
11508
11496
  created?: Date | null;
11509
11497
  }
11510
11498
  declare enum OrderStatus$1 {
11511
- /** Order status not available for this request fieldset */
11499
+ /** Order status not available for this request fieldset. */
11512
11500
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
11513
- /** Order is confirmed, no payment required */
11501
+ /** Order is confirmed and payment isn't required. */
11514
11502
  FREE = "FREE",
11515
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
11503
+ /** Order is paid for but the payment gateway has suspended the payment. */
11516
11504
  PENDING = "PENDING",
11517
- /** Order paid via payment gateway */
11505
+ /** Order is paid via a payment gateway. */
11518
11506
  PAID = "PAID",
11519
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
11507
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
11520
11508
  OFFLINE_PENDING = "OFFLINE_PENDING",
11521
- /** Order is awaiting for payment in Cashier */
11509
+ /** Order is awaiting payment at the cashier. */
11522
11510
  INITIATED = "INITIATED",
11523
- /** Order was canceled */
11511
+ /** Order is canceled. */
11524
11512
  CANCELED = "CANCELED",
11525
- /** Order payment was declined */
11513
+ /** Order payment is declined. */
11526
11514
  DECLINED = "DECLINED",
11527
- /** Order payment was authorized */
11515
+ /** Order payment is authorized. */
11528
11516
  AUTHORIZED = "AUTHORIZED",
11529
- /** Order payment was voided */
11517
+ /** Order payment is voided. */
11530
11518
  VOIDED = "VOIDED",
11531
- /** Order was partially paid, less than total amount covered. */
11519
+ /** Order is partially paid with less than the total amount. */
11532
11520
  PARTIALLY_PAID = "PARTIALLY_PAID"
11533
11521
  }
11534
11522
  interface GuestDetails$1 {
@@ -11571,9 +11559,9 @@ declare enum SubdivisionType$1 {
11571
11559
  COUNTRY = "COUNTRY"
11572
11560
  }
11573
11561
  declare enum ChannelType$1 {
11574
- /** Buyer created order via one of the online channels (website, mobile app, etc.) */
11562
+ /** Buyer created the order via an online channel such as a website or mobile app. */
11575
11563
  ONLINE = "ONLINE",
11576
- /** Order created and money collected by the sales person */
11564
+ /** Sales person created the order and collected the money. */
11577
11565
  OFFLINE_POS = "OFFLINE_POS"
11578
11566
  }
11579
11567
  interface ListTicketsRequest$1 {
@@ -11613,31 +11601,31 @@ interface ListTicketsRequest$1 {
11613
11601
  ticketDefinitionId?: string[];
11614
11602
  }
11615
11603
  declare enum TicketFieldset$1 {
11616
- /** Include guest details in ticket response */
11604
+ /** Include guest details in the ticket response. */
11617
11605
  GUEST_DETAILS = "GUEST_DETAILS",
11618
- /** Include ticket details in ticket response */
11606
+ /** Include ticket details in the ticket response. */
11619
11607
  TICKET_DETAILS = "TICKET_DETAILS",
11620
- /** Include individual guest form in ticket response */
11608
+ /** Include individual guest form in the ticket response. */
11621
11609
  GUEST_FORM = "GUEST_FORM"
11622
11610
  }
11623
11611
  declare enum State$3 {
11624
- /** Returns only archived orders' tickets */
11612
+ /** Returns only archived orders' tickets. */
11625
11613
  ORDER_ARCHIVED = "ORDER_ARCHIVED",
11626
- /** Returns only non-archived orders' tickets */
11614
+ /** Returns only non-archived orders' tickets. */
11627
11615
  ORDER_ACTIVE = "ORDER_ACTIVE",
11628
- /** Returns only archived tickets */
11616
+ /** Returns only archived tickets. */
11629
11617
  TICKET_ARCHIVED = "TICKET_ARCHIVED",
11630
- /** Returns only non-archived tickets */
11618
+ /** Returns only non-archived tickets. */
11631
11619
  TICKET_ACTIVE = "TICKET_ACTIVE",
11632
- /** Returns only checked-in tickets */
11620
+ /** Returns only checked-in tickets. */
11633
11621
  CHECKED_IN = "CHECKED_IN",
11634
- /** Returns only non-checked-in tickets */
11622
+ /** Returns only non-checked-in tickets. */
11635
11623
  NON_CHECKED_IN = "NON_CHECKED_IN",
11636
- /** Returns only free tickets */
11624
+ /** Returns only free tickets. */
11637
11625
  FREE = "FREE",
11638
- /** Returns only paid tickets */
11626
+ /** Returns only paid tickets. */
11639
11627
  PAID = "PAID",
11640
- /** Returns only member tickets */
11628
+ /** Returns only member tickets. */
11641
11629
  MEMBER = "MEMBER"
11642
11630
  }
11643
11631
  interface ListTicketsResponse$1 {
@@ -11896,27 +11884,27 @@ interface CheckIn {
11896
11884
  created?: Date | null;
11897
11885
  }
11898
11886
  declare enum OrderStatus {
11899
- /** Order status not available for this request fieldset */
11887
+ /** Order status not available for this request fieldset. */
11900
11888
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
11901
- /** Order is confirmed, no payment required */
11889
+ /** Order is confirmed and payment isn't required. */
11902
11890
  FREE = "FREE",
11903
- /** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
11891
+ /** Order is paid for but the payment gateway has suspended the payment. */
11904
11892
  PENDING = "PENDING",
11905
- /** Order paid via payment gateway */
11893
+ /** Order is paid via a payment gateway. */
11906
11894
  PAID = "PAID",
11907
- /** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
11895
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
11908
11896
  OFFLINE_PENDING = "OFFLINE_PENDING",
11909
- /** Order is awaiting for payment in Cashier */
11897
+ /** Order is awaiting payment at the cashier. */
11910
11898
  INITIATED = "INITIATED",
11911
- /** Order was canceled */
11899
+ /** Order is canceled. */
11912
11900
  CANCELED = "CANCELED",
11913
- /** Order payment was declined */
11901
+ /** Order payment is declined. */
11914
11902
  DECLINED = "DECLINED",
11915
- /** Order payment was authorized */
11903
+ /** Order payment is authorized. */
11916
11904
  AUTHORIZED = "AUTHORIZED",
11917
- /** Order payment was voided */
11905
+ /** Order payment is voided. */
11918
11906
  VOIDED = "VOIDED",
11919
- /** Order was partially paid, less than total amount covered. */
11907
+ /** Order is partially paid with less than the total amount. */
11920
11908
  PARTIALLY_PAID = "PARTIALLY_PAID"
11921
11909
  }
11922
11910
  interface GuestDetails {
@@ -11948,9 +11936,9 @@ interface InputValue$2 {
11948
11936
  values?: string[];
11949
11937
  }
11950
11938
  declare enum ChannelType {
11951
- /** Buyer created order via one of the online channels (website, mobile app, etc.) */
11939
+ /** Buyer created the order via an online channel such as a website or mobile app. */
11952
11940
  ONLINE = "ONLINE",
11953
- /** Order created and money collected by the sales person */
11941
+ /** Sales person created the order and collected the money. */
11954
11942
  OFFLINE_POS = "OFFLINE_POS"
11955
11943
  }
11956
11944
  interface ListTicketsRequest {
@@ -12002,31 +11990,31 @@ interface ListTicketsRequest {
12002
11990
  ticketDefinitionId?: string[];
12003
11991
  }
12004
11992
  declare enum TicketFieldset {
12005
- /** Include guest details in ticket response */
11993
+ /** Include guest details in the ticket response. */
12006
11994
  GUEST_DETAILS = "GUEST_DETAILS",
12007
- /** Include ticket details in ticket response */
11995
+ /** Include ticket details in the ticket response. */
12008
11996
  TICKET_DETAILS = "TICKET_DETAILS",
12009
- /** Include individual guest form in ticket response */
11997
+ /** Include individual guest form in the ticket response. */
12010
11998
  GUEST_FORM = "GUEST_FORM"
12011
11999
  }
12012
12000
  declare enum State$2 {
12013
- /** Returns only archived orders' tickets */
12001
+ /** Returns only archived orders' tickets. */
12014
12002
  ORDER_ARCHIVED = "ORDER_ARCHIVED",
12015
- /** Returns only non-archived orders' tickets */
12003
+ /** Returns only non-archived orders' tickets. */
12016
12004
  ORDER_ACTIVE = "ORDER_ACTIVE",
12017
- /** Returns only archived tickets */
12005
+ /** Returns only archived tickets. */
12018
12006
  TICKET_ARCHIVED = "TICKET_ARCHIVED",
12019
- /** Returns only non-archived tickets */
12007
+ /** Returns only non-archived tickets. */
12020
12008
  TICKET_ACTIVE = "TICKET_ACTIVE",
12021
- /** Returns only checked-in tickets */
12009
+ /** Returns only checked-in tickets. */
12022
12010
  CHECKED_IN = "CHECKED_IN",
12023
- /** Returns only non-checked-in tickets */
12011
+ /** Returns only non-checked-in tickets. */
12024
12012
  NON_CHECKED_IN = "NON_CHECKED_IN",
12025
- /** Returns only free tickets */
12013
+ /** Returns only free tickets. */
12026
12014
  FREE = "FREE",
12027
- /** Returns only paid tickets */
12015
+ /** Returns only paid tickets. */
12028
12016
  PAID = "PAID",
12029
- /** Returns only member tickets */
12017
+ /** Returns only member tickets. */
12030
12018
  MEMBER = "MEMBER"
12031
12019
  }
12032
12020
  interface ListTicketsResponse {
@@ -12315,11 +12303,11 @@ interface TicketSalePeriod$1 {
12315
12303
  hideNotOnSale?: boolean;
12316
12304
  }
12317
12305
  declare enum TicketSaleStatus$1 {
12318
- /** Ticket sale is scheduled to start */
12306
+ /** Ticket sale is scheduled to start. */
12319
12307
  SALE_SCHEDULED = "SALE_SCHEDULED",
12320
- /** Ticket sale has started */
12308
+ /** Ticket sale has started. */
12321
12309
  SALE_STARTED = "SALE_STARTED",
12322
- /** Ticket sale has ended */
12310
+ /** Ticket sale has ended. */
12323
12311
  SALE_ENDED = "SALE_ENDED"
12324
12312
  }
12325
12313
  declare enum TicketDefinitionStateEnumState$1 {
@@ -12384,9 +12372,9 @@ interface QueryTicketDefinitionsRequest$3 {
12384
12372
  facet?: string[];
12385
12373
  }
12386
12374
  declare enum TicketDefinitionFieldset$1 {
12387
- /** Include policy in the response. */
12375
+ /** Include `policy` in the response. */
12388
12376
  POLICY = "POLICY",
12389
- /** Include dashboard in the response. */
12377
+ /** Include `dashboard` in the response. */
12390
12378
  DASHBOARD = "DASHBOARD"
12391
12379
  }
12392
12380
  interface QueryTicketDefinitionsResponse$3 {
@@ -12516,13 +12504,13 @@ interface ListTicketDefinitionsRequest$1 {
12516
12504
  facet?: string[];
12517
12505
  }
12518
12506
  declare enum State$1 {
12519
- /** Ticket is available for purchase. */
12507
+ /** The ticket is available for purchase. */
12520
12508
  VISIBLE = "VISIBLE",
12521
- /** Opposite to VISIBLE. */
12509
+ /** The ticket is unavailable for purchase. */
12522
12510
  HIDDEN = "HIDDEN",
12523
- /** Ticket price is 0. */
12511
+ /** The ticket price is 0. */
12524
12512
  FREE = "FREE",
12525
- /** Ticket price is greater than 0. */
12513
+ /** The ticket price is greater than 0. */
12526
12514
  PAID = "PAID"
12527
12515
  }
12528
12516
  interface ListTicketDefinitionsResponse$1 {
@@ -12810,11 +12798,11 @@ interface TicketSalePeriod {
12810
12798
  hideNotOnSale?: boolean;
12811
12799
  }
12812
12800
  declare enum TicketSaleStatus {
12813
- /** Ticket sale is scheduled to start */
12801
+ /** Ticket sale is scheduled to start. */
12814
12802
  SALE_SCHEDULED = "SALE_SCHEDULED",
12815
- /** Ticket sale has started */
12803
+ /** Ticket sale has started. */
12816
12804
  SALE_STARTED = "SALE_STARTED",
12817
- /** Ticket sale has ended */
12805
+ /** Ticket sale has ended. */
12818
12806
  SALE_ENDED = "SALE_ENDED"
12819
12807
  }
12820
12808
  declare enum TicketDefinitionStateEnumState {
@@ -12879,9 +12867,9 @@ interface QueryTicketDefinitionsRequest$2 {
12879
12867
  facet?: string[];
12880
12868
  }
12881
12869
  declare enum TicketDefinitionFieldset {
12882
- /** Include policy in the response. */
12870
+ /** Include `policy` in the response. */
12883
12871
  POLICY = "POLICY",
12884
- /** Include dashboard in the response. */
12872
+ /** Include `dashboard` in the response. */
12885
12873
  DASHBOARD = "DASHBOARD"
12886
12874
  }
12887
12875
  interface QueryTicketDefinitionsResponse$2 {
@@ -13024,13 +13012,13 @@ interface ListTicketDefinitionsRequest {
13024
13012
  facet?: string[];
13025
13013
  }
13026
13014
  declare enum State {
13027
- /** Ticket is available for purchase. */
13015
+ /** The ticket is available for purchase. */
13028
13016
  VISIBLE = "VISIBLE",
13029
- /** Opposite to VISIBLE. */
13017
+ /** The ticket is unavailable for purchase. */
13030
13018
  HIDDEN = "HIDDEN",
13031
- /** Ticket price is 0. */
13019
+ /** The ticket price is 0. */
13032
13020
  FREE = "FREE",
13033
- /** Ticket price is greater than 0. */
13021
+ /** The ticket price is greater than 0. */
13034
13022
  PAID = "PAID"
13035
13023
  }
13036
13024
  interface ListTicketDefinitionsResponse {
@@ -13668,6 +13656,7 @@ interface Rsvp$1 {
13668
13656
  email?: string | null;
13669
13657
  /** Event registration form. */
13670
13658
  form?: FormResponse$1;
13659
+ /** RSVP response status. */
13671
13660
  status?: RsvpStatus$1;
13672
13661
  /**
13673
13662
  * Total number of guests per 1 RSVP.
@@ -13741,8 +13730,11 @@ declare enum SubdivisionType {
13741
13730
  }
13742
13731
  declare enum RsvpStatus$1 {
13743
13732
  UNKNOWN_RSVP_STATUS = "UNKNOWN_RSVP_STATUS",
13733
+ /** Guest is attending the event. */
13744
13734
  YES = "YES",
13735
+ /** Guest is not attending the event. */
13745
13736
  NO = "NO",
13737
+ /** Guest is in a waitlist. */
13746
13738
  WAITLIST = "WAITLIST"
13747
13739
  }
13748
13740
  interface GuestList$1 {
@@ -14644,6 +14636,7 @@ interface Rsvp {
14644
14636
  email?: string | null;
14645
14637
  /** Event registration form. */
14646
14638
  form?: FormResponse;
14639
+ /** RSVP response status. */
14647
14640
  status?: RsvpStatus;
14648
14641
  /**
14649
14642
  * Total number of guests per 1 RSVP.
@@ -14702,8 +14695,11 @@ interface InputValue {
14702
14695
  }
14703
14696
  declare enum RsvpStatus {
14704
14697
  UNKNOWN_RSVP_STATUS = "UNKNOWN_RSVP_STATUS",
14698
+ /** Guest is attending the event. */
14705
14699
  YES = "YES",
14700
+ /** Guest is not attending the event. */
14706
14701
  NO = "NO",
14702
+ /** Guest is in a waitlist. */
14707
14703
  WAITLIST = "WAITLIST"
14708
14704
  }
14709
14705
  interface GuestList {
@@ -15632,7 +15628,9 @@ interface V3Event$1 {
15632
15628
  */
15633
15629
  shortDescription?: string | null;
15634
15630
  /**
15635
- * Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags). <br>
15631
+ * Detailed description of an event.
15632
+ *
15633
+ * To populate this field call the [Create Rich Content](https://dev.wix.com/docs/rest/business-solutions/events/rich-content/create-rich-content) method. For the full flow read the introduction.
15636
15634
  * **Note:** This field is returned only when the `TEXTS` fieldset is included in the request.
15637
15635
  */
15638
15636
  detailedDescription?: string | null;
@@ -15657,12 +15655,7 @@ interface V3Event$1 {
15657
15655
  */
15658
15656
  updatedDate?: Date | null;
15659
15657
  /**
15660
- * Event status. Possible values:
15661
- * - `UPCOMING`: Event is published and scheduled to start.
15662
- * - `STARTED`: Event has started.
15663
- * - `ENDED`: Event has ended.
15664
- * - `CANCELED`: Event is canceled.
15665
- * - `DRAFT`: Event is not published.
15658
+ * Event status.
15666
15659
  * @readonly
15667
15660
  */
15668
15661
  status?: Status$3;
@@ -15730,11 +15723,7 @@ interface V3Event$1 {
15730
15723
  interface Location$3 {
15731
15724
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
15732
15725
  name?: string | null;
15733
- /**
15734
- * Location type. Possible values:
15735
- * - `VENUE`: Event is on-site at a specific physical location.
15736
- * - `ONLINE`: Event is online, such as a virtual video conference.
15737
- */
15726
+ /** Location type. */
15738
15727
  type?: LocationType$3;
15739
15728
  /** Exact location address. */
15740
15729
  address?: CommonAddress$3;
@@ -15742,9 +15731,11 @@ interface Location$3 {
15742
15731
  locationTbd?: boolean | null;
15743
15732
  }
15744
15733
  declare enum LocationType$3 {
15745
- /** Default value. This value is unused. */
15734
+ /** Unknown location type. */
15746
15735
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
15736
+ /** Event is on-site at a specific physical location. */
15747
15737
  VENUE = "VENUE",
15738
+ /** Event is online, such as a virtual video conference. */
15748
15739
  ONLINE = "ONLINE"
15749
15740
  }
15750
15741
  /** Physical address */
@@ -15808,12 +15799,7 @@ interface DateAndTimeSettings$3 {
15808
15799
  /** Whether the time zone is displayed in the formatted schedule. */
15809
15800
  showTimeZone?: boolean | null;
15810
15801
  /**
15811
- * Repeating event status. Possible values:
15812
- * - `ONE_TIME`: Event happens only once and can last multiple days.
15813
- * - `RECURRING`: A series of events that repeat.
15814
- * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
15815
- * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
15816
- * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
15802
+ * Repeating event status.
15817
15803
  * @readonly
15818
15804
  */
15819
15805
  recurrenceStatus?: RecurrenceStatusStatus$3;
@@ -15823,17 +15809,17 @@ interface DateAndTimeSettings$3 {
15823
15809
  formatted?: Formatted$3;
15824
15810
  }
15825
15811
  declare enum RecurrenceStatusStatus$3 {
15826
- /** Default value. This value is unused. */
15812
+ /** Unknown recurrance status. */
15827
15813
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
15828
- /** Event happens only once. */
15814
+ /** Event happens only once and can last multiple days. */
15829
15815
  ONE_TIME = "ONE_TIME",
15830
- /** Event is repeating and has a list of scheduled repetitions. */
15816
+ /** A series of events that repeat. */
15831
15817
  RECURRING = "RECURRING",
15832
- /** An upcoming event from the list of repetitions. */
15818
+ /** Next event in a schedule of recurring events. */
15833
15819
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
15834
- /** Latest ended event from the list of repetitions. */
15820
+ /** Latest event that ended in a schedule of recurring events. */
15835
15821
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
15836
- /** Latest cancelled event from the list of repetitions. */
15822
+ /** Latest canceled event in a schedule of recurring events */
15837
15823
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
15838
15824
  }
15839
15825
  interface Recurrences$3 {
@@ -15885,17 +15871,17 @@ interface Formatted$3 {
15885
15871
  endTime?: string | null;
15886
15872
  }
15887
15873
  declare enum Status$3 {
15888
- /** Default value. This value is unused */
15874
+ /** Unknown event status. */
15889
15875
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
15890
- /** Event is public and scheduled to start */
15876
+ /** Event is published and scheduled to start. */
15891
15877
  UPCOMING = "UPCOMING",
15892
- /** Event has started */
15878
+ /** Event has started. */
15893
15879
  STARTED = "STARTED",
15894
- /** Event has ended */
15880
+ /** Event has ended. */
15895
15881
  ENDED = "ENDED",
15896
- /** Event is canceled */
15882
+ /** Event is canceled. */
15897
15883
  CANCELED = "CANCELED",
15898
- /** Event is not public */
15884
+ /** Event is not public. */
15899
15885
  DRAFT = "DRAFT"
15900
15886
  }
15901
15887
  interface PageUrl$1 {
@@ -15906,24 +15892,12 @@ interface PageUrl$1 {
15906
15892
  }
15907
15893
  interface Registration$1 {
15908
15894
  /**
15909
- * Current registration type. Possible values:
15910
- * - `RSVP`: Guests register by RSVPing to the event.
15911
- * - `TICKETING`: Guests register by buying tickets.
15912
- * - `EXTERNAL`: Guests register externally using some other site or platform.
15913
- * - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.
15914
- * 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.
15895
+ * Current registration type.
15915
15896
  * @readonly
15916
15897
  */
15917
15898
  type?: RegistrationTypeType$1;
15918
15899
  /**
15919
- * Registration status. Possible values:
15920
- * - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.
15921
- * - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.
15922
- * - `OPEN_RSVP`: Guests can start RSVPing to the event.
15923
- * - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.
15924
- * - `OPEN_TICKETS`: Guests can buy tickets to the event.
15925
- * - `OPEN_EXTERNAL`: Guests register on a different page or web address.
15926
- * - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
15900
+ * Registration status.
15927
15901
  * @readonly
15928
15902
  */
15929
15903
  status?: RegistrationStatusStatus$1;
@@ -15933,18 +15907,9 @@ interface Registration$1 {
15933
15907
  tickets?: TicketsRegistration$1;
15934
15908
  /** External registration details. */
15935
15909
  external?: ExternalRegistration$1;
15936
- /**
15937
- * Types of guests allowed to register. Possible values:
15938
- * - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
15939
- * - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
15940
- */
15910
+ /** Types of guests allowed to register. */
15941
15911
  allowedGuestTypes?: GuestTypeType$1;
15942
- /**
15943
- * Initial event type which is set when creating an event. Possible values:
15944
- * - `RSVP`: Guests register by RSVPing to the event.
15945
- * - `TICKETING`: Guests register by buying tickets.
15946
- * This property value never changes.
15947
- */
15912
+ /** Initial event type which is set when creating an event. */
15948
15913
  initialType?: InitialRegistrationTypeType$1;
15949
15914
  /** Whether the registration is paused. */
15950
15915
  registrationPaused?: boolean;
@@ -15952,41 +15917,37 @@ interface Registration$1 {
15952
15917
  registrationDisabled?: boolean;
15953
15918
  }
15954
15919
  declare enum RegistrationTypeType$1 {
15955
- /** Default value. This value is unused */
15920
+ /** Unknown registration type. */
15956
15921
  UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
15957
- /** Registration via RSVP */
15922
+ /** Guests register by RSVPing to the event. */
15958
15923
  RSVP = "RSVP",
15959
- /** Registration via ticket purchase */
15924
+ /** Guests register by buying tickets. */
15960
15925
  TICKETING = "TICKETING",
15961
- /** External registration */
15926
+ /** Guests register externally using some other site or platform. */
15962
15927
  EXTERNAL = "EXTERNAL",
15963
- /** Registration not available */
15928
+ /** 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. */
15964
15929
  NONE = "NONE"
15965
15930
  }
15966
15931
  declare enum RegistrationStatusStatus$1 {
15967
15932
  /** Registration status is not applicable */
15968
15933
  UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
15969
- /** Registration to event is closed */
15934
+ /** Registration is closed after tickets are sold out. */
15970
15935
  CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
15971
- /** Registration to event is closed manually */
15936
+ /** Registration is closed when the `registration.registrationDisabled` property is set to `true`. */
15972
15937
  CLOSED_MANUALLY = "CLOSED_MANUALLY",
15973
- /** Registration is open via RSVP */
15938
+ /** Guests can start RSVPing to the event. */
15974
15939
  OPEN_RSVP = "OPEN_RSVP",
15975
- /** Registration to event waitlist is open via RSVP */
15940
+ /** Guest list has reached the maximum, new guests are added to a waitlist. */
15976
15941
  OPEN_RSVP_WAITLIST_ONLY = "OPEN_RSVP_WAITLIST_ONLY",
15977
- /** Registration is open via ticket purchase */
15942
+ /** Guests can buy tickets to the event. */
15978
15943
  OPEN_TICKETS = "OPEN_TICKETS",
15979
- /** Registration is open via external URL */
15944
+ /** Guests register on a different page or web address. */
15980
15945
  OPEN_EXTERNAL = "OPEN_EXTERNAL",
15981
- /** Registration will be open via RSVP */
15946
+ /** Registration via RSVP is scheduled for the future. */
15982
15947
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
15983
15948
  }
15984
15949
  interface RsvpRegistration$1 {
15985
- /**
15986
- * Available answers for registration to an event. Possible values:
15987
- * - `YES_ONLY`: Only a **Yes** answer is available to select when RSVP'ing to an event.
15988
- * - `YES_AND_NO`: Both **Yes** and **No** answers are available to select when RSVP'ing to an event.
15989
- */
15950
+ /** Available answers for registration to an event. */
15990
15951
  responseType?: ResponseType$1;
15991
15952
  /** How many guests can RSVP to an event. */
15992
15953
  limit?: number | null;
@@ -15998,11 +15959,11 @@ interface RsvpRegistration$1 {
15998
15959
  endDate?: Date | null;
15999
15960
  }
16000
15961
  declare enum ResponseType$1 {
16001
- /** Default value. This value is unused. */
15962
+ /** Unknown response type. */
16002
15963
  UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
16003
- /** Only a **Yes** answer is available for the registration. */
15964
+ /** Only a **Yes** answer is available to select when RSVP'ing to an event. */
16004
15965
  YES_ONLY = "YES_ONLY",
16005
- /** *Yes** and **No** answers are available for the registration. */
15966
+ /** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
16006
15967
  YES_AND_NO = "YES_AND_NO"
16007
15968
  }
16008
15969
  interface TicketsRegistration$1 {
@@ -16049,11 +16010,7 @@ interface Money$1 {
16049
16010
  formattedValue?: string | null;
16050
16011
  }
16051
16012
  interface TaxSettings$1 {
16052
- /**
16053
- * Tax application settings. Possible values:
16054
- * - `INCLUDED_IN_PRICE`: 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.
16055
- * - `ADDED_AT_CHECKOUT`: Show the fee iin 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.
16056
- */
16013
+ /** Tax application settings. */
16057
16014
  type?: TaxType$1;
16058
16015
  /** Tax name. */
16059
16016
  name?: string | null;
@@ -16062,12 +16019,13 @@ interface TaxSettings$1 {
16062
16019
  /** Apply tax to donations. */
16063
16020
  appliedToDonations?: boolean | null;
16064
16021
  }
16022
+ /** Tax application settings. */
16065
16023
  declare enum TaxType$1 {
16066
- /** Default value. This value is unused. */
16024
+ /** Unknown tax type. */
16067
16025
  UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
16068
- /** Tax is included in the ticket price */
16026
+ /** 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. */
16069
16027
  INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
16070
- /** Tax is added to the final total at the checkout */
16028
+ /** 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. */
16071
16029
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
16072
16030
  }
16073
16031
  interface ExternalRegistration$1 {
@@ -16075,19 +16033,19 @@ interface ExternalRegistration$1 {
16075
16033
  url?: string | null;
16076
16034
  }
16077
16035
  declare enum GuestTypeType$1 {
16078
- /** Default value. This value is unused */
16036
+ /** Unknown guest type. */
16079
16037
  UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
16080
- /** Site visitor or member */
16038
+ /** All site visitors can RSVP to the event. */
16081
16039
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
16082
- /** Site member */
16040
+ /** Only people who have signed up as members of your site are able to RSVP to the event. */
16083
16041
  MEMBER = "MEMBER"
16084
16042
  }
16085
16043
  declare enum InitialRegistrationTypeType$1 {
16086
- /** Default value. This value is unused */
16044
+ /** Unknown initial registration type. */
16087
16045
  UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
16088
- /** Registration via RSVP */
16046
+ /** Guests register by RSVPing to the event. */
16089
16047
  RSVP = "RSVP",
16090
- /** Registration via ticket purchase */
16048
+ /** Guests register by buying tickets. This property value never changes. */
16091
16049
  TICKETING = "TICKETING"
16092
16050
  }
16093
16051
  interface CommonImage {
@@ -16438,11 +16396,7 @@ interface OnlineConferencing$1 {
16438
16396
  enabled?: boolean;
16439
16397
  /** Conference host ID. */
16440
16398
  providerId?: string | null;
16441
- /**
16442
- * Conference type. Possible values:
16443
- * - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
16444
- * - `WEBINAR`: Guests can only watch the conference.
16445
- */
16399
+ /** Conference type. */
16446
16400
  type?: ConferenceTypeType$1;
16447
16401
  /** Online conferencing session information. */
16448
16402
  session?: OnlineConferencingSession$1;
@@ -16450,9 +16404,9 @@ interface OnlineConferencing$1 {
16450
16404
  declare enum ConferenceTypeType$1 {
16451
16405
  /** Default value. This value is unused */
16452
16406
  UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
16453
- /** Guests can publish and subscribe to video and audio. */
16407
+ /** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */
16454
16408
  MEETING = "MEETING",
16455
- /** Guests can only subscribe to video and audio. */
16409
+ /** Guests can only watch the conference. */
16456
16410
  WEBINAR = "WEBINAR"
16457
16411
  }
16458
16412
  interface OnlineConferencingSession$1 {
@@ -16571,44 +16525,33 @@ interface CreateEventRequest$1 {
16571
16525
  event: V3Event$1;
16572
16526
  /** Whether to create the event as a draft. */
16573
16527
  draft?: boolean;
16574
- /**
16575
- * Predefined sets of fields to return.
16576
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16577
- * - `TEXTS`: Returns `detailedDescription`.
16578
- * - `REGISTRATION`: Returns `registration`.
16579
- * - `URLS`: Returns `eventPageUrl`.
16580
- * - `FORM`: Returns `form`.
16581
- * - `DASHBOARD`: Returns `summaries`.
16582
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16583
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16584
- * - `AGENDA`: Returns `agendaSettings`.
16585
- * - `CATEGORIES`: Returns `categories`.
16586
- */
16528
+ /** Predefined sets of fields to return. */
16587
16529
  fields?: RequestedFields$1[];
16588
16530
  }
16589
16531
  declare enum RequestedFields$1 {
16532
+ /** Unknown requested field. */
16590
16533
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
16591
- /** Include `description`, `mainImage` and `calendarLinks` in the response. */
16534
+ /** Returns `shortDescription`, `mainImage` and `calendarUrls`. */
16592
16535
  DETAILS = "DETAILS",
16593
- /** Include `about` event rich text in the response. */
16536
+ /** Returns `detailedDescription`. */
16594
16537
  TEXTS = "TEXTS",
16595
- /** Include `registration` in the response. */
16538
+ /** Returns `registration`. */
16596
16539
  REGISTRATION = "REGISTRATION",
16597
- /** Include `eventPageUrl` in the response. */
16540
+ /** Returns `eventPageUrl`. */
16598
16541
  URLS = "URLS",
16599
- /** Include `form` in the response. */
16542
+ /** Returns `form`. */
16600
16543
  FORM = "FORM",
16601
- /** Include `dashboard` in the response. */
16544
+ /** Returns `summaries`. */
16602
16545
  DASHBOARD = "DASHBOARD",
16603
- /** Include `feed` in the response. */
16546
+ /** Returns `feed`. */
16604
16547
  FEED = "FEED",
16605
- /** Include `onlineConferencing` in the response. */
16548
+ /** Returns `onlineConferencing.session`. */
16606
16549
  ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
16607
- /** Include `seoSettings` in the response. */
16550
+ /** Returns `seoSettings`. */
16608
16551
  SEO_SETTINGS = "SEO_SETTINGS",
16609
- /** Include `agendaSettings` in the response. */
16552
+ /** Returns `agendaSettings`. */
16610
16553
  AGENDA = "AGENDA",
16611
- /** Include `categories` in the response. */
16554
+ /** Returns `categories`. */
16612
16555
  CATEGORIES = "CATEGORIES",
16613
16556
  CUSTOMIZABLE_TICKETS = "CUSTOMIZABLE_TICKETS"
16614
16557
  }
@@ -16623,19 +16566,7 @@ interface CloneEventRequest$1 {
16623
16566
  event?: V3Event$1;
16624
16567
  /** Whether to clone the event as a draft. */
16625
16568
  draft?: boolean;
16626
- /**
16627
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
16628
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16629
- * - `TEXTS`: Returns `detailedDescription`.
16630
- * - `REGISTRATION`: Returns `registration`.
16631
- * - `URLS`: Returns `eventPageUrl`.
16632
- * - `FORM`: Returns `form`.
16633
- * - `DASHBOARD`: Returns `summaries`.
16634
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16635
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16636
- * - `AGENDA`: Returns `agendaSettings`.
16637
- * - `CATEGORIES`: Returns `categories`.
16638
- */
16569
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
16639
16570
  fields?: RequestedFields$1[];
16640
16571
  }
16641
16572
  interface CloneEventResponse$1 {
@@ -16645,19 +16576,7 @@ interface CloneEventResponse$1 {
16645
16576
  interface UpdateEventRequest$1 {
16646
16577
  /** Field values to be changed. */
16647
16578
  event?: V3Event$1;
16648
- /**
16649
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
16650
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16651
- * - `TEXTS`: Returns `detailedDescription`.
16652
- * - `REGISTRATION`: Returns `registration`.
16653
- * - `URLS`: Returns `eventPageUrl`.
16654
- * - `FORM`: Returns `form`.
16655
- * - `DASHBOARD`: Returns `summaries`.
16656
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16657
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16658
- * - `AGENDA`: Returns `agendaSettings`.
16659
- * - `CATEGORIES`: Returns `categories`.
16660
- */
16579
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
16661
16580
  fields?: RequestedFields$1[];
16662
16581
  }
16663
16582
  interface UpdateEventResponse$1 {
@@ -16667,19 +16586,7 @@ interface UpdateEventResponse$1 {
16667
16586
  interface PublishDraftEventRequest$1 {
16668
16587
  /** Event ID. */
16669
16588
  eventId: string;
16670
- /**
16671
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
16672
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16673
- * - `TEXTS`: Returns `detailedDescription`.
16674
- * - `REGISTRATION`: Returns `registration`.
16675
- * - `URLS`: Returns `eventPageUrl`.
16676
- * - `FORM`: Returns `form`.
16677
- * - `DASHBOARD`: Returns `summaries`.
16678
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16679
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16680
- * - `AGENDA`: Returns `agendaSettings`.
16681
- * - `CATEGORIES`: Returns `categories`.
16682
- */
16589
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
16683
16590
  fields?: RequestedFields$1[];
16684
16591
  }
16685
16592
  interface PublishDraftEventResponse$1 {
@@ -16689,19 +16596,7 @@ interface PublishDraftEventResponse$1 {
16689
16596
  interface CancelEventRequest$1 {
16690
16597
  /** Event ID. */
16691
16598
  eventId: string;
16692
- /**
16693
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
16694
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16695
- * - `TEXTS`: Returns `detailedDescription`.
16696
- * - `REGISTRATION`: Returns `registration`.
16697
- * - `URLS`: Returns `eventPageUrl`.
16698
- * - `FORM`: Returns `form`.
16699
- * - `DASHBOARD`: Returns `summaries`.
16700
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16701
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16702
- * - `AGENDA`: Returns `agendaSettings`.
16703
- * - `CATEGORIES`: Returns `categories`.
16704
- */
16599
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
16705
16600
  fields?: RequestedFields$1[];
16706
16601
  }
16707
16602
  interface CancelEventResponse$1 {
@@ -16774,19 +16669,7 @@ interface BulkDeleteEventsByFilterResponse$1 {
16774
16669
  interface QueryEventsRequest$1 {
16775
16670
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
16776
16671
  query?: CommonQueryV2$1;
16777
- /**
16778
- * Predefined sets of fields to return.
16779
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16780
- * - `TEXTS`: Returns `detailedDescription`.
16781
- * - `REGISTRATION`: Returns `registration`.
16782
- * - `URLS`: Returns `eventPageUrl`.
16783
- * - `FORM`: Returns `form`.
16784
- * - `DASHBOARD`: Returns `summaries`.
16785
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16786
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16787
- * - `AGENDA`: Returns `agendaSettings`.
16788
- * - `CATEGORIES`: Returns `categories`.
16789
- */
16672
+ /** Predefined sets of fields to return. */
16790
16673
  fields?: RequestedFields$1[];
16791
16674
  /**
16792
16675
  * Whether draft events should be returned in the response. <br>
@@ -16842,19 +16725,6 @@ interface FacetCounts$3 {
16842
16725
  interface GetEventRequest$1 {
16843
16726
  /** Event ID. */
16844
16727
  eventId: string | null;
16845
- /**
16846
- * Predefined sets of fields to return.
16847
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16848
- * - `TEXTS`: Returns `detailedDescription`.
16849
- * - `REGISTRATION`: Returns `registration`.
16850
- * - `URLS`: Returns `eventPageUrl`.
16851
- * - `FORM`: Returns `form`.
16852
- * - `DASHBOARD`: Returns `summaries`.
16853
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16854
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16855
- * - `AGENDA`: Returns `agendaSettings`.
16856
- * - `CATEGORIES`: Returns `categories`.
16857
- */
16858
16728
  fields?: RequestedFields$1[];
16859
16729
  }
16860
16730
  interface GetEventResponse$1 {
@@ -16864,19 +16734,6 @@ interface GetEventResponse$1 {
16864
16734
  interface GetEventBySlugRequest$1 {
16865
16735
  /** URL slug. */
16866
16736
  slug: string | null;
16867
- /**
16868
- * Predefined sets of fields to return.
16869
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
16870
- * - `TEXTS`: Returns `detailedDescription`.
16871
- * - `REGISTRATION`: Returns `registration`.
16872
- * - `URLS`: Returns `eventPageUrl`.
16873
- * - `FORM`: Returns `form`.
16874
- * - `DASHBOARD`: Returns `summaries`.
16875
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
16876
- * - `SEO_SETTINGS`: Returns `seoSettings`.
16877
- * - `AGENDA`: Returns `agendaSettings`.
16878
- * - `CATEGORIES`: Returns `categories`.
16879
- */
16880
16737
  fields?: RequestedFields$1[];
16881
16738
  }
16882
16739
  interface GetEventBySlugResponse$1 {
@@ -17282,9 +17139,11 @@ interface Location$2 {
17282
17139
  locationTbd?: boolean | null;
17283
17140
  }
17284
17141
  declare enum LocationType$2 {
17285
- /** Default value. This value is unused. */
17142
+ /** Unknown location type. */
17286
17143
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
17144
+ /** Event is on-site at a specific physical location. */
17287
17145
  VENUE = "VENUE",
17146
+ /** Event is online, such as a virtual video conference. */
17288
17147
  ONLINE = "ONLINE"
17289
17148
  }
17290
17149
  /** Physical address */
@@ -17349,17 +17208,17 @@ interface DateAndTimeSettings$2 {
17349
17208
  formatted?: Formatted$2;
17350
17209
  }
17351
17210
  declare enum RecurrenceStatusStatus$2 {
17352
- /** Default value. This value is unused. */
17211
+ /** Unknown recurrance status. */
17353
17212
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
17354
- /** Event happens only once. */
17213
+ /** Event happens only once and can last multiple days. */
17355
17214
  ONE_TIME = "ONE_TIME",
17356
- /** Event is repeating and has a list of scheduled repetitions. */
17215
+ /** A series of events that repeat. */
17357
17216
  RECURRING = "RECURRING",
17358
- /** An upcoming event from the list of repetitions. */
17217
+ /** Next event in a schedule of recurring events. */
17359
17218
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
17360
- /** Latest ended event from the list of repetitions. */
17219
+ /** Latest event that ended in a schedule of recurring events. */
17361
17220
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
17362
- /** Latest cancelled event from the list of repetitions. */
17221
+ /** Latest canceled event in a schedule of recurring events */
17363
17222
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
17364
17223
  }
17365
17224
  interface Recurrences$2 {
@@ -17412,17 +17271,17 @@ interface Formatted$2 {
17412
17271
  endTime?: string | null;
17413
17272
  }
17414
17273
  declare enum Status$2 {
17415
- /** Default value. This value is unused */
17274
+ /** Unknown event status. */
17416
17275
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
17417
- /** Event is public and scheduled to start */
17276
+ /** Event is published and scheduled to start. */
17418
17277
  UPCOMING = "UPCOMING",
17419
- /** Event has started */
17278
+ /** Event has started. */
17420
17279
  STARTED = "STARTED",
17421
- /** Event has ended */
17280
+ /** Event has ended. */
17422
17281
  ENDED = "ENDED",
17423
- /** Event is canceled */
17282
+ /** Event is canceled. */
17424
17283
  CANCELED = "CANCELED",
17425
- /** Event is not public */
17284
+ /** Event is not public. */
17426
17285
  DRAFT = "DRAFT"
17427
17286
  }
17428
17287
  interface Registration {
@@ -17479,41 +17338,37 @@ interface Registration {
17479
17338
  registrationDisabled?: boolean;
17480
17339
  }
17481
17340
  declare enum RegistrationTypeType {
17482
- /** Default value. This value is unused */
17341
+ /** Unknown registration type. */
17483
17342
  UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
17484
- /** Registration via RSVP */
17343
+ /** Guests register by RSVPing to the event. */
17485
17344
  RSVP = "RSVP",
17486
- /** Registration via ticket purchase */
17345
+ /** Guests register by buying tickets. */
17487
17346
  TICKETING = "TICKETING",
17488
- /** External registration */
17347
+ /** Guests register externally using some other site or platform. */
17489
17348
  EXTERNAL = "EXTERNAL",
17490
- /** Registration not available */
17349
+ /** 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. */
17491
17350
  NONE = "NONE"
17492
17351
  }
17493
17352
  declare enum RegistrationStatusStatus {
17494
17353
  /** Registration status is not applicable */
17495
17354
  UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
17496
- /** Registration to event is closed */
17355
+ /** Registration is closed after tickets are sold out. */
17497
17356
  CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
17498
- /** Registration to event is closed manually */
17357
+ /** Registration is closed when the `registration.registrationDisabled` property is set to `true`. */
17499
17358
  CLOSED_MANUALLY = "CLOSED_MANUALLY",
17500
- /** Registration is open via RSVP */
17359
+ /** Guests can start RSVPing to the event. */
17501
17360
  OPEN_RSVP = "OPEN_RSVP",
17502
- /** Registration to event waitlist is open via RSVP */
17361
+ /** Guest list has reached the maximum, new guests are added to a waitlist. */
17503
17362
  OPEN_RSVP_WAITLIST_ONLY = "OPEN_RSVP_WAITLIST_ONLY",
17504
- /** Registration is open via ticket purchase */
17363
+ /** Guests can buy tickets to the event. */
17505
17364
  OPEN_TICKETS = "OPEN_TICKETS",
17506
- /** Registration is open via external URL */
17365
+ /** Guests register on a different page or web address. */
17507
17366
  OPEN_EXTERNAL = "OPEN_EXTERNAL",
17508
- /** Registration will be open via RSVP */
17367
+ /** Registration via RSVP is scheduled for the future. */
17509
17368
  SCHEDULED_RSVP = "SCHEDULED_RSVP"
17510
17369
  }
17511
17370
  interface RsvpRegistration {
17512
- /**
17513
- * Available answers for registration to an event. Possible values:
17514
- * - `YES_ONLY`: Only a **Yes** answer is available to select when RSVP'ing to an event.
17515
- * - `YES_AND_NO`: Both **Yes** and **No** answers are available to select when RSVP'ing to an event.
17516
- */
17371
+ /** Available answers for registration to an event. */
17517
17372
  responseType?: ResponseType;
17518
17373
  /** How many guests can RSVP to an event. */
17519
17374
  limit?: number | null;
@@ -17525,11 +17380,11 @@ interface RsvpRegistration {
17525
17380
  endDate?: Date | null;
17526
17381
  }
17527
17382
  declare enum ResponseType {
17528
- /** Default value. This value is unused. */
17383
+ /** Unknown response type. */
17529
17384
  UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
17530
- /** Only a **Yes** answer is available for the registration. */
17385
+ /** Only a **Yes** answer is available to select when RSVP'ing to an event. */
17531
17386
  YES_ONLY = "YES_ONLY",
17532
- /** *Yes** and **No** answers are available for the registration. */
17387
+ /** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
17533
17388
  YES_AND_NO = "YES_AND_NO"
17534
17389
  }
17535
17390
  interface TicketsRegistration {
@@ -17590,12 +17445,13 @@ interface TaxSettings {
17590
17445
  /** Apply tax to donations. */
17591
17446
  appliedToDonations?: boolean | null;
17592
17447
  }
17448
+ /** Tax application settings. */
17593
17449
  declare enum TaxType {
17594
- /** Default value. This value is unused. */
17450
+ /** Unknown tax type. */
17595
17451
  UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
17596
- /** Tax is included in the ticket price */
17452
+ /** 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. */
17597
17453
  INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
17598
- /** Tax is added to the final total at the checkout */
17454
+ /** 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. */
17599
17455
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
17600
17456
  }
17601
17457
  interface ExternalRegistration {
@@ -17603,19 +17459,19 @@ interface ExternalRegistration {
17603
17459
  url?: string | null;
17604
17460
  }
17605
17461
  declare enum GuestTypeType {
17606
- /** Default value. This value is unused */
17462
+ /** Unknown guest type. */
17607
17463
  UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
17608
- /** Site visitor or member */
17464
+ /** All site visitors can RSVP to the event. */
17609
17465
  VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
17610
- /** Site member */
17466
+ /** Only people who have signed up as members of your site are able to RSVP to the event. */
17611
17467
  MEMBER = "MEMBER"
17612
17468
  }
17613
17469
  declare enum InitialRegistrationTypeType {
17614
- /** Default value. This value is unused */
17470
+ /** Unknown initial registration type. */
17615
17471
  UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
17616
- /** Registration via RSVP */
17472
+ /** Guests register by RSVPing to the event. */
17617
17473
  RSVP = "RSVP",
17618
- /** Registration via ticket purchase */
17474
+ /** Guests register by buying tickets. This property value never changes. */
17619
17475
  TICKETING = "TICKETING"
17620
17476
  }
17621
17477
  interface CalendarUrls {
@@ -17959,9 +17815,9 @@ interface OnlineConferencing {
17959
17815
  declare enum ConferenceTypeType {
17960
17816
  /** Default value. This value is unused */
17961
17817
  UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
17962
- /** Guests can publish and subscribe to video and audio. */
17818
+ /** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */
17963
17819
  MEETING = "MEETING",
17964
- /** Guests can only subscribe to video and audio. */
17820
+ /** Guests can only watch the conference. */
17965
17821
  WEBINAR = "WEBINAR"
17966
17822
  }
17967
17823
  interface OnlineConferencingSession {
@@ -18080,44 +17936,33 @@ interface CreateEventRequest {
18080
17936
  event: V3Event;
18081
17937
  /** Whether to create the event as a draft. */
18082
17938
  draft?: boolean;
18083
- /**
18084
- * Predefined sets of fields to return.
18085
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18086
- * - `TEXTS`: Returns `detailedDescription`.
18087
- * - `REGISTRATION`: Returns `registration`.
18088
- * - `URLS`: Returns `eventPageUrl`.
18089
- * - `FORM`: Returns `form`.
18090
- * - `DASHBOARD`: Returns `summaries`.
18091
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18092
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18093
- * - `AGENDA`: Returns `agendaSettings`.
18094
- * - `CATEGORIES`: Returns `categories`.
18095
- */
17939
+ /** Predefined sets of fields to return. */
18096
17940
  fields?: RequestedFields[];
18097
17941
  }
18098
17942
  declare enum RequestedFields {
17943
+ /** Unknown requested field. */
18099
17944
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
18100
- /** Include `description`, `mainImage` and `calendarLinks` in the response. */
17945
+ /** Returns `shortDescription`, `mainImage` and `calendarUrls`. */
18101
17946
  DETAILS = "DETAILS",
18102
- /** Include `about` event rich text in the response. */
17947
+ /** Returns `detailedDescription`. */
18103
17948
  TEXTS = "TEXTS",
18104
- /** Include `registration` in the response. */
17949
+ /** Returns `registration`. */
18105
17950
  REGISTRATION = "REGISTRATION",
18106
- /** Include `eventPageUrl` in the response. */
17951
+ /** Returns `eventPageUrl`. */
18107
17952
  URLS = "URLS",
18108
- /** Include `form` in the response. */
17953
+ /** Returns `form`. */
18109
17954
  FORM = "FORM",
18110
- /** Include `dashboard` in the response. */
17955
+ /** Returns `summaries`. */
18111
17956
  DASHBOARD = "DASHBOARD",
18112
- /** Include `feed` in the response. */
17957
+ /** Returns `feed`. */
18113
17958
  FEED = "FEED",
18114
- /** Include `onlineConferencing` in the response. */
17959
+ /** Returns `onlineConferencing.session`. */
18115
17960
  ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
18116
- /** Include `seoSettings` in the response. */
17961
+ /** Returns `seoSettings`. */
18117
17962
  SEO_SETTINGS = "SEO_SETTINGS",
18118
- /** Include `agendaSettings` in the response. */
17963
+ /** Returns `agendaSettings`. */
18119
17964
  AGENDA = "AGENDA",
18120
- /** Include `categories` in the response. */
17965
+ /** Returns `categories`. */
18121
17966
  CATEGORIES = "CATEGORIES",
18122
17967
  CUSTOMIZABLE_TICKETS = "CUSTOMIZABLE_TICKETS"
18123
17968
  }
@@ -18132,19 +17977,7 @@ interface CloneEventRequest {
18132
17977
  event?: V3Event;
18133
17978
  /** Whether to clone the event as a draft. */
18134
17979
  draft?: boolean;
18135
- /**
18136
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
18137
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18138
- * - `TEXTS`: Returns `detailedDescription`.
18139
- * - `REGISTRATION`: Returns `registration`.
18140
- * - `URLS`: Returns `eventPageUrl`.
18141
- * - `FORM`: Returns `form`.
18142
- * - `DASHBOARD`: Returns `summaries`.
18143
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18144
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18145
- * - `AGENDA`: Returns `agendaSettings`.
18146
- * - `CATEGORIES`: Returns `categories`.
18147
- */
17980
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
18148
17981
  fields?: RequestedFields[];
18149
17982
  }
18150
17983
  interface CloneEventResponse {
@@ -18154,19 +17987,7 @@ interface CloneEventResponse {
18154
17987
  interface UpdateEventRequest {
18155
17988
  /** Field values to be changed. */
18156
17989
  event?: V3Event;
18157
- /**
18158
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
18159
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18160
- * - `TEXTS`: Returns `detailedDescription`.
18161
- * - `REGISTRATION`: Returns `registration`.
18162
- * - `URLS`: Returns `eventPageUrl`.
18163
- * - `FORM`: Returns `form`.
18164
- * - `DASHBOARD`: Returns `summaries`.
18165
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18166
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18167
- * - `AGENDA`: Returns `agendaSettings`.
18168
- * - `CATEGORIES`: Returns `categories`.
18169
- */
17990
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
18170
17991
  fields?: RequestedFields[];
18171
17992
  }
18172
17993
  interface UpdateEventResponse {
@@ -18176,19 +17997,7 @@ interface UpdateEventResponse {
18176
17997
  interface PublishDraftEventRequest {
18177
17998
  /** Event ID. */
18178
17999
  eventId: string;
18179
- /**
18180
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
18181
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18182
- * - `TEXTS`: Returns `detailedDescription`.
18183
- * - `REGISTRATION`: Returns `registration`.
18184
- * - `URLS`: Returns `eventPageUrl`.
18185
- * - `FORM`: Returns `form`.
18186
- * - `DASHBOARD`: Returns `summaries`.
18187
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18188
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18189
- * - `AGENDA`: Returns `agendaSettings`.
18190
- * - `CATEGORIES`: Returns `categories`.
18191
- */
18000
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
18192
18001
  fields?: RequestedFields[];
18193
18002
  }
18194
18003
  interface PublishDraftEventResponse {
@@ -18198,19 +18007,7 @@ interface PublishDraftEventResponse {
18198
18007
  interface CancelEventRequest {
18199
18008
  /** Event ID. */
18200
18009
  eventId: string;
18201
- /**
18202
- * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
18203
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18204
- * - `TEXTS`: Returns `detailedDescription`.
18205
- * - `REGISTRATION`: Returns `registration`.
18206
- * - `URLS`: Returns `eventPageUrl`.
18207
- * - `FORM`: Returns `form`.
18208
- * - `DASHBOARD`: Returns `summaries`.
18209
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18210
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18211
- * - `AGENDA`: Returns `agendaSettings`.
18212
- * - `CATEGORIES`: Returns `categories`.
18213
- */
18010
+ /** Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned. */
18214
18011
  fields?: RequestedFields[];
18215
18012
  }
18216
18013
  interface CancelEventResponse {
@@ -18283,19 +18080,7 @@ interface BulkDeleteEventsByFilterResponse {
18283
18080
  interface QueryEventsRequest {
18284
18081
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
18285
18082
  query?: CommonQueryV2;
18286
- /**
18287
- * Predefined sets of fields to return.
18288
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18289
- * - `TEXTS`: Returns `detailedDescription`.
18290
- * - `REGISTRATION`: Returns `registration`.
18291
- * - `URLS`: Returns `eventPageUrl`.
18292
- * - `FORM`: Returns `form`.
18293
- * - `DASHBOARD`: Returns `summaries`.
18294
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18295
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18296
- * - `AGENDA`: Returns `agendaSettings`.
18297
- * - `CATEGORIES`: Returns `categories`.
18298
- */
18083
+ /** Predefined sets of fields to return. */
18299
18084
  fields?: RequestedFields[];
18300
18085
  /**
18301
18086
  * Whether draft events should be returned in the response. <br>
@@ -18351,19 +18136,6 @@ interface FacetCounts$2 {
18351
18136
  interface GetEventRequest {
18352
18137
  /** Event ID. */
18353
18138
  eventId: string | null;
18354
- /**
18355
- * Predefined sets of fields to return.
18356
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18357
- * - `TEXTS`: Returns `detailedDescription`.
18358
- * - `REGISTRATION`: Returns `registration`.
18359
- * - `URLS`: Returns `eventPageUrl`.
18360
- * - `FORM`: Returns `form`.
18361
- * - `DASHBOARD`: Returns `summaries`.
18362
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18363
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18364
- * - `AGENDA`: Returns `agendaSettings`.
18365
- * - `CATEGORIES`: Returns `categories`.
18366
- */
18367
18139
  fields?: RequestedFields[];
18368
18140
  }
18369
18141
  interface GetEventResponse {
@@ -18373,19 +18145,6 @@ interface GetEventResponse {
18373
18145
  interface GetEventBySlugRequest {
18374
18146
  /** URL slug. */
18375
18147
  slug: string | null;
18376
- /**
18377
- * Predefined sets of fields to return.
18378
- * - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
18379
- * - `TEXTS`: Returns `detailedDescription`.
18380
- * - `REGISTRATION`: Returns `registration`.
18381
- * - `URLS`: Returns `eventPageUrl`.
18382
- * - `FORM`: Returns `form`.
18383
- * - `DASHBOARD`: Returns `summaries`.
18384
- * - `ONLINE_CONFERENCING_SESSION`: Returns `onlineConferencing.session`.
18385
- * - `SEO_SETTINGS`: Returns `seoSettings`.
18386
- * - `AGENDA`: Returns `agendaSettings`.
18387
- * - `CATEGORIES`: Returns `categories`.
18388
- */
18389
18148
  fields?: RequestedFields[];
18390
18149
  }
18391
18150
  interface GetEventBySlugResponse {
@@ -18749,19 +18508,12 @@ interface TicketDefinition$1 {
18749
18508
  actualLimit?: number | null;
18750
18509
  /** Ticket pricing method. */
18751
18510
  pricingMethod?: PricingMethod$1;
18752
- /**
18753
- * Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:
18754
- * - `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.
18755
- * - `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.
18756
- */
18511
+ /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
18757
18512
  feeType?: Type$1;
18758
18513
  /** Ticket sale period. */
18759
18514
  salePeriod?: SalePeriod$1;
18760
18515
  /**
18761
- * Ticket sale status. Possible values:
18762
- * - `SALE_SCHEDULED`: Tickets are not on sale yet.
18763
- * - `SALE_STARTED`: Tickets are on sale.
18764
- * - `SALE_ENDED`: Tickets are not on sale.
18516
+ * Ticket sale status.
18765
18517
  * @readonly
18766
18518
  */
18767
18519
  saleStatus?: SaleStatusEnumStatus$1;
@@ -18800,9 +18552,7 @@ interface PricingMethod$1 extends PricingMethodPriceOneOf$1 {
18800
18552
  /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
18801
18553
  pricingOptions?: PricingOptions$1;
18802
18554
  /**
18803
- * Ticket price type. Possible values:
18804
- * - `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`.
18805
- * - `DONATION`: All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method.
18555
+ * Ticket price type.
18806
18556
  * @readonly
18807
18557
  */
18808
18558
  pricingType?: PricingTypeEnumType$1;
@@ -18844,26 +18594,31 @@ interface OptionDetails$1 {
18844
18594
  price?: CommonMoney$1;
18845
18595
  }
18846
18596
  declare enum PricingTypeEnumType$1 {
18597
+ /** Undefined pricing type. */
18847
18598
  UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
18599
+ /** All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. */
18848
18600
  STANDARD = "STANDARD",
18601
+ /** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */
18849
18602
  DONATION = "DONATION"
18850
18603
  }
18851
18604
  declare enum Type$1 {
18605
+ /** Unknown fee type. */
18852
18606
  UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
18853
- /** Seller absorbs the fee. It is deducted from the ticket price. */
18607
+ /** 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. */
18854
18608
  FEE_INCLUDED = "FEE_INCLUDED",
18855
- /** Fee is added to the ticket price at checkout. */
18609
+ /** 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. */
18856
18610
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
18857
- /** Service fee is not collected - available only for free tickets and legacy users. */
18611
+ /** Service fee is not collected. Available only for free tickets and legacy users. */
18858
18612
  NO_FEE = "NO_FEE"
18859
18613
  }
18860
18614
  declare enum SaleStatusEnumStatus$1 {
18615
+ /** Undefined sale status. */
18861
18616
  UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
18862
- /** Ticket sale is scheduled to start */
18617
+ /** Tickets are not on sale yet. */
18863
18618
  SALE_SCHEDULED = "SALE_SCHEDULED",
18864
- /** Ticket sale has started */
18619
+ /** Tickets are on sale. */
18865
18620
  SALE_STARTED = "SALE_STARTED",
18866
- /** Ticket sale has ended */
18621
+ /** Tickets are not on sale. */
18867
18622
  SALE_ENDED = "SALE_ENDED"
18868
18623
  }
18869
18624
  interface SalesDetails$1 {
@@ -18934,11 +18689,7 @@ interface EventDetails$1 {
18934
18689
  interface Location$1 {
18935
18690
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
18936
18691
  name?: string | null;
18937
- /**
18938
- * Location type. Possible values:
18939
- * - `VENUE`: Event is on-site at a specific physical location.
18940
- * - `ONLINE`: Event is online, such as a virtual video conference.
18941
- */
18692
+ /** Location type. */
18942
18693
  type?: LocationType$1;
18943
18694
  /** Exact location address. */
18944
18695
  address?: CommonAddress$1;
@@ -18946,9 +18697,11 @@ interface Location$1 {
18946
18697
  locationTbd?: boolean | null;
18947
18698
  }
18948
18699
  declare enum LocationType$1 {
18949
- /** Default value. This value is unused. */
18700
+ /** Unknown location type. */
18950
18701
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
18702
+ /** Event is on-site at a specific physical location. */
18951
18703
  VENUE = "VENUE",
18704
+ /** Event is online, such as a virtual video conference. */
18952
18705
  ONLINE = "ONLINE"
18953
18706
  }
18954
18707
  /** Physical address */
@@ -19012,12 +18765,7 @@ interface DateAndTimeSettings$1 {
19012
18765
  /** Whether the time zone is displayed in the formatted schedule. */
19013
18766
  showTimeZone?: boolean | null;
19014
18767
  /**
19015
- * Repeating event status. Possible values:
19016
- * - `ONE_TIME`: Event happens only once and can last multiple days.
19017
- * - `RECURRING`: A series of events that repeat.
19018
- * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
19019
- * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
19020
- * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
18768
+ * Repeating event status.
19021
18769
  * @readonly
19022
18770
  */
19023
18771
  recurrenceStatus?: RecurrenceStatusStatus$1;
@@ -19027,17 +18775,17 @@ interface DateAndTimeSettings$1 {
19027
18775
  formatted?: Formatted$1;
19028
18776
  }
19029
18777
  declare enum RecurrenceStatusStatus$1 {
19030
- /** Default value. This value is unused. */
18778
+ /** Unknown recurrance status. */
19031
18779
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
19032
- /** Event happens only once. */
18780
+ /** Event happens only once and can last multiple days. */
19033
18781
  ONE_TIME = "ONE_TIME",
19034
- /** Event is repeating and has a list of scheduled repetitions. */
18782
+ /** A series of events that repeat. */
19035
18783
  RECURRING = "RECURRING",
19036
- /** An upcoming event from the list of repetitions. */
18784
+ /** Next event in a schedule of recurring events. */
19037
18785
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
19038
- /** Latest ended event from the list of repetitions. */
18786
+ /** Latest event that ended in a schedule of recurring events. */
19039
18787
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
19040
- /** Latest cancelled event from the list of repetitions. */
18788
+ /** Latest canceled event in a schedule of recurring events */
19041
18789
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
19042
18790
  }
19043
18791
  interface Recurrences$1 {
@@ -19095,33 +18843,31 @@ interface PageUrl {
19095
18843
  path?: string;
19096
18844
  }
19097
18845
  declare enum Status$1 {
19098
- /** Default value. This value is unused */
18846
+ /** Unknown event status. */
19099
18847
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
19100
- /** Event is public and scheduled to start */
18848
+ /** Event is published and scheduled to start. */
19101
18849
  UPCOMING = "UPCOMING",
19102
- /** Event has started */
18850
+ /** Event has started. */
19103
18851
  STARTED = "STARTED",
19104
- /** Event has ended */
18852
+ /** Event has ended. */
19105
18853
  ENDED = "ENDED",
19106
- /** Event is canceled */
18854
+ /** Event is canceled. */
19107
18855
  CANCELED = "CANCELED",
19108
- /** Event is not public */
18856
+ /** Event is not public. */
19109
18857
  DRAFT = "DRAFT"
19110
18858
  }
19111
18859
  interface CreateTicketDefinitionRequest$1 {
19112
18860
  /** Ticket definition info. */
19113
18861
  ticketDefinition: TicketDefinition$1;
19114
- /**
19115
- * Predefined sets of fields to return.
19116
- * - `SALES_DETAILS`: Returns `salesDetails`.
19117
- */
18862
+ /** Predefined sets of fields to return. */
19118
18863
  fields?: Field$1[];
19119
18864
  }
19120
18865
  declare enum Field$1 {
18866
+ /** Unknown requested field. */
19121
18867
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
19122
- /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
18868
+ /** Returns `salesDetails` in the response. */
19123
18869
  SALES_DETAILS = "SALES_DETAILS",
19124
- /** Include `eventDetails`. */
18870
+ /** Returns `eventDetails` in the response. */
19125
18871
  EVENT_DETAILS = "EVENT_DETAILS"
19126
18872
  }
19127
18873
  interface CreateTicketDefinitionResponse$1 {
@@ -19131,10 +18877,7 @@ interface CreateTicketDefinitionResponse$1 {
19131
18877
  interface UpdateTicketDefinitionRequest$1 {
19132
18878
  /** Ticket definition to update. */
19133
18879
  ticketDefinition: TicketDefinition$1;
19134
- /**
19135
- * Predefined sets of fields to return.
19136
- * - `SALES_DETAILS`: Returns `salesDetails`.
19137
- */
18880
+ /** Predefined sets of fields to return. */
19138
18881
  fields?: Field$1[];
19139
18882
  }
19140
18883
  interface UpdateTicketDefinitionResponse$1 {
@@ -19144,10 +18887,7 @@ interface UpdateTicketDefinitionResponse$1 {
19144
18887
  interface GetTicketDefinitionRequest$1 {
19145
18888
  /** Ticket definition ID. */
19146
18889
  ticketDefinitionId: string;
19147
- /**
19148
- * Predefined sets of fields to return.
19149
- * - `SALES_DETAILS`: Returns `salesDetails`.
19150
- */
18890
+ /** Predefined sets of fields to return. */
19151
18891
  fields?: Field$1[];
19152
18892
  }
19153
18893
  interface GetTicketDefinitionResponse$1 {
@@ -19182,10 +18922,7 @@ interface ReorderTicketDefinitionsResponse$1 {
19182
18922
  interface QueryTicketDefinitionsRequest$1 {
19183
18923
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
19184
18924
  query: QueryV2$1;
19185
- /**
19186
- * Predefined sets of fields to return.
19187
- * - `SALES_DETAILS`: Returns `salesDetails`.
19188
- */
18925
+ /** Predefined sets of fields to return. */
19189
18926
  fields?: Field$1[];
19190
18927
  }
19191
18928
  interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
@@ -19259,10 +18996,7 @@ interface Cursors$1 {
19259
18996
  interface QueryAvailableTicketDefinitionsRequest$1 {
19260
18997
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
19261
18998
  query: QueryV2$1;
19262
- /**
19263
- * Predefined sets of fields to return.
19264
- * - `SALES_DETAILS`: Returns `salesDetails`.
19265
- */
18999
+ /** Predefined sets of fields to return. */
19266
19000
  fields?: Field$1[];
19267
19001
  }
19268
19002
  interface QueryAvailableTicketDefinitionsResponse$1 {
@@ -19442,19 +19176,12 @@ interface TicketDefinition {
19442
19176
  actualLimit?: number | null;
19443
19177
  /** Ticket pricing method. */
19444
19178
  pricingMethod?: PricingMethod;
19445
- /**
19446
- * Whether fee is included in the ticket price or customer pays it additionally at checkout. Possible values:
19447
- * - `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.
19448
- * - `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.
19449
- */
19179
+ /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
19450
19180
  feeType?: Type;
19451
19181
  /** Ticket sale period. */
19452
19182
  salePeriod?: SalePeriod;
19453
19183
  /**
19454
- * Ticket sale status. Possible values:
19455
- * - `SALE_SCHEDULED`: Tickets are not on sale yet.
19456
- * - `SALE_STARTED`: Tickets are on sale.
19457
- * - `SALE_ENDED`: Tickets are not on sale.
19184
+ * Ticket sale status.
19458
19185
  * @readonly
19459
19186
  */
19460
19187
  saleStatus?: SaleStatusEnumStatus;
@@ -19493,9 +19220,7 @@ interface PricingMethod extends PricingMethodPriceOneOf {
19493
19220
  /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
19494
19221
  pricingOptions?: PricingOptions;
19495
19222
  /**
19496
- * Ticket price type. Possible values:
19497
- * - `STANDARD`: All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`.
19498
- * - `DONATION`: All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method.
19223
+ * Ticket price type.
19499
19224
  * @readonly
19500
19225
  */
19501
19226
  pricingType?: PricingTypeEnumType;
@@ -19537,26 +19262,31 @@ interface OptionDetails {
19537
19262
  price?: CommonMoney;
19538
19263
  }
19539
19264
  declare enum PricingTypeEnumType {
19265
+ /** Undefined pricing type. */
19540
19266
  UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
19267
+ /** All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. */
19541
19268
  STANDARD = "STANDARD",
19269
+ /** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */
19542
19270
  DONATION = "DONATION"
19543
19271
  }
19544
19272
  declare enum Type {
19273
+ /** Unknown fee type. */
19545
19274
  UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
19546
- /** Seller absorbs the fee. It is deducted from the ticket price. */
19275
+ /** 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. */
19547
19276
  FEE_INCLUDED = "FEE_INCLUDED",
19548
- /** Fee is added to the ticket price at checkout. */
19277
+ /** 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. */
19549
19278
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
19550
- /** Service fee is not collected - available only for free tickets and legacy users. */
19279
+ /** Service fee is not collected. Available only for free tickets and legacy users. */
19551
19280
  NO_FEE = "NO_FEE"
19552
19281
  }
19553
19282
  declare enum SaleStatusEnumStatus {
19283
+ /** Undefined sale status. */
19554
19284
  UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
19555
- /** Ticket sale is scheduled to start */
19285
+ /** Tickets are not on sale yet. */
19556
19286
  SALE_SCHEDULED = "SALE_SCHEDULED",
19557
- /** Ticket sale has started */
19287
+ /** Tickets are on sale. */
19558
19288
  SALE_STARTED = "SALE_STARTED",
19559
- /** Ticket sale has ended */
19289
+ /** Tickets are not on sale. */
19560
19290
  SALE_ENDED = "SALE_ENDED"
19561
19291
  }
19562
19292
  interface SalesDetails {
@@ -19627,11 +19357,7 @@ interface EventDetails {
19627
19357
  interface Location {
19628
19358
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
19629
19359
  name?: string | null;
19630
- /**
19631
- * Location type. Possible values:
19632
- * - `VENUE`: Event is on-site at a specific physical location.
19633
- * - `ONLINE`: Event is online, such as a virtual video conference.
19634
- */
19360
+ /** Location type. */
19635
19361
  type?: LocationType;
19636
19362
  /** Exact location address. */
19637
19363
  address?: CommonAddress;
@@ -19639,9 +19365,11 @@ interface Location {
19639
19365
  locationTbd?: boolean | null;
19640
19366
  }
19641
19367
  declare enum LocationType {
19642
- /** Default value. This value is unused. */
19368
+ /** Unknown location type. */
19643
19369
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
19370
+ /** Event is on-site at a specific physical location. */
19644
19371
  VENUE = "VENUE",
19372
+ /** Event is online, such as a virtual video conference. */
19645
19373
  ONLINE = "ONLINE"
19646
19374
  }
19647
19375
  /** Physical address */
@@ -19690,12 +19418,7 @@ interface DateAndTimeSettings {
19690
19418
  /** Whether the time zone is displayed in the formatted schedule. */
19691
19419
  showTimeZone?: boolean | null;
19692
19420
  /**
19693
- * Repeating event status. Possible values:
19694
- * - `ONE_TIME`: Event happens only once and can last multiple days.
19695
- * - `RECURRING`: A series of events that repeat.
19696
- * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
19697
- * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
19698
- * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
19421
+ * Repeating event status.
19699
19422
  * @readonly
19700
19423
  */
19701
19424
  recurrenceStatus?: RecurrenceStatusStatus;
@@ -19705,17 +19428,17 @@ interface DateAndTimeSettings {
19705
19428
  formatted?: Formatted;
19706
19429
  }
19707
19430
  declare enum RecurrenceStatusStatus {
19708
- /** Default value. This value is unused. */
19431
+ /** Unknown recurrance status. */
19709
19432
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
19710
- /** Event happens only once. */
19433
+ /** Event happens only once and can last multiple days. */
19711
19434
  ONE_TIME = "ONE_TIME",
19712
- /** Event is repeating and has a list of scheduled repetitions. */
19435
+ /** A series of events that repeat. */
19713
19436
  RECURRING = "RECURRING",
19714
- /** An upcoming event from the list of repetitions. */
19437
+ /** Next event in a schedule of recurring events. */
19715
19438
  RECURRING_UPCOMING = "RECURRING_UPCOMING",
19716
- /** Latest ended event from the list of repetitions. */
19439
+ /** Latest event that ended in a schedule of recurring events. */
19717
19440
  RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
19718
- /** Latest cancelled event from the list of repetitions. */
19441
+ /** Latest canceled event in a schedule of recurring events */
19719
19442
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
19720
19443
  }
19721
19444
  interface Recurrences {
@@ -19767,33 +19490,31 @@ interface Formatted {
19767
19490
  endTime?: string | null;
19768
19491
  }
19769
19492
  declare enum Status {
19770
- /** Default value. This value is unused */
19493
+ /** Unknown event status. */
19771
19494
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
19772
- /** Event is public and scheduled to start */
19495
+ /** Event is published and scheduled to start. */
19773
19496
  UPCOMING = "UPCOMING",
19774
- /** Event has started */
19497
+ /** Event has started. */
19775
19498
  STARTED = "STARTED",
19776
- /** Event has ended */
19499
+ /** Event has ended. */
19777
19500
  ENDED = "ENDED",
19778
- /** Event is canceled */
19501
+ /** Event is canceled. */
19779
19502
  CANCELED = "CANCELED",
19780
- /** Event is not public */
19503
+ /** Event is not public. */
19781
19504
  DRAFT = "DRAFT"
19782
19505
  }
19783
19506
  interface CreateTicketDefinitionRequest {
19784
19507
  /** Ticket definition info. */
19785
19508
  ticketDefinition: TicketDefinition;
19786
- /**
19787
- * Predefined sets of fields to return.
19788
- * - `SALES_DETAILS`: Returns `salesDetails`.
19789
- */
19509
+ /** Predefined sets of fields to return. */
19790
19510
  fields?: Field[];
19791
19511
  }
19792
19512
  declare enum Field {
19513
+ /** Unknown requested field. */
19793
19514
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
19794
- /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
19515
+ /** Returns `salesDetails` in the response. */
19795
19516
  SALES_DETAILS = "SALES_DETAILS",
19796
- /** Include `eventDetails`. */
19517
+ /** Returns `eventDetails` in the response. */
19797
19518
  EVENT_DETAILS = "EVENT_DETAILS"
19798
19519
  }
19799
19520
  interface CreateTicketDefinitionResponse {
@@ -19803,10 +19524,7 @@ interface CreateTicketDefinitionResponse {
19803
19524
  interface UpdateTicketDefinitionRequest {
19804
19525
  /** Ticket definition to update. */
19805
19526
  ticketDefinition: TicketDefinition;
19806
- /**
19807
- * Predefined sets of fields to return.
19808
- * - `SALES_DETAILS`: Returns `salesDetails`.
19809
- */
19527
+ /** Predefined sets of fields to return. */
19810
19528
  fields?: Field[];
19811
19529
  }
19812
19530
  interface UpdateTicketDefinitionResponse {
@@ -19816,10 +19534,7 @@ interface UpdateTicketDefinitionResponse {
19816
19534
  interface GetTicketDefinitionRequest {
19817
19535
  /** Ticket definition ID. */
19818
19536
  ticketDefinitionId: string;
19819
- /**
19820
- * Predefined sets of fields to return.
19821
- * - `SALES_DETAILS`: Returns `salesDetails`.
19822
- */
19537
+ /** Predefined sets of fields to return. */
19823
19538
  fields?: Field[];
19824
19539
  }
19825
19540
  interface GetTicketDefinitionResponse {
@@ -19854,10 +19569,7 @@ interface ReorderTicketDefinitionsResponse {
19854
19569
  interface QueryTicketDefinitionsRequest {
19855
19570
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
19856
19571
  query: QueryV2;
19857
- /**
19858
- * Predefined sets of fields to return.
19859
- * - `SALES_DETAILS`: Returns `salesDetails`.
19860
- */
19572
+ /** Predefined sets of fields to return. */
19861
19573
  fields?: Field[];
19862
19574
  }
19863
19575
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -19931,10 +19643,7 @@ interface Cursors {
19931
19643
  interface QueryAvailableTicketDefinitionsRequest {
19932
19644
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
19933
19645
  query: QueryV2;
19934
- /**
19935
- * Predefined sets of fields to return.
19936
- * - `SALES_DETAILS`: Returns `salesDetails`.
19937
- */
19646
+ /** Predefined sets of fields to return. */
19938
19647
  fields?: Field[];
19939
19648
  }
19940
19649
  interface QueryAvailableTicketDefinitionsResponse {