@wix/auto_sdk_events_ticket-definitions-v-2 1.0.23 → 1.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +186 -68
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +200 -82
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +186 -68
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +200 -82
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +186 -68
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +200 -82
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +186 -68
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +200 -82
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/package.json +3 -3
package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts
CHANGED
|
@@ -60,14 +60,14 @@ export interface TicketDefinition {
|
|
|
60
60
|
/** Ticket pricing method. */
|
|
61
61
|
pricingMethod?: PricingMethod;
|
|
62
62
|
/** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
|
|
63
|
-
feeType?:
|
|
63
|
+
feeType?: FeeTypeEnumTypeWithLiterals;
|
|
64
64
|
/** Ticket sale period. */
|
|
65
65
|
salePeriod?: SalePeriod;
|
|
66
66
|
/**
|
|
67
67
|
* Ticket sale status.
|
|
68
68
|
* @readonly
|
|
69
69
|
*/
|
|
70
|
-
saleStatus?:
|
|
70
|
+
saleStatus?: SaleStatusEnumStatusWithLiterals;
|
|
71
71
|
/**
|
|
72
72
|
* Ticket sales information. <br>
|
|
73
73
|
* **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.
|
|
@@ -107,7 +107,7 @@ export interface PricingMethod extends PricingMethodPriceOneOf {
|
|
|
107
107
|
* Ticket price type.
|
|
108
108
|
* @readonly
|
|
109
109
|
*/
|
|
110
|
-
pricingType?:
|
|
110
|
+
pricingType?: PricingTypeEnumTypeWithLiterals;
|
|
111
111
|
/**
|
|
112
112
|
* Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.
|
|
113
113
|
* @readonly
|
|
@@ -169,6 +169,8 @@ export declare enum PricingTypeEnumType {
|
|
|
169
169
|
/** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */
|
|
170
170
|
DONATION = "DONATION"
|
|
171
171
|
}
|
|
172
|
+
/** @enumType */
|
|
173
|
+
export type PricingTypeEnumTypeWithLiterals = PricingTypeEnumType | 'UNKNOWN_PRICING_TYPE' | 'STANDARD' | 'DONATION';
|
|
172
174
|
export declare enum FeeTypeEnumType {
|
|
173
175
|
/** Unknown fee type. */
|
|
174
176
|
UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
|
|
@@ -179,6 +181,8 @@ export declare enum FeeTypeEnumType {
|
|
|
179
181
|
/** Ticket service fee is not collected. Available only for free tickets and legacy users. */
|
|
180
182
|
NO_FEE = "NO_FEE"
|
|
181
183
|
}
|
|
184
|
+
/** @enumType */
|
|
185
|
+
export type FeeTypeEnumTypeWithLiterals = FeeTypeEnumType | 'UNKNOWN_FEE_TYPE' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT' | 'NO_FEE';
|
|
182
186
|
export declare enum SaleStatusEnumStatus {
|
|
183
187
|
/** Undefined sale status. */
|
|
184
188
|
UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
|
|
@@ -189,6 +193,8 @@ export declare enum SaleStatusEnumStatus {
|
|
|
189
193
|
/** Tickets are not on sale. */
|
|
190
194
|
SALE_ENDED = "SALE_ENDED"
|
|
191
195
|
}
|
|
196
|
+
/** @enumType */
|
|
197
|
+
export type SaleStatusEnumStatusWithLiterals = SaleStatusEnumStatus | 'UNKNOWN_SALE_STATUS' | 'SALE_SCHEDULED' | 'SALE_STARTED' | 'SALE_ENDED';
|
|
192
198
|
export interface SalesDetails {
|
|
193
199
|
/**
|
|
194
200
|
* Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.
|
|
@@ -255,7 +261,7 @@ export interface EventDetails {
|
|
|
255
261
|
* Event status.
|
|
256
262
|
* @readonly
|
|
257
263
|
*/
|
|
258
|
-
status?:
|
|
264
|
+
status?: StatusWithLiterals;
|
|
259
265
|
}
|
|
260
266
|
export interface Location {
|
|
261
267
|
/**
|
|
@@ -264,7 +270,7 @@ export interface Location {
|
|
|
264
270
|
*/
|
|
265
271
|
name?: string | null;
|
|
266
272
|
/** Location type. */
|
|
267
|
-
type?:
|
|
273
|
+
type?: LocationTypeWithLiterals;
|
|
268
274
|
/** Exact location address. */
|
|
269
275
|
address?: CommonAddress;
|
|
270
276
|
/** Whether the event location is TBD. */
|
|
@@ -278,6 +284,8 @@ export declare enum LocationType {
|
|
|
278
284
|
/** Event is online, such as a virtual video conference. */
|
|
279
285
|
ONLINE = "ONLINE"
|
|
280
286
|
}
|
|
287
|
+
/** @enumType */
|
|
288
|
+
export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
|
|
281
289
|
/** Physical address */
|
|
282
290
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
283
291
|
/** Street address. */
|
|
@@ -376,6 +384,8 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
376
384
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
377
385
|
COUNTRY = "COUNTRY"
|
|
378
386
|
}
|
|
387
|
+
/** @enumType */
|
|
388
|
+
export type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
379
389
|
export interface DateAndTimeSettings {
|
|
380
390
|
/** Whether the event date and time are TBD. */
|
|
381
391
|
dateAndTimeTbd?: boolean | null;
|
|
@@ -401,7 +411,7 @@ export interface DateAndTimeSettings {
|
|
|
401
411
|
* Repeating event status.
|
|
402
412
|
* @readonly
|
|
403
413
|
*/
|
|
404
|
-
recurrenceStatus?:
|
|
414
|
+
recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
|
|
405
415
|
/** Event repetitions. */
|
|
406
416
|
recurringEvents?: Recurrences;
|
|
407
417
|
/** Formatted date and time settings. */
|
|
@@ -421,6 +431,8 @@ export declare enum RecurrenceStatusStatus {
|
|
|
421
431
|
/** Latest canceled event in a schedule of recurring events */
|
|
422
432
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
423
433
|
}
|
|
434
|
+
/** @enumType */
|
|
435
|
+
export type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
|
|
424
436
|
export interface Recurrences {
|
|
425
437
|
/**
|
|
426
438
|
* Individual event dates.
|
|
@@ -495,6 +507,8 @@ export declare enum Status {
|
|
|
495
507
|
/** Event is not public. */
|
|
496
508
|
DRAFT = "DRAFT"
|
|
497
509
|
}
|
|
510
|
+
/** @enumType */
|
|
511
|
+
export type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
|
|
498
512
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
499
513
|
/**
|
|
500
514
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -612,7 +626,7 @@ export interface CreateTicketDefinitionRequest {
|
|
|
612
626
|
* Predefined sets of fields to return.
|
|
613
627
|
* @maxSize 5
|
|
614
628
|
*/
|
|
615
|
-
fields?:
|
|
629
|
+
fields?: FieldWithLiterals[];
|
|
616
630
|
}
|
|
617
631
|
export declare enum Field {
|
|
618
632
|
/** Unknown requested field. */
|
|
@@ -622,6 +636,8 @@ export declare enum Field {
|
|
|
622
636
|
/** Returns `eventDetails` in the response. */
|
|
623
637
|
EVENT_DETAILS = "EVENT_DETAILS"
|
|
624
638
|
}
|
|
639
|
+
/** @enumType */
|
|
640
|
+
export type FieldWithLiterals = Field | 'UNKNOWN_REQUESTED_FIELD' | 'SALES_DETAILS' | 'EVENT_DETAILS';
|
|
625
641
|
export interface CreateTicketDefinitionResponse {
|
|
626
642
|
/** Created ticket definition. */
|
|
627
643
|
ticketDefinition?: TicketDefinition;
|
|
@@ -633,7 +649,7 @@ export interface UpdateTicketDefinitionRequest {
|
|
|
633
649
|
* Predefined sets of fields to return.
|
|
634
650
|
* @maxSize 5
|
|
635
651
|
*/
|
|
636
|
-
fields?:
|
|
652
|
+
fields?: FieldWithLiterals[];
|
|
637
653
|
}
|
|
638
654
|
export interface UpdateTicketDefinitionResponse {
|
|
639
655
|
/** The updated ticket definition. */
|
|
@@ -649,7 +665,7 @@ export interface GetTicketDefinitionRequest {
|
|
|
649
665
|
* Predefined sets of fields to return.
|
|
650
666
|
* @maxSize 5
|
|
651
667
|
*/
|
|
652
|
-
fields?:
|
|
668
|
+
fields?: FieldWithLiterals[];
|
|
653
669
|
}
|
|
654
670
|
export interface GetTicketDefinitionResponse {
|
|
655
671
|
/** The requested ticket definition. */
|
|
@@ -715,7 +731,7 @@ export interface UpdateTicketDefinitionSortIndexRequest {
|
|
|
715
731
|
* Requested fields.
|
|
716
732
|
* @maxSize 5
|
|
717
733
|
*/
|
|
718
|
-
fields?:
|
|
734
|
+
fields?: FieldWithLiterals[];
|
|
719
735
|
}
|
|
720
736
|
export interface UpdateTicketDefinitionSortIndexResponse {
|
|
721
737
|
/** the updated ticket definition */
|
|
@@ -728,7 +744,7 @@ export interface QueryTicketDefinitionsRequest {
|
|
|
728
744
|
* Predefined sets of fields to return.
|
|
729
745
|
* @maxSize 5
|
|
730
746
|
*/
|
|
731
|
-
fields?:
|
|
747
|
+
fields?: FieldWithLiterals[];
|
|
732
748
|
}
|
|
733
749
|
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
734
750
|
/** Paging options to limit and skip the number of items. */
|
|
@@ -757,12 +773,14 @@ export interface Sorting {
|
|
|
757
773
|
*/
|
|
758
774
|
fieldName?: string;
|
|
759
775
|
/** Defaults to `ASC` */
|
|
760
|
-
order?:
|
|
776
|
+
order?: SortOrderWithLiterals;
|
|
761
777
|
}
|
|
762
778
|
export declare enum SortOrder {
|
|
763
779
|
ASC = "ASC",
|
|
764
780
|
DESC = "DESC"
|
|
765
781
|
}
|
|
782
|
+
/** @enumType */
|
|
783
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
766
784
|
export interface Paging {
|
|
767
785
|
/** Number of items to load per page. */
|
|
768
786
|
limit?: number | null;
|
|
@@ -821,7 +839,7 @@ export interface QueryAvailableTicketDefinitionsRequest {
|
|
|
821
839
|
* Predefined sets of fields to return.
|
|
822
840
|
* @maxSize 5
|
|
823
841
|
*/
|
|
824
|
-
fields?:
|
|
842
|
+
fields?: FieldWithLiterals[];
|
|
825
843
|
}
|
|
826
844
|
export interface QueryAvailableTicketDefinitionsResponse {
|
|
827
845
|
/** List of ticket definitions. */
|
|
@@ -986,7 +1004,7 @@ export interface EventCreated {
|
|
|
986
1004
|
*/
|
|
987
1005
|
userId?: string | null;
|
|
988
1006
|
/** Event status. */
|
|
989
|
-
status?:
|
|
1007
|
+
status?: EventStatusWithLiterals;
|
|
990
1008
|
/**
|
|
991
1009
|
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
992
1010
|
* @format GUID
|
|
@@ -1014,7 +1032,7 @@ export interface EventsLocation {
|
|
|
1014
1032
|
*/
|
|
1015
1033
|
address?: string | null;
|
|
1016
1034
|
/** Location type. */
|
|
1017
|
-
type?:
|
|
1035
|
+
type?: LocationLocationTypeWithLiterals;
|
|
1018
1036
|
/**
|
|
1019
1037
|
* Full address derived from formatted single line `address`.
|
|
1020
1038
|
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
@@ -1050,6 +1068,8 @@ export declare enum LocationLocationType {
|
|
|
1050
1068
|
VENUE = "VENUE",
|
|
1051
1069
|
ONLINE = "ONLINE"
|
|
1052
1070
|
}
|
|
1071
|
+
/** @enumType */
|
|
1072
|
+
export type LocationLocationTypeWithLiterals = LocationLocationType | 'VENUE' | 'ONLINE';
|
|
1053
1073
|
/** Physical address */
|
|
1054
1074
|
export interface Address extends AddressStreetOneOf {
|
|
1055
1075
|
/** a break down of the street to number and street name */
|
|
@@ -1129,6 +1149,8 @@ export declare enum SubdivisionType {
|
|
|
1129
1149
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
1130
1150
|
COUNTRY = "COUNTRY"
|
|
1131
1151
|
}
|
|
1152
|
+
/** @enumType */
|
|
1153
|
+
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
1132
1154
|
export interface ScheduleConfig {
|
|
1133
1155
|
/**
|
|
1134
1156
|
* Defines event as TBD (To Be Determined) schedule.
|
|
@@ -1172,7 +1194,7 @@ export interface EventsRecurrences {
|
|
|
1172
1194
|
* Recurrence status.
|
|
1173
1195
|
* @readonly
|
|
1174
1196
|
*/
|
|
1175
|
-
status?:
|
|
1197
|
+
status?: EventsRecurrenceStatusStatusWithLiterals;
|
|
1176
1198
|
}
|
|
1177
1199
|
export interface EventsOccurrence {
|
|
1178
1200
|
/** Event start timestamp. */
|
|
@@ -1199,6 +1221,8 @@ export declare enum EventsRecurrenceStatusStatus {
|
|
|
1199
1221
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1200
1222
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1201
1223
|
}
|
|
1224
|
+
/** @enumType */
|
|
1225
|
+
export type EventsRecurrenceStatusStatusWithLiterals = EventsRecurrenceStatusStatus | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
1202
1226
|
export declare enum EventStatus {
|
|
1203
1227
|
/** Event is public and scheduled to start */
|
|
1204
1228
|
SCHEDULED = "SCHEDULED",
|
|
@@ -1209,6 +1233,8 @@ export declare enum EventStatus {
|
|
|
1209
1233
|
/** Event was canceled */
|
|
1210
1234
|
CANCELED = "CANCELED"
|
|
1211
1235
|
}
|
|
1236
|
+
/** @enumType */
|
|
1237
|
+
export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
1212
1238
|
export interface Event {
|
|
1213
1239
|
/**
|
|
1214
1240
|
* Event ID.
|
|
@@ -1237,7 +1263,7 @@ export interface Event {
|
|
|
1237
1263
|
/** Event modified timestamp. */
|
|
1238
1264
|
modified?: Date | null;
|
|
1239
1265
|
/** Event status. */
|
|
1240
|
-
status?:
|
|
1266
|
+
status?: EventStatusWithLiterals;
|
|
1241
1267
|
/** RSVP or ticketing registration details. */
|
|
1242
1268
|
registration?: Registration;
|
|
1243
1269
|
/** "Add to calendar" URLs. */
|
|
@@ -1295,9 +1321,9 @@ export interface Scheduling {
|
|
|
1295
1321
|
}
|
|
1296
1322
|
export interface Registration {
|
|
1297
1323
|
/** Event type. */
|
|
1298
|
-
type?:
|
|
1324
|
+
type?: EventTypeWithLiterals;
|
|
1299
1325
|
/** Event registration status. */
|
|
1300
|
-
status?:
|
|
1326
|
+
status?: RegistrationStatusWithLiterals;
|
|
1301
1327
|
/** RSVP collection details. */
|
|
1302
1328
|
rsvpCollection?: RsvpCollection;
|
|
1303
1329
|
/** Ticketing details. */
|
|
@@ -1305,9 +1331,9 @@ export interface Registration {
|
|
|
1305
1331
|
/** External registration details. */
|
|
1306
1332
|
external?: ExternalEvent;
|
|
1307
1333
|
/** Types of users allowed to register. */
|
|
1308
|
-
restrictedTo?:
|
|
1334
|
+
restrictedTo?: VisitorTypeWithLiterals;
|
|
1309
1335
|
/** Initial event type which was set when creating an event. */
|
|
1310
|
-
initialType?:
|
|
1336
|
+
initialType?: EventTypeWithLiterals;
|
|
1311
1337
|
}
|
|
1312
1338
|
export declare enum EventType {
|
|
1313
1339
|
/** Type not available for this request fieldset */
|
|
@@ -1321,6 +1347,8 @@ export declare enum EventType {
|
|
|
1321
1347
|
/** Registration not available */
|
|
1322
1348
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
1323
1349
|
}
|
|
1350
|
+
/** @enumType */
|
|
1351
|
+
export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
1324
1352
|
export declare enum RegistrationStatus {
|
|
1325
1353
|
/** Registration status is not applicable */
|
|
1326
1354
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
@@ -1339,13 +1367,15 @@ export declare enum RegistrationStatus {
|
|
|
1339
1367
|
/** Registration will be open via RSVP */
|
|
1340
1368
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
1341
1369
|
}
|
|
1370
|
+
/** @enumType */
|
|
1371
|
+
export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
1342
1372
|
export interface RsvpCollection {
|
|
1343
1373
|
/** RSVP collection configuration. */
|
|
1344
1374
|
config?: RsvpCollectionConfig;
|
|
1345
1375
|
}
|
|
1346
1376
|
export interface RsvpCollectionConfig {
|
|
1347
1377
|
/** Defines the supported RSVP statuses. */
|
|
1348
|
-
rsvpStatusOptions?:
|
|
1378
|
+
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
1349
1379
|
/**
|
|
1350
1380
|
* Total guest limit available to register to the event.
|
|
1351
1381
|
* Additional guests per RSVP are counted towards total guests.
|
|
@@ -1364,6 +1394,8 @@ export declare enum RsvpStatusOptions {
|
|
|
1364
1394
|
/** YES and NO RSVP status options are available for the registration */
|
|
1365
1395
|
YES_AND_NO = "YES_AND_NO"
|
|
1366
1396
|
}
|
|
1397
|
+
/** @enumType */
|
|
1398
|
+
export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
1367
1399
|
export interface Ticketing {
|
|
1368
1400
|
/**
|
|
1369
1401
|
* Deprecated.
|
|
@@ -1424,7 +1456,7 @@ export interface TicketingConfig {
|
|
|
1424
1456
|
}
|
|
1425
1457
|
export interface TaxConfig {
|
|
1426
1458
|
/** Tax application settings. */
|
|
1427
|
-
type?:
|
|
1459
|
+
type?: TaxTypeWithLiterals;
|
|
1428
1460
|
/**
|
|
1429
1461
|
* Tax name.
|
|
1430
1462
|
* @minLength 1
|
|
@@ -1447,6 +1479,8 @@ export declare enum TaxType {
|
|
|
1447
1479
|
/** Tax is added to the final total at the checkout. */
|
|
1448
1480
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1449
1481
|
}
|
|
1482
|
+
/** @enumType */
|
|
1483
|
+
export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
1450
1484
|
export interface Money {
|
|
1451
1485
|
/**
|
|
1452
1486
|
* *Deprecated:** Use `value` instead.
|
|
@@ -1477,6 +1511,8 @@ export declare enum VisitorType {
|
|
|
1477
1511
|
/** Site visitor or member */
|
|
1478
1512
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
1479
1513
|
}
|
|
1514
|
+
/** @enumType */
|
|
1515
|
+
export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
1480
1516
|
export interface CalendarLinks {
|
|
1481
1517
|
/** "Add to Google calendar" URL. */
|
|
1482
1518
|
google?: string;
|
|
@@ -1518,7 +1554,7 @@ export interface Form {
|
|
|
1518
1554
|
*/
|
|
1519
1555
|
export interface InputControl {
|
|
1520
1556
|
/** Field control type. */
|
|
1521
|
-
type?:
|
|
1557
|
+
type?: InputControlTypeWithLiterals;
|
|
1522
1558
|
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
1523
1559
|
system?: boolean;
|
|
1524
1560
|
/**
|
|
@@ -1565,6 +1601,8 @@ export declare enum InputControlType {
|
|
|
1565
1601
|
/** Year, month and day fields. */
|
|
1566
1602
|
DATE = "DATE"
|
|
1567
1603
|
}
|
|
1604
|
+
/** @enumType */
|
|
1605
|
+
export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
1568
1606
|
/** An input of one or multiple text values */
|
|
1569
1607
|
export interface Input {
|
|
1570
1608
|
/** Field name. */
|
|
@@ -1588,7 +1626,7 @@ export interface Input {
|
|
|
1588
1626
|
* Type which determines field format.
|
|
1589
1627
|
* Used to validate submitted response.
|
|
1590
1628
|
*/
|
|
1591
|
-
type?:
|
|
1629
|
+
type?: ValueTypeWithLiterals;
|
|
1592
1630
|
/**
|
|
1593
1631
|
* A maximum accepted values for array input.
|
|
1594
1632
|
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
@@ -1612,6 +1650,8 @@ export declare enum ValueType {
|
|
|
1612
1650
|
DATE_TIME = "DATE_TIME",
|
|
1613
1651
|
ADDRESS = "ADDRESS"
|
|
1614
1652
|
}
|
|
1653
|
+
/** @enumType */
|
|
1654
|
+
export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
1615
1655
|
/**
|
|
1616
1656
|
* Describes initially selected option when an input has multiple choices.
|
|
1617
1657
|
* Defaults to first (0th) option if not configured.
|
|
@@ -1800,7 +1840,7 @@ export interface OnlineConferencingConfig {
|
|
|
1800
1840
|
*/
|
|
1801
1841
|
providerId?: string | null;
|
|
1802
1842
|
/** Conference type */
|
|
1803
|
-
conferenceType?:
|
|
1843
|
+
conferenceType?: ConferenceTypeWithLiterals;
|
|
1804
1844
|
}
|
|
1805
1845
|
export declare enum ConferenceType {
|
|
1806
1846
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
@@ -1808,6 +1848,8 @@ export declare enum ConferenceType {
|
|
|
1808
1848
|
/** Guests can only subscribe to video and audio. */
|
|
1809
1849
|
WEBINAR = "WEBINAR"
|
|
1810
1850
|
}
|
|
1851
|
+
/** @enumType */
|
|
1852
|
+
export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
1811
1853
|
export interface OnlineConferencingSession {
|
|
1812
1854
|
/**
|
|
1813
1855
|
* Link for event host to start the online conference session.
|
|
@@ -1952,7 +1994,7 @@ export interface Category {
|
|
|
1952
1994
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1953
1995
|
* @maxSize 3
|
|
1954
1996
|
*/
|
|
1955
|
-
states?:
|
|
1997
|
+
states?: CategoryStateStateWithLiterals[];
|
|
1956
1998
|
}
|
|
1957
1999
|
export interface CategoryCounts {
|
|
1958
2000
|
/** Total number of draft events assigned to the category. */
|
|
@@ -1970,6 +2012,8 @@ export declare enum CategoryStateState {
|
|
|
1970
2012
|
/** Category is hidden. */
|
|
1971
2013
|
HIDDEN = "HIDDEN"
|
|
1972
2014
|
}
|
|
2015
|
+
/** @enumType */
|
|
2016
|
+
export type CategoryStateStateWithLiterals = CategoryStateState | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
1973
2017
|
export interface EventDisplaySettings {
|
|
1974
2018
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1975
2019
|
hideEventDetailsButton?: boolean | null;
|
|
@@ -2042,9 +2086,9 @@ export interface Node extends NodeDataOneOf {
|
|
|
2042
2086
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
2043
2087
|
layoutCellData?: LayoutCellData;
|
|
2044
2088
|
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
2045
|
-
type?:
|
|
2089
|
+
type?: NodeTypeWithLiterals;
|
|
2046
2090
|
/** Node ID. */
|
|
2047
|
-
|
|
2091
|
+
id?: string;
|
|
2048
2092
|
/** A list of child nodes. */
|
|
2049
2093
|
nodes?: Node[];
|
|
2050
2094
|
/** Padding and background color styling for the node. */
|
|
@@ -2143,6 +2187,8 @@ export declare enum NodeType {
|
|
|
2143
2187
|
LAYOUT = "LAYOUT",
|
|
2144
2188
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
2145
2189
|
}
|
|
2190
|
+
/** @enumType */
|
|
2191
|
+
export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
2146
2192
|
export interface NodeStyle {
|
|
2147
2193
|
/** The top padding value in pixels. */
|
|
2148
2194
|
paddingTop?: string | null;
|
|
@@ -2155,7 +2201,7 @@ export interface ButtonData {
|
|
|
2155
2201
|
/** Styling for the button's container. */
|
|
2156
2202
|
containerData?: PluginContainerData;
|
|
2157
2203
|
/** The button type. */
|
|
2158
|
-
type?:
|
|
2204
|
+
type?: ButtonDataTypeWithLiterals;
|
|
2159
2205
|
/** Styling for the button. */
|
|
2160
2206
|
styles?: Styles;
|
|
2161
2207
|
/** The text to display on the button. */
|
|
@@ -2181,7 +2227,7 @@ export interface PluginContainerData {
|
|
|
2181
2227
|
/** The width of the node when it's displayed. */
|
|
2182
2228
|
width?: PluginContainerDataWidth;
|
|
2183
2229
|
/** The node's alignment within its container. */
|
|
2184
|
-
alignment?:
|
|
2230
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
2185
2231
|
/** Spoiler cover settings for the node. */
|
|
2186
2232
|
spoiler?: Spoiler;
|
|
2187
2233
|
/** The height of the node when it's displayed. */
|
|
@@ -2199,6 +2245,8 @@ export declare enum WidthType {
|
|
|
2199
2245
|
/** coast-to-coast display */
|
|
2200
2246
|
FULL_WIDTH = "FULL_WIDTH"
|
|
2201
2247
|
}
|
|
2248
|
+
/** @enumType */
|
|
2249
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
2202
2250
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
2203
2251
|
/**
|
|
2204
2252
|
* One of the following predefined width options:
|
|
@@ -2207,7 +2255,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
2207
2255
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
2208
2256
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
2209
2257
|
*/
|
|
2210
|
-
size?:
|
|
2258
|
+
size?: WidthTypeWithLiterals;
|
|
2211
2259
|
/** A custom width value in pixels. */
|
|
2212
2260
|
custom?: string | null;
|
|
2213
2261
|
}
|
|
@@ -2220,7 +2268,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
2220
2268
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
2221
2269
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
2222
2270
|
*/
|
|
2223
|
-
size?:
|
|
2271
|
+
size?: WidthTypeWithLiterals;
|
|
2224
2272
|
/** A custom width value in pixels. */
|
|
2225
2273
|
custom?: string | null;
|
|
2226
2274
|
}
|
|
@@ -2232,6 +2280,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
2232
2280
|
/** Right Alignment */
|
|
2233
2281
|
RIGHT = "RIGHT"
|
|
2234
2282
|
}
|
|
2283
|
+
/** @enumType */
|
|
2284
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2235
2285
|
export interface Spoiler {
|
|
2236
2286
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
2237
2287
|
enabled?: boolean | null;
|
|
@@ -2250,6 +2300,8 @@ export declare enum ButtonDataType {
|
|
|
2250
2300
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
2251
2301
|
ACTION = "ACTION"
|
|
2252
2302
|
}
|
|
2303
|
+
/** @enumType */
|
|
2304
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
2253
2305
|
export interface Styles {
|
|
2254
2306
|
/** Border attributes. */
|
|
2255
2307
|
border?: Border;
|
|
@@ -2268,7 +2320,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
2268
2320
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
2269
2321
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
2270
2322
|
*/
|
|
2271
|
-
target?:
|
|
2323
|
+
target?: TargetWithLiterals;
|
|
2272
2324
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
2273
2325
|
rel?: Rel;
|
|
2274
2326
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -2291,6 +2343,8 @@ export declare enum Target {
|
|
|
2291
2343
|
/** Opens the linked document in the full body of the window */
|
|
2292
2344
|
TOP = "TOP"
|
|
2293
2345
|
}
|
|
2346
|
+
/** @enumType */
|
|
2347
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
2294
2348
|
export interface Rel {
|
|
2295
2349
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
2296
2350
|
nofollow?: boolean | null;
|
|
@@ -2307,7 +2361,7 @@ export interface CodeBlockData {
|
|
|
2307
2361
|
}
|
|
2308
2362
|
export interface TextStyle {
|
|
2309
2363
|
/** Text alignment. Defaults to `AUTO`. */
|
|
2310
|
-
textAlignment?:
|
|
2364
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
2311
2365
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
2312
2366
|
lineHeight?: string | null;
|
|
2313
2367
|
}
|
|
@@ -2323,15 +2377,17 @@ export declare enum TextAlignment {
|
|
|
2323
2377
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
2324
2378
|
JUSTIFY = "JUSTIFY"
|
|
2325
2379
|
}
|
|
2380
|
+
/** @enumType */
|
|
2381
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
2326
2382
|
export interface DividerData {
|
|
2327
2383
|
/** Styling for the divider's container. */
|
|
2328
2384
|
containerData?: PluginContainerData;
|
|
2329
2385
|
/** Divider line style. */
|
|
2330
|
-
lineStyle?:
|
|
2386
|
+
lineStyle?: LineStyleWithLiterals;
|
|
2331
2387
|
/** Divider width. */
|
|
2332
|
-
width?:
|
|
2388
|
+
width?: WidthWithLiterals;
|
|
2333
2389
|
/** Divider alignment. */
|
|
2334
|
-
alignment?:
|
|
2390
|
+
alignment?: AlignmentWithLiterals;
|
|
2335
2391
|
}
|
|
2336
2392
|
export declare enum LineStyle {
|
|
2337
2393
|
/** Single Line */
|
|
@@ -2343,6 +2399,8 @@ export declare enum LineStyle {
|
|
|
2343
2399
|
/** Dotted Line */
|
|
2344
2400
|
DOTTED = "DOTTED"
|
|
2345
2401
|
}
|
|
2402
|
+
/** @enumType */
|
|
2403
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
2346
2404
|
export declare enum Width {
|
|
2347
2405
|
/** Large line */
|
|
2348
2406
|
LARGE = "LARGE",
|
|
@@ -2351,6 +2409,8 @@ export declare enum Width {
|
|
|
2351
2409
|
/** Small line */
|
|
2352
2410
|
SMALL = "SMALL"
|
|
2353
2411
|
}
|
|
2412
|
+
/** @enumType */
|
|
2413
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
2354
2414
|
export declare enum Alignment {
|
|
2355
2415
|
/** Center alignment */
|
|
2356
2416
|
CENTER = "CENTER",
|
|
@@ -2359,6 +2419,8 @@ export declare enum Alignment {
|
|
|
2359
2419
|
/** Right alignment */
|
|
2360
2420
|
RIGHT = "RIGHT"
|
|
2361
2421
|
}
|
|
2422
|
+
/** @enumType */
|
|
2423
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2362
2424
|
export interface FileData {
|
|
2363
2425
|
/** Styling for the file's container. */
|
|
2364
2426
|
containerData?: PluginContainerData;
|
|
@@ -2390,6 +2452,8 @@ export declare enum ViewMode {
|
|
|
2390
2452
|
/** Mini PDF view */
|
|
2391
2453
|
MINI = "MINI"
|
|
2392
2454
|
}
|
|
2455
|
+
/** @enumType */
|
|
2456
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
2393
2457
|
export interface FileSource extends FileSourceDataOneOf {
|
|
2394
2458
|
/** The absolute URL for the file's source. */
|
|
2395
2459
|
url?: string | null;
|
|
@@ -2399,7 +2463,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
2399
2463
|
*/
|
|
2400
2464
|
custom?: string | null;
|
|
2401
2465
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
2402
|
-
|
|
2466
|
+
id?: string | null;
|
|
2403
2467
|
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
2404
2468
|
private?: boolean | null;
|
|
2405
2469
|
}
|
|
@@ -2413,7 +2477,7 @@ export interface FileSourceDataOneOf {
|
|
|
2413
2477
|
*/
|
|
2414
2478
|
custom?: string | null;
|
|
2415
2479
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
2416
|
-
|
|
2480
|
+
id?: string | null;
|
|
2417
2481
|
}
|
|
2418
2482
|
export interface PDFSettings {
|
|
2419
2483
|
/**
|
|
@@ -2422,7 +2486,7 @@ export interface PDFSettings {
|
|
|
2422
2486
|
* `FULL` : A full page view of the PDF is displayed.
|
|
2423
2487
|
* `MINI` : A mini view of the PDF is displayed.
|
|
2424
2488
|
*/
|
|
2425
|
-
viewMode?:
|
|
2489
|
+
viewMode?: ViewModeWithLiterals;
|
|
2426
2490
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
2427
2491
|
disableDownload?: boolean | null;
|
|
2428
2492
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -2509,18 +2573,24 @@ export declare enum LayoutType {
|
|
|
2509
2573
|
/** Fullsize images type */
|
|
2510
2574
|
FULLSIZE = "FULLSIZE"
|
|
2511
2575
|
}
|
|
2576
|
+
/** @enumType */
|
|
2577
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
2512
2578
|
export declare enum Orientation {
|
|
2513
2579
|
/** Rows Orientation */
|
|
2514
2580
|
ROWS = "ROWS",
|
|
2515
2581
|
/** Columns Orientation */
|
|
2516
2582
|
COLUMNS = "COLUMNS"
|
|
2517
2583
|
}
|
|
2584
|
+
/** @enumType */
|
|
2585
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
2518
2586
|
export declare enum Crop {
|
|
2519
2587
|
/** Crop to fill */
|
|
2520
2588
|
FILL = "FILL",
|
|
2521
2589
|
/** Crop to fit */
|
|
2522
2590
|
FIT = "FIT"
|
|
2523
2591
|
}
|
|
2592
|
+
/** @enumType */
|
|
2593
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
2524
2594
|
export declare enum ThumbnailsAlignment {
|
|
2525
2595
|
/** Top alignment */
|
|
2526
2596
|
TOP = "TOP",
|
|
@@ -2533,13 +2603,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
2533
2603
|
/** No thumbnail */
|
|
2534
2604
|
NONE = "NONE"
|
|
2535
2605
|
}
|
|
2606
|
+
/** @enumType */
|
|
2607
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
2536
2608
|
export interface Layout {
|
|
2537
2609
|
/** Gallery layout type. */
|
|
2538
|
-
type?:
|
|
2610
|
+
type?: LayoutTypeWithLiterals;
|
|
2539
2611
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
2540
2612
|
horizontalScroll?: boolean | null;
|
|
2541
2613
|
/** Gallery orientation. */
|
|
2542
|
-
orientation?:
|
|
2614
|
+
orientation?: OrientationWithLiterals;
|
|
2543
2615
|
/** The number of columns to display on full size screens. */
|
|
2544
2616
|
numberOfColumns?: number | null;
|
|
2545
2617
|
/** The number of columns to display on mobile screens. */
|
|
@@ -2551,13 +2623,13 @@ export interface ItemStyle {
|
|
|
2551
2623
|
/** Item ratio */
|
|
2552
2624
|
ratio?: number | null;
|
|
2553
2625
|
/** Sets how item images are cropped. */
|
|
2554
|
-
crop?:
|
|
2626
|
+
crop?: CropWithLiterals;
|
|
2555
2627
|
/** The spacing between items in pixels. */
|
|
2556
2628
|
spacing?: number | null;
|
|
2557
2629
|
}
|
|
2558
2630
|
export interface Thumbnails {
|
|
2559
2631
|
/** Thumbnail alignment. */
|
|
2560
|
-
placement?:
|
|
2632
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
2561
2633
|
/** Spacing between thumbnails in pixels. */
|
|
2562
2634
|
spacing?: number | null;
|
|
2563
2635
|
}
|
|
@@ -2573,7 +2645,7 @@ export interface GIFData {
|
|
|
2573
2645
|
/** Width in pixels. */
|
|
2574
2646
|
width?: number;
|
|
2575
2647
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2576
|
-
gifType?:
|
|
2648
|
+
gifType?: GIFTypeWithLiterals;
|
|
2577
2649
|
}
|
|
2578
2650
|
export interface GIF {
|
|
2579
2651
|
/**
|
|
@@ -2596,6 +2668,8 @@ export declare enum GIFType {
|
|
|
2596
2668
|
NORMAL = "NORMAL",
|
|
2597
2669
|
STICKER = "STICKER"
|
|
2598
2670
|
}
|
|
2671
|
+
/** @enumType */
|
|
2672
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2599
2673
|
export interface HeadingData {
|
|
2600
2674
|
/** Heading level from 1-6. */
|
|
2601
2675
|
level?: number;
|
|
@@ -2617,7 +2691,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2617
2691
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
2618
2692
|
containerData?: PluginContainerData;
|
|
2619
2693
|
/** The type of HTML code. */
|
|
2620
|
-
source?:
|
|
2694
|
+
source?: SourceWithLiterals;
|
|
2621
2695
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
2622
2696
|
autoHeight?: boolean | null;
|
|
2623
2697
|
}
|
|
@@ -2637,6 +2711,8 @@ export declare enum Source {
|
|
|
2637
2711
|
HTML = "HTML",
|
|
2638
2712
|
ADSENSE = "ADSENSE"
|
|
2639
2713
|
}
|
|
2714
|
+
/** @enumType */
|
|
2715
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
2640
2716
|
export interface ImageData {
|
|
2641
2717
|
/** Styling for the image's container. */
|
|
2642
2718
|
containerData?: PluginContainerData;
|
|
@@ -2701,6 +2777,8 @@ export declare enum Position {
|
|
|
2701
2777
|
/** Thumbnail hidden and not displayed */
|
|
2702
2778
|
HIDDEN = "HIDDEN"
|
|
2703
2779
|
}
|
|
2780
|
+
/** @enumType */
|
|
2781
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2704
2782
|
export interface LinkPreviewDataStyles {
|
|
2705
2783
|
/**
|
|
2706
2784
|
* Background color as a hexadecimal value.
|
|
@@ -2732,7 +2810,7 @@ export interface LinkPreviewDataStyles {
|
|
|
2732
2810
|
*/
|
|
2733
2811
|
borderColor?: string | null;
|
|
2734
2812
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2735
|
-
thumbnailPosition?:
|
|
2813
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
2736
2814
|
}
|
|
2737
2815
|
export interface MapData {
|
|
2738
2816
|
/** Styling for the map's container. */
|
|
@@ -2762,7 +2840,7 @@ export interface MapSettings {
|
|
|
2762
2840
|
/** Initial zoom value. */
|
|
2763
2841
|
initialZoom?: number | null;
|
|
2764
2842
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2765
|
-
mapType?:
|
|
2843
|
+
mapType?: MapTypeWithLiterals;
|
|
2766
2844
|
}
|
|
2767
2845
|
export declare enum MapType {
|
|
2768
2846
|
/** Roadmap map type */
|
|
@@ -2774,6 +2852,8 @@ export declare enum MapType {
|
|
|
2774
2852
|
/** Terrain map type */
|
|
2775
2853
|
TERRAIN = "TERRAIN"
|
|
2776
2854
|
}
|
|
2855
|
+
/** @enumType */
|
|
2856
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2777
2857
|
export interface ParagraphData {
|
|
2778
2858
|
/** Styling for the paragraph text. */
|
|
2779
2859
|
textStyle?: TextStyle;
|
|
@@ -2800,23 +2880,27 @@ export declare enum ViewRole {
|
|
|
2800
2880
|
/** Anyone can see the results, even if one didn't vote */
|
|
2801
2881
|
EVERYONE = "EVERYONE"
|
|
2802
2882
|
}
|
|
2883
|
+
/** @enumType */
|
|
2884
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2803
2885
|
export declare enum VoteRole {
|
|
2804
2886
|
/** Logged in member */
|
|
2805
2887
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2806
2888
|
/** Anyone */
|
|
2807
2889
|
ALL = "ALL"
|
|
2808
2890
|
}
|
|
2891
|
+
/** @enumType */
|
|
2892
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2809
2893
|
export interface Permissions {
|
|
2810
2894
|
/** Sets who can view the poll results. */
|
|
2811
|
-
view?:
|
|
2895
|
+
view?: ViewRoleWithLiterals;
|
|
2812
2896
|
/** Sets who can vote. */
|
|
2813
|
-
vote?:
|
|
2897
|
+
vote?: VoteRoleWithLiterals;
|
|
2814
2898
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2815
2899
|
allowMultipleVotes?: boolean | null;
|
|
2816
2900
|
}
|
|
2817
2901
|
export interface Option {
|
|
2818
2902
|
/** Option ID. */
|
|
2819
|
-
|
|
2903
|
+
id?: string | null;
|
|
2820
2904
|
/** Option title. */
|
|
2821
2905
|
title?: string | null;
|
|
2822
2906
|
/** The image displayed with the option. */
|
|
@@ -2836,17 +2920,21 @@ export declare enum PollLayoutType {
|
|
|
2836
2920
|
/** Grid */
|
|
2837
2921
|
GRID = "GRID"
|
|
2838
2922
|
}
|
|
2923
|
+
/** @enumType */
|
|
2924
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2839
2925
|
export declare enum PollLayoutDirection {
|
|
2840
2926
|
/** Left-to-right */
|
|
2841
2927
|
LTR = "LTR",
|
|
2842
2928
|
/** Right-to-left */
|
|
2843
2929
|
RTL = "RTL"
|
|
2844
2930
|
}
|
|
2931
|
+
/** @enumType */
|
|
2932
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2845
2933
|
export interface PollLayout {
|
|
2846
2934
|
/** The layout for displaying the voting options. */
|
|
2847
|
-
type?:
|
|
2935
|
+
type?: PollLayoutTypeWithLiterals;
|
|
2848
2936
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2849
|
-
direction?:
|
|
2937
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
2850
2938
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2851
2939
|
enableImage?: boolean | null;
|
|
2852
2940
|
}
|
|
@@ -2862,6 +2950,8 @@ export declare enum BackgroundType {
|
|
|
2862
2950
|
/** Gradiant background type */
|
|
2863
2951
|
GRADIENT = "GRADIENT"
|
|
2864
2952
|
}
|
|
2953
|
+
/** @enumType */
|
|
2954
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2865
2955
|
export interface Gradient {
|
|
2866
2956
|
/** The gradient angle in degrees. */
|
|
2867
2957
|
angle?: number | null;
|
|
@@ -2887,7 +2977,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2887
2977
|
/** Details for a gradient background. */
|
|
2888
2978
|
gradient?: Gradient;
|
|
2889
2979
|
/** Background type. For each option, include the relevant details. */
|
|
2890
|
-
type?:
|
|
2980
|
+
type?: BackgroundTypeWithLiterals;
|
|
2891
2981
|
}
|
|
2892
2982
|
/** @oneof */
|
|
2893
2983
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -2913,7 +3003,7 @@ export interface OptionDesign {
|
|
|
2913
3003
|
}
|
|
2914
3004
|
export interface Poll {
|
|
2915
3005
|
/** Poll ID. */
|
|
2916
|
-
|
|
3006
|
+
id?: string | null;
|
|
2917
3007
|
/** Poll title. */
|
|
2918
3008
|
title?: string | null;
|
|
2919
3009
|
/** Poll creator ID. */
|
|
@@ -2964,7 +3054,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2964
3054
|
/** Data for a spoiler decoration. */
|
|
2965
3055
|
spoilerData?: SpoilerData;
|
|
2966
3056
|
/** The type of decoration to apply. */
|
|
2967
|
-
type?:
|
|
3057
|
+
type?: DecorationTypeWithLiterals;
|
|
2968
3058
|
}
|
|
2969
3059
|
/** @oneof */
|
|
2970
3060
|
export interface DecorationDataOneOf {
|
|
@@ -2999,6 +3089,8 @@ export declare enum DecorationType {
|
|
|
2999
3089
|
FONT_SIZE = "FONT_SIZE",
|
|
3000
3090
|
EXTERNAL = "EXTERNAL"
|
|
3001
3091
|
}
|
|
3092
|
+
/** @enumType */
|
|
3093
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
3002
3094
|
export interface AnchorData {
|
|
3003
3095
|
/** The target node's ID. */
|
|
3004
3096
|
anchor?: string;
|
|
@@ -3019,11 +3111,11 @@ export interface MentionData {
|
|
|
3019
3111
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
3020
3112
|
slug?: string;
|
|
3021
3113
|
/** Mentioned user's ID. */
|
|
3022
|
-
|
|
3114
|
+
id?: string | null;
|
|
3023
3115
|
}
|
|
3024
3116
|
export interface FontSizeData {
|
|
3025
3117
|
/** The units used for the font size. */
|
|
3026
|
-
unit?:
|
|
3118
|
+
unit?: FontTypeWithLiterals;
|
|
3027
3119
|
/** Font size value. */
|
|
3028
3120
|
value?: number | null;
|
|
3029
3121
|
}
|
|
@@ -3031,9 +3123,11 @@ export declare enum FontType {
|
|
|
3031
3123
|
PX = "PX",
|
|
3032
3124
|
EM = "EM"
|
|
3033
3125
|
}
|
|
3126
|
+
/** @enumType */
|
|
3127
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
3034
3128
|
export interface SpoilerData {
|
|
3035
3129
|
/** Spoiler ID. */
|
|
3036
|
-
|
|
3130
|
+
id?: string | null;
|
|
3037
3131
|
}
|
|
3038
3132
|
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
3039
3133
|
/** Data for embedded Wix Bookings content. */
|
|
@@ -3041,7 +3135,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
3041
3135
|
/** Data for embedded Wix Events content. */
|
|
3042
3136
|
eventData?: EventData;
|
|
3043
3137
|
/** The type of Wix App content being embedded. */
|
|
3044
|
-
type?:
|
|
3138
|
+
type?: AppTypeWithLiterals;
|
|
3045
3139
|
/** The ID of the embedded content. */
|
|
3046
3140
|
itemId?: string | null;
|
|
3047
3141
|
/** The name of the embedded content. */
|
|
@@ -3068,6 +3162,8 @@ export declare enum AppType {
|
|
|
3068
3162
|
EVENT = "EVENT",
|
|
3069
3163
|
BOOKING = "BOOKING"
|
|
3070
3164
|
}
|
|
3165
|
+
/** @enumType */
|
|
3166
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
3071
3167
|
export interface BookingData {
|
|
3072
3168
|
/** Booking duration in minutes. */
|
|
3073
3169
|
durations?: string | null;
|
|
@@ -3146,9 +3242,9 @@ export interface CollapsibleListData {
|
|
|
3146
3242
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
3147
3243
|
expandOnlyOne?: boolean | null;
|
|
3148
3244
|
/** Sets which items are expanded when the page loads. */
|
|
3149
|
-
initialExpandedItems?:
|
|
3245
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
3150
3246
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
3151
|
-
direction?:
|
|
3247
|
+
direction?: DirectionWithLiterals;
|
|
3152
3248
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
3153
3249
|
isQapageData?: boolean | null;
|
|
3154
3250
|
}
|
|
@@ -3160,12 +3256,16 @@ export declare enum InitialExpandedItems {
|
|
|
3160
3256
|
/** All items collapsed initally */
|
|
3161
3257
|
NONE = "NONE"
|
|
3162
3258
|
}
|
|
3259
|
+
/** @enumType */
|
|
3260
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
3163
3261
|
export declare enum Direction {
|
|
3164
3262
|
/** Left-to-right */
|
|
3165
3263
|
LTR = "LTR",
|
|
3166
3264
|
/** Right-to-left */
|
|
3167
3265
|
RTL = "RTL"
|
|
3168
3266
|
}
|
|
3267
|
+
/** @enumType */
|
|
3268
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
3169
3269
|
export interface TableData {
|
|
3170
3270
|
/** Styling for the table's container. */
|
|
3171
3271
|
containerData?: PluginContainerData;
|
|
@@ -3203,9 +3303,11 @@ export declare enum VerticalAlignment {
|
|
|
3203
3303
|
/** Bottom alignment */
|
|
3204
3304
|
BOTTOM = "BOTTOM"
|
|
3205
3305
|
}
|
|
3306
|
+
/** @enumType */
|
|
3307
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
3206
3308
|
export interface CellStyle {
|
|
3207
3309
|
/** Vertical alignment for the cell's text. */
|
|
3208
|
-
verticalAlignment?:
|
|
3310
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
3209
3311
|
/**
|
|
3210
3312
|
* Cell background color as a hexadecimal value.
|
|
3211
3313
|
* @format COLOR_HEX
|
|
@@ -3244,6 +3346,8 @@ export declare enum NullValue {
|
|
|
3244
3346
|
/** Null value. */
|
|
3245
3347
|
NULL_VALUE = "NULL_VALUE"
|
|
3246
3348
|
}
|
|
3349
|
+
/** @enumType */
|
|
3350
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
3247
3351
|
/**
|
|
3248
3352
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
3249
3353
|
*
|
|
@@ -3341,7 +3445,7 @@ export interface TextNodeStyle {
|
|
|
3341
3445
|
}
|
|
3342
3446
|
export interface Badge {
|
|
3343
3447
|
/** Badge type. */
|
|
3344
|
-
type?:
|
|
3448
|
+
type?: TypeWithLiterals;
|
|
3345
3449
|
/**
|
|
3346
3450
|
* Badge text.
|
|
3347
3451
|
* @maxLength 50
|
|
@@ -3358,6 +3462,8 @@ export declare enum Type {
|
|
|
3358
3462
|
/** General badge type. */
|
|
3359
3463
|
GENERAL = "GENERAL"
|
|
3360
3464
|
}
|
|
3465
|
+
/** @enumType */
|
|
3466
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'URGENT' | 'INFO' | 'GENERAL';
|
|
3361
3467
|
export interface EventUpdated {
|
|
3362
3468
|
/** Event update timestamp in ISO UTC format. */
|
|
3363
3469
|
timestamp?: Date | null;
|
|
@@ -3593,7 +3699,7 @@ export interface Asset {
|
|
|
3593
3699
|
*/
|
|
3594
3700
|
instanceId?: string;
|
|
3595
3701
|
/** An application state. */
|
|
3596
|
-
state?:
|
|
3702
|
+
state?: StateWithLiterals;
|
|
3597
3703
|
}
|
|
3598
3704
|
export declare enum State {
|
|
3599
3705
|
UNKNOWN = "UNKNOWN",
|
|
@@ -3602,6 +3708,8 @@ export declare enum State {
|
|
|
3602
3708
|
PENDING = "PENDING",
|
|
3603
3709
|
DEMO = "DEMO"
|
|
3604
3710
|
}
|
|
3711
|
+
/** @enumType */
|
|
3712
|
+
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
3605
3713
|
export interface SiteCreated {
|
|
3606
3714
|
/**
|
|
3607
3715
|
* A template identifier (empty if not created from a template).
|
|
@@ -3614,7 +3722,7 @@ export interface SiteCreated {
|
|
|
3614
3722
|
*/
|
|
3615
3723
|
ownerId?: string;
|
|
3616
3724
|
/** A context in which meta site was created. */
|
|
3617
|
-
context?:
|
|
3725
|
+
context?: SiteCreatedContextWithLiterals;
|
|
3618
3726
|
/**
|
|
3619
3727
|
* A meta site id from which this site was created.
|
|
3620
3728
|
*
|
|
@@ -3629,7 +3737,7 @@ export interface SiteCreated {
|
|
|
3629
3737
|
*/
|
|
3630
3738
|
siteName?: string;
|
|
3631
3739
|
/** A namespace. */
|
|
3632
|
-
namespace?:
|
|
3740
|
+
namespace?: NamespaceWithLiterals;
|
|
3633
3741
|
}
|
|
3634
3742
|
export declare enum SiteCreatedContext {
|
|
3635
3743
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
@@ -3645,6 +3753,8 @@ export declare enum SiteCreatedContext {
|
|
|
3645
3753
|
/** deprecated A meta site was created for Flash editor. */
|
|
3646
3754
|
FLASH = "FLASH"
|
|
3647
3755
|
}
|
|
3756
|
+
/** @enumType */
|
|
3757
|
+
export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
3648
3758
|
export declare enum Namespace {
|
|
3649
3759
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
3650
3760
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
@@ -3723,6 +3833,8 @@ export declare enum Namespace {
|
|
|
3723
3833
|
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
3724
3834
|
STANDALONE_FORMS = "STANDALONE_FORMS"
|
|
3725
3835
|
}
|
|
3836
|
+
/** @enumType */
|
|
3837
|
+
export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS';
|
|
3726
3838
|
/** Site transferred to another user. */
|
|
3727
3839
|
export interface SiteTransferred {
|
|
3728
3840
|
/**
|
|
@@ -3745,7 +3857,7 @@ export interface DeleteContext {
|
|
|
3745
3857
|
/** When the meta site was deleted. */
|
|
3746
3858
|
dateDeleted?: Date | null;
|
|
3747
3859
|
/** A status. */
|
|
3748
|
-
deleteStatus?:
|
|
3860
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
3749
3861
|
/**
|
|
3750
3862
|
* A reason (flow).
|
|
3751
3863
|
* @maxLength 255
|
|
@@ -3764,6 +3876,8 @@ export declare enum DeleteStatus {
|
|
|
3764
3876
|
PENDING_PURGE = "PENDING_PURGE",
|
|
3765
3877
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
3766
3878
|
}
|
|
3879
|
+
/** @enumType */
|
|
3880
|
+
export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
3767
3881
|
/** Restoration of the meta site. */
|
|
3768
3882
|
export interface SiteUndeleted {
|
|
3769
3883
|
}
|
|
@@ -3865,9 +3979,9 @@ export interface SiteHardDeleted {
|
|
|
3865
3979
|
}
|
|
3866
3980
|
export interface NamespaceChanged {
|
|
3867
3981
|
/** A previous namespace. */
|
|
3868
|
-
oldNamespace?:
|
|
3982
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
3869
3983
|
/** A new namespace. */
|
|
3870
|
-
newNamespace?:
|
|
3984
|
+
newNamespace?: NamespaceWithLiterals;
|
|
3871
3985
|
}
|
|
3872
3986
|
/** Assigned Studio editor */
|
|
3873
3987
|
export interface StudioAssigned {
|
|
@@ -3885,7 +3999,7 @@ export interface GetTicketDefinitionFromTrashBinRequest {
|
|
|
3885
3999
|
* Requested fields. Not implemented.
|
|
3886
4000
|
* @maxSize 5
|
|
3887
4001
|
*/
|
|
3888
|
-
fields?:
|
|
4002
|
+
fields?: FieldWithLiterals[];
|
|
3889
4003
|
}
|
|
3890
4004
|
export interface GetTicketDefinitionFromTrashBinResponse {
|
|
3891
4005
|
/** The requested ticket definition. */
|
|
@@ -3936,7 +4050,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3936
4050
|
*/
|
|
3937
4051
|
appId?: string;
|
|
3938
4052
|
/** @readonly */
|
|
3939
|
-
identityType?:
|
|
4053
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3940
4054
|
}
|
|
3941
4055
|
/** @oneof */
|
|
3942
4056
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3968,6 +4082,8 @@ export declare enum WebhookIdentityType {
|
|
|
3968
4082
|
WIX_USER = "WIX_USER",
|
|
3969
4083
|
APP = "APP"
|
|
3970
4084
|
}
|
|
4085
|
+
/** @enumType */
|
|
4086
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3971
4087
|
export interface GetTicketDefinitionSummaryRequest {
|
|
3972
4088
|
/**
|
|
3973
4089
|
* Ticket definition id.
|
|
@@ -4090,7 +4206,7 @@ export interface ReservationCreated {
|
|
|
4090
4206
|
/** Reservation expiration timestamp. */
|
|
4091
4207
|
expires?: Date | null;
|
|
4092
4208
|
/** Reservation status. */
|
|
4093
|
-
status?:
|
|
4209
|
+
status?: ReservationStatusWithLiterals;
|
|
4094
4210
|
/**
|
|
4095
4211
|
* Reservation ticket quantities.
|
|
4096
4212
|
* @maxSize 50
|
|
@@ -4116,6 +4232,8 @@ export declare enum ReservationStatus {
|
|
|
4116
4232
|
/** The reservation is expired. */
|
|
4117
4233
|
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
4118
4234
|
}
|
|
4235
|
+
/** @enumType */
|
|
4236
|
+
export type ReservationStatusWithLiterals = ReservationStatus | 'RESERVATION_PENDING' | 'RESERVATION_CONFIRMED' | 'RESERVATION_CANCELED' | 'RESERVATION_CANCELED_MANUALLY' | 'RESERVATION_EXPIRED';
|
|
4119
4237
|
export interface TicketQuantity {
|
|
4120
4238
|
/**
|
|
4121
4239
|
* Ticket definition ID.
|
|
@@ -4157,7 +4275,7 @@ export interface ReservationUpdated {
|
|
|
4157
4275
|
*/
|
|
4158
4276
|
reservationId?: string;
|
|
4159
4277
|
/** Reservation status. */
|
|
4160
|
-
status?:
|
|
4278
|
+
status?: ReservationStatusWithLiterals;
|
|
4161
4279
|
/** Reservation expiration timestamp. */
|
|
4162
4280
|
expires?: Date | null;
|
|
4163
4281
|
/**
|
|
@@ -4379,7 +4497,7 @@ export interface CreateTicketDefinitionOptions {
|
|
|
4379
4497
|
* Predefined sets of fields to return.
|
|
4380
4498
|
* @maxSize 5
|
|
4381
4499
|
*/
|
|
4382
|
-
fields?:
|
|
4500
|
+
fields?: FieldWithLiterals[];
|
|
4383
4501
|
}
|
|
4384
4502
|
/**
|
|
4385
4503
|
* > **Note:** This function replaces the deprecated `updateTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/updateticketdefinition).
|
|
@@ -4468,14 +4586,14 @@ export interface UpdateTicketDefinition {
|
|
|
4468
4586
|
/** Ticket pricing method. */
|
|
4469
4587
|
pricingMethod?: PricingMethod;
|
|
4470
4588
|
/** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
|
|
4471
|
-
feeType?:
|
|
4589
|
+
feeType?: FeeTypeEnumTypeWithLiterals;
|
|
4472
4590
|
/** Ticket sale period. */
|
|
4473
4591
|
salePeriod?: SalePeriod;
|
|
4474
4592
|
/**
|
|
4475
4593
|
* Ticket sale status.
|
|
4476
4594
|
* @readonly
|
|
4477
4595
|
*/
|
|
4478
|
-
saleStatus?:
|
|
4596
|
+
saleStatus?: SaleStatusEnumStatusWithLiterals;
|
|
4479
4597
|
/**
|
|
4480
4598
|
* Ticket sales information. <br>
|
|
4481
4599
|
* **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.
|
|
@@ -4501,7 +4619,7 @@ export interface UpdateTicketDefinitionOptions {
|
|
|
4501
4619
|
* Predefined sets of fields to return.
|
|
4502
4620
|
* @maxSize 5
|
|
4503
4621
|
*/
|
|
4504
|
-
fields?:
|
|
4622
|
+
fields?: FieldWithLiterals[];
|
|
4505
4623
|
}
|
|
4506
4624
|
/**
|
|
4507
4625
|
* > **Note:** This function replaces the deprecated `getTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/getticketdefinition).
|
|
@@ -4530,7 +4648,7 @@ export interface GetTicketDefinitionOptions {
|
|
|
4530
4648
|
* Predefined sets of fields to return.
|
|
4531
4649
|
* @maxSize 5
|
|
4532
4650
|
*/
|
|
4533
|
-
fields?:
|
|
4651
|
+
fields?: FieldWithLiterals[];
|
|
4534
4652
|
}
|
|
4535
4653
|
/**
|
|
4536
4654
|
* > **Note:** This function replaces the deprecated `deleteTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/deleteticketdefinition).
|
|
@@ -4627,7 +4745,7 @@ export interface QueryTicketDefinitionsOptions {
|
|
|
4627
4745
|
* Predefined sets of fields to return.
|
|
4628
4746
|
* @maxSize 5
|
|
4629
4747
|
*/
|
|
4630
|
-
fields?:
|
|
4748
|
+
fields?: FieldWithLiterals[] | undefined;
|
|
4631
4749
|
}
|
|
4632
4750
|
interface QueryCursorResult {
|
|
4633
4751
|
cursors: Cursors;
|
|
@@ -4716,7 +4834,7 @@ export interface QueryAvailableTicketDefinitionsOptions {
|
|
|
4716
4834
|
* Predefined sets of fields to return.
|
|
4717
4835
|
* @maxSize 5
|
|
4718
4836
|
*/
|
|
4719
|
-
fields?:
|
|
4837
|
+
fields?: FieldWithLiterals[];
|
|
4720
4838
|
}
|
|
4721
4839
|
/**
|
|
4722
4840
|
* Counts ticket definitions by the `saleStatus` field, including those with the `hidden` status.
|