@wix/events 1.0.153 → 1.0.155
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +3 -3
- package/build/cjs/index.js +4 -4
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +3 -3
- package/build/cjs/index.typings.js +4 -4
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +3 -3
- package/build/cjs/meta.js +4 -4
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/src/events-guests-v1-guest.universal.d.ts +4 -0
- package/build/cjs/src/events-guests-v1-guest.universal.js +4 -0
- package/build/cjs/src/events-guests-v1-guest.universal.js.map +1 -1
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.d.ts +22 -22
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js +22 -22
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +4 -4
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +4 -4
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.d.ts +22 -22
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.js +22 -22
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +18 -18
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js +18 -18
- package/build/cjs/src/events-v2-policy.universal.d.ts +14 -0
- package/build/cjs/src/events-v2-policy.universal.js +14 -0
- package/build/cjs/src/events-v2-policy.universal.js.map +1 -1
- package/build/cjs/src/events-v3-event.public.d.ts +2 -2
- package/build/cjs/src/events-v3-event.public.js +8 -1
- package/build/cjs/src/events-v3-event.public.js.map +1 -1
- package/build/cjs/src/events-v3-event.types.d.ts +468 -21
- package/build/cjs/src/events-v3-event.types.js +78 -1
- package/build/cjs/src/events-v3-event.types.js.map +1 -1
- package/build/cjs/src/events-v3-event.universal.d.ts +500 -19
- package/build/cjs/src/events-v3-event.universal.js +124 -1
- package/build/cjs/src/events-v3-event.universal.js.map +1 -1
- package/build/es/index.d.ts +3 -3
- package/build/es/index.js +3 -3
- package/build/es/index.js.map +1 -1
- package/build/es/index.typings.d.ts +3 -3
- package/build/es/index.typings.js +3 -3
- package/build/es/index.typings.js.map +1 -1
- package/build/es/meta.d.ts +3 -3
- package/build/es/meta.js +3 -3
- package/build/es/meta.js.map +1 -1
- package/build/es/src/events-guests-v1-guest.universal.d.ts +4 -0
- package/build/es/src/events-guests-v1-guest.universal.js +4 -0
- package/build/es/src/events-guests-v1-guest.universal.js.map +1 -1
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.d.ts +22 -22
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js +22 -22
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +4 -4
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +4 -4
- package/build/es/src/events-schedule-v1-schedule-item-schedule.http.d.ts +22 -22
- package/build/es/src/events-schedule-v1-schedule-item-schedule.http.js +22 -22
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +18 -18
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js +18 -18
- package/build/es/src/events-v2-policy.universal.d.ts +14 -0
- package/build/es/src/events-v2-policy.universal.js +14 -0
- package/build/es/src/events-v2-policy.universal.js.map +1 -1
- package/build/es/src/events-v3-event.public.d.ts +2 -2
- package/build/es/src/events-v3-event.public.js +1 -1
- package/build/es/src/events-v3-event.public.js.map +1 -1
- package/build/es/src/events-v3-event.types.d.ts +468 -21
- package/build/es/src/events-v3-event.types.js +77 -0
- package/build/es/src/events-v3-event.types.js.map +1 -1
- package/build/es/src/events-v3-event.universal.d.ts +500 -19
- package/build/es/src/events-v3-event.universal.js +123 -0
- package/build/es/src/events-v3-event.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1346,19 +1346,7 @@ export interface FindEventResponse {
|
|
|
1346
1346
|
/** Event. */
|
|
1347
1347
|
event?: Event;
|
|
1348
1348
|
}
|
|
1349
|
-
export interface
|
|
1350
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
1351
|
-
timestamp?: Date;
|
|
1352
|
-
/** Event ID. */
|
|
1353
|
-
eventId?: string;
|
|
1354
|
-
/** Event title. */
|
|
1355
|
-
title?: string;
|
|
1356
|
-
/** Event creator user ID. */
|
|
1357
|
-
userId?: string | null;
|
|
1358
|
-
}
|
|
1359
|
-
export interface Empty {
|
|
1360
|
-
}
|
|
1361
|
-
export interface EventCopied {
|
|
1349
|
+
export interface EventCreated {
|
|
1362
1350
|
/** Event created timestamp in ISO UTC format. */
|
|
1363
1351
|
timestamp?: Date;
|
|
1364
1352
|
/** Event ID. */
|
|
@@ -1377,12 +1365,8 @@ export interface EventCopied {
|
|
|
1377
1365
|
derivedFromInstanceId?: string | null;
|
|
1378
1366
|
/** Event ID. Indicates the original event which current event was derived from. */
|
|
1379
1367
|
derivedFromEventId?: string | null;
|
|
1380
|
-
/**
|
|
1381
|
-
|
|
1382
|
-
* Key represents ticket def id in the original event.
|
|
1383
|
-
* Value represents ticket def id in the newly created event.
|
|
1384
|
-
*/
|
|
1385
|
-
ticketDefinitions?: Record<string, string>;
|
|
1368
|
+
/** Event that was created. */
|
|
1369
|
+
event?: EventsEvent;
|
|
1386
1370
|
}
|
|
1387
1371
|
export interface EventsLocation {
|
|
1388
1372
|
/** Location name. */
|
|
@@ -1551,6 +1535,457 @@ export declare enum EventStatus {
|
|
|
1551
1535
|
/** Event is not public and needs to be published */
|
|
1552
1536
|
DRAFT = "DRAFT"
|
|
1553
1537
|
}
|
|
1538
|
+
export interface EventsEvent {
|
|
1539
|
+
/**
|
|
1540
|
+
* Event ID.
|
|
1541
|
+
* @readonly
|
|
1542
|
+
*/
|
|
1543
|
+
_id?: string;
|
|
1544
|
+
/** Event location. */
|
|
1545
|
+
location?: EventsLocation;
|
|
1546
|
+
/** Event scheduling. */
|
|
1547
|
+
scheduling?: Scheduling;
|
|
1548
|
+
/** Event title. */
|
|
1549
|
+
title?: string;
|
|
1550
|
+
/** Event description. */
|
|
1551
|
+
description?: string;
|
|
1552
|
+
/** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
|
|
1553
|
+
about?: string;
|
|
1554
|
+
/** Main event image. */
|
|
1555
|
+
mainImage?: string;
|
|
1556
|
+
/** Event slug URL (generated from event title). */
|
|
1557
|
+
slug?: string;
|
|
1558
|
+
/** ISO 639-1 language code of the event (used in content translations). */
|
|
1559
|
+
language?: string;
|
|
1560
|
+
/** Event creation timestamp. */
|
|
1561
|
+
created?: Date;
|
|
1562
|
+
/** Event modified timestamp. */
|
|
1563
|
+
modified?: Date;
|
|
1564
|
+
/** Event status. */
|
|
1565
|
+
status?: EventStatus;
|
|
1566
|
+
/** RSVP or ticketing registration details. */
|
|
1567
|
+
registration?: EventsRegistration;
|
|
1568
|
+
/** "Add to calendar" URLs. */
|
|
1569
|
+
calendarLinks?: CalendarLinks;
|
|
1570
|
+
/** Event page URL components. */
|
|
1571
|
+
eventPageUrl?: SiteUrl;
|
|
1572
|
+
/** Event registration form. */
|
|
1573
|
+
form?: Form;
|
|
1574
|
+
/** Event dashboard summary of RSVP / ticket sales. */
|
|
1575
|
+
dashboard?: Dashboard;
|
|
1576
|
+
/** Instance ID of the site where event is hosted. */
|
|
1577
|
+
instanceId?: string;
|
|
1578
|
+
/** Guest list configuration. */
|
|
1579
|
+
guestListConfig?: GuestListConfig;
|
|
1580
|
+
/** Event creator user ID. */
|
|
1581
|
+
userId?: string;
|
|
1582
|
+
/** Event discussion feed. For internal use. */
|
|
1583
|
+
feed?: EventsFeed;
|
|
1584
|
+
/** Online conferencing details. */
|
|
1585
|
+
onlineConferencing?: EventsOnlineConferencing;
|
|
1586
|
+
/** SEO settings. */
|
|
1587
|
+
seoSettings?: EventsSeoSettings;
|
|
1588
|
+
/** Assigned contacts label key. */
|
|
1589
|
+
assignedContactsLabel?: string | null;
|
|
1590
|
+
/** Agenda details. */
|
|
1591
|
+
agenda?: Agenda;
|
|
1592
|
+
/** Categories this event is assigned to. */
|
|
1593
|
+
categories?: Category[];
|
|
1594
|
+
/** Visual settings for event. */
|
|
1595
|
+
eventDisplaySettings?: EventsEventDisplaySettings;
|
|
1596
|
+
}
|
|
1597
|
+
export interface Scheduling {
|
|
1598
|
+
/** Schedule configuration. */
|
|
1599
|
+
config?: ScheduleConfig;
|
|
1600
|
+
/** Formatted schedule representation. */
|
|
1601
|
+
formatted?: string;
|
|
1602
|
+
/** Formatted start date of the event (empty for TBD schedules). */
|
|
1603
|
+
startDateFormatted?: string;
|
|
1604
|
+
/** Formatted start time of the event (empty for TBD schedules). */
|
|
1605
|
+
startTimeFormatted?: string;
|
|
1606
|
+
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
1607
|
+
endDateFormatted?: string;
|
|
1608
|
+
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
1609
|
+
endTimeFormatted?: string;
|
|
1610
|
+
}
|
|
1611
|
+
export interface EventsRegistration {
|
|
1612
|
+
/** Event type. */
|
|
1613
|
+
type?: EventType;
|
|
1614
|
+
/** Event registration status. */
|
|
1615
|
+
status?: RegistrationStatus;
|
|
1616
|
+
/** RSVP collection details. */
|
|
1617
|
+
rsvpCollection?: RsvpCollection;
|
|
1618
|
+
/** Ticketing details. */
|
|
1619
|
+
ticketing?: Ticketing;
|
|
1620
|
+
/** External registration details. */
|
|
1621
|
+
external?: ExternalEvent;
|
|
1622
|
+
/** Types of users allowed to register. */
|
|
1623
|
+
restrictedTo?: VisitorType;
|
|
1624
|
+
/** Initial event type which was set when creating an event. */
|
|
1625
|
+
initialType?: EventType;
|
|
1626
|
+
}
|
|
1627
|
+
export declare enum EventType {
|
|
1628
|
+
/** Type not available for this request fieldset */
|
|
1629
|
+
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
1630
|
+
/** Registration via RSVP */
|
|
1631
|
+
RSVP = "RSVP",
|
|
1632
|
+
/** Registration via ticket purchase */
|
|
1633
|
+
TICKETS = "TICKETS",
|
|
1634
|
+
/** External registration */
|
|
1635
|
+
EXTERNAL = "EXTERNAL",
|
|
1636
|
+
/** Registration not available */
|
|
1637
|
+
NO_REGISTRATION = "NO_REGISTRATION"
|
|
1638
|
+
}
|
|
1639
|
+
export declare enum RegistrationStatus {
|
|
1640
|
+
/** Registration status is not applicable */
|
|
1641
|
+
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
1642
|
+
/** Registration to event is closed */
|
|
1643
|
+
CLOSED = "CLOSED",
|
|
1644
|
+
/** Registration to event is closed manually */
|
|
1645
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
1646
|
+
/** Registration is open via RSVP */
|
|
1647
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
1648
|
+
/** Registration to event waitlist is open via RSVP */
|
|
1649
|
+
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
1650
|
+
/** Registration is open via ticket purchase */
|
|
1651
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
1652
|
+
/** Registration is open via external URL */
|
|
1653
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
1654
|
+
/** Registration will be open via RSVP */
|
|
1655
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
1656
|
+
}
|
|
1657
|
+
export interface RsvpCollection {
|
|
1658
|
+
/** RSVP collection configuration. */
|
|
1659
|
+
config?: RsvpCollectionConfig;
|
|
1660
|
+
}
|
|
1661
|
+
export interface RsvpCollectionConfig {
|
|
1662
|
+
/** Defines the supported RSVP statuses. */
|
|
1663
|
+
rsvpStatusOptions?: RsvpStatusOptions;
|
|
1664
|
+
/**
|
|
1665
|
+
* Total guest limit available to register to the event.
|
|
1666
|
+
* Additional guests per RSVP are counted towards total guests.
|
|
1667
|
+
*/
|
|
1668
|
+
limit?: number | null;
|
|
1669
|
+
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
1670
|
+
waitlist?: boolean;
|
|
1671
|
+
/** Registration start timestamp. */
|
|
1672
|
+
startDate?: Date;
|
|
1673
|
+
/** Registration end timestamp. */
|
|
1674
|
+
endDate?: Date;
|
|
1675
|
+
}
|
|
1676
|
+
export declare enum RsvpStatusOptions {
|
|
1677
|
+
/** Only YES RSVP status is available for RSVP registration */
|
|
1678
|
+
YES_ONLY = "YES_ONLY",
|
|
1679
|
+
/** YES and NO RSVP status options are available for the registration */
|
|
1680
|
+
YES_AND_NO = "YES_AND_NO"
|
|
1681
|
+
}
|
|
1682
|
+
export interface Ticketing {
|
|
1683
|
+
/** Deprecated. */
|
|
1684
|
+
lowestPrice?: string | null;
|
|
1685
|
+
/** Deprecated. */
|
|
1686
|
+
highestPrice?: string | null;
|
|
1687
|
+
/** Currency used in event transactions. */
|
|
1688
|
+
currency?: string | null;
|
|
1689
|
+
/** Ticketing configuration. */
|
|
1690
|
+
config?: TicketingConfig;
|
|
1691
|
+
/**
|
|
1692
|
+
* Price of lowest priced ticket.
|
|
1693
|
+
* @readonly
|
|
1694
|
+
*/
|
|
1695
|
+
lowestTicketPrice?: EventsMoney;
|
|
1696
|
+
/**
|
|
1697
|
+
* Price of highest priced ticket.
|
|
1698
|
+
* @readonly
|
|
1699
|
+
*/
|
|
1700
|
+
highestTicketPrice?: EventsMoney;
|
|
1701
|
+
/**
|
|
1702
|
+
* Formatted price of lowest priced ticket.
|
|
1703
|
+
* @readonly
|
|
1704
|
+
*/
|
|
1705
|
+
lowestTicketPriceFormatted?: string | null;
|
|
1706
|
+
/**
|
|
1707
|
+
* Formatted price of highest priced ticket.
|
|
1708
|
+
* @readonly
|
|
1709
|
+
*/
|
|
1710
|
+
highestTicketPriceFormatted?: string | null;
|
|
1711
|
+
/**
|
|
1712
|
+
* Whether all tickets are sold for this event.
|
|
1713
|
+
* @readonly
|
|
1714
|
+
*/
|
|
1715
|
+
soldOut?: boolean | null;
|
|
1716
|
+
}
|
|
1717
|
+
export interface TicketingConfig {
|
|
1718
|
+
/** Whether the form must be filled out separately for each ticket. */
|
|
1719
|
+
guestAssignedTickets?: boolean;
|
|
1720
|
+
/** Tax configuration. */
|
|
1721
|
+
taxConfig?: TaxConfig;
|
|
1722
|
+
/** Limit of tickets that can be purchased per order, default 20. */
|
|
1723
|
+
ticketLimitPerOrder?: number;
|
|
1724
|
+
/** Duration for which the tickets being bought are reserved. */
|
|
1725
|
+
reservationDurationInMinutes?: number | null;
|
|
1726
|
+
}
|
|
1727
|
+
export interface TaxConfig {
|
|
1728
|
+
/** Tax application settings. */
|
|
1729
|
+
type?: EventsTaxType;
|
|
1730
|
+
/** Tax name. */
|
|
1731
|
+
name?: string | null;
|
|
1732
|
+
/** Tax rate (e.g.,`21.55`). */
|
|
1733
|
+
rate?: string | null;
|
|
1734
|
+
/** Applies taxes for donations, default true. */
|
|
1735
|
+
appliesToDonations?: boolean | null;
|
|
1736
|
+
}
|
|
1737
|
+
export declare enum EventsTaxType {
|
|
1738
|
+
/** Tax is included in the ticket price */
|
|
1739
|
+
INCLUDED = "INCLUDED",
|
|
1740
|
+
/** Tax is added to the order at the checkout */
|
|
1741
|
+
ADDED = "ADDED",
|
|
1742
|
+
/** Tax is added to the final total at the checkout */
|
|
1743
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1744
|
+
}
|
|
1745
|
+
export interface ExternalEvent {
|
|
1746
|
+
/** External event registration URL. */
|
|
1747
|
+
registration?: string;
|
|
1748
|
+
}
|
|
1749
|
+
export declare enum VisitorType {
|
|
1750
|
+
/** Site visitor (including member) */
|
|
1751
|
+
VISITOR = "VISITOR",
|
|
1752
|
+
/** Site member */
|
|
1753
|
+
MEMBER = "MEMBER",
|
|
1754
|
+
/** Site visitor or member */
|
|
1755
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
1756
|
+
}
|
|
1757
|
+
export interface CalendarLinks {
|
|
1758
|
+
/** "Add to Google calendar" URL. */
|
|
1759
|
+
google?: string;
|
|
1760
|
+
/** "Download ICS calendar file" URL. */
|
|
1761
|
+
ics?: string;
|
|
1762
|
+
}
|
|
1763
|
+
/** Site URL components */
|
|
1764
|
+
export interface SiteUrl {
|
|
1765
|
+
/**
|
|
1766
|
+
* Base URL. For premium sites, this will be the domain.
|
|
1767
|
+
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
1768
|
+
*/
|
|
1769
|
+
base?: string;
|
|
1770
|
+
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
1771
|
+
path?: string;
|
|
1772
|
+
}
|
|
1773
|
+
export interface Dashboard {
|
|
1774
|
+
/** Guest RSVP summary. */
|
|
1775
|
+
rsvpSummary?: RsvpSummary;
|
|
1776
|
+
/**
|
|
1777
|
+
* Summary of revenue and tickets sold.
|
|
1778
|
+
* (Archived orders are not included).
|
|
1779
|
+
*/
|
|
1780
|
+
ticketingSummary?: TicketingSummary;
|
|
1781
|
+
}
|
|
1782
|
+
export interface RsvpSummary {
|
|
1783
|
+
/** Total number of RSVPs. */
|
|
1784
|
+
total?: number;
|
|
1785
|
+
/** Number of RSVPs with status `YES`. */
|
|
1786
|
+
yes?: number;
|
|
1787
|
+
/** Number of RSVPs with status `NO`. */
|
|
1788
|
+
no?: number;
|
|
1789
|
+
/** Number of RSVPs in waitlist. */
|
|
1790
|
+
waitlist?: number;
|
|
1791
|
+
}
|
|
1792
|
+
export interface TicketingSummary {
|
|
1793
|
+
/** Number of tickets sold. */
|
|
1794
|
+
tickets?: number;
|
|
1795
|
+
/**
|
|
1796
|
+
* Total revenue, excluding fees.
|
|
1797
|
+
* (taxes and payment provider fees are not deducted.)
|
|
1798
|
+
*/
|
|
1799
|
+
revenue?: EventsMoney;
|
|
1800
|
+
/** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
|
|
1801
|
+
currencyLocked?: boolean;
|
|
1802
|
+
/** Number of orders placed. */
|
|
1803
|
+
orders?: number;
|
|
1804
|
+
/** Total balance of confirmed transactions. */
|
|
1805
|
+
totalSales?: EventsMoney;
|
|
1806
|
+
}
|
|
1807
|
+
export interface GuestListConfig {
|
|
1808
|
+
/** Whether members can see other members attending the event (defaults to true). */
|
|
1809
|
+
publicGuestList?: boolean;
|
|
1810
|
+
}
|
|
1811
|
+
export interface EventsFeed {
|
|
1812
|
+
/** Event discussion feed token. */
|
|
1813
|
+
token?: string;
|
|
1814
|
+
}
|
|
1815
|
+
export interface EventsOnlineConferencing {
|
|
1816
|
+
config?: OnlineConferencingConfig;
|
|
1817
|
+
session?: EventsOnlineConferencingSession;
|
|
1818
|
+
}
|
|
1819
|
+
export interface OnlineConferencingConfig {
|
|
1820
|
+
/**
|
|
1821
|
+
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1822
|
+
* When enabled, links to join conferencing are generated and provided to guests.
|
|
1823
|
+
*/
|
|
1824
|
+
enabled?: boolean;
|
|
1825
|
+
/** Conferencing provider ID. */
|
|
1826
|
+
providerId?: string | null;
|
|
1827
|
+
/** Conference type */
|
|
1828
|
+
conferenceType?: ConferenceType;
|
|
1829
|
+
}
|
|
1830
|
+
export declare enum ConferenceType {
|
|
1831
|
+
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1832
|
+
MEETING = "MEETING",
|
|
1833
|
+
/** Guests can only subscribe to video and audio. */
|
|
1834
|
+
WEBINAR = "WEBINAR"
|
|
1835
|
+
}
|
|
1836
|
+
export interface EventsOnlineConferencingSession {
|
|
1837
|
+
/**
|
|
1838
|
+
* Link for event host to start the online conference session.
|
|
1839
|
+
* @readonly
|
|
1840
|
+
*/
|
|
1841
|
+
hostLink?: string;
|
|
1842
|
+
/**
|
|
1843
|
+
* Link for guests to join the online conference session.
|
|
1844
|
+
* @readonly
|
|
1845
|
+
*/
|
|
1846
|
+
guestLink?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* The password required to join online conferencing session (when relevant).
|
|
1849
|
+
* @readonly
|
|
1850
|
+
*/
|
|
1851
|
+
password?: string | null;
|
|
1852
|
+
/**
|
|
1853
|
+
* Indicates that session was created successfully on providers side.
|
|
1854
|
+
* @readonly
|
|
1855
|
+
*/
|
|
1856
|
+
sessionCreated?: boolean | null;
|
|
1857
|
+
/**
|
|
1858
|
+
* Unique session id
|
|
1859
|
+
* @readonly
|
|
1860
|
+
*/
|
|
1861
|
+
sessionId?: string | null;
|
|
1862
|
+
}
|
|
1863
|
+
export interface EventsSeoSettings {
|
|
1864
|
+
/** URL slug */
|
|
1865
|
+
slug?: string;
|
|
1866
|
+
/** Advanced SEO data */
|
|
1867
|
+
advancedSeoData?: SeoSchema;
|
|
1868
|
+
/**
|
|
1869
|
+
* Hidden from SEO Site Map
|
|
1870
|
+
* @readonly
|
|
1871
|
+
*/
|
|
1872
|
+
hidden?: boolean | null;
|
|
1873
|
+
}
|
|
1874
|
+
export interface Agenda {
|
|
1875
|
+
/** Whether the schedule is enabled for the event. */
|
|
1876
|
+
enabled?: boolean;
|
|
1877
|
+
/**
|
|
1878
|
+
* Agenda page URL.
|
|
1879
|
+
* @readonly
|
|
1880
|
+
*/
|
|
1881
|
+
pageUrl?: SiteUrl;
|
|
1882
|
+
}
|
|
1883
|
+
export interface Category {
|
|
1884
|
+
/**
|
|
1885
|
+
* Category ID.
|
|
1886
|
+
* @readonly
|
|
1887
|
+
*/
|
|
1888
|
+
_id?: string;
|
|
1889
|
+
/** Category name. */
|
|
1890
|
+
name?: string;
|
|
1891
|
+
/**
|
|
1892
|
+
* Category creation timestamp.
|
|
1893
|
+
* @readonly
|
|
1894
|
+
*/
|
|
1895
|
+
_createdDate?: Date;
|
|
1896
|
+
/**
|
|
1897
|
+
* Assigned events count. Deleted events are excluded.
|
|
1898
|
+
* @readonly
|
|
1899
|
+
*/
|
|
1900
|
+
assignedEventsCount?: number | null;
|
|
1901
|
+
/**
|
|
1902
|
+
* Assigned and assigned draft event counts.
|
|
1903
|
+
* @readonly
|
|
1904
|
+
*/
|
|
1905
|
+
counts?: CategoryCounts;
|
|
1906
|
+
/**
|
|
1907
|
+
* Category state. Default - MANUAL.
|
|
1908
|
+
* WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
|
|
1909
|
+
* Field will be ignored on update requests.
|
|
1910
|
+
*/
|
|
1911
|
+
states?: State[];
|
|
1912
|
+
}
|
|
1913
|
+
export interface CategoryCounts {
|
|
1914
|
+
/** Assigned events count. Deleted events are excluded. */
|
|
1915
|
+
assignedEventsCount?: number | null;
|
|
1916
|
+
/** Assigned draft events count. */
|
|
1917
|
+
assignedDraftEventsCount?: number | null;
|
|
1918
|
+
}
|
|
1919
|
+
export declare enum State {
|
|
1920
|
+
/** Created manually by the user. */
|
|
1921
|
+
MANUAL = "MANUAL",
|
|
1922
|
+
/** Created automatically. */
|
|
1923
|
+
AUTO = "AUTO",
|
|
1924
|
+
/** Created when publishing recurring events. */
|
|
1925
|
+
RECURRING_EVENT = "RECURRING_EVENT",
|
|
1926
|
+
/** Category is hidden. */
|
|
1927
|
+
HIDDEN = "HIDDEN",
|
|
1928
|
+
/** Category is used to store component events. */
|
|
1929
|
+
COMPONENT = "COMPONENT"
|
|
1930
|
+
}
|
|
1931
|
+
export interface EventsEventDisplaySettings {
|
|
1932
|
+
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1933
|
+
hideEventDetailsButton?: boolean | null;
|
|
1934
|
+
}
|
|
1935
|
+
export interface Empty {
|
|
1936
|
+
}
|
|
1937
|
+
export interface EventUpdated {
|
|
1938
|
+
/** Event update timestamp in ISO UTC format. */
|
|
1939
|
+
timestamp?: Date;
|
|
1940
|
+
/** Event ID. */
|
|
1941
|
+
eventId?: string;
|
|
1942
|
+
/** Event location. */
|
|
1943
|
+
location?: EventsLocation;
|
|
1944
|
+
/** Event schedule configuration. */
|
|
1945
|
+
scheduleConfig?: ScheduleConfig;
|
|
1946
|
+
/** Event title. */
|
|
1947
|
+
title?: string;
|
|
1948
|
+
/** Whether schedule configuration was updated. */
|
|
1949
|
+
scheduleConfigUpdated?: boolean;
|
|
1950
|
+
/** Updated event */
|
|
1951
|
+
event?: EventsEvent;
|
|
1952
|
+
}
|
|
1953
|
+
export interface EventDeleted {
|
|
1954
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
1955
|
+
timestamp?: Date;
|
|
1956
|
+
/** Event ID. */
|
|
1957
|
+
eventId?: string;
|
|
1958
|
+
/** Event title. */
|
|
1959
|
+
title?: string;
|
|
1960
|
+
/** Event creator user ID. */
|
|
1961
|
+
userId?: string | null;
|
|
1962
|
+
}
|
|
1963
|
+
export interface EventCopied {
|
|
1964
|
+
/** Event created timestamp in ISO UTC format. */
|
|
1965
|
+
timestamp?: Date;
|
|
1966
|
+
/** Event ID. */
|
|
1967
|
+
eventId?: string;
|
|
1968
|
+
/** Event location. */
|
|
1969
|
+
location?: EventsLocation;
|
|
1970
|
+
/** Event schedule configuration. */
|
|
1971
|
+
scheduleConfig?: ScheduleConfig;
|
|
1972
|
+
/** Event title. */
|
|
1973
|
+
title?: string;
|
|
1974
|
+
/** Event creator user ID. */
|
|
1975
|
+
userId?: string | null;
|
|
1976
|
+
/** Event status. */
|
|
1977
|
+
status?: EventStatus;
|
|
1978
|
+
/** Instance ID. Indicates the original app instance which current event was derived from. */
|
|
1979
|
+
derivedFromInstanceId?: string | null;
|
|
1980
|
+
/** Event ID. Indicates the original event which current event was derived from. */
|
|
1981
|
+
derivedFromEventId?: string | null;
|
|
1982
|
+
/**
|
|
1983
|
+
* Map of copied ticket definitions from original event.
|
|
1984
|
+
* Key represents ticket def id in the original event.
|
|
1985
|
+
* Value represents ticket def id in the newly created event.
|
|
1986
|
+
*/
|
|
1987
|
+
ticketDefinitions?: Record<string, string>;
|
|
1988
|
+
}
|
|
1554
1989
|
export interface EventPublished {
|
|
1555
1990
|
/** Event publish timestamp in ISO UTC format. */
|
|
1556
1991
|
timestamp?: Date;
|
|
@@ -3350,7 +3785,9 @@ export interface FindEventResponseNonNullableFields {
|
|
|
3350
3785
|
* @requiredField event.location
|
|
3351
3786
|
* @requiredField event.title
|
|
3352
3787
|
* @permissionScope Manage Events - all permissions
|
|
3788
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3353
3789
|
* @permissionScope Manage Events
|
|
3790
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3354
3791
|
* @applicableIdentity APP
|
|
3355
3792
|
* @returns Created event.
|
|
3356
3793
|
*/
|
|
@@ -3384,7 +3821,9 @@ export interface CreateEventOptions {
|
|
|
3384
3821
|
* @documentationMaturity preview
|
|
3385
3822
|
* @requiredField eventId
|
|
3386
3823
|
* @permissionScope Manage Events - all permissions
|
|
3824
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3387
3825
|
* @permissionScope Manage Events
|
|
3826
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3388
3827
|
* @applicableIdentity APP
|
|
3389
3828
|
*/
|
|
3390
3829
|
export declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<CloneEventResponse & CloneEventResponseNonNullableFields>;
|
|
@@ -3416,7 +3855,9 @@ export interface CloneEventOptions {
|
|
|
3416
3855
|
* @documentationMaturity preview
|
|
3417
3856
|
* @requiredField _id
|
|
3418
3857
|
* @permissionScope Manage Events - all permissions
|
|
3858
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3419
3859
|
* @permissionScope Manage Events
|
|
3860
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3420
3861
|
* @applicableIdentity APP
|
|
3421
3862
|
* @returns Updated event.
|
|
3422
3863
|
*/
|
|
@@ -3511,7 +3952,9 @@ export interface UpdateEventOptions {
|
|
|
3511
3952
|
* @documentationMaturity preview
|
|
3512
3953
|
* @requiredField eventId
|
|
3513
3954
|
* @permissionScope Manage Events - all permissions
|
|
3955
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3514
3956
|
* @permissionScope Manage Events
|
|
3957
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3515
3958
|
* @applicableIdentity APP
|
|
3516
3959
|
*/
|
|
3517
3960
|
export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
|
|
@@ -3541,7 +3984,9 @@ export interface PublishDraftEventOptions {
|
|
|
3541
3984
|
* @documentationMaturity preview
|
|
3542
3985
|
* @requiredField eventId
|
|
3543
3986
|
* @permissionScope Manage Events - all permissions
|
|
3987
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3544
3988
|
* @permissionScope Manage Events
|
|
3989
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3545
3990
|
* @applicableIdentity APP
|
|
3546
3991
|
*/
|
|
3547
3992
|
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
|
|
@@ -3570,7 +4015,9 @@ export interface CancelEventOptions {
|
|
|
3570
4015
|
* @documentationMaturity preview
|
|
3571
4016
|
* @requiredField options.filter.filter
|
|
3572
4017
|
* @permissionScope Manage Events - all permissions
|
|
4018
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3573
4019
|
* @permissionScope Manage Events
|
|
4020
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3574
4021
|
* @applicableIdentity APP
|
|
3575
4022
|
*/
|
|
3576
4023
|
export declare function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise<void>;
|
|
@@ -3586,7 +4033,9 @@ export interface BulkCancelEventsByFilterOptions {
|
|
|
3586
4033
|
* @documentationMaturity preview
|
|
3587
4034
|
* @requiredField eventId
|
|
3588
4035
|
* @permissionScope Manage Events - all permissions
|
|
4036
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3589
4037
|
* @permissionScope Manage Events
|
|
4038
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3590
4039
|
* @applicableIdentity APP
|
|
3591
4040
|
*/
|
|
3592
4041
|
export declare function deleteEvent(eventId: string): Promise<DeleteEventResponse & DeleteEventResponseNonNullableFields>;
|
|
@@ -3597,7 +4046,9 @@ export declare function deleteEvent(eventId: string): Promise<DeleteEventRespons
|
|
|
3597
4046
|
* @documentationMaturity preview
|
|
3598
4047
|
* @requiredField options.filter.filter
|
|
3599
4048
|
* @permissionScope Manage Events - all permissions
|
|
4049
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3600
4050
|
* @permissionScope Manage Events
|
|
4051
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3601
4052
|
* @applicableIdentity APP
|
|
3602
4053
|
*/
|
|
3603
4054
|
export declare function bulkDeleteEventsByFilter(options?: BulkDeleteEventsByFilterOptions): Promise<void>;
|
|
@@ -3616,11 +4067,17 @@ export interface BulkDeleteEventsByFilterOptions {
|
|
|
3616
4067
|
* @public
|
|
3617
4068
|
* @documentationMaturity preview
|
|
3618
4069
|
* @permissionScope Read Events - all read permissions
|
|
4070
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3619
4071
|
* @permissionScope Manage Bookings Services and Settings
|
|
4072
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3620
4073
|
* @permissionScope Manage Events - all permissions
|
|
4074
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3621
4075
|
* @permissionScope Read Events
|
|
4076
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3622
4077
|
* @permissionScope Manage Guest List
|
|
4078
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3623
4079
|
* @permissionScope Manage Events
|
|
4080
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3624
4081
|
* @applicableIdentity APP
|
|
3625
4082
|
* @applicableIdentity MEMBER
|
|
3626
4083
|
* @applicableIdentity VISITOR
|
|
@@ -3721,11 +4178,17 @@ export interface EventsQueryBuilder {
|
|
|
3721
4178
|
* @public
|
|
3722
4179
|
* @documentationMaturity preview
|
|
3723
4180
|
* @permissionScope Read Events - all read permissions
|
|
4181
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3724
4182
|
* @permissionScope Manage Bookings Services and Settings
|
|
4183
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3725
4184
|
* @permissionScope Manage Events - all permissions
|
|
4185
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3726
4186
|
* @permissionScope Read Events
|
|
4187
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3727
4188
|
* @permissionScope Manage Guest List
|
|
4189
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3728
4190
|
* @permissionScope Manage Events
|
|
4191
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3729
4192
|
* @applicableIdentity APP
|
|
3730
4193
|
* @applicableIdentity MEMBER
|
|
3731
4194
|
* @applicableIdentity VISITOR
|
|
@@ -3753,11 +4216,17 @@ export interface CountEventsByStatusOptions {
|
|
|
3753
4216
|
* @documentationMaturity preview
|
|
3754
4217
|
* @requiredField eventId
|
|
3755
4218
|
* @permissionScope Read Events - all read permissions
|
|
4219
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3756
4220
|
* @permissionScope Manage Bookings Services and Settings
|
|
4221
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3757
4222
|
* @permissionScope Manage Events - all permissions
|
|
4223
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3758
4224
|
* @permissionScope Read Events
|
|
4225
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3759
4226
|
* @permissionScope Manage Guest List
|
|
4227
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3760
4228
|
* @permissionScope Manage Events
|
|
4229
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3761
4230
|
* @applicableIdentity APP
|
|
3762
4231
|
* @applicableIdentity MEMBER
|
|
3763
4232
|
* @applicableIdentity VISITOR
|
|
@@ -3788,11 +4257,17 @@ export interface GetEventOptions {
|
|
|
3788
4257
|
* @documentationMaturity preview
|
|
3789
4258
|
* @requiredField slug
|
|
3790
4259
|
* @permissionScope Read Events - all read permissions
|
|
4260
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3791
4261
|
* @permissionScope Manage Bookings Services and Settings
|
|
4262
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3792
4263
|
* @permissionScope Manage Events - all permissions
|
|
4264
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3793
4265
|
* @permissionScope Read Events
|
|
4266
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3794
4267
|
* @permissionScope Manage Guest List
|
|
4268
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3795
4269
|
* @permissionScope Manage Events
|
|
4270
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3796
4271
|
* @applicableIdentity APP
|
|
3797
4272
|
* @applicableIdentity MEMBER
|
|
3798
4273
|
* @applicableIdentity VISITOR
|
|
@@ -3821,11 +4296,17 @@ export interface GetEventBySlugOptions {
|
|
|
3821
4296
|
* @public
|
|
3822
4297
|
* @documentationMaturity preview
|
|
3823
4298
|
* @permissionScope Read Events - all read permissions
|
|
4299
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3824
4300
|
* @permissionScope Manage Bookings Services and Settings
|
|
4301
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3825
4302
|
* @permissionScope Manage Events - all permissions
|
|
4303
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3826
4304
|
* @permissionScope Read Events
|
|
4305
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3827
4306
|
* @permissionScope Manage Guest List
|
|
4307
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3828
4308
|
* @permissionScope Manage Events
|
|
4309
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3829
4310
|
* @applicableIdentity APP
|
|
3830
4311
|
* @applicableIdentity MEMBER
|
|
3831
4312
|
* @applicableIdentity VISITOR
|