@wix/auto_sdk_events_notifications 1.0.56 → 1.0.58
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/index.d.ts +1 -1
- package/build/cjs/index.js +29 -497
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +280 -3104
- package/build/cjs/index.typings.js +26 -496
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +280 -3122
- package/build/cjs/meta.js +26 -496
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs +29 -446
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +280 -3104
- package/build/es/index.typings.mjs +26 -445
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +280 -3122
- package/build/es/meta.mjs +26 -445
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.js +29 -497
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +280 -3104
- package/build/internal/cjs/index.typings.js +26 -496
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +280 -3122
- package/build/internal/cjs/meta.js +26 -496
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.mjs +29 -446
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +280 -3104
- package/build/internal/es/index.typings.mjs +26 -445
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +280 -3122
- package/build/internal/es/meta.mjs +26 -445
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -290,3015 +290,6 @@ interface ActionEvent {
|
|
|
290
290
|
}
|
|
291
291
|
interface Empty {
|
|
292
292
|
}
|
|
293
|
-
interface EventUpdated {
|
|
294
|
-
/** Event update timestamp in ISO UTC format. */
|
|
295
|
-
timestamp?: Date | null;
|
|
296
|
-
/**
|
|
297
|
-
* Event ID.
|
|
298
|
-
* @format GUID
|
|
299
|
-
*/
|
|
300
|
-
eventId?: string;
|
|
301
|
-
/** Event location. */
|
|
302
|
-
location?: Location;
|
|
303
|
-
/** Event schedule configuration. */
|
|
304
|
-
scheduleConfig?: ScheduleConfig;
|
|
305
|
-
/** Event title. */
|
|
306
|
-
title?: string;
|
|
307
|
-
/**
|
|
308
|
-
* Whether schedule configuration was updated.
|
|
309
|
-
* @deprecated
|
|
310
|
-
*/
|
|
311
|
-
scheduleConfigUpdated?: boolean;
|
|
312
|
-
/** Updated event */
|
|
313
|
-
event?: Event;
|
|
314
|
-
}
|
|
315
|
-
interface Location {
|
|
316
|
-
/**
|
|
317
|
-
* Location name.
|
|
318
|
-
* @maxLength 50
|
|
319
|
-
*/
|
|
320
|
-
name?: string | null;
|
|
321
|
-
/** Location map coordinates. */
|
|
322
|
-
coordinates?: MapCoordinates;
|
|
323
|
-
/**
|
|
324
|
-
* Single line address representation.
|
|
325
|
-
* @maxLength 300
|
|
326
|
-
*/
|
|
327
|
-
address?: string | null;
|
|
328
|
-
/** Location type. */
|
|
329
|
-
type?: LocationTypeWithLiterals;
|
|
330
|
-
/**
|
|
331
|
-
* Full address derived from formatted single line `address`.
|
|
332
|
-
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
333
|
-
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
334
|
-
*
|
|
335
|
-
* Migration notes:
|
|
336
|
-
* - `full_address.formatted_address` is equivalent to `address`.
|
|
337
|
-
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
338
|
-
*/
|
|
339
|
-
fullAddress?: Address;
|
|
340
|
-
/**
|
|
341
|
-
* Defines event location as TBD (To Be Determined).
|
|
342
|
-
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
343
|
-
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
344
|
-
*/
|
|
345
|
-
tbd?: boolean | null;
|
|
346
|
-
}
|
|
347
|
-
interface MapCoordinates {
|
|
348
|
-
/**
|
|
349
|
-
* Latitude.
|
|
350
|
-
* @min -90
|
|
351
|
-
* @max 90
|
|
352
|
-
*/
|
|
353
|
-
lat?: number;
|
|
354
|
-
/**
|
|
355
|
-
* Longitude.
|
|
356
|
-
* @min -180
|
|
357
|
-
* @max 180
|
|
358
|
-
*/
|
|
359
|
-
lng?: number;
|
|
360
|
-
}
|
|
361
|
-
declare enum LocationType {
|
|
362
|
-
VENUE = "VENUE",
|
|
363
|
-
ONLINE = "ONLINE"
|
|
364
|
-
}
|
|
365
|
-
/** @enumType */
|
|
366
|
-
type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
367
|
-
/** Physical address */
|
|
368
|
-
interface Address extends AddressStreetOneOf {
|
|
369
|
-
/** a break down of the street to number and street name */
|
|
370
|
-
streetAddress?: StreetAddress;
|
|
371
|
-
/** Main address line (usually street and number) as free text */
|
|
372
|
-
addressLine1?: string | null;
|
|
373
|
-
/**
|
|
374
|
-
* country code
|
|
375
|
-
* @format COUNTRY
|
|
376
|
-
*/
|
|
377
|
-
country?: string | null;
|
|
378
|
-
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
379
|
-
subdivision?: string | null;
|
|
380
|
-
/** city name */
|
|
381
|
-
city?: string | null;
|
|
382
|
-
/** zip/postal code */
|
|
383
|
-
postalCode?: string | null;
|
|
384
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
385
|
-
addressLine2?: string | null;
|
|
386
|
-
/** A string containing the human-readable address of this location */
|
|
387
|
-
formatted?: string | null;
|
|
388
|
-
/** Free text for human-to-human textual orientation aid purposes */
|
|
389
|
-
hint?: string | null;
|
|
390
|
-
/** coordinates of the physical address */
|
|
391
|
-
location?: AddressLocation;
|
|
392
|
-
/** country full-name */
|
|
393
|
-
countryFullname?: string | null;
|
|
394
|
-
/**
|
|
395
|
-
* multi-level subdivisions from top to bottom
|
|
396
|
-
* @maxSize 6
|
|
397
|
-
*/
|
|
398
|
-
subdivisions?: Subdivision[];
|
|
399
|
-
}
|
|
400
|
-
/** @oneof */
|
|
401
|
-
interface AddressStreetOneOf {
|
|
402
|
-
/** a break down of the street to number and street name */
|
|
403
|
-
streetAddress?: StreetAddress;
|
|
404
|
-
/** Main address line (usually street and number) as free text */
|
|
405
|
-
addressLine?: string | null;
|
|
406
|
-
}
|
|
407
|
-
interface StreetAddress {
|
|
408
|
-
/** street number */
|
|
409
|
-
number?: string;
|
|
410
|
-
/** street name */
|
|
411
|
-
name?: string;
|
|
412
|
-
}
|
|
413
|
-
interface AddressLocation {
|
|
414
|
-
/**
|
|
415
|
-
* address latitude coordinates
|
|
416
|
-
* @min -90
|
|
417
|
-
* @max 90
|
|
418
|
-
*/
|
|
419
|
-
latitude?: number | null;
|
|
420
|
-
/**
|
|
421
|
-
* address longitude coordinates
|
|
422
|
-
* @min -180
|
|
423
|
-
* @max 180
|
|
424
|
-
*/
|
|
425
|
-
longitude?: number | null;
|
|
426
|
-
}
|
|
427
|
-
interface Subdivision {
|
|
428
|
-
/** subdivision short code */
|
|
429
|
-
code?: string;
|
|
430
|
-
/** subdivision full-name */
|
|
431
|
-
name?: string;
|
|
432
|
-
}
|
|
433
|
-
declare enum SubdivisionType {
|
|
434
|
-
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
435
|
-
/** State */
|
|
436
|
-
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
437
|
-
/** County */
|
|
438
|
-
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
439
|
-
/** City/town */
|
|
440
|
-
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
441
|
-
/** Neighborhood/quarter */
|
|
442
|
-
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
443
|
-
/** Street/block */
|
|
444
|
-
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
445
|
-
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
446
|
-
COUNTRY = "COUNTRY"
|
|
447
|
-
}
|
|
448
|
-
/** @enumType */
|
|
449
|
-
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';
|
|
450
|
-
interface ScheduleConfig {
|
|
451
|
-
/**
|
|
452
|
-
* Defines event as TBD (To Be Determined) schedule.
|
|
453
|
-
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
454
|
-
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
455
|
-
*/
|
|
456
|
-
scheduleTbd?: boolean;
|
|
457
|
-
/**
|
|
458
|
-
* TBD message.
|
|
459
|
-
* @maxLength 100
|
|
460
|
-
*/
|
|
461
|
-
scheduleTbdMessage?: string | null;
|
|
462
|
-
/** Event start timestamp. */
|
|
463
|
-
startDate?: Date | null;
|
|
464
|
-
/** Event end timestamp. */
|
|
465
|
-
endDate?: Date | null;
|
|
466
|
-
/**
|
|
467
|
-
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
468
|
-
* @maxLength 100
|
|
469
|
-
*/
|
|
470
|
-
timeZoneId?: string | null;
|
|
471
|
-
/** Whether end date is hidden in the formatted schedule. */
|
|
472
|
-
endDateHidden?: boolean;
|
|
473
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
474
|
-
showTimeZone?: boolean;
|
|
475
|
-
/** Event recurrences. */
|
|
476
|
-
recurrences?: Recurrences;
|
|
477
|
-
}
|
|
478
|
-
interface Recurrences {
|
|
479
|
-
/**
|
|
480
|
-
* Event occurrences.
|
|
481
|
-
* @maxSize 1000
|
|
482
|
-
*/
|
|
483
|
-
occurrences?: Occurrence[];
|
|
484
|
-
/**
|
|
485
|
-
* Recurring event category ID.
|
|
486
|
-
* @readonly
|
|
487
|
-
*/
|
|
488
|
-
categoryId?: string | null;
|
|
489
|
-
/**
|
|
490
|
-
* Recurrence status.
|
|
491
|
-
* @readonly
|
|
492
|
-
*/
|
|
493
|
-
status?: StatusWithLiterals;
|
|
494
|
-
}
|
|
495
|
-
interface Occurrence {
|
|
496
|
-
/** Event start timestamp. */
|
|
497
|
-
startDate?: Date | null;
|
|
498
|
-
/** Event end timestamp. */
|
|
499
|
-
endDate?: Date | null;
|
|
500
|
-
/**
|
|
501
|
-
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
502
|
-
* @maxLength 100
|
|
503
|
-
*/
|
|
504
|
-
timeZoneId?: string | null;
|
|
505
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
506
|
-
showTimeZone?: boolean;
|
|
507
|
-
}
|
|
508
|
-
declare enum Status {
|
|
509
|
-
/** Event occurs only once. */
|
|
510
|
-
ONE_TIME = "ONE_TIME",
|
|
511
|
-
/** Event is recurring. */
|
|
512
|
-
RECURRING = "RECURRING",
|
|
513
|
-
/** Marks the next upcoming occurrence of the recurring event. */
|
|
514
|
-
RECURRING_NEXT = "RECURRING_NEXT",
|
|
515
|
-
/** Marks the most recent ended occurrence of the recurring event. */
|
|
516
|
-
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
517
|
-
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
518
|
-
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
519
|
-
}
|
|
520
|
-
/** @enumType */
|
|
521
|
-
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
522
|
-
interface Event {
|
|
523
|
-
/**
|
|
524
|
-
* Event ID.
|
|
525
|
-
* @format GUID
|
|
526
|
-
* @readonly
|
|
527
|
-
*/
|
|
528
|
-
_id?: string;
|
|
529
|
-
/** Event location. */
|
|
530
|
-
location?: Location;
|
|
531
|
-
/** Event scheduling. */
|
|
532
|
-
scheduling?: Scheduling;
|
|
533
|
-
/** Event title. */
|
|
534
|
-
title?: string;
|
|
535
|
-
/** Event description. */
|
|
536
|
-
description?: string;
|
|
537
|
-
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
538
|
-
about?: string;
|
|
539
|
-
/** Main event image. */
|
|
540
|
-
mainImage?: string;
|
|
541
|
-
/** Event slug URL (generated from event title). */
|
|
542
|
-
slug?: string;
|
|
543
|
-
/** ISO 639-1 language code of the event (used in content translations). */
|
|
544
|
-
language?: string;
|
|
545
|
-
/** Event creation timestamp. */
|
|
546
|
-
created?: Date | null;
|
|
547
|
-
/** Event modified timestamp. */
|
|
548
|
-
modified?: Date | null;
|
|
549
|
-
/** Event status. */
|
|
550
|
-
status?: EventStatusWithLiterals;
|
|
551
|
-
/** RSVP or ticketing registration details. */
|
|
552
|
-
registration?: Registration;
|
|
553
|
-
/** "Add to calendar" URLs. */
|
|
554
|
-
calendarLinks?: CalendarLinks;
|
|
555
|
-
/** Event page URL components. */
|
|
556
|
-
eventPageUrl?: SiteUrl;
|
|
557
|
-
/** Event registration form. */
|
|
558
|
-
form?: Form;
|
|
559
|
-
/** Event dashboard summary of RSVP / ticket sales. */
|
|
560
|
-
dashboard?: Dashboard;
|
|
561
|
-
/** Instance ID of the site where event is hosted. */
|
|
562
|
-
instanceId?: string;
|
|
563
|
-
/** Guest list configuration. */
|
|
564
|
-
guestListConfig?: GuestListConfig;
|
|
565
|
-
/**
|
|
566
|
-
* Event creator user ID.
|
|
567
|
-
* @maxLength 36
|
|
568
|
-
*/
|
|
569
|
-
userId?: string;
|
|
570
|
-
/** Event discussion feed. For internal use. */
|
|
571
|
-
feed?: Feed;
|
|
572
|
-
/** Online conferencing details. */
|
|
573
|
-
onlineConferencing?: OnlineConferencing;
|
|
574
|
-
/** SEO settings. */
|
|
575
|
-
seoSettings?: SeoSettings;
|
|
576
|
-
/** Assigned contacts label key. */
|
|
577
|
-
assignedContactsLabel?: string | null;
|
|
578
|
-
/** Agenda details. */
|
|
579
|
-
agenda?: Agenda;
|
|
580
|
-
/** Categories this event is assigned to. */
|
|
581
|
-
categories?: Category[];
|
|
582
|
-
/** Visual settings for event. */
|
|
583
|
-
eventDisplaySettings?: EventDisplaySettings;
|
|
584
|
-
/** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
|
|
585
|
-
longDescription?: RichContent;
|
|
586
|
-
/**
|
|
587
|
-
* Event publish timestamp.
|
|
588
|
-
* @readonly
|
|
589
|
-
*/
|
|
590
|
-
publishedDate?: Date | null;
|
|
591
|
-
}
|
|
592
|
-
interface Scheduling {
|
|
593
|
-
/** Schedule configuration. */
|
|
594
|
-
config?: ScheduleConfig;
|
|
595
|
-
/** Formatted schedule representation. */
|
|
596
|
-
formatted?: string;
|
|
597
|
-
/** Formatted start date of the event (empty for TBD schedules). */
|
|
598
|
-
startDateFormatted?: string;
|
|
599
|
-
/** Formatted start time of the event (empty for TBD schedules). */
|
|
600
|
-
startTimeFormatted?: string;
|
|
601
|
-
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
602
|
-
endDateFormatted?: string;
|
|
603
|
-
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
604
|
-
endTimeFormatted?: string;
|
|
605
|
-
}
|
|
606
|
-
declare enum EventStatus {
|
|
607
|
-
/** Event is public and scheduled to start */
|
|
608
|
-
SCHEDULED = "SCHEDULED",
|
|
609
|
-
/** Event has started */
|
|
610
|
-
STARTED = "STARTED",
|
|
611
|
-
/** Event has ended */
|
|
612
|
-
ENDED = "ENDED",
|
|
613
|
-
/** Event was canceled */
|
|
614
|
-
CANCELED = "CANCELED"
|
|
615
|
-
}
|
|
616
|
-
/** @enumType */
|
|
617
|
-
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
618
|
-
interface Registration {
|
|
619
|
-
/** Event type. */
|
|
620
|
-
type?: EventTypeWithLiterals;
|
|
621
|
-
/** Event registration status. */
|
|
622
|
-
status?: RegistrationStatusWithLiterals;
|
|
623
|
-
/** RSVP collection details. */
|
|
624
|
-
rsvpCollection?: RsvpCollection;
|
|
625
|
-
/** Ticketing details. */
|
|
626
|
-
ticketing?: Ticketing;
|
|
627
|
-
/** External registration details. */
|
|
628
|
-
external?: ExternalEvent;
|
|
629
|
-
/** Types of users allowed to register. */
|
|
630
|
-
restrictedTo?: VisitorTypeWithLiterals;
|
|
631
|
-
/** Initial event type which was set when creating an event. */
|
|
632
|
-
initialType?: EventTypeWithLiterals;
|
|
633
|
-
}
|
|
634
|
-
declare enum EventType {
|
|
635
|
-
/** Type not available for this request fieldset */
|
|
636
|
-
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
637
|
-
/** Registration via RSVP */
|
|
638
|
-
RSVP = "RSVP",
|
|
639
|
-
/** Registration via ticket purchase */
|
|
640
|
-
TICKETS = "TICKETS",
|
|
641
|
-
/** External registration */
|
|
642
|
-
EXTERNAL = "EXTERNAL",
|
|
643
|
-
/** Registration not available */
|
|
644
|
-
NO_REGISTRATION = "NO_REGISTRATION"
|
|
645
|
-
}
|
|
646
|
-
/** @enumType */
|
|
647
|
-
type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
648
|
-
declare enum RegistrationStatus {
|
|
649
|
-
/** Registration status is not applicable */
|
|
650
|
-
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
651
|
-
/** Registration to event is closed */
|
|
652
|
-
CLOSED = "CLOSED",
|
|
653
|
-
/** Registration to event is closed manually */
|
|
654
|
-
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
655
|
-
/** Registration is open via RSVP */
|
|
656
|
-
OPEN_RSVP = "OPEN_RSVP",
|
|
657
|
-
/** Registration to event waitlist is open via RSVP */
|
|
658
|
-
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
659
|
-
/** Registration is open via ticket purchase */
|
|
660
|
-
OPEN_TICKETS = "OPEN_TICKETS",
|
|
661
|
-
/** Registration is open via external URL */
|
|
662
|
-
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
663
|
-
/** Registration will be open via RSVP */
|
|
664
|
-
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
665
|
-
}
|
|
666
|
-
/** @enumType */
|
|
667
|
-
type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
668
|
-
interface RsvpCollection {
|
|
669
|
-
/** RSVP collection configuration. */
|
|
670
|
-
config?: RsvpCollectionConfig;
|
|
671
|
-
}
|
|
672
|
-
interface RsvpCollectionConfig {
|
|
673
|
-
/** Defines the supported RSVP statuses. */
|
|
674
|
-
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
675
|
-
/**
|
|
676
|
-
* Total guest limit available to register to the event.
|
|
677
|
-
* Additional guests per RSVP are counted towards total guests.
|
|
678
|
-
*/
|
|
679
|
-
limit?: number | null;
|
|
680
|
-
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
681
|
-
waitlist?: boolean;
|
|
682
|
-
/** Registration start timestamp. */
|
|
683
|
-
startDate?: Date | null;
|
|
684
|
-
/** Registration end timestamp. */
|
|
685
|
-
endDate?: Date | null;
|
|
686
|
-
}
|
|
687
|
-
declare enum RsvpStatusOptions {
|
|
688
|
-
/** Only YES RSVP status is available for RSVP registration */
|
|
689
|
-
YES_ONLY = "YES_ONLY",
|
|
690
|
-
/** YES and NO RSVP status options are available for the registration */
|
|
691
|
-
YES_AND_NO = "YES_AND_NO"
|
|
692
|
-
}
|
|
693
|
-
/** @enumType */
|
|
694
|
-
type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
695
|
-
interface RsvpConfirmationMessages {
|
|
696
|
-
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
697
|
-
positiveConfirmation?: RsvpConfirmationMessagesPositiveResponseConfirmation;
|
|
698
|
-
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
699
|
-
waitlistMessages?: RsvpConfirmationMessagesPositiveResponseConfirmation;
|
|
700
|
-
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
701
|
-
negativeMessages?: RsvpConfirmationMessagesNegativeResponseConfirmation;
|
|
702
|
-
}
|
|
703
|
-
/** Confirmation shown after then registration when RSVP response is positive. */
|
|
704
|
-
interface RsvpConfirmationMessagesPositiveResponseConfirmation {
|
|
705
|
-
/**
|
|
706
|
-
* Confirmation message title.
|
|
707
|
-
* @maxLength 150
|
|
708
|
-
*/
|
|
709
|
-
title?: string | null;
|
|
710
|
-
/**
|
|
711
|
-
* Confirmation message text.
|
|
712
|
-
* @maxLength 350
|
|
713
|
-
*/
|
|
714
|
-
message?: string | null;
|
|
715
|
-
/**
|
|
716
|
-
* "Add to calendar" call-to-action label text.
|
|
717
|
-
* @maxLength 50
|
|
718
|
-
*/
|
|
719
|
-
addToCalendarActionLabel?: string | null;
|
|
720
|
-
/**
|
|
721
|
-
* "Share event" call-to-action label text.
|
|
722
|
-
* @maxLength 50
|
|
723
|
-
*/
|
|
724
|
-
shareActionLabel?: string | null;
|
|
725
|
-
}
|
|
726
|
-
/** Confirmation shown after then registration when RSVP response is negative. */
|
|
727
|
-
interface RsvpConfirmationMessagesNegativeResponseConfirmation {
|
|
728
|
-
/**
|
|
729
|
-
* Confirmation message title.
|
|
730
|
-
* @maxLength 150
|
|
731
|
-
*/
|
|
732
|
-
title?: string | null;
|
|
733
|
-
/**
|
|
734
|
-
* "Share event" call-to-action label text.
|
|
735
|
-
* @maxLength 50
|
|
736
|
-
*/
|
|
737
|
-
shareActionLabel?: string | null;
|
|
738
|
-
}
|
|
739
|
-
interface Ticketing {
|
|
740
|
-
/**
|
|
741
|
-
* Deprecated.
|
|
742
|
-
* @deprecated
|
|
743
|
-
*/
|
|
744
|
-
lowestPrice?: string | null;
|
|
745
|
-
/**
|
|
746
|
-
* Deprecated.
|
|
747
|
-
* @deprecated
|
|
748
|
-
*/
|
|
749
|
-
highestPrice?: string | null;
|
|
750
|
-
/** Currency used in event transactions. */
|
|
751
|
-
currency?: string | null;
|
|
752
|
-
/** Ticketing configuration. */
|
|
753
|
-
config?: TicketingConfig;
|
|
754
|
-
/**
|
|
755
|
-
* Price of lowest priced ticket.
|
|
756
|
-
* @readonly
|
|
757
|
-
*/
|
|
758
|
-
lowestTicketPrice?: Money;
|
|
759
|
-
/**
|
|
760
|
-
* Price of highest priced ticket.
|
|
761
|
-
* @readonly
|
|
762
|
-
*/
|
|
763
|
-
highestTicketPrice?: Money;
|
|
764
|
-
/**
|
|
765
|
-
* Formatted price of lowest priced ticket.
|
|
766
|
-
* @readonly
|
|
767
|
-
*/
|
|
768
|
-
lowestTicketPriceFormatted?: string | null;
|
|
769
|
-
/**
|
|
770
|
-
* Formatted price of highest priced ticket.
|
|
771
|
-
* @readonly
|
|
772
|
-
*/
|
|
773
|
-
highestTicketPriceFormatted?: string | null;
|
|
774
|
-
/**
|
|
775
|
-
* Whether all tickets are sold for this event.
|
|
776
|
-
* @readonly
|
|
777
|
-
*/
|
|
778
|
-
soldOut?: boolean | null;
|
|
779
|
-
}
|
|
780
|
-
interface TicketingConfig {
|
|
781
|
-
/** Whether the form must be filled out separately for each ticket. */
|
|
782
|
-
guestAssignedTickets?: boolean;
|
|
783
|
-
/** Tax configuration. */
|
|
784
|
-
taxConfig?: TaxConfig;
|
|
785
|
-
/**
|
|
786
|
-
* Limit of tickets that can be purchased per order, default 20.
|
|
787
|
-
* @max 50
|
|
788
|
-
*/
|
|
789
|
-
ticketLimitPerOrder?: number;
|
|
790
|
-
/**
|
|
791
|
-
* Duration for which the tickets being bought are reserved.
|
|
792
|
-
* @min 5
|
|
793
|
-
* @max 30
|
|
794
|
-
*/
|
|
795
|
-
reservationDurationInMinutes?: number | null;
|
|
796
|
-
}
|
|
797
|
-
interface TaxConfig {
|
|
798
|
-
/** Tax application settings. */
|
|
799
|
-
type?: TaxTypeWithLiterals;
|
|
800
|
-
/**
|
|
801
|
-
* Tax name.
|
|
802
|
-
* @minLength 1
|
|
803
|
-
* @maxLength 10
|
|
804
|
-
*/
|
|
805
|
-
name?: string | null;
|
|
806
|
-
/**
|
|
807
|
-
* Tax rate (e.g.,`21.55`).
|
|
808
|
-
* @decimalValue options { gte:0.001, lte:100, maxScale:3 }
|
|
809
|
-
*/
|
|
810
|
-
rate?: string | null;
|
|
811
|
-
/** Applies taxes for donations, default true. */
|
|
812
|
-
appliesToDonations?: boolean | null;
|
|
813
|
-
}
|
|
814
|
-
declare enum TaxType {
|
|
815
|
-
/** Tax is included in the ticket price. */
|
|
816
|
-
INCLUDED = "INCLUDED",
|
|
817
|
-
/** Tax is added to the order at the checkout. */
|
|
818
|
-
ADDED = "ADDED",
|
|
819
|
-
/** Tax is added to the final total at the checkout. */
|
|
820
|
-
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
821
|
-
}
|
|
822
|
-
/** @enumType */
|
|
823
|
-
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
824
|
-
interface TicketsConfirmationMessages {
|
|
825
|
-
/**
|
|
826
|
-
* Confirmation message title.
|
|
827
|
-
* @maxLength 150
|
|
828
|
-
*/
|
|
829
|
-
title?: string | null;
|
|
830
|
-
/**
|
|
831
|
-
* Confirmation message text.
|
|
832
|
-
* @maxLength 350
|
|
833
|
-
*/
|
|
834
|
-
message?: string | null;
|
|
835
|
-
/**
|
|
836
|
-
* "Download tickets" call-to-action label text.
|
|
837
|
-
* @maxLength 50
|
|
838
|
-
*/
|
|
839
|
-
downloadTicketsLabel?: string | null;
|
|
840
|
-
/**
|
|
841
|
-
* "Add to calendar" call-to-action label text.
|
|
842
|
-
* @maxLength 50
|
|
843
|
-
*/
|
|
844
|
-
addToCalendarActionLabel?: string | null;
|
|
845
|
-
/**
|
|
846
|
-
* "Share event" call-to-action label text.
|
|
847
|
-
* @maxLength 50
|
|
848
|
-
*/
|
|
849
|
-
shareActionLabel?: string | null;
|
|
850
|
-
}
|
|
851
|
-
declare enum CheckoutType {
|
|
852
|
-
UNKNOWN_CHECKOUT_TYPE = "UNKNOWN_CHECKOUT_TYPE",
|
|
853
|
-
/** Checkout using Events App. */
|
|
854
|
-
EVENTS_APP = "EVENTS_APP",
|
|
855
|
-
/** Checkout using Ecomm Platform. */
|
|
856
|
-
ECOMM_PLATFORM = "ECOMM_PLATFORM"
|
|
857
|
-
}
|
|
858
|
-
/** @enumType */
|
|
859
|
-
type CheckoutTypeWithLiterals = CheckoutType | 'UNKNOWN_CHECKOUT_TYPE' | 'EVENTS_APP' | 'ECOMM_PLATFORM';
|
|
860
|
-
interface Money {
|
|
861
|
-
/**
|
|
862
|
-
* *Deprecated:** Use `value` instead.
|
|
863
|
-
* @format DECIMAL_VALUE
|
|
864
|
-
* @deprecated
|
|
865
|
-
*/
|
|
866
|
-
amount?: string;
|
|
867
|
-
/**
|
|
868
|
-
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
|
|
869
|
-
* @format CURRENCY
|
|
870
|
-
*/
|
|
871
|
-
currency?: string;
|
|
872
|
-
/**
|
|
873
|
-
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
|
|
874
|
-
* @format DECIMAL_VALUE
|
|
875
|
-
*/
|
|
876
|
-
value?: string | null;
|
|
877
|
-
}
|
|
878
|
-
interface ExternalEvent {
|
|
879
|
-
/** External event registration URL. */
|
|
880
|
-
registration?: string;
|
|
881
|
-
}
|
|
882
|
-
declare enum VisitorType {
|
|
883
|
-
/** Site visitor (including member) */
|
|
884
|
-
VISITOR = "VISITOR",
|
|
885
|
-
/** Site member */
|
|
886
|
-
MEMBER = "MEMBER",
|
|
887
|
-
/** Site visitor or member */
|
|
888
|
-
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
889
|
-
}
|
|
890
|
-
/** @enumType */
|
|
891
|
-
type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
892
|
-
interface CalendarLinks {
|
|
893
|
-
/** "Add to Google calendar" URL. */
|
|
894
|
-
google?: string;
|
|
895
|
-
/** "Download ICS calendar file" URL. */
|
|
896
|
-
ics?: string;
|
|
897
|
-
}
|
|
898
|
-
/** Site URL components */
|
|
899
|
-
interface SiteUrl {
|
|
900
|
-
/**
|
|
901
|
-
* Base URL. For premium sites, this will be the domain.
|
|
902
|
-
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
903
|
-
*/
|
|
904
|
-
base?: string;
|
|
905
|
-
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
906
|
-
path?: string;
|
|
907
|
-
}
|
|
908
|
-
/**
|
|
909
|
-
* The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
|
|
910
|
-
* It also contains customizable messages and labels.
|
|
911
|
-
*
|
|
912
|
-
*
|
|
913
|
-
* A form is an ordered list of controls (blocks), which accept guest information into a field input.
|
|
914
|
-
*
|
|
915
|
-
* Each control contains one or more nested inputs. For example, `Name` control has two inputs:
|
|
916
|
-
* - First Name
|
|
917
|
-
* - Last Name
|
|
918
|
-
*
|
|
919
|
-
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
920
|
-
*/
|
|
921
|
-
interface Form {
|
|
922
|
-
/** Nested fields as an ordered list. */
|
|
923
|
-
controls?: InputControl[];
|
|
924
|
-
/**
|
|
925
|
-
* Set of defined form messages displayed in the UI before, during, and after a registration flow.
|
|
926
|
-
* Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
927
|
-
*/
|
|
928
|
-
messages?: FormMessages;
|
|
929
|
-
}
|
|
930
|
-
/**
|
|
931
|
-
* A block of nested fields.
|
|
932
|
-
* Used to aggregate similar inputs like First Name and Last Name.
|
|
933
|
-
*/
|
|
934
|
-
interface InputControl {
|
|
935
|
-
/** Field control type. */
|
|
936
|
-
type?: InputControlTypeWithLiterals;
|
|
937
|
-
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
938
|
-
system?: boolean;
|
|
939
|
-
/**
|
|
940
|
-
* Deprecated: Use `id` or `_id`.
|
|
941
|
-
* @deprecated
|
|
942
|
-
*/
|
|
943
|
-
name?: string;
|
|
944
|
-
/** Child inputs. */
|
|
945
|
-
inputs?: Input[];
|
|
946
|
-
/**
|
|
947
|
-
* *Deprecated:** Use `controls.inputs.label`.
|
|
948
|
-
* @deprecated
|
|
949
|
-
*/
|
|
950
|
-
label?: string;
|
|
951
|
-
/** Field controls are sorted by this value in ascending order. */
|
|
952
|
-
orderIndex?: number;
|
|
953
|
-
/** Unique control ID. */
|
|
954
|
-
_id?: string;
|
|
955
|
-
/**
|
|
956
|
-
* Whether the input control is deleted.
|
|
957
|
-
* @readonly
|
|
958
|
-
*/
|
|
959
|
-
deleted?: boolean | null;
|
|
960
|
-
}
|
|
961
|
-
declare enum InputControlType {
|
|
962
|
-
/** Single text value field. */
|
|
963
|
-
INPUT = "INPUT",
|
|
964
|
-
/** Single text value field with multiple lines. */
|
|
965
|
-
TEXTAREA = "TEXTAREA",
|
|
966
|
-
/** Single-choice field with predefined values. */
|
|
967
|
-
DROPDOWN = "DROPDOWN",
|
|
968
|
-
/** Single-choice field with predefined values. */
|
|
969
|
-
RADIO = "RADIO",
|
|
970
|
-
/** Multiple-choice field with predefined values. */
|
|
971
|
-
CHECKBOX = "CHECKBOX",
|
|
972
|
-
/** Fields for entering first and last names. */
|
|
973
|
-
NAME = "NAME",
|
|
974
|
-
/** Fields for additional guests and their respective names. */
|
|
975
|
-
GUEST_CONTROL = "GUEST_CONTROL",
|
|
976
|
-
/** Single-line address field. */
|
|
977
|
-
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
978
|
-
/** Full address field with multiple lines. */
|
|
979
|
-
ADDRESS_FULL = "ADDRESS_FULL",
|
|
980
|
-
/** Fields for entering year, month, and day. */
|
|
981
|
-
DATE = "DATE"
|
|
982
|
-
}
|
|
983
|
-
/** @enumType */
|
|
984
|
-
type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
985
|
-
/** Child inputs. */
|
|
986
|
-
interface Input {
|
|
987
|
-
/** Field name. */
|
|
988
|
-
name?: string;
|
|
989
|
-
/**
|
|
990
|
-
* *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
|
|
991
|
-
* @deprecated
|
|
992
|
-
*/
|
|
993
|
-
array?: boolean;
|
|
994
|
-
/** Main field label. */
|
|
995
|
-
label?: string;
|
|
996
|
-
/** Additional labels for multi-valued fields such as address. */
|
|
997
|
-
additionalLabels?: Record<string, string>;
|
|
998
|
-
/** Predefined choice options for fields, such as dropdown. */
|
|
999
|
-
options?: string[];
|
|
1000
|
-
/** Whether field is mandatory. */
|
|
1001
|
-
mandatory?: boolean;
|
|
1002
|
-
/** Maximum number of accepted characters (relevant for text fields). */
|
|
1003
|
-
maxLength?: number;
|
|
1004
|
-
/**
|
|
1005
|
-
* Type which determines field format.
|
|
1006
|
-
* Used to validate submitted response.
|
|
1007
|
-
*/
|
|
1008
|
-
type?: ValueTypeWithLiterals;
|
|
1009
|
-
/**
|
|
1010
|
-
* The maximum number of accepted values for array input.
|
|
1011
|
-
*
|
|
1012
|
-
* **Note:** Only applicable for `TEXT_ARRAY` input fields.
|
|
1013
|
-
*/
|
|
1014
|
-
maxSize?: number | null;
|
|
1015
|
-
/**
|
|
1016
|
-
* Default option initially selected when an input has multiple choices.
|
|
1017
|
-
*
|
|
1018
|
-
* Defaults to first (0th) option, if not configured.
|
|
1019
|
-
* Currently only applicable for `type.dropdown`.
|
|
1020
|
-
*/
|
|
1021
|
-
defaultOptionSelection?: OptionSelection;
|
|
1022
|
-
/**
|
|
1023
|
-
* Additional labels for multi-valued fields, such as address.
|
|
1024
|
-
* @readonly
|
|
1025
|
-
*/
|
|
1026
|
-
labels?: Label[];
|
|
1027
|
-
}
|
|
1028
|
-
declare enum ValueType {
|
|
1029
|
-
TEXT = "TEXT",
|
|
1030
|
-
NUMBER = "NUMBER",
|
|
1031
|
-
TEXT_ARRAY = "TEXT_ARRAY",
|
|
1032
|
-
DATE_TIME = "DATE_TIME",
|
|
1033
|
-
ADDRESS = "ADDRESS"
|
|
1034
|
-
}
|
|
1035
|
-
/** @enumType */
|
|
1036
|
-
type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
1037
|
-
/**
|
|
1038
|
-
* Describes initially selected option when an input has multiple choices.
|
|
1039
|
-
* Defaults to first (0th) option if not configured.
|
|
1040
|
-
*/
|
|
1041
|
-
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
1042
|
-
/**
|
|
1043
|
-
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
1044
|
-
* @max 199
|
|
1045
|
-
*/
|
|
1046
|
-
optionIndex?: number;
|
|
1047
|
-
/**
|
|
1048
|
-
* Placeholder hint describing expected choices, such as "Please select".
|
|
1049
|
-
* Considered an empty choice.
|
|
1050
|
-
* @maxLength 200
|
|
1051
|
-
*/
|
|
1052
|
-
placeholderText?: string;
|
|
1053
|
-
}
|
|
1054
|
-
/** @oneof */
|
|
1055
|
-
interface OptionSelectionSelectedOptionOneOf {
|
|
1056
|
-
/**
|
|
1057
|
-
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
1058
|
-
* @max 199
|
|
1059
|
-
*/
|
|
1060
|
-
optionIndex?: number;
|
|
1061
|
-
/**
|
|
1062
|
-
* Placeholder hint describing expected choices, such as "Please select".
|
|
1063
|
-
* Considered an empty choice.
|
|
1064
|
-
* @maxLength 200
|
|
1065
|
-
*/
|
|
1066
|
-
placeholderText?: string;
|
|
1067
|
-
}
|
|
1068
|
-
interface Label {
|
|
1069
|
-
/** Field name. */
|
|
1070
|
-
name?: string;
|
|
1071
|
-
/** Field label. */
|
|
1072
|
-
label?: string;
|
|
1073
|
-
}
|
|
1074
|
-
/**
|
|
1075
|
-
* Defines form messages shown in UI before, during, and after registration flow.
|
|
1076
|
-
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
1077
|
-
*/
|
|
1078
|
-
interface FormMessages {
|
|
1079
|
-
/** [RSVP form](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction) messages. */
|
|
1080
|
-
rsvp?: RsvpFormMessages;
|
|
1081
|
-
/** Checkout form messages. */
|
|
1082
|
-
checkout?: CheckoutFormMessages;
|
|
1083
|
-
/** Messages shown when event registration is closed. */
|
|
1084
|
-
registrationClosed?: RegistrationClosedMessages;
|
|
1085
|
-
/** Messages shown when event tickets are unavailable. */
|
|
1086
|
-
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
1087
|
-
}
|
|
1088
|
-
interface RsvpFormMessages {
|
|
1089
|
-
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
1090
|
-
rsvpYesOption?: string;
|
|
1091
|
-
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
1092
|
-
rsvpNoOption?: string;
|
|
1093
|
-
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
1094
|
-
positiveMessages?: Positive;
|
|
1095
|
-
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
1096
|
-
waitlistMessages?: Positive;
|
|
1097
|
-
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
1098
|
-
negativeMessages?: Negative;
|
|
1099
|
-
/** "Submit form" call-to-action label text. */
|
|
1100
|
-
submitActionLabel?: string;
|
|
1101
|
-
}
|
|
1102
|
-
/** Confirmation messages shown after registration. */
|
|
1103
|
-
interface PositiveResponseConfirmation {
|
|
1104
|
-
/** Confirmation message title. */
|
|
1105
|
-
title?: string;
|
|
1106
|
-
/** Confirmation message text. */
|
|
1107
|
-
message?: string;
|
|
1108
|
-
/** "Add to calendar" call-to-action label text. */
|
|
1109
|
-
addToCalendarActionLabel?: string;
|
|
1110
|
-
/** "Share event" call-to-action label text. */
|
|
1111
|
-
shareActionLabel?: string;
|
|
1112
|
-
}
|
|
1113
|
-
/** Confirmation messages shown after registration. */
|
|
1114
|
-
interface NegativeResponseConfirmation {
|
|
1115
|
-
/** Confirmation message title. */
|
|
1116
|
-
title?: string;
|
|
1117
|
-
/** "Share event" call-to-action label text. */
|
|
1118
|
-
shareActionLabel?: string;
|
|
1119
|
-
}
|
|
1120
|
-
/** Set of messages shown during registration when RSVP response is positive. */
|
|
1121
|
-
interface Positive {
|
|
1122
|
-
/** Main form title for positive response. */
|
|
1123
|
-
title?: string;
|
|
1124
|
-
/** Confirmation messages shown after registration. */
|
|
1125
|
-
confirmation?: PositiveResponseConfirmation;
|
|
1126
|
-
}
|
|
1127
|
-
/** A set of messages shown during registration with negative response */
|
|
1128
|
-
interface Negative {
|
|
1129
|
-
/** Main form title for negative response. */
|
|
1130
|
-
title?: string;
|
|
1131
|
-
/** Confirmation messages shown after registration. */
|
|
1132
|
-
confirmation?: NegativeResponseConfirmation;
|
|
1133
|
-
}
|
|
1134
|
-
interface CheckoutFormMessages {
|
|
1135
|
-
/** Main form title for response. */
|
|
1136
|
-
title?: string;
|
|
1137
|
-
/** Submit form call-to-action label text. */
|
|
1138
|
-
submitActionLabel?: string;
|
|
1139
|
-
/** Confirmation messages shown after checkout. */
|
|
1140
|
-
confirmation?: ResponseConfirmation;
|
|
1141
|
-
}
|
|
1142
|
-
/** Confirmation messages shown after checkout. */
|
|
1143
|
-
interface ResponseConfirmation {
|
|
1144
|
-
/** Confirmation message title. */
|
|
1145
|
-
title?: string;
|
|
1146
|
-
/** Confirmation message text. */
|
|
1147
|
-
message?: string;
|
|
1148
|
-
/** "Download tickets" call-to-action label text. */
|
|
1149
|
-
downloadTicketsLabel?: string;
|
|
1150
|
-
/** "Add to calendar" call-to-action label text. */
|
|
1151
|
-
addToCalendarLabel?: string;
|
|
1152
|
-
/** "Share event" call-to-action label text. */
|
|
1153
|
-
shareEventLabel?: string;
|
|
1154
|
-
}
|
|
1155
|
-
interface RegistrationClosedMessages {
|
|
1156
|
-
/** Message shown when event registration is closed. */
|
|
1157
|
-
message?: string;
|
|
1158
|
-
/** "Explore other events" call-to-action label text. */
|
|
1159
|
-
exploreEventsActionLabel?: string;
|
|
1160
|
-
}
|
|
1161
|
-
interface TicketsUnavailableMessages {
|
|
1162
|
-
/** Message shown when event tickets are unavailable. */
|
|
1163
|
-
message?: string;
|
|
1164
|
-
/** "Explore other events" call-to-action label text. */
|
|
1165
|
-
exploreEventsActionLabel?: string;
|
|
1166
|
-
}
|
|
1167
|
-
interface Dashboard {
|
|
1168
|
-
/** Guest RSVP summary. */
|
|
1169
|
-
rsvpSummary?: RsvpSummary;
|
|
1170
|
-
/**
|
|
1171
|
-
* Summary of revenue and tickets sold.
|
|
1172
|
-
* (Archived orders are not included).
|
|
1173
|
-
*/
|
|
1174
|
-
ticketingSummary?: TicketingSummary;
|
|
1175
|
-
}
|
|
1176
|
-
interface RsvpSummary {
|
|
1177
|
-
/** Total number of RSVPs. */
|
|
1178
|
-
total?: number;
|
|
1179
|
-
/** Number of RSVPs with status `YES`. */
|
|
1180
|
-
yes?: number;
|
|
1181
|
-
/** Number of RSVPs with status `NO`. */
|
|
1182
|
-
no?: number;
|
|
1183
|
-
/** Number of RSVPs in waitlist. */
|
|
1184
|
-
waitlist?: number;
|
|
1185
|
-
}
|
|
1186
|
-
interface TicketingSummary {
|
|
1187
|
-
/** Number of tickets sold. */
|
|
1188
|
-
tickets?: number;
|
|
1189
|
-
/**
|
|
1190
|
-
* Total revenue, excluding fees.
|
|
1191
|
-
* (taxes and payment provider fees are not deducted.)
|
|
1192
|
-
*/
|
|
1193
|
-
revenue?: Money;
|
|
1194
|
-
/** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
|
|
1195
|
-
currencyLocked?: boolean;
|
|
1196
|
-
/** Number of orders placed. */
|
|
1197
|
-
orders?: number;
|
|
1198
|
-
/** Total balance of confirmed transactions. */
|
|
1199
|
-
totalSales?: Money;
|
|
1200
|
-
}
|
|
1201
|
-
interface GuestListConfig {
|
|
1202
|
-
/** Whether members can see other members attending the event (defaults to true). */
|
|
1203
|
-
publicGuestList?: boolean;
|
|
1204
|
-
}
|
|
1205
|
-
interface Feed {
|
|
1206
|
-
/** Event discussion feed token. */
|
|
1207
|
-
token?: string;
|
|
1208
|
-
}
|
|
1209
|
-
interface OnlineConferencing {
|
|
1210
|
-
config?: OnlineConferencingConfig;
|
|
1211
|
-
session?: OnlineConferencingSession;
|
|
1212
|
-
}
|
|
1213
|
-
interface OnlineConferencingConfig {
|
|
1214
|
-
/**
|
|
1215
|
-
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1216
|
-
* When enabled, links to join conferencing are generated and provided to guests.
|
|
1217
|
-
*/
|
|
1218
|
-
enabled?: boolean;
|
|
1219
|
-
/**
|
|
1220
|
-
* Conferencing provider ID.
|
|
1221
|
-
* @format GUID
|
|
1222
|
-
*/
|
|
1223
|
-
providerId?: string | null;
|
|
1224
|
-
/** Conference type */
|
|
1225
|
-
conferenceType?: ConferenceTypeWithLiterals;
|
|
1226
|
-
}
|
|
1227
|
-
declare enum ConferenceType {
|
|
1228
|
-
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1229
|
-
MEETING = "MEETING",
|
|
1230
|
-
/** Guests can only subscribe to video and audio. */
|
|
1231
|
-
WEBINAR = "WEBINAR"
|
|
1232
|
-
}
|
|
1233
|
-
/** @enumType */
|
|
1234
|
-
type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
1235
|
-
interface OnlineConferencingSession {
|
|
1236
|
-
/**
|
|
1237
|
-
* Link for event host to start the online conference session.
|
|
1238
|
-
* @readonly
|
|
1239
|
-
*/
|
|
1240
|
-
hostLink?: string;
|
|
1241
|
-
/**
|
|
1242
|
-
* Link for guests to join the online conference session.
|
|
1243
|
-
* @readonly
|
|
1244
|
-
*/
|
|
1245
|
-
guestLink?: string;
|
|
1246
|
-
/**
|
|
1247
|
-
* The password required to join online conferencing session (when relevant).
|
|
1248
|
-
* @readonly
|
|
1249
|
-
*/
|
|
1250
|
-
password?: string | null;
|
|
1251
|
-
/**
|
|
1252
|
-
* Indicates that session was created successfully on providers side.
|
|
1253
|
-
* @readonly
|
|
1254
|
-
*/
|
|
1255
|
-
sessionCreated?: boolean | null;
|
|
1256
|
-
/**
|
|
1257
|
-
* Unique session id
|
|
1258
|
-
* @readonly
|
|
1259
|
-
*/
|
|
1260
|
-
sessionId?: string | null;
|
|
1261
|
-
}
|
|
1262
|
-
interface SeoSettings {
|
|
1263
|
-
/**
|
|
1264
|
-
* URL slug
|
|
1265
|
-
* @maxLength 130
|
|
1266
|
-
*/
|
|
1267
|
-
slug?: string;
|
|
1268
|
-
/** Advanced SEO data */
|
|
1269
|
-
advancedSeoData?: SeoSchema;
|
|
1270
|
-
/**
|
|
1271
|
-
* Hidden from SEO Site Map
|
|
1272
|
-
* @readonly
|
|
1273
|
-
*/
|
|
1274
|
-
hidden?: boolean | null;
|
|
1275
|
-
}
|
|
1276
|
-
/**
|
|
1277
|
-
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
1278
|
-
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1279
|
-
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
1280
|
-
*/
|
|
1281
|
-
interface SeoSchema {
|
|
1282
|
-
/** SEO tag information. */
|
|
1283
|
-
tags?: Tag[];
|
|
1284
|
-
/** SEO general settings. */
|
|
1285
|
-
settings?: Settings;
|
|
1286
|
-
}
|
|
1287
|
-
interface Keyword {
|
|
1288
|
-
/** Keyword value. */
|
|
1289
|
-
term?: string;
|
|
1290
|
-
/** Whether the keyword is the main focus keyword. */
|
|
1291
|
-
isMain?: boolean;
|
|
1292
|
-
/**
|
|
1293
|
-
* The source that added the keyword terms to the SEO settings.
|
|
1294
|
-
* @maxLength 1000
|
|
1295
|
-
*/
|
|
1296
|
-
origin?: string | null;
|
|
1297
|
-
}
|
|
1298
|
-
interface Tag {
|
|
1299
|
-
/**
|
|
1300
|
-
* SEO tag type.
|
|
1301
|
-
*
|
|
1302
|
-
*
|
|
1303
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
1304
|
-
*/
|
|
1305
|
-
type?: string;
|
|
1306
|
-
/**
|
|
1307
|
-
* A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
|
|
1308
|
-
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
1309
|
-
*/
|
|
1310
|
-
props?: Record<string, any> | null;
|
|
1311
|
-
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
|
|
1312
|
-
meta?: Record<string, any> | null;
|
|
1313
|
-
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
1314
|
-
children?: string;
|
|
1315
|
-
/** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
|
|
1316
|
-
custom?: boolean;
|
|
1317
|
-
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
|
|
1318
|
-
disabled?: boolean;
|
|
1319
|
-
}
|
|
1320
|
-
interface Settings {
|
|
1321
|
-
/**
|
|
1322
|
-
* Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1325
|
-
* Default: `false` (automatical redirect is enabled).
|
|
1326
|
-
*/
|
|
1327
|
-
preventAutoRedirect?: boolean;
|
|
1328
|
-
/**
|
|
1329
|
-
* User-selected keyword terms for a specific page.
|
|
1330
|
-
* @maxSize 5
|
|
1331
|
-
*/
|
|
1332
|
-
keywords?: Keyword[];
|
|
1333
|
-
}
|
|
1334
|
-
interface Agenda {
|
|
1335
|
-
/** Whether the schedule is enabled for the event. */
|
|
1336
|
-
enabled?: boolean;
|
|
1337
|
-
/**
|
|
1338
|
-
* Agenda page URL.
|
|
1339
|
-
* @readonly
|
|
1340
|
-
*/
|
|
1341
|
-
pageUrl?: SiteUrl;
|
|
1342
|
-
}
|
|
1343
|
-
/**
|
|
1344
|
-
* A Category is a classification object that groups related events on a site so you can organize and display them by themes, venues, or other facets.
|
|
1345
|
-
*
|
|
1346
|
-
* You can manage Categories, assign events to them, and use them to control the selection and order of events across different pages and widgets.
|
|
1347
|
-
*
|
|
1348
|
-
* Read more about [Categories](https://support.wix.com/en/article/creating-and-displaying-event-categories).
|
|
1349
|
-
*/
|
|
1350
|
-
interface Category {
|
|
1351
|
-
/**
|
|
1352
|
-
* Category ID.
|
|
1353
|
-
* @format GUID
|
|
1354
|
-
* @readonly
|
|
1355
|
-
*/
|
|
1356
|
-
_id?: string;
|
|
1357
|
-
/**
|
|
1358
|
-
* Category name.
|
|
1359
|
-
* @minLength 1
|
|
1360
|
-
* @maxLength 30
|
|
1361
|
-
*/
|
|
1362
|
-
name?: string;
|
|
1363
|
-
/**
|
|
1364
|
-
* Date and time when category was created.
|
|
1365
|
-
* @readonly
|
|
1366
|
-
*/
|
|
1367
|
-
_createdDate?: Date | null;
|
|
1368
|
-
/**
|
|
1369
|
-
* The total number of draft and published events assigned to the category.
|
|
1370
|
-
* @readonly
|
|
1371
|
-
*/
|
|
1372
|
-
counts?: CategoryCounts;
|
|
1373
|
-
/**
|
|
1374
|
-
* Category state.
|
|
1375
|
-
*
|
|
1376
|
-
* Default: `MANUAL`.
|
|
1377
|
-
*
|
|
1378
|
-
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
1379
|
-
* @maxSize 3
|
|
1380
|
-
*/
|
|
1381
|
-
states?: StateWithLiterals[];
|
|
1382
|
-
}
|
|
1383
|
-
interface CategoryCounts {
|
|
1384
|
-
/** Total number of draft events assigned to the category. */
|
|
1385
|
-
assignedEventsCount?: number | null;
|
|
1386
|
-
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
1387
|
-
assignedDraftEventsCount?: number | null;
|
|
1388
|
-
}
|
|
1389
|
-
declare enum State {
|
|
1390
|
-
/** Categoty is created manually by the user. */
|
|
1391
|
-
MANUAL = "MANUAL",
|
|
1392
|
-
/** Category is created automatically. */
|
|
1393
|
-
AUTO = "AUTO",
|
|
1394
|
-
/** Category is created automatically when publishing recurring events. */
|
|
1395
|
-
RECURRING_EVENT = "RECURRING_EVENT",
|
|
1396
|
-
/** Category is hidden. */
|
|
1397
|
-
HIDDEN = "HIDDEN"
|
|
1398
|
-
}
|
|
1399
|
-
/** @enumType */
|
|
1400
|
-
type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
1401
|
-
interface EventDisplaySettings {
|
|
1402
|
-
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1403
|
-
hideEventDetailsButton?: boolean | null;
|
|
1404
|
-
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1405
|
-
hideEventDetailsPage?: boolean | null;
|
|
1406
|
-
}
|
|
1407
|
-
interface LabellingSettings {
|
|
1408
|
-
}
|
|
1409
|
-
interface RichContent {
|
|
1410
|
-
/** Node objects representing a rich content document. */
|
|
1411
|
-
nodes?: Node[];
|
|
1412
|
-
/** Object metadata. */
|
|
1413
|
-
metadata?: Metadata;
|
|
1414
|
-
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1415
|
-
documentStyle?: DocumentStyle;
|
|
1416
|
-
}
|
|
1417
|
-
interface Node extends NodeDataOneOf {
|
|
1418
|
-
/** Data for a button node. */
|
|
1419
|
-
buttonData?: ButtonData;
|
|
1420
|
-
/** Data for a code block node. */
|
|
1421
|
-
codeBlockData?: CodeBlockData;
|
|
1422
|
-
/** Data for a divider node. */
|
|
1423
|
-
dividerData?: DividerData;
|
|
1424
|
-
/** Data for a file node. */
|
|
1425
|
-
fileData?: FileData;
|
|
1426
|
-
/** Data for a gallery node. */
|
|
1427
|
-
galleryData?: GalleryData;
|
|
1428
|
-
/** Data for a GIF node. */
|
|
1429
|
-
gifData?: GIFData;
|
|
1430
|
-
/** Data for a heading node. */
|
|
1431
|
-
headingData?: HeadingData;
|
|
1432
|
-
/** Data for an embedded HTML node. */
|
|
1433
|
-
htmlData?: HTMLData;
|
|
1434
|
-
/** Data for an image node. */
|
|
1435
|
-
imageData?: ImageData;
|
|
1436
|
-
/** Data for a link preview node. */
|
|
1437
|
-
linkPreviewData?: LinkPreviewData;
|
|
1438
|
-
/** @deprecated */
|
|
1439
|
-
mapData?: MapData;
|
|
1440
|
-
/** Data for a paragraph node. */
|
|
1441
|
-
paragraphData?: ParagraphData;
|
|
1442
|
-
/** Data for a poll node. */
|
|
1443
|
-
pollData?: PollData;
|
|
1444
|
-
/** Data for a text node. Used to apply decorations to text. */
|
|
1445
|
-
textData?: TextData;
|
|
1446
|
-
/** Data for an app embed node. */
|
|
1447
|
-
appEmbedData?: AppEmbedData;
|
|
1448
|
-
/** Data for a video node. */
|
|
1449
|
-
videoData?: VideoData;
|
|
1450
|
-
/** Data for an oEmbed node. */
|
|
1451
|
-
embedData?: EmbedData;
|
|
1452
|
-
/** Data for a collapsible list node. */
|
|
1453
|
-
collapsibleListData?: CollapsibleListData;
|
|
1454
|
-
/** Data for a table node. */
|
|
1455
|
-
tableData?: TableData;
|
|
1456
|
-
/** Data for a table cell node. */
|
|
1457
|
-
tableCellData?: TableCellData;
|
|
1458
|
-
/** Data for a custom external node. */
|
|
1459
|
-
externalData?: Record<string, any> | null;
|
|
1460
|
-
/** Data for an audio node. */
|
|
1461
|
-
audioData?: AudioData;
|
|
1462
|
-
/** Data for an ordered list node. */
|
|
1463
|
-
orderedListData?: OrderedListData;
|
|
1464
|
-
/** Data for a bulleted list node. */
|
|
1465
|
-
bulletedListData?: BulletedListData;
|
|
1466
|
-
/** Data for a block quote node. */
|
|
1467
|
-
blockquoteData?: BlockquoteData;
|
|
1468
|
-
/** Data for a caption node. */
|
|
1469
|
-
captionData?: CaptionData;
|
|
1470
|
-
/** Data for a layout node. Reserved for future use. */
|
|
1471
|
-
layoutData?: LayoutData;
|
|
1472
|
-
/** Data for a cell node. */
|
|
1473
|
-
layoutCellData?: LayoutCellData;
|
|
1474
|
-
/** 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. */
|
|
1475
|
-
type?: NodeTypeWithLiterals;
|
|
1476
|
-
/** Node ID. */
|
|
1477
|
-
id?: string;
|
|
1478
|
-
/** A list of child nodes. */
|
|
1479
|
-
nodes?: Node[];
|
|
1480
|
-
/** Padding and background color styling for the node. */
|
|
1481
|
-
style?: NodeStyle;
|
|
1482
|
-
}
|
|
1483
|
-
/** @oneof */
|
|
1484
|
-
interface NodeDataOneOf {
|
|
1485
|
-
/** Data for a button node. */
|
|
1486
|
-
buttonData?: ButtonData;
|
|
1487
|
-
/** Data for a code block node. */
|
|
1488
|
-
codeBlockData?: CodeBlockData;
|
|
1489
|
-
/** Data for a divider node. */
|
|
1490
|
-
dividerData?: DividerData;
|
|
1491
|
-
/** Data for a file node. */
|
|
1492
|
-
fileData?: FileData;
|
|
1493
|
-
/** Data for a gallery node. */
|
|
1494
|
-
galleryData?: GalleryData;
|
|
1495
|
-
/** Data for a GIF node. */
|
|
1496
|
-
gifData?: GIFData;
|
|
1497
|
-
/** Data for a heading node. */
|
|
1498
|
-
headingData?: HeadingData;
|
|
1499
|
-
/** Data for an embedded HTML node. */
|
|
1500
|
-
htmlData?: HTMLData;
|
|
1501
|
-
/** Data for an image node. */
|
|
1502
|
-
imageData?: ImageData;
|
|
1503
|
-
/** Data for a link preview node. */
|
|
1504
|
-
linkPreviewData?: LinkPreviewData;
|
|
1505
|
-
/** @deprecated */
|
|
1506
|
-
mapData?: MapData;
|
|
1507
|
-
/** Data for a paragraph node. */
|
|
1508
|
-
paragraphData?: ParagraphData;
|
|
1509
|
-
/** Data for a poll node. */
|
|
1510
|
-
pollData?: PollData;
|
|
1511
|
-
/** Data for a text node. Used to apply decorations to text. */
|
|
1512
|
-
textData?: TextData;
|
|
1513
|
-
/** Data for an app embed node. */
|
|
1514
|
-
appEmbedData?: AppEmbedData;
|
|
1515
|
-
/** Data for a video node. */
|
|
1516
|
-
videoData?: VideoData;
|
|
1517
|
-
/** Data for an oEmbed node. */
|
|
1518
|
-
embedData?: EmbedData;
|
|
1519
|
-
/** Data for a collapsible list node. */
|
|
1520
|
-
collapsibleListData?: CollapsibleListData;
|
|
1521
|
-
/** Data for a table node. */
|
|
1522
|
-
tableData?: TableData;
|
|
1523
|
-
/** Data for a table cell node. */
|
|
1524
|
-
tableCellData?: TableCellData;
|
|
1525
|
-
/** Data for a custom external node. */
|
|
1526
|
-
externalData?: Record<string, any> | null;
|
|
1527
|
-
/** Data for an audio node. */
|
|
1528
|
-
audioData?: AudioData;
|
|
1529
|
-
/** Data for an ordered list node. */
|
|
1530
|
-
orderedListData?: OrderedListData;
|
|
1531
|
-
/** Data for a bulleted list node. */
|
|
1532
|
-
bulletedListData?: BulletedListData;
|
|
1533
|
-
/** Data for a block quote node. */
|
|
1534
|
-
blockquoteData?: BlockquoteData;
|
|
1535
|
-
/** Data for a caption node. */
|
|
1536
|
-
captionData?: CaptionData;
|
|
1537
|
-
/** Data for a layout node. Reserved for future use. */
|
|
1538
|
-
layoutData?: LayoutData;
|
|
1539
|
-
/** Data for a cell node. */
|
|
1540
|
-
layoutCellData?: LayoutCellData;
|
|
1541
|
-
}
|
|
1542
|
-
declare enum NodeType {
|
|
1543
|
-
PARAGRAPH = "PARAGRAPH",
|
|
1544
|
-
TEXT = "TEXT",
|
|
1545
|
-
HEADING = "HEADING",
|
|
1546
|
-
BULLETED_LIST = "BULLETED_LIST",
|
|
1547
|
-
ORDERED_LIST = "ORDERED_LIST",
|
|
1548
|
-
LIST_ITEM = "LIST_ITEM",
|
|
1549
|
-
BLOCKQUOTE = "BLOCKQUOTE",
|
|
1550
|
-
CODE_BLOCK = "CODE_BLOCK",
|
|
1551
|
-
VIDEO = "VIDEO",
|
|
1552
|
-
DIVIDER = "DIVIDER",
|
|
1553
|
-
FILE = "FILE",
|
|
1554
|
-
GALLERY = "GALLERY",
|
|
1555
|
-
GIF = "GIF",
|
|
1556
|
-
HTML = "HTML",
|
|
1557
|
-
IMAGE = "IMAGE",
|
|
1558
|
-
LINK_PREVIEW = "LINK_PREVIEW",
|
|
1559
|
-
/** @deprecated */
|
|
1560
|
-
MAP = "MAP",
|
|
1561
|
-
POLL = "POLL",
|
|
1562
|
-
APP_EMBED = "APP_EMBED",
|
|
1563
|
-
BUTTON = "BUTTON",
|
|
1564
|
-
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
1565
|
-
TABLE = "TABLE",
|
|
1566
|
-
EMBED = "EMBED",
|
|
1567
|
-
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
1568
|
-
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
1569
|
-
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
1570
|
-
TABLE_CELL = "TABLE_CELL",
|
|
1571
|
-
TABLE_ROW = "TABLE_ROW",
|
|
1572
|
-
EXTERNAL = "EXTERNAL",
|
|
1573
|
-
AUDIO = "AUDIO",
|
|
1574
|
-
CAPTION = "CAPTION",
|
|
1575
|
-
LAYOUT = "LAYOUT",
|
|
1576
|
-
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1577
|
-
}
|
|
1578
|
-
/** @enumType */
|
|
1579
|
-
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';
|
|
1580
|
-
interface NodeStyle {
|
|
1581
|
-
/** The top padding value in pixels. */
|
|
1582
|
-
paddingTop?: string | null;
|
|
1583
|
-
/** The bottom padding value in pixels. */
|
|
1584
|
-
paddingBottom?: string | null;
|
|
1585
|
-
/** The background color as a hexadecimal value. */
|
|
1586
|
-
backgroundColor?: string | null;
|
|
1587
|
-
}
|
|
1588
|
-
interface ButtonData {
|
|
1589
|
-
/** Styling for the button's container. */
|
|
1590
|
-
containerData?: PluginContainerData;
|
|
1591
|
-
/** The button type. */
|
|
1592
|
-
type?: ButtonDataTypeWithLiterals;
|
|
1593
|
-
/** Styling for the button. */
|
|
1594
|
-
styles?: Styles;
|
|
1595
|
-
/** The text to display on the button. */
|
|
1596
|
-
text?: string | null;
|
|
1597
|
-
/** Button link details. */
|
|
1598
|
-
link?: V1Link;
|
|
1599
|
-
}
|
|
1600
|
-
interface Border {
|
|
1601
|
-
/**
|
|
1602
|
-
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1603
|
-
* @deprecated
|
|
1604
|
-
*/
|
|
1605
|
-
width?: number | null;
|
|
1606
|
-
/**
|
|
1607
|
-
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
1608
|
-
* @deprecated
|
|
1609
|
-
*/
|
|
1610
|
-
radius?: number | null;
|
|
1611
|
-
}
|
|
1612
|
-
interface Colors {
|
|
1613
|
-
/**
|
|
1614
|
-
* Deprecated: Use `textColor` in `styles` instead.
|
|
1615
|
-
* @deprecated
|
|
1616
|
-
*/
|
|
1617
|
-
text?: string | null;
|
|
1618
|
-
/**
|
|
1619
|
-
* Deprecated: Use `borderColor` in `styles` instead.
|
|
1620
|
-
* @deprecated
|
|
1621
|
-
*/
|
|
1622
|
-
border?: string | null;
|
|
1623
|
-
/**
|
|
1624
|
-
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
1625
|
-
* @deprecated
|
|
1626
|
-
*/
|
|
1627
|
-
background?: string | null;
|
|
1628
|
-
}
|
|
1629
|
-
interface PluginContainerData {
|
|
1630
|
-
/** The width of the node when it's displayed. */
|
|
1631
|
-
width?: PluginContainerDataWidth;
|
|
1632
|
-
/** The node's alignment within its container. */
|
|
1633
|
-
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
1634
|
-
/** Spoiler cover settings for the node. */
|
|
1635
|
-
spoiler?: Spoiler;
|
|
1636
|
-
/** The height of the node when it's displayed. */
|
|
1637
|
-
height?: Height;
|
|
1638
|
-
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
1639
|
-
textWrap?: boolean | null;
|
|
1640
|
-
}
|
|
1641
|
-
declare enum WidthType {
|
|
1642
|
-
/** Width matches the content width */
|
|
1643
|
-
CONTENT = "CONTENT",
|
|
1644
|
-
/** Small Width */
|
|
1645
|
-
SMALL = "SMALL",
|
|
1646
|
-
/** Width will match the original asset width */
|
|
1647
|
-
ORIGINAL = "ORIGINAL",
|
|
1648
|
-
/** coast-to-coast display */
|
|
1649
|
-
FULL_WIDTH = "FULL_WIDTH"
|
|
1650
|
-
}
|
|
1651
|
-
/** @enumType */
|
|
1652
|
-
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1653
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1654
|
-
/**
|
|
1655
|
-
* One of the following predefined width options:
|
|
1656
|
-
* `CONTENT`: The width of the container matches the content width.
|
|
1657
|
-
* `SMALL`: A small width.
|
|
1658
|
-
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1659
|
-
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1660
|
-
*/
|
|
1661
|
-
size?: WidthTypeWithLiterals;
|
|
1662
|
-
/** A custom width value in pixels. */
|
|
1663
|
-
custom?: string | null;
|
|
1664
|
-
}
|
|
1665
|
-
/** @oneof */
|
|
1666
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
1667
|
-
/**
|
|
1668
|
-
* One of the following predefined width options:
|
|
1669
|
-
* `CONTENT`: The width of the container matches the content width.
|
|
1670
|
-
* `SMALL`: A small width.
|
|
1671
|
-
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1672
|
-
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1673
|
-
*/
|
|
1674
|
-
size?: WidthTypeWithLiterals;
|
|
1675
|
-
/** A custom width value in pixels. */
|
|
1676
|
-
custom?: string | null;
|
|
1677
|
-
}
|
|
1678
|
-
declare enum PluginContainerDataAlignment {
|
|
1679
|
-
/** Center Alignment */
|
|
1680
|
-
CENTER = "CENTER",
|
|
1681
|
-
/** Left Alignment */
|
|
1682
|
-
LEFT = "LEFT",
|
|
1683
|
-
/** Right Alignment */
|
|
1684
|
-
RIGHT = "RIGHT"
|
|
1685
|
-
}
|
|
1686
|
-
/** @enumType */
|
|
1687
|
-
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1688
|
-
interface Spoiler {
|
|
1689
|
-
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1690
|
-
enabled?: boolean | null;
|
|
1691
|
-
/** The description displayed on top of the spoiler cover. */
|
|
1692
|
-
description?: string | null;
|
|
1693
|
-
/** The text for the button used to remove the spoiler cover. */
|
|
1694
|
-
buttonText?: string | null;
|
|
1695
|
-
}
|
|
1696
|
-
interface Height {
|
|
1697
|
-
/** A custom height value in pixels. */
|
|
1698
|
-
custom?: string | null;
|
|
1699
|
-
}
|
|
1700
|
-
declare enum ButtonDataType {
|
|
1701
|
-
/** Regular link button */
|
|
1702
|
-
LINK = "LINK",
|
|
1703
|
-
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1704
|
-
ACTION = "ACTION"
|
|
1705
|
-
}
|
|
1706
|
-
/** @enumType */
|
|
1707
|
-
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1708
|
-
interface Styles {
|
|
1709
|
-
/**
|
|
1710
|
-
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1711
|
-
* @deprecated
|
|
1712
|
-
*/
|
|
1713
|
-
border?: Border;
|
|
1714
|
-
/**
|
|
1715
|
-
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
1716
|
-
* @deprecated
|
|
1717
|
-
*/
|
|
1718
|
-
colors?: Colors;
|
|
1719
|
-
/** Border width in pixels. */
|
|
1720
|
-
borderWidth?: number | null;
|
|
1721
|
-
/**
|
|
1722
|
-
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
1723
|
-
* @deprecated
|
|
1724
|
-
*/
|
|
1725
|
-
borderWidthHover?: number | null;
|
|
1726
|
-
/** Border radius in pixels. */
|
|
1727
|
-
borderRadius?: number | null;
|
|
1728
|
-
/**
|
|
1729
|
-
* Border color as a hexadecimal value.
|
|
1730
|
-
* @format COLOR_HEX
|
|
1731
|
-
*/
|
|
1732
|
-
borderColor?: string | null;
|
|
1733
|
-
/**
|
|
1734
|
-
* Border color as a hexadecimal value (hover state).
|
|
1735
|
-
* @format COLOR_HEX
|
|
1736
|
-
*/
|
|
1737
|
-
borderColorHover?: string | null;
|
|
1738
|
-
/**
|
|
1739
|
-
* Text color as a hexadecimal value.
|
|
1740
|
-
* @format COLOR_HEX
|
|
1741
|
-
*/
|
|
1742
|
-
textColor?: string | null;
|
|
1743
|
-
/**
|
|
1744
|
-
* Text color as a hexadecimal value (hover state).
|
|
1745
|
-
* @format COLOR_HEX
|
|
1746
|
-
*/
|
|
1747
|
-
textColorHover?: string | null;
|
|
1748
|
-
/**
|
|
1749
|
-
* Background color as a hexadecimal value.
|
|
1750
|
-
* @format COLOR_HEX
|
|
1751
|
-
*/
|
|
1752
|
-
backgroundColor?: string | null;
|
|
1753
|
-
/**
|
|
1754
|
-
* Background color as a hexadecimal value (hover state).
|
|
1755
|
-
* @format COLOR_HEX
|
|
1756
|
-
*/
|
|
1757
|
-
backgroundColorHover?: string | null;
|
|
1758
|
-
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1759
|
-
buttonSize?: string | null;
|
|
1760
|
-
}
|
|
1761
|
-
interface V1Link extends V1LinkDataOneOf {
|
|
1762
|
-
/** The absolute URL for the linked document. */
|
|
1763
|
-
url?: string;
|
|
1764
|
-
/** The target node's ID. Used for linking to another node in this object. */
|
|
1765
|
-
anchor?: string;
|
|
1766
|
-
/**
|
|
1767
|
-
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
1768
|
-
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
1769
|
-
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
1770
|
-
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
1771
|
-
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
1772
|
-
*/
|
|
1773
|
-
target?: TargetWithLiterals;
|
|
1774
|
-
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
1775
|
-
rel?: Rel;
|
|
1776
|
-
/** A serialized object used for a custom or external link panel. */
|
|
1777
|
-
customData?: string | null;
|
|
1778
|
-
}
|
|
1779
|
-
/** @oneof */
|
|
1780
|
-
interface V1LinkDataOneOf {
|
|
1781
|
-
/** The absolute URL for the linked document. */
|
|
1782
|
-
url?: string;
|
|
1783
|
-
/** The target node's ID. Used for linking to another node in this object. */
|
|
1784
|
-
anchor?: string;
|
|
1785
|
-
}
|
|
1786
|
-
declare enum Target {
|
|
1787
|
-
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1788
|
-
SELF = "SELF",
|
|
1789
|
-
/** Opens the linked document in a new window or tab */
|
|
1790
|
-
BLANK = "BLANK",
|
|
1791
|
-
/** Opens the linked document in the parent frame */
|
|
1792
|
-
PARENT = "PARENT",
|
|
1793
|
-
/** Opens the linked document in the full body of the window */
|
|
1794
|
-
TOP = "TOP"
|
|
1795
|
-
}
|
|
1796
|
-
/** @enumType */
|
|
1797
|
-
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1798
|
-
interface Rel {
|
|
1799
|
-
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1800
|
-
nofollow?: boolean | null;
|
|
1801
|
-
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
1802
|
-
sponsored?: boolean | null;
|
|
1803
|
-
/** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
|
|
1804
|
-
ugc?: boolean | null;
|
|
1805
|
-
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1806
|
-
noreferrer?: boolean | null;
|
|
1807
|
-
}
|
|
1808
|
-
interface CodeBlockData {
|
|
1809
|
-
/** Styling for the code block's text. */
|
|
1810
|
-
textStyle?: TextStyle;
|
|
1811
|
-
}
|
|
1812
|
-
interface TextStyle {
|
|
1813
|
-
/** Text alignment. Defaults to `AUTO`. */
|
|
1814
|
-
textAlignment?: TextAlignmentWithLiterals;
|
|
1815
|
-
/** 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. */
|
|
1816
|
-
lineHeight?: string | null;
|
|
1817
|
-
}
|
|
1818
|
-
declare enum TextAlignment {
|
|
1819
|
-
/** browser default, eqivalent to `initial` */
|
|
1820
|
-
AUTO = "AUTO",
|
|
1821
|
-
/** Left align */
|
|
1822
|
-
LEFT = "LEFT",
|
|
1823
|
-
/** Right align */
|
|
1824
|
-
RIGHT = "RIGHT",
|
|
1825
|
-
/** Center align */
|
|
1826
|
-
CENTER = "CENTER",
|
|
1827
|
-
/** 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 */
|
|
1828
|
-
JUSTIFY = "JUSTIFY"
|
|
1829
|
-
}
|
|
1830
|
-
/** @enumType */
|
|
1831
|
-
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1832
|
-
interface DividerData {
|
|
1833
|
-
/** Styling for the divider's container. */
|
|
1834
|
-
containerData?: PluginContainerData;
|
|
1835
|
-
/** Divider line style. */
|
|
1836
|
-
lineStyle?: LineStyleWithLiterals;
|
|
1837
|
-
/** Divider width. */
|
|
1838
|
-
width?: WidthWithLiterals;
|
|
1839
|
-
/** Divider alignment. */
|
|
1840
|
-
alignment?: DividerDataAlignmentWithLiterals;
|
|
1841
|
-
}
|
|
1842
|
-
declare enum LineStyle {
|
|
1843
|
-
/** Single Line */
|
|
1844
|
-
SINGLE = "SINGLE",
|
|
1845
|
-
/** Double Line */
|
|
1846
|
-
DOUBLE = "DOUBLE",
|
|
1847
|
-
/** Dashed Line */
|
|
1848
|
-
DASHED = "DASHED",
|
|
1849
|
-
/** Dotted Line */
|
|
1850
|
-
DOTTED = "DOTTED"
|
|
1851
|
-
}
|
|
1852
|
-
/** @enumType */
|
|
1853
|
-
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1854
|
-
declare enum Width {
|
|
1855
|
-
/** Large line */
|
|
1856
|
-
LARGE = "LARGE",
|
|
1857
|
-
/** Medium line */
|
|
1858
|
-
MEDIUM = "MEDIUM",
|
|
1859
|
-
/** Small line */
|
|
1860
|
-
SMALL = "SMALL"
|
|
1861
|
-
}
|
|
1862
|
-
/** @enumType */
|
|
1863
|
-
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1864
|
-
declare enum DividerDataAlignment {
|
|
1865
|
-
/** Center alignment */
|
|
1866
|
-
CENTER = "CENTER",
|
|
1867
|
-
/** Left alignment */
|
|
1868
|
-
LEFT = "LEFT",
|
|
1869
|
-
/** Right alignment */
|
|
1870
|
-
RIGHT = "RIGHT"
|
|
1871
|
-
}
|
|
1872
|
-
/** @enumType */
|
|
1873
|
-
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1874
|
-
interface FileData {
|
|
1875
|
-
/** Styling for the file's container. */
|
|
1876
|
-
containerData?: PluginContainerData;
|
|
1877
|
-
/** The source for the file's data. */
|
|
1878
|
-
src?: FileSource;
|
|
1879
|
-
/** File name. */
|
|
1880
|
-
name?: string | null;
|
|
1881
|
-
/** File type. */
|
|
1882
|
-
type?: string | null;
|
|
1883
|
-
/**
|
|
1884
|
-
* Use `sizeInKb` instead.
|
|
1885
|
-
* @deprecated
|
|
1886
|
-
*/
|
|
1887
|
-
size?: number | null;
|
|
1888
|
-
/** Settings for PDF files. */
|
|
1889
|
-
pdfSettings?: PDFSettings;
|
|
1890
|
-
/** File MIME type. */
|
|
1891
|
-
mimeType?: string | null;
|
|
1892
|
-
/** File path. */
|
|
1893
|
-
path?: string | null;
|
|
1894
|
-
/** File size in KB. */
|
|
1895
|
-
sizeInKb?: string | null;
|
|
1896
|
-
}
|
|
1897
|
-
declare enum ViewMode {
|
|
1898
|
-
/** No PDF view */
|
|
1899
|
-
NONE = "NONE",
|
|
1900
|
-
/** Full PDF view */
|
|
1901
|
-
FULL = "FULL",
|
|
1902
|
-
/** Mini PDF view */
|
|
1903
|
-
MINI = "MINI"
|
|
1904
|
-
}
|
|
1905
|
-
/** @enumType */
|
|
1906
|
-
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1907
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
1908
|
-
/** The absolute URL for the file's source. */
|
|
1909
|
-
url?: string | null;
|
|
1910
|
-
/**
|
|
1911
|
-
* Custom ID. Use `id` instead.
|
|
1912
|
-
* @deprecated
|
|
1913
|
-
*/
|
|
1914
|
-
custom?: string | null;
|
|
1915
|
-
/** An ID that's resolved to a URL by a resolver function. */
|
|
1916
|
-
id?: string | null;
|
|
1917
|
-
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
1918
|
-
private?: boolean | null;
|
|
1919
|
-
}
|
|
1920
|
-
/** @oneof */
|
|
1921
|
-
interface FileSourceDataOneOf {
|
|
1922
|
-
/** The absolute URL for the file's source. */
|
|
1923
|
-
url?: string | null;
|
|
1924
|
-
/**
|
|
1925
|
-
* Custom ID. Use `id` instead.
|
|
1926
|
-
* @deprecated
|
|
1927
|
-
*/
|
|
1928
|
-
custom?: string | null;
|
|
1929
|
-
/** An ID that's resolved to a URL by a resolver function. */
|
|
1930
|
-
id?: string | null;
|
|
1931
|
-
}
|
|
1932
|
-
interface PDFSettings {
|
|
1933
|
-
/**
|
|
1934
|
-
* PDF view mode. One of the following:
|
|
1935
|
-
* `NONE` : The PDF isn't displayed.
|
|
1936
|
-
* `FULL` : A full page view of the PDF is displayed.
|
|
1937
|
-
* `MINI` : A mini view of the PDF is displayed.
|
|
1938
|
-
*/
|
|
1939
|
-
viewMode?: ViewModeWithLiterals;
|
|
1940
|
-
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1941
|
-
disableDownload?: boolean | null;
|
|
1942
|
-
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1943
|
-
disablePrint?: boolean | null;
|
|
1944
|
-
}
|
|
1945
|
-
interface GalleryData {
|
|
1946
|
-
/** Styling for the gallery's container. */
|
|
1947
|
-
containerData?: PluginContainerData;
|
|
1948
|
-
/** The items in the gallery. */
|
|
1949
|
-
items?: GalleryDataItem[];
|
|
1950
|
-
/** Options for defining the gallery's appearance. */
|
|
1951
|
-
options?: GalleryOptions;
|
|
1952
|
-
/** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
|
|
1953
|
-
disableExpand?: boolean | null;
|
|
1954
|
-
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1955
|
-
disableDownload?: boolean | null;
|
|
1956
|
-
}
|
|
1957
|
-
interface Media {
|
|
1958
|
-
/** The source for the media's data. */
|
|
1959
|
-
src?: FileSource;
|
|
1960
|
-
/** Media width in pixels. */
|
|
1961
|
-
width?: number | null;
|
|
1962
|
-
/** Media height in pixels. */
|
|
1963
|
-
height?: number | null;
|
|
1964
|
-
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1965
|
-
duration?: number | null;
|
|
1966
|
-
}
|
|
1967
|
-
interface Image {
|
|
1968
|
-
/** Image file details. */
|
|
1969
|
-
media?: Media;
|
|
1970
|
-
/** Link details for images that are links. */
|
|
1971
|
-
link?: V1Link;
|
|
1972
|
-
}
|
|
1973
|
-
interface Video {
|
|
1974
|
-
/** Video file details. */
|
|
1975
|
-
media?: Media;
|
|
1976
|
-
/** Video thumbnail file details. */
|
|
1977
|
-
thumbnail?: Media;
|
|
1978
|
-
}
|
|
1979
|
-
interface GalleryDataItem extends GalleryDataItemDataOneOf {
|
|
1980
|
-
/** An image item. */
|
|
1981
|
-
image?: Image;
|
|
1982
|
-
/** A video item. */
|
|
1983
|
-
video?: Video;
|
|
1984
|
-
/** Item title. */
|
|
1985
|
-
title?: string | null;
|
|
1986
|
-
/** Item's alternative text. */
|
|
1987
|
-
altText?: string | null;
|
|
1988
|
-
}
|
|
1989
|
-
/** @oneof */
|
|
1990
|
-
interface GalleryDataItemDataOneOf {
|
|
1991
|
-
/** An image item. */
|
|
1992
|
-
image?: Image;
|
|
1993
|
-
/** A video item. */
|
|
1994
|
-
video?: Video;
|
|
1995
|
-
}
|
|
1996
|
-
interface GalleryOptions {
|
|
1997
|
-
/** Gallery layout. */
|
|
1998
|
-
layout?: GalleryOptionsLayout;
|
|
1999
|
-
/** Styling for gallery items. */
|
|
2000
|
-
item?: ItemStyle;
|
|
2001
|
-
/** Styling for gallery thumbnail images. */
|
|
2002
|
-
thumbnails?: Thumbnails;
|
|
2003
|
-
}
|
|
2004
|
-
declare enum LayoutType {
|
|
2005
|
-
/** Collage type */
|
|
2006
|
-
COLLAGE = "COLLAGE",
|
|
2007
|
-
/** Masonry type */
|
|
2008
|
-
MASONRY = "MASONRY",
|
|
2009
|
-
/** Grid type */
|
|
2010
|
-
GRID = "GRID",
|
|
2011
|
-
/** Thumbnail type */
|
|
2012
|
-
THUMBNAIL = "THUMBNAIL",
|
|
2013
|
-
/** Slider type */
|
|
2014
|
-
SLIDER = "SLIDER",
|
|
2015
|
-
/** Slideshow type */
|
|
2016
|
-
SLIDESHOW = "SLIDESHOW",
|
|
2017
|
-
/** Panorama type */
|
|
2018
|
-
PANORAMA = "PANORAMA",
|
|
2019
|
-
/** Column type */
|
|
2020
|
-
COLUMN = "COLUMN",
|
|
2021
|
-
/** Magic type */
|
|
2022
|
-
MAGIC = "MAGIC",
|
|
2023
|
-
/** Fullsize images type */
|
|
2024
|
-
FULLSIZE = "FULLSIZE"
|
|
2025
|
-
}
|
|
2026
|
-
/** @enumType */
|
|
2027
|
-
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
2028
|
-
declare enum Orientation {
|
|
2029
|
-
/** Rows Orientation */
|
|
2030
|
-
ROWS = "ROWS",
|
|
2031
|
-
/** Columns Orientation */
|
|
2032
|
-
COLUMNS = "COLUMNS"
|
|
2033
|
-
}
|
|
2034
|
-
/** @enumType */
|
|
2035
|
-
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
2036
|
-
declare enum Crop {
|
|
2037
|
-
/** Crop to fill */
|
|
2038
|
-
FILL = "FILL",
|
|
2039
|
-
/** Crop to fit */
|
|
2040
|
-
FIT = "FIT"
|
|
2041
|
-
}
|
|
2042
|
-
/** @enumType */
|
|
2043
|
-
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
2044
|
-
declare enum ThumbnailsAlignment {
|
|
2045
|
-
/** Top alignment */
|
|
2046
|
-
TOP = "TOP",
|
|
2047
|
-
/** Right alignment */
|
|
2048
|
-
RIGHT = "RIGHT",
|
|
2049
|
-
/** Bottom alignment */
|
|
2050
|
-
BOTTOM = "BOTTOM",
|
|
2051
|
-
/** Left alignment */
|
|
2052
|
-
LEFT = "LEFT",
|
|
2053
|
-
/** No thumbnail */
|
|
2054
|
-
NONE = "NONE"
|
|
2055
|
-
}
|
|
2056
|
-
/** @enumType */
|
|
2057
|
-
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
2058
|
-
interface GalleryOptionsLayout {
|
|
2059
|
-
/** Gallery layout type. */
|
|
2060
|
-
type?: LayoutTypeWithLiterals;
|
|
2061
|
-
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
2062
|
-
horizontalScroll?: boolean | null;
|
|
2063
|
-
/** Gallery orientation. */
|
|
2064
|
-
orientation?: OrientationWithLiterals;
|
|
2065
|
-
/** The number of columns to display on full size screens. */
|
|
2066
|
-
numberOfColumns?: number | null;
|
|
2067
|
-
/** The number of columns to display on mobile screens. */
|
|
2068
|
-
mobileNumberOfColumns?: number | null;
|
|
2069
|
-
}
|
|
2070
|
-
interface ItemStyle {
|
|
2071
|
-
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
2072
|
-
targetSize?: number | null;
|
|
2073
|
-
/** Item ratio */
|
|
2074
|
-
ratio?: number | null;
|
|
2075
|
-
/** Sets how item images are cropped. */
|
|
2076
|
-
crop?: CropWithLiterals;
|
|
2077
|
-
/** The spacing between items in pixels. */
|
|
2078
|
-
spacing?: number | null;
|
|
2079
|
-
}
|
|
2080
|
-
interface Thumbnails {
|
|
2081
|
-
/** Thumbnail alignment. */
|
|
2082
|
-
placement?: ThumbnailsAlignmentWithLiterals;
|
|
2083
|
-
/** Spacing between thumbnails in pixels. */
|
|
2084
|
-
spacing?: number | null;
|
|
2085
|
-
}
|
|
2086
|
-
interface GIFData {
|
|
2087
|
-
/** Styling for the GIF's container. */
|
|
2088
|
-
containerData?: PluginContainerData;
|
|
2089
|
-
/** The source of the full size GIF. */
|
|
2090
|
-
original?: GIF;
|
|
2091
|
-
/** The source of the downsized GIF. */
|
|
2092
|
-
downsized?: GIF;
|
|
2093
|
-
/** Height in pixels. */
|
|
2094
|
-
height?: number;
|
|
2095
|
-
/** Width in pixels. */
|
|
2096
|
-
width?: number;
|
|
2097
|
-
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2098
|
-
gifType?: GIFTypeWithLiterals;
|
|
2099
|
-
}
|
|
2100
|
-
interface GIF {
|
|
2101
|
-
/**
|
|
2102
|
-
* GIF format URL.
|
|
2103
|
-
* @format WEB_URL
|
|
2104
|
-
*/
|
|
2105
|
-
gif?: string | null;
|
|
2106
|
-
/**
|
|
2107
|
-
* MP4 format URL.
|
|
2108
|
-
* @format WEB_URL
|
|
2109
|
-
*/
|
|
2110
|
-
mp4?: string | null;
|
|
2111
|
-
/**
|
|
2112
|
-
* Thumbnail URL.
|
|
2113
|
-
* @format WEB_URL
|
|
2114
|
-
*/
|
|
2115
|
-
still?: string | null;
|
|
2116
|
-
}
|
|
2117
|
-
declare enum GIFType {
|
|
2118
|
-
NORMAL = "NORMAL",
|
|
2119
|
-
STICKER = "STICKER"
|
|
2120
|
-
}
|
|
2121
|
-
/** @enumType */
|
|
2122
|
-
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2123
|
-
interface HeadingData {
|
|
2124
|
-
/** Heading level from 1-6. */
|
|
2125
|
-
level?: number;
|
|
2126
|
-
/** Styling for the heading text. */
|
|
2127
|
-
textStyle?: TextStyle;
|
|
2128
|
-
/** Indentation level from 1-4. */
|
|
2129
|
-
indentation?: number | null;
|
|
2130
|
-
}
|
|
2131
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
2132
|
-
/** The URL for the HTML code for the node. */
|
|
2133
|
-
url?: string;
|
|
2134
|
-
/** The HTML code for the node. */
|
|
2135
|
-
html?: string;
|
|
2136
|
-
/**
|
|
2137
|
-
* Whether this is an AdSense element. Use `source` instead.
|
|
2138
|
-
* @deprecated
|
|
2139
|
-
*/
|
|
2140
|
-
isAdsense?: boolean | null;
|
|
2141
|
-
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
2142
|
-
containerData?: PluginContainerData;
|
|
2143
|
-
/** The type of HTML code. */
|
|
2144
|
-
source?: SourceWithLiterals;
|
|
2145
|
-
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
2146
|
-
autoHeight?: boolean | null;
|
|
2147
|
-
}
|
|
2148
|
-
/** @oneof */
|
|
2149
|
-
interface HTMLDataDataOneOf {
|
|
2150
|
-
/** The URL for the HTML code for the node. */
|
|
2151
|
-
url?: string;
|
|
2152
|
-
/** The HTML code for the node. */
|
|
2153
|
-
html?: string;
|
|
2154
|
-
/**
|
|
2155
|
-
* Whether this is an AdSense element. Use `source` instead.
|
|
2156
|
-
* @deprecated
|
|
2157
|
-
*/
|
|
2158
|
-
isAdsense?: boolean | null;
|
|
2159
|
-
}
|
|
2160
|
-
declare enum Source {
|
|
2161
|
-
HTML = "HTML",
|
|
2162
|
-
ADSENSE = "ADSENSE",
|
|
2163
|
-
AI = "AI"
|
|
2164
|
-
}
|
|
2165
|
-
/** @enumType */
|
|
2166
|
-
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE' | 'AI';
|
|
2167
|
-
interface ImageData {
|
|
2168
|
-
/** Styling for the image's container. */
|
|
2169
|
-
containerData?: PluginContainerData;
|
|
2170
|
-
/** Image file details. */
|
|
2171
|
-
image?: Media;
|
|
2172
|
-
/** Link details for images that are links. */
|
|
2173
|
-
link?: V1Link;
|
|
2174
|
-
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
|
|
2175
|
-
disableExpand?: boolean | null;
|
|
2176
|
-
/** Image's alternative text. */
|
|
2177
|
-
altText?: string | null;
|
|
2178
|
-
/**
|
|
2179
|
-
* Deprecated: use Caption node instead.
|
|
2180
|
-
* @deprecated
|
|
2181
|
-
*/
|
|
2182
|
-
caption?: string | null;
|
|
2183
|
-
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
2184
|
-
disableDownload?: boolean | null;
|
|
2185
|
-
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
2186
|
-
decorative?: boolean | null;
|
|
2187
|
-
/** Styling for the image. */
|
|
2188
|
-
styles?: ImageDataStyles;
|
|
2189
|
-
}
|
|
2190
|
-
interface StylesBorder {
|
|
2191
|
-
/** Border width in pixels. */
|
|
2192
|
-
width?: number | null;
|
|
2193
|
-
/**
|
|
2194
|
-
* Border color as a hexadecimal value.
|
|
2195
|
-
* @format COLOR_HEX
|
|
2196
|
-
*/
|
|
2197
|
-
color?: string | null;
|
|
2198
|
-
/** Border radius in pixels. */
|
|
2199
|
-
radius?: number | null;
|
|
2200
|
-
}
|
|
2201
|
-
interface ImageDataStyles {
|
|
2202
|
-
/** Border attributes. */
|
|
2203
|
-
border?: StylesBorder;
|
|
2204
|
-
}
|
|
2205
|
-
interface LinkPreviewData {
|
|
2206
|
-
/** Styling for the link preview's container. */
|
|
2207
|
-
containerData?: PluginContainerData;
|
|
2208
|
-
/** Link details. */
|
|
2209
|
-
link?: V1Link;
|
|
2210
|
-
/** Preview title. */
|
|
2211
|
-
title?: string | null;
|
|
2212
|
-
/** Preview thumbnail URL. */
|
|
2213
|
-
thumbnailUrl?: string | null;
|
|
2214
|
-
/** Preview description. */
|
|
2215
|
-
description?: string | null;
|
|
2216
|
-
/** The preview content as HTML. */
|
|
2217
|
-
html?: string | null;
|
|
2218
|
-
/** Styling for the link preview. */
|
|
2219
|
-
styles?: LinkPreviewDataStyles;
|
|
2220
|
-
}
|
|
2221
|
-
declare enum StylesPosition {
|
|
2222
|
-
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2223
|
-
START = "START",
|
|
2224
|
-
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
2225
|
-
END = "END",
|
|
2226
|
-
/** Thumbnail positioned at the top */
|
|
2227
|
-
TOP = "TOP",
|
|
2228
|
-
/** Thumbnail hidden and not displayed */
|
|
2229
|
-
HIDDEN = "HIDDEN"
|
|
2230
|
-
}
|
|
2231
|
-
/** @enumType */
|
|
2232
|
-
type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2233
|
-
interface LinkPreviewDataStyles {
|
|
2234
|
-
/**
|
|
2235
|
-
* Background color as a hexadecimal value.
|
|
2236
|
-
* @format COLOR_HEX
|
|
2237
|
-
*/
|
|
2238
|
-
backgroundColor?: string | null;
|
|
2239
|
-
/**
|
|
2240
|
-
* Title color as a hexadecimal value.
|
|
2241
|
-
* @format COLOR_HEX
|
|
2242
|
-
*/
|
|
2243
|
-
titleColor?: string | null;
|
|
2244
|
-
/**
|
|
2245
|
-
* Subtitle color as a hexadecimal value.
|
|
2246
|
-
* @format COLOR_HEX
|
|
2247
|
-
*/
|
|
2248
|
-
subtitleColor?: string | null;
|
|
2249
|
-
/**
|
|
2250
|
-
* Link color as a hexadecimal value.
|
|
2251
|
-
* @format COLOR_HEX
|
|
2252
|
-
*/
|
|
2253
|
-
linkColor?: string | null;
|
|
2254
|
-
/** Border width in pixels. */
|
|
2255
|
-
borderWidth?: number | null;
|
|
2256
|
-
/** Border radius in pixels. */
|
|
2257
|
-
borderRadius?: number | null;
|
|
2258
|
-
/**
|
|
2259
|
-
* Border color as a hexadecimal value.
|
|
2260
|
-
* @format COLOR_HEX
|
|
2261
|
-
*/
|
|
2262
|
-
borderColor?: string | null;
|
|
2263
|
-
/** Position of thumbnail. Defaults to `START`. */
|
|
2264
|
-
thumbnailPosition?: StylesPositionWithLiterals;
|
|
2265
|
-
}
|
|
2266
|
-
interface MapData {
|
|
2267
|
-
/** Styling for the map's container. */
|
|
2268
|
-
containerData?: PluginContainerData;
|
|
2269
|
-
/** Map settings. */
|
|
2270
|
-
mapSettings?: MapSettings;
|
|
2271
|
-
}
|
|
2272
|
-
interface MapSettings {
|
|
2273
|
-
/** The address to display on the map. */
|
|
2274
|
-
address?: string | null;
|
|
2275
|
-
/** Sets whether the map is draggable. */
|
|
2276
|
-
draggable?: boolean | null;
|
|
2277
|
-
/** Sets whether the location marker is visible. */
|
|
2278
|
-
marker?: boolean | null;
|
|
2279
|
-
/** Sets whether street view control is enabled. */
|
|
2280
|
-
streetViewControl?: boolean | null;
|
|
2281
|
-
/** Sets whether zoom control is enabled. */
|
|
2282
|
-
zoomControl?: boolean | null;
|
|
2283
|
-
/** Location latitude. */
|
|
2284
|
-
lat?: number | null;
|
|
2285
|
-
/** Location longitude. */
|
|
2286
|
-
lng?: number | null;
|
|
2287
|
-
/** Location name. */
|
|
2288
|
-
locationName?: string | null;
|
|
2289
|
-
/** Sets whether view mode control is enabled. */
|
|
2290
|
-
viewModeControl?: boolean | null;
|
|
2291
|
-
/** Initial zoom value. */
|
|
2292
|
-
initialZoom?: number | null;
|
|
2293
|
-
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2294
|
-
mapType?: MapTypeWithLiterals;
|
|
2295
|
-
}
|
|
2296
|
-
declare enum MapType {
|
|
2297
|
-
/** Roadmap map type */
|
|
2298
|
-
ROADMAP = "ROADMAP",
|
|
2299
|
-
/** Satellite map type */
|
|
2300
|
-
SATELITE = "SATELITE",
|
|
2301
|
-
/** Hybrid map type */
|
|
2302
|
-
HYBRID = "HYBRID",
|
|
2303
|
-
/** Terrain map type */
|
|
2304
|
-
TERRAIN = "TERRAIN"
|
|
2305
|
-
}
|
|
2306
|
-
/** @enumType */
|
|
2307
|
-
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2308
|
-
interface ParagraphData {
|
|
2309
|
-
/** Styling for the paragraph text. */
|
|
2310
|
-
textStyle?: TextStyle;
|
|
2311
|
-
/** Indentation level from 1-4. */
|
|
2312
|
-
indentation?: number | null;
|
|
2313
|
-
/** Paragraph level */
|
|
2314
|
-
level?: number | null;
|
|
2315
|
-
}
|
|
2316
|
-
interface PollData {
|
|
2317
|
-
/** Styling for the poll's container. */
|
|
2318
|
-
containerData?: PluginContainerData;
|
|
2319
|
-
/** Poll data. */
|
|
2320
|
-
poll?: Poll;
|
|
2321
|
-
/** Layout settings for the poll and voting options. */
|
|
2322
|
-
layout?: PollDataLayout;
|
|
2323
|
-
/** Styling for the poll and voting options. */
|
|
2324
|
-
design?: Design;
|
|
2325
|
-
}
|
|
2326
|
-
declare enum ViewRole {
|
|
2327
|
-
/** Only Poll creator can view the results */
|
|
2328
|
-
CREATOR = "CREATOR",
|
|
2329
|
-
/** Anyone who voted can see the results */
|
|
2330
|
-
VOTERS = "VOTERS",
|
|
2331
|
-
/** Anyone can see the results, even if one didn't vote */
|
|
2332
|
-
EVERYONE = "EVERYONE"
|
|
2333
|
-
}
|
|
2334
|
-
/** @enumType */
|
|
2335
|
-
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2336
|
-
declare enum VoteRole {
|
|
2337
|
-
/** Logged in member */
|
|
2338
|
-
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2339
|
-
/** Anyone */
|
|
2340
|
-
ALL = "ALL"
|
|
2341
|
-
}
|
|
2342
|
-
/** @enumType */
|
|
2343
|
-
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2344
|
-
interface Permissions {
|
|
2345
|
-
/** Sets who can view the poll results. */
|
|
2346
|
-
view?: ViewRoleWithLiterals;
|
|
2347
|
-
/** Sets who can vote. */
|
|
2348
|
-
vote?: VoteRoleWithLiterals;
|
|
2349
|
-
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2350
|
-
allowMultipleVotes?: boolean | null;
|
|
2351
|
-
}
|
|
2352
|
-
interface Option {
|
|
2353
|
-
/** Option ID. */
|
|
2354
|
-
id?: string | null;
|
|
2355
|
-
/** Option title. */
|
|
2356
|
-
title?: string | null;
|
|
2357
|
-
/** The image displayed with the option. */
|
|
2358
|
-
image?: Media;
|
|
2359
|
-
}
|
|
2360
|
-
interface PollSettings {
|
|
2361
|
-
/** Permissions settings for voting. */
|
|
2362
|
-
permissions?: Permissions;
|
|
2363
|
-
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
2364
|
-
showVoters?: boolean | null;
|
|
2365
|
-
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2366
|
-
showVotesCount?: boolean | null;
|
|
2367
|
-
}
|
|
2368
|
-
declare enum PollLayoutType {
|
|
2369
|
-
/** List */
|
|
2370
|
-
LIST = "LIST",
|
|
2371
|
-
/** Grid */
|
|
2372
|
-
GRID = "GRID"
|
|
2373
|
-
}
|
|
2374
|
-
/** @enumType */
|
|
2375
|
-
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2376
|
-
declare enum PollLayoutDirection {
|
|
2377
|
-
/** Left-to-right */
|
|
2378
|
-
LTR = "LTR",
|
|
2379
|
-
/** Right-to-left */
|
|
2380
|
-
RTL = "RTL"
|
|
2381
|
-
}
|
|
2382
|
-
/** @enumType */
|
|
2383
|
-
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2384
|
-
interface PollLayout {
|
|
2385
|
-
/** The layout for displaying the voting options. */
|
|
2386
|
-
type?: PollLayoutTypeWithLiterals;
|
|
2387
|
-
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2388
|
-
direction?: PollLayoutDirectionWithLiterals;
|
|
2389
|
-
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2390
|
-
enableImage?: boolean | null;
|
|
2391
|
-
}
|
|
2392
|
-
interface OptionLayout {
|
|
2393
|
-
/** Sets whether to display option images. Defaults to `false`. */
|
|
2394
|
-
enableImage?: boolean | null;
|
|
2395
|
-
}
|
|
2396
|
-
declare enum BackgroundType {
|
|
2397
|
-
/** Color background type */
|
|
2398
|
-
COLOR = "COLOR",
|
|
2399
|
-
/** Image background type */
|
|
2400
|
-
IMAGE = "IMAGE",
|
|
2401
|
-
/** Gradiant background type */
|
|
2402
|
-
GRADIENT = "GRADIENT"
|
|
2403
|
-
}
|
|
2404
|
-
/** @enumType */
|
|
2405
|
-
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2406
|
-
interface Gradient {
|
|
2407
|
-
/** The gradient angle in degrees. */
|
|
2408
|
-
angle?: number | null;
|
|
2409
|
-
/**
|
|
2410
|
-
* The start color as a hexademical value.
|
|
2411
|
-
* @format COLOR_HEX
|
|
2412
|
-
*/
|
|
2413
|
-
startColor?: string | null;
|
|
2414
|
-
/**
|
|
2415
|
-
* The end color as a hexademical value.
|
|
2416
|
-
* @format COLOR_HEX
|
|
2417
|
-
*/
|
|
2418
|
-
lastColor?: string | null;
|
|
2419
|
-
}
|
|
2420
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
2421
|
-
/**
|
|
2422
|
-
* The background color as a hexademical value.
|
|
2423
|
-
* @format COLOR_HEX
|
|
2424
|
-
*/
|
|
2425
|
-
color?: string | null;
|
|
2426
|
-
/** An image to use for the background. */
|
|
2427
|
-
image?: Media;
|
|
2428
|
-
/** Details for a gradient background. */
|
|
2429
|
-
gradient?: Gradient;
|
|
2430
|
-
/** Background type. For each option, include the relevant details. */
|
|
2431
|
-
type?: BackgroundTypeWithLiterals;
|
|
2432
|
-
}
|
|
2433
|
-
/** @oneof */
|
|
2434
|
-
interface BackgroundBackgroundOneOf {
|
|
2435
|
-
/**
|
|
2436
|
-
* The background color as a hexademical value.
|
|
2437
|
-
* @format COLOR_HEX
|
|
2438
|
-
*/
|
|
2439
|
-
color?: string | null;
|
|
2440
|
-
/** An image to use for the background. */
|
|
2441
|
-
image?: Media;
|
|
2442
|
-
/** Details for a gradient background. */
|
|
2443
|
-
gradient?: Gradient;
|
|
2444
|
-
}
|
|
2445
|
-
interface PollDesign {
|
|
2446
|
-
/** Background styling. */
|
|
2447
|
-
background?: Background;
|
|
2448
|
-
/** Border radius in pixels. */
|
|
2449
|
-
borderRadius?: number | null;
|
|
2450
|
-
}
|
|
2451
|
-
interface OptionDesign {
|
|
2452
|
-
/** Border radius in pixels. */
|
|
2453
|
-
borderRadius?: number | null;
|
|
2454
|
-
}
|
|
2455
|
-
interface Poll {
|
|
2456
|
-
/** Poll ID. */
|
|
2457
|
-
id?: string | null;
|
|
2458
|
-
/** Poll title. */
|
|
2459
|
-
title?: string | null;
|
|
2460
|
-
/** Poll creator ID. */
|
|
2461
|
-
creatorId?: string | null;
|
|
2462
|
-
/** Main poll image. */
|
|
2463
|
-
image?: Media;
|
|
2464
|
-
/** Voting options. */
|
|
2465
|
-
options?: Option[];
|
|
2466
|
-
/** The poll's permissions and display settings. */
|
|
2467
|
-
settings?: PollSettings;
|
|
2468
|
-
}
|
|
2469
|
-
interface PollDataLayout {
|
|
2470
|
-
/** Poll layout settings. */
|
|
2471
|
-
poll?: PollLayout;
|
|
2472
|
-
/** Voting otpions layout settings. */
|
|
2473
|
-
options?: OptionLayout;
|
|
2474
|
-
}
|
|
2475
|
-
interface Design {
|
|
2476
|
-
/** Styling for the poll. */
|
|
2477
|
-
poll?: PollDesign;
|
|
2478
|
-
/** Styling for voting options. */
|
|
2479
|
-
options?: OptionDesign;
|
|
2480
|
-
}
|
|
2481
|
-
interface TextData {
|
|
2482
|
-
/** The text to apply decorations to. */
|
|
2483
|
-
text?: string;
|
|
2484
|
-
/** The decorations to apply. */
|
|
2485
|
-
decorations?: Decoration[];
|
|
2486
|
-
}
|
|
2487
|
-
/** Adds appearence changes to text */
|
|
2488
|
-
interface Decoration extends DecorationDataOneOf {
|
|
2489
|
-
/** Data for an anchor link decoration. */
|
|
2490
|
-
anchorData?: AnchorData;
|
|
2491
|
-
/** Data for a color decoration. */
|
|
2492
|
-
colorData?: ColorData;
|
|
2493
|
-
/** Data for an external link decoration. */
|
|
2494
|
-
linkData?: LinkData;
|
|
2495
|
-
/** Data for a mention decoration. */
|
|
2496
|
-
mentionData?: MentionData;
|
|
2497
|
-
/** Data for a font size decoration. */
|
|
2498
|
-
fontSizeData?: FontSizeData;
|
|
2499
|
-
/** Font weight for a bold decoration. */
|
|
2500
|
-
fontWeightValue?: number | null;
|
|
2501
|
-
/** Data for an italic decoration. Defaults to `true`. */
|
|
2502
|
-
italicData?: boolean | null;
|
|
2503
|
-
/** Data for an underline decoration. Defaults to `true`. */
|
|
2504
|
-
underlineData?: boolean | null;
|
|
2505
|
-
/** Data for a spoiler decoration. */
|
|
2506
|
-
spoilerData?: SpoilerData;
|
|
2507
|
-
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2508
|
-
strikethroughData?: boolean | null;
|
|
2509
|
-
/** Data for a superscript decoration. Defaults to `true`. */
|
|
2510
|
-
superscriptData?: boolean | null;
|
|
2511
|
-
/** Data for a subscript decoration. Defaults to `true`. */
|
|
2512
|
-
subscriptData?: boolean | null;
|
|
2513
|
-
/** Data for a font family decoration. */
|
|
2514
|
-
fontFamilyData?: FontFamilyData;
|
|
2515
|
-
/** The type of decoration to apply. */
|
|
2516
|
-
type?: DecorationTypeWithLiterals;
|
|
2517
|
-
}
|
|
2518
|
-
/** @oneof */
|
|
2519
|
-
interface DecorationDataOneOf {
|
|
2520
|
-
/** Data for an anchor link decoration. */
|
|
2521
|
-
anchorData?: AnchorData;
|
|
2522
|
-
/** Data for a color decoration. */
|
|
2523
|
-
colorData?: ColorData;
|
|
2524
|
-
/** Data for an external link decoration. */
|
|
2525
|
-
linkData?: LinkData;
|
|
2526
|
-
/** Data for a mention decoration. */
|
|
2527
|
-
mentionData?: MentionData;
|
|
2528
|
-
/** Data for a font size decoration. */
|
|
2529
|
-
fontSizeData?: FontSizeData;
|
|
2530
|
-
/** Font weight for a bold decoration. */
|
|
2531
|
-
fontWeightValue?: number | null;
|
|
2532
|
-
/** Data for an italic decoration. Defaults to `true`. */
|
|
2533
|
-
italicData?: boolean | null;
|
|
2534
|
-
/** Data for an underline decoration. Defaults to `true`. */
|
|
2535
|
-
underlineData?: boolean | null;
|
|
2536
|
-
/** Data for a spoiler decoration. */
|
|
2537
|
-
spoilerData?: SpoilerData;
|
|
2538
|
-
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2539
|
-
strikethroughData?: boolean | null;
|
|
2540
|
-
/** Data for a superscript decoration. Defaults to `true`. */
|
|
2541
|
-
superscriptData?: boolean | null;
|
|
2542
|
-
/** Data for a subscript decoration. Defaults to `true`. */
|
|
2543
|
-
subscriptData?: boolean | null;
|
|
2544
|
-
/** Data for a font family decoration. */
|
|
2545
|
-
fontFamilyData?: FontFamilyData;
|
|
2546
|
-
}
|
|
2547
|
-
declare enum DecorationType {
|
|
2548
|
-
BOLD = "BOLD",
|
|
2549
|
-
ITALIC = "ITALIC",
|
|
2550
|
-
UNDERLINE = "UNDERLINE",
|
|
2551
|
-
SPOILER = "SPOILER",
|
|
2552
|
-
ANCHOR = "ANCHOR",
|
|
2553
|
-
MENTION = "MENTION",
|
|
2554
|
-
LINK = "LINK",
|
|
2555
|
-
COLOR = "COLOR",
|
|
2556
|
-
FONT_SIZE = "FONT_SIZE",
|
|
2557
|
-
EXTERNAL = "EXTERNAL",
|
|
2558
|
-
STRIKETHROUGH = "STRIKETHROUGH",
|
|
2559
|
-
SUPERSCRIPT = "SUPERSCRIPT",
|
|
2560
|
-
SUBSCRIPT = "SUBSCRIPT",
|
|
2561
|
-
FONT_FAMILY = "FONT_FAMILY"
|
|
2562
|
-
}
|
|
2563
|
-
/** @enumType */
|
|
2564
|
-
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY';
|
|
2565
|
-
interface AnchorData {
|
|
2566
|
-
/** The target node's ID. */
|
|
2567
|
-
anchor?: string;
|
|
2568
|
-
}
|
|
2569
|
-
interface ColorData {
|
|
2570
|
-
/** The text's background color as a hexadecimal value. */
|
|
2571
|
-
background?: string | null;
|
|
2572
|
-
/** The text's foreground color as a hexadecimal value. */
|
|
2573
|
-
foreground?: string | null;
|
|
2574
|
-
}
|
|
2575
|
-
interface LinkData {
|
|
2576
|
-
/** Link details. */
|
|
2577
|
-
link?: V1Link;
|
|
2578
|
-
}
|
|
2579
|
-
interface MentionData {
|
|
2580
|
-
/** The mentioned user's name. */
|
|
2581
|
-
name?: string;
|
|
2582
|
-
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
2583
|
-
slug?: string;
|
|
2584
|
-
/** Mentioned user's ID. */
|
|
2585
|
-
id?: string | null;
|
|
2586
|
-
}
|
|
2587
|
-
interface FontSizeData {
|
|
2588
|
-
/** The units used for the font size. */
|
|
2589
|
-
unit?: FontTypeWithLiterals;
|
|
2590
|
-
/** Font size value. */
|
|
2591
|
-
value?: number | null;
|
|
2592
|
-
}
|
|
2593
|
-
declare enum FontType {
|
|
2594
|
-
PX = "PX",
|
|
2595
|
-
EM = "EM"
|
|
2596
|
-
}
|
|
2597
|
-
/** @enumType */
|
|
2598
|
-
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2599
|
-
interface SpoilerData {
|
|
2600
|
-
/** Spoiler ID. */
|
|
2601
|
-
id?: string | null;
|
|
2602
|
-
}
|
|
2603
|
-
interface FontFamilyData {
|
|
2604
|
-
/** @maxLength 1000 */
|
|
2605
|
-
value?: string | null;
|
|
2606
|
-
}
|
|
2607
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2608
|
-
/** Data for embedded Wix Bookings content. */
|
|
2609
|
-
bookingData?: BookingData;
|
|
2610
|
-
/** Data for embedded Wix Events content. */
|
|
2611
|
-
eventData?: EventData;
|
|
2612
|
-
/** The type of Wix App content being embedded. */
|
|
2613
|
-
type?: AppTypeWithLiterals;
|
|
2614
|
-
/** The ID of the embedded content. */
|
|
2615
|
-
itemId?: string | null;
|
|
2616
|
-
/** The name of the embedded content. */
|
|
2617
|
-
name?: string | null;
|
|
2618
|
-
/**
|
|
2619
|
-
* Deprecated: Use `image` instead.
|
|
2620
|
-
* @deprecated
|
|
2621
|
-
*/
|
|
2622
|
-
imageSrc?: string | null;
|
|
2623
|
-
/** The URL for the embedded content. */
|
|
2624
|
-
url?: string | null;
|
|
2625
|
-
/** An image for the embedded content. */
|
|
2626
|
-
image?: Media;
|
|
2627
|
-
/** Whether to hide the image. */
|
|
2628
|
-
hideImage?: boolean | null;
|
|
2629
|
-
/** Whether to hide the title. */
|
|
2630
|
-
hideTitle?: boolean | null;
|
|
2631
|
-
/** Whether to hide the price. */
|
|
2632
|
-
hidePrice?: boolean | null;
|
|
2633
|
-
/** Whether to hide the description (Event and Booking). */
|
|
2634
|
-
hideDescription?: boolean | null;
|
|
2635
|
-
/** Whether to hide the date and time (Event). */
|
|
2636
|
-
hideDateTime?: boolean | null;
|
|
2637
|
-
/** Whether to hide the location (Event). */
|
|
2638
|
-
hideLocation?: boolean | null;
|
|
2639
|
-
/** Whether to hide the duration (Booking). */
|
|
2640
|
-
hideDuration?: boolean | null;
|
|
2641
|
-
/** Whether to hide the button. */
|
|
2642
|
-
hideButton?: boolean | null;
|
|
2643
|
-
/** Whether to hide the ribbon. */
|
|
2644
|
-
hideRibbon?: boolean | null;
|
|
2645
|
-
/** Button styling options. */
|
|
2646
|
-
buttonStyles?: ButtonStyles;
|
|
2647
|
-
/** Image styling options. */
|
|
2648
|
-
imageStyles?: ImageStyles;
|
|
2649
|
-
/** Ribbon styling options. */
|
|
2650
|
-
ribbonStyles?: RibbonStyles;
|
|
2651
|
-
/** Card styling options. */
|
|
2652
|
-
cardStyles?: CardStyles;
|
|
2653
|
-
/** Styling for the app embed's container. */
|
|
2654
|
-
containerData?: PluginContainerData;
|
|
2655
|
-
/** Pricing data for embedded Wix App content. */
|
|
2656
|
-
pricingData?: PricingData;
|
|
2657
|
-
}
|
|
2658
|
-
/** @oneof */
|
|
2659
|
-
interface AppEmbedDataAppDataOneOf {
|
|
2660
|
-
/** Data for embedded Wix Bookings content. */
|
|
2661
|
-
bookingData?: BookingData;
|
|
2662
|
-
/** Data for embedded Wix Events content. */
|
|
2663
|
-
eventData?: EventData;
|
|
2664
|
-
}
|
|
2665
|
-
declare enum Position {
|
|
2666
|
-
/** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2667
|
-
START = "START",
|
|
2668
|
-
/** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
2669
|
-
END = "END",
|
|
2670
|
-
/** Image positioned at the top */
|
|
2671
|
-
TOP = "TOP"
|
|
2672
|
-
}
|
|
2673
|
-
/** @enumType */
|
|
2674
|
-
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
|
|
2675
|
-
declare enum AspectRatio {
|
|
2676
|
-
/** 1:1 aspect ratio */
|
|
2677
|
-
SQUARE = "SQUARE",
|
|
2678
|
-
/** 16:9 aspect ratio */
|
|
2679
|
-
RECTANGLE = "RECTANGLE"
|
|
2680
|
-
}
|
|
2681
|
-
/** @enumType */
|
|
2682
|
-
type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
|
|
2683
|
-
declare enum Resizing {
|
|
2684
|
-
/** Fill the container, may crop the image */
|
|
2685
|
-
FILL = "FILL",
|
|
2686
|
-
/** Fit the image within the container */
|
|
2687
|
-
FIT = "FIT"
|
|
2688
|
-
}
|
|
2689
|
-
/** @enumType */
|
|
2690
|
-
type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
|
|
2691
|
-
declare enum Placement {
|
|
2692
|
-
/** Ribbon placed on the image */
|
|
2693
|
-
IMAGE = "IMAGE",
|
|
2694
|
-
/** Ribbon placed on the product information */
|
|
2695
|
-
PRODUCT_INFO = "PRODUCT_INFO"
|
|
2696
|
-
}
|
|
2697
|
-
/** @enumType */
|
|
2698
|
-
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
|
2699
|
-
declare enum CardStylesType {
|
|
2700
|
-
/** Card with visible border and background */
|
|
2701
|
-
CONTAINED = "CONTAINED",
|
|
2702
|
-
/** Card without visible border */
|
|
2703
|
-
FRAMELESS = "FRAMELESS"
|
|
2704
|
-
}
|
|
2705
|
-
/** @enumType */
|
|
2706
|
-
type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
|
|
2707
|
-
declare enum Alignment {
|
|
2708
|
-
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
|
2709
|
-
START = "START",
|
|
2710
|
-
/** Content centered */
|
|
2711
|
-
CENTER = "CENTER",
|
|
2712
|
-
/** Content aligned to end (right in LTR layouts, left in RTL layouts) */
|
|
2713
|
-
END = "END"
|
|
2714
|
-
}
|
|
2715
|
-
/** @enumType */
|
|
2716
|
-
type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
|
|
2717
|
-
declare enum Layout {
|
|
2718
|
-
/** Elements stacked vertically */
|
|
2719
|
-
STACKED = "STACKED",
|
|
2720
|
-
/** Elements arranged horizontally */
|
|
2721
|
-
SIDE_BY_SIDE = "SIDE_BY_SIDE"
|
|
2722
|
-
}
|
|
2723
|
-
/** @enumType */
|
|
2724
|
-
type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
|
|
2725
|
-
declare enum AppType {
|
|
2726
|
-
PRODUCT = "PRODUCT",
|
|
2727
|
-
EVENT = "EVENT",
|
|
2728
|
-
BOOKING = "BOOKING"
|
|
2729
|
-
}
|
|
2730
|
-
/** @enumType */
|
|
2731
|
-
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2732
|
-
interface BookingData {
|
|
2733
|
-
/** Booking duration in minutes. */
|
|
2734
|
-
durations?: string | null;
|
|
2735
|
-
}
|
|
2736
|
-
interface EventData {
|
|
2737
|
-
/** Event schedule. */
|
|
2738
|
-
scheduling?: string | null;
|
|
2739
|
-
/** Event location. */
|
|
2740
|
-
location?: string | null;
|
|
2741
|
-
}
|
|
2742
|
-
interface ButtonStyles {
|
|
2743
|
-
/** Text to display on the button. */
|
|
2744
|
-
buttonText?: string | null;
|
|
2745
|
-
/** Border width in pixels. */
|
|
2746
|
-
borderWidth?: number | null;
|
|
2747
|
-
/** Border radius in pixels. */
|
|
2748
|
-
borderRadius?: number | null;
|
|
2749
|
-
/**
|
|
2750
|
-
* Border color as a hexadecimal value.
|
|
2751
|
-
* @format COLOR_HEX
|
|
2752
|
-
*/
|
|
2753
|
-
borderColor?: string | null;
|
|
2754
|
-
/**
|
|
2755
|
-
* Text color as a hexadecimal value.
|
|
2756
|
-
* @format COLOR_HEX
|
|
2757
|
-
*/
|
|
2758
|
-
textColor?: string | null;
|
|
2759
|
-
/**
|
|
2760
|
-
* Background color as a hexadecimal value.
|
|
2761
|
-
* @format COLOR_HEX
|
|
2762
|
-
*/
|
|
2763
|
-
backgroundColor?: string | null;
|
|
2764
|
-
/**
|
|
2765
|
-
* Border color as a hexadecimal value (hover state).
|
|
2766
|
-
* @format COLOR_HEX
|
|
2767
|
-
*/
|
|
2768
|
-
borderColorHover?: string | null;
|
|
2769
|
-
/**
|
|
2770
|
-
* Text color as a hexadecimal value (hover state).
|
|
2771
|
-
* @format COLOR_HEX
|
|
2772
|
-
*/
|
|
2773
|
-
textColorHover?: string | null;
|
|
2774
|
-
/**
|
|
2775
|
-
* Background color as a hexadecimal value (hover state).
|
|
2776
|
-
* @format COLOR_HEX
|
|
2777
|
-
*/
|
|
2778
|
-
backgroundColorHover?: string | null;
|
|
2779
|
-
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
2780
|
-
buttonSize?: string | null;
|
|
2781
|
-
}
|
|
2782
|
-
interface ImageStyles {
|
|
2783
|
-
/** Whether to hide the image. */
|
|
2784
|
-
hideImage?: boolean | null;
|
|
2785
|
-
/** Position of image. Defaults to `START`. */
|
|
2786
|
-
imagePosition?: PositionWithLiterals;
|
|
2787
|
-
/** Aspect ratio for the image. Defaults to `SQUARE`. */
|
|
2788
|
-
aspectRatio?: AspectRatioWithLiterals;
|
|
2789
|
-
/** How the image should be resized. Defaults to `FILL`. */
|
|
2790
|
-
resizing?: ResizingWithLiterals;
|
|
2791
|
-
/**
|
|
2792
|
-
* Image border color as a hexadecimal value.
|
|
2793
|
-
* @format COLOR_HEX
|
|
2794
|
-
*/
|
|
2795
|
-
borderColor?: string | null;
|
|
2796
|
-
/** Image border width in pixels. */
|
|
2797
|
-
borderWidth?: number | null;
|
|
2798
|
-
/** Image border radius in pixels. */
|
|
2799
|
-
borderRadius?: number | null;
|
|
2800
|
-
}
|
|
2801
|
-
interface RibbonStyles {
|
|
2802
|
-
/** Text to display on the ribbon. */
|
|
2803
|
-
ribbonText?: string | null;
|
|
2804
|
-
/**
|
|
2805
|
-
* Ribbon background color as a hexadecimal value.
|
|
2806
|
-
* @format COLOR_HEX
|
|
2807
|
-
*/
|
|
2808
|
-
backgroundColor?: string | null;
|
|
2809
|
-
/**
|
|
2810
|
-
* Ribbon text color as a hexadecimal value.
|
|
2811
|
-
* @format COLOR_HEX
|
|
2812
|
-
*/
|
|
2813
|
-
textColor?: string | null;
|
|
2814
|
-
/**
|
|
2815
|
-
* Ribbon border color as a hexadecimal value.
|
|
2816
|
-
* @format COLOR_HEX
|
|
2817
|
-
*/
|
|
2818
|
-
borderColor?: string | null;
|
|
2819
|
-
/** Ribbon border width in pixels. */
|
|
2820
|
-
borderWidth?: number | null;
|
|
2821
|
-
/** Ribbon border radius in pixels. */
|
|
2822
|
-
borderRadius?: number | null;
|
|
2823
|
-
/** Placement of the ribbon. Defaults to `IMAGE`. */
|
|
2824
|
-
ribbonPlacement?: PlacementWithLiterals;
|
|
2825
|
-
}
|
|
2826
|
-
interface CardStyles {
|
|
2827
|
-
/**
|
|
2828
|
-
* Card background color as a hexadecimal value.
|
|
2829
|
-
* @format COLOR_HEX
|
|
2830
|
-
*/
|
|
2831
|
-
backgroundColor?: string | null;
|
|
2832
|
-
/**
|
|
2833
|
-
* Card border color as a hexadecimal value.
|
|
2834
|
-
* @format COLOR_HEX
|
|
2835
|
-
*/
|
|
2836
|
-
borderColor?: string | null;
|
|
2837
|
-
/** Card border width in pixels. */
|
|
2838
|
-
borderWidth?: number | null;
|
|
2839
|
-
/** Card border radius in pixels. */
|
|
2840
|
-
borderRadius?: number | null;
|
|
2841
|
-
/** Card type. Defaults to `CONTAINED`. */
|
|
2842
|
-
type?: CardStylesTypeWithLiterals;
|
|
2843
|
-
/** Content alignment. Defaults to `START`. */
|
|
2844
|
-
alignment?: AlignmentWithLiterals;
|
|
2845
|
-
/** Layout for title and price. Defaults to `STACKED`. */
|
|
2846
|
-
titlePriceLayout?: LayoutWithLiterals;
|
|
2847
|
-
/**
|
|
2848
|
-
* Title text color as a hexadecimal value.
|
|
2849
|
-
* @format COLOR_HEX
|
|
2850
|
-
*/
|
|
2851
|
-
titleColor?: string | null;
|
|
2852
|
-
/**
|
|
2853
|
-
* Text color as a hexadecimal value.
|
|
2854
|
-
* @format COLOR_HEX
|
|
2855
|
-
*/
|
|
2856
|
-
textColor?: string | null;
|
|
2857
|
-
}
|
|
2858
|
-
interface PricingData {
|
|
2859
|
-
/**
|
|
2860
|
-
* Minimum numeric price value as string (e.g., "10.99").
|
|
2861
|
-
* @decimalValue options { maxScale:2 }
|
|
2862
|
-
*/
|
|
2863
|
-
valueFrom?: string | null;
|
|
2864
|
-
/**
|
|
2865
|
-
* Maximum numeric price value as string (e.g., "19.99").
|
|
2866
|
-
* @decimalValue options { maxScale:2 }
|
|
2867
|
-
*/
|
|
2868
|
-
valueTo?: string | null;
|
|
2869
|
-
/**
|
|
2870
|
-
* Numeric price value as string after discount application (e.g., "15.99").
|
|
2871
|
-
* @decimalValue options { maxScale:2 }
|
|
2872
|
-
*/
|
|
2873
|
-
discountedValue?: string | null;
|
|
2874
|
-
/**
|
|
2875
|
-
* Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
|
|
2876
|
-
* @format CURRENCY
|
|
2877
|
-
*/
|
|
2878
|
-
currency?: string | null;
|
|
2879
|
-
/**
|
|
2880
|
-
* Pricing plan ID.
|
|
2881
|
-
* @format GUID
|
|
2882
|
-
*/
|
|
2883
|
-
pricingPlanId?: string | null;
|
|
2884
|
-
}
|
|
2885
|
-
interface VideoData {
|
|
2886
|
-
/** Styling for the video's container. */
|
|
2887
|
-
containerData?: PluginContainerData;
|
|
2888
|
-
/** Video details. */
|
|
2889
|
-
video?: Media;
|
|
2890
|
-
/** Video thumbnail details. */
|
|
2891
|
-
thumbnail?: Media;
|
|
2892
|
-
/** Sets whether the video's download button is disabled. Defaults to `false`. */
|
|
2893
|
-
disableDownload?: boolean | null;
|
|
2894
|
-
/** Video title. */
|
|
2895
|
-
title?: string | null;
|
|
2896
|
-
/** Video options. */
|
|
2897
|
-
options?: PlaybackOptions;
|
|
2898
|
-
}
|
|
2899
|
-
interface PlaybackOptions {
|
|
2900
|
-
/** Sets whether the media will automatically start playing. */
|
|
2901
|
-
autoPlay?: boolean | null;
|
|
2902
|
-
/** Sets whether media's will be looped. */
|
|
2903
|
-
playInLoop?: boolean | null;
|
|
2904
|
-
/** Sets whether media's controls will be shown. */
|
|
2905
|
-
showControls?: boolean | null;
|
|
2906
|
-
}
|
|
2907
|
-
interface EmbedData {
|
|
2908
|
-
/** Styling for the oEmbed node's container. */
|
|
2909
|
-
containerData?: PluginContainerData;
|
|
2910
|
-
/** An [oEmbed](https://www.oembed.com) object. */
|
|
2911
|
-
oembed?: Oembed;
|
|
2912
|
-
/** Origin asset source. */
|
|
2913
|
-
src?: string | null;
|
|
2914
|
-
}
|
|
2915
|
-
interface Oembed {
|
|
2916
|
-
/** The resource type. */
|
|
2917
|
-
type?: string | null;
|
|
2918
|
-
/** The width of the resource specified in the `url` property in pixels. */
|
|
2919
|
-
width?: number | null;
|
|
2920
|
-
/** The height of the resource specified in the `url` property in pixels. */
|
|
2921
|
-
height?: number | null;
|
|
2922
|
-
/** Resource title. */
|
|
2923
|
-
title?: string | null;
|
|
2924
|
-
/** The source URL for the resource. */
|
|
2925
|
-
url?: string | null;
|
|
2926
|
-
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
2927
|
-
html?: string | null;
|
|
2928
|
-
/** The name of the author or owner of the resource. */
|
|
2929
|
-
authorName?: string | null;
|
|
2930
|
-
/** The URL for the author or owner of the resource. */
|
|
2931
|
-
authorUrl?: string | null;
|
|
2932
|
-
/** The name of the resource provider. */
|
|
2933
|
-
providerName?: string | null;
|
|
2934
|
-
/** The URL for the resource provider. */
|
|
2935
|
-
providerUrl?: string | null;
|
|
2936
|
-
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
2937
|
-
thumbnailUrl?: string | null;
|
|
2938
|
-
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
2939
|
-
thumbnailWidth?: string | null;
|
|
2940
|
-
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
2941
|
-
thumbnailHeight?: string | null;
|
|
2942
|
-
/** The URL for an embedded viedo. */
|
|
2943
|
-
videoUrl?: string | null;
|
|
2944
|
-
/** The oEmbed version number. This value must be `1.0`. */
|
|
2945
|
-
version?: string | null;
|
|
2946
|
-
}
|
|
2947
|
-
interface CollapsibleListData {
|
|
2948
|
-
/** Styling for the collapsible list's container. */
|
|
2949
|
-
containerData?: PluginContainerData;
|
|
2950
|
-
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2951
|
-
expandOnlyOne?: boolean | null;
|
|
2952
|
-
/** Sets which items are expanded when the page loads. */
|
|
2953
|
-
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2954
|
-
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2955
|
-
direction?: DirectionWithLiterals;
|
|
2956
|
-
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2957
|
-
isQapageData?: boolean | null;
|
|
2958
|
-
}
|
|
2959
|
-
declare enum InitialExpandedItems {
|
|
2960
|
-
/** First item will be expended initally */
|
|
2961
|
-
FIRST = "FIRST",
|
|
2962
|
-
/** All items will expended initally */
|
|
2963
|
-
ALL = "ALL",
|
|
2964
|
-
/** All items collapsed initally */
|
|
2965
|
-
NONE = "NONE"
|
|
2966
|
-
}
|
|
2967
|
-
/** @enumType */
|
|
2968
|
-
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2969
|
-
declare enum Direction {
|
|
2970
|
-
/** Left-to-right */
|
|
2971
|
-
LTR = "LTR",
|
|
2972
|
-
/** Right-to-left */
|
|
2973
|
-
RTL = "RTL"
|
|
2974
|
-
}
|
|
2975
|
-
/** @enumType */
|
|
2976
|
-
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2977
|
-
interface TableData {
|
|
2978
|
-
/** Styling for the table's container. */
|
|
2979
|
-
containerData?: PluginContainerData;
|
|
2980
|
-
/** The table's dimensions. */
|
|
2981
|
-
dimensions?: Dimensions;
|
|
2982
|
-
/**
|
|
2983
|
-
* Deprecated: Use `rowHeader` and `columnHeader` instead.
|
|
2984
|
-
* @deprecated
|
|
2985
|
-
*/
|
|
2986
|
-
header?: boolean | null;
|
|
2987
|
-
/** Sets whether the table's first row is a header. Defaults to `false`. */
|
|
2988
|
-
rowHeader?: boolean | null;
|
|
2989
|
-
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2990
|
-
columnHeader?: boolean | null;
|
|
2991
|
-
/** The spacing between cells in pixels. Defaults to `0`. */
|
|
2992
|
-
cellSpacing?: number | null;
|
|
2993
|
-
/**
|
|
2994
|
-
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
|
|
2995
|
-
* @maxSize 4
|
|
2996
|
-
*/
|
|
2997
|
-
cellPadding?: number[];
|
|
2998
|
-
}
|
|
2999
|
-
interface Dimensions {
|
|
3000
|
-
/** An array representing relative width of each column in relation to the other columns. */
|
|
3001
|
-
colsWidthRatio?: number[];
|
|
3002
|
-
/** An array representing the height of each row in pixels. */
|
|
3003
|
-
rowsHeight?: number[];
|
|
3004
|
-
/** An array representing the minimum width of each column in pixels. */
|
|
3005
|
-
colsMinWidth?: number[];
|
|
3006
|
-
}
|
|
3007
|
-
interface TableCellData {
|
|
3008
|
-
/** Styling for the cell's background color and text alignment. */
|
|
3009
|
-
cellStyle?: CellStyle;
|
|
3010
|
-
/** The cell's border colors. */
|
|
3011
|
-
borderColors?: BorderColors;
|
|
3012
|
-
/** Defines how many columns the cell spans. Default: 1. */
|
|
3013
|
-
colspan?: number | null;
|
|
3014
|
-
/** Defines how many rows the cell spans. Default: 1. */
|
|
3015
|
-
rowspan?: number | null;
|
|
3016
|
-
/** The cell's border widths. */
|
|
3017
|
-
borderWidths?: BorderWidths;
|
|
3018
|
-
}
|
|
3019
|
-
declare enum VerticalAlignment {
|
|
3020
|
-
/** Top alignment */
|
|
3021
|
-
TOP = "TOP",
|
|
3022
|
-
/** Middle alignment */
|
|
3023
|
-
MIDDLE = "MIDDLE",
|
|
3024
|
-
/** Bottom alignment */
|
|
3025
|
-
BOTTOM = "BOTTOM"
|
|
3026
|
-
}
|
|
3027
|
-
/** @enumType */
|
|
3028
|
-
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
3029
|
-
interface CellStyle {
|
|
3030
|
-
/** Vertical alignment for the cell's text. */
|
|
3031
|
-
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
3032
|
-
/**
|
|
3033
|
-
* Cell background color as a hexadecimal value.
|
|
3034
|
-
* @format COLOR_HEX
|
|
3035
|
-
*/
|
|
3036
|
-
backgroundColor?: string | null;
|
|
3037
|
-
}
|
|
3038
|
-
interface BorderColors {
|
|
3039
|
-
/**
|
|
3040
|
-
* Left border color as a hexadecimal value.
|
|
3041
|
-
* @format COLOR_HEX
|
|
3042
|
-
*/
|
|
3043
|
-
left?: string | null;
|
|
3044
|
-
/**
|
|
3045
|
-
* Right border color as a hexadecimal value.
|
|
3046
|
-
* @format COLOR_HEX
|
|
3047
|
-
*/
|
|
3048
|
-
right?: string | null;
|
|
3049
|
-
/**
|
|
3050
|
-
* Top border color as a hexadecimal value.
|
|
3051
|
-
* @format COLOR_HEX
|
|
3052
|
-
*/
|
|
3053
|
-
top?: string | null;
|
|
3054
|
-
/**
|
|
3055
|
-
* Bottom border color as a hexadecimal value.
|
|
3056
|
-
* @format COLOR_HEX
|
|
3057
|
-
*/
|
|
3058
|
-
bottom?: string | null;
|
|
3059
|
-
}
|
|
3060
|
-
interface BorderWidths {
|
|
3061
|
-
/** Left border width in pixels. */
|
|
3062
|
-
left?: number | null;
|
|
3063
|
-
/** Right border width in pixels. */
|
|
3064
|
-
right?: number | null;
|
|
3065
|
-
/** Top border width in pixels. */
|
|
3066
|
-
top?: number | null;
|
|
3067
|
-
/** Bottom border width in pixels. */
|
|
3068
|
-
bottom?: number | null;
|
|
3069
|
-
}
|
|
3070
|
-
/**
|
|
3071
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
3072
|
-
* `Value` type union.
|
|
3073
|
-
*
|
|
3074
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
3075
|
-
*/
|
|
3076
|
-
declare enum NullValue {
|
|
3077
|
-
/** Null value. */
|
|
3078
|
-
NULL_VALUE = "NULL_VALUE"
|
|
3079
|
-
}
|
|
3080
|
-
/** @enumType */
|
|
3081
|
-
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
3082
|
-
/**
|
|
3083
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
3084
|
-
*
|
|
3085
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
3086
|
-
*/
|
|
3087
|
-
interface ListValue {
|
|
3088
|
-
/** Repeated field of dynamically typed values. */
|
|
3089
|
-
values?: any[];
|
|
3090
|
-
}
|
|
3091
|
-
interface AudioData {
|
|
3092
|
-
/** Styling for the audio node's container. */
|
|
3093
|
-
containerData?: PluginContainerData;
|
|
3094
|
-
/** Audio file details. */
|
|
3095
|
-
audio?: Media;
|
|
3096
|
-
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
|
|
3097
|
-
disableDownload?: boolean | null;
|
|
3098
|
-
/** Cover image. */
|
|
3099
|
-
coverImage?: Media;
|
|
3100
|
-
/** Track name. */
|
|
3101
|
-
name?: string | null;
|
|
3102
|
-
/** Author name. */
|
|
3103
|
-
authorName?: string | null;
|
|
3104
|
-
/** An HTML version of the audio node. */
|
|
3105
|
-
html?: string | null;
|
|
3106
|
-
}
|
|
3107
|
-
interface OrderedListData {
|
|
3108
|
-
/** Indentation level from 0-4. */
|
|
3109
|
-
indentation?: number;
|
|
3110
|
-
/** Offset level from 0-4. */
|
|
3111
|
-
offset?: number | null;
|
|
3112
|
-
/** List start number. */
|
|
3113
|
-
start?: number | null;
|
|
3114
|
-
}
|
|
3115
|
-
interface BulletedListData {
|
|
3116
|
-
/** Indentation level from 0-4. */
|
|
3117
|
-
indentation?: number;
|
|
3118
|
-
/** Offset level from 0-4. */
|
|
3119
|
-
offset?: number | null;
|
|
3120
|
-
}
|
|
3121
|
-
interface BlockquoteData {
|
|
3122
|
-
/** Indentation level from 1-4. */
|
|
3123
|
-
indentation?: number;
|
|
3124
|
-
}
|
|
3125
|
-
interface CaptionData {
|
|
3126
|
-
textStyle?: TextStyle;
|
|
3127
|
-
}
|
|
3128
|
-
interface LayoutData {
|
|
3129
|
-
/**
|
|
3130
|
-
* Background color as a hexadecimal value.
|
|
3131
|
-
* @format COLOR_HEX
|
|
3132
|
-
*/
|
|
3133
|
-
backgroundColor?: string | null;
|
|
3134
|
-
/** Background image. */
|
|
3135
|
-
backgroundImage?: BackgroundImage;
|
|
3136
|
-
/**
|
|
3137
|
-
* Border color as a hexadecimal value.
|
|
3138
|
-
* @format COLOR_HEX
|
|
3139
|
-
*/
|
|
3140
|
-
borderColor?: string | null;
|
|
3141
|
-
/** Border width in pixels. */
|
|
3142
|
-
borderWidth?: number | null;
|
|
3143
|
-
/** Border */
|
|
3144
|
-
borderRadius?: number | null;
|
|
3145
|
-
/**
|
|
3146
|
-
* Backdrop color as a hexadecimal value.
|
|
3147
|
-
* @format COLOR_HEX
|
|
3148
|
-
*/
|
|
3149
|
-
backdropColor?: string | null;
|
|
3150
|
-
/** Backdrop image.radius in pixels. */
|
|
3151
|
-
backdropImage?: BackgroundImage;
|
|
3152
|
-
/** Backdrop top padding. */
|
|
3153
|
-
backdropPaddingTop?: number | null;
|
|
3154
|
-
/** Backdrop bottom padding */
|
|
3155
|
-
backdropPaddingBottom?: number | null;
|
|
3156
|
-
/** Horizontal and vertical gap between columns */
|
|
3157
|
-
gap?: number | null;
|
|
3158
|
-
/**
|
|
3159
|
-
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left
|
|
3160
|
-
* @maxSize 4
|
|
3161
|
-
*/
|
|
3162
|
-
cellPadding?: number[];
|
|
3163
|
-
/** Vertical alignment for the cell's items. */
|
|
3164
|
-
cellVerticalAlignment?: VerticalAlignmentAlignmentWithLiterals;
|
|
3165
|
-
/** Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers. */
|
|
3166
|
-
responsivenessBehaviour?: ResponsivenessBehaviourWithLiterals;
|
|
3167
|
-
/** Size in pixels when responsiveness_behaviour applies */
|
|
3168
|
-
responsivenessBreakpoint?: number | null;
|
|
3169
|
-
/** Styling for the layout's container. */
|
|
3170
|
-
containerData?: PluginContainerData;
|
|
3171
|
-
}
|
|
3172
|
-
declare enum Scaling {
|
|
3173
|
-
/** Auto image scaling */
|
|
3174
|
-
AUTO = "AUTO",
|
|
3175
|
-
/** Contain image scaling */
|
|
3176
|
-
CONTAIN = "CONTAIN",
|
|
3177
|
-
/** Cover image scaling */
|
|
3178
|
-
COVER = "COVER"
|
|
3179
|
-
}
|
|
3180
|
-
/** @enumType */
|
|
3181
|
-
type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
|
|
3182
|
-
declare enum ImagePosition {
|
|
3183
|
-
/** Image positioned at the center */
|
|
3184
|
-
CENTER = "CENTER",
|
|
3185
|
-
/** Image positioned on the left */
|
|
3186
|
-
CENTER_LEFT = "CENTER_LEFT",
|
|
3187
|
-
/** Image positioned on the right */
|
|
3188
|
-
CENTER_RIGHT = "CENTER_RIGHT",
|
|
3189
|
-
/** Image positioned at the center top */
|
|
3190
|
-
TOP = "TOP",
|
|
3191
|
-
/** Image positioned at the top left */
|
|
3192
|
-
TOP_LEFT = "TOP_LEFT",
|
|
3193
|
-
/** Image positioned at the top right */
|
|
3194
|
-
TOP_RIGHT = "TOP_RIGHT",
|
|
3195
|
-
/** Image positioned at the center bottom */
|
|
3196
|
-
BOTTOM = "BOTTOM",
|
|
3197
|
-
/** Image positioned at the bottom left */
|
|
3198
|
-
BOTTOM_LEFT = "BOTTOM_LEFT",
|
|
3199
|
-
/** Image positioned at the bottom right */
|
|
3200
|
-
BOTTOM_RIGHT = "BOTTOM_RIGHT"
|
|
3201
|
-
}
|
|
3202
|
-
/** @enumType */
|
|
3203
|
-
type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
3204
|
-
interface BackgroundImage {
|
|
3205
|
-
/** Background image. */
|
|
3206
|
-
media?: Media;
|
|
3207
|
-
/** Background image opacity. */
|
|
3208
|
-
opacity?: number | null;
|
|
3209
|
-
/** Background image scaling. */
|
|
3210
|
-
scaling?: ScalingWithLiterals;
|
|
3211
|
-
/** Position of background. Defaults to `CENTER`. */
|
|
3212
|
-
position?: ImagePositionWithLiterals;
|
|
3213
|
-
}
|
|
3214
|
-
declare enum VerticalAlignmentAlignment {
|
|
3215
|
-
/** Top alignment */
|
|
3216
|
-
TOP = "TOP",
|
|
3217
|
-
/** Middle alignment */
|
|
3218
|
-
MIDDLE = "MIDDLE",
|
|
3219
|
-
/** Bottom alignment */
|
|
3220
|
-
BOTTOM = "BOTTOM"
|
|
3221
|
-
}
|
|
3222
|
-
/** @enumType */
|
|
3223
|
-
type VerticalAlignmentAlignmentWithLiterals = VerticalAlignmentAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
3224
|
-
declare enum ResponsivenessBehaviour {
|
|
3225
|
-
/** Stacking of columns */
|
|
3226
|
-
STACK = "STACK",
|
|
3227
|
-
/** Wrapping of columns */
|
|
3228
|
-
WRAP = "WRAP"
|
|
3229
|
-
}
|
|
3230
|
-
/** @enumType */
|
|
3231
|
-
type ResponsivenessBehaviourWithLiterals = ResponsivenessBehaviour | 'STACK' | 'WRAP';
|
|
3232
|
-
interface LayoutCellData {
|
|
3233
|
-
/** Size of the cell in 12 columns grid. */
|
|
3234
|
-
colSpan?: number | null;
|
|
3235
|
-
}
|
|
3236
|
-
interface Metadata {
|
|
3237
|
-
/** Schema version. */
|
|
3238
|
-
version?: number;
|
|
3239
|
-
/**
|
|
3240
|
-
* When the object was created.
|
|
3241
|
-
* @readonly
|
|
3242
|
-
* @deprecated
|
|
3243
|
-
*/
|
|
3244
|
-
createdTimestamp?: Date | null;
|
|
3245
|
-
/**
|
|
3246
|
-
* When the object was most recently updated.
|
|
3247
|
-
* @deprecated
|
|
3248
|
-
*/
|
|
3249
|
-
updatedTimestamp?: Date | null;
|
|
3250
|
-
/** Object ID. */
|
|
3251
|
-
_id?: string | null;
|
|
3252
|
-
}
|
|
3253
|
-
interface DocumentStyle {
|
|
3254
|
-
/** Styling for H1 nodes. */
|
|
3255
|
-
headerOne?: TextNodeStyle;
|
|
3256
|
-
/** Styling for H2 nodes. */
|
|
3257
|
-
headerTwo?: TextNodeStyle;
|
|
3258
|
-
/** Styling for H3 nodes. */
|
|
3259
|
-
headerThree?: TextNodeStyle;
|
|
3260
|
-
/** Styling for H4 nodes. */
|
|
3261
|
-
headerFour?: TextNodeStyle;
|
|
3262
|
-
/** Styling for H5 nodes. */
|
|
3263
|
-
headerFive?: TextNodeStyle;
|
|
3264
|
-
/** Styling for H6 nodes. */
|
|
3265
|
-
headerSix?: TextNodeStyle;
|
|
3266
|
-
/** Styling for paragraph nodes. */
|
|
3267
|
-
paragraph?: TextNodeStyle;
|
|
3268
|
-
/** Styling for block quote nodes. */
|
|
3269
|
-
blockquote?: TextNodeStyle;
|
|
3270
|
-
/** Styling for code block nodes. */
|
|
3271
|
-
codeBlock?: TextNodeStyle;
|
|
3272
|
-
}
|
|
3273
|
-
interface TextNodeStyle {
|
|
3274
|
-
/** The decorations to apply to the node. */
|
|
3275
|
-
decorations?: Decoration[];
|
|
3276
|
-
/** Padding and background color for the node. */
|
|
3277
|
-
nodeStyle?: NodeStyle;
|
|
3278
|
-
/** Line height for text in the node. */
|
|
3279
|
-
lineHeight?: string | null;
|
|
3280
|
-
}
|
|
3281
|
-
interface Badge {
|
|
3282
|
-
/** Badge type. */
|
|
3283
|
-
type?: TypeWithLiterals;
|
|
3284
|
-
/**
|
|
3285
|
-
* Badge text.
|
|
3286
|
-
* @maxLength 50
|
|
3287
|
-
*/
|
|
3288
|
-
text?: string | null;
|
|
3289
|
-
}
|
|
3290
|
-
declare enum Type {
|
|
3291
|
-
/** Unknown badge type. */
|
|
3292
|
-
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
3293
|
-
/** 1st priority badge type. */
|
|
3294
|
-
FIRST_PRIORITY = "FIRST_PRIORITY",
|
|
3295
|
-
/** 2nd priority badge type. */
|
|
3296
|
-
SECOND_PRIORITY = "SECOND_PRIORITY",
|
|
3297
|
-
/** 3rd priority badge type. */
|
|
3298
|
-
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
3299
|
-
}
|
|
3300
|
-
/** @enumType */
|
|
3301
|
-
type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
3302
293
|
/** Triggered when an order is confirmed. */
|
|
3303
294
|
interface OrderConfirmed {
|
|
3304
295
|
/** Date and time the order was confirmed. */
|
|
@@ -3432,6 +423,23 @@ interface CommonSubdivision {
|
|
|
3432
423
|
/** Subdivision full name. */
|
|
3433
424
|
name?: string;
|
|
3434
425
|
}
|
|
426
|
+
declare enum SubdivisionType {
|
|
427
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
428
|
+
/** State */
|
|
429
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
430
|
+
/** County */
|
|
431
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
432
|
+
/** City/town */
|
|
433
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
434
|
+
/** Neighborhood/quarter */
|
|
435
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
436
|
+
/** Street/block */
|
|
437
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
438
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
439
|
+
COUNTRY = "COUNTRY"
|
|
440
|
+
}
|
|
441
|
+
/** @enumType */
|
|
442
|
+
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';
|
|
3435
443
|
/** Subdivision Concordance values */
|
|
3436
444
|
interface StandardDetails {
|
|
3437
445
|
/**
|
|
@@ -3518,6 +526,24 @@ interface CheckIn {
|
|
|
3518
526
|
/** Time of a ticket's check-in. */
|
|
3519
527
|
created?: Date | null;
|
|
3520
528
|
}
|
|
529
|
+
interface Money {
|
|
530
|
+
/**
|
|
531
|
+
* *Deprecated:** Use `value` instead.
|
|
532
|
+
* @format DECIMAL_VALUE
|
|
533
|
+
* @deprecated
|
|
534
|
+
*/
|
|
535
|
+
amount?: string;
|
|
536
|
+
/**
|
|
537
|
+
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
|
|
538
|
+
* @format CURRENCY
|
|
539
|
+
*/
|
|
540
|
+
currency?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
|
|
543
|
+
* @format DECIMAL_VALUE
|
|
544
|
+
*/
|
|
545
|
+
value?: string | null;
|
|
546
|
+
}
|
|
3521
547
|
interface OnlineConferencingLogin {
|
|
3522
548
|
/**
|
|
3523
549
|
* Link URL to the online conference.
|
|
@@ -3675,6 +701,16 @@ interface Tax {
|
|
|
3675
701
|
/** Total tax amount. */
|
|
3676
702
|
amount?: Money;
|
|
3677
703
|
}
|
|
704
|
+
declare enum TaxType {
|
|
705
|
+
/** Tax is included in the ticket price. */
|
|
706
|
+
INCLUDED = "INCLUDED",
|
|
707
|
+
/** Tax is added to the order at the checkout. */
|
|
708
|
+
ADDED = "ADDED",
|
|
709
|
+
/** Tax is added to the final total at the checkout. */
|
|
710
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
711
|
+
}
|
|
712
|
+
/** @enumType */
|
|
713
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
3678
714
|
interface Fee {
|
|
3679
715
|
/** Fee identifier. */
|
|
3680
716
|
name?: FeeNameWithLiterals;
|
|
@@ -3774,83 +810,23 @@ interface OrderEmailAdded {
|
|
|
3774
810
|
status?: OrderStatusWithLiterals;
|
|
3775
811
|
/**
|
|
3776
812
|
* Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.
|
|
3777
|
-
* @maxLength 100
|
|
3778
|
-
*/
|
|
3779
|
-
method?: string | null;
|
|
3780
|
-
/**
|
|
3781
|
-
* Tickets generated after payment.
|
|
3782
|
-
* @maxSize 50
|
|
3783
|
-
*/
|
|
3784
|
-
tickets?: Ticket[];
|
|
3785
|
-
/** Whether order was archived and excluded from results. */
|
|
3786
|
-
archived?: boolean;
|
|
3787
|
-
/**
|
|
3788
|
-
* Reservation ID associated with this order.
|
|
3789
|
-
* @format GUID
|
|
3790
|
-
*/
|
|
3791
|
-
reservationId?: string;
|
|
3792
|
-
/** Whether marketing consent was given. */
|
|
3793
|
-
marketingConsent?: boolean | null;
|
|
3794
|
-
}
|
|
3795
|
-
interface EventCanceled {
|
|
3796
|
-
/** Event canceled timestamp in ISO UTC format. */
|
|
3797
|
-
timestamp?: Date | null;
|
|
3798
|
-
/**
|
|
3799
|
-
* Event ID.
|
|
3800
|
-
* @format GUID
|
|
3801
|
-
*/
|
|
3802
|
-
eventId?: string;
|
|
3803
|
-
/** Event title */
|
|
3804
|
-
title?: string;
|
|
3805
|
-
/**
|
|
3806
|
-
* Event creator user ID.
|
|
3807
|
-
* @format GUID
|
|
3808
|
-
*/
|
|
3809
|
-
userId?: string | null;
|
|
3810
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3811
|
-
hasGuests?: boolean | null;
|
|
3812
|
-
}
|
|
3813
|
-
interface EventReminder {
|
|
3814
|
-
/** Reminder timestamp in ISO UTC format. */
|
|
3815
|
-
timestamp?: Date | null;
|
|
3816
|
-
/**
|
|
3817
|
-
* Event ID.
|
|
3818
|
-
* @format GUID
|
|
3819
|
-
*/
|
|
3820
|
-
eventId?: string;
|
|
3821
|
-
/** Event location. */
|
|
3822
|
-
location?: Location;
|
|
3823
|
-
/** Event schedule configuration. */
|
|
3824
|
-
scheduleConfig?: ScheduleConfig;
|
|
3825
|
-
/** Event title. */
|
|
3826
|
-
title?: string;
|
|
3827
|
-
/**
|
|
3828
|
-
* Event creator user ID.
|
|
3829
|
-
* @format GUID
|
|
813
|
+
* @maxLength 100
|
|
3830
814
|
*/
|
|
3831
|
-
|
|
3832
|
-
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
3833
|
-
startsIn?: TimeDuration;
|
|
3834
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
3835
|
-
hasGuests?: boolean | null;
|
|
3836
|
-
}
|
|
3837
|
-
/**
|
|
3838
|
-
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
3839
|
-
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
3840
|
-
*/
|
|
3841
|
-
interface TimeDuration {
|
|
3842
|
-
/** Number of days. */
|
|
3843
|
-
days?: number;
|
|
815
|
+
method?: string | null;
|
|
3844
816
|
/**
|
|
3845
|
-
*
|
|
3846
|
-
* @
|
|
817
|
+
* Tickets generated after payment.
|
|
818
|
+
* @maxSize 50
|
|
3847
819
|
*/
|
|
3848
|
-
|
|
820
|
+
tickets?: Ticket[];
|
|
821
|
+
/** Whether order was archived and excluded from results. */
|
|
822
|
+
archived?: boolean;
|
|
3849
823
|
/**
|
|
3850
|
-
*
|
|
3851
|
-
* @
|
|
824
|
+
* Reservation ID associated with this order.
|
|
825
|
+
* @format GUID
|
|
3852
826
|
*/
|
|
3853
|
-
|
|
827
|
+
reservationId?: string;
|
|
828
|
+
/** Whether marketing consent was given. */
|
|
829
|
+
marketingConsent?: boolean | null;
|
|
3854
830
|
}
|
|
3855
831
|
/** Triggered when an order is paid. */
|
|
3856
832
|
interface OrderPaid {
|
|
@@ -4007,28 +983,6 @@ interface OrderCanceled {
|
|
|
4007
983
|
/** Invoice. */
|
|
4008
984
|
invoice?: Invoice;
|
|
4009
985
|
}
|
|
4010
|
-
interface EventEnded {
|
|
4011
|
-
/** Event end timestamp in ISO UTC format. */
|
|
4012
|
-
timestamp?: Date | null;
|
|
4013
|
-
/**
|
|
4014
|
-
* Event ID.
|
|
4015
|
-
* @format GUID
|
|
4016
|
-
*/
|
|
4017
|
-
eventId?: string;
|
|
4018
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4019
|
-
hasGuests?: boolean | null;
|
|
4020
|
-
}
|
|
4021
|
-
interface EventStarted {
|
|
4022
|
-
/** Event start timestamp in ISO UTC format. */
|
|
4023
|
-
timestamp?: Date | null;
|
|
4024
|
-
/**
|
|
4025
|
-
* Event ID.
|
|
4026
|
-
* @format GUID
|
|
4027
|
-
*/
|
|
4028
|
-
eventId?: string;
|
|
4029
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4030
|
-
hasGuests?: boolean | null;
|
|
4031
|
-
}
|
|
4032
986
|
interface ResolveNotificationConfigRequest {
|
|
4033
987
|
/**
|
|
4034
988
|
* Id of the NotificationConfig to retrieve
|
|
@@ -4061,6 +1015,24 @@ interface ResolveEmailNotificationConfigResponse {
|
|
|
4061
1015
|
/** The retrieved EmailNotificationConfig */
|
|
4062
1016
|
emailNotificationConfig?: EmailNotificationConfig;
|
|
4063
1017
|
}
|
|
1018
|
+
interface EventCanceled {
|
|
1019
|
+
/** Event canceled timestamp in ISO UTC format. */
|
|
1020
|
+
timestamp?: Date | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Event ID.
|
|
1023
|
+
* @format GUID
|
|
1024
|
+
*/
|
|
1025
|
+
eventId?: string;
|
|
1026
|
+
/** Event title */
|
|
1027
|
+
title?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* Event creator user ID.
|
|
1030
|
+
* @format GUID
|
|
1031
|
+
*/
|
|
1032
|
+
userId?: string | null;
|
|
1033
|
+
/** True if at least one guest is registered to the event with any attendance status. */
|
|
1034
|
+
hasGuests?: boolean | null;
|
|
1035
|
+
}
|
|
4064
1036
|
interface EventDeleted {
|
|
4065
1037
|
/** Event deleted timestamp in ISO UTC format. */
|
|
4066
1038
|
timestamp?: Date | null;
|
|
@@ -4115,6 +1087,208 @@ interface EventCopied {
|
|
|
4115
1087
|
*/
|
|
4116
1088
|
ticketDefinitions?: Record<string, string>;
|
|
4117
1089
|
}
|
|
1090
|
+
interface Location {
|
|
1091
|
+
/**
|
|
1092
|
+
* Location name.
|
|
1093
|
+
* @maxLength 50
|
|
1094
|
+
*/
|
|
1095
|
+
name?: string | null;
|
|
1096
|
+
/** Location map coordinates. */
|
|
1097
|
+
coordinates?: MapCoordinates;
|
|
1098
|
+
/**
|
|
1099
|
+
* Single line address representation.
|
|
1100
|
+
* @maxLength 300
|
|
1101
|
+
*/
|
|
1102
|
+
address?: string | null;
|
|
1103
|
+
/** Location type. */
|
|
1104
|
+
type?: LocationTypeWithLiterals;
|
|
1105
|
+
/**
|
|
1106
|
+
* Full address derived from formatted single line `address`.
|
|
1107
|
+
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
1108
|
+
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
1109
|
+
*
|
|
1110
|
+
* Migration notes:
|
|
1111
|
+
* - `full_address.formatted_address` is equivalent to `address`.
|
|
1112
|
+
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
1113
|
+
*/
|
|
1114
|
+
fullAddress?: Address;
|
|
1115
|
+
/**
|
|
1116
|
+
* Defines event location as TBD (To Be Determined).
|
|
1117
|
+
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
1118
|
+
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
1119
|
+
*/
|
|
1120
|
+
tbd?: boolean | null;
|
|
1121
|
+
}
|
|
1122
|
+
interface MapCoordinates {
|
|
1123
|
+
/**
|
|
1124
|
+
* Latitude.
|
|
1125
|
+
* @min -90
|
|
1126
|
+
* @max 90
|
|
1127
|
+
*/
|
|
1128
|
+
lat?: number;
|
|
1129
|
+
/**
|
|
1130
|
+
* Longitude.
|
|
1131
|
+
* @min -180
|
|
1132
|
+
* @max 180
|
|
1133
|
+
*/
|
|
1134
|
+
lng?: number;
|
|
1135
|
+
}
|
|
1136
|
+
declare enum LocationType {
|
|
1137
|
+
VENUE = "VENUE",
|
|
1138
|
+
ONLINE = "ONLINE"
|
|
1139
|
+
}
|
|
1140
|
+
/** @enumType */
|
|
1141
|
+
type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
|
|
1142
|
+
/** Physical address */
|
|
1143
|
+
interface Address extends AddressStreetOneOf {
|
|
1144
|
+
/** a break down of the street to number and street name */
|
|
1145
|
+
streetAddress?: StreetAddress;
|
|
1146
|
+
/** Main address line (usually street and number) as free text */
|
|
1147
|
+
addressLine1?: string | null;
|
|
1148
|
+
/**
|
|
1149
|
+
* country code
|
|
1150
|
+
* @format COUNTRY
|
|
1151
|
+
*/
|
|
1152
|
+
country?: string | null;
|
|
1153
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
1154
|
+
subdivision?: string | null;
|
|
1155
|
+
/** city name */
|
|
1156
|
+
city?: string | null;
|
|
1157
|
+
/** zip/postal code */
|
|
1158
|
+
postalCode?: string | null;
|
|
1159
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
1160
|
+
addressLine2?: string | null;
|
|
1161
|
+
/** A string containing the human-readable address of this location */
|
|
1162
|
+
formatted?: string | null;
|
|
1163
|
+
/** Free text for human-to-human textual orientation aid purposes */
|
|
1164
|
+
hint?: string | null;
|
|
1165
|
+
/** coordinates of the physical address */
|
|
1166
|
+
location?: AddressLocation;
|
|
1167
|
+
/** country full-name */
|
|
1168
|
+
countryFullname?: string | null;
|
|
1169
|
+
/**
|
|
1170
|
+
* multi-level subdivisions from top to bottom
|
|
1171
|
+
* @maxSize 6
|
|
1172
|
+
*/
|
|
1173
|
+
subdivisions?: Subdivision[];
|
|
1174
|
+
}
|
|
1175
|
+
/** @oneof */
|
|
1176
|
+
interface AddressStreetOneOf {
|
|
1177
|
+
/** a break down of the street to number and street name */
|
|
1178
|
+
streetAddress?: StreetAddress;
|
|
1179
|
+
/** Main address line (usually street and number) as free text */
|
|
1180
|
+
addressLine?: string | null;
|
|
1181
|
+
}
|
|
1182
|
+
interface StreetAddress {
|
|
1183
|
+
/** street number */
|
|
1184
|
+
number?: string;
|
|
1185
|
+
/** street name */
|
|
1186
|
+
name?: string;
|
|
1187
|
+
}
|
|
1188
|
+
interface AddressLocation {
|
|
1189
|
+
/**
|
|
1190
|
+
* address latitude coordinates
|
|
1191
|
+
* @min -90
|
|
1192
|
+
* @max 90
|
|
1193
|
+
*/
|
|
1194
|
+
latitude?: number | null;
|
|
1195
|
+
/**
|
|
1196
|
+
* address longitude coordinates
|
|
1197
|
+
* @min -180
|
|
1198
|
+
* @max 180
|
|
1199
|
+
*/
|
|
1200
|
+
longitude?: number | null;
|
|
1201
|
+
}
|
|
1202
|
+
interface Subdivision {
|
|
1203
|
+
/** subdivision short code */
|
|
1204
|
+
code?: string;
|
|
1205
|
+
/** subdivision full-name */
|
|
1206
|
+
name?: string;
|
|
1207
|
+
}
|
|
1208
|
+
interface ScheduleConfig {
|
|
1209
|
+
/**
|
|
1210
|
+
* Defines event as TBD (To Be Determined) schedule.
|
|
1211
|
+
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
1212
|
+
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1213
|
+
*/
|
|
1214
|
+
scheduleTbd?: boolean;
|
|
1215
|
+
/**
|
|
1216
|
+
* TBD message.
|
|
1217
|
+
* @maxLength 100
|
|
1218
|
+
*/
|
|
1219
|
+
scheduleTbdMessage?: string | null;
|
|
1220
|
+
/** Event start timestamp. */
|
|
1221
|
+
startDate?: Date | null;
|
|
1222
|
+
/** Event end timestamp. */
|
|
1223
|
+
endDate?: Date | null;
|
|
1224
|
+
/**
|
|
1225
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
1226
|
+
* @maxLength 100
|
|
1227
|
+
*/
|
|
1228
|
+
timeZoneId?: string | null;
|
|
1229
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
1230
|
+
endDateHidden?: boolean;
|
|
1231
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1232
|
+
showTimeZone?: boolean;
|
|
1233
|
+
/** Event recurrences. */
|
|
1234
|
+
recurrences?: Recurrences;
|
|
1235
|
+
}
|
|
1236
|
+
interface Recurrences {
|
|
1237
|
+
/**
|
|
1238
|
+
* Event occurrences.
|
|
1239
|
+
* @maxSize 1000
|
|
1240
|
+
*/
|
|
1241
|
+
occurrences?: Occurrence[];
|
|
1242
|
+
/**
|
|
1243
|
+
* Recurring event category ID.
|
|
1244
|
+
* @readonly
|
|
1245
|
+
*/
|
|
1246
|
+
categoryId?: string | null;
|
|
1247
|
+
/**
|
|
1248
|
+
* Recurrence status.
|
|
1249
|
+
* @readonly
|
|
1250
|
+
*/
|
|
1251
|
+
status?: StatusWithLiterals;
|
|
1252
|
+
}
|
|
1253
|
+
interface Occurrence {
|
|
1254
|
+
/** Event start timestamp. */
|
|
1255
|
+
startDate?: Date | null;
|
|
1256
|
+
/** Event end timestamp. */
|
|
1257
|
+
endDate?: Date | null;
|
|
1258
|
+
/**
|
|
1259
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
1260
|
+
* @maxLength 100
|
|
1261
|
+
*/
|
|
1262
|
+
timeZoneId?: string | null;
|
|
1263
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1264
|
+
showTimeZone?: boolean;
|
|
1265
|
+
}
|
|
1266
|
+
declare enum Status {
|
|
1267
|
+
/** Event occurs only once. */
|
|
1268
|
+
ONE_TIME = "ONE_TIME",
|
|
1269
|
+
/** Event is recurring. */
|
|
1270
|
+
RECURRING = "RECURRING",
|
|
1271
|
+
/** Marks the next upcoming occurrence of the recurring event. */
|
|
1272
|
+
RECURRING_NEXT = "RECURRING_NEXT",
|
|
1273
|
+
/** Marks the most recent ended occurrence of the recurring event. */
|
|
1274
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
1275
|
+
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1276
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1277
|
+
}
|
|
1278
|
+
/** @enumType */
|
|
1279
|
+
type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
1280
|
+
declare enum EventStatus {
|
|
1281
|
+
/** Event is public and scheduled to start */
|
|
1282
|
+
SCHEDULED = "SCHEDULED",
|
|
1283
|
+
/** Event has started */
|
|
1284
|
+
STARTED = "STARTED",
|
|
1285
|
+
/** Event has ended */
|
|
1286
|
+
ENDED = "ENDED",
|
|
1287
|
+
/** Event was canceled */
|
|
1288
|
+
CANCELED = "CANCELED"
|
|
1289
|
+
}
|
|
1290
|
+
/** @enumType */
|
|
1291
|
+
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
4118
1292
|
interface MessageEnvelope {
|
|
4119
1293
|
/**
|
|
4120
1294
|
* App instance ID.
|
|
@@ -4258,6 +1432,8 @@ declare function onNotificationConfigCreated(handler: (event: NotificationConfig
|
|
|
4258
1432
|
interface NotificationConfigUpdatedEnvelope {
|
|
4259
1433
|
entity: NotificationConfig;
|
|
4260
1434
|
metadata: EventMetadata;
|
|
1435
|
+
/** @hidden */
|
|
1436
|
+
modifiedFields: Record<string, any>;
|
|
4261
1437
|
}
|
|
4262
1438
|
/** @permissionScope Read Events - all read permissions
|
|
4263
1439
|
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
@@ -4386,4 +1562,4 @@ interface UpsertNotificationConfig {
|
|
|
4386
1562
|
orderConfirmationWithTicketsLink?: EmailNotificationConfig;
|
|
4387
1563
|
}
|
|
4388
1564
|
|
|
4389
|
-
export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type
|
|
1565
|
+
export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type BaseEventMetadata, type CheckIn, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonStreetAddress, type CommonSubdivision, type CouponDiscount, type Discount, type DiscountItem, type DiscountItemDiscountOneOf, type DomainEvent, type DomainEventBodyOneOf, type EmailNotificationConfig, EmailNotificationReminderTime, type EmailNotificationReminderTimeWithLiterals, EmailNotificationType, type EmailNotificationTypeWithLiterals, type EmailTemplate, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventCanceled, type EventCopied, type EventDeleted, type EventGuests, type EventMetadata, EventStatus, type EventStatusWithLiterals, type Fee, FeeName, type FeeNameWithLiterals, FeeType, type FeeTypeWithLiterals, type FormResponse, type FormattedAddress, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type Invoice, type Item, type Link, type Location, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MessageEnvelope, type Money, type NotificationConfig, type NotificationConfigCreatedEnvelope, type NotificationConfigUpdatedEnvelope, type Occurrence, type OnlineConferencingLogin, type OrderCanceled, type OrderConfirmed, type OrderEmailAdded, type OrderGuest, type OrderPaid, OrderStatus, type OrderStatusWithLiterals, type PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf, type PercentDiscount, PushNotificationType, type PushNotificationTypeWithLiterals, type Recurrences, type ResolveEmailNotificationConfigRequest, type ResolveEmailNotificationConfigResponse, type ResolveNotificationConfigRequest, type ResolveNotificationConfigResponse, type RestoreInfo, type RsvpGuest, type ScheduleConfig, type StandardDetails, Status, type StatusWithLiterals, type StreetAddress, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Tax, TaxType, type TaxTypeWithLiterals, type Ticket, type TicketGuest, type TicketPdfResolveDelayed, type TicketPdfResolved, type TriggerNotificationOptions, type TriggerNotificationOptionsGuestsOneOf, type TriggerNotificationOptionsNotificationOneOf, type TriggerNotificationRequest, type TriggerNotificationRequestGuestsOneOf, type TriggerNotificationRequestNotificationOneOf, type TriggerNotificationResponse, type UpsertNotificationConfig, type UpsertNotificationConfigRequest, type UpsertNotificationConfigResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, onNotificationConfigCreated, onNotificationConfigUpdated, resolveNotificationConfig, triggerNotification, upsertNotificationConfig };
|