@wix/events 1.0.12 → 1.0.14

package/build/cjs/index.d.ts

@@ -1,5 +1,12 @@
 export * as guests from './src/events-guests-v1-guest.public';
+export * as scheduleBookmarks from './src/events-schedule-v1-schedule-item-schedule-bookmarks.public';
+export * as schedule from './src/events-schedule-v1-schedule-item-schedule.public';
 export * as categories from './src/events-v1-category.public';
 export * as events from './src/events-v1-event.public';
 export * as forms from './src/events-v1-form.public';
-export * as policy from './src/events-v2-policy.public';
+export * as checkout from './src/events-v1-order-checkout.public';
+export * as orders from './src/events-v1-order-orders.public';
+export * as rsvp from './src/events-v1-rsvp.public';
+export * as tickets from './src/events-v1-ticket.public';
+export * as ticketDefinitions from './src/events-v1-ticket-definition.public';
+export * as policies from './src/events-v2-policy.public';

package/build/cjs/index.js

@@ -19,10 +19,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.policy = exports.forms = exports.events = exports.categories = exports.guests = void 0;
+exports.policies = exports.ticketDefinitions = exports.tickets = exports.rsvp = exports.orders = exports.checkout = exports.forms = exports.events = exports.categories = exports.schedule = exports.scheduleBookmarks = exports.guests = void 0;
 exports.guests = __importStar(require("./src/events-guests-v1-guest.public"));
+exports.scheduleBookmarks = __importStar(require("./src/events-schedule-v1-schedule-item-schedule-bookmarks.public"));
+exports.schedule = __importStar(require("./src/events-schedule-v1-schedule-item-schedule.public"));
 exports.categories = __importStar(require("./src/events-v1-category.public"));
 exports.events = __importStar(require("./src/events-v1-event.public"));
 exports.forms = __importStar(require("./src/events-v1-form.public"));
-exports.policy = __importStar(require("./src/events-v2-policy.public"));
+exports.checkout = __importStar(require("./src/events-v1-order-checkout.public"));
+exports.orders = __importStar(require("./src/events-v1-order-orders.public"));
+exports.rsvp = __importStar(require("./src/events-v1-rsvp.public"));
+exports.tickets = __importStar(require("./src/events-v1-ticket.public"));
+exports.ticketDefinitions = __importStar(require("./src/events-v1-ticket-definition.public"));
+exports.policies = __importStar(require("./src/events-v2-policy.public"));
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,8EAA8D;AAC9D,8EAA8D;AAC9D,uEAAuD;AACvD,qEAAqD;AACrD,wEAAwD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,8EAA8D;AAC9D,sHAAsG;AACtG,mGAAmF;AACnF,8EAA8D;AAC9D,uEAAuD;AACvD,qEAAqD;AACrD,kFAAkE;AAClE,8EAA8D;AAC9D,oEAAoD;AACpD,yEAAyD;AACzD,8FAA8E;AAC9E,0EAA0D"}

package/build/cjs/src/events-guests-v1-guest.http.d.ts

@@ -1,7 +1,4 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
 import { QueryEventGuestsRequest, QueryEventGuestsResponse } from './events-guests-v1-guest.types';
-/**
- * Query to select guests.
- * Supports efficient filtering by `createdDate`, `eventId`, `attendanceStatus`, `secondaryLanguageCode`, `rsvpId`, `orderNumber`, `ticketNumber`, `memberId` or `guestDetails.checkedIn`
- */
+/** Retrieves a list of guests according to the provided filters and paging. */
 export declare function queryEventGuests(payload: QueryEventGuestsRequest): RequestOptionsFactory<QueryEventGuestsResponse>;

package/build/cjs/src/events-guests-v1-guest.http.js

@@ -25,13 +25,35 @@ const _inputValue = {
 const _queryEventGuestsRequest = {};
 const _queryEventGuestsResponse = { guests: '_eventGuest' };
 function resolveWixEventsGuestsV1EventGuestsServiceUrl(opts) {
-    const domainToMappings = {};
+    const domainToMappings = {
+        'api._api_base_domain_': [
+            {
+                srcPath: '/events-guests',
+                destPath: '',
+            },
+        ],
+        _: [
+            {
+                srcPath: '/_api/events-guests',
+                destPath: '',
+            },
+        ],
+        'manage._base_domain_': [
+            {
+                srcPath: '/_api/events-guests',
+                destPath: '',
+            },
+        ],
+        'www.wixapis.com': [
+            {
+                srcPath: '/events-guests',
+                destPath: '',
+            },
+        ],
+    };
     return metro_runtime_1.resolveUrl(Object.assign(opts, { domainToMappings }));
 }
-/**
- * Query to select guests.
- * Supports efficient filtering by `createdDate`, `eventId`, `attendanceStatus`, `secondaryLanguageCode`, `rsvpId`, `orderNumber`, `ticketNumber`, `memberId` or `guestDetails.checkedIn`
- */
+/** Retrieves a list of guests according to the provided filters and paging. */
 function queryEventGuests(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryEventGuestsRequest, {});
     const { fromJSON: fromRes } = ambassador_1.serializer(_queryEventGuestsResponse, {

package/build/cjs/src/events-guests-v1-guest.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"events-guests-v1-guest.http.js","sourceRoot":"","sources":["../../../src/events-guests-v1-guest.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,QAAQ,GAAG,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;AACjD,MAAM,gBAAgB,GAAG;IACvB,QAAQ,EAAE,6BAA6B;IACvC,SAAS,EAAE,6BAA6B;CACzC,CAAC;AACF,MAAM,WAAW,GAAG;IAClB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,2BAA2B,EAAE,2BAA2B;IACxD,YAAY,EAAE,eAAe;CAC9B,CAAC;AACF,MAAM,iBAAiB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAClD,MAAM,aAAa,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;AACrD,MAAM,aAAa,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACxD,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,6BAA6B;IACrC,QAAQ,EAAE,2BAA2B;IACrC,OAAO,EAAE,mBAAmB;CAC7B,CAAC;AACF,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AAE5D,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,OAAO,0BAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,yBAAyB,EAAE;QAClE,QAAQ;QACR,gBAAgB;QAChB,WAAW;QACX,aAAa;QACb,iBAAiB;QACjB,aAAa;QACb,WAAW;KACZ,CAAC,CAAC;IAEH,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AApCD,4CAoCC"}
+{"version":3,"file":"events-guests-v1-guest.http.js","sourceRoot":"","sources":["../../../src/events-guests-v1-guest.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,QAAQ,GAAG,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;AACjD,MAAM,gBAAgB,GAAG;IACvB,QAAQ,EAAE,6BAA6B;IACvC,SAAS,EAAE,6BAA6B;CACzC,CAAC;AACF,MAAM,WAAW,GAAG;IAClB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,2BAA2B,EAAE,2BAA2B;IACxD,YAAY,EAAE,eAAe;CAC9B,CAAC;AACF,MAAM,iBAAiB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAClD,MAAM,aAAa,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;AACrD,MAAM,aAAa,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACxD,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,6BAA6B;IACrC,QAAQ,EAAE,2BAA2B;IACrC,OAAO,EAAE,mBAAmB;CAC7B,CAAC;AACF,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AAE5D,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,0BAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,+EAA+E;AAC/E,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,yBAAyB,EAAE;QAClE,QAAQ;QACR,gBAAgB;QAChB,WAAW;QACX,aAAa;QACb,iBAAiB;QACjB,aAAa;QACb,WAAW;KACZ,CAAC,CAAC;IAEH,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AApCD,4CAoCC"}

package/build/cjs/src/events-guests-v1-guest.public.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from '@wix/sdk-types';
 import { QueryV2 } from './events-guests-v1-guest.universal';
 export declare function queryEventGuests(httpClient: HttpClient): (query: QueryV2) => Promise<import("./events-guests-v1-guest.universal").QueryEventGuestsResponse>;
-export { SubdivisionType, AttendanceStatus, GuestSource, SortOrder, RsvpStatus, OrderStatus, OrderType, } from './events-guests-v1-guest.universal';
-export { EventGuest, GuestDetails, FormResponse, InputValue, FormattedAddress, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, QueryEventGuestsRequest, QueryV2, QueryV2PagingMethodOneOf, Sorting, Paging, CursorPaging, QueryEventGuestsResponse, PagingMetadataV2, Cursors, SecondaryLanguagesRequest, SecondaryLanguagesResponse, RsvpCreated, Guest, CheckIn, Empty, RsvpUpdated, RsvpDeleted, OrderUpdated, Ticket, Money, OrderDeleted, Task, TaskKey, } from './events-guests-v1-guest.universal';
+export { SubdivisionType, AttendanceStatus, GuestType, SortOrder, RsvpStatus, OrderStatus, OrderType, } from './events-guests-v1-guest.universal';
+export { EventGuest, GuestDetails, FormResponse, InputValue, FormattedAddress, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, QueryEventGuestsRequest, QueryV2, QueryV2PagingMethodOneOf, Sorting, Paging, CursorPaging, QueryEventGuestsResponse, PagingMetadataV2, Cursors, StreamEventGuestsRequest, TaskContext, Empty, NotifyGuestAction, SecondaryLanguagesRequest, SecondaryLanguagesResponse, RsvpCreated, Guest, CheckIn, RsvpUpdated, RsvpDeleted, OrderUpdated, Ticket, Money, OrderDeleted, EventDeleted, Task, TaskKey, } from './events-guests-v1-guest.universal';

package/build/cjs/src/events-guests-v1-guest.public.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderType = exports.OrderStatus = exports.RsvpStatus = exports.SortOrder = exports.GuestSource = exports.AttendanceStatus = exports.SubdivisionType = exports.queryEventGuests = void 0;
+exports.OrderType = exports.OrderStatus = exports.RsvpStatus = exports.SortOrder = exports.GuestType = exports.AttendanceStatus = exports.SubdivisionType = exports.queryEventGuests = void 0;
 const events_guests_v1_guest_universal_1 = require("./events-guests-v1-guest.universal");
 function queryEventGuests(httpClient) {
     return (query) => events_guests_v1_guest_universal_1.queryEventGuests(query, 
@@ -11,7 +11,7 @@ exports.queryEventGuests = queryEventGuests;
 var events_guests_v1_guest_universal_2 = require("./events-guests-v1-guest.universal");
 Object.defineProperty(exports, "SubdivisionType", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.SubdivisionType; } });
 Object.defineProperty(exports, "AttendanceStatus", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.AttendanceStatus; } });
-Object.defineProperty(exports, "GuestSource", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.GuestSource; } });
+Object.defineProperty(exports, "GuestType", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.GuestType; } });
 Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.SortOrder; } });
 Object.defineProperty(exports, "RsvpStatus", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.RsvpStatus; } });
 Object.defineProperty(exports, "OrderStatus", { enumerable: true, get: function () { return events_guests_v1_guest_universal_2.OrderStatus; } });

package/build/cjs/src/events-guests-v1-guest.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"events-guests-v1-guest.public.js","sourceRoot":"","sources":["../../../src/events-guests-v1-guest.public.ts"],"names":[],"mappings":";;;AACA,yFAG4C;AAE5C,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,KAAc,EAAE,EAAE,CACxB,mDAAyB,CACvB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4CAOC;AAED,uFAQ4C;AAP1C,mIAAA,eAAe,OAAA;AACf,oIAAA,gBAAgB,OAAA;AAChB,+HAAA,WAAW,OAAA;AACX,6HAAA,SAAS,OAAA;AACT,8HAAA,UAAU,OAAA;AACV,+HAAA,WAAW,OAAA;AACX,6HAAA,SAAS,OAAA"}
+{"version":3,"file":"events-guests-v1-guest.public.js","sourceRoot":"","sources":["../../../src/events-guests-v1-guest.public.ts"],"names":[],"mappings":";;;AACA,yFAG4C;AAE5C,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,KAAc,EAAE,EAAE,CACxB,mDAAyB,CACvB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4CAOC;AAED,uFAQ4C;AAP1C,mIAAA,eAAe,OAAA;AACf,oIAAA,gBAAgB,OAAA;AAChB,6HAAA,SAAS,OAAA;AACT,6HAAA,SAAS,OAAA;AACT,8HAAA,UAAU,OAAA;AACV,+HAAA,WAAW,OAAA;AACX,6HAAA,SAAS,OAAA"}

package/build/cjs/src/events-guests-v1-guest.types.d.ts

@@ -1,34 +1,34 @@
 export interface EventGuest {
-    /** Guest id. */
+    /** Guest ID. */
     id?: string | null;
-    /** Event id. */
+    /** Event ID. */
     eventId?: string | null;
-    /** Rsvp id. Available only when Guest type is RSVP. */
+    /** RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`. */
     rsvpId?: string | null;
-    /** Order number. Available only when Guest type is ORDER or TICKET. */
+    /** Order number. <br/> <br/> **Note:** Only applicable when **guestType** is `BUYER` or `TICKET_HOLDER`. */
     orderNumber?: string | null;
-    /** Ticket number. Available only when Guest type is ORDER or TICKET. */
+    /** Ticket number. <br/> <br/> **Note:** Only applicable when **guestType** is `TICKET_HOLDER`. */
     ticketNumber?: string | null;
-    /** List of bought tickets. */
+    /** List of ticket numbers for one order. */
     tickets?: string[];
-    /** CRM contact ID for the person who is a guest. */
+    /** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
     contactId?: string | null;
-    /** Guest details. */
+    /** Guest details. <br/> <br/> **Note:** Will not appear in the response unless the `guestDetails` fieldset will be sent in the request. */
     guestDetails?: GuestDetails;
-    /** Attendance status */
+    /** Attendance status. <br/> <br/> **Note:** For **guestType** `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
     attendanceStatus?: AttendanceStatus;
-    /** Secondary language code. */
+    /** 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. */
     secondaryLanguageCode?: string | null;
-    /** Date and time when the guest was created. */
+    /** Date and time when the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
     createdDate?: Date;
-    /** Date and time when the guest was updated. */
+    /** Date and time of guest's latest update in `yyyy-mm-ddThh:mm:sssZ` format. */
     updatedDate?: Date;
-    /** The last date and time when the guest attendance status was updated. */
+    /** Date and time of guest's latest attendance status update. */
     attendanceStatusUpdatedDate?: Date;
-    /** Site member id. */
+    /** Site member ID. */
     memberId?: string | null;
-    /** Guest source. */
-    guestSource?: GuestSource;
+    /** 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 which the ticket was bought. */
+    guestType?: GuestType;
 }
 export interface GuestDetails {
     /** Email. */
@@ -39,7 +39,7 @@ export interface GuestDetails {
     lastName?: string | null;
     /** Form response. */
     formResponse?: FormResponse;
-    /** Indicates if guests is checked in. */
+    /** Whether the guest has checked into the event. */
     checkedIn?: boolean;
 }
 export interface FormResponse {
@@ -125,36 +125,24 @@ export declare enum AttendanceStatus {
     /** In a waiting list. */
     IN_WAITLIST = "IN_WAITLIST"
 }
-export declare enum GuestSource {
+export declare enum GuestType {
     /** Rsvp guest. */
     RSVP = "RSVP",
-    /** Order source. */
-    ORDER = "ORDER",
-    /** Ticket source. */
-    TICKET = "TICKET"
+    /** Buyer. */
+    BUYER = "BUYER",
+    /** Ticket holder guest. */
+    TICKET_HOLDER = "TICKET_HOLDER"
 }
 export interface QueryEventGuestsRequest {
-    /** WQL expression */
+    /** Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
     query: QueryV2;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
+    /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "sd3f-jhds-4fs77", "ticketNumber": {"$startsWith":"478"} }` <br/> <br/> See [supported fields and operators](https://dev.wix.com/api/rest/all-apis/eventguestsservice/filter-and-sort) for more information. */
     filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
+    /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"ticketNumber","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/all-apis/eventguestsservice/filter-and-sort) for more information. */
     sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /** Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details. <br/> <br/> See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information. */
     fieldsets?: string[];
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
@@ -171,7 +159,7 @@ export interface QueryV2PagingMethodOneOf {
 export interface Sorting {
     /** Name of the field to sort by. */
     fieldName?: string;
-    /** Sort order. */
+    /** Sort order (ASC/DESC). Defaults to ASC */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -179,13 +167,13 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface Paging {
-    /** Number of items to load. */
+    /** Number of items to load per page. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Number of items to load. */
+    /** Number of items to load per page. */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
@@ -220,6 +208,24 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
+export interface StreamEventGuestsRequest {
+    /** Filter. */
+    filter?: Record<string, any> | null;
+    /** Task context. */
+    taskContext?: TaskContext;
+}
+export interface TaskContext {
+    /** Task id. */
+    id?: string | null;
+}
+export interface Empty {
+}
+export interface NotifyGuestAction {
+    /** Event guest. */
+    guest?: EventGuest;
+    /** Task context. */
+    taskContext?: TaskContext;
+}
 export interface SecondaryLanguagesRequest {
     /** Guest event id. */
     eventId?: string;
@@ -275,8 +281,6 @@ export interface CheckIn {
     /** Time of check-in */
     created?: Date;
 }
-export interface Empty {
-}
 export interface RsvpUpdated {
     /** RSVP updated timestamp in ISO UTC format. */
     timestamp?: Date;
@@ -438,6 +442,16 @@ export declare enum OrderType {
     /** Each order ticket has its own form */
     ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
 }
+export interface EventDeleted {
+    /** Event deleted timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+}
 export interface Task {
     key?: TaskKey;
     executeAt?: Date;

package/build/cjs/src/events-guests-v1-guest.types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderType = exports.OrderStatus = exports.RsvpStatus = exports.SortOrder = exports.GuestSource = exports.AttendanceStatus = exports.SubdivisionType = void 0;
+exports.OrderType = exports.OrderStatus = exports.RsvpStatus = exports.SortOrder = exports.GuestType = exports.AttendanceStatus = exports.SubdivisionType = void 0;
 var SubdivisionType;
 (function (SubdivisionType) {
     SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
@@ -26,15 +26,15 @@ var AttendanceStatus;
     /** In a waiting list. */
     AttendanceStatus["IN_WAITLIST"] = "IN_WAITLIST";
 })(AttendanceStatus = exports.AttendanceStatus || (exports.AttendanceStatus = {}));
-var GuestSource;
-(function (GuestSource) {
+var GuestType;
+(function (GuestType) {
     /** Rsvp guest. */
-    GuestSource["RSVP"] = "RSVP";
-    /** Order source. */
-    GuestSource["ORDER"] = "ORDER";
-    /** Ticket source. */
-    GuestSource["TICKET"] = "TICKET";
-})(GuestSource = exports.GuestSource || (exports.GuestSource = {}));
+    GuestType["RSVP"] = "RSVP";
+    /** Buyer. */
+    GuestType["BUYER"] = "BUYER";
+    /** Ticket holder guest. */
+    GuestType["TICKET_HOLDER"] = "TICKET_HOLDER";
+})(GuestType = exports.GuestType || (exports.GuestType = {}));
 var SortOrder;
 (function (SortOrder) {
     SortOrder["ASC"] = "ASC";

package/build/cjs/src/events-guests-v1-guest.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"events-guests-v1-guest.types.js","sourceRoot":"","sources":["../../../src/events-guests-v1-guest.types.ts"],"names":[],"mappings":";;;AAkHA,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAc1B;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,qBAAqB;IACrB,mDAA+B,CAAA;IAC/B,iBAAiB;IACjB,2CAAuB,CAAA;IACvB,yBAAyB;IACzB,+CAA2B,CAAA;AAC7B,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAED,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,kBAAkB;IAClB,4BAAa,CAAA;IACb,oBAAoB;IACpB,8BAAe,CAAA;IACf,qBAAqB;IACrB,gCAAiB,CAAA;AACnB,CAAC,EAPW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAOtB;AA+CD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAwFD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,yBAAW,CAAA;IACX,uBAAS,CAAA;IACT,iCAAmB,CAAA;AACrB,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAwGD,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACrB,2DAA2D;IAC3D,kDAAmC,CAAA;IACnC,8CAA8C;IAC9C,4BAAa,CAAA;IACb,2FAA2F;IAC3F,kCAAmB,CAAA;IACnB,qCAAqC;IACrC,4BAAa,CAAA;IACb,iGAAiG;IACjG,kDAAmC,CAAA;IACnC,+CAA+C;IAC/C,sCAAuB,CAAA;IACvB,yBAAyB;IACzB,oCAAqB,CAAA;IACrB,iCAAiC;IACjC,oCAAqB,CAAA;AACvB,CAAC,EAjBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiBtB;AA6DD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,yCAAyC;IACzC,sDAAyC,CAAA;IACzC,yCAAyC;IACzC,kDAAqC,CAAA;AACvC,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB"}
+{"version":3,"file":"events-guests-v1-guest.types.js","sourceRoot":"","sources":["../../../src/events-guests-v1-guest.types.ts"],"names":[],"mappings":";;;AAkHA,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAc1B;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,qBAAqB;IACrB,mDAA+B,CAAA;IAC/B,iBAAiB;IACjB,2CAAuB,CAAA;IACvB,yBAAyB;IACzB,+CAA2B,CAAA;AAC7B,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAED,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,kBAAkB;IAClB,0BAAa,CAAA;IACb,aAAa;IACb,4BAAe,CAAA;IACf,2BAA2B;IAC3B,4CAA+B,CAAA;AACjC,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB;AAmCD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA6GD,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,yBAAW,CAAA;IACX,uBAAS,CAAA;IACT,iCAAmB,CAAA;AACrB,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAsGD,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACrB,2DAA2D;IAC3D,kDAAmC,CAAA;IACnC,8CAA8C;IAC9C,4BAAa,CAAA;IACb,2FAA2F;IAC3F,kCAAmB,CAAA;IACnB,qCAAqC;IACrC,4BAAa,CAAA;IACb,iGAAiG;IACjG,kDAAmC,CAAA;IACnC,+CAA+C;IAC/C,sCAAuB,CAAA;IACvB,yBAAyB;IACzB,oCAAqB,CAAA;IACrB,iCAAiC;IACjC,oCAAqB,CAAA;AACvB,CAAC,EAjBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiBtB;AA6DD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,yCAAyC;IACzC,sDAAyC,CAAA;IACzC,yCAAyC;IACzC,kDAAqC,CAAA;AACvC,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB"}

package/build/cjs/src/events-guests-v1-guest.universal.d.ts

@@ -5,36 +5,36 @@ export declare const __debug: {
     };
 };
 export interface EventGuest {
-    /** Guest id. */
+    /** Guest ID. */
     _id?: string | null;
-    /** Event id. */
+    /** Event ID. */
     eventId?: string | null;
-    /** Rsvp id. Available only when Guest type is RSVP. */
+    /** RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`. */
     rsvpId?: string | null;
-    /** Order number. Available only when Guest type is ORDER or TICKET. */
+    /** Order number. <br/> <br/> **Note:** Only applicable when **guestType** is `BUYER` or `TICKET_HOLDER`. */
     orderNumber?: string | null;
-    /** Ticket number. Available only when Guest type is ORDER or TICKET. */
+    /** Ticket number. <br/> <br/> **Note:** Only applicable when **guestType** is `TICKET_HOLDER`. */
     ticketNumber?: string | null;
-    /** List of bought tickets. */
+    /** List of ticket numbers for one order. */
     tickets?: string[];
-    /** CRM contact ID for the person who is a guest. */
+    /** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
     contactId?: string | null;
-    /** Guest details. */
+    /** Guest details. <br/> <br/> **Note:** Will not appear in the response unless the `guestDetails` fieldset will be sent in the request. */
     guestDetails?: GuestDetails;
-    /** Attendance status */
+    /** Attendance status. <br/> <br/> **Note:** For **guestType** `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
     attendanceStatus?: AttendanceStatus;
-    /** Secondary language code. */
+    /** 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. */
     secondaryLanguageCode?: string | null;
-    /** Date and time when the guest was created. */
+    /** Date and time when the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
     _createdDate?: Date;
-    /** Date and time when the guest was updated. */
+    /** Date and time of guest's latest update in `yyyy-mm-ddThh:mm:sssZ` format. */
     _updatedDate?: Date;
-    /** The last date and time when the guest attendance status was updated. */
+    /** Date and time of guest's latest attendance status update. */
     attendanceStatusUpdatedDate?: Date;
-    /** Site member id. */
+    /** Site member ID. */
     memberId?: string | null;
-    /** Guest source. */
-    guestSource?: GuestSource;
+    /** 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 which the ticket was bought. */
+    guestType?: GuestType;
 }
 export interface GuestDetails {
     /** Email. */
@@ -45,7 +45,7 @@ export interface GuestDetails {
     lastName?: string | null;
     /** Form response. */
     formResponse?: FormResponse;
-    /** Indicates if guests is checked in. */
+    /** Whether the guest has checked into the event. */
     checkedIn?: boolean;
 }
 export interface FormResponse {
@@ -131,36 +131,24 @@ export declare enum AttendanceStatus {
     /** In a waiting list. */
     IN_WAITLIST = "IN_WAITLIST"
 }
-export declare enum GuestSource {
+export declare enum GuestType {
     /** Rsvp guest. */
     RSVP = "RSVP",
-    /** Order source. */
-    ORDER = "ORDER",
-    /** Ticket source. */
-    TICKET = "TICKET"
+    /** Buyer. */
+    BUYER = "BUYER",
+    /** Ticket holder guest. */
+    TICKET_HOLDER = "TICKET_HOLDER"
 }
 export interface QueryEventGuestsRequest {
-    /** WQL expression */
+    /** Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
     query: QueryV2;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
+    /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "sd3f-jhds-4fs77", "ticketNumber": {"$startsWith":"478"} }` <br/> <br/> See [supported fields and operators](https://dev.wix.com/api/rest/all-apis/eventguestsservice/filter-and-sort) for more information. */
     filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
+    /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"ticketNumber","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/all-apis/eventguestsservice/filter-and-sort) for more information. */
     sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /** Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details. <br/> <br/> See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information. */
     fieldsets?: string[];
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
@@ -177,7 +165,7 @@ export interface QueryV2PagingMethodOneOf {
 export interface Sorting {
     /** Name of the field to sort by. */
     fieldName?: string;
-    /** Sort order. */
+    /** Sort order (ASC/DESC). Defaults to ASC */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -185,13 +173,13 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface Paging {
-    /** Number of items to load. */
+    /** Number of items to load per page. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Number of items to load. */
+    /** Number of items to load per page. */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
@@ -226,6 +214,24 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
+export interface StreamEventGuestsRequest {
+    /** Filter. */
+    filter?: Record<string, any> | null;
+    /** Task context. */
+    taskContext?: TaskContext;
+}
+export interface TaskContext {
+    /** Task id. */
+    _id?: string | null;
+}
+export interface Empty {
+}
+export interface NotifyGuestAction {
+    /** Event guest. */
+    guest?: EventGuest;
+    /** Task context. */
+    taskContext?: TaskContext;
+}
 export interface SecondaryLanguagesRequest {
     /** Guest event id. */
     eventId?: string;
@@ -281,8 +287,6 @@ export interface CheckIn {
     /** Time of check-in */
     created?: Date;
 }
-export interface Empty {
-}
 export interface RsvpUpdated {
     /** RSVP updated timestamp in ISO UTC format. */
     timestamp?: Date;
@@ -444,6 +448,16 @@ export declare enum OrderType {
     /** Each order ticket has its own form */
     ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
 }
+export interface EventDeleted {
+    /** Event deleted timestamp in ISO UTC format. */
+    timestamp?: Date;
+    /** Event ID. */
+    eventId?: string;
+    /** Event title. */
+    title?: string;
+    /** Event creator user ID. */
+    userId?: string | null;
+}
 export interface Task {
     key?: TaskKey;
     executeAt?: Date;
@@ -455,10 +469,10 @@ export interface TaskKey {
     subjectId?: string | null;
 }
 /**
- * Query to select guests.
- * Supports efficient filtering by `createdDate`, `eventId`, `attendanceStatus`, `secondaryLanguageCode`, `rsvpId`, `orderNumber`, `ticketNumber`, `memberId` or `guestDetails.checkedIn`
- * @param query - WQL expression
+ * Retrieves a list of guests according to the provided filters and paging.
+ * @param query - Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
  * @public
+ * @documentationMaturity preview
  * @requiredField query
  */
 export declare function queryEventGuests(query: QueryV2): Promise<QueryEventGuestsResponse>;

package/build/cjs/src/events-guests-v1-guest.universal.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryEventGuests = exports.OrderType = exports.OrderStatus = exports.RsvpStatus = exports.SortOrder = exports.GuestSource = exports.AttendanceStatus = exports.SubdivisionType = exports.__debug = void 0;
+exports.queryEventGuests = exports.OrderType = exports.OrderStatus = exports.RsvpStatus = exports.SortOrder = exports.GuestType = exports.AttendanceStatus = exports.SubdivisionType = exports.__debug = void 0;
 const velo_1 = require("@wix/metro-runtime/velo");
 const ambassadorWixEventsGuestsV1Guest = __importStar(require("./events-guests-v1-guest.http"));
 let __verbose = false;
@@ -71,15 +71,15 @@ var AttendanceStatus;
     /** In a waiting list. */
     AttendanceStatus["IN_WAITLIST"] = "IN_WAITLIST";
 })(AttendanceStatus = exports.AttendanceStatus || (exports.AttendanceStatus = {}));
-var GuestSource;
-(function (GuestSource) {
+var GuestType;
+(function (GuestType) {
     /** Rsvp guest. */
-    GuestSource["RSVP"] = "RSVP";
-    /** Order source. */
-    GuestSource["ORDER"] = "ORDER";
-    /** Ticket source. */
-    GuestSource["TICKET"] = "TICKET";
-})(GuestSource = exports.GuestSource || (exports.GuestSource = {}));
+    GuestType["RSVP"] = "RSVP";
+    /** Buyer. */
+    GuestType["BUYER"] = "BUYER";
+    /** Ticket holder guest. */
+    GuestType["TICKET_HOLDER"] = "TICKET_HOLDER";
+})(GuestType = exports.GuestType || (exports.GuestType = {}));
 var SortOrder;
 (function (SortOrder) {
     SortOrder["ASC"] = "ASC";
@@ -125,10 +125,10 @@ const _inputValue = { address: '_formattedAddress' };
 const _queryEventGuestsRequest = {};
 const _queryEventGuestsResponse = { guests: '_eventGuest' };
 /**
- * Query to select guests.
- * Supports efficient filtering by `createdDate`, `eventId`, `attendanceStatus`, `secondaryLanguageCode`, `rsvpId`, `orderNumber`, `ticketNumber`, `memberId` or `guestDetails.checkedIn`
- * @param query - WQL expression
+ * Retrieves a list of guests according to the provided filters and paging.
+ * @param query - Query options. See [API Query Langauge](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
  * @public
+ * @documentationMaturity preview
  * @requiredField query
  */
 function queryEventGuests(query) {