@wix/auto_sdk_events_guests 1.0.21 → 1.0.23

package/build/cjs/{events-guests-v1-guest-guests.universal-CBYtnjLy.d.ts → index.typings.d.ts}

@@ -155,24 +155,24 @@ interface GuestDetails {
 }
 interface FormResponse {
     /**
-     * Input values entered when filling the form.
+     * Form field inputs.
      * @maxSize 200
      */
     inputValues?: InputValue[];
 }
 interface InputValue {
     /**
-     * Input field name.
+     * Form field input name.
      * @maxLength 100
      */
     inputName?: string;
     /**
-     * Text entered into the input field.
+     * Form field value.
      * @maxLength 5000
      */
     value?: string;
     /**
-     * Multiple input values. For example, the array is filled if several checkboxes are ticked.
+     * Form field values.
      * @maxSize 100
      * @maxLength 5000
      */
@@ -180,11 +180,11 @@ interface InputValue {
 }
 interface FormattedAddress {
     /**
-     * One line address representation.
+     * 1-line address representation.
      * @maxLength 200
      */
     formatted?: string;
-    /** Address components (optional). */
+    /** Address components. */
     address?: Address;
 }
 /** Physical address */
@@ -247,6 +247,8 @@ declare enum SubdivisionType {
     /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
     COUNTRY = "COUNTRY"
 }
+/** @enumType */
+type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
 /** Subdivision Concordance values */
 interface StandardDetails {
     /**
@@ -527,6 +529,8 @@ declare enum SubdivisionSubdivisionType {
     /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
     COUNTRY = "COUNTRY"
 }
+/** @enumType */
+type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
 interface DateAndTimeSettings {
     /** Whether the event date and time are TBD. */
     dateAndTimeTbd?: boolean | null;
@@ -718,7 +722,7 @@ interface OrderDetails {
     invoice?: Invoice;
 }
 declare enum OrderStatus {
-    /** Order status is not available for this request fieldset. */
+    /** Order status isn't available for this request fieldset. */
     NA_ORDER_STATUS = "NA_ORDER_STATUS",
     /** Order is confirmed, no payment is required. */
     FREE = "FREE",
@@ -726,9 +730,9 @@ declare enum OrderStatus {
     PENDING = "PENDING",
     /** Order is paid. */
     PAID = "PAID",
-    /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
+    /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
     OFFLINE_PENDING = "OFFLINE_PENDING",
-    /** Order is awaiting for payment at the cashier. */
+    /** Order is waiting for payment at the cashier. */
     INITIATED = "INITIATED",
     /** Order is canceled. */
     CANCELED = "CANCELED",
@@ -760,8 +764,8 @@ interface Invoice {
      * Total amount of a cart after discount, tax, and fees.
      * Grand total is calculated in the following order:
      * 1. Total prices of all items in the cart are calculated.
-     * 2. Discount is subtracted from the cart (if applicable).
-     * 3. Tax is added (if applicable).
+     * 2. Discount is subtracted from the cart, if applicable.
+     * 3. Tax is added, if applicable.
      * 4. Wix ticket service fee is added.
      */
     grandTotal?: Money;
@@ -770,7 +774,7 @@ interface Invoice {
      * @readonly
      */
     fees?: Fee[];
-    /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
+    /** Total revenue, excluding fees. Taxes and payment provider fees aren't deducted. */
     revenue?: Money;
     /** Invoice preview URL. Only returned if the order is paid. */
     previewUrl?: string | null;
@@ -811,7 +815,7 @@ interface Money {
      */
     amount?: string;
     /**
-     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
      * @format CURRENCY
      */
     currency?: string;
@@ -1352,7 +1356,7 @@ interface Ticket {
     canceled?: boolean | null;
 }
 interface CheckIn {
-    /** Time of check-in. */
+    /** Time of a ticket's check-in. */
     created?: Date | null;
 }
 /** Triggered when an order is updated. */
@@ -1614,30 +1618,184 @@ interface GuestCreatedEnvelope {
     entity: EventGuest;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a guest is created.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_created
+ * @slug created
+ */
+declare function onGuestCreated(handler: (event: GuestCreatedEnvelope) => void | Promise<void>): void;
 interface GuestDeletedEnvelope {
     entity: EventGuest;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a guest is deleted.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_deleted
+ * @slug deleted
+ */
+declare function onGuestDeleted(handler: (event: GuestDeletedEnvelope) => void | Promise<void>): void;
 interface GuestCheckedInEnvelope {
     data: GuestCheckedIn;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a guest has checked in.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_guest_checked_in
+ * @slug guest_checked_in
+ */
+declare function onGuestCheckedIn(handler: (event: GuestCheckedInEnvelope) => void | Promise<void>): void;
 interface GuestEventCanceledEnvelope {
     data: GuestEventCanceled;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when an event is canceled.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_guest_event_canceled
+ * @slug guest_event_canceled
+ */
+declare function onGuestEventCanceled(handler: (event: GuestEventCanceledEnvelope) => void | Promise<void>): void;
 interface GuestEventStartsEnvelope {
     data: GuestEventStarts;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when an event has started.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_guest_event_starts
+ * @slug guest_event_starts
+ */
+declare function onGuestEventStarts(handler: (event: GuestEventStartsEnvelope) => void | Promise<void>): void;
 interface GuestOrderCanceledEnvelope {
     data: GuestOrderCanceled;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a ticket order is canceled.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_guest_order_canceled
+ * @slug guest_order_canceled
+ */
+declare function onGuestOrderCanceled(handler: (event: GuestOrderCanceledEnvelope) => void | Promise<void>): void;
 interface GuestUpdatedEnvelope {
     entity: EventGuest;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a guest is updated.
+ *
+ * This event always triggers together with the Guest Created and the Guest Deleted events.
+ * > **Note:** Since this event may trigger twice, you should explicitly add code to ensure that the parts of your code that depend on this event run only once.
+ * @permissionScope Read Events - all read permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
+ * @permissionScope Manage Events - all permissions
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Read Event Tickets and Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
+ * @webhook
+ * @eventType wix.events.guests.v1.guest_updated
+ * @slug updated
+ */
+declare function onGuestUpdated(handler: (event: GuestUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a query to retrieve a list of guests.
+ *
+ *
+ * The `queryGuests()` method builds a query to retrieve a list of guests and returns a [GuestsQueryBuilder](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/ascending) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/find) method.
+ *
+ * You can refine the query by chaining `GuestsQueryBuilder` methods onto the query. `GuestsQueryBuilder` methods enable you to sort, filter, and control the results that `queryGuests.find()` returns.
+ *
+ * The query runs with the following `GuestsQueryBuilder` defaults that you can override:
+ *
+ * - [`skipTo(0)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/skip-to)
+ * - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/limit)
+ * - [`descending("_createdDate")`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/descending)
+ *
+ * The methods that are chained to `queryGuests()` are applied in the order they are called. For example, if you apply `ascending ('_createdDate')` and then `descending ('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
+ *
+ * The table below shows which `GuestsQueryBuilder` methods are supported for `queryGuests()`. You can only use one filter method for each property. Only the first filter will work if a property is used in more than one filter.
+ * @public
+ * @permissionId WIX_EVENTS.READ_GUESTS
+ * @applicableIdentity APP
+ * @fqn wix.events.guests.v1.EventGuestsService.QueryEventGuests
+ */
+declare function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;
 interface QueryEventGuestsOptions {
     /**
      * Predefined sets of fields to return.
@@ -1696,4 +1854,4 @@ interface GuestsQueryBuilder {
     find: () => Promise<GuestsQueryResult>;
 }
 
-export { type CommonAddressLocation as $, AttendanceStatus as A, type AddressLocation as B, type Subdivision as C, type StandardDetails as D, EventType as E, FeeName as F, type GuestsQueryBuilder as G, type GuestCountUpdated as H, type InputValue as I, type GuestCountUpdate as J, type MemberEventStatusUpdated as K, LocationType as L, MemberEventStatusUpdatedEventType as M, NotifyActionType as N, OrderStatus as O, type ContactEventStatusUpdated as P, type QueryEventGuestsOptions as Q, RecurrenceStatusStatus as R, SubdivisionType as S, Timing as T, type GuestCheckedIn as U, type EventDetails as V, WebhookIdentityType as W, type Location as X, type CommonAddress as Y, type CommonAddressStreetOneOf as Z, type CommonStreetAddress as _, type GuestCreatedEnvelope as a, type BaseEventMetadata as a$, type CommonSubdivision as a0, type DateAndTimeSettings as a1, type Recurrences as a2, type Occurrence as a3, type Formatted as a4, type NotifyGuestAction as a5, type TaskContext as a6, type OrderDetails as a7, type Invoice as a8, type Item as a9, type Sorting as aA, type Paging as aB, type CursorPaging as aC, type QueryEventGuestsResponse as aD, type PagingMetadataV2 as aE, type Cursors as aF, type StreamEventGuestsRequest as aG, type Empty as aH, type SecondaryLanguagesRequest as aI, type SecondaryLanguagesResponse as aJ, type Language as aK, type OrderConfirmed as aL, type Ticket as aM, type CheckIn as aN, type OrderUpdated as aO, type OrderDeleted as aP, type EventDeleted as aQ, type Task as aR, type TaskKey as aS, type ListGuestListPreviewsRequest as aT, type ListGuestListPreviewsResponse as aU, type GuestListPreview as aV, type GuestCount as aW, type MemberGuests as aX, type MemberGuest as aY, type UpdateGuestRequest as aZ, type UpdateGuestResponse as a_, type Money as aa, type Discount as ab, type DiscountItem as ac, type DiscountItemDiscountOneOf as ad, type CouponDiscount as ae, type PaidPlanDiscount as af, type PaidPlanDiscountDiscountOneOf as ag, type PercentDiscount as ah, type Tax as ai, type Fee as aj, type GuestEventCanceled as ak, type GuestEventStarts as al, type GuestOrderCanceled as am, type DomainEvent as an, type DomainEventBodyOneOf as ao, type EntityCreatedEvent as ap, type RestoreInfo as aq, type EntityUpdatedEvent as ar, type EntityDeletedEvent as as, type ActionEvent as at, type MessageEnvelope as au, type IdentificationData as av, type IdentificationDataIdOneOf as aw, type QueryEventGuestsRequest as ax, type QueryV2 as ay, type QueryV2PagingMethodOneOf as az, type GuestDeletedEnvelope as b, type EventMetadata as b0, type GuestsQueryResult as b1, type GuestCheckedInEnvelope as c, type GuestEventCanceledEnvelope as d, type GuestEventStartsEnvelope as e, type GuestOrderCanceledEnvelope as f, type GuestUpdatedEnvelope as g, GuestType as h, SubdivisionSubdivisionType as i, Status as j, TaxType as k, FeeType as l, SortOrder as m, RequestedFieldsEnumRequestedFields as n, OrderType as o, RequestedFields as p, type EventGuest as q, type TicketDetails as r, type TicketGuestDetails as s, type OnlineConferencingLogin as t, type GuestDetails as u, type FormResponse as v, type FormattedAddress as w, type Address as x, type AddressStreetOneOf as y, type StreetAddress as z };
+export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, AttendanceStatus, type AttendanceStatusWithLiterals, type BaseEventMetadata, type CheckIn, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonStreetAddress, type CommonSubdivision, type ContactEventStatusUpdated, type CouponDiscount, type CursorPaging, type Cursors, type DateAndTimeSettings, type Discount, type DiscountItem, type DiscountItemDiscountOneOf, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventDeleted, type EventDetails, type EventGuest, type EventMetadata, EventType, type EventTypeWithLiterals, type Fee, FeeName, type FeeNameWithLiterals, FeeType, type FeeTypeWithLiterals, type FormResponse, type Formatted, type FormattedAddress, type GuestCheckedIn, type GuestCheckedInEnvelope, type GuestCount, type GuestCountUpdate, type GuestCountUpdated, type GuestCreatedEnvelope, type GuestDeletedEnvelope, type GuestDetails, type GuestEventCanceled, type GuestEventCanceledEnvelope, type GuestEventStarts, type GuestEventStartsEnvelope, type GuestListPreview, type GuestOrderCanceled, type GuestOrderCanceledEnvelope, GuestType, type GuestTypeWithLiterals, type GuestUpdatedEnvelope, type GuestsQueryBuilder, type GuestsQueryResult, type IdentificationData, type IdentificationDataIdOneOf, type InputValue, type Invoice, type Item, type Language, type ListGuestListPreviewsRequest, type ListGuestListPreviewsResponse, type Location, LocationType, type LocationTypeWithLiterals, type MemberEventStatusUpdated, MemberEventStatusUpdatedEventType, type MemberEventStatusUpdatedEventTypeWithLiterals, type MemberGuest, type MemberGuests, type MessageEnvelope, type Money, NotifyActionType, type NotifyActionTypeWithLiterals, type NotifyGuestAction, type Occurrence, type OnlineConferencingLogin, type OrderConfirmed, type OrderDeleted, type OrderDetails, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdated, type Paging, type PagingMetadataV2, type PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf, type PercentDiscount, type QueryEventGuestsOptions, type QueryEventGuestsRequest, type QueryEventGuestsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, RequestedFields, RequestedFieldsEnumRequestedFields, type RequestedFieldsEnumRequestedFieldsWithLiterals, type RequestedFieldsWithLiterals, type RestoreInfo, type SecondaryLanguagesRequest, type SecondaryLanguagesResponse, SortOrder, type SortOrderWithLiterals, type Sorting, type StandardDetails, Status, type StatusWithLiterals, type StreamEventGuestsRequest, type StreetAddress, type Subdivision, SubdivisionSubdivisionType, type SubdivisionSubdivisionTypeWithLiterals, SubdivisionType, type SubdivisionTypeWithLiterals, type Task, type TaskContext, type TaskKey, type Tax, TaxType, type TaxTypeWithLiterals, type Ticket, type TicketDetails, type TicketGuestDetails, Timing, type TimingWithLiterals, type UpdateGuestRequest, type UpdateGuestResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, onGuestCheckedIn, onGuestCreated, onGuestDeleted, onGuestEventCanceled, onGuestEventStarts, onGuestOrderCanceled, onGuestUpdated, queryGuests };