@wix/auto_sdk_events_notifications 1.0.25 → 1.0.27

package/build/cjs/{events-notifications-v2-notification-config-notifications.universal-DK7vt86U.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface NotificationConfig {
     /**
      * Event ID.
@@ -441,6 +443,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';
 interface ScheduleConfig {
     /**
      * Defines event as TBD (To Be Determined) schedule.
@@ -2719,6 +2723,8 @@ declare enum NullValue {
     /** Null value. */
     NULL_VALUE = "NULL_VALUE"
 }
+/** @enumType */
+type NullValueWithLiterals = NullValue | 'NULL_VALUE';
 /**
  * `ListValue` is a wrapper around a repeated field of values.
  *
@@ -3325,6 +3331,8 @@ interface OrderEmailAdded {
      * @format GUID
      */
     reservationId?: string;
+    /** Whether marketing consent was given. */
+    marketingConsent?: boolean | null;
 }
 interface EventCanceled {
     /** Event canceled timestamp in ISO UTC format. */
@@ -3769,10 +3777,63 @@ interface NotificationConfigCreatedEnvelope {
     entity: NotificationConfig;
     metadata: EventMetadata;
 }
+/** @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 Read Events
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
+ * @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
+ * @webhook
+ * @eventType wix.events.notifications.v2.notification_config_created
+ * @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onNotificationConfigCreated(handler: (event: NotificationConfigCreatedEnvelope) => void | Promise<void>): void;
 interface NotificationConfigUpdatedEnvelope {
     entity: NotificationConfig;
     metadata: EventMetadata;
 }
+/** @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 Read Events
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
+ * @permissionScope Manage Guest List
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
+ * @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
+ * @webhook
+ * @eventType wix.events.notifications.v2.notification_config_updated
+ * @serviceIdentifier wix.events.notifications.v2.NotificationConfigManagement
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onNotificationConfigUpdated(handler: (event: NotificationConfigUpdatedEnvelope) => void | Promise<void>): void;
+type NotificationConfigNonNullablePaths = `rsvpConfirmation.notificationType` | `rsvpConfirmation.reminderTime` | `newSpotsAvailable.notificationType` | `newSpotsAvailable.reminderTime` | `eventCancelation.notificationType` | `eventCancelation.reminderTime` | `upcomingEventReminder.notificationType` | `upcomingEventReminder.reminderTime` | `orderConfirmation.notificationType` | `orderConfirmation.reminderTime` | `ticketConfirmation.notificationType` | `ticketConfirmation.reminderTime` | `invoice.notificationType` | `invoice.reminderTime` | `orderConfirmationWithTicketsLink.notificationType` | `orderConfirmationWithTicketsLink.reminderTime`;
+/**
+ * Triggers notification
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.guests
+ * @requiredField options.notification
+ * @permissionId WIX_EVENTS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
+ */
+declare function triggerNotification(options: TriggerNotificationOptions): Promise<void>;
 interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
     /** Email notification type */
     emailNotificationType?: EmailNotificationTypeWithLiterals;
@@ -3805,6 +3866,33 @@ interface TriggerNotificationOptionsGuestsOneOf {
     /** Ticket guests info */
     ticketGuest?: TicketGuest;
 }
+/**
+ * Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.
+ * @param notificationConfigId - Id of the NotificationConfig to retrieve
+ * @public
+ * @documentationMaturity preview
+ * @requiredField notificationConfigId
+ * @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG
+ * @applicableIdentity APP
+ * @fqn wix.events.notifications.v2.NotificationConfigManagement.ResolveNotificationConfig
+ */
+declare function resolveNotificationConfig(notificationConfigId: string): Promise<NonNullablePaths<ResolveNotificationConfigResponse, {
+    [P in NotificationConfigNonNullablePaths]: `notificationConfig.${P}`;
+}[NotificationConfigNonNullablePaths]>>;
+/**
+ * Upsert a NotificationConfig
+ * @param _id - Event ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField notificationConfig
+ * @permissionId WIX_EVENTS.UPDATE_NOTIFICATION_CONFIG
+ * @applicableIdentity APP
+ * @fqn wix.events.notifications.v2.NotificationConfigManagement.UpsertNotificationConfig
+ */
+declare function upsertNotificationConfig(_id: string, notificationConfig: UpsertNotificationConfig): Promise<NonNullablePaths<UpsertNotificationConfigResponse, {
+    [P in NotificationConfigNonNullablePaths]: `notificationConfig.${P}`;
+}[NotificationConfigNonNullablePaths]>>;
 interface UpsertNotificationConfig {
     /**
      * Event ID.
@@ -3845,4 +3933,4 @@ interface UpsertNotificationConfig {
     orderConfirmationWithTicketsLink?: EmailNotificationConfig;
 }
 
-export { OrderStatus as $, Alignment as A, ButtonDataType as B, ConferenceType as C, PollLayoutDirection as D, EmailNotificationType as E, BackgroundType as F, GIFType as G, DecorationType as H, InputControlType as I, FontType as J, AppType as K, LocationType as L, MapType as M, type NotificationConfigCreatedEnvelope as N, Orientation as O, PushNotificationType as P, InitialExpandedItems as Q, type ResolveNotificationConfigResponse as R, SubdivisionType as S, type TriggerNotificationOptions as T, type UpsertNotificationConfig as U, VisitorType as V, WidthType as W, Direction as X, VerticalAlignment as Y, NullValue as Z, Type as _, type UpsertNotificationConfigResponse as a, type RsvpSummary as a$, FeeName as a0, FeeType as a1, WebhookIdentityType as a2, type NotificationConfig as a3, type EmailNotificationConfig as a4, type EmailTemplate as a5, type Link as a6, type TriggerNotificationRequest as a7, type TriggerNotificationRequestNotificationOneOf as a8, type TriggerNotificationRequestGuestsOneOf as a9, type Registration as aA, type RsvpCollection as aB, type RsvpCollectionConfig as aC, type Ticketing as aD, type TicketingConfig as aE, type TaxConfig as aF, type Money as aG, type ExternalEvent as aH, type CalendarLinks as aI, type SiteUrl as aJ, type Form as aK, type InputControl as aL, type Input as aM, type OptionSelection as aN, type OptionSelectionSelectedOptionOneOf as aO, type Label as aP, type FormMessages as aQ, type RsvpFormMessages as aR, type PositiveResponseConfirmation as aS, type NegativeResponseConfirmation as aT, type Positive as aU, type Negative as aV, type CheckoutFormMessages as aW, type ResponseConfirmation as aX, type RegistrationClosedMessages as aY, type TicketsUnavailableMessages as aZ, type Dashboard as a_, type RsvpGuest as aa, type OrderGuest as ab, type EventGuests as ac, type TicketGuest as ad, type TriggerNotificationResponse as ae, type DomainEvent as af, type DomainEventBodyOneOf as ag, type EntityCreatedEvent as ah, type RestoreInfo as ai, type EntityUpdatedEvent as aj, type EntityDeletedEvent as ak, type ActionEvent as al, type Empty as am, type EventUpdated as an, type Location as ao, type MapCoordinates as ap, type Address as aq, type AddressStreetOneOf as ar, type StreetAddress as as, type AddressLocation as at, type Subdivision as au, type ScheduleConfig as av, type Recurrences as aw, type Occurrence as ax, type Event as ay, type Scheduling as az, type NotificationConfigUpdatedEnvelope as b, type Permissions as b$, type TicketingSummary as b0, type GuestListConfig as b1, type Feed as b2, type OnlineConferencing as b3, type OnlineConferencingConfig as b4, type OnlineConferencingSession as b5, type SeoSettings as b6, type SeoSchema as b7, type Keyword as b8, type Tag as b9, type FileSource as bA, type FileSourceDataOneOf as bB, type PDFSettings as bC, type GalleryData as bD, type Media as bE, type Image as bF, type Video as bG, type GalleryDataItem as bH, type GalleryDataItemDataOneOf as bI, type GalleryOptions as bJ, type Layout as bK, type ItemStyle as bL, type Thumbnails as bM, type GIFData as bN, type GIF as bO, type HeadingData as bP, type HTMLData as bQ, type HTMLDataDataOneOf as bR, type ImageData as bS, type StylesBorder as bT, type ImageDataStyles as bU, type LinkPreviewData as bV, type LinkPreviewDataStyles as bW, type MapData as bX, type MapSettings as bY, type ParagraphData as bZ, type PollData as b_, type Settings as ba, type Agenda as bb, type Category as bc, type CategoryCounts as bd, type EventDisplaySettings as be, type LabellingSettings as bf, type RichContent as bg, type Node as bh, type NodeDataOneOf as bi, type NodeStyle as bj, type ButtonData as bk, type Border as bl, type Colors as bm, type PluginContainerData as bn, type PluginContainerDataWidth as bo, type PluginContainerDataWidthDataOneOf as bp, type Spoiler as bq, type Height as br, type Styles as bs, type V1Link as bt, type V1LinkDataOneOf as bu, type Rel as bv, type CodeBlockData as bw, type TextStyle as bx, type DividerData as by, type FileData as bz, EmailNotificationReminderTime as c, type DiscountItemDiscountOneOf as c$, type Option as c0, type PollSettings as c1, type PollLayout as c2, type OptionLayout as c3, type Gradient as c4, type Background as c5, type BackgroundBackgroundOneOf as c6, type PollDesign as c7, type OptionDesign as c8, type Poll as c9, type AudioData as cA, type OrderedListData as cB, type BulletedListData as cC, type BlockquoteData as cD, type CaptionData as cE, type LayoutCellData as cF, type Metadata as cG, type DocumentStyle as cH, type TextNodeStyle as cI, type Badge as cJ, type OrderConfirmed as cK, type FormResponse as cL, type InputValue as cM, type FormattedAddress as cN, type CommonAddress as cO, type CommonAddressStreetOneOf as cP, type CommonStreetAddress as cQ, type CommonAddressLocation as cR, type CommonSubdivision as cS, type StandardDetails as cT, type Ticket as cU, type CheckIn as cV, type OnlineConferencingLogin as cW, type Invoice as cX, type Item as cY, type Discount as cZ, type DiscountItem as c_, type PollDataLayout as ca, type Design as cb, type TextData as cc, type Decoration as cd, type DecorationDataOneOf as ce, type AnchorData as cf, type ColorData as cg, type LinkData as ch, type MentionData as ci, type FontSizeData as cj, type SpoilerData as ck, type AppEmbedData as cl, type AppEmbedDataAppDataOneOf as cm, type BookingData as cn, type EventData as co, type VideoData as cp, type PlaybackOptions as cq, type EmbedData as cr, type Oembed as cs, type CollapsibleListData as ct, type TableData as cu, type Dimensions as cv, type TableCellData as cw, type CellStyle as cx, type BorderColors as cy, type ListValue as cz, Status as d, type CouponDiscount as d0, type PaidPlanDiscount as d1, type PaidPlanDiscountDiscountOneOf as d2, type PercentDiscount as d3, type Tax as d4, type Fee as d5, type OrderEmailAdded as d6, type EventCanceled as d7, type EventReminder as d8, type TimeDuration as d9, type OrderPaid as da, type TicketPdfResolved as db, type TicketPdfResolveDelayed as dc, type OrderCanceled as dd, type EventEnded as de, type EventStarted as df, type ResolveNotificationConfigRequest as dg, type UpsertNotificationConfigRequest as dh, type ResolveEmailNotificationConfigRequest as di, type ResolveEmailNotificationConfigResponse as dj, type EventDeleted as dk, type EventCopied as dl, type MessageEnvelope as dm, type IdentificationData as dn, type IdentificationDataIdOneOf as dp, type BaseEventMetadata as dq, type EventMetadata as dr, type TriggerNotificationOptionsNotificationOneOf as ds, type TriggerNotificationOptionsGuestsOneOf as dt, EventStatus as e, EventType as f, RegistrationStatus as g, RsvpStatusOptions as h, TaxType as i, ValueType as j, State as k, NodeType as l, PluginContainerDataAlignment as m, Target as n, TextAlignment as o, LineStyle as p, Width as q, ViewMode as r, LayoutType as s, Crop as t, ThumbnailsAlignment as u, Source as v, Position as w, ViewRole as x, VoteRole as y, PollLayoutType as z };
+export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type Agenda, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type CalendarLinks, type CaptionData, type Category, type CategoryCounts, type CellStyle, type CheckIn, type CheckoutFormMessages, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonStreetAddress, type CommonSubdivision, ConferenceType, type ConferenceTypeWithLiterals, type CouponDiscount, Crop, type CropWithLiterals, type Dashboard, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type Discount, type DiscountItem, type DiscountItemDiscountOneOf, type DividerData, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmailNotificationConfig, EmailNotificationReminderTime, type EmailNotificationReminderTimeWithLiterals, EmailNotificationType, type EmailNotificationTypeWithLiterals, type EmailTemplate, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCopied, type EventData, type EventDeleted, type EventDisplaySettings, type EventEnded, type EventGuests, type EventMetadata, type EventReminder, type EventStarted, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type ExternalEvent, type Fee, FeeName, type FeeNameWithLiterals, FeeType, type FeeTypeWithLiterals, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type FormResponse, type FormattedAddress, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryDataItem, type GalleryDataItemDataOneOf, type GalleryOptions, type Gradient, type GuestListConfig, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type InputValue, type Invoice, type Item, type ItemStyle, type Keyword, type Label, type LabellingSettings, type Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type Location, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, type NotificationConfig, type NotificationConfigCreatedEnvelope, type NotificationConfigUpdatedEnvelope, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingLogin, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderCanceled, type OrderConfirmed, type OrderEmailAdded, type OrderGuest, type OrderPaid, OrderStatus, type OrderStatusWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type PaidPlanDiscount, type PaidPlanDiscountDiscountOneOf, type ParagraphData, type PercentDiscount, type Permissions, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, PushNotificationType, type PushNotificationTypeWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, type RegistrationStatusWithLiterals, type Rel, type ResolveEmailNotificationConfigRequest, type ResolveEmailNotificationConfigResponse, type ResolveNotificationConfigRequest, type ResolveNotificationConfigResponse, type ResponseConfirmation, type RestoreInfo, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpFormMessages, type RsvpGuest, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type StandardDetails, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type Tax, type TaxConfig, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticket, type TicketGuest, type TicketPdfResolveDelayed, type TicketPdfResolved, type Ticketing, type TicketingConfig, type TicketingSummary, type TicketsUnavailableMessages, type TimeDuration, type TriggerNotificationOptions, type TriggerNotificationOptionsGuestsOneOf, type TriggerNotificationOptionsNotificationOneOf, type TriggerNotificationRequest, type TriggerNotificationRequestGuestsOneOf, type TriggerNotificationRequestNotificationOneOf, type TriggerNotificationResponse, Type, type TypeWithLiterals, type UpsertNotificationConfig, type UpsertNotificationConfigRequest, type UpsertNotificationConfigResponse, type V1Link, type V1LinkDataOneOf, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, onNotificationConfigCreated, onNotificationConfigUpdated, resolveNotificationConfig, triggerNotification, upsertNotificationConfig };