@wix/events 1.0.283 → 1.0.285
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/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +1930 -1901
- package/type-bundles/index.bundle.d.ts +1930 -1901
|
@@ -689,7 +689,11 @@ declare enum OrderStatus$3 {
|
|
|
689
689
|
/** Order was canceled */
|
|
690
690
|
CANCELED = "CANCELED",
|
|
691
691
|
/** Order payment was declined */
|
|
692
|
-
DECLINED = "DECLINED"
|
|
692
|
+
DECLINED = "DECLINED",
|
|
693
|
+
/** Order payment was authorized */
|
|
694
|
+
AUTHORIZED = "AUTHORIZED",
|
|
695
|
+
/** Order payment was voided */
|
|
696
|
+
VOIDED = "VOIDED"
|
|
693
697
|
}
|
|
694
698
|
interface Ticket$3 {
|
|
695
699
|
/** Unique issued ticket number. */
|
|
@@ -1403,2221 +1407,2205 @@ declare enum EmailNotificationReminderTime {
|
|
|
1403
1407
|
/** 30 minutes prior */
|
|
1404
1408
|
BEFORE_30_MINUTES = "BEFORE_30_MINUTES"
|
|
1405
1409
|
}
|
|
1406
|
-
interface
|
|
1407
|
-
/**
|
|
1408
|
-
|
|
1409
|
-
/**
|
|
1410
|
-
|
|
1410
|
+
interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {
|
|
1411
|
+
/** Email notification type */
|
|
1412
|
+
emailNotificationType?: EmailNotificationType;
|
|
1413
|
+
/** Push notification type */
|
|
1414
|
+
pushNotificationType?: PushNotificationType;
|
|
1415
|
+
/** Rsvp guest info */
|
|
1416
|
+
rsvpGuest?: RsvpGuest;
|
|
1417
|
+
/** Order guest info */
|
|
1418
|
+
orderGuest?: OrderGuest;
|
|
1419
|
+
/** Event guests info */
|
|
1420
|
+
eventGuests?: EventGuests;
|
|
1421
|
+
/** Ticket guests info */
|
|
1422
|
+
ticketGuest?: TicketGuest;
|
|
1411
1423
|
}
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
* Automation ID.
|
|
1419
|
-
* @readonly
|
|
1420
|
-
*/
|
|
1421
|
-
_id?: string | null;
|
|
1422
|
-
/**
|
|
1423
|
-
* Revision number, which increments by 1 each time the automation is updated.
|
|
1424
|
-
* To prevent conflicting changes,
|
|
1425
|
-
* the current revision must be passed when updating the automation.
|
|
1426
|
-
*
|
|
1427
|
-
* Ignored when creating an automation.
|
|
1428
|
-
* @readonly
|
|
1429
|
-
*/
|
|
1430
|
-
revision?: string | null;
|
|
1431
|
-
/**
|
|
1432
|
-
* Information about the creator of the automation.
|
|
1433
|
-
* @readonly
|
|
1434
|
-
*/
|
|
1435
|
-
createdBy?: AuditInfo;
|
|
1436
|
-
/**
|
|
1437
|
-
* Date and time the automation was created.
|
|
1438
|
-
* @readonly
|
|
1439
|
-
*/
|
|
1440
|
-
_createdDate?: Date;
|
|
1441
|
-
/**
|
|
1442
|
-
* The entity that last updated the automation.
|
|
1443
|
-
* @readonly
|
|
1444
|
-
*/
|
|
1445
|
-
updatedBy?: AuditInfo;
|
|
1446
|
-
/**
|
|
1447
|
-
* Date and time the automation was last updated.
|
|
1448
|
-
* @readonly
|
|
1449
|
-
*/
|
|
1450
|
-
_updatedDate?: Date;
|
|
1451
|
-
/** Automation name that is displayed on the user's site. */
|
|
1452
|
-
name?: string;
|
|
1453
|
-
/** Automation description. */
|
|
1454
|
-
description?: string | null;
|
|
1455
|
-
/** Object that defines the automation's trigger, actions, and activation status. */
|
|
1456
|
-
configuration?: AutomationConfiguration;
|
|
1457
|
-
/** Defines how the automation was added to the site. */
|
|
1458
|
-
origin?: Origin;
|
|
1459
|
-
/** Automation settings. */
|
|
1460
|
-
settings?: AutomationSettings;
|
|
1461
|
-
/**
|
|
1462
|
-
* Draft info (optional - only if the automation is a draft)
|
|
1463
|
-
* @readonly
|
|
1464
|
-
*/
|
|
1465
|
-
draftInfo?: DraftInfo;
|
|
1466
|
-
/** Namespace */
|
|
1467
|
-
namespace?: string | null;
|
|
1424
|
+
/** @oneof */
|
|
1425
|
+
interface TriggerNotificationRequestNotificationOneOf {
|
|
1426
|
+
/** Email notification type */
|
|
1427
|
+
emailNotificationType?: EmailNotificationType;
|
|
1428
|
+
/** Push notification type */
|
|
1429
|
+
pushNotificationType?: PushNotificationType;
|
|
1468
1430
|
}
|
|
1469
1431
|
/** @oneof */
|
|
1470
|
-
interface
|
|
1471
|
-
/**
|
|
1472
|
-
|
|
1473
|
-
/**
|
|
1474
|
-
|
|
1432
|
+
interface TriggerNotificationRequestGuestsOneOf {
|
|
1433
|
+
/** Rsvp guest info */
|
|
1434
|
+
rsvpGuest?: RsvpGuest;
|
|
1435
|
+
/** Order guest info */
|
|
1436
|
+
orderGuest?: OrderGuest;
|
|
1437
|
+
/** Event guests info */
|
|
1438
|
+
eventGuests?: EventGuests;
|
|
1439
|
+
/** Ticket guests info */
|
|
1440
|
+
ticketGuest?: TicketGuest;
|
|
1475
1441
|
}
|
|
1476
|
-
|
|
1477
|
-
/**
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
/** Whether the option to add a delay is disabled for the automation. */
|
|
1488
|
-
disableDelayAddition?: boolean;
|
|
1489
|
-
/** Whether the option to add a condition is disabled for the automation. */
|
|
1490
|
-
disableConditionAddition?: boolean;
|
|
1442
|
+
declare enum PushNotificationType {
|
|
1443
|
+
/** This is default value. This value is unused. */
|
|
1444
|
+
UNKNOWN_PUSH_TYPE = "UNKNOWN_PUSH_TYPE",
|
|
1445
|
+
/** Triggered when event is updated. */
|
|
1446
|
+
PUSH_EVENT_UPDATED = "PUSH_EVENT_UPDATED",
|
|
1447
|
+
/** Triggered when event is canceled. */
|
|
1448
|
+
PUSH_EVENT_CANCELATION = "PUSH_EVENT_CANCELATION",
|
|
1449
|
+
/** Triggered before the event start time. */
|
|
1450
|
+
PUSH_UPCOMING_EVENT_REMINDER = "PUSH_UPCOMING_EVENT_REMINDER",
|
|
1451
|
+
/** Triggered when event is created. */
|
|
1452
|
+
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
1491
1453
|
}
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1454
|
+
/** Single guest associated to the RSVP */
|
|
1455
|
+
interface RsvpGuest {
|
|
1456
|
+
/** Event id */
|
|
1457
|
+
eventId?: string;
|
|
1458
|
+
/** Rsvp id */
|
|
1459
|
+
rsvpId?: string;
|
|
1497
1460
|
}
|
|
1498
|
-
/**
|
|
1499
|
-
interface
|
|
1500
|
-
/**
|
|
1501
|
-
|
|
1502
|
-
/**
|
|
1503
|
-
|
|
1461
|
+
/** Single guest associated to the Order */
|
|
1462
|
+
interface OrderGuest {
|
|
1463
|
+
/** Event id */
|
|
1464
|
+
eventId?: string;
|
|
1465
|
+
/** Order number */
|
|
1466
|
+
orderNumber?: string;
|
|
1504
1467
|
}
|
|
1505
|
-
/**
|
|
1506
|
-
interface
|
|
1507
|
-
/**
|
|
1508
|
-
|
|
1509
|
-
/** Automation trigger configuration. */
|
|
1510
|
-
trigger?: Trigger;
|
|
1511
|
-
/** List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel. */
|
|
1512
|
-
rootActionIds?: string[];
|
|
1513
|
-
/**
|
|
1514
|
-
* Map of all actions that the automation may execute.
|
|
1515
|
-
* The key is the action ID, and the value is the action configuration.
|
|
1516
|
-
*/
|
|
1517
|
-
actions?: Record<string, Action$1>;
|
|
1468
|
+
/** All event guest from RSVPs and Orders */
|
|
1469
|
+
interface EventGuests {
|
|
1470
|
+
/** Event id */
|
|
1471
|
+
eventId?: string;
|
|
1518
1472
|
}
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1473
|
+
/** Multiple guests associated to Tickets */
|
|
1474
|
+
interface TicketGuest {
|
|
1475
|
+
/** Event id */
|
|
1476
|
+
eventId?: string;
|
|
1477
|
+
/** Order number */
|
|
1478
|
+
orderNumber?: string | null;
|
|
1479
|
+
/** Ticket numbers must be from the same order only. */
|
|
1480
|
+
ticketNumber?: string[];
|
|
1526
1481
|
}
|
|
1527
|
-
interface
|
|
1528
|
-
/** Filter ID. */
|
|
1529
|
-
_id?: string;
|
|
1530
|
-
/** Field key from the payload schema, for example "formId". */
|
|
1531
|
-
fieldKey?: string;
|
|
1532
|
-
/** Filter expression that evaluates to a boolean. */
|
|
1533
|
-
filterExpression?: string;
|
|
1482
|
+
interface TriggerNotificationResponse {
|
|
1534
1483
|
}
|
|
1535
|
-
interface
|
|
1536
|
-
/**
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1484
|
+
interface RsvpCreated$1 {
|
|
1485
|
+
/** RSVP created timestamp in ISO UTC format. */
|
|
1486
|
+
timestamp?: Date;
|
|
1487
|
+
/** Site language when RSVP created */
|
|
1488
|
+
language?: string | null;
|
|
1489
|
+
/** Notifications silenced for this domain event. */
|
|
1490
|
+
silent?: boolean | null;
|
|
1491
|
+
/** Event ID. */
|
|
1492
|
+
eventId?: string;
|
|
1493
|
+
/** RSVP ID. */
|
|
1494
|
+
rsvpId?: string;
|
|
1495
|
+
/** Contact ID associated with this RSVP. */
|
|
1496
|
+
contactId?: string;
|
|
1497
|
+
/** Member ID associated with this RSVP. */
|
|
1498
|
+
memberId?: string | null;
|
|
1499
|
+
/** Guest first name. */
|
|
1500
|
+
firstName?: string;
|
|
1501
|
+
/** Guest last name. */
|
|
1502
|
+
lastName?: string;
|
|
1503
|
+
/** Guest email. */
|
|
1504
|
+
email?: string;
|
|
1505
|
+
/** RSVP form response. */
|
|
1506
|
+
rsvpForm?: FormResponse$4;
|
|
1507
|
+
/** RSVP response status. */
|
|
1508
|
+
status?: RsvpStatus$2;
|
|
1509
|
+
/** List of all guests. */
|
|
1510
|
+
guests?: Guest$3[];
|
|
1511
|
+
/** URL and password to online conference */
|
|
1512
|
+
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
1543
1513
|
}
|
|
1544
|
-
interface
|
|
1545
|
-
|
|
1546
|
-
maxActivationsExpression?: string;
|
|
1547
|
-
/** Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent. */
|
|
1548
|
-
durationExpression?: string | null;
|
|
1549
|
-
/** Time unit for the rate limit duration. */
|
|
1550
|
-
durationTimeUnit?: TimeUnit;
|
|
1551
|
-
/** Unique identifier of each activation, by which rate limiter will count activations. */
|
|
1552
|
-
uniqueIdentifierExpression?: string | null;
|
|
1514
|
+
interface FormResponse$4 {
|
|
1515
|
+
inputValues?: InputValue$4[];
|
|
1553
1516
|
}
|
|
1554
|
-
interface
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
booleanExpressions?: string[];
|
|
1517
|
+
interface InputValue$4 {
|
|
1518
|
+
inputName?: string;
|
|
1519
|
+
value?: string;
|
|
1520
|
+
values?: string[];
|
|
1559
1521
|
}
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1522
|
+
interface FormattedAddress$4 {
|
|
1523
|
+
/** One line address representation. */
|
|
1524
|
+
formatted?: string;
|
|
1525
|
+
/** Address components (optional). */
|
|
1526
|
+
address?: CommonAddress$2;
|
|
1564
1527
|
}
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
appId?: string;
|
|
1582
|
-
/** Action key. */
|
|
1583
|
-
actionKey?: string;
|
|
1584
|
-
/** Action input mapping. */
|
|
1585
|
-
inputMapping?: Record<string, any> | null;
|
|
1586
|
-
/**
|
|
1587
|
-
* Array of conditions determining whether to skip the action in the automation flow.
|
|
1588
|
-
* The action will be skipped if any of the expression groups evaluate to `true`.
|
|
1589
|
-
* Actions following a skipped action will still run.
|
|
1590
|
-
*/
|
|
1591
|
-
skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
|
|
1592
|
-
/** List of IDs of actions to run in parallel once the action completes. */
|
|
1593
|
-
postActionIds?: string[];
|
|
1594
|
-
}
|
|
1595
|
-
interface ConditionAction {
|
|
1596
|
-
/** The condition evaluates to `true` if either of the expression groups evaluate to `true`. */
|
|
1597
|
-
orExpressionGroups?: ConditionExpressionGroup[];
|
|
1598
|
-
/** List of IDs of actions to run when the entire condition is evaluated to `true`. */
|
|
1599
|
-
truePostActionIds?: string[];
|
|
1600
|
-
/** List of IDs of actions to run when the entire condition is evaluated to `false`. */
|
|
1601
|
-
falsePostActionIds?: string[];
|
|
1528
|
+
/** Physical address */
|
|
1529
|
+
interface CommonAddress$2 extends CommonAddressStreetOneOf$2 {
|
|
1530
|
+
/** Street name and number. */
|
|
1531
|
+
streetAddress?: CommonStreetAddress$2;
|
|
1532
|
+
/** Main address line, usually street and number as free text. */
|
|
1533
|
+
addressLine1?: string | null;
|
|
1534
|
+
/** Country code. */
|
|
1535
|
+
country?: string | null;
|
|
1536
|
+
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
1537
|
+
subdivision?: string | null;
|
|
1538
|
+
/** City name. */
|
|
1539
|
+
city?: string | null;
|
|
1540
|
+
/** Zip/postal code. */
|
|
1541
|
+
postalCode?: string | null;
|
|
1542
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
|
|
1543
|
+
addressLine2?: string | null;
|
|
1602
1544
|
}
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
* The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
|
|
1610
|
-
* If an offset is defined, it's calculated from this date.
|
|
1611
|
-
* The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
|
|
1612
|
-
*/
|
|
1613
|
-
dueDateEpochExpression?: string | null;
|
|
1614
|
-
/** List of IDs of actions to run in parallel after the delay. */
|
|
1615
|
-
postActionIds?: string[];
|
|
1545
|
+
/** @oneof */
|
|
1546
|
+
interface CommonAddressStreetOneOf$2 {
|
|
1547
|
+
/** Street name and number. */
|
|
1548
|
+
streetAddress?: CommonStreetAddress$2;
|
|
1549
|
+
/** Main address line, usually street and number as free text. */
|
|
1550
|
+
addressLine?: string | null;
|
|
1616
1551
|
}
|
|
1617
|
-
interface
|
|
1618
|
-
/**
|
|
1619
|
-
|
|
1620
|
-
/**
|
|
1621
|
-
|
|
1622
|
-
* If no value is set, then there is no time limit on the rate limiter.
|
|
1623
|
-
*/
|
|
1624
|
-
rateLimitDurationExpression?: string | null;
|
|
1625
|
-
/** Time unit for the rate limit duration. */
|
|
1626
|
-
rateLimitDurationTimeUnit?: TimeUnit;
|
|
1627
|
-
/** Unique identifier of each activation by which rate limiter counts activations. */
|
|
1628
|
-
uniqueIdentifierExpression?: string | null;
|
|
1629
|
-
/** List of IDs of actions to run in parallel once the action completes. */
|
|
1630
|
-
postActionIds?: string[];
|
|
1552
|
+
interface CommonStreetAddress$2 {
|
|
1553
|
+
/** Street number. */
|
|
1554
|
+
number?: string;
|
|
1555
|
+
/** Street name. */
|
|
1556
|
+
name?: string;
|
|
1631
1557
|
}
|
|
1632
|
-
interface
|
|
1633
|
-
/**
|
|
1634
|
-
|
|
1558
|
+
interface CommonAddressLocation$2 {
|
|
1559
|
+
/** Address latitude. */
|
|
1560
|
+
latitude?: number | null;
|
|
1561
|
+
/** Address longitude. */
|
|
1562
|
+
longitude?: number | null;
|
|
1635
1563
|
}
|
|
1636
|
-
|
|
1637
|
-
/**
|
|
1638
|
-
|
|
1639
|
-
/**
|
|
1640
|
-
|
|
1641
|
-
/** Automation will not be triggered */
|
|
1642
|
-
INACTIVE = "INACTIVE"
|
|
1564
|
+
interface CommonSubdivision$2 {
|
|
1565
|
+
/** Short subdivision code. */
|
|
1566
|
+
code?: string;
|
|
1567
|
+
/** Subdivision full name. */
|
|
1568
|
+
name?: string;
|
|
1643
1569
|
}
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
/**
|
|
1655
|
-
|
|
1656
|
-
/**
|
|
1657
|
-
|
|
1658
|
-
automationConfigMapping?: Record<string, any> | null;
|
|
1570
|
+
declare enum SubdivisionType$9 {
|
|
1571
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
1572
|
+
/** State */
|
|
1573
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
1574
|
+
/** County */
|
|
1575
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
1576
|
+
/** City/town */
|
|
1577
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
1578
|
+
/** Neighborhood/quarter */
|
|
1579
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
1580
|
+
/** Street/block */
|
|
1581
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
1582
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
1583
|
+
COUNTRY = "COUNTRY"
|
|
1659
1584
|
}
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
conditionInfo?: ConditionAction;
|
|
1665
|
-
/** Delay action. */
|
|
1666
|
-
delayInfo?: DelayAction;
|
|
1667
|
-
/** Rate-limiting action. */
|
|
1668
|
-
rateLimitInfo?: RateLimitAction;
|
|
1669
|
-
/** Action ID. If not specified, a new ID is generated. */
|
|
1670
|
-
_id?: string | null;
|
|
1671
|
-
/** Action type. */
|
|
1672
|
-
type?: Type$5;
|
|
1673
|
-
/**
|
|
1674
|
-
* Human-readable name to differentiate the action from other actions of the same type.
|
|
1675
|
-
* The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
|
|
1676
|
-
* generated automatically.
|
|
1677
|
-
* If the action has output, the output will be available in the payload under this name.
|
|
1678
|
-
* If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
|
|
1679
|
-
*/
|
|
1680
|
-
namespace?: string | null;
|
|
1585
|
+
/** Subdivision Concordance values */
|
|
1586
|
+
interface StandardDetails$4 {
|
|
1587
|
+
/** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */
|
|
1588
|
+
iso31662?: string | null;
|
|
1681
1589
|
}
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
/** Condition action. */
|
|
1687
|
-
conditionInfo?: ConditionAction;
|
|
1688
|
-
/** Delay action. */
|
|
1689
|
-
delayInfo?: DelayAction;
|
|
1690
|
-
/** Rate-limiting action. */
|
|
1691
|
-
rateLimitInfo?: RateLimitAction;
|
|
1590
|
+
declare enum RsvpStatus$2 {
|
|
1591
|
+
YES = "YES",
|
|
1592
|
+
NO = "NO",
|
|
1593
|
+
WAITING = "WAITING"
|
|
1692
1594
|
}
|
|
1693
|
-
|
|
1694
|
-
/**
|
|
1695
|
-
|
|
1696
|
-
/**
|
|
1697
|
-
|
|
1698
|
-
/**
|
|
1699
|
-
|
|
1700
|
-
/**
|
|
1701
|
-
|
|
1595
|
+
interface Guest$3 {
|
|
1596
|
+
/** Index in the RSVP guest list. */
|
|
1597
|
+
index?: number;
|
|
1598
|
+
/** Guest full name. */
|
|
1599
|
+
fullName?: string;
|
|
1600
|
+
/** Guest check-in. */
|
|
1601
|
+
checkIn?: CheckIn$3;
|
|
1602
|
+
/** Unique guest ID per RSVP. */
|
|
1603
|
+
_id?: number;
|
|
1702
1604
|
}
|
|
1703
|
-
interface
|
|
1704
|
-
/**
|
|
1705
|
-
|
|
1605
|
+
interface CheckIn$3 {
|
|
1606
|
+
/** Time of check-in */
|
|
1607
|
+
created?: Date;
|
|
1706
1608
|
}
|
|
1707
|
-
interface
|
|
1708
|
-
/** ID of the app that defines the preinstalled automation. */
|
|
1709
|
-
appId?: string;
|
|
1710
|
-
/** Application component ID. */
|
|
1711
|
-
componentId?: string;
|
|
1712
|
-
/** Application component version. */
|
|
1713
|
-
componentVersion?: number;
|
|
1609
|
+
interface OnlineConferencingLogin$4 {
|
|
1714
1610
|
/**
|
|
1715
|
-
*
|
|
1716
|
-
* automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
|
|
1717
|
-
* preinstalled automation is used.
|
|
1718
|
-
*
|
|
1719
|
-
* Default: `false`
|
|
1611
|
+
* Link URL to the online conference.
|
|
1720
1612
|
* @readonly
|
|
1721
1613
|
*/
|
|
1722
|
-
|
|
1723
|
-
}
|
|
1724
|
-
interface AutomationSettings {
|
|
1725
|
-
/**
|
|
1726
|
-
* Whether the automation is hidden from users.
|
|
1727
|
-
* Default: `false`
|
|
1728
|
-
*/
|
|
1729
|
-
hidden?: boolean;
|
|
1730
|
-
/**
|
|
1731
|
-
* Whether the automation is read-only.
|
|
1732
|
-
* Default: `false`
|
|
1733
|
-
*/
|
|
1734
|
-
readonly?: boolean;
|
|
1735
|
-
/**
|
|
1736
|
-
* Whether the option to delete the automation from the site is disabled.
|
|
1737
|
-
* Default: `false`
|
|
1738
|
-
*/
|
|
1739
|
-
disableDelete?: boolean;
|
|
1740
|
-
/**
|
|
1741
|
-
* Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
|
|
1742
|
-
* Default: `false`
|
|
1743
|
-
*/
|
|
1744
|
-
disableStatusChange?: boolean;
|
|
1745
|
-
/** Automation action settings. */
|
|
1746
|
-
actionSettings?: ActionSettings;
|
|
1747
|
-
}
|
|
1748
|
-
interface DraftInfo {
|
|
1614
|
+
link?: string;
|
|
1749
1615
|
/**
|
|
1750
|
-
*
|
|
1616
|
+
* Password for the online conference.
|
|
1751
1617
|
* @readonly
|
|
1752
1618
|
*/
|
|
1753
|
-
|
|
1619
|
+
password?: string | null;
|
|
1754
1620
|
}
|
|
1755
|
-
interface
|
|
1756
|
-
/** Deleted automation */
|
|
1757
|
-
automation?: Automation;
|
|
1621
|
+
interface Empty$5 {
|
|
1758
1622
|
}
|
|
1759
|
-
interface
|
|
1760
|
-
/**
|
|
1761
|
-
|
|
1762
|
-
/**
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
/** Guest ID. */
|
|
1767
|
-
_id?: string | null;
|
|
1623
|
+
interface RsvpUpdated$1 {
|
|
1624
|
+
/** RSVP updated timestamp in ISO UTC format. */
|
|
1625
|
+
timestamp?: Date;
|
|
1626
|
+
/** Site language when RSVP created */
|
|
1627
|
+
language?: string | null;
|
|
1628
|
+
/** Locale in which Rsvp was created. */
|
|
1629
|
+
locale?: string | null;
|
|
1768
1630
|
/** Event ID. */
|
|
1769
|
-
eventId?: string
|
|
1770
|
-
/** RSVP ID.
|
|
1771
|
-
rsvpId?: string
|
|
1772
|
-
/**
|
|
1773
|
-
|
|
1774
|
-
/**
|
|
1775
|
-
ticketNumber?: string | null;
|
|
1776
|
-
/** List of names, numbers, and definition IDs for each ticket. */
|
|
1777
|
-
tickets?: TicketDetails$2[];
|
|
1778
|
-
/** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
|
|
1779
|
-
contactId?: string | null;
|
|
1780
|
-
/** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
|
|
1781
|
-
guestDetails?: GuestDetails$2;
|
|
1782
|
-
/** Attendance status. The attendaces status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
|
|
1783
|
-
attendanceStatus?: AttendanceStatus;
|
|
1784
|
-
/** Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. */
|
|
1785
|
-
secondaryLanguageCode?: string | null;
|
|
1786
|
-
/** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
1787
|
-
_createdDate?: Date;
|
|
1788
|
-
/** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
1789
|
-
_updatedDate?: Date;
|
|
1790
|
-
/** Date and time of guest's latest attendance status update. */
|
|
1791
|
-
attendanceStatusUpdatedDate?: Date;
|
|
1792
|
-
/** Site member ID. */
|
|
1631
|
+
eventId?: string;
|
|
1632
|
+
/** RSVP ID. */
|
|
1633
|
+
rsvpId?: string;
|
|
1634
|
+
/** Contact ID associated with this RSVP. */
|
|
1635
|
+
contactId?: string;
|
|
1636
|
+
/** Member ID associated with this RSVP. */
|
|
1793
1637
|
memberId?: string | null;
|
|
1794
|
-
/**
|
|
1795
|
-
|
|
1796
|
-
/**
|
|
1797
|
-
|
|
1798
|
-
/**
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1638
|
+
/** RSVP created timestamp. */
|
|
1639
|
+
created?: Date;
|
|
1640
|
+
/** Guest first name. */
|
|
1641
|
+
firstName?: string;
|
|
1642
|
+
/** Guest last name. */
|
|
1643
|
+
lastName?: string;
|
|
1644
|
+
/** Guest email. */
|
|
1645
|
+
email?: string;
|
|
1646
|
+
/** RSVP form response. */
|
|
1647
|
+
rsvpForm?: FormResponse$4;
|
|
1648
|
+
/** RSVP response status. */
|
|
1649
|
+
status?: RsvpStatus$2;
|
|
1650
|
+
/** List of the guests. */
|
|
1651
|
+
guests?: Guest$3[];
|
|
1652
|
+
/** URL and password to online conference */
|
|
1653
|
+
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
1654
|
+
/** Notifications silenced for this domain event. */
|
|
1655
|
+
silent?: boolean | null;
|
|
1656
|
+
}
|
|
1657
|
+
interface EventUpdated$3 {
|
|
1658
|
+
/** Event update timestamp in ISO UTC format. */
|
|
1659
|
+
timestamp?: Date;
|
|
1660
|
+
/** Event ID. */
|
|
1661
|
+
eventId?: string;
|
|
1662
|
+
/** Event location. */
|
|
1663
|
+
location?: Location$6;
|
|
1664
|
+
/** Event schedule configuration. */
|
|
1665
|
+
scheduleConfig?: ScheduleConfig$6;
|
|
1666
|
+
/** Event title. */
|
|
1667
|
+
title?: string;
|
|
1803
1668
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
* @
|
|
1669
|
+
* Whether schedule configuration was updated.
|
|
1670
|
+
* @deprecated
|
|
1806
1671
|
*/
|
|
1807
|
-
|
|
1672
|
+
scheduleConfigUpdated?: boolean;
|
|
1673
|
+
/** Updated event */
|
|
1674
|
+
event?: Event$4;
|
|
1808
1675
|
}
|
|
1809
|
-
interface
|
|
1810
|
-
/**
|
|
1811
|
-
number?: string;
|
|
1812
|
-
/** Ticket definition ID. */
|
|
1813
|
-
definitionId?: string | null;
|
|
1814
|
-
/** Ticket name. */
|
|
1676
|
+
interface Location$6 {
|
|
1677
|
+
/** Location name. */
|
|
1815
1678
|
name?: string | null;
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
/**
|
|
1819
|
-
|
|
1820
|
-
/**
|
|
1821
|
-
|
|
1822
|
-
/** Last name. */
|
|
1823
|
-
lastName?: string | null;
|
|
1824
|
-
}
|
|
1825
|
-
interface OnlineConferencingLogin$4 {
|
|
1679
|
+
/** Location map coordinates. */
|
|
1680
|
+
coordinates?: MapCoordinates$6;
|
|
1681
|
+
/** Single line address representation. */
|
|
1682
|
+
address?: string | null;
|
|
1683
|
+
/** Location type. */
|
|
1684
|
+
type?: LocationType$6;
|
|
1826
1685
|
/**
|
|
1827
|
-
*
|
|
1828
|
-
*
|
|
1686
|
+
* Full address derived from formatted single line `address`.
|
|
1687
|
+
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
1688
|
+
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
1689
|
+
*
|
|
1690
|
+
* Migration notes:
|
|
1691
|
+
* - `full_address.formatted_address` is equivalent to `address`.
|
|
1692
|
+
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
1829
1693
|
*/
|
|
1830
|
-
|
|
1694
|
+
fullAddress?: Address$9;
|
|
1831
1695
|
/**
|
|
1832
|
-
*
|
|
1833
|
-
*
|
|
1696
|
+
* Defines event location as TBD (To Be Determined).
|
|
1697
|
+
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
1698
|
+
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
1834
1699
|
*/
|
|
1835
|
-
|
|
1836
|
-
}
|
|
1837
|
-
interface GuestDetails$2 {
|
|
1838
|
-
/** Email. */
|
|
1839
|
-
email?: string | null;
|
|
1840
|
-
/** First name. */
|
|
1841
|
-
firstName?: string | null;
|
|
1842
|
-
/** Last name. */
|
|
1843
|
-
lastName?: string | null;
|
|
1844
|
-
/** Form response. */
|
|
1845
|
-
formResponse?: FormResponse$4;
|
|
1846
|
-
/** Whether the guest has checked into the event. */
|
|
1847
|
-
checkedIn?: boolean;
|
|
1848
|
-
/** The login details for the guest to access the online conference event. */
|
|
1849
|
-
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
1850
|
-
}
|
|
1851
|
-
interface FormResponse$4 {
|
|
1852
|
-
inputValues?: InputValue$4[];
|
|
1700
|
+
tbd?: boolean | null;
|
|
1853
1701
|
}
|
|
1854
|
-
interface
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1702
|
+
interface MapCoordinates$6 {
|
|
1703
|
+
/** Latitude. */
|
|
1704
|
+
lat?: number;
|
|
1705
|
+
/** Longitude. */
|
|
1706
|
+
lng?: number;
|
|
1858
1707
|
}
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
/** Address components (optional). */
|
|
1863
|
-
address?: CommonAddress$2;
|
|
1708
|
+
declare enum LocationType$6 {
|
|
1709
|
+
VENUE = "VENUE",
|
|
1710
|
+
ONLINE = "ONLINE"
|
|
1864
1711
|
}
|
|
1865
1712
|
/** Physical address */
|
|
1866
|
-
interface
|
|
1867
|
-
/**
|
|
1868
|
-
streetAddress?:
|
|
1869
|
-
/** Main address line
|
|
1713
|
+
interface Address$9 extends AddressStreetOneOf$9 {
|
|
1714
|
+
/** a break down of the street to number and street name */
|
|
1715
|
+
streetAddress?: StreetAddress$9;
|
|
1716
|
+
/** Main address line (usually street and number) as free text */
|
|
1870
1717
|
addressLine1?: string | null;
|
|
1871
|
-
/**
|
|
1718
|
+
/** country code */
|
|
1872
1719
|
country?: string | null;
|
|
1873
|
-
/**
|
|
1720
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
1874
1721
|
subdivision?: string | null;
|
|
1875
|
-
/**
|
|
1722
|
+
/** city name */
|
|
1876
1723
|
city?: string | null;
|
|
1877
|
-
/**
|
|
1724
|
+
/** zip/postal code */
|
|
1878
1725
|
postalCode?: string | null;
|
|
1879
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite,
|
|
1726
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
1880
1727
|
addressLine2?: string | null;
|
|
1728
|
+
/** A string containing the human-readable address of this location */
|
|
1729
|
+
formatted?: string | null;
|
|
1730
|
+
/** coordinates of the physical address */
|
|
1731
|
+
location?: AddressLocation$9;
|
|
1881
1732
|
}
|
|
1882
1733
|
/** @oneof */
|
|
1883
|
-
interface
|
|
1884
|
-
/**
|
|
1885
|
-
streetAddress?:
|
|
1886
|
-
/** Main address line
|
|
1734
|
+
interface AddressStreetOneOf$9 {
|
|
1735
|
+
/** a break down of the street to number and street name */
|
|
1736
|
+
streetAddress?: StreetAddress$9;
|
|
1737
|
+
/** Main address line (usually street and number) as free text */
|
|
1887
1738
|
addressLine?: string | null;
|
|
1888
1739
|
}
|
|
1889
|
-
interface
|
|
1890
|
-
/**
|
|
1740
|
+
interface StreetAddress$9 {
|
|
1741
|
+
/** street number */
|
|
1891
1742
|
number?: string;
|
|
1892
|
-
/**
|
|
1743
|
+
/** street name */
|
|
1893
1744
|
name?: string;
|
|
1894
1745
|
}
|
|
1895
|
-
interface
|
|
1896
|
-
/**
|
|
1746
|
+
interface AddressLocation$9 {
|
|
1747
|
+
/** address latitude coordinates */
|
|
1897
1748
|
latitude?: number | null;
|
|
1898
|
-
/**
|
|
1749
|
+
/** address longitude coordinates */
|
|
1899
1750
|
longitude?: number | null;
|
|
1900
1751
|
}
|
|
1901
|
-
interface
|
|
1902
|
-
/**
|
|
1752
|
+
interface Subdivision$9 {
|
|
1753
|
+
/** subdivision short code */
|
|
1903
1754
|
code?: string;
|
|
1904
|
-
/**
|
|
1755
|
+
/** subdivision full-name */
|
|
1905
1756
|
name?: string;
|
|
1906
1757
|
}
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
/**
|
|
1923
|
-
|
|
1924
|
-
/**
|
|
1925
|
-
|
|
1758
|
+
interface ScheduleConfig$6 {
|
|
1759
|
+
/**
|
|
1760
|
+
* Defines event as TBD (To Be Determined) schedule.
|
|
1761
|
+
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
1762
|
+
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
1763
|
+
*/
|
|
1764
|
+
scheduleTbd?: boolean;
|
|
1765
|
+
/** TBD message. */
|
|
1766
|
+
scheduleTbdMessage?: string | null;
|
|
1767
|
+
/** Event start timestamp. */
|
|
1768
|
+
startDate?: Date;
|
|
1769
|
+
/** Event end timestamp. */
|
|
1770
|
+
endDate?: Date;
|
|
1771
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
1772
|
+
timeZoneId?: string | null;
|
|
1773
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
1774
|
+
endDateHidden?: boolean;
|
|
1775
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1776
|
+
showTimeZone?: boolean;
|
|
1777
|
+
/** Event recurrences. */
|
|
1778
|
+
recurrences?: Recurrences$6;
|
|
1926
1779
|
}
|
|
1927
|
-
|
|
1928
|
-
/**
|
|
1929
|
-
|
|
1930
|
-
/**
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1780
|
+
interface Recurrences$6 {
|
|
1781
|
+
/** Event occurrences. */
|
|
1782
|
+
occurrences?: Occurrence$6[];
|
|
1783
|
+
/**
|
|
1784
|
+
* Recurring event category ID.
|
|
1785
|
+
* @readonly
|
|
1786
|
+
*/
|
|
1787
|
+
categoryId?: string | null;
|
|
1788
|
+
/**
|
|
1789
|
+
* Recurrence status.
|
|
1790
|
+
* @readonly
|
|
1791
|
+
*/
|
|
1792
|
+
status?: RecurrenceStatusStatus$1;
|
|
1934
1793
|
}
|
|
1935
|
-
|
|
1936
|
-
/**
|
|
1794
|
+
interface Occurrence$6 {
|
|
1795
|
+
/** Event start timestamp. */
|
|
1796
|
+
startDate?: Date;
|
|
1797
|
+
/** Event end timestamp. */
|
|
1798
|
+
endDate?: Date;
|
|
1799
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
1800
|
+
timeZoneId?: string | null;
|
|
1801
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
1802
|
+
showTimeZone?: boolean;
|
|
1803
|
+
}
|
|
1804
|
+
declare enum RecurrenceStatusStatus$1 {
|
|
1805
|
+
/** Event occurs only once. */
|
|
1806
|
+
ONE_TIME = "ONE_TIME",
|
|
1807
|
+
/** Event is recurring. */
|
|
1808
|
+
RECURRING = "RECURRING",
|
|
1809
|
+
/** Marks the next upcoming occurrence of the recurring event. */
|
|
1810
|
+
RECURRING_NEXT = "RECURRING_NEXT",
|
|
1811
|
+
/** Marks the most recent ended occurrence of the recurring event. */
|
|
1812
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
1813
|
+
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1814
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1815
|
+
}
|
|
1816
|
+
interface Event$4 {
|
|
1817
|
+
/**
|
|
1818
|
+
* Event ID.
|
|
1819
|
+
* @readonly
|
|
1820
|
+
*/
|
|
1821
|
+
_id?: string;
|
|
1822
|
+
/** Event location. */
|
|
1823
|
+
location?: Location$6;
|
|
1824
|
+
/** Event scheduling. */
|
|
1825
|
+
scheduling?: Scheduling$4;
|
|
1826
|
+
/** Event title. */
|
|
1827
|
+
title?: string;
|
|
1828
|
+
/** Event description. */
|
|
1829
|
+
description?: string;
|
|
1830
|
+
/** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
|
|
1831
|
+
about?: string;
|
|
1832
|
+
/** Main event image. */
|
|
1833
|
+
mainImage?: string;
|
|
1834
|
+
/** Event slug URL (generated from event title). */
|
|
1835
|
+
slug?: string;
|
|
1836
|
+
/** ISO 639-1 language code of the event (used in content translations). */
|
|
1837
|
+
language?: string;
|
|
1838
|
+
/** Event creation timestamp. */
|
|
1839
|
+
created?: Date;
|
|
1840
|
+
/** Event modified timestamp. */
|
|
1841
|
+
modified?: Date;
|
|
1842
|
+
/** Event status. */
|
|
1843
|
+
status?: EventStatus$6;
|
|
1844
|
+
/** RSVP or ticketing registration details. */
|
|
1845
|
+
registration?: Registration$4;
|
|
1846
|
+
/** "Add to calendar" URLs. */
|
|
1847
|
+
calendarLinks?: CalendarLinks$6;
|
|
1848
|
+
/** Event page URL components. */
|
|
1849
|
+
eventPageUrl?: SiteUrl$4;
|
|
1850
|
+
/** Event registration form. */
|
|
1851
|
+
form?: Form$4;
|
|
1852
|
+
/** Event dashboard summary of RSVP / ticket sales. */
|
|
1853
|
+
dashboard?: Dashboard$6;
|
|
1854
|
+
/** Instance ID of the site where event is hosted. */
|
|
1855
|
+
instanceId?: string;
|
|
1856
|
+
/** Guest list configuration. */
|
|
1857
|
+
guestListConfig?: GuestListConfig$4;
|
|
1858
|
+
/** Event creator user ID. */
|
|
1859
|
+
userId?: string;
|
|
1860
|
+
/** Event discussion feed. For internal use. */
|
|
1861
|
+
feed?: Feed$4;
|
|
1862
|
+
/** Online conferencing details. */
|
|
1863
|
+
onlineConferencing?: OnlineConferencing$4;
|
|
1864
|
+
/** SEO settings. */
|
|
1865
|
+
seoSettings?: SeoSettings$4;
|
|
1866
|
+
/** Assigned contacts label key. */
|
|
1867
|
+
assignedContactsLabel?: string | null;
|
|
1868
|
+
/** Agenda details. */
|
|
1869
|
+
agenda?: Agenda$4;
|
|
1870
|
+
/** Categories this event is assigned to. */
|
|
1871
|
+
categories?: Category$5[];
|
|
1872
|
+
/** Visual settings for event. */
|
|
1873
|
+
eventDisplaySettings?: EventDisplaySettings$4;
|
|
1874
|
+
}
|
|
1875
|
+
interface Scheduling$4 {
|
|
1876
|
+
/** Schedule configuration. */
|
|
1877
|
+
config?: ScheduleConfig$6;
|
|
1878
|
+
/** Formatted schedule representation. */
|
|
1879
|
+
formatted?: string;
|
|
1880
|
+
/** Formatted start date of the event (empty for TBD schedules). */
|
|
1881
|
+
startDateFormatted?: string;
|
|
1882
|
+
/** Formatted start time of the event (empty for TBD schedules). */
|
|
1883
|
+
startTimeFormatted?: string;
|
|
1884
|
+
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
1885
|
+
endDateFormatted?: string;
|
|
1886
|
+
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
1887
|
+
endTimeFormatted?: string;
|
|
1888
|
+
}
|
|
1889
|
+
declare enum EventStatus$6 {
|
|
1890
|
+
/** Event is public and scheduled to start */
|
|
1891
|
+
SCHEDULED = "SCHEDULED",
|
|
1892
|
+
/** Event has started */
|
|
1893
|
+
STARTED = "STARTED",
|
|
1894
|
+
/** Event has ended */
|
|
1895
|
+
ENDED = "ENDED",
|
|
1896
|
+
/** Event was canceled */
|
|
1897
|
+
CANCELED = "CANCELED",
|
|
1898
|
+
/** Event is not public and needs to be published */
|
|
1899
|
+
DRAFT = "DRAFT"
|
|
1900
|
+
}
|
|
1901
|
+
interface Registration$4 {
|
|
1902
|
+
/** Event type. */
|
|
1903
|
+
type?: EventType$4;
|
|
1904
|
+
/** Event registration status. */
|
|
1905
|
+
status?: RegistrationStatus$4;
|
|
1906
|
+
/** RSVP collection details. */
|
|
1907
|
+
rsvpCollection?: RsvpCollection$4;
|
|
1908
|
+
/** Ticketing details. */
|
|
1909
|
+
ticketing?: Ticketing$4;
|
|
1910
|
+
/** External registration details. */
|
|
1911
|
+
external?: ExternalEvent$4;
|
|
1912
|
+
/** Types of users allowed to register. */
|
|
1913
|
+
restrictedTo?: VisitorType$4;
|
|
1914
|
+
/** Initial event type which was set when creating an event. */
|
|
1915
|
+
initialType?: EventType$4;
|
|
1916
|
+
}
|
|
1917
|
+
declare enum EventType$4 {
|
|
1918
|
+
/** Type not available for this request fieldset */
|
|
1919
|
+
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
1920
|
+
/** Registration via RSVP */
|
|
1937
1921
|
RSVP = "RSVP",
|
|
1938
|
-
/**
|
|
1939
|
-
|
|
1940
|
-
/**
|
|
1941
|
-
|
|
1922
|
+
/** Registration via ticket purchase */
|
|
1923
|
+
TICKETS = "TICKETS",
|
|
1924
|
+
/** External registration */
|
|
1925
|
+
EXTERNAL = "EXTERNAL",
|
|
1926
|
+
/** Registration not available */
|
|
1927
|
+
NO_REGISTRATION = "NO_REGISTRATION"
|
|
1942
1928
|
}
|
|
1943
|
-
|
|
1944
|
-
/**
|
|
1945
|
-
|
|
1946
|
-
/**
|
|
1947
|
-
|
|
1948
|
-
/**
|
|
1949
|
-
|
|
1929
|
+
declare enum RegistrationStatus$4 {
|
|
1930
|
+
/** Registration status is not applicable */
|
|
1931
|
+
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
1932
|
+
/** Registration to event is closed */
|
|
1933
|
+
CLOSED = "CLOSED",
|
|
1934
|
+
/** Registration to event is closed manually */
|
|
1935
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
1936
|
+
/** Registration is open via RSVP */
|
|
1937
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
1938
|
+
/** Registration to event waitlist is open via RSVP */
|
|
1939
|
+
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
1940
|
+
/** Registration is open via ticket purchase */
|
|
1941
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
1942
|
+
/** Registration is open via external URL */
|
|
1943
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
1944
|
+
/** Registration will be open via RSVP */
|
|
1945
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
1950
1946
|
}
|
|
1951
|
-
interface
|
|
1952
|
-
/**
|
|
1953
|
-
|
|
1954
|
-
/** Member id. */
|
|
1955
|
-
memberId?: string | null;
|
|
1956
|
-
/** Member event status. */
|
|
1957
|
-
status?: MemberEventStatusUpdatedEventType;
|
|
1947
|
+
interface RsvpCollection$4 {
|
|
1948
|
+
/** RSVP collection configuration. */
|
|
1949
|
+
config?: RsvpCollectionConfig$4;
|
|
1958
1950
|
}
|
|
1959
|
-
|
|
1951
|
+
interface RsvpCollectionConfig$4 {
|
|
1952
|
+
/** Defines the supported RSVP statuses. */
|
|
1953
|
+
rsvpStatusOptions?: RsvpStatusOptions$4;
|
|
1960
1954
|
/**
|
|
1961
|
-
*
|
|
1962
|
-
*
|
|
1955
|
+
* Total guest limit available to register to the event.
|
|
1956
|
+
* Additional guests per RSVP are counted towards total guests.
|
|
1963
1957
|
*/
|
|
1964
|
-
|
|
1958
|
+
limit?: number | null;
|
|
1959
|
+
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
1960
|
+
waitlist?: boolean;
|
|
1961
|
+
/** Registration start timestamp. */
|
|
1962
|
+
startDate?: Date;
|
|
1963
|
+
/** Registration end timestamp. */
|
|
1964
|
+
endDate?: Date;
|
|
1965
|
+
}
|
|
1966
|
+
declare enum RsvpStatusOptions$4 {
|
|
1967
|
+
/** Only YES RSVP status is available for RSVP registration */
|
|
1968
|
+
YES_ONLY = "YES_ONLY",
|
|
1969
|
+
/** YES and NO RSVP status options are available for the registration */
|
|
1970
|
+
YES_AND_NO = "YES_AND_NO"
|
|
1971
|
+
}
|
|
1972
|
+
interface Ticketing$4 {
|
|
1965
1973
|
/**
|
|
1966
|
-
*
|
|
1967
|
-
*
|
|
1974
|
+
* Deprecated.
|
|
1975
|
+
* @deprecated
|
|
1968
1976
|
*/
|
|
1969
|
-
|
|
1977
|
+
lowestPrice?: string | null;
|
|
1970
1978
|
/**
|
|
1971
|
-
*
|
|
1972
|
-
*
|
|
1979
|
+
* Deprecated.
|
|
1980
|
+
* @deprecated
|
|
1973
1981
|
*/
|
|
1974
|
-
|
|
1982
|
+
highestPrice?: string | null;
|
|
1983
|
+
/** Currency used in event transactions. */
|
|
1984
|
+
currency?: string | null;
|
|
1985
|
+
/** Ticketing configuration. */
|
|
1986
|
+
config?: TicketingConfig$4;
|
|
1975
1987
|
/**
|
|
1976
|
-
*
|
|
1977
|
-
*
|
|
1978
|
-
* This event can also be fired if existing guest changed their member ID or status to not ATTENDING.
|
|
1988
|
+
* Price of lowest priced ticket.
|
|
1989
|
+
* @readonly
|
|
1979
1990
|
*/
|
|
1980
|
-
|
|
1981
|
-
}
|
|
1982
|
-
interface ContactEventStatusUpdated {
|
|
1983
|
-
/** Event id. */
|
|
1984
|
-
eventId?: string | null;
|
|
1985
|
-
/** Contact id. */
|
|
1986
|
-
contactId?: string | null;
|
|
1987
|
-
/** Contact event status. */
|
|
1988
|
-
status?: ContactEventStatusUpdatedEventType;
|
|
1989
|
-
}
|
|
1990
|
-
declare enum ContactEventStatusUpdatedEventType {
|
|
1991
|
+
lowestTicketPrice?: Money$7;
|
|
1991
1992
|
/**
|
|
1992
|
-
*
|
|
1993
|
-
*
|
|
1993
|
+
* Price of highest priced ticket.
|
|
1994
|
+
* @readonly
|
|
1994
1995
|
*/
|
|
1995
|
-
|
|
1996
|
+
highestTicketPrice?: Money$7;
|
|
1996
1997
|
/**
|
|
1997
|
-
*
|
|
1998
|
-
*
|
|
1998
|
+
* Formatted price of lowest priced ticket.
|
|
1999
|
+
* @readonly
|
|
1999
2000
|
*/
|
|
2000
|
-
|
|
2001
|
+
lowestTicketPriceFormatted?: string | null;
|
|
2001
2002
|
/**
|
|
2002
|
-
*
|
|
2003
|
-
*
|
|
2004
|
-
* This event can also be fired if existing guest changed their contact ID.
|
|
2003
|
+
* Formatted price of highest priced ticket.
|
|
2004
|
+
* @readonly
|
|
2005
2005
|
*/
|
|
2006
|
-
|
|
2007
|
-
}
|
|
2008
|
-
interface NotifyGuestAction {
|
|
2009
|
-
/** Event guest. */
|
|
2010
|
-
guest?: EventGuest;
|
|
2011
|
-
/** Task context. */
|
|
2012
|
-
taskContext?: TaskContext;
|
|
2013
|
-
}
|
|
2014
|
-
interface TaskContext {
|
|
2015
|
-
/** Task id. */
|
|
2016
|
-
_id?: string | null;
|
|
2017
|
-
/** Notify action type */
|
|
2018
|
-
type?: NotifyActionType;
|
|
2019
|
-
}
|
|
2020
|
-
declare enum NotifyActionType {
|
|
2021
|
-
UNKNOWN = "UNKNOWN",
|
|
2022
|
-
EMAIL = "EMAIL",
|
|
2023
|
-
AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
|
|
2024
|
-
PUSH = "PUSH"
|
|
2025
|
-
}
|
|
2026
|
-
interface UnprocessedTargetEvent {
|
|
2027
|
-
/** The target that was not marked as processed */
|
|
2028
|
-
target?: Target$1;
|
|
2029
|
-
}
|
|
2030
|
-
interface Target$1 {
|
|
2031
|
-
/** Unique identifier of the target with pattern `id_tag_value[type]`, for example 'com.wixpress.myproto[wix_proto_bundle_export]`` */
|
|
2032
|
-
_id?: string | null;
|
|
2033
|
-
/** The unique location of the target in Bazel notation i.e @repo//path/to/target:target_name */
|
|
2034
|
-
location?: string | null;
|
|
2035
|
-
/** The combined digest of all files within the target */
|
|
2036
|
-
combinedDigest?: string | null;
|
|
2037
|
-
/** The vcs commit timestamp of the target in milliseconds */
|
|
2038
|
-
commitTimestamp?: string | null;
|
|
2039
|
-
/** The type of the target */
|
|
2040
|
-
type?: TargetType;
|
|
2006
|
+
highestTicketPriceFormatted?: string | null;
|
|
2041
2007
|
/**
|
|
2042
|
-
*
|
|
2043
|
-
*
|
|
2008
|
+
* Whether all tickets are sold for this event.
|
|
2009
|
+
* @readonly
|
|
2044
2010
|
*/
|
|
2045
|
-
|
|
2046
|
-
files?: File$1[];
|
|
2011
|
+
soldOut?: boolean | null;
|
|
2047
2012
|
}
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2013
|
+
interface TicketingConfig$4 {
|
|
2014
|
+
/** Whether the form must be filled out separately for each ticket. */
|
|
2015
|
+
guestAssignedTickets?: boolean;
|
|
2016
|
+
/** Tax configuration. */
|
|
2017
|
+
taxConfig?: TaxConfig$4;
|
|
2018
|
+
/** Limit of tickets that can be purchased per order, default 20. */
|
|
2019
|
+
ticketLimitPerOrder?: number;
|
|
2020
|
+
/** Duration for which the tickets being bought are reserved. */
|
|
2021
|
+
reservationDurationInMinutes?: number | null;
|
|
2053
2022
|
}
|
|
2054
|
-
interface
|
|
2055
|
-
/**
|
|
2023
|
+
interface TaxConfig$4 {
|
|
2024
|
+
/** Tax application settings. */
|
|
2025
|
+
type?: TaxType$5;
|
|
2026
|
+
/** Tax name. */
|
|
2056
2027
|
name?: string | null;
|
|
2057
|
-
/**
|
|
2058
|
-
|
|
2059
|
-
/**
|
|
2060
|
-
|
|
2061
|
-
/** The size of the file in bytes */
|
|
2062
|
-
sizeInBytes?: string | null;
|
|
2028
|
+
/** Tax rate (e.g.,`21.55`). */
|
|
2029
|
+
rate?: string | null;
|
|
2030
|
+
/** Applies taxes for donations, default true. */
|
|
2031
|
+
appliesToDonations?: boolean | null;
|
|
2063
2032
|
}
|
|
2064
|
-
|
|
2065
|
-
/**
|
|
2066
|
-
|
|
2067
|
-
/**
|
|
2068
|
-
|
|
2069
|
-
/**
|
|
2070
|
-
|
|
2071
|
-
/** Order guest info */
|
|
2072
|
-
orderGuest?: OrderGuest;
|
|
2073
|
-
/** Event guests info */
|
|
2074
|
-
eventGuests?: EventGuests;
|
|
2075
|
-
/** Ticket guests info */
|
|
2076
|
-
ticketGuest?: TicketGuest;
|
|
2033
|
+
declare enum TaxType$5 {
|
|
2034
|
+
/** Tax is included in the ticket price. */
|
|
2035
|
+
INCLUDED = "INCLUDED",
|
|
2036
|
+
/** Tax is added to the order at the checkout. */
|
|
2037
|
+
ADDED = "ADDED",
|
|
2038
|
+
/** Tax is added to the final total at the checkout. */
|
|
2039
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
2077
2040
|
}
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2041
|
+
interface Money$7 {
|
|
2042
|
+
/**
|
|
2043
|
+
* *Deprecated:** Use `value` instead.
|
|
2044
|
+
* @deprecated
|
|
2045
|
+
*/
|
|
2046
|
+
amount?: string;
|
|
2047
|
+
/** ISO 4217 format of the currency e.g., `USD`. */
|
|
2048
|
+
currency?: string;
|
|
2049
|
+
/** 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. */
|
|
2050
|
+
value?: string | null;
|
|
2084
2051
|
}
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
rsvpGuest?: RsvpGuest;
|
|
2089
|
-
/** Order guest info */
|
|
2090
|
-
orderGuest?: OrderGuest;
|
|
2091
|
-
/** Event guests info */
|
|
2092
|
-
eventGuests?: EventGuests;
|
|
2093
|
-
/** Ticket guests info */
|
|
2094
|
-
ticketGuest?: TicketGuest;
|
|
2052
|
+
interface ExternalEvent$4 {
|
|
2053
|
+
/** External event registration URL. */
|
|
2054
|
+
registration?: string;
|
|
2095
2055
|
}
|
|
2096
|
-
declare enum
|
|
2097
|
-
/**
|
|
2098
|
-
|
|
2099
|
-
/**
|
|
2100
|
-
|
|
2101
|
-
/**
|
|
2102
|
-
|
|
2103
|
-
/** Triggered before the event start time. */
|
|
2104
|
-
PUSH_UPCOMING_EVENT_REMINDER = "PUSH_UPCOMING_EVENT_REMINDER",
|
|
2105
|
-
/** Triggered when event is created. */
|
|
2106
|
-
PUSH_EVENT_CREATED = "PUSH_EVENT_CREATED"
|
|
2056
|
+
declare enum VisitorType$4 {
|
|
2057
|
+
/** Site visitor (including member) */
|
|
2058
|
+
VISITOR = "VISITOR",
|
|
2059
|
+
/** Site member */
|
|
2060
|
+
MEMBER = "MEMBER",
|
|
2061
|
+
/** Site visitor or member */
|
|
2062
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
2107
2063
|
}
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
rsvpId?: string;
|
|
2064
|
+
interface CalendarLinks$6 {
|
|
2065
|
+
/** "Add to Google calendar" URL. */
|
|
2066
|
+
google?: string;
|
|
2067
|
+
/** "Download ICS calendar file" URL. */
|
|
2068
|
+
ics?: string;
|
|
2114
2069
|
}
|
|
2115
|
-
/**
|
|
2116
|
-
interface
|
|
2117
|
-
/**
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2070
|
+
/** Site URL components */
|
|
2071
|
+
interface SiteUrl$4 {
|
|
2072
|
+
/**
|
|
2073
|
+
* Base URL. For premium sites, this will be the domain.
|
|
2074
|
+
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
2075
|
+
*/
|
|
2076
|
+
base?: string;
|
|
2077
|
+
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
2078
|
+
path?: string;
|
|
2121
2079
|
}
|
|
2122
|
-
/**
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2080
|
+
/**
|
|
2081
|
+
* The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
|
|
2082
|
+
* It also contains customizable messages and labels.
|
|
2083
|
+
*
|
|
2084
|
+
*
|
|
2085
|
+
* A form is an ordered list of controls (blocks), which accept guest information into a field input.
|
|
2086
|
+
*
|
|
2087
|
+
* Each control contains one or more nested inputs. For example, `Name` control has two inputs:
|
|
2088
|
+
* - First Name
|
|
2089
|
+
* - Last Name
|
|
2090
|
+
*
|
|
2091
|
+
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
2092
|
+
*/
|
|
2093
|
+
interface Form$4 {
|
|
2094
|
+
/** Nested fields as an ordered list. */
|
|
2095
|
+
controls?: InputControl$4[];
|
|
2096
|
+
/** Set of configured form messages. */
|
|
2097
|
+
messages?: FormMessages$4;
|
|
2126
2098
|
}
|
|
2127
|
-
/**
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2099
|
+
/**
|
|
2100
|
+
* A block of nested fields.
|
|
2101
|
+
* Used to aggregate similar inputs like First Name and Last Name.
|
|
2102
|
+
*/
|
|
2103
|
+
interface InputControl$4 {
|
|
2104
|
+
/** Field control type. */
|
|
2105
|
+
type?: InputControlType$4;
|
|
2106
|
+
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
2107
|
+
system?: boolean;
|
|
2108
|
+
/**
|
|
2109
|
+
* Deprecated: Use `id`.
|
|
2110
|
+
* @deprecated
|
|
2111
|
+
*/
|
|
2112
|
+
name?: string;
|
|
2113
|
+
/** Child inputs. */
|
|
2114
|
+
inputs?: Input$4[];
|
|
2115
|
+
/**
|
|
2116
|
+
* Deprecated: use `inputs.label`.
|
|
2117
|
+
* @deprecated
|
|
2118
|
+
*/
|
|
2119
|
+
label?: string;
|
|
2120
|
+
/** Field controls are sorted by this value in ascending order. */
|
|
2121
|
+
orderIndex?: number;
|
|
2122
|
+
/** Unique control ID. */
|
|
2123
|
+
_id?: string;
|
|
2124
|
+
/**
|
|
2125
|
+
* Whether input control is deleted.
|
|
2126
|
+
* @readonly
|
|
2127
|
+
*/
|
|
2128
|
+
deleted?: boolean | null;
|
|
2135
2129
|
}
|
|
2136
|
-
|
|
2130
|
+
declare enum InputControlType$4 {
|
|
2131
|
+
/** Single text value field. */
|
|
2132
|
+
INPUT = "INPUT",
|
|
2133
|
+
/** Single text value field. */
|
|
2134
|
+
TEXTAREA = "TEXTAREA",
|
|
2135
|
+
/** Single-choice field of predefined values. */
|
|
2136
|
+
DROPDOWN = "DROPDOWN",
|
|
2137
|
+
/** Single-choice field of predefined values. */
|
|
2138
|
+
RADIO = "RADIO",
|
|
2139
|
+
/** Multiple-choice field of predefined values. */
|
|
2140
|
+
CHECKBOX = "CHECKBOX",
|
|
2141
|
+
/** First and last name fields. */
|
|
2142
|
+
NAME = "NAME",
|
|
2143
|
+
/** Additional guests and respective guest names fields. */
|
|
2144
|
+
GUEST_CONTROL = "GUEST_CONTROL",
|
|
2145
|
+
/** Single-line address field. */
|
|
2146
|
+
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
2147
|
+
/** Full address field. */
|
|
2148
|
+
ADDRESS_FULL = "ADDRESS_FULL",
|
|
2149
|
+
/** Year, month and day fields. */
|
|
2150
|
+
DATE = "DATE"
|
|
2137
2151
|
}
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
language?: string | null;
|
|
2143
|
-
/** Notifications silenced for this domain event. */
|
|
2144
|
-
silent?: boolean | null;
|
|
2145
|
-
/** Event ID. */
|
|
2146
|
-
eventId?: string;
|
|
2147
|
-
/** RSVP ID. */
|
|
2148
|
-
rsvpId?: string;
|
|
2149
|
-
/** Contact ID associated with this RSVP. */
|
|
2150
|
-
contactId?: string;
|
|
2151
|
-
/** Member ID associated with this RSVP. */
|
|
2152
|
-
memberId?: string | null;
|
|
2153
|
-
/** Guest first name. */
|
|
2154
|
-
firstName?: string;
|
|
2155
|
-
/** Guest last name. */
|
|
2156
|
-
lastName?: string;
|
|
2157
|
-
/** Guest email. */
|
|
2158
|
-
email?: string;
|
|
2159
|
-
/** RSVP form response. */
|
|
2160
|
-
rsvpForm?: FormResponse$4;
|
|
2161
|
-
/** RSVP response status. */
|
|
2162
|
-
status?: RsvpStatus$2;
|
|
2163
|
-
/** List of all guests. */
|
|
2164
|
-
guests?: Guest$3[];
|
|
2165
|
-
/** URL and password to online conference */
|
|
2166
|
-
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
2167
|
-
}
|
|
2168
|
-
declare enum RsvpStatus$2 {
|
|
2169
|
-
YES = "YES",
|
|
2170
|
-
NO = "NO",
|
|
2171
|
-
WAITING = "WAITING"
|
|
2172
|
-
}
|
|
2173
|
-
interface Guest$3 {
|
|
2174
|
-
/** Index in the RSVP guest list. */
|
|
2175
|
-
index?: number;
|
|
2176
|
-
/** Guest full name. */
|
|
2177
|
-
fullName?: string;
|
|
2178
|
-
/** Guest check-in. */
|
|
2179
|
-
checkIn?: CheckIn$3;
|
|
2180
|
-
/** Unique guest ID per RSVP. */
|
|
2181
|
-
_id?: number;
|
|
2182
|
-
}
|
|
2183
|
-
interface CheckIn$3 {
|
|
2184
|
-
/** Time of check-in */
|
|
2185
|
-
created?: Date;
|
|
2186
|
-
}
|
|
2187
|
-
interface Empty$5 {
|
|
2188
|
-
}
|
|
2189
|
-
interface RsvpUpdated$1 {
|
|
2190
|
-
/** RSVP updated timestamp in ISO UTC format. */
|
|
2191
|
-
timestamp?: Date;
|
|
2192
|
-
/** Site language when RSVP created */
|
|
2193
|
-
language?: string | null;
|
|
2194
|
-
/** Locale in which Rsvp was created. */
|
|
2195
|
-
locale?: string | null;
|
|
2196
|
-
/** Event ID. */
|
|
2197
|
-
eventId?: string;
|
|
2198
|
-
/** RSVP ID. */
|
|
2199
|
-
rsvpId?: string;
|
|
2200
|
-
/** Contact ID associated with this RSVP. */
|
|
2201
|
-
contactId?: string;
|
|
2202
|
-
/** Member ID associated with this RSVP. */
|
|
2203
|
-
memberId?: string | null;
|
|
2204
|
-
/** RSVP created timestamp. */
|
|
2205
|
-
created?: Date;
|
|
2206
|
-
/** Guest first name. */
|
|
2207
|
-
firstName?: string;
|
|
2208
|
-
/** Guest last name. */
|
|
2209
|
-
lastName?: string;
|
|
2210
|
-
/** Guest email. */
|
|
2211
|
-
email?: string;
|
|
2212
|
-
/** RSVP form response. */
|
|
2213
|
-
rsvpForm?: FormResponse$4;
|
|
2214
|
-
/** RSVP response status. */
|
|
2215
|
-
status?: RsvpStatus$2;
|
|
2216
|
-
/** List of the guests. */
|
|
2217
|
-
guests?: Guest$3[];
|
|
2218
|
-
/** URL and password to online conference */
|
|
2219
|
-
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
2220
|
-
/** Notifications silenced for this domain event. */
|
|
2221
|
-
silent?: boolean | null;
|
|
2222
|
-
}
|
|
2223
|
-
interface EventUpdated$3 {
|
|
2224
|
-
/** Event update timestamp in ISO UTC format. */
|
|
2225
|
-
timestamp?: Date;
|
|
2226
|
-
/** Event ID. */
|
|
2227
|
-
eventId?: string;
|
|
2228
|
-
/** Event location. */
|
|
2229
|
-
location?: Location$6;
|
|
2230
|
-
/** Event schedule configuration. */
|
|
2231
|
-
scheduleConfig?: ScheduleConfig$6;
|
|
2232
|
-
/** Event title. */
|
|
2233
|
-
title?: string;
|
|
2152
|
+
/** An input of one or multiple text values */
|
|
2153
|
+
interface Input$4 {
|
|
2154
|
+
/** Field name. */
|
|
2155
|
+
name?: string;
|
|
2234
2156
|
/**
|
|
2235
|
-
*
|
|
2157
|
+
* Deprecated: use `ValueType.TEXT_ARRAY`.
|
|
2236
2158
|
* @deprecated
|
|
2237
2159
|
*/
|
|
2238
|
-
|
|
2239
|
-
/**
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
/**
|
|
2244
|
-
|
|
2245
|
-
/**
|
|
2246
|
-
|
|
2247
|
-
/**
|
|
2248
|
-
|
|
2249
|
-
/** Location type. */
|
|
2250
|
-
type?: LocationType$6;
|
|
2251
|
-
/**
|
|
2252
|
-
* Full address derived from formatted single line `address`.
|
|
2253
|
-
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
2254
|
-
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
2255
|
-
*
|
|
2256
|
-
* Migration notes:
|
|
2257
|
-
* - `full_address.formatted_address` is equivalent to `address`.
|
|
2258
|
-
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
2259
|
-
*/
|
|
2260
|
-
fullAddress?: Address$9;
|
|
2160
|
+
array?: boolean;
|
|
2161
|
+
/** Main field label */
|
|
2162
|
+
label?: string;
|
|
2163
|
+
/** Additional labels for multi-valued fields such as address. */
|
|
2164
|
+
additionalLabels?: Record<string, string>;
|
|
2165
|
+
/** Predefined choice options for fields, such as dropdown. */
|
|
2166
|
+
options?: string[];
|
|
2167
|
+
/** Whether field is mandatory. */
|
|
2168
|
+
mandatory?: boolean;
|
|
2169
|
+
/** Maximum number of accepted characters (relevant for text fields). */
|
|
2170
|
+
maxLength?: number;
|
|
2261
2171
|
/**
|
|
2262
|
-
*
|
|
2263
|
-
*
|
|
2264
|
-
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
2172
|
+
* Type which determines field format.
|
|
2173
|
+
* Used to validate submitted response.
|
|
2265
2174
|
*/
|
|
2266
|
-
|
|
2267
|
-
}
|
|
2268
|
-
interface MapCoordinates$6 {
|
|
2269
|
-
/** Latitude. */
|
|
2270
|
-
lat?: number;
|
|
2271
|
-
/** Longitude. */
|
|
2272
|
-
lng?: number;
|
|
2273
|
-
}
|
|
2274
|
-
declare enum LocationType$6 {
|
|
2275
|
-
VENUE = "VENUE",
|
|
2276
|
-
ONLINE = "ONLINE"
|
|
2277
|
-
}
|
|
2278
|
-
/** Physical address */
|
|
2279
|
-
interface Address$9 extends AddressStreetOneOf$9 {
|
|
2280
|
-
/** a break down of the street to number and street name */
|
|
2281
|
-
streetAddress?: StreetAddress$9;
|
|
2282
|
-
/** Main address line (usually street and number) as free text */
|
|
2283
|
-
addressLine1?: string | null;
|
|
2284
|
-
/** country code */
|
|
2285
|
-
country?: string | null;
|
|
2286
|
-
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
2287
|
-
subdivision?: string | null;
|
|
2288
|
-
/** city name */
|
|
2289
|
-
city?: string | null;
|
|
2290
|
-
/** zip/postal code */
|
|
2291
|
-
postalCode?: string | null;
|
|
2292
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
2293
|
-
addressLine2?: string | null;
|
|
2294
|
-
/** A string containing the human-readable address of this location */
|
|
2295
|
-
formatted?: string | null;
|
|
2296
|
-
/** coordinates of the physical address */
|
|
2297
|
-
location?: AddressLocation$9;
|
|
2298
|
-
}
|
|
2299
|
-
/** @oneof */
|
|
2300
|
-
interface AddressStreetOneOf$9 {
|
|
2301
|
-
/** a break down of the street to number and street name */
|
|
2302
|
-
streetAddress?: StreetAddress$9;
|
|
2303
|
-
/** Main address line (usually street and number) as free text */
|
|
2304
|
-
addressLine?: string | null;
|
|
2305
|
-
}
|
|
2306
|
-
interface StreetAddress$9 {
|
|
2307
|
-
/** street number */
|
|
2308
|
-
number?: string;
|
|
2309
|
-
/** street name */
|
|
2310
|
-
name?: string;
|
|
2311
|
-
}
|
|
2312
|
-
interface AddressLocation$9 {
|
|
2313
|
-
/** address latitude coordinates */
|
|
2314
|
-
latitude?: number | null;
|
|
2315
|
-
/** address longitude coordinates */
|
|
2316
|
-
longitude?: number | null;
|
|
2317
|
-
}
|
|
2318
|
-
interface Subdivision$9 {
|
|
2319
|
-
/** subdivision short code */
|
|
2320
|
-
code?: string;
|
|
2321
|
-
/** subdivision full-name */
|
|
2322
|
-
name?: string;
|
|
2323
|
-
}
|
|
2324
|
-
interface ScheduleConfig$6 {
|
|
2175
|
+
type?: ValueType$4;
|
|
2325
2176
|
/**
|
|
2326
|
-
*
|
|
2327
|
-
*
|
|
2328
|
-
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
2177
|
+
* A maximum accepted values for array input.
|
|
2178
|
+
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
2329
2179
|
*/
|
|
2330
|
-
|
|
2331
|
-
/** TBD message. */
|
|
2332
|
-
scheduleTbdMessage?: string | null;
|
|
2333
|
-
/** Event start timestamp. */
|
|
2334
|
-
startDate?: Date;
|
|
2335
|
-
/** Event end timestamp. */
|
|
2336
|
-
endDate?: Date;
|
|
2337
|
-
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
2338
|
-
timeZoneId?: string | null;
|
|
2339
|
-
/** Whether end date is hidden in the formatted schedule. */
|
|
2340
|
-
endDateHidden?: boolean;
|
|
2341
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
2342
|
-
showTimeZone?: boolean;
|
|
2343
|
-
/** Event recurrences. */
|
|
2344
|
-
recurrences?: Recurrences$6;
|
|
2345
|
-
}
|
|
2346
|
-
interface Recurrences$6 {
|
|
2347
|
-
/** Event occurrences. */
|
|
2348
|
-
occurrences?: Occurrence$6[];
|
|
2180
|
+
maxSize?: number | null;
|
|
2349
2181
|
/**
|
|
2350
|
-
*
|
|
2351
|
-
*
|
|
2182
|
+
* Preselected option.
|
|
2183
|
+
* Currently only applicable for dropdown.
|
|
2352
2184
|
*/
|
|
2353
|
-
|
|
2185
|
+
defaultOptionSelection?: OptionSelection$4;
|
|
2354
2186
|
/**
|
|
2355
|
-
*
|
|
2187
|
+
* Additional labels for multi-valued fields such as address.
|
|
2356
2188
|
* @readonly
|
|
2357
2189
|
*/
|
|
2358
|
-
|
|
2190
|
+
labels?: Label$4[];
|
|
2359
2191
|
}
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
timeZoneId?: string | null;
|
|
2367
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
2368
|
-
showTimeZone?: boolean;
|
|
2192
|
+
declare enum ValueType$4 {
|
|
2193
|
+
TEXT = "TEXT",
|
|
2194
|
+
NUMBER = "NUMBER",
|
|
2195
|
+
TEXT_ARRAY = "TEXT_ARRAY",
|
|
2196
|
+
DATE_TIME = "DATE_TIME",
|
|
2197
|
+
ADDRESS = "ADDRESS"
|
|
2369
2198
|
}
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
/**
|
|
2376
|
-
|
|
2377
|
-
/**
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2199
|
+
/**
|
|
2200
|
+
* Describes initially selected option when an input has multiple choices.
|
|
2201
|
+
* Defaults to first (0th) option if not configured.
|
|
2202
|
+
*/
|
|
2203
|
+
interface OptionSelection$4 extends OptionSelectionSelectedOptionOneOf$4 {
|
|
2204
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
2205
|
+
optionIndex?: number;
|
|
2206
|
+
/**
|
|
2207
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
2208
|
+
* Considered an empty choice.
|
|
2209
|
+
*/
|
|
2210
|
+
placeholderText?: string;
|
|
2381
2211
|
}
|
|
2382
|
-
|
|
2212
|
+
/** @oneof */
|
|
2213
|
+
interface OptionSelectionSelectedOptionOneOf$4 {
|
|
2214
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
2215
|
+
optionIndex?: number;
|
|
2383
2216
|
/**
|
|
2384
|
-
*
|
|
2385
|
-
*
|
|
2217
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
2218
|
+
* Considered an empty choice.
|
|
2386
2219
|
*/
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
/**
|
|
2391
|
-
|
|
2392
|
-
/**
|
|
2220
|
+
placeholderText?: string;
|
|
2221
|
+
}
|
|
2222
|
+
interface Label$4 {
|
|
2223
|
+
/** Field name. */
|
|
2224
|
+
name?: string;
|
|
2225
|
+
/** Field label. */
|
|
2226
|
+
label?: string;
|
|
2227
|
+
}
|
|
2228
|
+
/**
|
|
2229
|
+
* Defines form messages shown in UI before, during, and after registration flow.
|
|
2230
|
+
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
2231
|
+
*/
|
|
2232
|
+
interface FormMessages$4 {
|
|
2233
|
+
/** RSVP form messages. */
|
|
2234
|
+
rsvp?: RsvpFormMessages$4;
|
|
2235
|
+
/** Checkout form messages. */
|
|
2236
|
+
checkout?: CheckoutFormMessages$4;
|
|
2237
|
+
/** Messages shown when event registration is closed. */
|
|
2238
|
+
registrationClosed?: RegistrationClosedMessages$4;
|
|
2239
|
+
/** Messages shown when event tickets are unavailable. */
|
|
2240
|
+
ticketsUnavailable?: TicketsUnavailableMessages$4;
|
|
2241
|
+
}
|
|
2242
|
+
interface RsvpFormMessages$4 {
|
|
2243
|
+
/** Label text indicating RSVP `YES` response. */
|
|
2244
|
+
rsvpYesOption?: string;
|
|
2245
|
+
/** Label text indicating RSVP `NO` response. */
|
|
2246
|
+
rsvpNoOption?: string;
|
|
2247
|
+
/** Messages shown for RSVP = `YES`. */
|
|
2248
|
+
positiveMessages?: Positive$4;
|
|
2249
|
+
/** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
|
|
2250
|
+
waitlistMessages?: Positive$4;
|
|
2251
|
+
/** Messages shown for RSVP = `NO`. */
|
|
2252
|
+
negativeMessages?: Negative$4;
|
|
2253
|
+
/** "Submit form" call-to-action label text. */
|
|
2254
|
+
submitActionLabel?: string;
|
|
2255
|
+
}
|
|
2256
|
+
/** Confirmation messages shown after registration. */
|
|
2257
|
+
interface PositiveResponseConfirmation$4 {
|
|
2258
|
+
/** Confirmation message title. */
|
|
2393
2259
|
title?: string;
|
|
2394
|
-
/**
|
|
2395
|
-
|
|
2396
|
-
/**
|
|
2397
|
-
|
|
2398
|
-
/**
|
|
2399
|
-
|
|
2400
|
-
/** Event slug URL (generated from event title). */
|
|
2401
|
-
slug?: string;
|
|
2402
|
-
/** ISO 639-1 language code of the event (used in content translations). */
|
|
2403
|
-
language?: string;
|
|
2404
|
-
/** Event creation timestamp. */
|
|
2405
|
-
created?: Date;
|
|
2406
|
-
/** Event modified timestamp. */
|
|
2407
|
-
modified?: Date;
|
|
2408
|
-
/** Event status. */
|
|
2409
|
-
status?: EventStatus$6;
|
|
2410
|
-
/** RSVP or ticketing registration details. */
|
|
2411
|
-
registration?: Registration$4;
|
|
2412
|
-
/** "Add to calendar" URLs. */
|
|
2413
|
-
calendarLinks?: CalendarLinks$6;
|
|
2414
|
-
/** Event page URL components. */
|
|
2415
|
-
eventPageUrl?: SiteUrl$4;
|
|
2416
|
-
/** Event registration form. */
|
|
2417
|
-
form?: Form$4;
|
|
2418
|
-
/** Event dashboard summary of RSVP / ticket sales. */
|
|
2419
|
-
dashboard?: Dashboard$6;
|
|
2420
|
-
/** Instance ID of the site where event is hosted. */
|
|
2421
|
-
instanceId?: string;
|
|
2422
|
-
/** Guest list configuration. */
|
|
2423
|
-
guestListConfig?: GuestListConfig$4;
|
|
2424
|
-
/** Event creator user ID. */
|
|
2425
|
-
userId?: string;
|
|
2426
|
-
/** Event discussion feed. For internal use. */
|
|
2427
|
-
feed?: Feed$4;
|
|
2428
|
-
/** Online conferencing details. */
|
|
2429
|
-
onlineConferencing?: OnlineConferencing$4;
|
|
2430
|
-
/** SEO settings. */
|
|
2431
|
-
seoSettings?: SeoSettings$4;
|
|
2432
|
-
/** Assigned contacts label key. */
|
|
2433
|
-
assignedContactsLabel?: string | null;
|
|
2434
|
-
/** Agenda details. */
|
|
2435
|
-
agenda?: Agenda$4;
|
|
2436
|
-
/** Categories this event is assigned to. */
|
|
2437
|
-
categories?: Category$5[];
|
|
2438
|
-
/** Visual settings for event. */
|
|
2439
|
-
eventDisplaySettings?: EventDisplaySettings$4;
|
|
2260
|
+
/** Confirmation message text. */
|
|
2261
|
+
message?: string;
|
|
2262
|
+
/** "Add to calendar" call-to-action label text. */
|
|
2263
|
+
addToCalendarActionLabel?: string;
|
|
2264
|
+
/** "Share event" call-to-action label text. */
|
|
2265
|
+
shareActionLabel?: string;
|
|
2440
2266
|
}
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
startDateFormatted?: string;
|
|
2448
|
-
/** Formatted start time of the event (empty for TBD schedules). */
|
|
2449
|
-
startTimeFormatted?: string;
|
|
2450
|
-
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
2451
|
-
endDateFormatted?: string;
|
|
2452
|
-
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
2453
|
-
endTimeFormatted?: string;
|
|
2267
|
+
/** Confirmation messages shown after registration. */
|
|
2268
|
+
interface NegativeResponseConfirmation$4 {
|
|
2269
|
+
/** Confirmation message title. */
|
|
2270
|
+
title?: string;
|
|
2271
|
+
/** "Share event" call-to-action label text. */
|
|
2272
|
+
shareActionLabel?: string;
|
|
2454
2273
|
}
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
ENDED = "ENDED",
|
|
2462
|
-
/** Event was canceled */
|
|
2463
|
-
CANCELED = "CANCELED",
|
|
2464
|
-
/** Event is not public and needs to be published */
|
|
2465
|
-
DRAFT = "DRAFT"
|
|
2274
|
+
/** Set of messages shown during registration when RSVP response is positive. */
|
|
2275
|
+
interface Positive$4 {
|
|
2276
|
+
/** Main form title for positive response. */
|
|
2277
|
+
title?: string;
|
|
2278
|
+
/** Confirmation messages shown after registration. */
|
|
2279
|
+
confirmation?: PositiveResponseConfirmation$4;
|
|
2466
2280
|
}
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
rsvpCollection?: RsvpCollection$4;
|
|
2474
|
-
/** Ticketing details. */
|
|
2475
|
-
ticketing?: Ticketing$4;
|
|
2476
|
-
/** External registration details. */
|
|
2477
|
-
external?: ExternalEvent$4;
|
|
2478
|
-
/** Types of users allowed to register. */
|
|
2479
|
-
restrictedTo?: VisitorType$4;
|
|
2480
|
-
/** Initial event type which was set when creating an event. */
|
|
2481
|
-
initialType?: EventType$4;
|
|
2281
|
+
/** A set of messages shown during registration with negative response */
|
|
2282
|
+
interface Negative$4 {
|
|
2283
|
+
/** Main form title for negative response. */
|
|
2284
|
+
title?: string;
|
|
2285
|
+
/** Confirmation messages shown after registration. */
|
|
2286
|
+
confirmation?: NegativeResponseConfirmation$4;
|
|
2482
2287
|
}
|
|
2483
|
-
|
|
2484
|
-
/**
|
|
2485
|
-
|
|
2486
|
-
/**
|
|
2487
|
-
|
|
2488
|
-
/**
|
|
2489
|
-
|
|
2490
|
-
/** External registration */
|
|
2491
|
-
EXTERNAL = "EXTERNAL",
|
|
2492
|
-
/** Registration not available */
|
|
2493
|
-
NO_REGISTRATION = "NO_REGISTRATION"
|
|
2288
|
+
interface CheckoutFormMessages$4 {
|
|
2289
|
+
/** Main form title for response. */
|
|
2290
|
+
title?: string;
|
|
2291
|
+
/** Submit form call-to-action label text. */
|
|
2292
|
+
submitActionLabel?: string;
|
|
2293
|
+
/** Confirmation messages shown after checkout. */
|
|
2294
|
+
confirmation?: ResponseConfirmation$4;
|
|
2494
2295
|
}
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
OPEN_TICKETS = "OPEN_TICKETS",
|
|
2508
|
-
/** Registration is open via external URL */
|
|
2509
|
-
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
2510
|
-
/** Registration will be open via RSVP */
|
|
2511
|
-
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
2296
|
+
/** Confirmation messages shown after checkout. */
|
|
2297
|
+
interface ResponseConfirmation$4 {
|
|
2298
|
+
/** Confirmation message title. */
|
|
2299
|
+
title?: string;
|
|
2300
|
+
/** Confirmation message text. */
|
|
2301
|
+
message?: string;
|
|
2302
|
+
/** "Download tickets" call-to-action label text. */
|
|
2303
|
+
downloadTicketsLabel?: string;
|
|
2304
|
+
/** "Add to calendar" call-to-action label text. */
|
|
2305
|
+
addToCalendarLabel?: string;
|
|
2306
|
+
/** "Share event" call-to-action label text. */
|
|
2307
|
+
shareEventLabel?: string;
|
|
2512
2308
|
}
|
|
2513
|
-
interface
|
|
2514
|
-
/**
|
|
2515
|
-
|
|
2309
|
+
interface RegistrationClosedMessages$4 {
|
|
2310
|
+
/** Message shown when event registration is closed. */
|
|
2311
|
+
message?: string;
|
|
2312
|
+
/** "Explore other events" call-to-action label text. */
|
|
2313
|
+
exploreEventsActionLabel?: string;
|
|
2314
|
+
}
|
|
2315
|
+
interface TicketsUnavailableMessages$4 {
|
|
2316
|
+
/** Message shown when event tickets are unavailable. */
|
|
2317
|
+
message?: string;
|
|
2318
|
+
/** "Explore other events" call-to-action label text. */
|
|
2319
|
+
exploreEventsActionLabel?: string;
|
|
2516
2320
|
}
|
|
2517
|
-
interface
|
|
2518
|
-
/**
|
|
2519
|
-
|
|
2321
|
+
interface Dashboard$6 {
|
|
2322
|
+
/** Guest RSVP summary. */
|
|
2323
|
+
rsvpSummary?: RsvpSummary$5;
|
|
2520
2324
|
/**
|
|
2521
|
-
*
|
|
2522
|
-
*
|
|
2325
|
+
* Summary of revenue and tickets sold.
|
|
2326
|
+
* (Archived orders are not included).
|
|
2523
2327
|
*/
|
|
2524
|
-
|
|
2525
|
-
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
2526
|
-
waitlist?: boolean;
|
|
2527
|
-
/** Registration start timestamp. */
|
|
2528
|
-
startDate?: Date;
|
|
2529
|
-
/** Registration end timestamp. */
|
|
2530
|
-
endDate?: Date;
|
|
2328
|
+
ticketingSummary?: TicketingSummary$4;
|
|
2531
2329
|
}
|
|
2532
|
-
|
|
2533
|
-
/**
|
|
2534
|
-
|
|
2535
|
-
/**
|
|
2536
|
-
|
|
2330
|
+
interface RsvpSummary$5 {
|
|
2331
|
+
/** Total number of RSVPs. */
|
|
2332
|
+
total?: number;
|
|
2333
|
+
/** Number of RSVPs with status `YES`. */
|
|
2334
|
+
yes?: number;
|
|
2335
|
+
/** Number of RSVPs with status `NO`. */
|
|
2336
|
+
no?: number;
|
|
2337
|
+
/** Number of RSVPs in waitlist. */
|
|
2338
|
+
waitlist?: number;
|
|
2537
2339
|
}
|
|
2538
|
-
interface
|
|
2340
|
+
interface TicketingSummary$4 {
|
|
2341
|
+
/** Number of tickets sold. */
|
|
2342
|
+
tickets?: number;
|
|
2539
2343
|
/**
|
|
2540
|
-
*
|
|
2541
|
-
*
|
|
2344
|
+
* Total revenue, excluding fees.
|
|
2345
|
+
* (taxes and payment provider fees are not deducted.)
|
|
2542
2346
|
*/
|
|
2543
|
-
|
|
2347
|
+
revenue?: Money$7;
|
|
2348
|
+
/** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
|
|
2349
|
+
currencyLocked?: boolean;
|
|
2350
|
+
/** Number of orders placed. */
|
|
2351
|
+
orders?: number;
|
|
2352
|
+
/** Total balance of confirmed transactions. */
|
|
2353
|
+
totalSales?: Money$7;
|
|
2354
|
+
}
|
|
2355
|
+
interface GuestListConfig$4 {
|
|
2356
|
+
/** Whether members can see other members attending the event (defaults to true). */
|
|
2357
|
+
publicGuestList?: boolean;
|
|
2358
|
+
}
|
|
2359
|
+
interface Feed$4 {
|
|
2360
|
+
/** Event discussion feed token. */
|
|
2361
|
+
token?: string;
|
|
2362
|
+
}
|
|
2363
|
+
interface OnlineConferencing$4 {
|
|
2364
|
+
config?: OnlineConferencingConfig$4;
|
|
2365
|
+
session?: OnlineConferencingSession$4;
|
|
2366
|
+
}
|
|
2367
|
+
interface OnlineConferencingConfig$4 {
|
|
2544
2368
|
/**
|
|
2545
|
-
*
|
|
2546
|
-
*
|
|
2369
|
+
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
2370
|
+
* When enabled, links to join conferencing are generated and provided to guests.
|
|
2547
2371
|
*/
|
|
2548
|
-
|
|
2549
|
-
/**
|
|
2550
|
-
|
|
2551
|
-
/**
|
|
2552
|
-
|
|
2372
|
+
enabled?: boolean;
|
|
2373
|
+
/** Conferencing provider ID. */
|
|
2374
|
+
providerId?: string | null;
|
|
2375
|
+
/** Conference type */
|
|
2376
|
+
conferenceType?: ConferenceType$4;
|
|
2377
|
+
}
|
|
2378
|
+
declare enum ConferenceType$4 {
|
|
2379
|
+
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
2380
|
+
MEETING = "MEETING",
|
|
2381
|
+
/** Guests can only subscribe to video and audio. */
|
|
2382
|
+
WEBINAR = "WEBINAR"
|
|
2383
|
+
}
|
|
2384
|
+
interface OnlineConferencingSession$4 {
|
|
2553
2385
|
/**
|
|
2554
|
-
*
|
|
2386
|
+
* Link for event host to start the online conference session.
|
|
2555
2387
|
* @readonly
|
|
2556
2388
|
*/
|
|
2557
|
-
|
|
2389
|
+
hostLink?: string;
|
|
2558
2390
|
/**
|
|
2559
|
-
*
|
|
2391
|
+
* Link for guests to join the online conference session.
|
|
2560
2392
|
* @readonly
|
|
2561
2393
|
*/
|
|
2562
|
-
|
|
2394
|
+
guestLink?: string;
|
|
2563
2395
|
/**
|
|
2564
|
-
*
|
|
2396
|
+
* The password required to join online conferencing session (when relevant).
|
|
2565
2397
|
* @readonly
|
|
2566
2398
|
*/
|
|
2567
|
-
|
|
2399
|
+
password?: string | null;
|
|
2568
2400
|
/**
|
|
2569
|
-
*
|
|
2401
|
+
* Indicates that session was created successfully on providers side.
|
|
2570
2402
|
* @readonly
|
|
2571
2403
|
*/
|
|
2572
|
-
|
|
2404
|
+
sessionCreated?: boolean | null;
|
|
2573
2405
|
/**
|
|
2574
|
-
*
|
|
2406
|
+
* Unique session id
|
|
2575
2407
|
* @readonly
|
|
2576
2408
|
*/
|
|
2577
|
-
|
|
2578
|
-
}
|
|
2579
|
-
interface TicketingConfig$4 {
|
|
2580
|
-
/** Whether the form must be filled out separately for each ticket. */
|
|
2581
|
-
guestAssignedTickets?: boolean;
|
|
2582
|
-
/** Tax configuration. */
|
|
2583
|
-
taxConfig?: TaxConfig$4;
|
|
2584
|
-
/** Limit of tickets that can be purchased per order, default 20. */
|
|
2585
|
-
ticketLimitPerOrder?: number;
|
|
2586
|
-
/** Duration for which the tickets being bought are reserved. */
|
|
2587
|
-
reservationDurationInMinutes?: number | null;
|
|
2588
|
-
}
|
|
2589
|
-
interface TaxConfig$4 {
|
|
2590
|
-
/** Tax application settings. */
|
|
2591
|
-
type?: TaxType$5;
|
|
2592
|
-
/** Tax name. */
|
|
2593
|
-
name?: string | null;
|
|
2594
|
-
/** Tax rate (e.g.,`21.55`). */
|
|
2595
|
-
rate?: string | null;
|
|
2596
|
-
/** Applies taxes for donations, default true. */
|
|
2597
|
-
appliesToDonations?: boolean | null;
|
|
2598
|
-
}
|
|
2599
|
-
declare enum TaxType$5 {
|
|
2600
|
-
/** Tax is included in the ticket price. */
|
|
2601
|
-
INCLUDED = "INCLUDED",
|
|
2602
|
-
/** Tax is added to the order at the checkout. */
|
|
2603
|
-
ADDED = "ADDED",
|
|
2604
|
-
/** Tax is added to the final total at the checkout. */
|
|
2605
|
-
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
2409
|
+
sessionId?: string | null;
|
|
2606
2410
|
}
|
|
2607
|
-
interface
|
|
2411
|
+
interface SeoSettings$4 {
|
|
2412
|
+
/** URL slug */
|
|
2413
|
+
slug?: string;
|
|
2414
|
+
/** Advanced SEO data */
|
|
2415
|
+
advancedSeoData?: SeoSchema$4;
|
|
2608
2416
|
/**
|
|
2609
|
-
*
|
|
2610
|
-
* @
|
|
2417
|
+
* Hidden from SEO Site Map
|
|
2418
|
+
* @readonly
|
|
2611
2419
|
*/
|
|
2612
|
-
|
|
2613
|
-
/** ISO 4217 format of the currency e.g., `USD`. */
|
|
2614
|
-
currency?: string;
|
|
2615
|
-
/** 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. */
|
|
2616
|
-
value?: string | null;
|
|
2420
|
+
hidden?: boolean | null;
|
|
2617
2421
|
}
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
|
|
2422
|
+
/**
|
|
2423
|
+
* 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.
|
|
2424
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
2425
|
+
* 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.
|
|
2426
|
+
*/
|
|
2427
|
+
interface SeoSchema$4 {
|
|
2428
|
+
/** SEO tag information. */
|
|
2429
|
+
tags?: Tag$4[];
|
|
2430
|
+
/** SEO general settings. */
|
|
2431
|
+
settings?: Settings$5;
|
|
2621
2432
|
}
|
|
2622
|
-
|
|
2623
|
-
/**
|
|
2624
|
-
|
|
2625
|
-
/**
|
|
2626
|
-
|
|
2627
|
-
/**
|
|
2628
|
-
|
|
2433
|
+
interface Keyword$4 {
|
|
2434
|
+
/** Keyword value. */
|
|
2435
|
+
term?: string;
|
|
2436
|
+
/** Whether the keyword is the main focus keyword. */
|
|
2437
|
+
isMain?: boolean;
|
|
2438
|
+
/** Who added the keyword to the settings */
|
|
2439
|
+
origin?: string | null;
|
|
2629
2440
|
}
|
|
2630
|
-
interface
|
|
2631
|
-
/**
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
|
|
2441
|
+
interface Tag$4 {
|
|
2442
|
+
/**
|
|
2443
|
+
* SEO tag type.
|
|
2444
|
+
*
|
|
2445
|
+
*
|
|
2446
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
2447
|
+
*/
|
|
2448
|
+
type?: string;
|
|
2449
|
+
/**
|
|
2450
|
+
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
2451
|
+
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
2452
|
+
*/
|
|
2453
|
+
props?: Record<string, any> | null;
|
|
2454
|
+
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
2455
|
+
meta?: Record<string, any> | null;
|
|
2456
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
2457
|
+
children?: string;
|
|
2458
|
+
/** Whether the tag is a custom tag. */
|
|
2459
|
+
custom?: boolean;
|
|
2460
|
+
/** Whether the tag is disabled. */
|
|
2461
|
+
disabled?: boolean;
|
|
2635
2462
|
}
|
|
2636
|
-
|
|
2637
|
-
interface SiteUrl$4 {
|
|
2463
|
+
interface Settings$5 {
|
|
2638
2464
|
/**
|
|
2639
|
-
*
|
|
2640
|
-
*
|
|
2465
|
+
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
2466
|
+
*
|
|
2467
|
+
*
|
|
2468
|
+
* Default: `false` (Auto Redirect is enabled.)
|
|
2641
2469
|
*/
|
|
2642
|
-
|
|
2643
|
-
/**
|
|
2644
|
-
|
|
2470
|
+
preventAutoRedirect?: boolean;
|
|
2471
|
+
/** User-selected keyword terms for a specific page. */
|
|
2472
|
+
keywords?: Keyword$4[];
|
|
2645
2473
|
}
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
* - First Name
|
|
2655
|
-
* - Last Name
|
|
2656
|
-
*
|
|
2657
|
-
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
2658
|
-
*/
|
|
2659
|
-
interface Form$4 {
|
|
2660
|
-
/** Nested fields as an ordered list. */
|
|
2661
|
-
controls?: InputControl$4[];
|
|
2662
|
-
/** Set of configured form messages. */
|
|
2663
|
-
messages?: FormMessages$4;
|
|
2474
|
+
interface Agenda$4 {
|
|
2475
|
+
/** Whether the schedule is enabled for the event. */
|
|
2476
|
+
enabled?: boolean;
|
|
2477
|
+
/**
|
|
2478
|
+
* Agenda page URL.
|
|
2479
|
+
* @readonly
|
|
2480
|
+
*/
|
|
2481
|
+
pageUrl?: SiteUrl$4;
|
|
2664
2482
|
}
|
|
2665
|
-
|
|
2666
|
-
* A block of nested fields.
|
|
2667
|
-
* Used to aggregate similar inputs like First Name and Last Name.
|
|
2668
|
-
*/
|
|
2669
|
-
interface InputControl$4 {
|
|
2670
|
-
/** Field control type. */
|
|
2671
|
-
type?: InputControlType$4;
|
|
2672
|
-
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
2673
|
-
system?: boolean;
|
|
2483
|
+
interface Category$5 {
|
|
2674
2484
|
/**
|
|
2675
|
-
*
|
|
2676
|
-
* @
|
|
2485
|
+
* Category ID.
|
|
2486
|
+
* @readonly
|
|
2677
2487
|
*/
|
|
2488
|
+
_id?: string;
|
|
2489
|
+
/** Category name. */
|
|
2678
2490
|
name?: string;
|
|
2679
|
-
/** Child inputs. */
|
|
2680
|
-
inputs?: Input$4[];
|
|
2681
2491
|
/**
|
|
2682
|
-
*
|
|
2683
|
-
* @
|
|
2492
|
+
* Date and time when category was created.
|
|
2493
|
+
* @readonly
|
|
2684
2494
|
*/
|
|
2685
|
-
|
|
2686
|
-
/** Field controls are sorted by this value in ascending order. */
|
|
2687
|
-
orderIndex?: number;
|
|
2688
|
-
/** Unique control ID. */
|
|
2689
|
-
_id?: string;
|
|
2495
|
+
_createdDate?: Date;
|
|
2690
2496
|
/**
|
|
2691
|
-
*
|
|
2497
|
+
* The total number of draft and published events assigned to the category.
|
|
2692
2498
|
* @readonly
|
|
2693
2499
|
*/
|
|
2694
|
-
|
|
2500
|
+
counts?: CategoryCounts$5;
|
|
2501
|
+
/**
|
|
2502
|
+
* Category state. Possible values:
|
|
2503
|
+
*
|
|
2504
|
+
* `MANUAL`: Category is created manually by the user.
|
|
2505
|
+
* `AUTO`: Category is created automatically.
|
|
2506
|
+
* `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
|
|
2507
|
+
* `HIDDEN`: Category can't be seen.
|
|
2508
|
+
*
|
|
2509
|
+
* Default: `MANUAL`.
|
|
2510
|
+
*
|
|
2511
|
+
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
2512
|
+
*/
|
|
2513
|
+
states?: State$8[];
|
|
2695
2514
|
}
|
|
2696
|
-
|
|
2697
|
-
/**
|
|
2698
|
-
|
|
2699
|
-
/**
|
|
2700
|
-
|
|
2701
|
-
/** Single-choice field of predefined values. */
|
|
2702
|
-
DROPDOWN = "DROPDOWN",
|
|
2703
|
-
/** Single-choice field of predefined values. */
|
|
2704
|
-
RADIO = "RADIO",
|
|
2705
|
-
/** Multiple-choice field of predefined values. */
|
|
2706
|
-
CHECKBOX = "CHECKBOX",
|
|
2707
|
-
/** First and last name fields. */
|
|
2708
|
-
NAME = "NAME",
|
|
2709
|
-
/** Additional guests and respective guest names fields. */
|
|
2710
|
-
GUEST_CONTROL = "GUEST_CONTROL",
|
|
2711
|
-
/** Single-line address field. */
|
|
2712
|
-
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
2713
|
-
/** Full address field. */
|
|
2714
|
-
ADDRESS_FULL = "ADDRESS_FULL",
|
|
2715
|
-
/** Year, month and day fields. */
|
|
2716
|
-
DATE = "DATE"
|
|
2515
|
+
interface CategoryCounts$5 {
|
|
2516
|
+
/** Total number of draft events assigned to the category. */
|
|
2517
|
+
assignedEventsCount?: number | null;
|
|
2518
|
+
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
2519
|
+
assignedDraftEventsCount?: number | null;
|
|
2717
2520
|
}
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2521
|
+
declare enum State$8 {
|
|
2522
|
+
/** Created manually by the user. */
|
|
2523
|
+
MANUAL = "MANUAL",
|
|
2524
|
+
/** Created automatically. */
|
|
2525
|
+
AUTO = "AUTO",
|
|
2526
|
+
/** Created when publishing recurring events. */
|
|
2527
|
+
RECURRING_EVENT = "RECURRING_EVENT",
|
|
2528
|
+
/** Category is hidden. */
|
|
2529
|
+
HIDDEN = "HIDDEN",
|
|
2530
|
+
/** Category is used to store component events. */
|
|
2531
|
+
COMPONENT = "COMPONENT"
|
|
2532
|
+
}
|
|
2533
|
+
interface EventDisplaySettings$4 {
|
|
2534
|
+
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
2535
|
+
hideEventDetailsButton?: boolean | null;
|
|
2536
|
+
}
|
|
2537
|
+
interface LabellingSettings$4 {
|
|
2538
|
+
}
|
|
2539
|
+
interface OrderConfirmed$1 {
|
|
2540
|
+
/** Order confirmation timestamp in ISO UTC. */
|
|
2541
|
+
timestamp?: Date;
|
|
2542
|
+
/** Site language when Order initiated */
|
|
2543
|
+
language?: string | null;
|
|
2544
|
+
/** Notifications silenced for this domain event. */
|
|
2545
|
+
silent?: boolean | null;
|
|
2546
|
+
/** Locale in which Order was created. */
|
|
2547
|
+
locale?: string | null;
|
|
2548
|
+
/** Event ID. */
|
|
2549
|
+
eventId?: string;
|
|
2550
|
+
/** Unique order number. */
|
|
2551
|
+
orderNumber?: string;
|
|
2552
|
+
/** Contact ID associated with this order. */
|
|
2553
|
+
contactId?: string;
|
|
2554
|
+
/** Member ID associated with this order. */
|
|
2555
|
+
memberId?: string | null;
|
|
2722
2556
|
/**
|
|
2723
|
-
*
|
|
2724
|
-
* @
|
|
2557
|
+
* Order created timestamp
|
|
2558
|
+
* @readonly
|
|
2725
2559
|
*/
|
|
2726
|
-
|
|
2727
|
-
/**
|
|
2728
|
-
|
|
2729
|
-
/**
|
|
2730
|
-
|
|
2731
|
-
/**
|
|
2732
|
-
|
|
2733
|
-
/**
|
|
2734
|
-
|
|
2735
|
-
/**
|
|
2736
|
-
|
|
2560
|
+
created?: Date;
|
|
2561
|
+
/** Buyer first name. */
|
|
2562
|
+
firstName?: string;
|
|
2563
|
+
/** Buyer last name. */
|
|
2564
|
+
lastName?: string;
|
|
2565
|
+
/** Buyer email address. */
|
|
2566
|
+
email?: string;
|
|
2567
|
+
/** Checkout form response. */
|
|
2568
|
+
checkoutForm?: FormResponse$4;
|
|
2569
|
+
/** Order status. */
|
|
2570
|
+
status?: OrderStatus$2;
|
|
2571
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
2572
|
+
method?: string | null;
|
|
2573
|
+
/** Tickets (generated after payment). */
|
|
2574
|
+
tickets?: Ticket$2[];
|
|
2575
|
+
/** Invoice. */
|
|
2576
|
+
invoice?: Invoice$1;
|
|
2577
|
+
/** Reservation ID associated with this order. */
|
|
2578
|
+
reservationId?: string;
|
|
2579
|
+
}
|
|
2580
|
+
declare enum OrderStatus$2 {
|
|
2581
|
+
/** Order status not available for this request fieldset */
|
|
2582
|
+
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
2583
|
+
/** Order is confirmed, no payment required */
|
|
2584
|
+
FREE = "FREE",
|
|
2585
|
+
/** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
|
|
2586
|
+
PENDING = "PENDING",
|
|
2587
|
+
/** Order paid via payment gateway */
|
|
2588
|
+
PAID = "PAID",
|
|
2589
|
+
/** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
|
|
2590
|
+
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
2591
|
+
/** Order is awaiting for payment in Cashier */
|
|
2592
|
+
INITIATED = "INITIATED",
|
|
2593
|
+
/** Order was canceled */
|
|
2594
|
+
CANCELED = "CANCELED",
|
|
2595
|
+
/** Order payment was declined */
|
|
2596
|
+
DECLINED = "DECLINED",
|
|
2597
|
+
/** Order payment was authorized */
|
|
2598
|
+
AUTHORIZED = "AUTHORIZED",
|
|
2599
|
+
/** Order payment was voided */
|
|
2600
|
+
VOIDED = "VOIDED"
|
|
2601
|
+
}
|
|
2602
|
+
interface Ticket$2 {
|
|
2603
|
+
/** Unique issued ticket number. */
|
|
2604
|
+
ticketNumber?: string;
|
|
2605
|
+
/** Ticket definition ID. */
|
|
2606
|
+
ticketDefinitionId?: string;
|
|
2607
|
+
/** Ticket check-in. */
|
|
2608
|
+
checkIn?: CheckIn$3;
|
|
2609
|
+
/** Ticket price. */
|
|
2610
|
+
price?: Money$7;
|
|
2611
|
+
/** Whether ticket is archived. */
|
|
2612
|
+
archived?: boolean;
|
|
2613
|
+
/** Guest first name. */
|
|
2614
|
+
firstName?: string | null;
|
|
2615
|
+
/** Guest last name. */
|
|
2616
|
+
lastName?: string | null;
|
|
2617
|
+
/** Guest email. */
|
|
2618
|
+
email?: string | null;
|
|
2619
|
+
/** Contact ID associated with this ticket. */
|
|
2620
|
+
contactId?: string | null;
|
|
2621
|
+
/** Whether ticket is confirmed */
|
|
2622
|
+
confirmed?: boolean;
|
|
2623
|
+
/** Member ID associated with this ticket. */
|
|
2624
|
+
memberId?: string | null;
|
|
2625
|
+
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
2626
|
+
form?: FormResponse$4;
|
|
2627
|
+
/** Ticket name. */
|
|
2628
|
+
ticketName?: string;
|
|
2629
|
+
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
2630
|
+
anonymized?: boolean;
|
|
2631
|
+
/** URL and password to online conference */
|
|
2632
|
+
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
2633
|
+
}
|
|
2634
|
+
interface Invoice$1 {
|
|
2635
|
+
items?: Item$2[];
|
|
2737
2636
|
/**
|
|
2738
|
-
*
|
|
2739
|
-
*
|
|
2637
|
+
* Total cart amount.
|
|
2638
|
+
* @deprecated
|
|
2740
2639
|
*/
|
|
2741
|
-
|
|
2640
|
+
total?: Money$7;
|
|
2641
|
+
/** Discount applied to cart. */
|
|
2642
|
+
discount?: Discount$1;
|
|
2643
|
+
/** Tax applied to cart. */
|
|
2644
|
+
tax?: Tax$1;
|
|
2645
|
+
/** Total cart amount before discount, tax, and fees. */
|
|
2646
|
+
subTotal?: Money$7;
|
|
2742
2647
|
/**
|
|
2743
|
-
*
|
|
2744
|
-
*
|
|
2648
|
+
* Total amount of cart after discount, tax, and fees.
|
|
2649
|
+
* Grand total is calculated in the following order:
|
|
2650
|
+
* 1. Total prices of all items in the cart are calculated.
|
|
2651
|
+
* 2. Discount is subtracted from the cart (if applicable).
|
|
2652
|
+
* 3. Tax is added (if applicable).
|
|
2653
|
+
* 4. Wix service fee is added.
|
|
2745
2654
|
*/
|
|
2746
|
-
|
|
2655
|
+
grandTotal?: Money$7;
|
|
2747
2656
|
/**
|
|
2748
|
-
*
|
|
2749
|
-
*
|
|
2657
|
+
* Fees applied to the cart.
|
|
2658
|
+
* @readonly
|
|
2750
2659
|
*/
|
|
2751
|
-
|
|
2660
|
+
fees?: Fee$1[];
|
|
2661
|
+
/** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
|
|
2662
|
+
revenue?: Money$7;
|
|
2663
|
+
/** URL to invoice preview. Returned only if order is paid. */
|
|
2664
|
+
previewUrl?: string | null;
|
|
2665
|
+
}
|
|
2666
|
+
interface Item$2 {
|
|
2667
|
+
/** Unique line item ID. */
|
|
2668
|
+
_id?: string;
|
|
2669
|
+
/** Line item quantity. */
|
|
2670
|
+
quantity?: number;
|
|
2671
|
+
/** Line item mame. */
|
|
2672
|
+
name?: string;
|
|
2673
|
+
/** Line item price. */
|
|
2674
|
+
price?: Money$7;
|
|
2675
|
+
/** Total price for line items. Always equal to price * quantity. */
|
|
2676
|
+
total?: Money$7;
|
|
2677
|
+
/** Discount applied to the line item. */
|
|
2678
|
+
discount?: Discount$1;
|
|
2679
|
+
/** Tax applied to the item. */
|
|
2680
|
+
tax?: Tax$1;
|
|
2752
2681
|
/**
|
|
2753
|
-
*
|
|
2682
|
+
* Fees applied to the item.
|
|
2754
2683
|
* @readonly
|
|
2755
2684
|
*/
|
|
2756
|
-
|
|
2757
|
-
}
|
|
2758
|
-
declare enum ValueType$4 {
|
|
2759
|
-
TEXT = "TEXT",
|
|
2760
|
-
NUMBER = "NUMBER",
|
|
2761
|
-
TEXT_ARRAY = "TEXT_ARRAY",
|
|
2762
|
-
DATE_TIME = "DATE_TIME",
|
|
2763
|
-
ADDRESS = "ADDRESS"
|
|
2685
|
+
fees?: Fee$1[];
|
|
2764
2686
|
}
|
|
2765
|
-
|
|
2766
|
-
|
|
2767
|
-
|
|
2768
|
-
*/
|
|
2769
|
-
|
|
2770
|
-
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
2771
|
-
optionIndex?: number;
|
|
2687
|
+
interface Discount$1 {
|
|
2688
|
+
/** Total discount amount. */
|
|
2689
|
+
amount?: Money$7;
|
|
2690
|
+
/** Total charge after applied discount. */
|
|
2691
|
+
afterDiscount?: Money$7;
|
|
2772
2692
|
/**
|
|
2773
|
-
*
|
|
2774
|
-
*
|
|
2693
|
+
* Discount coupon code.
|
|
2694
|
+
* @deprecated
|
|
2775
2695
|
*/
|
|
2776
|
-
|
|
2777
|
-
}
|
|
2778
|
-
/** @oneof */
|
|
2779
|
-
interface OptionSelectionSelectedOptionOneOf$4 {
|
|
2780
|
-
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
2781
|
-
optionIndex?: number;
|
|
2696
|
+
code?: string;
|
|
2782
2697
|
/**
|
|
2783
|
-
*
|
|
2784
|
-
*
|
|
2698
|
+
* Discount coupon name.
|
|
2699
|
+
* @deprecated
|
|
2785
2700
|
*/
|
|
2786
|
-
placeholderText?: string;
|
|
2787
|
-
}
|
|
2788
|
-
interface Label$4 {
|
|
2789
|
-
/** Field name. */
|
|
2790
2701
|
name?: string;
|
|
2791
|
-
/**
|
|
2792
|
-
|
|
2702
|
+
/**
|
|
2703
|
+
* Discount coupon ID.
|
|
2704
|
+
* @deprecated
|
|
2705
|
+
*/
|
|
2706
|
+
couponId?: string;
|
|
2707
|
+
/** Discount items. */
|
|
2708
|
+
discounts?: DiscountItem$1[];
|
|
2793
2709
|
}
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
*/
|
|
2798
|
-
|
|
2799
|
-
/**
|
|
2800
|
-
|
|
2801
|
-
/** Checkout form messages. */
|
|
2802
|
-
checkout?: CheckoutFormMessages$4;
|
|
2803
|
-
/** Messages shown when event registration is closed. */
|
|
2804
|
-
registrationClosed?: RegistrationClosedMessages$4;
|
|
2805
|
-
/** Messages shown when event tickets are unavailable. */
|
|
2806
|
-
ticketsUnavailable?: TicketsUnavailableMessages$4;
|
|
2710
|
+
interface DiscountItem$1 extends DiscountItemDiscountOneOf$1 {
|
|
2711
|
+
/** Coupon discount. */
|
|
2712
|
+
coupon?: CouponDiscount$1;
|
|
2713
|
+
/** Pricing plan discount. */
|
|
2714
|
+
paidPlan?: PaidPlanDiscount$1;
|
|
2715
|
+
/** Total discount amount. */
|
|
2716
|
+
amount?: Money$7;
|
|
2807
2717
|
}
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
positiveMessages?: Positive$4;
|
|
2815
|
-
/** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
|
|
2816
|
-
waitlistMessages?: Positive$4;
|
|
2817
|
-
/** Messages shown for RSVP = `NO`. */
|
|
2818
|
-
negativeMessages?: Negative$4;
|
|
2819
|
-
/** "Submit form" call-to-action label text. */
|
|
2820
|
-
submitActionLabel?: string;
|
|
2718
|
+
/** @oneof */
|
|
2719
|
+
interface DiscountItemDiscountOneOf$1 {
|
|
2720
|
+
/** Coupon discount. */
|
|
2721
|
+
coupon?: CouponDiscount$1;
|
|
2722
|
+
/** Pricing plan discount. */
|
|
2723
|
+
paidPlan?: PaidPlanDiscount$1;
|
|
2821
2724
|
}
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
addToCalendarActionLabel?: string;
|
|
2830
|
-
/** "Share event" call-to-action label text. */
|
|
2831
|
-
shareActionLabel?: string;
|
|
2725
|
+
interface CouponDiscount$1 {
|
|
2726
|
+
/** Discount coupon name. */
|
|
2727
|
+
name?: string;
|
|
2728
|
+
/** Discount coupon code. */
|
|
2729
|
+
code?: string;
|
|
2730
|
+
/** Discount coupon ID. */
|
|
2731
|
+
couponId?: string;
|
|
2832
2732
|
}
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
shareActionLabel?: string;
|
|
2733
|
+
interface PaidPlanDiscount$1 extends PaidPlanDiscountDiscountOneOf$1 {
|
|
2734
|
+
/** Discount by percentage applied to tickets. */
|
|
2735
|
+
percentDiscount?: PercentDiscount$1;
|
|
2736
|
+
/** Name of pricing plan. */
|
|
2737
|
+
name?: string;
|
|
2839
2738
|
}
|
|
2840
|
-
/**
|
|
2841
|
-
interface
|
|
2842
|
-
/**
|
|
2843
|
-
|
|
2844
|
-
/** Confirmation messages shown after registration. */
|
|
2845
|
-
confirmation?: PositiveResponseConfirmation$4;
|
|
2739
|
+
/** @oneof */
|
|
2740
|
+
interface PaidPlanDiscountDiscountOneOf$1 {
|
|
2741
|
+
/** Discount by percentage applied to tickets. */
|
|
2742
|
+
percentDiscount?: PercentDiscount$1;
|
|
2846
2743
|
}
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
confirmation?: NegativeResponseConfirmation$4;
|
|
2744
|
+
interface PercentDiscount$1 {
|
|
2745
|
+
/** Percent rate. */
|
|
2746
|
+
rate?: string;
|
|
2747
|
+
/** Number of discounted tickets. */
|
|
2748
|
+
quantityDiscounted?: number;
|
|
2853
2749
|
}
|
|
2854
|
-
interface
|
|
2855
|
-
/**
|
|
2856
|
-
|
|
2857
|
-
/**
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2750
|
+
interface Tax$1 {
|
|
2751
|
+
/** Tax type. */
|
|
2752
|
+
type?: TaxType$5;
|
|
2753
|
+
/**
|
|
2754
|
+
* Tax name.
|
|
2755
|
+
* @readonly
|
|
2756
|
+
*/
|
|
2757
|
+
name?: string;
|
|
2758
|
+
/** Tax rate. */
|
|
2759
|
+
rate?: string;
|
|
2760
|
+
/** Taxable amount. */
|
|
2761
|
+
taxable?: Money$7;
|
|
2762
|
+
/** Total tax amount. */
|
|
2763
|
+
amount?: Money$7;
|
|
2861
2764
|
}
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
/**
|
|
2873
|
-
|
|
2765
|
+
interface Fee$1 {
|
|
2766
|
+
/** Fee identifier. */
|
|
2767
|
+
name?: FeeName$1;
|
|
2768
|
+
/** How fee is calculated. */
|
|
2769
|
+
type?: FeeType$2;
|
|
2770
|
+
/**
|
|
2771
|
+
* Fee rate.
|
|
2772
|
+
* @readonly
|
|
2773
|
+
*/
|
|
2774
|
+
rate?: string;
|
|
2775
|
+
/** Total amount of fee charges. */
|
|
2776
|
+
amount?: Money$7;
|
|
2874
2777
|
}
|
|
2875
|
-
|
|
2876
|
-
/**
|
|
2877
|
-
|
|
2878
|
-
/** "Explore other events" call-to-action label text. */
|
|
2879
|
-
exploreEventsActionLabel?: string;
|
|
2778
|
+
declare enum FeeName$1 {
|
|
2779
|
+
/** Wix service fee charges applied to the line item. */
|
|
2780
|
+
WIX_FEE = "WIX_FEE"
|
|
2880
2781
|
}
|
|
2881
|
-
|
|
2882
|
-
/**
|
|
2883
|
-
|
|
2884
|
-
/**
|
|
2885
|
-
|
|
2782
|
+
declare enum FeeType$2 {
|
|
2783
|
+
/** Fee is added to the ticket price at checkout. */
|
|
2784
|
+
FEE_ADDED = "FEE_ADDED",
|
|
2785
|
+
/** Seller absorbs the fee. It is deducted from the ticket price. */
|
|
2786
|
+
FEE_INCLUDED = "FEE_INCLUDED",
|
|
2787
|
+
/** Fee is added to the ticket price at checkout. */
|
|
2788
|
+
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
2886
2789
|
}
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2790
|
+
/** Produced if a buyer email was added to the existing order */
|
|
2791
|
+
interface OrderEmailAdded {
|
|
2792
|
+
/** Order updated timestamp in ISO UTC format. */
|
|
2793
|
+
timestamp?: Date;
|
|
2794
|
+
/** Site language when Order initiated */
|
|
2795
|
+
language?: string | null;
|
|
2796
|
+
/** Locale in which Order was created. */
|
|
2797
|
+
locale?: string | null;
|
|
2798
|
+
/** Notifications silenced for this domain event. */
|
|
2799
|
+
silent?: boolean | null;
|
|
2800
|
+
/** Event ID. */
|
|
2801
|
+
eventId?: string;
|
|
2802
|
+
/** Unique order number. */
|
|
2803
|
+
orderNumber?: string;
|
|
2804
|
+
/** Contact ID associated with this order. */
|
|
2805
|
+
contactId?: string | null;
|
|
2806
|
+
/** Member ID associated with this order. */
|
|
2807
|
+
memberId?: string | null;
|
|
2890
2808
|
/**
|
|
2891
|
-
*
|
|
2892
|
-
*
|
|
2809
|
+
* Order created timestamp.
|
|
2810
|
+
* @readonly
|
|
2893
2811
|
*/
|
|
2894
|
-
|
|
2895
|
-
}
|
|
2896
|
-
interface RsvpSummary$5 {
|
|
2897
|
-
/** Total number of RSVPs. */
|
|
2898
|
-
total?: number;
|
|
2899
|
-
/** Number of RSVPs with status `YES`. */
|
|
2900
|
-
yes?: number;
|
|
2901
|
-
/** Number of RSVPs with status `NO`. */
|
|
2902
|
-
no?: number;
|
|
2903
|
-
/** Number of RSVPs in waitlist. */
|
|
2904
|
-
waitlist?: number;
|
|
2905
|
-
}
|
|
2906
|
-
interface TicketingSummary$4 {
|
|
2907
|
-
/** Number of tickets sold. */
|
|
2908
|
-
tickets?: number;
|
|
2812
|
+
created?: Date;
|
|
2909
2813
|
/**
|
|
2910
|
-
*
|
|
2911
|
-
*
|
|
2814
|
+
* Order updated timestamp.
|
|
2815
|
+
* @readonly
|
|
2912
2816
|
*/
|
|
2913
|
-
|
|
2914
|
-
/**
|
|
2915
|
-
|
|
2916
|
-
/**
|
|
2917
|
-
|
|
2918
|
-
/**
|
|
2919
|
-
|
|
2817
|
+
updated?: Date;
|
|
2818
|
+
/** Buyer first name. */
|
|
2819
|
+
firstName?: string | null;
|
|
2820
|
+
/** Buyer last name. */
|
|
2821
|
+
lastName?: string | null;
|
|
2822
|
+
/** Buyer email. */
|
|
2823
|
+
email?: string | null;
|
|
2824
|
+
/** Checkout form response. */
|
|
2825
|
+
checkoutForm?: FormResponse$4;
|
|
2826
|
+
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
2827
|
+
confirmed?: boolean;
|
|
2828
|
+
/** Order status. */
|
|
2829
|
+
status?: OrderStatus$2;
|
|
2830
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
2831
|
+
method?: string | null;
|
|
2832
|
+
/** Tickets generated after payment. */
|
|
2833
|
+
tickets?: Ticket$2[];
|
|
2834
|
+
/** Whether order was archived and excluded from results. */
|
|
2835
|
+
archived?: boolean;
|
|
2836
|
+
/** Reservation ID associated with this order. */
|
|
2837
|
+
reservationId?: string;
|
|
2920
2838
|
}
|
|
2921
|
-
interface
|
|
2922
|
-
/**
|
|
2923
|
-
|
|
2839
|
+
interface EventCanceled$2 {
|
|
2840
|
+
/** Event canceled timestamp in ISO UTC format. */
|
|
2841
|
+
timestamp?: Date;
|
|
2842
|
+
/** Event ID. */
|
|
2843
|
+
eventId?: string;
|
|
2844
|
+
/** Event title */
|
|
2845
|
+
title?: string;
|
|
2846
|
+
/** Event creator user ID. */
|
|
2847
|
+
userId?: string | null;
|
|
2924
2848
|
}
|
|
2925
|
-
interface
|
|
2926
|
-
/**
|
|
2927
|
-
|
|
2849
|
+
interface EventReminder$1 {
|
|
2850
|
+
/** Reminder timestamp in ISO UTC format. */
|
|
2851
|
+
timestamp?: Date;
|
|
2852
|
+
/** Event ID. */
|
|
2853
|
+
eventId?: string;
|
|
2854
|
+
/** Event location. */
|
|
2855
|
+
location?: Location$6;
|
|
2856
|
+
/** Event schedule configuration. */
|
|
2857
|
+
scheduleConfig?: ScheduleConfig$6;
|
|
2858
|
+
/** Event title. */
|
|
2859
|
+
title?: string;
|
|
2860
|
+
/** Event creator user ID. */
|
|
2861
|
+
userId?: string | null;
|
|
2862
|
+
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
2863
|
+
startsIn?: TimeDuration$1;
|
|
2928
2864
|
}
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2865
|
+
/**
|
|
2866
|
+
* A coarse-grained representation of time duration divided into whole constituting components of days, hours, and minutes.
|
|
2867
|
+
* For example, 25.5 hours duration is represented as `{ days: 1, hours: 1, minutes: 30 }`.
|
|
2868
|
+
*/
|
|
2869
|
+
interface TimeDuration$1 {
|
|
2870
|
+
/** Number of days. */
|
|
2871
|
+
days?: number;
|
|
2872
|
+
/** Number of hours. */
|
|
2873
|
+
hours?: number;
|
|
2874
|
+
/** Number of minutes. */
|
|
2875
|
+
minutes?: number;
|
|
2932
2876
|
}
|
|
2933
|
-
interface
|
|
2877
|
+
interface OrderPaid$1 {
|
|
2878
|
+
/** Order paid timestamp in ISO UTC. */
|
|
2879
|
+
timestamp?: Date;
|
|
2880
|
+
/** Site language when Order initiated */
|
|
2881
|
+
language?: string | null;
|
|
2882
|
+
/** Notifications silenced for this domain event. */
|
|
2883
|
+
silent?: boolean | null;
|
|
2884
|
+
/** Locale in which Order was created. */
|
|
2885
|
+
locale?: string | null;
|
|
2886
|
+
/** Event ID. */
|
|
2887
|
+
eventId?: string;
|
|
2888
|
+
/** Unique order number. */
|
|
2889
|
+
orderNumber?: string;
|
|
2890
|
+
/** Reservation ID associated with this order. */
|
|
2891
|
+
reservationId?: string;
|
|
2892
|
+
/** Contact ID associated with this order. */
|
|
2893
|
+
contactId?: string;
|
|
2894
|
+
/** Member ID associated with this order. */
|
|
2895
|
+
memberId?: string | null;
|
|
2934
2896
|
/**
|
|
2935
|
-
*
|
|
2936
|
-
*
|
|
2897
|
+
* Order created timestamp
|
|
2898
|
+
* @readonly
|
|
2937
2899
|
*/
|
|
2938
|
-
|
|
2939
|
-
/**
|
|
2940
|
-
|
|
2941
|
-
/**
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
/**
|
|
2946
|
-
|
|
2947
|
-
/**
|
|
2948
|
-
|
|
2900
|
+
created?: Date;
|
|
2901
|
+
/** Buyer first name. */
|
|
2902
|
+
firstName?: string;
|
|
2903
|
+
/** Buyer last name. */
|
|
2904
|
+
lastName?: string;
|
|
2905
|
+
/** Buyer email address. */
|
|
2906
|
+
email?: string;
|
|
2907
|
+
/** Checkout form response. */
|
|
2908
|
+
checkoutForm?: FormResponse$4;
|
|
2909
|
+
/** Order status. */
|
|
2910
|
+
status?: OrderStatus$2;
|
|
2911
|
+
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
2912
|
+
method?: string | null;
|
|
2913
|
+
/** Tickets (generated after payment). */
|
|
2914
|
+
tickets?: Ticket$2[];
|
|
2915
|
+
/** Invoice. */
|
|
2916
|
+
invoice?: Invoice$1;
|
|
2949
2917
|
}
|
|
2950
|
-
interface
|
|
2918
|
+
interface DomainEvent$8 extends DomainEventBodyOneOf$8 {
|
|
2919
|
+
createdEvent?: EntityCreatedEvent$8;
|
|
2920
|
+
updatedEvent?: EntityUpdatedEvent$8;
|
|
2921
|
+
deletedEvent?: EntityDeletedEvent$8;
|
|
2922
|
+
actionEvent?: ActionEvent$8;
|
|
2951
2923
|
/**
|
|
2952
|
-
*
|
|
2953
|
-
*
|
|
2924
|
+
* Unique event ID.
|
|
2925
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2954
2926
|
*/
|
|
2955
|
-
|
|
2927
|
+
_id?: string;
|
|
2956
2928
|
/**
|
|
2957
|
-
*
|
|
2958
|
-
*
|
|
2929
|
+
* Assumes actions are also always typed to an entity_type
|
|
2930
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2959
2931
|
*/
|
|
2960
|
-
|
|
2932
|
+
entityFqdn?: string;
|
|
2961
2933
|
/**
|
|
2962
|
-
*
|
|
2963
|
-
*
|
|
2934
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2935
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2936
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2964
2937
|
*/
|
|
2965
|
-
|
|
2938
|
+
slug?: string;
|
|
2939
|
+
/** ID of the entity associated with the event. */
|
|
2940
|
+
entityId?: string;
|
|
2941
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2942
|
+
eventTime?: Date;
|
|
2966
2943
|
/**
|
|
2967
|
-
*
|
|
2968
|
-
*
|
|
2944
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2945
|
+
* (for example, GDPR).
|
|
2969
2946
|
*/
|
|
2970
|
-
|
|
2947
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2948
|
+
/** If present, indicates the action that triggered the event. */
|
|
2949
|
+
originatedFrom?: string | null;
|
|
2971
2950
|
/**
|
|
2972
|
-
*
|
|
2973
|
-
*
|
|
2951
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2952
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2953
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2954
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2955
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2956
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2974
2957
|
*/
|
|
2975
|
-
|
|
2958
|
+
entityEventSequence?: string | null;
|
|
2976
2959
|
}
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
* Hidden from SEO Site Map
|
|
2984
|
-
* @readonly
|
|
2985
|
-
*/
|
|
2986
|
-
hidden?: boolean | null;
|
|
2960
|
+
/** @oneof */
|
|
2961
|
+
interface DomainEventBodyOneOf$8 {
|
|
2962
|
+
createdEvent?: EntityCreatedEvent$8;
|
|
2963
|
+
updatedEvent?: EntityUpdatedEvent$8;
|
|
2964
|
+
deletedEvent?: EntityDeletedEvent$8;
|
|
2965
|
+
actionEvent?: ActionEvent$8;
|
|
2987
2966
|
}
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
2991
|
-
* 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.
|
|
2992
|
-
*/
|
|
2993
|
-
interface SeoSchema$4 {
|
|
2994
|
-
/** SEO tag information. */
|
|
2995
|
-
tags?: Tag$4[];
|
|
2996
|
-
/** SEO general settings. */
|
|
2997
|
-
settings?: Settings$5;
|
|
2967
|
+
interface EntityCreatedEvent$8 {
|
|
2968
|
+
entity?: string;
|
|
2998
2969
|
}
|
|
2999
|
-
interface
|
|
3000
|
-
|
|
3001
|
-
term?: string;
|
|
3002
|
-
/** Whether the keyword is the main focus keyword. */
|
|
3003
|
-
isMain?: boolean;
|
|
3004
|
-
/** Who added the keyword to the settings */
|
|
3005
|
-
origin?: string | null;
|
|
2970
|
+
interface RestoreInfo$7 {
|
|
2971
|
+
deletedDate?: Date;
|
|
3006
2972
|
}
|
|
3007
|
-
interface
|
|
2973
|
+
interface EntityUpdatedEvent$8 {
|
|
3008
2974
|
/**
|
|
3009
|
-
*
|
|
3010
|
-
*
|
|
3011
|
-
*
|
|
3012
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
2975
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2976
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2977
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3013
2978
|
*/
|
|
3014
|
-
|
|
2979
|
+
currentEntity?: string;
|
|
2980
|
+
}
|
|
2981
|
+
interface EntityDeletedEvent$8 {
|
|
2982
|
+
/** Entity that was deleted */
|
|
2983
|
+
deletedEntity?: string | null;
|
|
2984
|
+
}
|
|
2985
|
+
interface ActionEvent$8 {
|
|
2986
|
+
body?: string;
|
|
2987
|
+
}
|
|
2988
|
+
interface TicketPdfResolved {
|
|
2989
|
+
/** Optional order number */
|
|
2990
|
+
orderNumber?: string | null;
|
|
2991
|
+
/** Optional ticket number */
|
|
2992
|
+
ticketNumber?: string | null;
|
|
2993
|
+
/** Resolved download url */
|
|
2994
|
+
downloadUrl?: string | null;
|
|
2995
|
+
/** Resolve status */
|
|
2996
|
+
resolveFailed?: boolean | null;
|
|
2997
|
+
/** Papyrus document id */
|
|
2998
|
+
documentId?: string | null;
|
|
2999
|
+
}
|
|
3000
|
+
interface TicketPdfResolveDelayed {
|
|
3001
|
+
/** Optional order number */
|
|
3002
|
+
orderNumber?: string | null;
|
|
3003
|
+
/** Optional ticket number */
|
|
3004
|
+
ticketNumber?: string | null;
|
|
3005
|
+
/** Papyrus document id */
|
|
3006
|
+
documentId?: string | null;
|
|
3007
|
+
}
|
|
3008
|
+
interface OrderCanceled {
|
|
3009
|
+
/** Event ID. */
|
|
3010
|
+
eventId?: string;
|
|
3011
|
+
/** Unique order number. */
|
|
3012
|
+
orderNumber?: string;
|
|
3013
|
+
/** Reservation ID associated with this order. */
|
|
3014
|
+
reservationId?: string;
|
|
3015
|
+
/** Contact ID associated with this order. */
|
|
3016
|
+
contactId?: string;
|
|
3017
|
+
/** Buyer first name. */
|
|
3018
|
+
firstName?: string | null;
|
|
3019
|
+
/** Buyer last name. */
|
|
3020
|
+
lastName?: string | null;
|
|
3021
|
+
/** Buyer email address. */
|
|
3022
|
+
email?: string | null;
|
|
3023
|
+
/** Checkout form response. */
|
|
3024
|
+
checkoutForm?: FormResponse$4;
|
|
3025
|
+
/** Invoice. */
|
|
3026
|
+
invoice?: Invoice$1;
|
|
3027
|
+
}
|
|
3028
|
+
interface EventEnded$2 {
|
|
3029
|
+
/** Event end timestamp in ISO UTC format. */
|
|
3030
|
+
timestamp?: Date;
|
|
3031
|
+
/** Event ID. */
|
|
3032
|
+
eventId?: string;
|
|
3033
|
+
}
|
|
3034
|
+
interface EventStarted$1 {
|
|
3035
|
+
/** Event start timestamp in ISO UTC format. */
|
|
3036
|
+
timestamp?: Date;
|
|
3037
|
+
/** Event ID. */
|
|
3038
|
+
eventId?: string;
|
|
3039
|
+
}
|
|
3040
|
+
interface UpdatedWithPreviousEntity {
|
|
3041
|
+
/** previous automation */
|
|
3042
|
+
previousAutomation?: Automation;
|
|
3043
|
+
/** updated automation */
|
|
3044
|
+
currentAutomation?: Automation;
|
|
3045
|
+
}
|
|
3046
|
+
interface Automation extends AutomationOriginInfoOneOf {
|
|
3047
|
+
/** Application info */
|
|
3048
|
+
applicationInfo?: ApplicationOrigin;
|
|
3049
|
+
/** Preinstalled info */
|
|
3050
|
+
preinstalledInfo?: PreinstalledOrigin;
|
|
3015
3051
|
/**
|
|
3016
|
-
*
|
|
3017
|
-
*
|
|
3052
|
+
* Automation ID.
|
|
3053
|
+
* @readonly
|
|
3018
3054
|
*/
|
|
3019
|
-
|
|
3020
|
-
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
3021
|
-
meta?: Record<string, any> | null;
|
|
3022
|
-
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
3023
|
-
children?: string;
|
|
3024
|
-
/** Whether the tag is a custom tag. */
|
|
3025
|
-
custom?: boolean;
|
|
3026
|
-
/** Whether the tag is disabled. */
|
|
3027
|
-
disabled?: boolean;
|
|
3028
|
-
}
|
|
3029
|
-
interface Settings$5 {
|
|
3055
|
+
_id?: string | null;
|
|
3030
3056
|
/**
|
|
3031
|
-
*
|
|
3032
|
-
*
|
|
3057
|
+
* Revision number, which increments by 1 each time the automation is updated.
|
|
3058
|
+
* To prevent conflicting changes,
|
|
3059
|
+
* the current revision must be passed when updating the automation.
|
|
3033
3060
|
*
|
|
3034
|
-
*
|
|
3061
|
+
* Ignored when creating an automation.
|
|
3062
|
+
* @readonly
|
|
3035
3063
|
*/
|
|
3036
|
-
|
|
3037
|
-
/** User-selected keyword terms for a specific page. */
|
|
3038
|
-
keywords?: Keyword$4[];
|
|
3039
|
-
}
|
|
3040
|
-
interface Agenda$4 {
|
|
3041
|
-
/** Whether the schedule is enabled for the event. */
|
|
3042
|
-
enabled?: boolean;
|
|
3064
|
+
revision?: string | null;
|
|
3043
3065
|
/**
|
|
3044
|
-
*
|
|
3066
|
+
* Information about the creator of the automation.
|
|
3045
3067
|
* @readonly
|
|
3046
3068
|
*/
|
|
3047
|
-
|
|
3048
|
-
}
|
|
3049
|
-
interface Category$5 {
|
|
3069
|
+
createdBy?: AuditInfo;
|
|
3050
3070
|
/**
|
|
3051
|
-
*
|
|
3071
|
+
* Date and time the automation was created.
|
|
3052
3072
|
* @readonly
|
|
3053
3073
|
*/
|
|
3054
|
-
|
|
3055
|
-
/** Category name. */
|
|
3056
|
-
name?: string;
|
|
3074
|
+
_createdDate?: Date;
|
|
3057
3075
|
/**
|
|
3058
|
-
*
|
|
3076
|
+
* The entity that last updated the automation.
|
|
3059
3077
|
* @readonly
|
|
3060
3078
|
*/
|
|
3061
|
-
|
|
3079
|
+
updatedBy?: AuditInfo;
|
|
3062
3080
|
/**
|
|
3063
|
-
*
|
|
3081
|
+
* Date and time the automation was last updated.
|
|
3064
3082
|
* @readonly
|
|
3065
3083
|
*/
|
|
3066
|
-
|
|
3084
|
+
_updatedDate?: Date;
|
|
3085
|
+
/** Automation name that is displayed on the user's site. */
|
|
3086
|
+
name?: string;
|
|
3087
|
+
/** Automation description. */
|
|
3088
|
+
description?: string | null;
|
|
3089
|
+
/** Object that defines the automation's trigger, actions, and activation status. */
|
|
3090
|
+
configuration?: AutomationConfiguration;
|
|
3091
|
+
/** Defines how the automation was added to the site. */
|
|
3092
|
+
origin?: Origin;
|
|
3093
|
+
/** Automation settings. */
|
|
3094
|
+
settings?: AutomationSettings;
|
|
3067
3095
|
/**
|
|
3068
|
-
*
|
|
3069
|
-
*
|
|
3070
|
-
* `MANUAL`: Category is created manually by the user.
|
|
3071
|
-
* `AUTO`: Category is created automatically.
|
|
3072
|
-
* `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
|
|
3073
|
-
* `HIDDEN`: Category can't be seen.
|
|
3074
|
-
*
|
|
3075
|
-
* Default: `MANUAL`.
|
|
3076
|
-
*
|
|
3077
|
-
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
3096
|
+
* Draft info (optional - only if the automation is a draft)
|
|
3097
|
+
* @readonly
|
|
3078
3098
|
*/
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
/** Total number of draft events assigned to the category. */
|
|
3083
|
-
assignedEventsCount?: number | null;
|
|
3084
|
-
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
3085
|
-
assignedDraftEventsCount?: number | null;
|
|
3086
|
-
}
|
|
3087
|
-
declare enum State$8 {
|
|
3088
|
-
/** Created manually by the user. */
|
|
3089
|
-
MANUAL = "MANUAL",
|
|
3090
|
-
/** Created automatically. */
|
|
3091
|
-
AUTO = "AUTO",
|
|
3092
|
-
/** Created when publishing recurring events. */
|
|
3093
|
-
RECURRING_EVENT = "RECURRING_EVENT",
|
|
3094
|
-
/** Category is hidden. */
|
|
3095
|
-
HIDDEN = "HIDDEN",
|
|
3096
|
-
/** Category is used to store component events. */
|
|
3097
|
-
COMPONENT = "COMPONENT"
|
|
3098
|
-
}
|
|
3099
|
-
interface EventDisplaySettings$4 {
|
|
3100
|
-
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
3101
|
-
hideEventDetailsButton?: boolean | null;
|
|
3099
|
+
draftInfo?: DraftInfo;
|
|
3100
|
+
/** Namespace */
|
|
3101
|
+
namespace?: string | null;
|
|
3102
3102
|
}
|
|
3103
|
-
|
|
3103
|
+
/** @oneof */
|
|
3104
|
+
interface AutomationOriginInfoOneOf {
|
|
3105
|
+
/** Application info */
|
|
3106
|
+
applicationInfo?: ApplicationOrigin;
|
|
3107
|
+
/** Preinstalled info */
|
|
3108
|
+
preinstalledInfo?: PreinstalledOrigin;
|
|
3104
3109
|
}
|
|
3105
|
-
interface
|
|
3106
|
-
/** Order confirmation timestamp in ISO UTC. */
|
|
3107
|
-
timestamp?: Date;
|
|
3108
|
-
/** Site language when Order initiated */
|
|
3109
|
-
language?: string | null;
|
|
3110
|
-
/** Notifications silenced for this domain event. */
|
|
3111
|
-
silent?: boolean | null;
|
|
3112
|
-
/** Locale in which Order was created. */
|
|
3113
|
-
locale?: string | null;
|
|
3114
|
-
/** Event ID. */
|
|
3115
|
-
eventId?: string;
|
|
3116
|
-
/** Unique order number. */
|
|
3117
|
-
orderNumber?: string;
|
|
3118
|
-
/** Contact ID associated with this order. */
|
|
3119
|
-
contactId?: string;
|
|
3120
|
-
/** Member ID associated with this order. */
|
|
3121
|
-
memberId?: string | null;
|
|
3110
|
+
interface ActionSettings {
|
|
3122
3111
|
/**
|
|
3123
|
-
*
|
|
3124
|
-
*
|
|
3112
|
+
* List of actions that cannot be deleted.
|
|
3113
|
+
* Default: Empty. All actions are deletable by default.
|
|
3125
3114
|
*/
|
|
3126
|
-
|
|
3127
|
-
/**
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
|
|
3131
|
-
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
status?: OrderStatus$2;
|
|
3137
|
-
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
3138
|
-
method?: string | null;
|
|
3139
|
-
/** Tickets (generated after payment). */
|
|
3140
|
-
tickets?: Ticket$2[];
|
|
3141
|
-
/** Invoice. */
|
|
3142
|
-
invoice?: Invoice$1;
|
|
3143
|
-
/** Reservation ID associated with this order. */
|
|
3144
|
-
reservationId?: string;
|
|
3115
|
+
permanentActionIds?: string[];
|
|
3116
|
+
/**
|
|
3117
|
+
* List of actions that cannot be edited.
|
|
3118
|
+
* Default: Empty. All actions are editable by default.
|
|
3119
|
+
*/
|
|
3120
|
+
readonlyActionIds?: string[];
|
|
3121
|
+
/** Whether the option to add a delay is disabled for the automation. */
|
|
3122
|
+
disableDelayAddition?: boolean;
|
|
3123
|
+
/** Whether the option to add a condition is disabled for the automation. */
|
|
3124
|
+
disableConditionAddition?: boolean;
|
|
3145
3125
|
}
|
|
3146
|
-
|
|
3147
|
-
/**
|
|
3148
|
-
|
|
3149
|
-
/**
|
|
3150
|
-
|
|
3151
|
-
/** Order was paid but payment gateway suspended the payment. Eventually changes to PAID */
|
|
3152
|
-
PENDING = "PENDING",
|
|
3153
|
-
/** Order paid via payment gateway */
|
|
3154
|
-
PAID = "PAID",
|
|
3155
|
-
/** Order confirmed but has to be paid via offline payment and status manually updated to PAID */
|
|
3156
|
-
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
3157
|
-
/** Order is awaiting for payment in Cashier */
|
|
3158
|
-
INITIATED = "INITIATED",
|
|
3159
|
-
/** Order was canceled */
|
|
3160
|
-
CANCELED = "CANCELED",
|
|
3161
|
-
/** Order payment was declined */
|
|
3162
|
-
DECLINED = "DECLINED"
|
|
3126
|
+
interface AuditInfo extends AuditInfoIdOneOf {
|
|
3127
|
+
/** User ID. */
|
|
3128
|
+
userId?: string;
|
|
3129
|
+
/** Application ID. */
|
|
3130
|
+
appId?: string;
|
|
3163
3131
|
}
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
checkIn?: CheckIn$3;
|
|
3171
|
-
/** Ticket price. */
|
|
3172
|
-
price?: Money$7;
|
|
3173
|
-
/** Whether ticket is archived. */
|
|
3174
|
-
archived?: boolean;
|
|
3175
|
-
/** Guest first name. */
|
|
3176
|
-
firstName?: string | null;
|
|
3177
|
-
/** Guest last name. */
|
|
3178
|
-
lastName?: string | null;
|
|
3179
|
-
/** Guest email. */
|
|
3180
|
-
email?: string | null;
|
|
3181
|
-
/** Contact ID associated with this ticket. */
|
|
3182
|
-
contactId?: string | null;
|
|
3183
|
-
/** Whether ticket is confirmed */
|
|
3184
|
-
confirmed?: boolean;
|
|
3185
|
-
/** Member ID associated with this ticket. */
|
|
3186
|
-
memberId?: string | null;
|
|
3187
|
-
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
3188
|
-
form?: FormResponse$4;
|
|
3189
|
-
/** Ticket name. */
|
|
3190
|
-
ticketName?: string;
|
|
3191
|
-
/** Anonymized tickets no longer contain personally identifiable information (PII). */
|
|
3192
|
-
anonymized?: boolean;
|
|
3193
|
-
/** URL and password to online conference */
|
|
3194
|
-
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
3132
|
+
/** @oneof */
|
|
3133
|
+
interface AuditInfoIdOneOf {
|
|
3134
|
+
/** User ID. */
|
|
3135
|
+
userId?: string;
|
|
3136
|
+
/** Application ID. */
|
|
3137
|
+
appId?: string;
|
|
3195
3138
|
}
|
|
3196
|
-
|
|
3197
|
-
|
|
3139
|
+
/** Automation runtime configuration */
|
|
3140
|
+
interface AutomationConfiguration {
|
|
3141
|
+
/** Status of the automation on the site. */
|
|
3142
|
+
status?: Status$7;
|
|
3143
|
+
/** Automation trigger configuration. */
|
|
3144
|
+
trigger?: Trigger;
|
|
3145
|
+
/** List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel. */
|
|
3146
|
+
rootActionIds?: string[];
|
|
3198
3147
|
/**
|
|
3199
|
-
*
|
|
3200
|
-
*
|
|
3148
|
+
* Map of all actions that the automation may execute.
|
|
3149
|
+
* The key is the action ID, and the value is the action configuration.
|
|
3201
3150
|
*/
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3151
|
+
actions?: Record<string, Action$1>;
|
|
3152
|
+
}
|
|
3153
|
+
declare enum TimeUnit {
|
|
3154
|
+
UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
|
|
3155
|
+
MINUTES = "MINUTES",
|
|
3156
|
+
HOURS = "HOURS",
|
|
3157
|
+
DAYS = "DAYS",
|
|
3158
|
+
WEEKS = "WEEKS",
|
|
3159
|
+
MONTHS = "MONTHS"
|
|
3160
|
+
}
|
|
3161
|
+
interface Filter {
|
|
3162
|
+
/** Filter ID. */
|
|
3163
|
+
_id?: string;
|
|
3164
|
+
/** Field key from the payload schema, for example "formId". */
|
|
3165
|
+
fieldKey?: string;
|
|
3166
|
+
/** Filter expression that evaluates to a boolean. */
|
|
3167
|
+
filterExpression?: string;
|
|
3168
|
+
}
|
|
3169
|
+
interface FutureDateActivationOffset {
|
|
3209
3170
|
/**
|
|
3210
|
-
*
|
|
3211
|
-
*
|
|
3212
|
-
* 1. Total prices of all items in the cart are calculated.
|
|
3213
|
-
* 2. Discount is subtracted from the cart (if applicable).
|
|
3214
|
-
* 3. Tax is added (if applicable).
|
|
3215
|
-
* 4. Wix service fee is added.
|
|
3171
|
+
* The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
|
|
3172
|
+
* To create an offset that causes the automation to run after the trigger date, use a delay action.
|
|
3216
3173
|
*/
|
|
3217
|
-
|
|
3174
|
+
preScheduledEventOffsetExpression?: string;
|
|
3175
|
+
/** Time unit for the scheduled event offset. */
|
|
3176
|
+
scheduledEventOffsetTimeUnit?: TimeUnit;
|
|
3177
|
+
}
|
|
3178
|
+
interface RateLimit {
|
|
3179
|
+
/** Value expressing the maximum number of times the trigger can be activated. */
|
|
3180
|
+
maxActivationsExpression?: string;
|
|
3181
|
+
/** Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent. */
|
|
3182
|
+
durationExpression?: string | null;
|
|
3183
|
+
/** Time unit for the rate limit duration. */
|
|
3184
|
+
durationTimeUnit?: TimeUnit;
|
|
3185
|
+
/** Unique identifier of each activation, by which rate limiter will count activations. */
|
|
3186
|
+
uniqueIdentifierExpression?: string | null;
|
|
3187
|
+
}
|
|
3188
|
+
interface ConditionExpressionGroup {
|
|
3189
|
+
/** Expression group operator. */
|
|
3190
|
+
operator?: Operator;
|
|
3191
|
+
/** List of boolean expressions to be evaluated with the given operator. */
|
|
3192
|
+
booleanExpressions?: string[];
|
|
3193
|
+
}
|
|
3194
|
+
declare enum Operator {
|
|
3195
|
+
UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
|
|
3196
|
+
OR = "OR",
|
|
3197
|
+
AND = "AND"
|
|
3198
|
+
}
|
|
3199
|
+
declare enum Type$5 {
|
|
3200
|
+
/** Automation will be triggered according to the trigger configuration */
|
|
3201
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
3202
|
+
/** App defined Action */
|
|
3203
|
+
APP_DEFINED = "APP_DEFINED",
|
|
3204
|
+
/** Condition Action */
|
|
3205
|
+
CONDITION = "CONDITION",
|
|
3206
|
+
/** Delay Action */
|
|
3207
|
+
DELAY = "DELAY",
|
|
3208
|
+
/** RateLimit Action */
|
|
3209
|
+
RATE_LIMIT = "RATE_LIMIT",
|
|
3210
|
+
/** Output Action */
|
|
3211
|
+
OUTPUT = "OUTPUT"
|
|
3212
|
+
}
|
|
3213
|
+
interface AppDefinedAction {
|
|
3214
|
+
/** ID of the app that defines the action. */
|
|
3215
|
+
appId?: string;
|
|
3216
|
+
/** Action key. */
|
|
3217
|
+
actionKey?: string;
|
|
3218
|
+
/** Action input mapping. */
|
|
3219
|
+
inputMapping?: Record<string, any> | null;
|
|
3218
3220
|
/**
|
|
3219
|
-
*
|
|
3220
|
-
*
|
|
3221
|
+
* Array of conditions determining whether to skip the action in the automation flow.
|
|
3222
|
+
* The action will be skipped if any of the expression groups evaluate to `true`.
|
|
3223
|
+
* Actions following a skipped action will still run.
|
|
3221
3224
|
*/
|
|
3222
|
-
|
|
3223
|
-
/**
|
|
3224
|
-
|
|
3225
|
-
/** URL to invoice preview. Returned only if order is paid. */
|
|
3226
|
-
previewUrl?: string | null;
|
|
3225
|
+
skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
|
|
3226
|
+
/** List of IDs of actions to run in parallel once the action completes. */
|
|
3227
|
+
postActionIds?: string[];
|
|
3227
3228
|
}
|
|
3228
|
-
interface
|
|
3229
|
-
/**
|
|
3230
|
-
|
|
3231
|
-
/**
|
|
3232
|
-
|
|
3233
|
-
/**
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
/**
|
|
3238
|
-
|
|
3239
|
-
/**
|
|
3240
|
-
|
|
3241
|
-
/** Tax applied to the item. */
|
|
3242
|
-
tax?: Tax$1;
|
|
3229
|
+
interface ConditionAction {
|
|
3230
|
+
/** The condition evaluates to `true` if either of the expression groups evaluate to `true`. */
|
|
3231
|
+
orExpressionGroups?: ConditionExpressionGroup[];
|
|
3232
|
+
/** List of IDs of actions to run when the entire condition is evaluated to `true`. */
|
|
3233
|
+
truePostActionIds?: string[];
|
|
3234
|
+
/** List of IDs of actions to run when the entire condition is evaluated to `false`. */
|
|
3235
|
+
falsePostActionIds?: string[];
|
|
3236
|
+
}
|
|
3237
|
+
interface DelayAction {
|
|
3238
|
+
/** Value expressing the amount of time to wait from a specific date or from the time the action is executed. */
|
|
3239
|
+
offsetExpression?: string | null;
|
|
3240
|
+
/** Time unit for delay offset. */
|
|
3241
|
+
offsetTimeUnit?: TimeUnit;
|
|
3243
3242
|
/**
|
|
3244
|
-
*
|
|
3245
|
-
*
|
|
3243
|
+
* The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
|
|
3244
|
+
* If an offset is defined, it's calculated from this date.
|
|
3245
|
+
* The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
|
|
3246
3246
|
*/
|
|
3247
|
-
|
|
3247
|
+
dueDateEpochExpression?: string | null;
|
|
3248
|
+
/** List of IDs of actions to run in parallel after the delay. */
|
|
3249
|
+
postActionIds?: string[];
|
|
3248
3250
|
}
|
|
3249
|
-
interface
|
|
3250
|
-
/**
|
|
3251
|
-
|
|
3252
|
-
/** Total charge after applied discount. */
|
|
3253
|
-
afterDiscount?: Money$7;
|
|
3251
|
+
interface RateLimitAction {
|
|
3252
|
+
/** The maximum number of activations allowed for the action. */
|
|
3253
|
+
maxActivationsExpression?: string;
|
|
3254
3254
|
/**
|
|
3255
|
-
*
|
|
3256
|
-
*
|
|
3255
|
+
* Duration of the rate limiting window, expressed in selected time unit.
|
|
3256
|
+
* If no value is set, then there is no time limit on the rate limiter.
|
|
3257
3257
|
*/
|
|
3258
|
-
|
|
3258
|
+
rateLimitDurationExpression?: string | null;
|
|
3259
|
+
/** Time unit for the rate limit duration. */
|
|
3260
|
+
rateLimitDurationTimeUnit?: TimeUnit;
|
|
3261
|
+
/** Unique identifier of each activation by which rate limiter counts activations. */
|
|
3262
|
+
uniqueIdentifierExpression?: string | null;
|
|
3263
|
+
/** List of IDs of actions to run in parallel once the action completes. */
|
|
3264
|
+
postActionIds?: string[];
|
|
3265
|
+
}
|
|
3266
|
+
interface OutputAction {
|
|
3267
|
+
/** Output action output mapping. */
|
|
3268
|
+
outputMapping?: Record<string, any> | null;
|
|
3269
|
+
}
|
|
3270
|
+
declare enum Status$7 {
|
|
3271
|
+
/** unused */
|
|
3272
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3273
|
+
/** Automation will be triggered according to the trigger configuration */
|
|
3274
|
+
ACTIVE = "ACTIVE",
|
|
3275
|
+
/** Automation will not be triggered */
|
|
3276
|
+
INACTIVE = "INACTIVE"
|
|
3277
|
+
}
|
|
3278
|
+
interface Trigger {
|
|
3279
|
+
/** ID of the app that defines the trigger. */
|
|
3280
|
+
appId?: string;
|
|
3281
|
+
/** Trigger key. */
|
|
3282
|
+
triggerKey?: string;
|
|
3259
3283
|
/**
|
|
3260
|
-
*
|
|
3261
|
-
*
|
|
3284
|
+
* List of filters on schema fields.
|
|
3285
|
+
* In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
|
|
3262
3286
|
*/
|
|
3263
|
-
|
|
3287
|
+
filters?: Filter[];
|
|
3288
|
+
/** Defines the time offset between the trigger date and when the automation runs. */
|
|
3289
|
+
scheduledEventOffset?: FutureDateActivationOffset;
|
|
3290
|
+
/** Limits the number of times an automation can be triggered. */
|
|
3291
|
+
rateLimit?: RateLimit;
|
|
3292
|
+
automationConfigMapping?: Record<string, any> | null;
|
|
3293
|
+
}
|
|
3294
|
+
interface Action$1 extends ActionInfoOneOf {
|
|
3295
|
+
/** Action defined by an app (via RPC, HTTP or Velo). */
|
|
3296
|
+
appDefinedInfo?: AppDefinedAction;
|
|
3297
|
+
/** Condition action. */
|
|
3298
|
+
conditionInfo?: ConditionAction;
|
|
3299
|
+
/** Delay action. */
|
|
3300
|
+
delayInfo?: DelayAction;
|
|
3301
|
+
/** Rate-limiting action. */
|
|
3302
|
+
rateLimitInfo?: RateLimitAction;
|
|
3303
|
+
/** Action ID. If not specified, a new ID is generated. */
|
|
3304
|
+
_id?: string | null;
|
|
3305
|
+
/** Action type. */
|
|
3306
|
+
type?: Type$5;
|
|
3264
3307
|
/**
|
|
3265
|
-
*
|
|
3266
|
-
*
|
|
3308
|
+
* Human-readable name to differentiate the action from other actions of the same type.
|
|
3309
|
+
* The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
|
|
3310
|
+
* generated automatically.
|
|
3311
|
+
* If the action has output, the output will be available in the payload under this name.
|
|
3312
|
+
* If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
|
|
3267
3313
|
*/
|
|
3268
|
-
|
|
3269
|
-
/** Discount items. */
|
|
3270
|
-
discounts?: DiscountItem$1[];
|
|
3271
|
-
}
|
|
3272
|
-
interface DiscountItem$1 extends DiscountItemDiscountOneOf$1 {
|
|
3273
|
-
/** Coupon discount. */
|
|
3274
|
-
coupon?: CouponDiscount$1;
|
|
3275
|
-
/** Pricing plan discount. */
|
|
3276
|
-
paidPlan?: PaidPlanDiscount$1;
|
|
3277
|
-
/** Total discount amount. */
|
|
3278
|
-
amount?: Money$7;
|
|
3314
|
+
namespace?: string | null;
|
|
3279
3315
|
}
|
|
3280
3316
|
/** @oneof */
|
|
3281
|
-
interface
|
|
3282
|
-
/**
|
|
3283
|
-
|
|
3284
|
-
/**
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
|
|
3288
|
-
/**
|
|
3289
|
-
|
|
3290
|
-
/** Discount coupon code. */
|
|
3291
|
-
code?: string;
|
|
3292
|
-
/** Discount coupon ID. */
|
|
3293
|
-
couponId?: string;
|
|
3317
|
+
interface ActionInfoOneOf {
|
|
3318
|
+
/** Action defined by an app (via RPC, HTTP or Velo). */
|
|
3319
|
+
appDefinedInfo?: AppDefinedAction;
|
|
3320
|
+
/** Condition action. */
|
|
3321
|
+
conditionInfo?: ConditionAction;
|
|
3322
|
+
/** Delay action. */
|
|
3323
|
+
delayInfo?: DelayAction;
|
|
3324
|
+
/** Rate-limiting action. */
|
|
3325
|
+
rateLimitInfo?: RateLimitAction;
|
|
3294
3326
|
}
|
|
3295
|
-
|
|
3296
|
-
/**
|
|
3297
|
-
|
|
3298
|
-
/**
|
|
3299
|
-
|
|
3327
|
+
declare enum Origin {
|
|
3328
|
+
/** default value. this is unused */
|
|
3329
|
+
UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
|
|
3330
|
+
/** user created automation */
|
|
3331
|
+
USER = "USER",
|
|
3332
|
+
/** automation created by application (site specific) */
|
|
3333
|
+
APPLICATION = "APPLICATION",
|
|
3334
|
+
/** preinstalled application automation */
|
|
3335
|
+
PREINSTALLED = "PREINSTALLED"
|
|
3300
3336
|
}
|
|
3301
|
-
|
|
3302
|
-
|
|
3303
|
-
|
|
3304
|
-
percentDiscount?: PercentDiscount$1;
|
|
3337
|
+
interface ApplicationOrigin {
|
|
3338
|
+
/** Application ID. */
|
|
3339
|
+
appId?: string;
|
|
3305
3340
|
}
|
|
3306
|
-
interface
|
|
3307
|
-
/**
|
|
3308
|
-
|
|
3309
|
-
/**
|
|
3310
|
-
|
|
3341
|
+
interface PreinstalledOrigin {
|
|
3342
|
+
/** ID of the app that defines the preinstalled automation. */
|
|
3343
|
+
appId?: string;
|
|
3344
|
+
/** Application component ID. */
|
|
3345
|
+
componentId?: string;
|
|
3346
|
+
/** Application component version. */
|
|
3347
|
+
componentVersion?: number;
|
|
3348
|
+
/**
|
|
3349
|
+
* Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
|
|
3350
|
+
* automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
|
|
3351
|
+
* preinstalled automation is used.
|
|
3352
|
+
*
|
|
3353
|
+
* Default: `false`
|
|
3354
|
+
* @readonly
|
|
3355
|
+
*/
|
|
3356
|
+
override?: boolean | null;
|
|
3311
3357
|
}
|
|
3312
|
-
interface
|
|
3313
|
-
/** Tax type. */
|
|
3314
|
-
type?: TaxType$5;
|
|
3358
|
+
interface AutomationSettings {
|
|
3315
3359
|
/**
|
|
3316
|
-
*
|
|
3317
|
-
*
|
|
3360
|
+
* Whether the automation is hidden from users.
|
|
3361
|
+
* Default: `false`
|
|
3318
3362
|
*/
|
|
3319
|
-
|
|
3320
|
-
/**
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3324
|
-
|
|
3325
|
-
|
|
3363
|
+
hidden?: boolean;
|
|
3364
|
+
/**
|
|
3365
|
+
* Whether the automation is read-only.
|
|
3366
|
+
* Default: `false`
|
|
3367
|
+
*/
|
|
3368
|
+
readonly?: boolean;
|
|
3369
|
+
/**
|
|
3370
|
+
* Whether the option to delete the automation from the site is disabled.
|
|
3371
|
+
* Default: `false`
|
|
3372
|
+
*/
|
|
3373
|
+
disableDelete?: boolean;
|
|
3374
|
+
/**
|
|
3375
|
+
* Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
|
|
3376
|
+
* Default: `false`
|
|
3377
|
+
*/
|
|
3378
|
+
disableStatusChange?: boolean;
|
|
3379
|
+
/** Automation action settings. */
|
|
3380
|
+
actionSettings?: ActionSettings;
|
|
3326
3381
|
}
|
|
3327
|
-
interface
|
|
3328
|
-
/** Fee identifier. */
|
|
3329
|
-
name?: FeeName$1;
|
|
3330
|
-
/** How fee is calculated. */
|
|
3331
|
-
type?: FeeType$2;
|
|
3382
|
+
interface DraftInfo {
|
|
3332
3383
|
/**
|
|
3333
|
-
*
|
|
3384
|
+
* optional - automationId of the original automation
|
|
3334
3385
|
* @readonly
|
|
3335
3386
|
*/
|
|
3336
|
-
|
|
3337
|
-
/** Total amount of fee charges. */
|
|
3338
|
-
amount?: Money$7;
|
|
3387
|
+
originalAutomationId?: string | null;
|
|
3339
3388
|
}
|
|
3340
|
-
|
|
3341
|
-
/**
|
|
3342
|
-
|
|
3389
|
+
interface DeletedWithEntity {
|
|
3390
|
+
/** Deleted automation */
|
|
3391
|
+
automation?: Automation;
|
|
3343
3392
|
}
|
|
3344
|
-
|
|
3345
|
-
/**
|
|
3346
|
-
|
|
3347
|
-
/**
|
|
3348
|
-
|
|
3349
|
-
/** Fee is added to the ticket price at checkout. */
|
|
3350
|
-
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
3393
|
+
interface GuestCountUpdated {
|
|
3394
|
+
/** Guest. */
|
|
3395
|
+
guest?: EventGuest;
|
|
3396
|
+
/** Guest count updates. */
|
|
3397
|
+
guestCountUpdates?: GuestCountUpdate[];
|
|
3351
3398
|
}
|
|
3352
|
-
|
|
3353
|
-
|
|
3354
|
-
|
|
3355
|
-
timestamp?: Date;
|
|
3356
|
-
/** Site language when Order initiated */
|
|
3357
|
-
language?: string | null;
|
|
3358
|
-
/** Locale in which Order was created. */
|
|
3359
|
-
locale?: string | null;
|
|
3360
|
-
/** Notifications silenced for this domain event. */
|
|
3361
|
-
silent?: boolean | null;
|
|
3399
|
+
interface EventGuest {
|
|
3400
|
+
/** Guest ID. */
|
|
3401
|
+
_id?: string | null;
|
|
3362
3402
|
/** Event ID. */
|
|
3363
|
-
eventId?: string;
|
|
3364
|
-
/**
|
|
3365
|
-
|
|
3366
|
-
/**
|
|
3403
|
+
eventId?: string | null;
|
|
3404
|
+
/** RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`. */
|
|
3405
|
+
rsvpId?: string | null;
|
|
3406
|
+
/** Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`. */
|
|
3407
|
+
orderNumber?: string | null;
|
|
3408
|
+
/** Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`. */
|
|
3409
|
+
ticketNumber?: string | null;
|
|
3410
|
+
/** List of names, numbers, and definition IDs for each ticket. */
|
|
3411
|
+
tickets?: TicketDetails$2[];
|
|
3412
|
+
/** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
|
|
3367
3413
|
contactId?: string | null;
|
|
3368
|
-
/**
|
|
3414
|
+
/** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
|
|
3415
|
+
guestDetails?: GuestDetails$2;
|
|
3416
|
+
/** Attendance status. The attendaces status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
|
|
3417
|
+
attendanceStatus?: AttendanceStatus;
|
|
3418
|
+
/** Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. */
|
|
3419
|
+
secondaryLanguageCode?: string | null;
|
|
3420
|
+
/** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
3421
|
+
_createdDate?: Date;
|
|
3422
|
+
/** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
3423
|
+
_updatedDate?: Date;
|
|
3424
|
+
/** Date and time of guest's latest attendance status update. */
|
|
3425
|
+
attendanceStatusUpdatedDate?: Date;
|
|
3426
|
+
/** Site member ID. */
|
|
3369
3427
|
memberId?: string | null;
|
|
3428
|
+
/** Guest type: <br/> <br/> `RSVP`: An invited guest, no ticket necessary. <br/> <br/> `BUYER`: The guest who bought the tickets. <br/> <br/> `TICKET_HOLDER`: The guest for whom the ticket was bought. */
|
|
3429
|
+
guestType?: GuestType;
|
|
3430
|
+
/** Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. */
|
|
3431
|
+
locale?: string | null;
|
|
3370
3432
|
/**
|
|
3371
|
-
*
|
|
3433
|
+
* Number of current guest plus additional guests
|
|
3372
3434
|
* @readonly
|
|
3373
3435
|
*/
|
|
3374
|
-
|
|
3436
|
+
totalGuests?: number | null;
|
|
3375
3437
|
/**
|
|
3376
|
-
*
|
|
3438
|
+
* Guest revision
|
|
3377
3439
|
* @readonly
|
|
3378
3440
|
*/
|
|
3379
|
-
|
|
3380
|
-
|
|
3441
|
+
revision?: string | null;
|
|
3442
|
+
}
|
|
3443
|
+
interface TicketDetails$2 {
|
|
3444
|
+
/** Ticket number. */
|
|
3445
|
+
number?: string;
|
|
3446
|
+
/** Ticket definition ID. */
|
|
3447
|
+
definitionId?: string | null;
|
|
3448
|
+
/** Ticket name. */
|
|
3449
|
+
name?: string | null;
|
|
3450
|
+
}
|
|
3451
|
+
interface TicketGuestDetails {
|
|
3452
|
+
/** The login details for the guest to access the online conference event. */
|
|
3453
|
+
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
3454
|
+
/** First name. */
|
|
3381
3455
|
firstName?: string | null;
|
|
3382
|
-
/**
|
|
3456
|
+
/** Last name. */
|
|
3383
3457
|
lastName?: string | null;
|
|
3384
|
-
/** Buyer email. */
|
|
3385
|
-
email?: string | null;
|
|
3386
|
-
/** Checkout form response. */
|
|
3387
|
-
checkoutForm?: FormResponse$4;
|
|
3388
|
-
/** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
|
|
3389
|
-
confirmed?: boolean;
|
|
3390
|
-
/** Order status. */
|
|
3391
|
-
status?: OrderStatus$2;
|
|
3392
|
-
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
3393
|
-
method?: string | null;
|
|
3394
|
-
/** Tickets generated after payment. */
|
|
3395
|
-
tickets?: Ticket$2[];
|
|
3396
|
-
/** Whether order was archived and excluded from results. */
|
|
3397
|
-
archived?: boolean;
|
|
3398
|
-
/** Reservation ID associated with this order. */
|
|
3399
|
-
reservationId?: string;
|
|
3400
3458
|
}
|
|
3401
|
-
interface
|
|
3402
|
-
/**
|
|
3403
|
-
|
|
3404
|
-
/**
|
|
3405
|
-
|
|
3406
|
-
/**
|
|
3407
|
-
|
|
3408
|
-
/**
|
|
3409
|
-
|
|
3459
|
+
interface GuestDetails$2 {
|
|
3460
|
+
/** Email. */
|
|
3461
|
+
email?: string | null;
|
|
3462
|
+
/** First name. */
|
|
3463
|
+
firstName?: string | null;
|
|
3464
|
+
/** Last name. */
|
|
3465
|
+
lastName?: string | null;
|
|
3466
|
+
/** Form response. */
|
|
3467
|
+
formResponse?: FormResponse$4;
|
|
3468
|
+
/** Whether the guest has checked into the event. */
|
|
3469
|
+
checkedIn?: boolean;
|
|
3470
|
+
/** The login details for the guest to access the online conference event. */
|
|
3471
|
+
onlineConferencingLogin?: OnlineConferencingLogin$4;
|
|
3410
3472
|
}
|
|
3411
|
-
|
|
3412
|
-
/**
|
|
3413
|
-
|
|
3414
|
-
/**
|
|
3415
|
-
|
|
3416
|
-
/**
|
|
3417
|
-
|
|
3418
|
-
/** Event schedule configuration. */
|
|
3419
|
-
scheduleConfig?: ScheduleConfig$6;
|
|
3420
|
-
/** Event title. */
|
|
3421
|
-
title?: string;
|
|
3422
|
-
/** Event creator user ID. */
|
|
3423
|
-
userId?: string | null;
|
|
3424
|
-
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
3425
|
-
startsIn?: TimeDuration$1;
|
|
3473
|
+
declare enum AttendanceStatus {
|
|
3474
|
+
/** Not attending. */
|
|
3475
|
+
NOT_ATTENDING = "NOT_ATTENDING",
|
|
3476
|
+
/** Attending. */
|
|
3477
|
+
ATTENDING = "ATTENDING",
|
|
3478
|
+
/** In a waiting list. */
|
|
3479
|
+
IN_WAITLIST = "IN_WAITLIST"
|
|
3426
3480
|
}
|
|
3427
|
-
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
*/
|
|
3431
|
-
|
|
3432
|
-
/**
|
|
3433
|
-
|
|
3434
|
-
/** Number of hours. */
|
|
3435
|
-
hours?: number;
|
|
3436
|
-
/** Number of minutes. */
|
|
3437
|
-
minutes?: number;
|
|
3481
|
+
declare enum GuestType {
|
|
3482
|
+
/** Rsvp guest. */
|
|
3483
|
+
RSVP = "RSVP",
|
|
3484
|
+
/** Buyer guest. */
|
|
3485
|
+
BUYER = "BUYER",
|
|
3486
|
+
/** Ticket holder guest. */
|
|
3487
|
+
TICKET_HOLDER = "TICKET_HOLDER"
|
|
3438
3488
|
}
|
|
3439
|
-
interface
|
|
3440
|
-
/**
|
|
3441
|
-
|
|
3442
|
-
/**
|
|
3443
|
-
|
|
3444
|
-
/**
|
|
3445
|
-
|
|
3446
|
-
/** Locale in which Order was created. */
|
|
3447
|
-
locale?: string | null;
|
|
3448
|
-
/** Event ID. */
|
|
3449
|
-
eventId?: string;
|
|
3450
|
-
/** Unique order number. */
|
|
3451
|
-
orderNumber?: string;
|
|
3452
|
-
/** Reservation ID associated with this order. */
|
|
3453
|
-
reservationId?: string;
|
|
3454
|
-
/** Contact ID associated with this order. */
|
|
3455
|
-
contactId?: string;
|
|
3456
|
-
/** Member ID associated with this order. */
|
|
3457
|
-
memberId?: string | null;
|
|
3458
|
-
/**
|
|
3459
|
-
* Order created timestamp
|
|
3460
|
-
* @readonly
|
|
3461
|
-
*/
|
|
3462
|
-
created?: Date;
|
|
3463
|
-
/** Buyer first name. */
|
|
3464
|
-
firstName?: string;
|
|
3465
|
-
/** Buyer last name. */
|
|
3466
|
-
lastName?: string;
|
|
3467
|
-
/** Buyer email address. */
|
|
3468
|
-
email?: string;
|
|
3469
|
-
/** Checkout form response. */
|
|
3470
|
-
checkoutForm?: FormResponse$4;
|
|
3471
|
-
/** Order status. */
|
|
3472
|
-
status?: OrderStatus$2;
|
|
3473
|
-
/** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
|
|
3474
|
-
method?: string | null;
|
|
3475
|
-
/** Tickets (generated after payment). */
|
|
3476
|
-
tickets?: Ticket$2[];
|
|
3477
|
-
/** Invoice. */
|
|
3478
|
-
invoice?: Invoice$1;
|
|
3489
|
+
interface GuestCountUpdate {
|
|
3490
|
+
/** Attendance status. */
|
|
3491
|
+
attendanceStatus?: AttendanceStatus;
|
|
3492
|
+
/** Total guest count change. */
|
|
3493
|
+
totalGuestsDelta?: number;
|
|
3494
|
+
/** Guest count change. */
|
|
3495
|
+
countDelta?: number;
|
|
3479
3496
|
}
|
|
3480
|
-
interface
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
/**
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
_id?: string;
|
|
3497
|
+
interface MemberEventStatusUpdated {
|
|
3498
|
+
/** Event id. */
|
|
3499
|
+
eventId?: string | null;
|
|
3500
|
+
/** Member id. */
|
|
3501
|
+
memberId?: string | null;
|
|
3502
|
+
/** Member event status. */
|
|
3503
|
+
status?: MemberEventStatusUpdatedEventType;
|
|
3504
|
+
}
|
|
3505
|
+
declare enum MemberEventStatusUpdatedEventType {
|
|
3490
3506
|
/**
|
|
3491
|
-
*
|
|
3492
|
-
*
|
|
3507
|
+
* Every time a guest with specified member ID is added to the event.
|
|
3508
|
+
* This event can also be fired if existing guest changed member ID.
|
|
3493
3509
|
*/
|
|
3494
|
-
|
|
3510
|
+
MEMBER_JOINED = "MEMBER_JOINED",
|
|
3495
3511
|
/**
|
|
3496
|
-
*
|
|
3497
|
-
* This
|
|
3498
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3512
|
+
* Every time a guest with specified member ID is removed from the event.
|
|
3513
|
+
* This event can also be fired if existing guest changed member ID.
|
|
3499
3514
|
*/
|
|
3500
|
-
|
|
3501
|
-
/** ID of the entity associated with the event. */
|
|
3502
|
-
entityId?: string;
|
|
3503
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3504
|
-
eventTime?: Date;
|
|
3515
|
+
MEMBER_LEFT = "MEMBER_LEFT",
|
|
3505
3516
|
/**
|
|
3506
|
-
*
|
|
3507
|
-
*
|
|
3517
|
+
* Every time a guest with specified member ID and status ATTENDING is added to the event.
|
|
3518
|
+
* This event can also be fired if existing guest changed member ID or status to ATTENDING.
|
|
3508
3519
|
*/
|
|
3509
|
-
|
|
3510
|
-
/** If present, indicates the action that triggered the event. */
|
|
3511
|
-
originatedFrom?: string | null;
|
|
3520
|
+
ATTENDING_MEMBER_JOINED = "ATTENDING_MEMBER_JOINED",
|
|
3512
3521
|
/**
|
|
3513
|
-
*
|
|
3514
|
-
*
|
|
3515
|
-
*
|
|
3516
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3517
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3518
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3522
|
+
* Once last guest with specified member ID is removed from the event or status became not ATTENDING.
|
|
3523
|
+
* Once this is fired there are no more attending guests with specified member ID in the event.
|
|
3524
|
+
* This event can also be fired if existing guest changed their member ID or status to not ATTENDING.
|
|
3519
3525
|
*/
|
|
3520
|
-
|
|
3521
|
-
}
|
|
3522
|
-
/** @oneof */
|
|
3523
|
-
interface DomainEventBodyOneOf$8 {
|
|
3524
|
-
createdEvent?: EntityCreatedEvent$8;
|
|
3525
|
-
updatedEvent?: EntityUpdatedEvent$8;
|
|
3526
|
-
deletedEvent?: EntityDeletedEvent$8;
|
|
3527
|
-
actionEvent?: ActionEvent$8;
|
|
3528
|
-
}
|
|
3529
|
-
interface EntityCreatedEvent$8 {
|
|
3530
|
-
entity?: string;
|
|
3526
|
+
LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
|
|
3531
3527
|
}
|
|
3532
|
-
interface
|
|
3533
|
-
|
|
3528
|
+
interface ContactEventStatusUpdated {
|
|
3529
|
+
/** Event id. */
|
|
3530
|
+
eventId?: string | null;
|
|
3531
|
+
/** Contact id. */
|
|
3532
|
+
contactId?: string | null;
|
|
3533
|
+
/** Contact event status. */
|
|
3534
|
+
status?: ContactEventStatusUpdatedEventType;
|
|
3534
3535
|
}
|
|
3535
|
-
|
|
3536
|
+
declare enum ContactEventStatusUpdatedEventType {
|
|
3536
3537
|
/**
|
|
3537
|
-
*
|
|
3538
|
-
* This
|
|
3539
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3538
|
+
* Every time a guest with specified contact ID is added to the event.
|
|
3539
|
+
* This event can also be fired if existing guest changed contact ID.
|
|
3540
3540
|
*/
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
/** Optional ticket number */
|
|
3554
|
-
ticketNumber?: string | null;
|
|
3555
|
-
/** Resolved download url */
|
|
3556
|
-
downloadUrl?: string | null;
|
|
3557
|
-
/** Resolve status */
|
|
3558
|
-
resolveFailed?: boolean | null;
|
|
3559
|
-
/** Papyrus document id */
|
|
3560
|
-
documentId?: string | null;
|
|
3541
|
+
CONTACT_JOINED = "CONTACT_JOINED",
|
|
3542
|
+
/**
|
|
3543
|
+
* Every time a guest with specified contact ID is removed from the event.
|
|
3544
|
+
* This event can also be fired if existing guest changed contact ID.
|
|
3545
|
+
*/
|
|
3546
|
+
CONTACT_LEFT = "CONTACT_LEFT",
|
|
3547
|
+
/**
|
|
3548
|
+
* Once last guest with specified contact ID is removed from the event.
|
|
3549
|
+
* Once this is fired there are no more guests with specified contact ID in the event.
|
|
3550
|
+
* This event can also be fired if existing guest changed their contact ID.
|
|
3551
|
+
*/
|
|
3552
|
+
LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
|
|
3561
3553
|
}
|
|
3562
|
-
interface
|
|
3563
|
-
/**
|
|
3564
|
-
|
|
3565
|
-
/**
|
|
3566
|
-
|
|
3567
|
-
/** Papyrus document id */
|
|
3568
|
-
documentId?: string | null;
|
|
3554
|
+
interface NotifyGuestAction {
|
|
3555
|
+
/** Event guest. */
|
|
3556
|
+
guest?: EventGuest;
|
|
3557
|
+
/** Task context. */
|
|
3558
|
+
taskContext?: TaskContext;
|
|
3569
3559
|
}
|
|
3570
|
-
interface
|
|
3571
|
-
/**
|
|
3572
|
-
|
|
3573
|
-
/**
|
|
3574
|
-
|
|
3560
|
+
interface TaskContext {
|
|
3561
|
+
/** Task id. */
|
|
3562
|
+
_id?: string | null;
|
|
3563
|
+
/** Notify action type */
|
|
3564
|
+
type?: NotifyActionType;
|
|
3575
3565
|
}
|
|
3576
|
-
|
|
3577
|
-
|
|
3578
|
-
|
|
3579
|
-
|
|
3580
|
-
|
|
3566
|
+
declare enum NotifyActionType {
|
|
3567
|
+
UNKNOWN = "UNKNOWN",
|
|
3568
|
+
EMAIL = "EMAIL",
|
|
3569
|
+
AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
|
|
3570
|
+
PUSH = "PUSH"
|
|
3581
3571
|
}
|
|
3582
|
-
interface
|
|
3583
|
-
/**
|
|
3584
|
-
|
|
3585
|
-
/** Event type. */
|
|
3586
|
-
eventType?: string;
|
|
3587
|
-
/** The identification type and identity data. */
|
|
3588
|
-
identity?: IdentificationData$c;
|
|
3589
|
-
/** Stringify payload. */
|
|
3590
|
-
data?: string;
|
|
3572
|
+
interface UnprocessedTargetEvent {
|
|
3573
|
+
/** The target that was not marked as processed */
|
|
3574
|
+
target?: Target$1;
|
|
3591
3575
|
}
|
|
3592
|
-
interface
|
|
3593
|
-
/**
|
|
3594
|
-
|
|
3595
|
-
/**
|
|
3596
|
-
|
|
3597
|
-
/**
|
|
3598
|
-
|
|
3599
|
-
/**
|
|
3600
|
-
|
|
3601
|
-
/**
|
|
3602
|
-
|
|
3576
|
+
interface Target$1 {
|
|
3577
|
+
/** Unique identifier of the target with pattern `id_tag_value[type]`, for example 'com.wixpress.myproto[wix_proto_bundle_export]`` */
|
|
3578
|
+
_id?: string | null;
|
|
3579
|
+
/** The unique location of the target in Bazel notation i.e @repo//path/to/target:target_name */
|
|
3580
|
+
location?: string | null;
|
|
3581
|
+
/** The combined digest of all files within the target */
|
|
3582
|
+
combinedDigest?: string | null;
|
|
3583
|
+
/** The vcs commit timestamp of the target in milliseconds */
|
|
3584
|
+
commitTimestamp?: string | null;
|
|
3585
|
+
/** The type of the target */
|
|
3586
|
+
type?: TargetType;
|
|
3587
|
+
/**
|
|
3588
|
+
* The target's id tag value in Bazel, uniquness is not guaranteed
|
|
3589
|
+
* i.e for a tag "businessSchemaIndexerId=com.wixpress.myproto" the value is "com.wixpress.myproto"
|
|
3590
|
+
*/
|
|
3591
|
+
idTagValue?: string | null;
|
|
3592
|
+
files?: File$1[];
|
|
3603
3593
|
}
|
|
3604
|
-
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
memberId?: string;
|
|
3610
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3611
|
-
wixUserId?: string;
|
|
3612
|
-
/** ID of an app. */
|
|
3613
|
-
appId?: string;
|
|
3594
|
+
declare enum TargetType {
|
|
3595
|
+
NONE = "NONE",
|
|
3596
|
+
WIX_PROTO_BUNDLE_EXPORT = "WIX_PROTO_BUNDLE_EXPORT",
|
|
3597
|
+
WIX_APPENDIX_BUNDLE_EXPORT = "WIX_APPENDIX_BUNDLE_EXPORT",
|
|
3598
|
+
WIX_API_REGISTRY_INFO_EXPORT = "WIX_API_REGISTRY_INFO_EXPORT"
|
|
3614
3599
|
}
|
|
3615
|
-
|
|
3616
|
-
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
|
|
3600
|
+
interface File$1 {
|
|
3601
|
+
/** The name of the file including path relative to its source repo, i.e src/main/java/com/wixpress/MyClass.java */
|
|
3602
|
+
name?: string | null;
|
|
3603
|
+
/** The URI of the file */
|
|
3604
|
+
uri?: string | null;
|
|
3605
|
+
/** The digest of the file */
|
|
3606
|
+
digest?: string | null;
|
|
3607
|
+
/** The size of the file in bytes */
|
|
3608
|
+
sizeInBytes?: string | null;
|
|
3621
3609
|
}
|
|
3622
3610
|
interface ResolveNotificationConfigRequest {
|
|
3623
3611
|
/** Id of the NotificationConfig to retrieve */
|
|
@@ -3681,6 +3669,46 @@ interface EventCopied$3 {
|
|
|
3681
3669
|
*/
|
|
3682
3670
|
ticketDefinitions?: Record<string, string>;
|
|
3683
3671
|
}
|
|
3672
|
+
interface MessageEnvelope$c {
|
|
3673
|
+
/** App instance ID. */
|
|
3674
|
+
instanceId?: string | null;
|
|
3675
|
+
/** Event type. */
|
|
3676
|
+
eventType?: string;
|
|
3677
|
+
/** The identification type and identity data. */
|
|
3678
|
+
identity?: IdentificationData$c;
|
|
3679
|
+
/** Stringify payload. */
|
|
3680
|
+
data?: string;
|
|
3681
|
+
}
|
|
3682
|
+
interface IdentificationData$c extends IdentificationDataIdOneOf$c {
|
|
3683
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
3684
|
+
anonymousVisitorId?: string;
|
|
3685
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
3686
|
+
memberId?: string;
|
|
3687
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3688
|
+
wixUserId?: string;
|
|
3689
|
+
/** ID of an app. */
|
|
3690
|
+
appId?: string;
|
|
3691
|
+
/** @readonly */
|
|
3692
|
+
identityType?: WebhookIdentityType$c;
|
|
3693
|
+
}
|
|
3694
|
+
/** @oneof */
|
|
3695
|
+
interface IdentificationDataIdOneOf$c {
|
|
3696
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
3697
|
+
anonymousVisitorId?: string;
|
|
3698
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
3699
|
+
memberId?: string;
|
|
3700
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3701
|
+
wixUserId?: string;
|
|
3702
|
+
/** ID of an app. */
|
|
3703
|
+
appId?: string;
|
|
3704
|
+
}
|
|
3705
|
+
declare enum WebhookIdentityType$c {
|
|
3706
|
+
UNKNOWN = "UNKNOWN",
|
|
3707
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3708
|
+
MEMBER = "MEMBER",
|
|
3709
|
+
WIX_USER = "WIX_USER",
|
|
3710
|
+
APP = "APP"
|
|
3711
|
+
}
|
|
3684
3712
|
interface EmailNotificationConfigNonNullableFields {
|
|
3685
3713
|
notificationType: EmailNotificationType;
|
|
3686
3714
|
reminderTime: EmailNotificationReminderTime;
|
|
@@ -3902,6 +3930,7 @@ declare const context$e_NotifyActionType: typeof NotifyActionType;
|
|
|
3902
3930
|
type context$e_NotifyGuestAction = NotifyGuestAction;
|
|
3903
3931
|
type context$e_Operator = Operator;
|
|
3904
3932
|
declare const context$e_Operator: typeof Operator;
|
|
3933
|
+
type context$e_OrderCanceled = OrderCanceled;
|
|
3905
3934
|
type context$e_OrderEmailAdded = OrderEmailAdded;
|
|
3906
3935
|
type context$e_OrderGuest = OrderGuest;
|
|
3907
3936
|
type context$e_Origin = Origin;
|
|
@@ -3949,7 +3978,7 @@ declare const context$e_resolveNotificationConfig: typeof resolveNotificationCon
|
|
|
3949
3978
|
declare const context$e_triggerNotification: typeof triggerNotification;
|
|
3950
3979
|
declare const context$e_upsertNotificationConfig: typeof upsertNotificationConfig;
|
|
3951
3980
|
declare namespace context$e {
|
|
3952
|
-
export { type Action$1 as Action, type ActionEvent$8 as ActionEvent, type context$e_ActionInfoOneOf as ActionInfoOneOf, type context$e_ActionSettings as ActionSettings, type Address$9 as Address, type AddressLocation$9 as AddressLocation, type AddressStreetOneOf$9 as AddressStreetOneOf, type Agenda$4 as Agenda, type context$e_AppDefinedAction as AppDefinedAction, type context$e_ApplicationOrigin as ApplicationOrigin, context$e_AttendanceStatus as AttendanceStatus, type context$e_AuditInfo as AuditInfo, type context$e_AuditInfoIdOneOf as AuditInfoIdOneOf, type context$e_Automation as Automation, type context$e_AutomationConfiguration as AutomationConfiguration, type context$e_AutomationOriginInfoOneOf as AutomationOriginInfoOneOf, type context$e_AutomationSettings as AutomationSettings, type BaseEventMetadata$a as BaseEventMetadata, type CalendarLinks$6 as CalendarLinks, type Category$5 as Category, type CategoryCounts$5 as CategoryCounts, type CheckIn$3 as CheckIn, type CheckoutFormMessages$4 as CheckoutFormMessages, type CommonAddress$2 as CommonAddress, type CommonAddressLocation$2 as CommonAddressLocation, type CommonAddressStreetOneOf$2 as CommonAddressStreetOneOf, type CommonStreetAddress$2 as CommonStreetAddress, type CommonSubdivision$2 as CommonSubdivision, type context$e_ConditionAction as ConditionAction, type context$e_ConditionExpressionGroup as ConditionExpressionGroup, ConferenceType$4 as ConferenceType, type context$e_ContactEventStatusUpdated as ContactEventStatusUpdated, context$e_ContactEventStatusUpdatedEventType as ContactEventStatusUpdatedEventType, type CouponDiscount$1 as CouponDiscount, type Dashboard$6 as Dashboard, type context$e_DelayAction as DelayAction, type context$e_DeletedWithEntity as DeletedWithEntity, type Discount$1 as Discount, type DiscountItem$1 as DiscountItem, type DiscountItemDiscountOneOf$1 as DiscountItemDiscountOneOf, type DomainEvent$8 as DomainEvent, type DomainEventBodyOneOf$8 as DomainEventBodyOneOf, type context$e_DraftInfo as DraftInfo, type context$e_EmailNotificationConfig as EmailNotificationConfig, context$e_EmailNotificationReminderTime as EmailNotificationReminderTime, context$e_EmailNotificationType as EmailNotificationType, type context$e_EmailTemplate as EmailTemplate, type Empty$5 as Empty, type EntityCreatedEvent$8 as EntityCreatedEvent, type EntityDeletedEvent$8 as EntityDeletedEvent, type EntityUpdatedEvent$8 as EntityUpdatedEvent, type Event$4 as Event, type EventCanceled$2 as EventCanceled, type EventCopied$3 as EventCopied, type EventDeleted$4 as EventDeleted, type EventDisplaySettings$4 as EventDisplaySettings, type EventEnded$2 as EventEnded, type context$e_EventGuest as EventGuest, type context$e_EventGuests as EventGuests, type EventMetadata$5 as EventMetadata, type EventReminder$1 as EventReminder, type EventStarted$1 as EventStarted, EventStatus$6 as EventStatus, EventType$4 as EventType, type EventUpdated$3 as EventUpdated, type ExternalEvent$4 as ExternalEvent, type Fee$1 as Fee, FeeName$1 as FeeName, FeeType$2 as FeeType, type Feed$4 as Feed, type File$1 as File, type context$e_Filter as Filter, type Form$4 as Form, type FormMessages$4 as FormMessages, type FormResponse$4 as FormResponse, type FormattedAddress$4 as FormattedAddress, type context$e_FutureDateActivationOffset as FutureDateActivationOffset, type Guest$3 as Guest, type context$e_GuestCountUpdate as GuestCountUpdate, type context$e_GuestCountUpdated as GuestCountUpdated, type GuestDetails$2 as GuestDetails, type GuestListConfig$4 as GuestListConfig, context$e_GuestType as GuestType, type IdentificationData$c as IdentificationData, type IdentificationDataIdOneOf$c as IdentificationDataIdOneOf, type Input$4 as Input, type InputControl$4 as InputControl, InputControlType$4 as InputControlType, type InputValue$4 as InputValue, type Invoice$1 as Invoice, type Item$2 as Item, type Keyword$4 as Keyword, type Label$4 as Label, type LabellingSettings$4 as LabellingSettings, type Link$1 as Link, type Location$6 as Location, LocationType$6 as LocationType, type MapCoordinates$6 as MapCoordinates, type context$e_MemberEventStatusUpdated as MemberEventStatusUpdated, context$e_MemberEventStatusUpdatedEventType as MemberEventStatusUpdatedEventType, type MessageEnvelope$c as MessageEnvelope, type Money$7 as Money, type Negative$4 as Negative, type NegativeResponseConfirmation$4 as NegativeResponseConfirmation, type context$e_NotificationConfig as NotificationConfig, type context$e_NotificationConfigCreatedEnvelope as NotificationConfigCreatedEnvelope, type context$e_NotificationConfigDeletedEnvelope as NotificationConfigDeletedEnvelope, type context$e_NotificationConfigUpdatedEnvelope as NotificationConfigUpdatedEnvelope, context$e_NotifyActionType as NotifyActionType, type context$e_NotifyGuestAction as NotifyGuestAction, type Occurrence$6 as Occurrence, type OnlineConferencing$4 as OnlineConferencing, type OnlineConferencingConfig$4 as OnlineConferencingConfig, type OnlineConferencingLogin$4 as OnlineConferencingLogin, type OnlineConferencingSession$4 as OnlineConferencingSession, context$e_Operator as Operator, type OptionSelection$4 as OptionSelection, type OptionSelectionSelectedOptionOneOf$4 as OptionSelectionSelectedOptionOneOf, type OrderConfirmed$1 as OrderConfirmed, type context$e_OrderEmailAdded as OrderEmailAdded, type context$e_OrderGuest as OrderGuest, type OrderPaid$1 as OrderPaid, OrderStatus$2 as OrderStatus, context$e_Origin as Origin, type context$e_OutputAction as OutputAction, type PaidPlanDiscount$1 as PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf$1 as PaidPlanDiscountDiscountOneOf, type PercentDiscount$1 as PercentDiscount, type Positive$4 as Positive, type PositiveResponseConfirmation$4 as PositiveResponseConfirmation, type context$e_PreinstalledOrigin as PreinstalledOrigin, context$e_PushNotificationType as PushNotificationType, type context$e_RateLimit as RateLimit, type context$e_RateLimitAction as RateLimitAction, RecurrenceStatusStatus$1 as RecurrenceStatusStatus, type Recurrences$6 as Recurrences, type Registration$4 as Registration, type RegistrationClosedMessages$4 as RegistrationClosedMessages, RegistrationStatus$4 as RegistrationStatus, type context$e_ResolveEmailNotificationConfigRequest as ResolveEmailNotificationConfigRequest, type context$e_ResolveEmailNotificationConfigResponse as ResolveEmailNotificationConfigResponse, type context$e_ResolveNotificationConfigRequest as ResolveNotificationConfigRequest, type context$e_ResolveNotificationConfigResponse as ResolveNotificationConfigResponse, type context$e_ResolveNotificationConfigResponseNonNullableFields as ResolveNotificationConfigResponseNonNullableFields, type ResponseConfirmation$4 as ResponseConfirmation, type RestoreInfo$7 as RestoreInfo, type RsvpCollection$4 as RsvpCollection, type RsvpCollectionConfig$4 as RsvpCollectionConfig, type RsvpCreated$1 as RsvpCreated, type RsvpFormMessages$4 as RsvpFormMessages, type context$e_RsvpGuest as RsvpGuest, RsvpStatus$2 as RsvpStatus, RsvpStatusOptions$4 as RsvpStatusOptions, type RsvpSummary$5 as RsvpSummary, type RsvpUpdated$1 as RsvpUpdated, type ScheduleConfig$6 as ScheduleConfig, type Scheduling$4 as Scheduling, type SeoSchema$4 as SeoSchema, type SeoSettings$4 as SeoSettings, type Settings$5 as Settings, type SiteUrl$4 as SiteUrl, type StandardDetails$4 as StandardDetails, State$8 as State, Status$7 as Status, type StreetAddress$9 as StreetAddress, type Subdivision$9 as Subdivision, SubdivisionType$9 as SubdivisionType, type Tag$4 as Tag, type Target$1 as Target, context$e_TargetType as TargetType, type context$e_TaskContext as TaskContext, type Tax$1 as Tax, type TaxConfig$4 as TaxConfig, TaxType$5 as TaxType, type Ticket$2 as Ticket, type TicketDetails$2 as TicketDetails, type context$e_TicketGuest as TicketGuest, type context$e_TicketGuestDetails as TicketGuestDetails, type context$e_TicketPdfResolveDelayed as TicketPdfResolveDelayed, type context$e_TicketPdfResolved as TicketPdfResolved, type Ticketing$4 as Ticketing, type TicketingConfig$4 as TicketingConfig, type TicketingSummary$4 as TicketingSummary, type TicketsUnavailableMessages$4 as TicketsUnavailableMessages, type TimeDuration$1 as TimeDuration, context$e_TimeUnit as TimeUnit, type context$e_Trigger as Trigger, type context$e_TriggerNotificationOptions as TriggerNotificationOptions, type context$e_TriggerNotificationRequest as TriggerNotificationRequest, type context$e_TriggerNotificationRequestGuestsOneOf as TriggerNotificationRequestGuestsOneOf, type context$e_TriggerNotificationRequestNotificationOneOf as TriggerNotificationRequestNotificationOneOf, type context$e_TriggerNotificationResponse as TriggerNotificationResponse, Type$5 as Type, type context$e_UnprocessedTargetEvent as UnprocessedTargetEvent, type context$e_UpdatedWithPreviousEntity as UpdatedWithPreviousEntity, type context$e_UpsertNotificationConfig as UpsertNotificationConfig, type context$e_UpsertNotificationConfigRequest as UpsertNotificationConfigRequest, type context$e_UpsertNotificationConfigResponse as UpsertNotificationConfigResponse, type context$e_UpsertNotificationConfigResponseNonNullableFields as UpsertNotificationConfigResponseNonNullableFields, ValueType$4 as ValueType, VisitorType$4 as VisitorType, WebhookIdentityType$c as WebhookIdentityType, type context$e__publicOnNotificationConfigCreatedType as _publicOnNotificationConfigCreatedType, type context$e__publicOnNotificationConfigDeletedType as _publicOnNotificationConfigDeletedType, type context$e__publicOnNotificationConfigUpdatedType as _publicOnNotificationConfigUpdatedType, context$e_onNotificationConfigCreated as onNotificationConfigCreated, context$e_onNotificationConfigDeleted as onNotificationConfigDeleted, context$e_onNotificationConfigUpdated as onNotificationConfigUpdated, onNotificationConfigCreated$1 as publicOnNotificationConfigCreated, onNotificationConfigDeleted$1 as publicOnNotificationConfigDeleted, onNotificationConfigUpdated$1 as publicOnNotificationConfigUpdated, context$e_resolveNotificationConfig as resolveNotificationConfig, context$e_triggerNotification as triggerNotification, context$e_upsertNotificationConfig as upsertNotificationConfig };
|
|
3981
|
+
export { type Action$1 as Action, type ActionEvent$8 as ActionEvent, type context$e_ActionInfoOneOf as ActionInfoOneOf, type context$e_ActionSettings as ActionSettings, type Address$9 as Address, type AddressLocation$9 as AddressLocation, type AddressStreetOneOf$9 as AddressStreetOneOf, type Agenda$4 as Agenda, type context$e_AppDefinedAction as AppDefinedAction, type context$e_ApplicationOrigin as ApplicationOrigin, context$e_AttendanceStatus as AttendanceStatus, type context$e_AuditInfo as AuditInfo, type context$e_AuditInfoIdOneOf as AuditInfoIdOneOf, type context$e_Automation as Automation, type context$e_AutomationConfiguration as AutomationConfiguration, type context$e_AutomationOriginInfoOneOf as AutomationOriginInfoOneOf, type context$e_AutomationSettings as AutomationSettings, type BaseEventMetadata$a as BaseEventMetadata, type CalendarLinks$6 as CalendarLinks, type Category$5 as Category, type CategoryCounts$5 as CategoryCounts, type CheckIn$3 as CheckIn, type CheckoutFormMessages$4 as CheckoutFormMessages, type CommonAddress$2 as CommonAddress, type CommonAddressLocation$2 as CommonAddressLocation, type CommonAddressStreetOneOf$2 as CommonAddressStreetOneOf, type CommonStreetAddress$2 as CommonStreetAddress, type CommonSubdivision$2 as CommonSubdivision, type context$e_ConditionAction as ConditionAction, type context$e_ConditionExpressionGroup as ConditionExpressionGroup, ConferenceType$4 as ConferenceType, type context$e_ContactEventStatusUpdated as ContactEventStatusUpdated, context$e_ContactEventStatusUpdatedEventType as ContactEventStatusUpdatedEventType, type CouponDiscount$1 as CouponDiscount, type Dashboard$6 as Dashboard, type context$e_DelayAction as DelayAction, type context$e_DeletedWithEntity as DeletedWithEntity, type Discount$1 as Discount, type DiscountItem$1 as DiscountItem, type DiscountItemDiscountOneOf$1 as DiscountItemDiscountOneOf, type DomainEvent$8 as DomainEvent, type DomainEventBodyOneOf$8 as DomainEventBodyOneOf, type context$e_DraftInfo as DraftInfo, type context$e_EmailNotificationConfig as EmailNotificationConfig, context$e_EmailNotificationReminderTime as EmailNotificationReminderTime, context$e_EmailNotificationType as EmailNotificationType, type context$e_EmailTemplate as EmailTemplate, type Empty$5 as Empty, type EntityCreatedEvent$8 as EntityCreatedEvent, type EntityDeletedEvent$8 as EntityDeletedEvent, type EntityUpdatedEvent$8 as EntityUpdatedEvent, type Event$4 as Event, type EventCanceled$2 as EventCanceled, type EventCopied$3 as EventCopied, type EventDeleted$4 as EventDeleted, type EventDisplaySettings$4 as EventDisplaySettings, type EventEnded$2 as EventEnded, type context$e_EventGuest as EventGuest, type context$e_EventGuests as EventGuests, type EventMetadata$5 as EventMetadata, type EventReminder$1 as EventReminder, type EventStarted$1 as EventStarted, EventStatus$6 as EventStatus, EventType$4 as EventType, type EventUpdated$3 as EventUpdated, type ExternalEvent$4 as ExternalEvent, type Fee$1 as Fee, FeeName$1 as FeeName, FeeType$2 as FeeType, type Feed$4 as Feed, type File$1 as File, type context$e_Filter as Filter, type Form$4 as Form, type FormMessages$4 as FormMessages, type FormResponse$4 as FormResponse, type FormattedAddress$4 as FormattedAddress, type context$e_FutureDateActivationOffset as FutureDateActivationOffset, type Guest$3 as Guest, type context$e_GuestCountUpdate as GuestCountUpdate, type context$e_GuestCountUpdated as GuestCountUpdated, type GuestDetails$2 as GuestDetails, type GuestListConfig$4 as GuestListConfig, context$e_GuestType as GuestType, type IdentificationData$c as IdentificationData, type IdentificationDataIdOneOf$c as IdentificationDataIdOneOf, type Input$4 as Input, type InputControl$4 as InputControl, InputControlType$4 as InputControlType, type InputValue$4 as InputValue, type Invoice$1 as Invoice, type Item$2 as Item, type Keyword$4 as Keyword, type Label$4 as Label, type LabellingSettings$4 as LabellingSettings, type Link$1 as Link, type Location$6 as Location, LocationType$6 as LocationType, type MapCoordinates$6 as MapCoordinates, type context$e_MemberEventStatusUpdated as MemberEventStatusUpdated, context$e_MemberEventStatusUpdatedEventType as MemberEventStatusUpdatedEventType, type MessageEnvelope$c as MessageEnvelope, type Money$7 as Money, type Negative$4 as Negative, type NegativeResponseConfirmation$4 as NegativeResponseConfirmation, type context$e_NotificationConfig as NotificationConfig, type context$e_NotificationConfigCreatedEnvelope as NotificationConfigCreatedEnvelope, type context$e_NotificationConfigDeletedEnvelope as NotificationConfigDeletedEnvelope, type context$e_NotificationConfigUpdatedEnvelope as NotificationConfigUpdatedEnvelope, context$e_NotifyActionType as NotifyActionType, type context$e_NotifyGuestAction as NotifyGuestAction, type Occurrence$6 as Occurrence, type OnlineConferencing$4 as OnlineConferencing, type OnlineConferencingConfig$4 as OnlineConferencingConfig, type OnlineConferencingLogin$4 as OnlineConferencingLogin, type OnlineConferencingSession$4 as OnlineConferencingSession, context$e_Operator as Operator, type OptionSelection$4 as OptionSelection, type OptionSelectionSelectedOptionOneOf$4 as OptionSelectionSelectedOptionOneOf, type context$e_OrderCanceled as OrderCanceled, type OrderConfirmed$1 as OrderConfirmed, type context$e_OrderEmailAdded as OrderEmailAdded, type context$e_OrderGuest as OrderGuest, type OrderPaid$1 as OrderPaid, OrderStatus$2 as OrderStatus, context$e_Origin as Origin, type context$e_OutputAction as OutputAction, type PaidPlanDiscount$1 as PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf$1 as PaidPlanDiscountDiscountOneOf, type PercentDiscount$1 as PercentDiscount, type Positive$4 as Positive, type PositiveResponseConfirmation$4 as PositiveResponseConfirmation, type context$e_PreinstalledOrigin as PreinstalledOrigin, context$e_PushNotificationType as PushNotificationType, type context$e_RateLimit as RateLimit, type context$e_RateLimitAction as RateLimitAction, RecurrenceStatusStatus$1 as RecurrenceStatusStatus, type Recurrences$6 as Recurrences, type Registration$4 as Registration, type RegistrationClosedMessages$4 as RegistrationClosedMessages, RegistrationStatus$4 as RegistrationStatus, type context$e_ResolveEmailNotificationConfigRequest as ResolveEmailNotificationConfigRequest, type context$e_ResolveEmailNotificationConfigResponse as ResolveEmailNotificationConfigResponse, type context$e_ResolveNotificationConfigRequest as ResolveNotificationConfigRequest, type context$e_ResolveNotificationConfigResponse as ResolveNotificationConfigResponse, type context$e_ResolveNotificationConfigResponseNonNullableFields as ResolveNotificationConfigResponseNonNullableFields, type ResponseConfirmation$4 as ResponseConfirmation, type RestoreInfo$7 as RestoreInfo, type RsvpCollection$4 as RsvpCollection, type RsvpCollectionConfig$4 as RsvpCollectionConfig, type RsvpCreated$1 as RsvpCreated, type RsvpFormMessages$4 as RsvpFormMessages, type context$e_RsvpGuest as RsvpGuest, RsvpStatus$2 as RsvpStatus, RsvpStatusOptions$4 as RsvpStatusOptions, type RsvpSummary$5 as RsvpSummary, type RsvpUpdated$1 as RsvpUpdated, type ScheduleConfig$6 as ScheduleConfig, type Scheduling$4 as Scheduling, type SeoSchema$4 as SeoSchema, type SeoSettings$4 as SeoSettings, type Settings$5 as Settings, type SiteUrl$4 as SiteUrl, type StandardDetails$4 as StandardDetails, State$8 as State, Status$7 as Status, type StreetAddress$9 as StreetAddress, type Subdivision$9 as Subdivision, SubdivisionType$9 as SubdivisionType, type Tag$4 as Tag, type Target$1 as Target, context$e_TargetType as TargetType, type context$e_TaskContext as TaskContext, type Tax$1 as Tax, type TaxConfig$4 as TaxConfig, TaxType$5 as TaxType, type Ticket$2 as Ticket, type TicketDetails$2 as TicketDetails, type context$e_TicketGuest as TicketGuest, type context$e_TicketGuestDetails as TicketGuestDetails, type context$e_TicketPdfResolveDelayed as TicketPdfResolveDelayed, type context$e_TicketPdfResolved as TicketPdfResolved, type Ticketing$4 as Ticketing, type TicketingConfig$4 as TicketingConfig, type TicketingSummary$4 as TicketingSummary, type TicketsUnavailableMessages$4 as TicketsUnavailableMessages, type TimeDuration$1 as TimeDuration, context$e_TimeUnit as TimeUnit, type context$e_Trigger as Trigger, type context$e_TriggerNotificationOptions as TriggerNotificationOptions, type context$e_TriggerNotificationRequest as TriggerNotificationRequest, type context$e_TriggerNotificationRequestGuestsOneOf as TriggerNotificationRequestGuestsOneOf, type context$e_TriggerNotificationRequestNotificationOneOf as TriggerNotificationRequestNotificationOneOf, type context$e_TriggerNotificationResponse as TriggerNotificationResponse, Type$5 as Type, type context$e_UnprocessedTargetEvent as UnprocessedTargetEvent, type context$e_UpdatedWithPreviousEntity as UpdatedWithPreviousEntity, type context$e_UpsertNotificationConfig as UpsertNotificationConfig, type context$e_UpsertNotificationConfigRequest as UpsertNotificationConfigRequest, type context$e_UpsertNotificationConfigResponse as UpsertNotificationConfigResponse, type context$e_UpsertNotificationConfigResponseNonNullableFields as UpsertNotificationConfigResponseNonNullableFields, ValueType$4 as ValueType, VisitorType$4 as VisitorType, WebhookIdentityType$c as WebhookIdentityType, type context$e__publicOnNotificationConfigCreatedType as _publicOnNotificationConfigCreatedType, type context$e__publicOnNotificationConfigDeletedType as _publicOnNotificationConfigDeletedType, type context$e__publicOnNotificationConfigUpdatedType as _publicOnNotificationConfigUpdatedType, context$e_onNotificationConfigCreated as onNotificationConfigCreated, context$e_onNotificationConfigDeleted as onNotificationConfigDeleted, context$e_onNotificationConfigUpdated as onNotificationConfigUpdated, onNotificationConfigCreated$1 as publicOnNotificationConfigCreated, onNotificationConfigDeleted$1 as publicOnNotificationConfigDeleted, onNotificationConfigUpdated$1 as publicOnNotificationConfigUpdated, context$e_resolveNotificationConfig as resolveNotificationConfig, context$e_triggerNotification as triggerNotification, context$e_upsertNotificationConfig as upsertNotificationConfig };
|
|
3953
3982
|
}
|
|
3954
3983
|
|
|
3955
3984
|
/** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */
|